Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
User Interfaces
Reference Guide
ARSVD00399
Cornerstone
User Interfaces Reference Guide
2001 ARRIS
All rights reserved
The information in this document is subject to change without notice. The statements, configurations, technical data, and
recommendations in this document are believed to be accurate and reliable, but are presented without express or implied warranty.
Users must take full responsibility for their applications of any products specified in this document. The information in this document
is proprietary to ARRIS.
ARRIS, ARRIS Interactive, and Voice Port are trademarks of ARRIS Licensing Company. Cornerstone is a registered trademark
of ARRIS Licensing Company. AccessNode is a registered trademark of Nortel Networks. All other trademarks and registered
trademarks are the property of their respective holders.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
iii
Publication history
September 2001
Release 8.1, Standard 1.0 version of this document which includes changes for
CsV08.1.
September 2000
Release 6, Standard 2.0 version of this document which includes changes for
CS06.2.
June 1999
Release 6, Standard 2.0 version of this document which includes changes for
CS06.1.
April 1999
Release 6, Standard 1.0 version of this document which includes changes for
CS06.
December 1998
Release 5, Standard 1.0 version of this document which includes changes for
CsV05.2.
August 1998
Release 4, Standard 1.0 version of this document which includes changes for
CsV05.
March 1998
Release 3, Standard 1.0 of this document.
October 1997
Release 2, Standard 1.0 of this document.
October 1996
Release 1, Standard 2.0 version of this document.
July 1996
Release 1, Standard 1.0 version of this document.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
iv Publication history
Contents
About this document 1-xi
Terminology 1-xi
References in this document 1-xi
Warnings and safety precautions 1-xii
Network element user interface 1-1
Overall features 1-1
Screen layout 1-2
Command inheritance 1-8
The concept of “context” 1-8
Editable fields 1-8
Toggled fields 1-9
Status messages 1-9
Input and output editing features 1-11
Command input 1-11
Macros 1-12
Command parameter prompting 1-12
Last command recall 1-13
Multiple command entry 1-13
Command output 1-13
Command confirmation 1-13
Common menu commands or options 1-13
Line editing 1-15
Operational commands 1-16
Help 1-16
Paging 1-17
Scrolling 1-17
Event logs 1-17
Command menus 1-20
OPC character-mode user interface 2-1
Logging in to the CMT environment 2-1
For HP host systems 2-1
For Sun host systems 2-2
User Session Manager 2-3
Status icons 2-4
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
vi Contents
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
viii Contents
modem 7-17
Procedure 7-5 Logging in to the OPC 7-19
Procedure 7-6 Logging in to the remote OPC from a local OPC 7-23
Procedure 7-7 Logging in to an OPC from a network element 7-26
Procedure 7-8 Logging in to the Cornerstone toolset 7-28
Procedure 7-9 Opening an OPC tool 7-31
Procedure 7-10 Closing an OPC tool 7-33
Procedure 7-11 Logging out of the OPC 7-34
Procedure 7-12 Changing your password 7-36
Procedure 7-13 Displaying OPC status 7-39
Procedure 7-14 Changing the name of an OPC 7-41
Other OPC procedures 8-1
Chapter task list 8-1
Requirements 8-2
Procedure 8-1 Shutting down an OPC 8-3
Procedure 8-2 Checking the OPC tape identification 8-7
Procedure 8-3 Saving OPC data to tape 8-9
Procedure 8-4 Restoring OPC data from tape 8-15
Procedure 8-5 Transferring data between OPCs 8-24
Procedure 8-6 Detecting and/or removing existing OPC software 8-27
Procedure 8-7 Installing software in a local OPC 8-31
Procedure 8-8 Restoring an NE database 8-34
Procedure 8-9 Setting the time zone, date, or time 8-39
Using the CI tool user interface 9-1
Procedure 9-1 Opening a CI tool 9-2
Procedure 9-2 Displaying the help screen for a CI tool 9-4
Procedure 9-3 Entering a CI command 9-5
Procedure 9-4 Closing the CI tool 9-6
OPC Ethernet port configuration and connections 10-1
How to Use this Chapter 10-2
Requirements 10-2
X terminal support 10-3
X terminal equipment recommendations 10-4
X terminal setup requirements 10-5
Instructions for X terminal setup 10-7
Replacing or exchanging X terminals 10-8
LAN considerations 10-8
Cabling options 10-9
Session-terminating conditions 10-12
Troubleshooting guidelines for X terminals 10-13
Engineering guidelines for OPC X terminal sessions 10-15
Procedure 10-1 Initializing the OPC Ethernet port 10-16
Procedure 10-2 Enabling and disabling the OPC Ethernet port 10-20
Procedure 10-3 Connecting the OPC to network equipment 10-23
Procedure 10-4 Establishing a telnet session between an X terminal and the OPC
10-24
Procedure 10-5 Adding, changing, or deleting an NCD19 configuration file 10-25
Procedure 10-6 Loading the NCD19 configuration data from the OPC to an NCD19
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
x Contents
Terminology
The terms “downstream” and “upstream” used in this document refer to the
direction of transmission towards the customer site and towards the head-end,
respectively. This nomenclature follows that of the telephony industry.
Equivalent cable industry terminology is “forward” and “return”, respectively.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
xii About this document
DANGER
Risk of personal injury
A danger warning advises you of a risk of personal injury.
DANGER
This warning advises you of a possible electrical hazard. When
you see this warning, proceed with care, to avoid personal
injury.
CAUTION
Risk of service interruption or equipment damage
A caution warning advises you of a risk of service interruption
or equipment damage.
CAUTION
Risk of equipment damage
This warning advises you of possible equipment damage.
Observe precautions for handling electrostatic sensitive
devices.
The command menus provided in the user interface are included at the end of
this chapter.
Overall features
The NEUI is a menu-based, user-friendly interface to the network. The menu
hierarchy of the user interface allows access to the following:
• alarms
• configuration and provisioning
• performance monitoring
• maintenance
• protection switching
• on-line inventory
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-2 Network element user interface
Screen layout
The user interface allows you to access all system alarms, status and control
information, and commands. The user interface screens are organized to make
it easy for the new user to read, understand, and use the Video Display
Terminal (VDT). The following shows the screen template:
CS-10232
CS-10232
Work Area
Static area
Command Status Messages
Menu
Display
Area
Screen dependent
Changes to the critical, major, minor and warning fields are shown in inverse
video to indicate when new alarms are generated and that they should be
investigated.
The system status area also contains fields indicating current protection
activity failures and lockouts, and a field to alert of performance degradation.
A question mark “?” in the top left corner of the system status area indicates
that system level data may be incorrect due to a temporary loss of
communication with the OPC.
CS-10224
CS-10224
1 Ottawa 2 3 1 1 * . . .
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-4 Network element user interface
CSV Nodes
FW-10199
0 Quit
2
3 Alarms
4 ListNEs
5
6 PerfMon
7
8
9
10 Protectn
11
12
13 JackAcc
14
15 Equipmnt
16 Facility
17 Admin
18 Help
FW-10197
NE 1
Time 17:35 >
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-6 Network element user interface
Conversation area
The conversation area is located just below the work area and just above the
command line, and consists of 20 lines of 68 characters each. The conversation
area displays the information in a scroll format for displaying large amounts of
data.
FW-10196
FW-10196
NewAlms
Alm Class Type Sh Reason Severity
21 Env CE 1 SP Datacomm 0 station fail LOS C,SA
20 Env Input 1 Door Latch Open Clear
Work area
The work area displays information as a result of the commands you entered
on the command line.
The work area displays the information in a page format. It also displays
system status or information depending on the command you entered.
FW-10217
FW-10217
Header information
For some screens in monitor mode, header information is not monitored even
though the screen’s contents are. For example, you are viewing protection
switching information, which is in monitor mode. The header information
(NE, shelf, or CLLI) is not being monitored. However, this header information
will rarely, if ever, change once provisioned.
Note: When an object is deleted, its screen is not updated in monitor mode.
The screen should be reselected to display the new status of deleted
objects.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-8 Network element user interface
Command inheritance
When you display a screen, the commands displayed become available. When
you display a “child” screen, the commands on the “parent” screen continue to
be available. Thus all commands from the main menu level down to the current
screen are available. Note that in some cases, a shortcut exists to move from
one menu hierarchy to another. In this case, only the commands in the new
menu hierarchy are available (for example, moving from the equipment to the
facility screens).
Commands on the main menu (a “parent” of all other menus) are available at
all levels. These commands (and abbreviations) are:
• Alarms (or AL)
• ListNES
• PerfMon (or PM)
• Protectn (or Prot)
• Equipment (or EQ)
• Facility (or FA)
• Admin (or AD)
Note that some menu screens are specific to a certain type of context, and thus
changing the context is not always possible. In this case, you must return to the
main menu and re-enter the main menu command with the new context.
Editable fields
A field which is displayed within angled brackets (<...>) indicates that the field
contains a string which can be edited.
Toggled fields
Some fields contain a user-selected value which is one of a limited set of
possible values. You can either select the desired value explicitly with the
appropriate command or can toggle the value by entering the command
without any parameters. For parameters with two possible values, the
parameter toggles from its current value to the other possible value. For
parameters with more than two values, the parameter toggles from its current
value to the next “larger” value.
Status messages
The fourth line of the screen (first line of the static work area) is normally
blank. This line is used to display important system messages. Messages
displayed in the scrolling conversation area are lost whenever the conversation
area is updated. A message displayed in the first line of the static work area is
not lost unless the condition which it reflects is corrected, or is no longer
relevant. The messages which may be displayed and the conditions which they
indicate are:
Object Deleted - The object instance which was displayed on the current
screen has been deleted, possibly by another user. This message displays when
any posted unit is displayed. The “unit” might be a circuit pack group, a
facility, or a protection group. This indicates that any further operations against
this unit will be rejected, as the unit is no longer provisioned.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-10 Network element user interface
Could Not Retrieve Screen Data - The data required to display the current
screen could not be retrieved for some reason. The specific reason associated
with this indication is displayed in the conversation area. The reason will either
be that the requested instance does not exist (and may be added) or there was
a messaging failure. The most likely messaging failure is a timeout (that is, no
response received) due to either congestion of the OAM network or loading of
the target NE.
Fields Will Remain Blank Until You Change Them - Whenever you
display a screen with all instances of an object selected, no data is displayed in
the screen fields because the values for different object instances will generally
not be the same. For any fields that can be changed with all instances selected,
a value is shown in the field, if you successfully edit the field.
Network Data Unavailable - The data that is used to maintain the network
banner line is unavailable. Most often, this is due to a failure of the link
between the NE which is hosting the login session and the OPC. The NEUI
will automatically attempt to re-establish this link on a periodic basis. In
addition, any time the user re-enters the Network Element Status screen from
CI or MAPCI, the NEUI attempts to establish this link.
Command input
The entry of commands is based on the VT100 key set. Some variations in
identification of keys may exist if another type of keyboard is used.
When selecting commands from the command menu display area, either the
entire string or just the number of the command can be specified.
Any field on the screen containing a text string, which you can change, is
displayed with angled brackets (<...>). The brackets indicate the maximum
width of the text field, regardless of what has been entered for the string. The
brackets are intended to provide you with an indication that a field contains an
editable string, and the maximum allowable size of the string. The string may
be numeric, alphabetic, or alphanumeric, depending on the particular field.
The brackets are shown around such fields regardless of whether or not you are
permitted to edit the field. The brackets do not appear around toggled fields
which you can indirectly change or around display-only fields (that is, fields
which a user cannot alter using the user interface).
Replies to user input, error message, and confirmation sequences are displayed
at the output scroll area.
Refer to “Command menus” for a list of command menus and any associated
parameters.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-12 Network element user interface
Macros
The command macros are built into the operating system to allow repetitive
commands that do not require confirmation. You can group frequently used
sequences of commands as user-defined macros which can be called from the
NEUI. All macros are used when you log out from the operating system (using
Logout).
Examples:
Command DS1prot (FWP; PROTECTN; DTLProt DS1)
Command DS1AlmPts (FACILITY DS1 G1 1; ALMPROV)
A macro command can call another macro, or several macros. Example:
Command Macro3 (macro2; macro1)
Note: Do not use macro names that are the same as existing commands.
Caution should be used when a recursive macro is created (that is, the macro
name appears in the menu command brackets). This can cause the system to
be caught in a loop.
Note: Use of the menu number shortcut is only permitted for the first
command in a multiple command entry.
Command output
If a command cannot be carried out or fails, a command fail notification is
displayed at the output scroll area. Examples are as follows:
• The XXXXXXXX command failed. Please re-enter the command.
• If the problem persists, call the NT Technical Assistance
Service and quote error number NNN.
Command confirmation
A command confirmation sequence is provided when entering service
affecting commands such as deleting data. This function prompts you to
confirm the associated command by entering y (yes) or n (no).
Command/Option Description
FWP Displays the main menu (system level status screen). FWP
can be used at the FWPUI command interpreter level.
Help Displays help text specific to the current screen hierarchy (for
example, Alarms help, Facility help, etc.)
—continued—
ListNEs This command lists all NEs (by name and number) which you
can view.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-14 Network element user interface
Table 1-1
Common menu commands or options (continued)
Command/Option Description
Logout Log out from the user interface. This command is available at
any time.
Mainmenu Displays the main menu and selects the NE to which you are
physically connected.
New Displays any new alarms since the last new command.
Print users Lists all users who are logged into the NE in context.
Query This menu item is similar to the select menu option except
that the requested data is placed in the output scroll area so
as to not delete the original data. However, the output scroll
area displays data in snapshot mode and is not updated if
changes occur.
Quit all; MAPCI This can be used to determine who is logged in at a terminal.
The userID is displayed in the bottom left-hand corner.
show users Lists all users who have access to the NE in context. (This
command is available to users with command classes 1, 2,
and 3 only).
Line editing
Table 1-2 lists and describes the line editing functions available in the
command input area.
Table 1-2
Line editing
Command Description
<ctrl> E Deletes all characters from the cursor position to the end of the
line.
<ctrl> X Switches the cursor to overwrite mode, any subsequent input will
overwrite existing characters.
<- Also called the BACKSPACE key, moves the cursor to the left
one position.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-16 Network element user interface
Operational commands
Table 1-3 lists and describes the operational commands which allow you to
control processes started by the interface commands and are available
throughout the UI.
Table 1-3
Operational commands
Command Description
<break> HX Clears the screen and exits to the Command Interpreter (CI)
level.
SIL Stops all flashing on-screen indicators and inverse video until the
next status change occurs.
Note: The <break> command is sent with the <break> key on the VT100
terminal (usually F5). The <break> command is always received at the NE
to which you are logged on. However, if you have logged in to a remote NE
(using the NE Login Manager or by using the rlogin command), you must
enter CTRL_B instead of <break>.
Help
Prefixing any command with Q displays the function and format of that
command. A space is required between Q and the command being queried.
Paging
If the amount of data generated in response to a command exceeds the
available display area, a prompt appears, indicating the number of pages. To
view the pages, the commands shown in Table 1-4 can be used.
Table 1-4
Paging commands
Command Description
Scrolling
If the amount of data generated in the conversation area exceeds the available
area for display (for example, during parameter prompting), the prompt
“more...” appears. Use the Return (↵) key to view subsequent data. Enter ht to
halt the scrolling of data. The last page of data is identified by the absence of
the “more...” prompt.
Event logs
The event log system records all status changes in the network element. The
event log messages can be automatically routed to a printer connected to a
local RS-232 port provisioned for a printer. It can also be printed at operator
request through a printer attached to the VT100 or compatible user terminal.
There are five categories of event messages generated by the network element
system. These include facility (FAC), equipment (EQP), communications
(COML), database (FWDB), and exceptions (miscellaneous - EXCP). Reports
can be set up and printed based on the different categories. To get a list of
available reports, type ListReps in LOGUTIL. Each buffer handles 40 event
messages. When a particular buffer is full, a first-in first-out algorithm
accommodates additional incoming messages.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-18 Network element user interface
LOGUTIL Description
Option
Open Select a log buffer for viewing and displaying the current report
entry.
Type of editing or
function control Keys Function
Command input <ctrl> E deletes all characters from the cursor to the
editing end of the line
<- backspaces
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-20 Network element user interface
Command menus
This section provides a summary of all the menus provided in the user
interface. Table 1-7 lists these menus.
Table 1-7
Menu layouts
Figure 1-1
Mapci menus
Figure 1-2
Alarms menus
FW-21457
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-22 Network element user interface
Figure 1-3
Protection menus
Figure 1-4
Performance monitoring menus
Figure 1-5
Facility menus (sheet 1 of 2)
CS Nodes
0 Quit
2
3 Alarms
4 ListNEs
5
6 PerfMon
7
8
9
10 Protectn
11
12
13 JackAcc
14
15 Equipment
16 Facility
17 Admin
18 Help
DS1
DS 1/3 Fac Edit Fac AlmProv
0 Quit 0 Quit 0 Quit
2 Select 2 Select 2 Select
3 Query 3 Query 3
4 4 4
5 ListAlms 5 FacID 5 ListAlms
6 AlmRpt 6 LCoding 6 ALMRpt
7 Loopback 7 LBO 7
8 ChgState 8 FrameFmt 8
9 9 AlarmEnc 9
10 DtlProt 10 Synchr 10
11 Edit 11 PMProv 11 EditStat
12 12 12
13 Add 13 13
14 Delete 14 14
15 Equipmnt 15 15
16 16 16
17 AlmProv 17 17
18 Help 18 Help 18 Help
TIC
TIC Fac AlmProv TIC Fac AlmProv
0 Quit 0 Quit 0 Quit 0 Quit
2 Select 2 Select 2 Select 2 Select
3 Query 3 3 Query 3
4 4 4 4
5 ListAlms 5 ListAlms 5 ListAlms 5 ListAlms
6 AlmRpt 6 AlmRpt 6 AlmRpt 6 AlmRpt
7 SubPtSel 7 7 7
8 ChgState 8 8 ChgState 8
9 9 9 9
10 TrlateSP 10 10 TrlateSP 10
11 11 EditStat 11 11 EditStat
12 12 12 12
13 13 13 13
14 14 14 14
15 Equipmnt 15 15 Equipmnt 15
16 16 16 16
17 AlmProv 17 17 AlmProv 17
18 Help 18 Help 18 Help 18 Help
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-24 Network element user interface
Figure 1-6
Facility menus (sheet 2 of 2)
Figure 1-7
Equipment menus (sheet 1 of 3)
DS1
CS Nodes
DS1 Equip AlmProv
0 Quit
2 0 Quit 0 Quit
3 Alarms 2 Select 2 Select
4 ListNEs 3 Query 3
5 4 4
6 PerfMon 5 ListAlms 5 ListAlms
7 6 AlmRpt 6 AlmRpt
8 7 7
9 8 ChgState 8
10 Protectn 9 9
11 10 DtlProt 10
12 11 11 EditStat
13 JackAcc 12 12
14 13 Add 13
15 Equipmnt 14 Delete 14
16 Facility 15 15
17 Admin 16 Facility 16
18 Help 17 AlmProv 17
18 Help 18 Help
Figure 1-8
Equipment menus (sheet 2 of 3)
OPC CRVLC/VPLC
CS Nodes OPC Equip LC Equip
0 Quit 0 Quit 0 Quit
2 2 Select 2 Select
3 Alarms 3 Query 3 Query
4 ListNEs 4 4
5 5 ListAlms 5 ListAlms
6 PerfMon 6 AlmRpt 6 AlmRpt
7 7 7
8 8 ChgState 8 ChgState
9 9 9
10 Protectn 10 10
11 11 11 Next
12 12 12 Diagnose
13 JackAcc 13 Add 13
14 14 Delete 14
15 Equipmnt 15 15
16 Facility 16 16 ResetLC
17 Admin 17 17 AlmProv
18 Help 18 Help 18 Help
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-26 Network element user interface
Figure 1-9
Equipment menus (sheet 3 of 3)
PROC TAC
CS Nodes PROC Equip
TAC Equip
0 Quit 0 Quit
2 2 Select 0 Quit
3 Alarms 3 Query 2
4 ListNEs 4 Restart 3 Query
5 5 ListAlms 4
6 PerfMon 6 AlmRpt 5 ListAlms
7 7 DataSync 6 AlmRpt
8 8 ChgState 7
9 9 Switch 8 ChgState
10 Protectn 10 9
11 11 RexEna 10
12 12 Diagnose 11
13 JackAcc 13 Add 12 Diagnose
14 14 Delete 13
15 Equipmnt 15 EditAINS 14
16 Facility 16 Exercise 15 EditAINS
17 Admin 17 AlmProv 16
18 Help 18 Help 17 AlmProv
18 Help
Figure 1-10
Administration menus (sheet 1 of 2)
NE Profile
Log Utility
0 QuitLogs
2 ListLogs
3 Open
4 Current
5 Forward
6 Back
7 First
8 Last
9 Start
10 Stop
11 ClearLog
12 Format
13 ListReps
14 ListDevs
15 StartDev
16 StopDev
17
18 Help
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-28 Network element user interface
Figure 1-11
Administration menus (sheet 2 of 2)
Ports 1, 2
CS Nodes Ports Stats UI Port Edit UI
0 Quit 0 Quit 0 Quit 0 Quit
2 2 2 Select 2 Select
3 Alarms 3 Query 3 Query 3 Query
4 ListNEs 4 4 4
5 5 5 5 BaudRate
6 PerfMon 6 6 6 Parity
7 7 7 7 CharSize
8 8 8 ChgState 8 StopBits
9 9 9 9
10 Protectn 10 10 10
11 11 11 Edit 11
12 12 DtlProt 12 12
13 JackAcc 13 Add 13 13
14 14 Delete 14 14
15 Equipmnt 15 15 15
16 Facility 16 16 16
17 Admin 17 17 17
18 Help 18 Help 18 Help 18 Help
Port 6 Ports 3, 4
Tel Output TBOS Port Edit TBOS
0 Quit 0 Quit 0 Quit
2 Select 2 Select 2 Select
3 Query 3 Query 3 Query
4 4 4
5 5 5 Status
6 Operate 6 6 Display
7 Release 7 7
8 8 ChgState 8
9 9 9
10 10 10
11 Edit 11 Edit 11
12 12 12
13 13 13
14 14 14 DelDisp
15 15 15
16 16 16
17 17 17
18 Help 18 Help 18 Help
Port 5
Edit Output Tel Input Edit Input
0 Quit 0 Quit 0 Quit
2 Select 2 Select 2 Select
3 Query 3 Query 3 Query
4 4 4
5 Status 5 5 Status
6 Display 6 6 Severity
7 7 7 SvcImpct
8 Byte 8 8 Descript
9 Bit 9 9
10 Descript 10 10
11 11 Edit 11
12 12 12
13 13 13
14 DelDisp 14 14
15 15 15
16 16 16
17 17 17
18 Help 18 Help 18 Help
Figure 1-12
Help menu
CS Nodes Help
0 Quit 0 Quit
2 2
3 Alarms 3
4 ListNEs 4
5 5
6 PerfMon 6
7 7
8 8
9 9
10 Protectn 10
11 11
12 12
13 JackAcc 13
14 14
15 Equipmnt 15
16 Facility 16
17 Admin 17
18 Help 18
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
1-30 Network element user interface
Step Action
1 Type your userID after the login prompt and press Enter.
2 Type your password after the password prompt and press Enter.
Note: The password does not appear in the field as you type it. Do
not use capital letters unless the capitalization is part of the
password, because the system treats uppercase and lowercase
letters differently.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-2 OPC character-mode user interface
Step Action
Note: The password does not appear in the field as you type it. Do
not use capital letters unless the capitalization is part of the
password, because the system treats uppercase and lowercase
letters differently.
A session is defined as all interaction between you and the system from the
time you log in until the time you log out.
The User Session Manager lets you control your movement among tools.
List of available
tools
Disabled icon
List of open
tools
Logout button
In the User Session Manager window shown above, there are several toolsets
available for use. Toolsets with a disabled icon in front remind you that the
toolset cannot be selected.
There are also a number of tools that have already been opened. These tools
are shown under the Open tools list, and represent an instance of the tool.
Note: In a session, you can open more than one instance of the same tool.
However, when you reach the maximum number of instances allowed for
a particular tool, no further instances of that tool are allowed and a disabled
icon displays in front of the tool in the Available tools list.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-4 OPC character-mode user interface
Status icons
Status icons appear in the title bar of the main window, beside a list item, or
beside a command in a history field.
OK >•
Busy ><
Error >X
Printing >>
Major Alarm !M
Critical Alarm *C
Minor Alarm !m
OK >•
Error >X
Printing >>
Contains data +
Contains no data —
Major alarm !M
Critical alarm *C
Minor alarm !m
Busy ><
CS-10235
7 8 9 -
Home Previous Next End
(and save)
4 5 6 ,
Step Jump Window Tool
scroll... scroll... menu menu
1 2 3 Enter
Drag Global Chooser/
menu List menu List item
Select menu
to here...
Field
0 . menu
Select Multiselect
Button
Choose menu item menu
Keys shown with ellipsis (...) require the use of other keys to activate their
functions:
• The Scroll, Select to here, and Drag keys must be followed by arrow keys.
• The Window key must be followed by the Next or Previous key.
Keyboard strokes are often preceded by either a Control key or an Escape key.
When you use the Control key as part of a keyboard combination, hold the
Control key down while you press the other key—an underscore, as in Ctrl_T,
denotes this hold-and-press action. If you use Ctrl_T plus another key (such as
Ctrl_T plus 0), you hold the Control key down while you press T, next you
release both the Control and T keys, then you press the 0 key.
When you use the Escape key (represented as a black ◊ in menus and on action
buttons to indicate a shortcut) as part of a keyboard combination, press the
Escape key, release it, then press the other key. A space, as in Esc H, indicates
this press-and-release action.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
Using the Keyboard
Ctrl Caps A Select S Save D (Dupli- F Find G Tool H Help J K L : Sort " Return OK | Again
All cate) Next Shortcuts Home / ; ' \
Lock
Select / Scroll Delete Left Item New Line Quiet
Select Start X-Off Mode On or Left Mode On Menu Character Character
No Shift Z X Cut C Copy V Paste B N M < > Refresh ? Help Shift Line
, . Screen /
Scroll Feed
Previous New Line
Drag Object Character Help
Legend:
Function
To move... Use...
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-8 OPC character-mode user interface
Using tools
Every session begins at the User Session Manager window. To manage a
session, you need to know how to do a few things:
• opening a tool
• returning to the User Session Manager
• accessing an open tool
• refreshing the screen
• moving from one open tool to another
To perform procedures effectively, it is important that you are familiar with the
OPC user interface. Figure 2-2 shows a brief summary of the keyboard
conventions used with the VT100-compatible user interface.
Figure 2-2
Character-mode interface conventions
FW-21118A
To open a tool
Move your cursor down the FW-21118
Available tools list to the tool
> . User Session Manager : admin
you want and then select it
(Keypad 0 or Ctrl_A).
Available tools Open tools
The main window for that tool opens. Toolset/Tools ID State Tool
Software Admin 2 > . OK OPC Status : Primary/Active
Reboot/Load Manager 3 >. OKEvent Browser
Backup/Restore Mngr
Event Browser
To access an open tool NE SW Delivery Mngr
Move your cursor down the Network Upgrade Mngr
OPC Amin
Open tools list to the tool Group and User Setup
you want, and then select it Remote OPC SW Inst.
OPC Save and REstore
(Keypad 0 or Ctrl_A). OPC Shutdown
OPC Date
or Unix Shell
Network Admin
Press Ctrl_T, followed by the ID Remote Telemetry
Utilities
of the tool ( for example, Ctrl_T 3 to
[ Logout ]
access the Event Browser tool).
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 10:59
7 8 9 - Tab Q W E
Back Next Next
4 5 6 , Ctrl A S
OR
1 2 3 Enter Z X C V B
0 .
• within an object (example, from list item to list item, or menu item to menu item).
Selecting an object
7 8 9 - Tab Q W E
4 5 6 , Ctrl A S
OR
1 2 3 Enter Z X
0 .
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-10 OPC character-mode user interface
Opening a tool
To open a tool, you must be in the User Session Manager window. Move your
cursor into the User Session Manager window, if necessary, by pressing the
Tab key. Then, move your cursor (using your arrow keys) down the Available
tools list to the tool you want and select it (Keypad 0 or Ctrl_A).
For example, if you select the Event Browser tool, the OPC displays a screen
similar to the following.
The tool you were in before returning to the User Session Manager does not
close and remains active.
Step Action
1 Note the ID of the tool instance (see the ID column in the Open
tools list for the number).
The tool status indicator tells you whether or not the window is ready to be
used. A >• symbol means the window is ready for use.
Title bar
Status indicator
List
Window
border
Status line
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-12 OPC character-mode user interface
Closing a tool
When you are finished with a tool such as in the following example, choose
Exit from the window menu (Keypad 6) of the main window.
Window
menu
Using menus
Each tool has an assortment of menus, as follows:
Window menu
Tool menu
Global menu
List menu
Background
menu
Keyboard shortcut
Displaying a menu
As shown in Figure 2-5, the keypad allows you to access specific menus.
Figure 2-5
Menus accessed by the keypad
CS-10235
7 8 9 -
Home Previous Next End
(and save)
4 5 6 ,
Step Jump Window Tool
scroll... scroll... menu menu
1 2 3 Enter
Drag Global Chooser/
menu List menu List item
Select menu
to here...
Field
0 . menu
Select Multiselect
Button
Choose menu item menu
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-14 OPC character-mode user interface
Table 2-1 shows you the different types of menus and how to display them
using the keypad or keyboard.
Table 2-1
Displaying different types of menus using the keypad or keyboard
Global menu gives you quick access to all the Keypad 2 Ctrl_L plus G
menus available to you. That is, you
are provided with a list of the menus
based on the position of your cursor.
Menu mode
Displaying a menu puts you in menu mode. Once in menu mode, you can:
• choose the menu item
• go to the previous or next menu in the hierarchy for this object
• go to a specific menu
• go to the cascaded menu (if there is one)
Note: Note that keyboard shortcuts are provided for some menu
commands. To use a shortcut, press the Esc key (represented as a black ◊
on the menu) and the letter associated with the command.
To abort: To exit from any mode and ignore the changes that you have made
while you were in that mode, press Keypad PF4 or Ctrl_^ or Esc Esc.
To end: To exit from any mode and save the changes that you have made while
you were in that mode, press Keypad – or Ctrl_].
Table 2-2 lists the different modes and the effects of the End and Abort
commands on them.
Table 2-2
Menu modes and effects of End and Abort
Drag (moving a dialog) dialog will remain at the dialog returns to its original
current position position
Menu (equivalent to not applicable closes the menu but does not
choosing an item) select the item
Resize (command pane) command pane keeps the command pane returns to its
current size change original size
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-16 OPC character-mode user interface
Scrolling
When a window, dialog, scrolling field, or list cannot fully display its contents,
a view bar displays.
Scrolling view
bar
The view bar represents the size and location of the current view in relation to
the whole object. For example, the view bar in the main window indicates that
the information currently displayed is only a portion of the information
available.
Step Action
3 After setting the scroll amount, use the arrow keys to scroll.
• for vertical scrolling, use up and down arrow keys.
• for horizontal scrolling, use left and right arrow keys.
Step Action
2 After setting the scroll amount, use the arrow keys to scroll:
• for vertical scrolling, use up and down arrow keys
• for horizontal scrolling, use left and right arrow keys
Experiment with the scrolling. When you are finished, scrolling can be either
ended (where you remain at the current cursor position) or aborted (where you
return to the cursor position you were in before you began scrolling).
• To end, use Keypad – or Ctrl_].
• To abort, use Keypad PF4 or Ctrl_^.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-18 OPC character-mode user interface
Using lists
Lists allow you to select things for processing.
There is a menu for the list and for each list item. Commands on the list menu
affect the list as a whole. The commands on the list item menu apply to an item
(or items). Inactive commands have a disabled icon beside them.
List menu
List item
Disable icon
Step Action
2 Display the list item menu by pressing Ctrl_L (or Keypad Enter).
The menu shows what can be done with the selected item.
3 Move the cursor down to the command you want. For example, if
you want to delete an item; then choose Delete this item by
pressing Space (or Keypad 0).
The selected item is deleted.
Step Action
2 Use the arrow keys to move to the menu item you want to select.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-20 OPC character-mode user interface
Using dialogs
Dialogs are subsidiary windows associated with a window. They appear in
front of the tool in which they belong. This particular dialog, Alarm Details,
displays detailed information about a particular alarm. It appears on top of the
Alarm Monitor.
FW-20306
Alarm Details
[ D
Done Return]
Moving a dialog
The main window cannot be moved because a window occupies the whole
screen. However, the dialog can be moved so that it is positioned where you
would like it. To move a dialog box, perform the following procedure:
Step Action
4 When the dialog is where you want it, exit the mode (Keypad — or
Ctrl_]) or, if you want to restore it to its original position, abort the
mode by pressing Ctrl_^ (or Keypad 4).
Step Action
3 When the window/dialog you want is on top—in this case, the Set
an Alarm dialog—exit the mode by pressing Ctrl_]
(or Keypad –).
Closing a dialog
To close the dialog, tab to the Cancel or OK button and select it by pressing
Keypad 0 or Ctrl_A.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-22 OPC character-mode user interface
Getting help
Online Help is available for all windows, dialogs and objects in them.
• For help on objects, choose Help from the list, list item, field, and button
menus.
• For help on windows and dialogs, choose Help from the window or
background menu.
Open the dialog menu by pressing Keypad 6 or Ctrl_ L plus W, and choose
Help (Keypad 0 or Space). Help appears in a dialog, as follows.
Help types
Done button
Four types of help are available for the Alarm Monitor window, as indicated
by the buttons at the bottom of the window. Concepts, Commands, Navigation,
and Help on Help are always provided; other types (such as Procedures) may
or may not be provided.
When the Help dialog first appears, it displays Concepts Help, which gives
you a general explanation of the purpose of the object (in this case, the Alarm
Monitor window).
To see one of the other types of Help, you select the appropriate button.
• Commands Help describes the effects of commands on the object.
• Navigation Help tells you how to use menus, move around the screen,
manage the session, and scroll.
• Procedures Help tells you how to perform tasks with a tool.
• Help on Help documents the use of the Help dialog.
Move the cursor to Help on Help (by using the Tab key move to the group of
radio buttons, then the arrow keys to move among the buttons) and select it
(Keypad 0 or Ctrl_A). Notice that the content of the Help dialog changes.
If you were to ask for Help on another object, the content of the help dialog
would change again, showing Help for that object.
You could close the Help dialog by tabbing to the Done button and selecting it
(Keypad 0 or Ctrl_A).
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-24 OPC character-mode user interface
Field
Chooser
Radio
buttons
Fields
The “>” in front of a field name means that it is a mandatory field. A cursor
will appear.
Choosers
Choosers allow you to select a preset value from a menu. Display the chooser
menu by pressing Keypad 3 or Ctrl_L plus /.
Scrolling fields
Scrolling fields (not shown in this example) allow you to type in several lines
of information.
To use a scrolling field, tab to the field and type the desired message. When
you get to the edge of the box, the text wraps to the next line. When the box is
full, it scrolls downwards and a vertical view bar appears.
Radio buttons
Radio buttons allow you to select only one of a set of options. When you select
a radio button, your previous selection is turned off.
These radio buttons let you choose whether the HDT has an OPC, and if so,
whether the OPC is the primary or backup. A black diamond appears between
the brackets when the item is selected.
Check boxes
Check boxes allow you to turn options on or off. More than one option can be
active at a time.
Action buttons
Action buttons tell the system to do something. Inactive buttons are displayed
with the disabled icon preceding the label.
The status indicator on the main window changes to an >X and the mandatory
icon (>) beside the Time field changes to an X to indicate an error.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-26 OPC character-mode user interface
Editing text
The following describes some of the text editing capabilities in the tools.
Basic editing
If you want to insert text, or delete a few characters, position the cursor where
you want to edit. You can insert text, or use the delete or backspace keys to
delete.
Selecting text
To move, copy, or delete larger blocks of text, you must select the text first
before you can use the editing commands. To select text, move the cursor to
the text field you want to select, press Keypad Enter or Ctrl_L to display the
Field menu, then choose Select All.
If you want to change the selection, you can use your arrow keys.
To paste the text, position the cursor at the beginning of the field (where it is
to be pasted). Then press Esc followed by a V (or display the field menu and
choose Paste).
Step Action
3 Using the arrow keys, go to the beginning of the field to where you
want the text replaced.
Editing shortcuts
The following is a list of the basic editing commands as well as some
miscellaneous commands. (Remember that shortcuts can only be used when
the menu is not displayed.)
Esc X Cut
Esc C Copy
Esc V Paste
Esc ( Open
Esc ) Close
Esc Return OK
Closing a tool
When you are finished with a tool, open the window menu (Keypad 6 or Ctrl_L
plus W) and choose Exit to close it.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-28 OPC character-mode user interface
Logging out
When you close a tool, you return to the User Session Manager.
Logout
To log out, tab to the Logout button and select it (Keypad 0 or Ctrl_A). A
message box appears, asking you to confirm your selection.
If you select the Cancel button, the log out command is canceled.
If you select the Logout button, you are logged out. All open windows are
closed automatically. If there are any unsaved changes in a window, a dialog
is presented asking whether to save changes before closing, or whether to
cancel the logout command.
Using UNIX
The following items are described for UNIX systems.
If the command string continues onto a second line, ellipsis (…) are shown at
the end of the first line to indicate a space and not to press Return. Press the
Return key only when you see the ↵ symbol in the instructions.
System prompts and responses are printed and capitalized as they appear on
the screen, as follows:
Password:
The result of an action is shown in italic type, as follows:
The alarm screen is displayed.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-30 OPC character-mode user interface
Command Description
cp <orig> <dest> Copies the file <orig> to the location <dest> (which can be a
directory or a complete file name).
mv <orig> <dest> Moves (or renames) the file <orig> to the location <dest> (which
can be a directory or complete file name).
vi <file> Opens the specified <file> in the standard UNIX text editor. See
“UNIX editor (vi) quick reference” on page 2-31 for a brief
description of the text editor.
The vi editor has two basic modes: command mode and insert mode. Letters
typed in command mode execute the commands listed in Table 2-4. Letters
typed in insert mode are added as text. To enter the insert mode, type a or i. To
return to command mode, press the Esc key.
Table 2-4
Common actions in vi
Function Action Command
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
2-32 OPC character-mode user interface
If you are using a character-mode (VT100 type) terminal with your OPC, refer
to Chapter 2.
Logging in
When the system starts, it displays a message which asks for your name and
password. All workstation users must have their own user names (user IDs)
and passwords. If you do not know yours, consult your system administrator.
Enter your user ID and password in the appropriate fields. Your password is not
displayed in the field when you enter it. Do not use capital letters unless the
capitalization is part of the password, as the system treats capitals and lower
case letters differently. You can use the mouse or your Tab key to move
between fields.
When you have finished, press Return, or click Select on the OK button. If you
have successfully logged in, a grey workspace appears, with toolset icons at
the top left.
If you make a mistake, the system asks you to try again, displaying the
following message.
FW-21158
FW-21158
Login incorrect
OK Return
Click on OK with the Select button of your mouse. Both fields are cleared, and
you must reenter both your userID and password correctly.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-2 OPC graphical user interface
There is a limit to the number of attempts you can make at entering your
password after which the following message appears.
FW-21159
FW-21159
OK Return
If this happens, the system administrator must log in as the root user and reset
the system’s record of invalid login attempts before you will be able to try
again.
Select
Modify
Menu
Note: For an optical mouse to work properly, the pad should be aligned so
that the long sides are at the top and bottom. (An optical mouse has an LED
on its underside.)
Select Use the Select button (usually the left mouse button) to select items,
by pressing and releasing it.
Modify Use the Modify button (usually the center mouse button) to modify
selections.
Menu Use the Menu button (usually the right mouse button) to display a menu
of commands, or a choice of values. Move the pointer to a specific place on the
screen, press and hold down the right mouse button, move the pointer to the
menu item you want and release the button.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-4 OPC graphical user interface
The Select, Modify and Menu buttons also have window manipulation
functions, described in “Using the workspace” on page 3-5.
Note: On the HP 9000 keyboard, the Alt key is labeled “Extend char.” On
some Sun keyboards, it is labeled “Left” and “Right”, and on others with a
symbol. On NCD X terminals, it is labeled “Alt.”
When you use the Control, Alt, or Shift key as part of a keyboard combination,
hold the Control/Alt/Shift key down while you press the other key; for
example, Ctrl+K denotes this hold-and-press action.
The icon in the top left corner of the workspace represents the training toolset.
Toolsets are collections of tools which allow you to perform tasks.
The workspace menu (see Figure 3-2) enables you to log off the workstation
or redraw the workspace. To display the workspace menu, press and hold the
Menu mouse button while the pointer is on the workspace background.
Figure 3-2
Workspace menu
FW-20243
FW-20243
Workspace Menu
Refresh Workspace
Logout
Help
Option Description
Logout Logs you out of the workstation. A dialog asks you to confirm
your intent:
FW-21157
FW 21157
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-6 OPC graphical user interface
To display the tools in the toolset menu using the keyboard, perform the
following:
1 Tab to the toolset icon.
2 Press F4.
To start a tool from a toolset menu using the keyboard, perform the following:
1 Move cursor with arrow keys to the tool you want to start.
The menu item is highlighted.
2 Press Return.
After a short delay, the tool opens.
Tools can sometimes be started from within other tools. When this happens,
the new tool can inherit context from the previous tool. For example, if you
invoke Help from within another tool, it will give you help on the tool from
which you invoked Help.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-8 OPC graphical user interface
Status icons
The status icons listed in Figure 3-4 can appear in the tool’s main window
status area (at the left of the title bar), or beside a list item or field. They
indicate the current state of a tool, list item, or field.
Figure 3-4
Status icons
FW-20202
FW-20202
Closing a tool
To close a tool using the mouse, perform the following:
1 Move your pointer to the file menu, and hold the Menu mouse button.
The file menu appears.
2 Choose Exit.
A dialog appears, asking you whether you want to save the changes you have
made to the tool.
3 Choose Yes or No.
After a short delay, the window and all its associated dialogs closes.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-10 OPC graphical user interface
The tool status indicator tells you what the status of the window is (for
example, whether the window is being used for the task of printing or is in an
error condition). A check mark (√) means that the window is ready for
keyboard or pointer input, and no error or alarm condition is indicated by its
contents.
From the main window, you can access all the tasks available to the tool.
Figure 3-5 shows the main window of our demonstration tool, Alarm Monitor,
with a list of alarms. To open this window, click the Menu mouse button over
the Network Surv. toolset icon, then click the Select button on Alarm
Monitor.
Note: All windows and dialogs are surrounded by a frame. The frame
allows you to manage the screen.
Figure 3-5
Example main window
File menu
Options menu
List
Window
frame
Using menus
To display the menu bar menus using the keyboard, perform the following:
1 Press F10.
The left-most menu on the menu bar appears.
2 Press the appropriate arrow key to move to other Menu bar menus.
Menu Description
Status indicator This menu is located on the left side of the menu bar.
The label (in the form of a status indicator) shows the
current status of the tool (see “Status icons” on page
3-8). When displayed, the menu contains one entry,
Help.
Tool (Options and others) One or more tool menus may appear to the right of the
FIle Menu. These menus contain commands that affect
the tool as a whole.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-12 OPC graphical user interface
Object menus
Every object in the window has a menu, containing commands that affect it.
• To display the object menus using the mouse, move your pointer to the
object and press and hold the Menu mouse button. The menu appears.
• To display the object menus using the keyboard, tab to the object for which
you want to display a menu and press F4. The menu appears.
Menu Description
List item menu This menu is located at a list item. This menu contains
commands (such as Select, Deselect, Delete) that affect the
list item chosen.
List menu This menu is located in the heading area of a list. This menu
contains commands (such as Sort and New) that affect the list
as a whole.
Button menu(s) This menu is located in the button area, and contains the Help
command.
Field menu This menu is located within the field area. This menu contains
commands (such as Select, Deselect, Delete) that alter the
text in the field.
Using lists
Lists enable you to select one or more of a number of objects for further action.
Some lists allow only one selection; others allow any number of selections at
once. Lists can have any number of items and can be scrolled to show items
not currently displayed. (Refer to “Scrolling” on page 3-14 for information on
scrolling.)
Lists have a list menu and a list item menu. The list menu provides commands
that affect the list as a whole. List item menu commands affect an individual
item (or group of items). An example list, showing a list menu and a list item
menu, is shown in Figure 3-6.
Figure 3-6
Lists and associated menus
FW-21063
List title
Inactive item
List item
• To select one or more list items using the mouse, move the pointer to a list
item and click the Select mouse button. To select more than one list item,
press and hold the Select mouse button and drag.
• To select one or more list items using the keyboard, tab to the list. The first
item is highlighted. Use the arrow keys to move. To select more than one
list item, hold the Shift key and then use the arrow keys.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-14 OPC graphical user interface
Table 3-1 lists and describes the standard list item menu commands:
Table 3-1
List item menu commands
Command Description
Open Opens a dialog filled with data about the selected list item.
This command applies only to lists with items that can be
opened, such as lists of data records. You can also use the
keyboard shortcut Alt+O.
Select all Selects all items in the list. You can also use the keyboard
shortcut Alt+A.
Select this item Selects the item that was under the pointer.
Scrolling
Scroll bars appear when a window (or a scrolling field or list) cannot fully
display its contents. Both vertical and horizontal scroll bars can appear. Scroll
bars have three distinct areas, shown in Figure 3-7.
Figure 3-7
Scroll bar areas
FW-21112
FW-21112
A scroll bar consists of two arrow buttons on either end of a trough and a slider
(or view bar) in the trough. The slider represents the current position and size
of the viewed portion of the data relative to all the data (as represented by the
trough). When the slider totally fills the trough, all the data is visible.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-16 OPC graphical user interface
The keyboard can also be used to perform the same window operations. When
using the keyboard, the Alt key is often used. On the HP 9000 keyboard, the
Alt key is labeled “Extend char.” On some Sun keyboards, it is labeled “Left”
and “Right”, and on others with a symbol. On NCD X terminals, it is labeled
“Alt.”
Window frame
menu button Restore Alt+F5
Move Alt+F7
Window frame Alt+F8
Size
menu
Minimize Alt+F9
Maximize Alt+F10
Lower Alt+F3
Raise Alt+F2
Close Alt+F4
Minimize button
Maximize button
Resize borders
Note: The frames around dialogs do not have a title bar, a minimize button,
a maximize button, or a frame menu button. There are also no handle bars
or resize borders.
All the window operations can also be performed using the window frame
menu. Once you have gone through the following sections on window
operations using the pointer and keyboard, you might want to try the window
operations using the menu. If so, note the following:
• To display the window frame menu, click the Select mouse button on the
window frame menu button (if using the keyboard, press Alt+Space).
• To choose the operation you want off the menu, click the Select mouse
button. If you are using the keyboard, use the arrow keys to move to the
operation and then press Return.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-18 OPC graphical user interface
Targeting a window
Keyboard input only affects a window (or dialog) when you are focused on that
window.
The window on which you are currently focused is known as the target
window. The target window is indicated as follows: The frame of the window
is grey, while the title bar and the left border of the window is dark. (For
dialogs, the left and top borders are dark.)
To target the windows and dialog one at a time using the mouse, move the
mouse into the desired window. Note how each window takes the focus as you
move the pointer into that window.
Note that when you move the pointer into a window that is partially covered
by another window, that window takes the focus but does not come to the front.
To bring a window to the front, click the Select button in that window’s title
bar. To send a window to the back, click the Menu button in that window’s title
bar.
To target the windows or associated dialogs one at a time using the keyboard,
perform the following:
1 Press Alt+F6 to move from a tool’s main window to its (open) dialogs. Note
that this does not open a new dialog box.
2 Press Alt+Tab to move from main window to main window.
For example, to move the Help window to the front using the mouse, perform
the following:
1 Position the pointer on the frame of the Help window.
2 Click Select.
To move the Help window to the front using the keyboard, press Alt+F2.
Remember when you are using the keyboard that the window or dialog that
you want to move to the front must be targeted first.
Note: You cannot raise a main window over any of its dialogs.
You can also send any window or dialog to the back. To send a window or
dialog to the back using the mouse, perform the following:
1 Position the pointer on the frame.
2 Hold down the Shift key and click Select.
To move a window to the back using the keyboard, press Alt+F3. Remember
when you are using the keyboard that the window or dialog that you want to
move to the back must first be targeted.
Moving windows
Both windows and dialogs can be moved about the workspace. To move a
window or dialog, perform the following:
1 Position the pointer anywhere on the frame, then press and hold the Modify
button (the second mouse button).
2 Move the pointer to the left and down.
The dialog moves with the pointer.
3 Release the Modify button when the dialog is correctly positioned.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-20 OPC graphical user interface
Minimizing windows
You can minimize any window into an icon. Minimized windows are still
active and will continue processing.
To minimize the main window into an icon using the mouse, perform the
following steps:
1 Position the pointer on the minimize button of the main window.
2 Click Select.
The window and associated dialogs become an icon and is placed starting in
the bottom left.
To minimize the main window into an icon using the keyboard, perform the
following steps:
1 Press Alt+F9.
The window and associated dialogs become an icon.
2 Move the icon to the left side of the workspace to keep it out of the way. You
can move icons the same way you move windows.
Maximizing windows
You can increase the size of any window to the maximum allowable size.
To increase the size of the Help window to the maximum using the mouse,
perform the following steps:
1 Position the pointer on the maximize button of the help window.
2 Click Select.
The window fills the screen.
To increase the size of the Help window to the maximum using the keyboard,
Press Alt+F10.
To restore a maximized window to the previous size and location using the
mouse, perform the following steps:
1 Position the pointer on the maximize button of the help window.
2 Click Select.
The window returns to the previous size and location.
To restore a maximized window to the previous size and location using the
keyboard press Alt+F5.
To restore a minimized window to its previous size and location using the
mouse, perform the following steps:
1 Position the pointer on the icon.
2 Double click the Select button.
The main window and its associated dialog return to their previous size and
location.
To restore a minimized window to its previous size and location using the
mouse, perform the following steps:
1 Make certain the icon has focus.
Note: If not, use Alt+Tab until it has focus.0
2 Press Alt+F5.
The main window and its associated dialog return to their previous size and
location.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-22 OPC graphical user interface
Sizing a window
You can increase or decrease the size of any window horizontally, vertically,
or proportionally.
To change the size of a window using the mouse, perform the following steps:
1 Position the pointer on the border you want to change (left, right, top, bottom,
or any corner).
The cursor changes shape to indicate the direction of size change chosen.
2 Press and hold the Select mouse button.
3 Now move the pointer in the direction you want to go.
The border of the window follows the cursor.
4 Release the Select button when you reach the desired size.
The sizing stops.
To change the size of a window using the keyboard, perform the following
steps:
1 Press Alt+F8.
The window title bar lightens.
2 Press and hold the appropriate arrow key (for example, if you want to resize
the width of the window, choose the left or right arrow key).
3 Release the arrow key when you reach the desired size.
The sizing stops.
4 Press Return to exit from the resize mode.
Getting Help
Online Help is available for every window and dialog, and for all objects
within a window or dialog.
To obtain Help on a window using the mouse, perform the following steps:
1 Move the pointer to the background menu, and press the Menu mouse button.
The background menu appears.
2 Move the pointer to the Help entry and choose it by releasing the Menu
mouse button.
Note: You can also choose Help from the Help menu at the right-most position
of the Menu bar (which contains <tool> overview, Using Help, Navigation, and
Product Information). For dialogs, there is no Menu bar, so Help is available
only from the background menu.
To obtain Help on a window using the keyboard, press F1.
Help appears at the top right of the screen in a separate window, similar to that
shown in Figure 3-9.
Figure 3-9
Example help screen
FW-21073
Use the menu for the Alarm list title bar to create new
alarms, sort the list, and delete old alarms.
Use the menu for any list item to see or change the settings
for any particular alarm.
When you want to quit Message Alarm, choose Exit from the
File menu on the window menu bar.
When the Help window first displays, it presents Concepts Help. Concepts
Help gives you a general explanation of the purpose of an object (in this case,
the Message Alarm main window). Concepts and Navigation help types are
always provided; other types may or may not be.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-24 OPC graphical user interface
To view another type of Help using the mouse, perform the following:
1 Move your pointer to the appropriate button at the bottom of the window.
2 Click the Select mouse button.
To view another type of Help using the keyboard, perform the following:
1 Use the arrow keys to move to the appropriate Help type.
2 Press Return.
Commands Help describes the commands on the menu. (In the case of Help on
an object such as a list menu, Commands Help describes the commands on the
list menu.) Navigation Help tells you how to navigate around the screen, as
well as how to perform basic functions.
To obtain information on how to operate the Help window using the mouse,
perform the following:
1 Move the pointer to the Help menu on the Help window.
2 Choose Help on Help.
To obtain information on how to operate the Help window using the keyboard
(see Figure 3-10), you have a choice:
• Press Ctrl+H
• Press F1
Figure 3-10
Help on help
FW-21075
FW-21075
Help on Help
The window manager's title bar names the object for which
help is being provided. Beneath the title bar is the menu
bar, which holds the File and Help menus. Next is the
information area; if there is more information than can be
displayed at once, use the scroll bars to scroll the
unviewable text. At the bottom of the window is a listing
of the help types that can be selected.
Done Alt+Return
Help On Help describes the Help window and how it works. It appears in a
separate dialog, and can be referred to as you use or manipulate a Help
window.
To remove the Help on Help information dialog using the mouse, perform the
following:
1 Move the pointer to the Done button.
2 Click the Select mouse button.
To remove the Help on Help information dialog using the keyboard, perform
the following:
1 Tab to the Done button.
2 Press Return.
You can close the help window by choosing Exit from its File menu.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-26 OPC graphical user interface
Entering information
The NE Commissioning Data dialog is used for setting up an HDT. To open
this dialog, click the Menu mouse button on the SLAT toolset, select
Commissioning Manager from the menu, then click the “Commission New
Network Element” button in the Commissioning Manager window.
Figure 3-11 shows the NE Commissioning Data dialog box.
Figure 3-11
NE Commissioning Data dialog
Field
Radio buttons
Action button
This dialog is filled with fields and buttons, and you must be able to navigate
throughout the dialog to enter information.
To navigate from object to object within a window or dialog using the mouse,
perform the following:
1 Move the pointer to the object.
2 Click the Select mouse button.
Note: Clicking the Select mouse button on some objects—such as action
buttons— activates their functions.
Fields
This section describes the major types of fields that accept typed data. “Editing
text” describes how to modify the contents of a field.
Standard fields
Figure 3-12 shows a standard field, and its associated menu.
Figure 3-12
Example text field
FW-21110
Field Menu
FW-21110
Field label field text
Select all Ctrl+/
Deselect all Ctrl+\
Cut Shift+Delete Char
Copy Ctrl+Insert Char
Paste Shift+Insert Char
Delete Ctrl+K
Help Ctrl+H
To move to a field, either click Select on it, or press the Tab key until the cursor
appears there.
To type information into a standard field using the mouse, perform the
following:
1 Move the pointer over the box and click Select.
A pointer, looking like an inverted T, appears in the field.
2 Type the information. You might be able to type more characters than fit in the
box.
If so, the field scrolls automatically to the right so that you can see what you
are typing.
To type information into a standard field using the keyboard, perform the
following:
1 Tab to the field.
A pointer, looking like an inverted T, appears.
2 Type the information. You might be able to type more characters than fit in the
box.
If so, the field scrolls automatically to the right so that you can see what you
are typing.
Fields can be mandatory or optional: mandatory fields are marked with a black
triangle at the left side of the field, and require you to enter information.
Optional fields do not require you to enter information.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-28 OPC graphical user interface
Choosers
Choosers enable you to select a preset value from a menu. The box at the right
end of the field is the chooser. Figure 3-13 shows an example of a field with a
chooser, its chooser menu, and the field menu (note that the appearance of a
chooser may vary from system to system).
Figure 3-13
Example chooser
FW-21106
FW-21106
Field label Option a
Option a
Option b
To display and enter the correct chooser value using the mouse, perform the
following:
1 Move your pointer to the rectangular box.
2 Press and hold the Menu mouse button and choose one of the options.
The option that you have chosen appears in the field.
To display and enter the correct chooser value using the keyboard, perform the
following:
1 Press Shift+F4.
2 Use your arrow keys to move to the option you want, and choose it by
pressing Return.
The option that you have chosen appears in the field.
Scrolling fields
Scrolling fields are much like standard fields, but they allow you to type many
lines of information. Figure 3-14 shows an example of a scrolling field and its
menu.
Figure 3-14
Example scrolling field
FW-21105
Selectbe
Here is some text that might all in a Ctrl+/
scrolling field. Deselect all Ctrl+\
Cut Shift+Delete Char
When you type past the border of the
Copy Ctrl+Insert Char
field, a scroll bar appears. You can then
Paste Shift+Insert Char
Delete Ctrl+K
Help Ctrl+H
Click Select in the box and start typing. When you get to the edge of the box,
the text wraps to the next line. When the box is full, it scrolls downward to
allow more typing and a scroll bar appears. Scroll bars are described under
“Navigation.”
To move from a scrolling field to another object within the window or dialog
using the mouse, perform the following:
1 Move the pointer to the object.
2 Click the Select mouse button.
To move from a scrolling field to another object within the window or dialog
using the keyboard, press Ctrl+Tab.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-30 OPC graphical user interface
Buttons
Three different types of buttons are used in the graphical user interface; radio
buttons, check boxes, and action buttons. They look different, and are used for
different purposes.
Radio buttons
Radio buttons allow you to choose one of a set of options. They appear as an
array of labeled diamonds, one of which is highlighted as shown in
Figure 3-15.
Figure 3-15
Example radio buttons
FW-21107
FW-21107
Option A
Option B
Option C
To select a radio button using the mouse, click Select on the radio button that
you want to choose. The diamond beside that radio button is highlighted.
Check boxes
Check boxes allow you to activate one or more of a set of options. They appear
as an array of labeled boxes. Active options have check marks in them, as
shown in Figure 3-16.
Figure 3-16
Example check boxes
FW-21108
FW-21108
✔ Option 1
Option 2
To select or deselect a check box using the mouse, Click Select on the box.
If a check mark appears in the box, the option is on. If the check mark disappears from
the box, the option is off.
To select or deselect a check box using the keyboard, perform the following:
1 Press the appropriate arrow key to move to the check box you want.
2 Press Return.
If a check mark appears in the box, the option is on. If the check mark
disappears from the box, the option is off.
Note: Inactive check boxes are dimmed.
Action buttons
Action buttons tell the system to do something, such as apply changes to the
system, or cancel a dialog. Action buttons contain their labels, and can have
keyboard shortcuts assigned to them. Figure 3-17 shows examples of three
action buttons.
Figure 3-17
Example action buttons
FW-21109
FW-21109
To select an action button using the mouse, Click Select on the button. The
action associated with the button is activated.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-32 OPC graphical user interface
To select an action button using the keyboard, perform the following steps:
1 Tab to the action button you want.
2 Press Return.
The action associated with the button is activated.
Note: Inactive action buttons are dimmed.
Editing text
The following procedures describe the methods available for entering,
selecting, and editing text.
Entering text
Before you can insert or delete text, you must first position your cursor.
To position your cursor using the keyboard, use the arrow keys to move to
where you want to edit.
You can insert text once you have positioned the cursor, or you can use the
Backspace key to delete text.
To cut selected text using the keyboard, Press Ctrl+Delete Char. The previously
selected text disappears.
To copy the selected text using the mouse, perform the following steps:
1 Press Menu on the text field.
2 Choose Copy from the field menu. The selected text does not disappear.
To copy the selected text using the keyboard, Press Ctrl+Insert. The selected
text does not disappear.
To paste the cut or copied text using the mouse, perform the following:
1 Click the Select mouse button at the place where you want the text to be
pasted.
2 Press the Menu mouse button, and choose Paste from the field menu.
The previously cut or copied text reappears in the new location.
To paste the cut or copied text using the keyboard, perform the following:
1 Use the arrow keys to move to the place where you want the text to be pasted.
2 Press Shift+Insert.
The previously cut or copied text reappears in the new location.
To replace text with cut or copied text using the mouse, perform the following:
1 Press the Menu mouse button in the field in which you have the selected text.
2 Choose paste from the field menu.
New text replaces the old text.
To replace text with cut or copied text using the keyboard, select the text to
replace and then press Shift+Insert. The new text replaces the old text.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-34 OPC graphical user interface
Editing commands
If you want to edit a block of text, use the editing commands on the menu
associated with the field you are editing (or use the keyboard equivalents).
Table 3-2 shows a list of editing commands.
Table 3-2
Editing commands
Command Keyboard Action
equivalent
Note: Shortcut keys affect the object with keyboard focus, which might not
be the object that your pointer is on. Be sure the cursor is in the field you
want to edit before using a shortcut key sequence.
Command areas
Command areas are used for sending typed commands to a tool. They have two
main parts: a command field where you type commands and a history field
which keeps a record of the commands you have typed. Figure 3-18 shows an
example of a command area.
FW-21103
Separator
History field
Again
>
Command field Select this command
Select all Ctrl+/
Deselect this command
Deselect all Ctrl+\
Command field menu
Copy Ctrl+Insert Char
Cut Shift+Delete Char
Help Ctrl+H
Copy Ctrl+Insert Char
Paste Shift+Insert Char
History field menu
Delete Ctrl+K
Help Ctrl+H
The Command field menu presents the standard editing commands, which are
discussed in “Editing text.” The History field menu commands are the
following:
Command Description
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-36 OPC graphical user interface
History fields
History fields can be resized.
To change the size of a history field using the mouse, perform the following:
1 Move the pointer to the separator line box.
The pointer becomes a double-ended arrow.
2 Press and hold the Select mouse button, and move up or down.
The history field area increases or decreases respectively.
3 Release the Select mouse button when you are finished sizing the history
field.
To change the size of a history field using the keyboard, perform the following:
1 Tab to the separator line box.
The box is highlighted.
2 Use the up or down arrow keys.
The history field area increases or decreases respectively.
Closing a tool
When you are finished with a tool, choose Exit from the File menu on the
Menu bar.
FW-21092
Exit menu
In some cases, a dialog appears, asking you whether you want to save the
changes you have made.
FW-21096
FW-21096
Select the Yes button to save changes and exit, No to exit without saving, or
Cancel to return to the tool.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
3-38 OPC graphical user interface
Logging out
When you are ready to leave the workspace, move the pointer to the workspace
background, press Menu to open the workspace menu and select Logout.
FW-20243
FW-20243
Workspace Menu
Refresh Workspace
Logout
Help
FW-21157
cvalrm Alarm details—to view detailed information about modem- page 4-6
shelf and Voice Port alarms
For a detailed description of the commands available for each CI tool, refer to
the appropriate page for the CI tool listed in Table 4-1.
Note: The command names and keywords are not case sensitive.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-2 CI tool user interface
Command Description
If you are using TL1, use only alphanumeric characters and underscores in
alias strings.
Opening a CI tool
If you want to initiate a CI, perform the following steps.
1 Log in to the OPC.
2 Open the NE Login Manager tool.
3 Log in to the network element.
4 At the prompt, enter the following:
quit all ↵
5 At the CI prompt, enter the following:
cornerstone ↵
The CORNERSTONE CI prompt appears.
6 Open the CI tool by entering the name of the CI tool. For example, if you want
to perform spectrum maintenance, enter:
cvspmn ↵
Once you have initiated the CI, you enter CI commands to carry out the desired
operations. Refer to Chapter 9 for detailed instructions on how to use the CI
tool user interface.
CSOPTCI commands
Use the optionality commands to enable or query a particular Cornerstone
option.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts the user to reenter the data.
Table 4-3
CSOPTCI commands
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-4 CI tool user interface
queryOpt
Syntax
queryopt
Description
Queries optionality. Displays the entire set of optional features and which
features have been enabled.
Parameters
None.
Example Command
> QueryOpt
Successful Response
PEC Feature Status
--------- ------------------ ------
NTBN47AB RF_CONC ON
NTBN74AB EXTENDEDRANGE ON
NTBN74AC ENCRYPTION OFF
NTBN74AE ENCRYPTION OFF
NTBNXXX4 FEAT_3 OFF
NTBNXXX5 FEAT_3 OFF
NTBNXXX6 FEAT_3 OFF
NTBNXXX7 FEAT_3 OFF
NTBNXXX8 FEAT_3 OFF
NTBNXXX9 FEAT_3 OFF
NTBNXXXA FEAT_3 OFF
Error Response
None.
Enable
Syntax
Enable <token> <token_value> <parameter> <Opt_Code>
Description
Enables an optional feature on a given system and extended range for the
HDT.
Parameters
<token> is the desired addressing method for the feature. It will be
either FEAT to address the feature by the feature name or PEC
to address the feature by the PEC code.
<token_value> is the name of the feature if FEAT was selected as the token;
otherwise, <token_value> must be the PEC code for the
optional feature. Both values will be displayed on the
optionality code printout received from Cornerstone
Operations.
<parameter> is the desired addressing method for the feature. It will be
either FEAT to address the feature by the feature name or PEC
to address the feature by the PEC code.
<Opt_code> is the 16-digit optionality code obtained from Arris
Commercial Operations. This optionality code is specific to
the ABM system and the feature specified.
Example Command
> Enable PEC NTBN47AB 52e0b4893e4dd991
> Enable FEAT RF_CONC 52e0b4893e4dd991
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-6 CI tool user interface
CVALRM CI commands
Use the alarm details commands to view detailed information about modem-
shelf and voice-port alarms.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts the user to reenter the data.
Table 4-4
CVALRM CI commands
alrmdisp
Syntax
alrmdisp <filter criteria>
Description
This command allows you to display all of the active alarms in the Modem
Shelf alarm buffer.
Parameters
<filter criteria> is filter criteria for the alarms to be displayed:
ALL — displays all alarms. This is the default value.
FA — displays facility alarms.
EQ — displays equipment alarms.
SP — displays spectrum alarms.
C — displays critical alarms.
MA — displays active major alarms.
MI — displays active minor alarms.
Example Command
> alrmdisp
Successful Response
Active Alarms
Alm Class Shelf Type Unit Reason Severity
--- ----- ----- ---- ---------- -------------------------------------- --------
3 EQP MS1 DMC 9 DMC Circuit Pack Total Fail M,SA
Raised: 15:17:32 04/12/1999
Error Response
No alarms match filter criteria.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-8 CI tool user interface
alrmrpt
Syntax
alrmrpt <alarm report ID>
Description
This command allows you to display details of a specific alarm.
Parameters
<alarm report ID>is the alarm report ID given in the alarms list.
Example Command
> alrmrpt 4
Successful Response
There are three different detail alarm formats:
Equipment -
ALARM 4
Address: DMC 3 m,nsa
Location: Modem Shelf 1 Slot 3 21:17:52
Reason: Circuit pack fail 04/12/1999
Equip ID: <Equip_id> PEC: <PEC_code> Equipment
Facility -
ALARM 4
Address: Head End Modem 13-2 m,SA
Location: Modem Shelf 1 Slot 13 Modem 2 21:18:37
Reason: DMC Head End Modem Loss of Signal 04/11/1999
Carrier Path: <CP_id> Facility
Spectrum -
ALARM 4
Address: Spectrum Manager m,nsa
Location: 21:23:05
Reason: Minimum Upstream Protection Band Limit 04/12/1999
Carrier Path: <CP_id> Spectrum
The Address and Location fields of the alarm details convey different
information depending on the maintenance entity raising/clearing the alarm.
Maintenance Entity Address Location
Error Response
ERROR: Unused Alarm Specified.
history
Syntax
history <filter criteria>
Description
This command allows you to display all of the alarms in the Modem Shelf
alarm history buffer that match the filter criteria.
Parameters
<filter criteria> is filter criteria for the alarms to be displayed:
ALL — displays all alarms. This is the default value.
FA — displays facility alarms.
EQ — displays equipment alarms.
SP — displays spectrum alarms.
C — displays critical alarms.
MA — displays active major alarms.
MI — displays active minor alarms.
Example Command
> history
Successful Response
Alarm History
Alm Cls Shlf Type Unit Reason Severity
--- --- ---- ---- ------ ---------------------------- --------
24 Eqp MS1 DMC 1 Circuit Pack Failure clear
23 Fac REM VP <VPid> Voice Port Facility Degraded clear
4 Eqp MS1 DMC 3 Circuit Pack Failure M,SA
2 Fac MS1 HEM 13-2 DMC Head End Modem LOS m,SA
41 Spe MS1 CP <CPid> Marshalling Frequency Unavail. m,nsa
Error Response
EITHER incorrect optional parameter(s) OR too many parameters.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-10 CI tool user interface
CVEQPT CI commands
Use the equipment maintenance commands to maintain modem-shelf
equipment and Voice Ports.
The detailed description of the commands includes syntax and parameters and
gives examples of their use.
Table 4-5
CVEQPT CI commands
addDMC
Syntax
addDMC <dmc id>
Description
This command allows you to manually provision the selected DMC.
Parameters
<dmc id> is the DMC id: 1 to 14.
Example Command
> addDMC 10
Successful Response
DMC 10 has been successfully provisioned.
Error Response
DMC request rejected because DMC is in an invalid state.
Specified DMC has already been added.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-12 CI tool user interface
Checkvp
Syntax
checkvp <id type>
checkvp dist <parameter1> <parameter2>
checkvp HEM <DMC> {1 to 14} <modem> {1 to 2} DIST
<parameter1> <parameter2>
checkvp CP <direction> DIST <parameter1> <parameter2>
Description
This CsV04 and newer command allows you to list Voice Ports that do not fit
the specified criteria: PEC or LOAD names, distance, level, HEM, or carrier
path. CsV06 and later versions also allow listing Voice Ports by signal quality.
In CsV06.2 and later, the CheckVP command replaces the LEVEL parameter
with a new DBMV parameter. This allows checking for explicit transmit levels
rather than relative levels.
In CsV08 and later, reflects the extended range delays in meters when Voice
Ports are within the extended range.
Parameters
<id type> specifies the Voice Ports to exclude from the list, based on
one of the following criteria:
PEC <code> [<code>...] — one or more Voice Port PEC codes
LOAD <loadname> [<loadname>...] — one or more Voice Port
software load names
DIST <low> <hi> — distance from the headend, in km (0 to 80)
DBMV <low> <hi> — Voice Port transmit level (5 to
55 dBmV)
HEM <DMC> <modem> <id type> — list Voice Ports attached
to a specific HEM, excluding those that match PEC, LOAD,
DIST, or DBMV criteria as specified above. You can also
specify a signal quality range using SIGQUAL <low> <high>
(0 to 50).
CP <direction> <id type> — list Voice Ports assigned to a
specific carrier path (US <path> for upstream or DS <path> for
downstream, 0 to 56 in either case), excluding those that match
PEC, LOAD, DIST, or DBMV criteria as specified above.
<parameter> specifies the parameter for 1 or 2.
parameter1: <low (km)> {0 to 144}
Example Command
> checkvp hem 1 1 dist 70 80
> checkvp dist 0 80
> checkvp hem 6 1 dist 0 80
> checkvp cp us 1 dist 0 80
> checkvp cp ds 10 dist 0 80
Successful Response
The command displays the Voice Port ID and specified criteria; for example:
VP no. VP ID Distance (m)
---------- -------- ---------------------
1 11110002 120600
2 222220045 98600
3 1111010113 98600
4 11110088 98600
5 570482561 98600
6 570442636 98600
7 570426694 98600
8 214799934 98600
9 214749926 150600
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-14 CI tool user interface
chgModemChan
Syntax
chgModemChan <DMC> <modem> <direction> <channel code>
Description
This command allows you to change up or down stream communication
frequency for the specified modem.
Parameters
<direction> is the direction of the frequency: US (upstream) or
DS (downstream).
<dmc id> is the DMC id: 1 to 14.
<channel code> is the downstream and upstream communication frequency
range represented as a channel code.
For downstream, the frequency range is a 1.792 MHz
frequency range of channels from 375 - 750 MHz: 98 to 1562.
For upstream, the narowband frequency range is a 1.792 MHz
frequency range of channels from 5 - 42 MHz: 1 to 144.
For upstream, the wideband frequency range is a 1.792 MHz
frequency range of channels from 5-65 MHz: 1 to 234.
Note: Refer to Appendix C: Channel center frequencies of the
Engineering Guidelines, ARSVD00388, for upstream and
downstream channel codes.
<modem id> is the modem id: 1 or 2.
Example Command
> chgModemChan 14 2 US 135
Successful Response
Modem frequency is changed to upstream channel 135.
Error Response
Specified modem does not exist.
Specified frequency is not provisioned.
Specified frequency is not available.
chgstateDMC
Syntax
chgstateDMC <dmc id> <target state>
Description
This command allows you to change the primary state of the selected DMC.
Parameters
<dmc id> is the DMC id: 1 to 14.
<target state> is the target service state: IS or OOS.
Example Command
> chgstateDMC 10 OOS
Successful Response
DMC 10 is now OOS.
Error Response
DMC request rejected because DMC is in an invalid state.
Specified DMC does not exist.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-16 CI tool user interface
chgstateModem
Syntax
chgstateModem <dmc id> <modem id> <target state>
Description
This command allows you to change the primary state of the selected modem.
Parameters
<dmc id> is the DMC ID: 1 to 14.
<modem id> is the modem ID: 1 to 2.
<target state> is the target service state: IS or OOS.
Example Command
> chgstateModem 10 1 OOS
Warning: This command will affect service.
Please confirm (“Yes” or “No”):
Successful Response
Modem 1 of DMC 10 is now OOS.
Error Response
Request rejected because HEM is in an invalid state.
HEM unequipped.
Specified HEM is already <target state>
chgstateSM
Syntax
chgstateSM <sm id> <target state>
Description
This command allows you to change the selected Spectrum Manager
equipment state.
Parameters
<sm id> is the Spectrum Manager on which the carrier path is carried:
1 to 4.
Note: Although the range is 1 to 4, only two Spectrum
Managers are supported.
<target state> is the target service state: IS or OOS.
Example Command
> chgstateSM 2 OOS
Successful Response
Spectrum Manager #2 is OOS.
Error Response
The specified Spectrum Manager ID does not exist.
Request rejected because Spectrum Manager is in an invalid state.
Specified Spectrum Manager is already <target state>.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-18 CI tool user interface
chgstateVP
Syntax
chgstateVP <id type> <target state>
Description
This command allows you to toggle the Voice Port between the in-service and
out-of-service state.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
<target state> is the target service state: IS or OOS.
Example Command
> chgstateVP ALIAS ‘Norcross’ OOS
> chgstateVP VP 123456 IS
Successful Response
Voice Port state changed to OOS.
Error Response
Voice Port equipment does not exist.
Specified voice port alias does not exist.
Specified voice port is already <target state>.
delDMC
Syntax
delDMC <dmc id>
Description
This command allows you to deprovision the selected DMC.
Parameters
<dmc id> is the DMC ID: 1 to 14.
Example Command
> delDMC 10
Successful Response
DMC 10 has been deleted.
Error Response
DMC request rejected because DMC is in an invalid state.
Specified DMC does not exist.
DMC must be OOS to be deleted.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-20 CI tool user interface
delSM
Syntax
delSM <sm id>
Description
This command allows you to delete the selected Spectrum Manager.
Parameters
<sm id> is the Spectrum Manager on which the carrier path is carried:
1 to 4.
Note: Although the range is 1 to 4, only two Spectrum
Managers are supported.
Example Command
> delSM 2
Successful Response
Spectrum Manager #2 has been deprovisioned.
Error Response
The specified Spectrum Manager ID does not exist.
Request rejected because Spectrum Manager is in an invalid state.
Spectrum Manager must be OOS to be deleted.
delVP
Syntax
delVP <id type>
Description
This command allows you to delete the Voice Port provisioning data and the
equipment data.
This command can be used when a homeowner moves.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
Example Command
> delVP ALIAS ‘new_customer_4567890’
Warning: VP will be deleted.
Please confirm (“Yes” or “No”):
> delVP VP 123456
Warning: VP will be deleted.
Please confirm (“Yes” or “No”):
Successful Response
Provisioning and equipment records of Voice Port have been
deleted.
Error Response
Voice Port equipment does not exist.
Specified Voice Port alias does not exist.
Voice Port has service provisioned.
No response from the modem shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-22 CI tool user interface
diagSM
Syntax
diagSM <sm id>
Description
This command allows you to run diagnostics on the selected Spectrum
Manager chassis.
Parameters
<sm id> is the Spectrum Manager on which the carrier path is carried:
1 to 4.
Note: Although the range is 1 to 4, only two Spectrum
Managers are supported.
Example Command
> diagSM 2
Successful Response
Diagnostics are currently underway. Please refer to CV
logs for the results.
Error Response
The specified Spectrum Manager ID does not exist.
Spectrum Manager is in an invalid state for this request.
Specified spectrum manager is busy - try again later.
queryBattery
Syntax
QueryBattery <ID Type>
Description
The QueryBattery command displays all Voice Ports that match one of the
specified battery conditions.
Parameters
<id type> designates how to list the Voice Ports:
ALL <valid states> — lists all Voice Ports assigned to this HDT
for the valid state specified (NORMAL, REPLACE,
NO_BATTERY, NO_AC_GOOD_BATT, NO
_AC_REPLACE_BATT, N_A).
HEM <dmc> <modem> <valid states> — lists Voice Ports
connected to a specified DMC (1 to 14) and a specified modem
(1 or 2) in a valid state.
COUNT ALL <valid states> — counts all Voice Ports assigned
to this HDT for a specified valid state.
COUNT HEM <dmc> <modem> — counts all Voice Ports
assigned to this HDT
Example Command
> querybattery all no_ac
> querybattery hem 8 2 no_ac_good_batt
> querybattery count all no_battery
> querybattery count all normal
Successful Response
Count VPID Power Condition
------ ------------- -----------------
1 16783413 No AC Power 1 1
2 16774611 No AC Power, Battery Good
3 16778993 No AC Power, Replace Battery
1 16783413 Normal 0 1
2 16733443 No AC Power 0 1
1 16819791 Normal
2 16774611 No AC Power, Battery Good
3 16721935 Normal
4 16687434 Normal
5 16687555 Normal
Error Response
No Voice Ports are assigned to the specified modem.
No response from the modem shelf ... aborting.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-24 CI tool user interface
queryDMC
Syntax
queryDMC <dmc id>
Description
This command allows you to show the status of the selected DMC.
Parameters
<dmc id> is the DMC ID: 1 to 14.
Example Command
> queryDMC 1
Successful Response
> Unit: DMC 1
Primary State: IS
FW Load in FLASH A: DDM18DR01
FW Load in FLASH B: DDM18DR01
Circuit Pack: NTBN19DA
Serial Number: L1AMP7Y
Manufacturer’s Date:08/FEB/1999
Modem 1: Primary State: IS Secondary State:
DS CP: 2 Spectrum_Chan_Code:400
US CP: 1 Spectrum_Chan_Code:72
TX Level: 30 dBmV RX Level: 15 dBmV
Modem 2: Primary State: IS Secondary State:
DS CP: 4 Spectrum_Chan_Code:353
US CP: 3 Spectrum_Chan_Code:66
TX Level: 30 dBmV RX Level: 15 dBmV
Error Response
Specified DMC does not exist.
No response from modem shelf.
queryMS
Syntax
queryMS
Description
This command displays the status of the Modem Shelf (MS) equipment and
Spectrum Managers.
Parameters
None.
Example Command
> queryMS
Successful Response
Slot Type PEC Primary Secondary
---- ---- ---------- ------- ---------
1 DMC NTBN19CA IS
2 DMC NULL
3 DMC NULL
4 DMC NTBN19CA IS
5 DMC NULL
6 DMC NULL
7 DMC NTBN19AA IS
8 DMC NTBN19AA IS
9 DMC NULL
10 DMC NULL
11 DMC NTBN19CA IS
12 DMC NULL
13 DMC NULL
14 DMC NTBN19CA OOS
15 MSC NTBN20AB IS
-- SM NTBN21AB IS
-- SM NULL NULL
-- SM NULL NULL
-- SM NULL NULL
Error Response
No response from the modem shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-26 CI tool user interface
queryMSC
Syntax
queryMSC
Description
This command allows you to query the MSC equipment.
Parameters
None.
Example Command
> queryMSC
Successful Response
Unit: 1
State: IS
FW Load in RAM: CMSNAD18BG00
FW Load in FLASH A: CMSNAD18BG00
FW Load in FLASH B: CMSNAD18BG00
MSC Current Active Flash: Bank B
Circuit Pack: NTBN20AC
Serial Number: A1A2T8U
Manufacturer's Date: 12/DEC/1996
Error Response
None.
querySM
Syntax
querySM <sm id>
Description
This command allows you to show the status of the selected Spectrum
Manager.
Parameters
<sm id> is the Spectrum Manager on which the carrier path is carried:
1 to 4.
Note: Although the range is 1 to 4, only two Spectrum
Managers are supported.
Example Command
> querySM 2
Successful Response
Unit: Spectrum Manager 1
Primary State: IS
Secondary State:
FW Load in RAM: - vAU.01
Circuit Pack: NTBN21AB
Error Response
Specified Spectrum Manager does not exist.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-28 CI tool user interface
queryVP
Syntax
queryVP <id type> <parameter1> <parameter2>
Description
This command allows you to query the status, marshalling state, and
configuration of a Voice Port.
For CsV06:
• This command includes an indication for battery condition and status of
local power supplies via telemetry. This feature is not supported by all voice
ports and will show "N/A" for those that do not support this feature.
For CsV08:
• This command displays the status of line card modules installed in the MAX
24 Voice Port. The MAX 24 does not have specific battery telemetry points,
so battery telemetry only applies to the AC power condition.
1 = normal (AC power is present
2 = no AC power
GTP 1 & 2 are only displayed for the MAX 24 Voice Port.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-30 CI tool user interface
Error Response
Specified voice port id does not exist.
Specified voice port alias does not exist.
Specified modem id does not exist.
No voice port assigned to the specified modem id.
No voice ports are provisioned with the specified service.
No response form the modem shelf.
No voice ports are in the specified CATV mode.
No voice ports found.
No voice ports are in the specified state.
resetMSC
Syntax
resetMSC [FORCE]
Description
This command allows you to reset the MSC equipment.
Parameters
FORCE Optional parameter, resets the MSC in cases where the MSC
is not responding to commands, but the lower level
communications is present. Do not use this option unless
instructed by support.
Note: If lower level communications are not present, you will
see a message when executing the queryMS command. The
FORCE option can be used to reset the MSC remotely in cases
where the MSC SW application is not responding (for
example, a database vintage mismatch).
Example Command
> resetMSC force
Successful Response
Initiated MSC reset. Check logs for diag results.
Error Response
Unable to send message to modem shelf, RC=bmBadLink.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-32 CI tool user interface
resetVP
Syntax
resetVP <id type>
Description
This command allows you to manually restart the software on a Voice Port.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
Example Command
> resetVP ALIAS ‘Norcross’
> resetVP VP 123456
Successful Response
Initiated Voice Port reset. Check logs for reset results.
Error Response
Unable to send message to modem shelf, RC=bmBadLink.
CVLOADER CI commands
Use the load management commands to download firmware loads to modem-
shelf equipment and Voice Ports.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts the user to reenter the data.
Table 4-6
CVLOADER CI commands
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-34 CI tool user interface
cvload
Syntax
cvload <proc type> <loadname>
Description
This command allows you to load the specified processor. Use this command
to reload or upgrade software in the HDT.
Parameters
<proc type> is the processor to be loaded; one of:
VP <id type> — a Voice Port; use ALIAS <alias> to specify by
alias or VP <id> to specify by VPID (1 to 4294967295).
DMC <id type> — specifies a Dual Modem Card by slot
number (1 to 14)
MSC — specifies the Modem Shelf Controller.
SM <proc> — specifies a Spectrum Manager (1 or 2)
Note: The Spectrum Manager must already have the AV01 or
newer firmware load before using this command. While
loading the Spectrum Manager, out-of-band Voice Port
marshalling is suspended and frequency agility is impaired.
<loadname> is the name of the file on the OPC that contains the software
that is to be loaded on the processor.
Example Command
> cvload DMC 12 CDMNAL11AA01
> cvload vp vp 16801614 CVPPHL16AX99
Successful Response
In addition to the following response, this command generates a CVLDxxx log
containing details of the load attempt.
listdefaults
Syntax
listdefaults
Description
Starting in CsV04, this command allows you to display the loads currently
contained in the default load entity set on the MSC. This includes Voice Port,
DMC, Modem Shelf Controller, and Spectrum Manager loads.
Parameters
None.
Example Command
> listdefaults
Successful Response
The current CV Modem Shelf Load Lineup file is CV_1900MS.load.
---------------------------------------------------------
Processor PEC Date Load Name
--------- --- ---------- ------------
MSC NTBN20AA 02-02-99 CMSNAL19AA01
SM NTBN21AB 02-02-99 CSMNAL11AV01
Error Response
No Default loads assigned. Use SyncDefaults command.
CVLOADER ERROR: OPC not responding, check association.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-36 CI tool user interface
mscflswact
Syntax
mscflswact
Description
This command swaps the MSC flash and resets to the processor (CsV04 and
newer).
Parameters
None.
Example Command
> mscflswact
Successful Response
Swact command sent Check loader logs for result.
Error Response
Msc communication failure; please try again later.
queryCVswldFile
Syntax
queryCVswldFile
Description
This command displays the current Modem Shelf Load Lineup file.
Parameters
None.
Example Command
> queryCVswldFile
Successful Response
The CV modem shelf load lineup file that will be used in
the next potential upgrade situation is CV_1803MD.load.
The APU database release number currently associated with
it is REL1803.
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-38 CI tool user interface
queryload
Syntax
queryload <proc id> <id type>
Description
This command allows you to display the load that is currently on the specified
processor.
Parameters
<proc type> is the processor to be loaded; one of:
VP <id type> — a Voice Port; use ALIAS <alias> to specify by
alias or VP <id> to specify by VPID (1 to 4294967295).
DMC <id type> — specifies a Dual Modem Card by slot
number (1 to 14)
MSC — specifies the Modem Shelf Controller.
SM <sm id> — specifies a Spectrum Manager, either 1 or 2.
Example Command
> queryload VP VP11087
Successful Response
<proc type> is running firmware release: <release type>
Error Response
The specified processor instance does not exist
Voice port<#> not found in the database. Try again.
setCVswldFile
Syntax
setCVswldFile <file> [FORCE]
Description
This command updates the Modem Shelf Load Lineup file.
Parameters
<file> is the name of the new load lineup file.
FORCE optional parameter; forces an update.
Example Command
> setCVswldFile CV_1803MD
Successful Response
The CV Modem Shelf Load Lineup File has been successfully
updated from CV_1802MD.load to CV_1803MD.load.
Error Response
Invalid CV Modem Shelf Load Lineup Filename
The file name must begin with CV_ and be between 4 and 14 characters in
length. Do not append the “.load” extension.
<file>.load is not accessible.
The load file must be in /users/VFS/users/csv on the OPC, and must have
read permissions.
There is no need to update the CV Modem Shelf Load Lineup File
The specified file is already the current load lineup file.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-40 CI tool user interface
syncdefaults
Syntax
syncdefaults
Description
This command allows the MSC to read the defaults load file on the OPC and
to update the default load entity set on MSC to match the file on OPC. If there
was a discrepancy between the OPC version and the MSC version, loads on
the OPC are propagated to the appropriate processors which reset to allow the
new load to take effect.
Parameters
None.
Example Command
> syncdefaults
Successful Response
Warning: This action is service affecting. All processors
will be downloaded with their defaulted loads.
Please confirm (Yes or No):
Y
Default load synchronization complete.
Error Response
Default load synchronization failed.
Command Rejected. SM1 is currently downloading.
The SyncDefaults command cannot run while a Spectrum Manager is
being loaded.
MSC communication failure; please try again.
CVPATH CI commands
Use the carrier path CI commands to provision and deprovision carrier paths
and headend modems.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts the user to reenter the data.
The Modem Shelf Controller (MSC) is the centralized entity to validate the
consistency of the provisioning input. The cvpath CI requires the MSC to be
in service to process every command except queryCP and queryPortThSM.
The CI indicates the MSC is not in service even though this error response is
not explicitly specified for each command.
Table 4-7
CVPATH CI commands
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-42 CI tool user interface
Table 4-7
CVPATH CI commands (continued)
addCP
Syntax
addCP <cp id> <name> DS <marshalling mode>
<marshalling parameter> <HE to nearest VP>
addCP <cp id> <name> US <sm id> <sm port> <ds cp id>
<HE to nearest VP>
Description
This command allows you to add a new carrier path to the cable network. The
path can be either downstream or upstream.
To define an upstream path, specify the monitoring Spectrum Manager port
and identify the correlating downstream path.
To define a downstream path for multiple upstream paths, specify the
marshalling mode, either in band or out of band. For out-of-band marshalling,
specify the common Voice Port marshalling channel shared by all the return
paths. For in-band marshalling, specify the minimum marshalling delay by
entering the distance between head end and the nearest Voice Port installed on
the defining path.
If the specified Spectrum Manager does not exist, you are prompted to
continue. If you choose to continue, the HDT places the (non-existent)
Spectrum Manager in an IS-Trbl-Comms-Down state.
Add an additional marshalling channel using the allocMarshSpectCP
command to handle marshalling frequency agility. Refer to
“allocMarshSpectCP” on page 4-45.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<name> 20 character carrier path name.
US, DS indicates the direction of this carrier path, either upstream or
downstream.
<marshalling mode>
is the marshalling mode of the carrier path: IB (in band) or
OOB (out of band).
<marshalling parameter>
for the desired marshalling mode:
IB - distance between the headend and the nearest Voice Port
(in km): 0 to 64.
OOB - common upstream frequency channel set aside for out-
of-band Voice Port marshalling: 4 to 141 for narrowband; 4 to
231 for wideband.
<sm id> is the Spectrum Manager on which the carrier path is carried:
1 to 4.
Note: Although the range is 1 to 4, only two Spectrum
Managers are supported.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-44 CI tool user interface
<sm port> is the Spectrum Manager port associated with the upstream
carrier path:1 to 14.
<ds cp id> is the downstream carrier path that corresponds to this
upstream carrier path: 1 to 56.
<HE to nearest vp>
is the minimum distance between the head end and nearest
Voice Port (in km): 0 to 64.
Example Command
case 1> addcp 1 ‘downstream_1’ DS OOB 237
case 2> addcp 3 ‘upstream_3’ US 1 1 1
case 3> addcp 4 ‘upstream_4’ US 1 2 2
case 4> addcp 2 ‘downstream_2’ DS IB 9
Successful Response
case 1: Downstream carrier path 1, ‘downstream_1’, is
defined. The common upstream channel 140 is used for Voice
Port out-of-band marshalling.
case 2: Downstream carrier path 2, ‘downstream_2’, is
defined to utilize in-band marshalling. The nearest Voice
Port is 9 kilometers away from its head end.
case 3: Upstream CP 3, ‘upstream_3’, is defined and
monitored by Spectrum Manager 1 port 1. It correlates to
downstream path 1.
case 4: Upstream CP 4, ‘upstream_4’, is defined and
monitored by Spectrum Manager 1 port 2. It correlates to
downstream path 2.
Error Response
Unable to set narrowband. Wideband Channel is in use.
The specified carrier path id is in use.
The correlating downstream CP does not exist.
Maximum number of SM addresses exceeded.
The specified Spectrum Manager port is in use.
Multiple return paths requires a marshalling channel allocated.
Exceeded the maximum number of provisioned cp for the specified direction.
No response from the Modem Shelf.
allocMarshSpectCP
Syntax
allocMarshSpectCP <ds cp id> <us freq>
Description
This command allows you to allocate a common frequency, specified as a
channel code, used by headend modems assigned to various return paths to
marshall Voice Port on the same downstream carrier path.
The specified marshalling channel should be disjoint from communication
channel bands. The maximum number of marshalling channels is 10.
This command is acceptable when marshalling mode is out of band.
Parameters
<ds cp id> is the downstream carrier path that corresponds to this
upstream carrier path: 1 to 56.
<us freq> is the upstream marshalling (frequency) channel: 4 to 141 for
narrowband; 4 to 234 for wideband.
Example Command
> allocMarshSpectCP 1 70
Successful Response
Marshalling frequency channel 70 allocated to carrier
path 1.
Error Response
Specified CP does not exist.
Specified path is not a DS CP.
Specified channel is already allocated for Voice Port communication.
Maximum number of marshalling channels exceeded.
Marshalling mode is not OOB.
No response from the Modem Shelf.
Cannot allocate Wideband Marshalling Channel on Tied Group.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-46 CI tool user interface
allocSpectCP
Syntax
allocSpectCP <cp id> <low> <high>
Description
This command allows you to assign the frequency channel range, used by
modem communication, of a given carrier path.
The maximum of communication channel bands is 42. To accommodate 28
headend modems per Modem Shelf, the required maximum number of discrete
channel bands is 28. Also, to support a 2:1 protection ratio, additional 14
channel bands are available.
If the number of contiguous channel to cover the bandwidth of 2 MHz
required by one headend modem is 7, then, (n x 7) contiguous clear channels
are required to provide the bandwidth for n headend modems to communicate
with the attached Voice Ports.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<low> and <high>
is the downstream and upstream communication frequency
range represented as a channel code.
For downstream, the frequency range is a 1.792 MHz
frequency range of channels from 375 - 750 MHz: 98 to 1562.
For upstream, the frequency range is a 1.792 MHz frequency
range of channels from 5 - 65 MHz: 1 to 144 for narrowband;
1 to 234 for wideband.
Note: Refer to Appendix C: Channel center frequencies of the
Engineering Guidelines, ARSVD00388, for upstream and
downstream channel codes.
Example Command
> allocSpectCP 2 180 194
Successful Response
Frequency channels [180..194] added to carrier path 2.
Error Response
Specified CP does not exist.
Specified upstream channel range contains marshalling channel.
Maximum number of channel bands exceeded.
No response from the Modem Shelf.
Frequency overlap with tied group. Cannot allocate spectrum.
CP tied together and in narrowband. Cannot change to Wideband.
asgnModemCP
Syntax
asgnModemCP <dmc id> <modem id> <ds cp id> <us cp id>
<tx power> <rx power>
Description
This command allows you to assign a modem to the specified upstream and
downstream carrier path.
To avoid affecting service, the bandwidth of the specified paths must be
sufficient for frequency assignment to the given modem, in addition to
protection bands. Refer to “queryCP” on page 4-57 to determine the
availability of those bandwidth.
Parameters
<dmc id> is the DMC ID: 1 to 14.
<modem id> is the modem: 1 or 2.
<ds cp id> and <us cp id>
are the downstream and upstream carrier path ids to which the
modem will be connected: 1 to 56.
<tx power> is the downstream transmission power level for the modem (in
dBmV): 25 to 55.
<rx power> is the upstream transmission power level for the modem (in
dBmV): -5 to 20.
Note: The transmit and receive power levels are average
engineered levels that the modem will be transmitting and
receiving respectively. Refer to the Engineering Guidelines,
ARSVD00388 for details on how to set these levels.
Example Command
> asgnModemCP 6 1 1 2 25 5
Successful Response
Ok.
Modem 1 on DMC 6 assignments made:
downstream - 1
upstream - 2
TX power - 25 dBmV
RX power - 5 dBmV
Error Response
Specified carrier path does not exist. Provision it with addCP followed by
allocSpectCP command.
Specified modem is already assigned to other CPs.
Specified upstream carrier path does not have enough bandwidth.
Specified downstream carrier path does not have enough bandwidth.
Specified upstream path is not a return path of the specified downstream path.
Specified path is not used for upstream direction.
Specified path is not a DS CP.
Unable to assign modem carrier path due to incorrect shelf type. Please insert
DMC into corresponding modem shelf slot and reassign modems to carrier
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-48 CI tool user interface
path.
No response from the Modem Shelf.
chgMarshMode
Syntax
chgMarshMode <cp id> <marshalling mode>
<marshalling parameter>
Description
This command allows you to change the marshalling mode. All the related
parameters associated with the previous marshalling mode are reset. For
instance, after changing to in-band marshalling, the out-of-band marshalling
channel count resets to zero.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<marshalling mode>
is the marshalling mode of the carrier path: IB (in band) or
OOB (out of band).
<marshalling parameter>
is the marshalling parameter for the desired marshalling mode.
For IB, this parameter is the distance between the head end
and the nearest Voice Port (in km): 0 to 64.
For OOB, this parameter is the common upstream frequency
channel set aside for out-of-band Voice Port marshalling:
4 to 141 for narrowband, 4 to 231 for wideband.
Example Command
> chgMarshMode 2 IB 5
Successful Response
OK.
Error Response
Specified carrier path does not exist.
Specified path is not a DS CP.
Marshalling mode was already the same as specified.
More than one return path is associated with the specified down stream carrier
path.
No response from the Modem Shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-50 CI tool user interface
chgNameCP
Syntax
chgNameCP <cp id> <name>
Description
This command allows you to rename the specified carrier path.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<name> is the 20 character carrier path name.
Example Command
> chgNameCP 1 ‘first_downstreamPath’
Successful Response
Carrier path 1 renamed to [first_downstreampath].
Error Response
Specified CP does not exist.
No response from the Modem Shelf.
Unable to send message to modem shelf: bmBadLink.
chgSMPortCP
Syntax
chgSMPortCP <cp id> <old sm id> <old sm port> <new sm id>
<new sm port>
Description
This command allows you to use a different port of a Spectrum Manager to
monitor an upstream carrier path.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<old sm id> is the Spectrum Manager on which the carrier path is carried:
1 to 4.
Note: Although the range is 1 to 4, only two Spectrum
Managers are supported.
<old sm port> is the old Spectrum Manager port: 1 to 14.
<new sm id> is the Spectrum Manager on which the carrier path is carried:
1 to 4.
Note: Although the range is 1 to 4, only two Spectrum
Managers are supported.
<new sm port> is the new Spectrum Manager port: 1 to 14.
Example Command
> chgSMPortCP 2 4 1 4 11
Successful Response
Carrier path 2’s Spectrum Manager changed to SM ID:4,
PORT: 11.
Error Response
Specified upstream CP does not exist.
Carrier path is not used for upstream direction.
Carrier path was not monitored by the Spectrum Manager port being specified.
Maximum number of SM addresses exceeded.
New SM port is already in use.
No response from the Modem Shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-52 CI tool user interface
deallocMarshSpectCP
Syntax
deallocMarshSpectCP <ds cp id> <us freq>
Description
This command allows you to deallocate a marshalling frequency channel on
the given downstream carrier path when out-of-band marshalling mode is
used.
To support out-of-band marshalling for a topology configured with one
downstream path and multiple return paths, provision at least one common
marshalling channel.
Parameters
<ds cp id> is the downstream carrier path that corresponds to this
upstream carrier path: 1 to 56.
<us freq> is the upstream marshalling (frequency) channel: 1 to 141 for
narrowband, 1 to 234 for wideband.
Example Command
> deallocMarshSpectCP 3 231
Successful Response
Marshalling frequency channel 231 deallocated from carrier
path 3.
Error Response
Specified CP does not exist.
Specified path is not a DS CP.
Specified channel is not used for marshalling.
Invalid to deallocate the last marshalling frequency code for a multiple return
paths topology.
Marshalling mode is not OOB.
No response from the Modem Shelf.
deallocSpectCP
Syntax
deallocSpectCP <cp id> <low> <high>
Description
This command allows you to reduce or deallocate the frequency range, used
by modem communication, of a given carrier path.
The maximum number of communication channel band is 42 (refer to the
description of “addCP” on page 4-43 for the rationale of this limitation). To
deallocate frequency channel bands you can break one allocated band into two
sub-bands. The upper bound must be followed.
To avoid affecting service, the reduced bandwidth must be sufficient to serve
all the assigned modems as well as the protection bands.
In addition, the specified channel band should exclude any marshalling
channel. Use “deallocMarshSpectCP” on page 4-52 to free a marshalling
channel.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<low> and <high>
is the downstream and upstream communication frequency
range represented as a channel code.
For downstream, the frequency range is a 1.792 MHz
frequency range of channels from 375 - 750 MHz: 98 to 1562.
For upstream, the frequency range is a 1.792 MHz frequency
range of channels from 5 - 42 MHz for narrowband: 1 to 144,
or 5 - 65 MHz for wideband: 1 to 234.
Note: Refer to Appendix C: Channel center frequencies in the
Engineering Guidelines, ARSVD00388, for the upstream and
downstream channel codes.
Example Command
After using the command allocSpectCP 1 98 200
deallocSpectCP 1 98 124
Warning: Delete channel may impact service.
Please confirm (“Yes” or “No”):
Successful Response
Frequency [180..194] deallocated from carrier path 2.
Error Response
Specified CP does not exist.
Insufficient bandwidth for the modems currently assigned or for the protection
band limit currently set on this CP..
Maximum number of channel bands exceeded.
No response from the Modem Shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-54 CI tool user interface
deasgnModemCP
Syntax
deasgnModemCP <dmc id> <modem id>
Description
This command allows you to deassign the specified headend modem from the
cable network.
To avoid service interference, no Voice Port must be assigned to this headend
modem. If a Voice Port was assigned to this modem, copy the vp_id along
with its provisioned data first. Use deasgnVp to delete those affected Voice
Ports provisioning data. After deasgnModemCP is completed, use
appropriate commands to recover those deleted provisioning data. If a line was
provisioned as CSC POTS, use the DMS MAPCI to make the necessary
corrections as well.
Parameters
<dmc id> is the DMC ID: 1 to 14.
<modem id> is the modem ID: 1 to 2.
Example Command
> deasgnModemCP 5 1
This will delete CP assignments for modem 2 on DMC 6.
Please confirm ("Yes" or "No"):
>y
Successful Response
Modem is deassigned.
Error Response
Specified modem does not exist.
Command rejected. This modem is serving provisioned Voice Ports.
No response from the Modem Shelf.
The specified receive power level does not match the DMC version.
Specified modem is not assigned to a carrier path.
delCP
Syntax
delCP <cp id>
Description
This command allows you to remove a carrier path from the cable network by
specifying the id.
To avoid service interference, ensure that no headend modems are currently
provisioned on this carrier path. If required, use “deasgnModemCP” on page
4-54 to move those affected modem first.
All upstream carrier paths associated with a downstream carrier path must be
deleted prior to deleting the downstream path.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
Example Command
> delCP 1
About to delete CP 1, “first_downstreamPath”
Please confirm (“Yes” or “No”):
Successful Response
Carrier path 1 deleted.
Error Response
Specified CP does not exist.
There are modems provisioned on the specified carrier path.
There are Voice Port provisioned on the specified carrier path.
There are return paths associated with the specified DS CP.
No response from the Modem Shelf.
Canot delete CP. CP tied together.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-56 CI tool user interface
Enable_ExtRange
Syntax
Enable_ExtRange
Description
This command allows you to extend the range for the HDT by setting the
extended range ON (for the entire HDT). This is only available after extended
range has been enabled via CSOPTCI.
Parameters
None.
Example Command
> Enable_ExtRange
Successful Response
Extended distance for this HDT is ON.
queryCP
Syntax
queryCP [<cp id>]
Description
This command displays the upstream or downstream direction, the name, the
modem list, the allocated modem communication frequency channel bands of
the carrier path table. The Spectrum Manager port and the associated
downstream path id are associated with an upstream carrier path; the out-of-
band marshalling channel is associated with a downstream carrier path using
out-of-band marshalling; the distance between head end and the nearest Voice
Port is associated with a downstream carrier path using in-band marshalling.
Parameters
<cp id> is an optional parameter that specifies the ID for either
upstream or downstream carrier path: 1 to 56. Up to half of
the IDs are used for upstream, the other 28, at most, are used
for downstream. When path is specified, a detailed
information, rather than a summary, is displayed.
Example Command
> queryCP
> queryCP 1
Successful Response
> queryCP
scan #of marshalling DS
id CP name dir port PB dist.(Km)/chan Cp Comm Channels
-- --------- --- ---- --- --------------- --- -------------
1 Norcross DS - - 141 - 500-1500
2 Windward DS - - 135 - 500-1500
3 Atlanta US 1 2 - 1 40- 140
4 Suwanee US 1 2 - 1 24- 133
> queryCP 1
CPid = 1, CPname = Norcross
Direction : DS
Marshalling mode : OOB
Marshalling channel : 141
Communication channel : 500-1500
Modems connected : 1,1 1,2 2,1 2,2 3,1 3,2 4,1 4,2
> queryCP 2
CPid = 1, CPname = Atlanta
Direction : US Downstream CP id :1
Spec Mgr Id : 1 Spec Mgr Port :1
Route Diversity : On
Communication channel : 1-100
Modems connected : 4,1 4,2
Num of prot band :1 Noise threshold : -25.00 dBmV
Error Response
Specified carrier path does not exist.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-58 CI tool user interface
queryPortThSM
Syntax
queryPortThSM <cp id>
Description
This command allows you to show the noise threshold setting for the selected
carrier path.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
Example Command
> queryPortThSM 2
Successful Response
The threshold is 30.00 dBmV.
Error Response
Specified CP does not exist.
Specified path is not used for upstream direction.
queryTG
Syntax
queryTG [<tg id>]
Description
This command allows you to show all of the tied groups that have been created
and lists all of the carrier paths associated with each group. This command is
only available in wideband markets using Cornerstone release 8.1 and later.
Parameters
<tg id> is an optional parameter that specifies the ID for a specific tie
group: 1 to 27.
Example Command
> queryTG
> queryTG 1
Successful Response
>queryTG
> Group ID US Carrier Path Band
-------------------------------------------
1 3 NB
5 WB
2 8 NB
7 WB
>queryTG 1
> Group ID US Carrier Path Band
-------------------------------------------
1 3 NB
5 WB
Error Response
No tie groups have been provisioned.
This feature is available only on Wideband system.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-60 CI tool user interface
setMinMarshDistance
Syntax
setMinMarshDistance <cp id> <HE to nearest vp>
Description
This command sets the minimum distance, in kilometers, between the head
end and the nearest Voice Port assigned to the specified downstream carrier
path.
This command is valid only when the marshalling mode is in band.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<HE to nearest vp>
is the minimum distance between the head end and nearest
Voice Port (in km): 0 to 100.
Example Command
> setMinMarshDistance 2 2
Successful Response
OK.
Error Response
Specified CP does not exist
Specified CP is not a downstream CP.
The marshalling mode is not IB.
No response from the Modem Shelf.
setModemRxPower
Syntax
setModemRxPower <dmc id> <modem id> <us rx power>
Description
This command allows you to set the specified modem upstream receiving
power level.
Parameters
<dmc id> is the DMC ID: 1 to 14.
<modem id> is the modem ID: 1 to 2.
<us rx power> is the upstream receiving power level for the modem
(in dBmV):
Model 1 DMC: 0 to 20
Model 2 and Model 3 DMC: –5 to 20
Example Command
> setModemRxPower 5 1 15
Successful Response
Input power lever of modem 1 on DMC 5 set to 15 dBmV.
Error Response
Specified modem is not assigned to a carrier path.
No response from the Modem Shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-62 CI tool user interface
setModemTxPower
Syntax
setModemTxPower <dmc id> <modem id> <ds tx power>
Description
This command allows you to set the specified modem downstream
transmission power level.
Parameters
<dmc id> is the DMC ID: 1 to 14.
<modem id> is the modem ID: 1 to 2.
<ds tx power> is the downstream transmitted power level for the modem
(in dBmV): 25 to 55
Example Command
> setModemTxPower 5 1 35
Successful Response
Modem 1 on DMC 5 transmission power level set to 35 dBmV.
Error Response
Specified modem does not exist.
No response from the Modem Shelf.
setPortThSM
Syntax
setPortThSM <us cp id> <threshold value>
Description
This command allows you to set the noise threshold power level for the
selected upstream carrier path.
Parameters
<us cp id> is the carrier path: 1 to 56.
<threshold value>
is the maximum acceptable RF noise level for channels
associated with the carrier path (dBmV x 100): -3375 to 3000
(in increments of 25)
Note: An input of -2500 corresponds to -25.00 dBmV..
Note: The Spectrum Manager converts the value entered into
an equivalent dBmV value that is used to determine if the
channel is acceptable for voice communication.
Example Command
> setPortThSM 2 425
Successful Response
The threshold of CP 2 is set to 4.25 dBmV.
Error Response
Specified CP does not exist.
Specified path is not used for upstream.
No response from the Modem Shelf.
Invalid threshold value
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-64 CI tool user interface
setProtBandCP
Syntax
setProtBandCP <us cp id> <num pb>
Description
This command allows you to set the minimum number of 2 MHz upstream
frequency protection bands to the specified upstream carrier path before
alarming.
To avoid affecting service, the bandwidth of the specified path must be
sufficient to support the given protection bands in addition to all the assigned
modems. Refer to “queryCP” on page 4-57 to determine the availability of the
bandwidth.
Parameters
<us cp id> is the carrier path: 1 to 56.
<num pb> is the minimum number of protection bands: 0 to 14.
Example Command
> setProtBandCP 12 2
Successful Response
2 protection channel bands are reserved for carrier path
12.
Error Response
Specified CP does not exist.
Specified path is not an upstream carrier path.
Insufficient spectrum available for protection band assignment.
No response from the Modem Shelf.
setRouteDiversity
Syntax
setRouteDiversity <us_cp> <mode>
Description
This command lets you change route diversity settings for the specified carrier
path. It is available in CsV06.2 and later releases.
Use this command in systems that do not use diversely-routed fiber paths; this
minimizes service impacts resulting from the HDT’s response to fiber outages.
If your system supports redundant fiber paths, do not disable route diversity;
otherwise, Voice Port recovery times will increase significantly in the event of
a fiber switch.
Parameters
<us_cp> is the upstream carrier path id: 1 to 56.
<mode> is the route diversity mode for this carrier path: OFF or ON
Example Command
> setRouteDiversity 2 off
Successful Response
Turning RouteDiversity OFF for a CP that actually has multiple routes can increase
the recovery time for a route switch from under 5 minutes to over an hour.
Are you sure you want to turn RouteDiversity OFF for CP: 2?
Please confirm ("Yes" or "No"):
>yes
Ok.
The RouteDiversity for CP 2 is set to OFF.
Error Response
Specified path is not used for upstream direction.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-66 CI tool user interface
tieCP
Syntax
tieCP <tied group id> <carrier path id> <carrier path id>
Description
This command allows you to tie logical upstream carrier path’s together as a
single physical upstream. When tieing carrier paths together, 1 narrowband
and 1 wideband carrier path must be tied together and the marshalling channel
must be in the narrowband spectrum. This command is only available in
wideband markets using Cornerstone release 8.1 and later.
Parameters
<tied group id> is the ID for that identifies a particular group of carrier paths
that are tied: 1 to 27.
<carrier path id> is the ID associated with a provisioned upstream carrier
path: 1 to 56.
Example Command
> tieCP 1 1 4
Successful Response
Carrier paths have successfully been tied together.
Error Response
Invalid upstream carrier path id. No carrier paths have been tied together.
Carrier path is already tied together. Command rejected.
Carrier path id is out of range. No carrier paths have been tied together.
Too many carrier path id’s specified. No carrier paths have been tied together.
Two upstream carrier path id’s must be identified. No carrier paths have been
tied together.
Marshalling channel must be narrowband. No carrier paths have been tied
together.
Carrier path frequencies are overlapping. No carrier paths have been tied
together.
Wideband must be set to use this command. Command rejected.
Invalid group id. No carrier paths have been tied together.
No response from modem shelf. No carrier paths have been tied together.
Tied Group ID already exists. Command rejected.
Both CPs are NB. Only NB and WB carrier paths can be tied.
Both CPs are WB. Only NB and WB carrier paths can be tied.
No marshalling channel allocated. No carrier paths have been tied together.
untieCP
Syntax
untieCP <tied group id>
Description
This command allows you to logically separate the two carrier paths that were
assigned to a group. This command is only available in wideband markets
using Cornerstone release 8.1 and later.
Parameters
<tied group id> is the ID for that identifies a particular group of carrier paths
that are tied: 1 to 27.
Example Command
> untieCP 1
Successful Response
Carrier paths have successfully been removed from the
group.
Error Response
Invalid group id. No carrier paths have been untied.
No response from modem shelf. No carrier paths have been untied.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-68 CI tool user interface
CVPROV CI commands
Use the Voice Port provisioning commands to provision and deprovision
customers’ cable TV and phone services.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts the user to reenter the data.
Table 4-8
CVPROV CI commands
Table 4-8
CVPROV CI commands
RF concentration
Figure 4-1 shows an example of the CVPROV commands when RF
concentration is enabled.
Figure 4-1
RF concentration enabled
>addline
Next par is: <Id Type> {Alias <Alias> STRING,
VP <ID> {1 TO 4294967295} }
Enter: <Id Type> <Line Number> <Service Type>
>1 10 on
The line was allocated with a 1-based LC instance: 6
Provisioning accepted, check LC LOG for service activation.
>addline
Next par is: <Id Type> {Alias <Alias> STRING,
VP <ID> {1 TO 4294967295} }
Enter: <Id Type> <Line Number> <Service Type>
>1 10
The line was allocated with a 1-based LC instance: 7
Provisioning accepted, check LC LOG for service activation.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-70 CI tool user interface
Note: When RF concentration is enabled using the optionality feature, the new
conc mode parameter appears. This may require some changes to your
existing provisioning scripts.
addLine
Syntax
addLINE <id type> <line_number> <svc_type>
Description
Provisions a line service to be either a MVI POTS, LCM POTS, V5.2 POTS,
or EBS.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
<line_number> is the line number, 1 to 24, on the Voice Port.
<svc_type> <device>
is the service to be provisioned. The supported types are:
LCMPOTS <vlcm> <lsg> <slot> [<conc>] — service is
provisioned against a VLCM number, lsg number, and slot
number. The VLCM number ranges from 1 to 7. The lsg
number is from 0 to 19. The slot number is from 0 to 31.
LCMPOTS service applies to Chile, Japan and DMS100.
V5POTS <if> <port> [<conc>] — service is provisioned
against a V5.2 interface and port ID. The interface ID ranges
from 1 to 16777215. The port ID ranges from 0 to 32767.
MVIPOTS <host> <crv> [<conc>]
EBS <host> <crv> — service is provisioned against host id and
Call Reference Value. The host id is 1 to 5. CRV ranges from
1 to 2048.
<conc> is a flag to indicate if the line is concentrated or non-
concentrated. Enter ON for a concentrated line and OFF for a
non-concentrated line. The choice for the flag can only be
entered if the RF Concentration feature is enabled in
Cornerstone optionality for MVIPOTS, LCMPOTS, and
V5POTS.
Example Command
Adding a (Voice Port=16780139, Line Card=1) as a V52POTS (Interface
ID=111, Port ID=95) w/RF Concentration
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-72 CI tool user interface
asgnVpHEM
Syntax
asgnVpHEM <id type> <dmc id> <modem id>
Description
This command allows you to assign a Voice Port to a headend modem with
CATV enabled.
This command has been deleted from CsV06.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
<dmc id> is the DMC id: 1 to 14.
<modem id> is the modem: 1 or 2.
Example Command
> asgnVpHEM ALIAS ‘Voice Port ABC’ 1 1
> asgnVpHEM VP 123456 1 1
Successful Response
Voice Port alias ‘Voice Port ABC’ assigned to DMC1
modem 1.
Voice Port 123456 assigned to DMC 1 modem 1.
Error Response
Specified modem does not exist.
Voice Port was assigned to another upstream path than the one connecting to
the specified headend modem.
All 24 PCM channels are used by the specified modem.
No response from the Modem Shelf.
Specified modem is not assigned to a carrier path.
The voice port is already assigned to a different HEM.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-74 CI tool user interface
CATV
Syntax
CATV <id type> <catv status>
Description
This command allows you to turn on or turn off a CATV service by either
specifying Voice Port alias or Voice Port id.
This command is not supported for Multi-line Voice Ports (MVP) or the Max
24 voice port. An MVP will indicate that CATV service has been enabled even
though the Voice Port does not support CATV.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
<catv status> is ON or OFF.
Note: This command defaults to OFF for Chile and Dutch
loads, ON for all other loads.
Example Command
> CATV VP 123456 ON
> CATV ALIAS ‘Voice_Port_ABC’ OFF
Successful Response
CATV service turned ON for Voice Port 123456.
CATV service turned OFF for VP Alias Voice_Port_ABC.
Error Response
Specified voice port alias does not exist.
No response from the Modem Shelf.
This command is not applicable.
chgVpID
Syntax
chgVpID <old vp id> <new vp id>
Description
This command allows you to change an old Voice Port id to a new one when a
Voice Port is replaced. Use this command if your cable system strictly uses vp
id, not Voice Port alias, to provision a service.
Once a Voice Port is detected, the system generates a database record to
monitor the equipment. This command triggers the deletion of the old Voice
Port equipment record and changes the association of the provisioning record
from the previous Voice Port id to the newly installed Voice Port id.
When detecting a Voice Port, the system generates an equipment record and a
provisioning record, if needed, and associates both records with the Voice Port
id.
When the Voice Port is replaced by a new one, the system generates a second
equipment record. The provisioning record is still associated with the previous
Voice Port id. The system deletes the equipment record of the first Voice Port
and changes the provisioning record association to the new Voice Port id.
Parameters
<old vp id> and
<new vp id> are the decimal ids of the old and new Voice Ports
respectively: 1 to 4294967295.
Note: Voice Port aliases cannot be used in this command.
Example Command
> chgVpID 123456 112233
Successful Response
Warning: This command will affect service.
Please confirm (“Yes” or “No”):
Yes
Ok.
Error Response
The specified original Voice Port id does not exist.
The specified new Voice Port id is already in use.
No response from the Modem Shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-76 CI tool user interface
clearTstAcc
Syntax
ClearTstAcc <vp id> <line>
<line> {2, 4, 6, 8, 12, 16, 24}
Description
This command deprovisions a line that was previously provisioned for Digital
Test Access (DTA). It applies only to E1-based systems.
Parameters
<vp id> is the Voice Port id: 1 to 4294967295.
<line> is the Voice Port line previously provisioned for DTA.
Example Command
> cleartstacc 16798981 8
> cleartstacc 16798981 16
> cleartstacc 16798981 24
Successful Response
This will deprovision the following DTA line:
Voice Port:16788981
Line Card:2
Please confirm (“Yes” or “No”):
>Yes
Command is in progress, check LC LOG for result.
Error Response
Line 8 is not a valid DTA line for VP 16798981.
No response from the modem shelf.
Line 8, 16, or 24 must be used for Test Access on VP 16798981.
The specified Voice Port provisioning record does not exist.
Line number <line> is not provisioned with DTA service.
Correlate
Syntax
Correlate <vp alias> <vp id>
Description
This command associates a Voice Port alias with a VPID.
The Cornerstone HDT generates an equipment record upon detecting a Voice
Port for the first time. If a provisioning record does not exist for the Voice
Port, the HDT also creates a provisioning record using the VPID.
Preprovisioning a Voice Port using an alias also generates a provisioning
record. The correlate command merges both provisioning records into one
and relates this record to the equipment record of the same VPID.
If the preprovisioned line is a POTSRT or a MVIPOTS, refer to LC LOG for
the provisioning result.
If the alias is already associated with a VPID, the new VPID overrides the
existing one. This allows another Voice Port to replace an installed Voice Port
that malfunctions.
Parameters
<vp alias> is the Voice Port alias (see “Voice Port aliases” on page 4-2).
<vp id> is is the Voice Port id: 1 to 4294967295.
Example Command
> correlate ‘a_Voice Port_name’ 123456
Successful Response
Warning: This will affect service on the Voice Port.
Please confirm (“Yes” or “No):
>Yes
OK
Error Response
Neither the specified voice gate id nor the specified alias exist.
The specified VP id is already in use.
No response from the Modem Shelf.
Unable to send message to modem shelf: BmBadLink.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-78 CI tool user interface
cpCapacity
Syntax
cpCapacity [<us cp id>]
Description
This command allows you to display the total upstream capacity in terms of
total available PCM channels on the carrier path for provisioning of dedicated
lines. The display can be focused on one upstream carrier path, if the
parameter is specified; or towards all upstream carrier paths.
Parameters
[<us_cp_id>] optional parameter; specifies the carrier path id: 1 to 56.
Example Command
> cpCapacity
Successful Response
Num Num Total Num
# NonConc Conc Proved Avail
CPid CPname modem Lines Lines Lines Chans
==== ==================== ===== ======= ====== ====== =======
2 US_IB1 6 0 177 177 144
4 US_OOB1 10 0 646 646 240
6 US_OOB2 6 5 142 147 139
7 US_OOB3 6 0 231 231 144
Error Response
Specified carrier path does not exist.
The specified carrier path is not provisioned for upstream.
deasgnVp
Syntax
deasgnVp <id type>
Description
This command allows you to delete the Voice Port provisioning data.
This command is typically useful when tenants change in an apartment
complex.
If this command is intended to move Voice Port to a different modem, make a
copy of the Voice Port id along with all the provisioning data. The following
commands are useful when recovering those provisioning data: asgnVpHEM
or asgnVpCP, addLine, CATV, and correlate.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
Example Command
> deasgnVp ALIAS ‘new_customer_4567890’
Successful Response
Warning: VP will be de-provisioned.
Please confirm (“Yes” or “No”):
>Yes
OK
Error Response
The specified Voice Port provisioning record does not exist.
Specified Voice Port alias does not exist.
No response from the Modem Shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-80 CI tool user interface
delLine
Syntax
delLine <id type> <line number>
Description
This command allows you to delete a line service.
Parameters
<id type> specifies the Voice Port by alias or VPID:
ALIAS <alias> — where <alias> is a 20-character string
enclosed in single quotation marks (see “Voice Port aliases” on
page 4-2).
VP <id> — where <id> is a decimal number: 1 to 4294967295.
<line number> is the line number being deleted: 1 to 24.
Example Command
> delLine VP 123456 2
Successful Response
This will deprovision the following subscriber on the
Voice Port:
enableConc
Syntax
enableConc <unit>
Description
Modifies the RF Concentration mode from non-concentrated to concentrated
for the specified unit. In order to execute this command, concentration must
first be enabled using the CSOPTCI toolset. Enabling concentration is
password protected. This command is not service affecting.
Parameters
<unit> is the type of equipment for which the RF Concentration mode
will be changed. Use one of the following:
ALL — all lines on the HDT.
CP <us_id> — all lines on the specified carrier path: 1 to 56.
HEM <DMC> <modem> — all lines on the specified HEM.
LINE <vp> <line> — a single line. The <vp> parameter is either
ALIAS <alias> or VP <id> to specify a Voice Port by alias or
VPID. The <line> parameter specifies the line on the Voice
Port: 1 to 24.
Example Command
> enableConc LINE VP 11523 1
> enableConc HEM 3 1
> enableConc CP 6
> enableConc ALL
Successful Response
WARNING! RF concentration will be rejected for UAP-2
resident lines. All other lines on the specified unit will
have their concentration mode changed from OFF to ON.
Please confirm (“Yes” or “No”):
>Yes
Proceeding with command! UAP-2 resident line cards will be ignored.
Error Response
The specified Voice Port provisioning record does not exist.
The specified HEM does not exist.
The specified Carrier Path does not exist.
No response from the Modem Shelf.
Enableconc command is unavailable. RF concentration is not enabled.
The specified line is already provisioned as a concentrated line.
The specified line card provisioning record does not exist.
Concentration mode can not be enabled. The specified line has TR-08 service.
Specified upstream CP does not exist.
Specified path is not used for upstream direction.
I’m sorry, that optionality code is invalid for this system. Please contact your
Cornerstone Sales Representative to obtain a valid code.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-82 CI tool user interface
modemCapacity
Syntax
ModemCapacity <cp id>
Description
This command allows you to focus on the PCM channels consumed by those
Voice Ports grouped on HEMs assigned to the specified upstream carrier path.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
Example Command
> modemCAPACITY 2
Successful Response
CPid = 2, CPname = US_IB1
Movevp
Syntax
movevp <Id type> <to DMC> <modem>
Description
This CsV04 and later command allows you to move a Voice Port from one
HEM to another. This command allows headend engineering of RF
concentration.To be used properly, the following items must be true:
• the Voice Ports must have all lines provisioned as concentrated
• the destination HEM must not have any non-concentrated, provisioned
lines.
Lines in a “Traffic busy” state are not moved. If this command is used to move
a Voice Port that is OOS to another HEM, the Voice Port state becomes IS at
the new HEM.
Parameters
<id type> is a specific Voice Port or all Voice Ports on a HEM; one of
the following:
ALIAS <alias> — specifies a Voice Port by its alias.
VP <id> — specifies a Voice Port by VPID: 1 to 4294967295.
MODEM <DMC> <modem> — specifies all Voice Ports on the
specified DMC and modem.
<to DMC> is the destination DMC: 1 to 14.
<modem> is the destination modem: 1 or 2.
Example Command
> movevp vp 12345678 4 1
Successful Response
Working. Please wait.
Moving VP 12345678.
Moving VP 12345678 to a different CP?
Please confirm (“Yes” or “No”):
>Yes
Moving VP 12345678.
Moved VP 12345678.
Done.
Total Voice Ports moved: 1
Total Lines moved: 2
Error Response
RF Concentration must be enabled to use movevp.
The NE is not a DFA type. Command aborted.
Alias <alias name> not found.
VP ID <msn> not found.
Absence of Voice Ports
NO VP found on source DMC <dmc #> <modem #>.
MOVEVP aborted. Destination HEM cannot exceed 240 lines provisioned.
Non-conc Line Message
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-84 CI tool user interface
queryCapacity
Syntax
queryCapacity <unit>
Description
This CsV04 and newer command displays the capacity data for the specified
unit. It displays the following information on a per HEM basis:
• number of non-concentrated lines
• number of concentrated lines
• total lines provisioned
• number of RF Channels available for concentrated lines
Parameters
<unit> equipment for which the RF Concentration data will be
displayed. The display can be for all lines on a HEM, all lines
on a carrier path, or all provisioned lines:
ALL — all provisioned lines.
CP <us_cp> — all lines on the specified upstream carrier path:
1 to 56.
HEM <DMC> <modem> — all lines on the specified DMC
(1 to 14) and modem (1 to 2).
Example Command
> queryCapacity HEM 3 1
> queryCapacity CP 6
> queryCapacity ALL
Successful Response
Num Num Total Avail Ch
HEM NonConc Conc Proved for Conc
id Lines Lines Lines Lines
=== ======== ===== ====== ==========
1 1 1 2 23
Error Response
The specified Carrier Path does not exist.
No DMC card present for this HEM id.
HEM 2 is unprovisioned.
The specified carrier path is not provisioned for upstream
No modem assigned to the specified US CP id
queryEncryption
Syntax
queryEncryption
Description
Use this CSV05.2 and newer command to display encryption status for the
HDT.
Note: The queryEncryption command is available only if encryption has been
enabled for the HDT (using the Enable command). Encryption also requires
the Model 3 DMC.
Parameters
None.
Example Command
queryEncryption
Successful Response
Encryption for this HDT is ON.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-86 CI tool user interface
queryLCMsvc
Syntax
queryLCMsvc [<vlcm number> <LSG number> <slot number>]
Description
This command allows you to display provisioning data regarding LCM
services.
Parameters
If you do not specify any parameters, the provisioning data for all LCM lines
is displayed. Otherwise, LCM lines are displayed to level of detail specified.
<LSG number> is the line subgroup number: 00 to 19.
<slot number> is the slot number within the LSG: 0 to 31.
<vlcm number> is the virtual line concentration module id: 1 to 7 or all.
Example Command
ex1> queryLCMsvc 2
ex2> queryLCMsvc 2 0
ex3> queryLCMsvc 8 19 31
Successful Response
%% ex 1> queryLCMSvc
VLCM LSG Slot VP VP Line Srvc Provisioning
# # # id alias # Type Status
---- --- ---- ---------- -------------------- ---- ------- -------------
1 0 0 C. Smith 2 LCMPOTS Head End OnlyNote 1
%% ex 2> queryLCMsvc 2
VLCM LSG Slot VP VP Line Srvc Provisioning
# # # id alias # Type Status
---- --- ---- ---------- -------------------- ---- ------- -------------
2 0 3 112234 D. Alda 1 LCMPOTS Head End OnlyNote 1
%% ex 3> queryLCMsvc 2 0
VLCM LSG Slot VP VP Line Srvc Provisioning
# # # id alias # Type Status
---- --- ---- ---------- -------------------- ---- ------- -------------
2 0 3 112234 D. Alda 1 LCMPOTS Head End OnlyNote 1
%% ex 4> queryLCMsvc 8 19 31
VLCM LSG Slot VP VP Line Srvc Provisioning
# # # id alias # Type Status
---- --- ---- ---------- -------------------- ---- ------- -------------
8 19 31 123456 B. Goodall 2 LCMPOTS CompletedNote 3
Note 1: The data displayed originated from one or more CVPROV commands.
(for example, addLine, correlate, asgnVpHEM, etc.)
Note 2: The data displayed originated from a DMSX switch.
Note 3: The data displayed originated from one or more CVPROV commands
and a DMSX switch.
Error Response
No LCM service is provisioned.
queryLCTemplate
Syntax
queryLCTemplate
Description
This command queries the database on the APU and displays the template type
that is allowed to be provisioned on the Network Element. The available
template types are:
• NORTH_AMERICAN_STANDARD (7 dB Rx / 5 dB Tx loss plan)
• NORTH_AMERICAN_HIGH (3 dB Rx / 3 dB Tx high-gain loss plan)
• CHILE_PHILIPPINES
• JAPAN
• GERMANY
• NETHERLANDS
• AUSTRALIA
• AUSTRIA
• SPAIN
• FRANCE
• ARGENTINA
• BRAZIL
• COLUMBIA
• VENEZUELA
• IRELAND
• SWEDEN
• CZECH REP
• HUNGARY
• HOLLAND
• PORTUGAL
• POLAND
Parameters
None.
Example Command
> queryLCTemplate
Successful Response
Country specific line card template is region
Error Response
Cannot query at this time.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-88 CI tool user interface
queryMVIsvc
Syntax
queryMVIsvc <record type> <host> <CRV begin> <CRV end>
Description
Queries provisioning information regarding MVI services. This command is
available in CsV04 and newer releases.
Parameters
< record type > specifies the type of CRVs to search for: USED to search for
provisioned CRVs or FREE to search for available CRVs.
< host > is the host ID: 1 to 5
< CRV begin > is the beginning CRV in the range to search: 1 to 2048
< CRV end > is the ending CRV in the range to search: 1 to 2048
Example Command
> querymvisvc used 1 2 5
Successful Response
Host CRV Valid VP VP Line Srvc
# # Combo Id alias # Type
--- --- ----- ----------- ------------------ ---- ----
1 2 YES 16798171 T.Jones 1 MVIPOTS
1 3 YES 16798172 J.Wayne 2 EBS
1 4 YES 16798170 J.Stewart 1 EBS
1 55 YES 16798145 K Douglas 2 MVIPOTS
Error Response
Bad input: number of parameters is 104.
Command must include the record type and a host ID. The acceptable record
type parameters are USED or FREE. Re-enter the command with USED to
search for provisioned CRVs or free to search for available CRVs.
The acceptable range for a host ID is 1 to 5. Please re-enter the command
making sure the first parameter is between 1 and 5.
The acceptable range for CRV values is 0 to 2048. Please re-enter the
command making sure the second parameter is between 0 and 2048.
The acceptable range for CRV values is 0 to 2048. Please re-enter the
command making sure the third parameter is between 0 and 2048 and that it
is greater than the second parameter.
No MVI Services are provisioned.
queryTstAcc
Syntax
QueryTstAcc
Description
This command lists all Voice Port lines previously provisioned for Digital Test
Access (DTA).
Parameters
None.
Example Command
> querytstacc
Successful Response
VP id Line # Mapper Port DS0
---------- ------ ------ ---- ---
54095 4 G1 1 20
Error Response
There are no DTA lines provisioned.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-90 CI tool user interface
queryVpSvc
Syntax
queryVpSvc <id type>
Description
Display services provisioned on either the specified Voice Port, or all the
Voice Ports assigned to the specified modem or carrier path.
For CsV06, this command has been changed to include line card status for
each line provisioned. For digital test access lines only, a column showing
digital test access status is provided.
For CsV06.2, this command provides loop current status for Voice Ports that
support provisionable loop current (Voice Ports that do not support this feature
show N/A in this field).
Parameters
<id type> specifies one or more Voice Ports:
ALIAS <alias> — specifies a Voice Port by alias, where <alias>
is a 20-character string enclosed in single quotation marks (see
“Voice Port aliases” on page 4-2).
VP <id> — specifies a Voice Port by VPID: 1 to 4294967295
MODEM <DMC> <modem> — all Voice Ports on the specified
DMC (1 to 14) and modem (1 to 2).
CP <id> — all Voice Ports on the specified carrier path: 1 to 56
Example Command
ex 1> queryVpSvc VP 123456
ex 2> queryVpSvc MODEM 1 1
Successful Response
VP id VP alias Prov Modem CATV
========== ==================== ========== ====
16801614 DMC 14 1 on
queryWideband
Syntax
QueryWideband
Description
This command queries the status of the system based wideband flag.
Example Command
> queryWB
Successful Response
Case 1> The Wideband Flag is Currently Enabled.
Case 2> The Wideband Flag is Currently Disabled.
Error Response
Unable to read database.
No Response from modem shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-92 CI tool user interface
setEncryption
Syntax
setEncryption <mode>
Description
Use this CSV05.2 and newer command to enable or disable encryption for the
HDT.
Note: The setEncryption command is available only if encryption has been
enabled for the HDT (using the Enable command). Encryption also requires
the Model 3 DMC.
Parameters
<mode> is the desired encryption setting: ON or OFF.
Example Command
> setEncryption ON
Successful Response
Encryption for this HDT is ON.
setLCTemplate
Syntax
setLCTemplate <region>
Description
This command sets the LC template to an integer value which is used by Voice
Ports to determine which template to use.
Using this command requires that you reset all DMCs on the HDT.
Parameters
<region> specifies the line card template for a region, one of:
• NORTH_AMERICAN_STANDARD (7 dB Rx / 5 dB Tx loss plan)
• NORTH_AMERICAN_HIGH (3 dB Rx / 3 dB Tx high-gain loss plan)
• CHILE_PHILIPPINES
• JAPAN
• GERMANY
• NETHERLANDS
• AUSTRALIA
• AUSTRIA
• SPAIN
• FRANCE
• ARGENTINA
• BRAZIL
• COLUMBIA
• VENEZUELA
• IRELAND
• SWEDEN
• CZECH REP
• HUNGARY
• HOLLAND
• PORTUGAL
• POLAND
Example Command
> setLCTemplate JAPAN
Successful Response
The line card template is set to JAPAN.
Please reset DMC to make new LC template effective.
Error Response
No response from the Modem Shelf.
Unable to send message to Modem Shelf.
Internal error, please check the swerr log.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-94 CI tool user interface
setLoopCurrent
Syntax
setLoopCurrent <id type> <line number> <current>
setLoopC <id type> <line number> <current>
Description
This command sets high or normal loop current on the specified line. Applies
only to Voice Ports that support provisionable loop current.
This command is available in CsV06.2 and later releases.
Note: Only eight lines per Voice Port can be set to HIGH. The rest have to be
set to NORM.
Parameters
<id type> specifies one or more Voice Ports:
ALIAS <alias> — specifies a Voice Port by alias, where <alias>
is a 20-character string enclosed in single quotation marks (see
“Voice Port aliases” on page 4-2).
VP <id> — specifies a Voice Port by VPID: 1 to 4294967295
<line number> is the line number to provision: 1 to 24.
<current> is the loop current to use on this line: NORM or HIGH.
Example Command
setloopc vp 16801901 2 high
Successful Response
OK
Error Response
The specified Voice Port provisioning record does not exist.
The specified line card provisioning does not exist.
Line specified is unavailable on the VP.
Find out how many lines the specified Voice Port has.
The Line is provisioned with DTA service.
SetLoopCurrent command is rejected
Do not attempt to set loop current on a line provisioned as Digital Test
Access (DTA).
The hardware specified does not support this command.
SetLoopCurrent command is rejected.
The specified Voice Port does not support provisionable loop current. You
will see this message only if the specified Voice Port has already been
marshalled.
Unable to send message to modem shelf.
Out of range parameter entered.
The specified Voice Port or line number are not in the ranges shown
above.
Internal Error: invalid response code from the modem shelf.
Internal Error: please check the swerr log.
setTstAcc
Syntax
settstacc <vp id> <line> <mapper> <port> <DS0>
<line> {2, 4, 6, 8, 12, 16, 24}
Description
This command provisions a Voice Port line for Digital Test Access (DTA).
Parameters
<vp id> is the Voice Port serial number: 1 to 4294967295
<line> is the Voice Port line number on the Voice Port: 2, 4, 8, 12,
16, or 24.
<mapper> is the mapper: g1, g2 or g4
<port> is the mapper port number: 1 to 7 for an E1 system; 1 to 14 for
a DS1 system
<DS0> is the DS0 time slot to use for DTA: 1 to 31 for an E1 system;
1 to 24 for a DS1 system.
Example Command
> settstacc 16798981 8 g1 1 1
> settstacc 16798981 16 g1 1 1
> settstacc 16798981 24 g1 1 1
Successful Response
The line was allocated with a 1-based LC instance: 11
Provisioning accepted, check LC LOG for service
activation.
Error Response
Line number 8 is not provisioned with DTA service.
No response from the modem shelf.
Line 8, 16, or 24 must be used for Test Access on VP 16798981.
The specified line card provisioning record does not exist.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-96 CI tool user interface
setWideband
Syntax
SetWideband on
SetWideband off
Description
This command enables and disables wideband channels on the HDT. If you
answer “YES”, the Cornerstone software checks the Spectrum Manager PEC
codes to verify the ability to support wideband. The system based wideband
flag is then set. All command prompts and checks for the upstream channel
numbers will use a maximum US channel code of 234. If a system is not
wideband enabled, the number will be 144.
Example Command
setWideband on
Successful Response
The system is now a wideband system.
The system is now a narrowband system.
Error Response
Installed Spectrum Manager(s) do not support this feature.
Wideband Channels are still provisioned on carrier paths.
Unable to Write DataBase.
No Response from Modem Shelf.
At least 1 tied group present. Cannot turn Wide Band OFF.
VPmap
Syntax
VPmap <LC inst>
Description
This command allows you to display the Voice Port id, alias, modem CATV,
service type, line card instance, and service specific data.
Parameters
<LC inst> is the line card number: 1 to 3360.
Example Command
> vpmap 7
Successful Response
VP id VP alias Prov Modem CATV
========== ==================== ========== ====
16799308 T Jones DMC 1 1 on
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-98 CI tool user interface
CVSPMN CI commands
Use the Spectrum Manager maintenance commands to perform spectrum
maintenance.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts the user to reenter the data.
Table 4-9
CVSPMN CI commands
chanMap
Syntax
chanMap <direction> <low chan> <high chan>
Description
This command allows you to display mapping from channels to frequencies.
Parameters
<direction> is the direction of the frequency: US (upstream) or
DS (downstream).
<low chan> is the lowest channel number: 1 to 144(narrowband upstream);
1 to 234 (wideband upstream) or 98 to 1562 (downstream)
<high chan> is the highest channel number: 1 to 144(narrowband
upstream); 1 to 234 (wideband upstream) or 98 to 1562
(downstream)
Example Command
> chanMap US 144 148
> chanMap DS 1 50
Successful Response
Downstream:
Channel Frequency (kHz)
------- ---------------
55 18944
56 19200
57 19456
58 19712
59 19968
60 20224
Upstream:
Channel Frequency (kHz)
------- ---------------
144 41728
145 42240
146 42496
147 42752
148 43008
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-100 CI tool user interface
chgChanState
Syntax
chgChanState <cp id> <channel number> <new state> [FORCE]
Description
This command allows you to change the service state of a channel in the
spectrum range allocated for use on the specified carrier path. This allows the
channel’s status to be updated while controlling its availability for assignment
to a modem. If the channel to be taken out of service (OOS) is active, you can
only change the status to OOS if the FORCE flag is set to TRUE; otherwise,
the command will be rejected.
Parameters
<channel number>
is the number of the channel whose state will change:
1 to 144 (narrowband upstream), 1 to 234 (wideband
upstream) or 98 to 1562 (downstream).
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<new state> is the new state of the channel(s): IS or OOS.
FORCE optional parameter; use it to take an active channel out of
service.
Example Command
> chgChanState 2 200 IS
> chgChanState 2 200 OOS
Successful Response
The following response is only received when changing a channel(s) from In
Service to Out of Service. There is no response when changing a channel from
Out of Service to In Service.
freqMap
Syntax
freqMap <direction> [<low freq> <high freq>]
Description
This command allows you to display mapping from frequencies to channels.
Parameters
<direction> is the direction of the frequency: US (upstream) or
DS (downstream).
<low freq> when specifying a range of frequencies, this is the lowest
frequency in the range. The default is to display all
frequencies in the specified direction. The range is 5 to 42
(narrowband upstream), 5 to 65 (wideband upstream) or 375
to 750 (downstream).
<high freq> when specifying a range of frequencies this is the highest
frequency in the range. The range is 5 to 42 (narrowband
upstream), 5 to 65 (wideband upstream) or 375 to 750
(downstream).
Example Command
> freqmap US 41 42
> freqMap DS 400 410
Successful Response
Downstream:
Channel Frequency (kHz)
------- ---------------
1 5120
2 5376
3 5632
4 5888
5 6144
Upstream:
Channel Frequency (kHz)
------- ---------------
141 40960
142 41216
143 41472
144 41728
145 41984
146 42240
147 42496
148 42752
149 43008
150 43264
151 43520
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-102 CI tool user interface
queryChannel/qchan
Syntax
querychannel <cp id> [<low channel> <high channel>]
qchan <cp id> [<low channel> <high channel>]
Description
This command allows you to generate a display giving the status of each of the
specified channels.
• If a range of channels is specified, this command displays RF energy levels
in the range of channels on the specified carrier path.
• If no range is supplied, this command displays the RF energy levels detected
on the currently provisioned channels in the specified carrier path’s
spectrum.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<low channel> when specifying a range of channels, this is the lowest
channel in the range. The default is to display all channels in
the specified carrier path. The range is 5 to 42 (narrowband
upstream), 5 to 65 (wideband upstream) or 375 to 750
(downstream).
<high channel> when specifying a range of channels, this is the highest
channel in the range.
Example Command
> querychannel 3 1 1
> querychannel 2 98 196
> querychannel 4 22 65
Successful Response
A Spectrum Availability Report display will be generated.
Error Response
The specified channel XX is invalid.
Invalid carrier path id. (Specified carrier path is out of range or not
provisioned.).
No response from Modem Shelf.
queryRF
Syntax
queryRF <cp id> <range> <dwell time>
qrf <cp id> <range> <dwell time>
Description
This command generates a display of detected RF energy levels on each of the
specified upstream spectrum channels.
Parameters
<cp id> is the ID for either upstream or downstream carrier path:
1 to 56. Up to half of the IDs are used for upstream, the other
28, at most, are used for downstream.
<low channel> when specifying a range of channels, this is the lowest
channel in the range. The default is to display all channels in
the specified upstream carrier path. The range is 5 to 42
(narrowband upstream), 5 to 65 (wideband upstream) or 375
to 750 (downstream).
<high channel> when specifying a range of channels, this is the highest
channel in the range.
<dwell time> is the dwell time (ms): 0 to 500
Example Command
> queryRF 2 152 162 50
Successful Response
Channel Frequency (kHz) RF Level
---------- ------------------- -----------
152 40.960 -33.75
153 41.216 -33.75
154 41.472 -33.75
155 41.728 -33.75
156 41.984 -33.75
157 42.240 -33.75
158 42.496 -33.75
159 42.752 -33.75
160 43.008 -33.75
161 43.264 -33.75
162 43.520 -33.75
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-104 CI tool user interface
Error Response
The specified channel XX is invalid.
Invalid carrier path id.
No RF Spectrum Manager response. (The RF Spectrum Manager assigned to
the specified carrier path is unequipped or failed).
No response from Modem Shelf.
Invalid carrier path direction.
CVTRAF commands
Use the CVTRAF commands to monitor completed and non-completed calls.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts you to reenter the information.
Table 4-10
CVTRAF commands
Field definitions
The following table lists and describes the fields that appear as output from the
CVTRAF commands
Table 4-11
CVTRAF output fields
Field Definition
ACB Total number of seconds that all PCM channels were in use
Secs during the reporting period.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-106 CI tool user interface
Field Definition
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-108 CI tool user interface
querycallinfo
Syntax
querycallinfo <scope> <time_unit> <time_period>
Description
Displays call statistic totals.
The completed calls counter is limited to recording 65,535 calls on a single
HEM in a single day.
Parameters
<scope> specifies the entity to display call statistics; one of:
CP <cpid> — displays statistics for the specified carrier path.
HEM <DMC> <modem> — displays statistics for the
specified HEM.
ALL — displays statistics for all available entities.
<time_unit> is the amount of time over which to display statistics: Year,
Month, Week or Day
<time_period> is the period on which to display statistics: Curr or Prev (if
the <time_unit> is Month, the time_period can also be Jan,
Feb, Mar, and so on)
Example Command
> querycallinfo hem 2 1 day prev
Successful Response
Hour| Comp | Comp | Comp |Conc|Ncon| CCS/ | Avg |Blk |Blk |Blk% |Min |Avg | ACB
| Orig | Term |Noncon|Line|Line| Line | Hold|Orig|Term| |Chan|Occ | Secs
================================================================================
0 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
1 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
2 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
3 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
4 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
5 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
6 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
7 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
8 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
9 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
10 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
11 | 0| 0| 0| 0 | 0 | . | 0 | 0| 0| . | 24 | 0 | 0
Error Response
None.
querytopbh
Syntax
querytopbh <scope> <time_unit> <time_period>
Description
Displays peak periods of usage.
Parameters
<scope> specifies the entity to display; one of:
CP <cpid> — displays peak periods for the specified carrier
path.
HEM <DMC> <modem> — displays peak periods for the
specified HEM.
ALL — displays peak periods for all available entities.
<time_unit> is the amount of time over which to display statistics: Year,
Month, Week or Day
<time_period> is the period on which to display statistics: Curr or Prev
Example Command
> querytopbh hem 14 1 month curr
Successful Response
Rank|Modem| Date |Hour| Comp | Comp | Comp |Conc|Ncon|CCS/ | Avg |Blk |Blk |Blk%
| | | | Orig | Term |Noncon|Line|Line|Line | Hold|Orig|Term|
================================================================================
1 | 14,1| 0| 0 | 0 | 0 | 0 | 0 | 0 | . | 0 | 0| 0| .
2 | 14,1| 0| 0 | 0 | 0 | 0 | 0 | 0 | . | 0 | 0| 0| .
3 | 14,1| 0| 0 | 0 | 0 | 0 | 0 | 0 | . | 0 | 0| 0| .
4 | 14,1| 0| 0 | 0 | 0 | 0 | 0 | 0 | . | 0 | 0| 0| .
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-110 CI tool user interface
querybhbrief
Syntax
querybhbrief <time_unit> <time_period>
Description
Displays the busiest hour for each modem.
Parameters
<time_unit> is the amount of time over which to display busy hours: Year,
Month, Week or Day
<time_period> is the period on which to display busy hours: Curr or Prev
Example Command
> querybhbrief month curr
Successful Response
HEM|US |DS |Date |Hour |Conc|Ncon| Comp| Comp| Comp |CCS/ |Blk |Blk |Blk%
|CP |CP | | |Line|Line| Orig| Term|Noncon|Line |Orig|Term|
============================================================================
1,1| 2 | 1 |Dec11| 9 | 3 | 2 | 0| 0| 0| 2.8 | 0 | 0 | .
1,2| 2 | 1 |Dec18| 14 | 1 | 0 | 2| 0| 0| .1 | 0 | 0 | .
Error Response
None.
querygos
Syntax
querygos <scope> <time period> <% blocking>
Description
Displays busy hours that exceed the specified blocking percentage.
Parameters
<scope> specifies the entity to display; one of:
CP <cpid> — displays the specified carrier path.
HEM <DMC> <modem> — displays the specified HEM.
ALL — displays all available entities.
<time period> can be CURR or PREV
<% blocking> can be 0 to 100
Example Command
> querygos hem 14 1 prev 8
Successful Response
HEM |Hour|Comp |Comp |Comp|Conc|Ncon| CCS/ |Avg |Blk |Blk |Blk% |Min |Avg | ACB
| |Orig |Term |Ncon|Line|Line| Line |Hold|Orig|Term| |Chan|Occ | Secs
===============================================================================
14,1| 17 | 1092| 813| 0| 58 | 0 | 5.0 | 15| 9| 255|12.1 | 0 | 8 | 420
14,1| 13 | 1262| 974| 0| 58 | 0 | 6.0 | 15| 39| 255|11.6 | 0 | 9 | 465
14,1| 19 | 1370| 1122| 0| 58 | 0 |11.9 | 27| 42| 238|10.1 | 0 | 19 | 755
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-112 CI tool user interface
conclog
Syntax
conclog <action> <log_type> [<value>]
Description
This command enables, disables, or queries settings for monitoring logs.
Parameters
<action> is enable, disable, or query (read-only users only)
<log_type> can be CCS, Block, MinChan, BusyLine, Blkalarm, and
CallInfo
[<value>] can be CCS (1 to 36), Block (0 to 250), MinChan (0 to 23),
BusyLine (1 to 60), or BlkAlarm (0 to 250)
Note: For CsV06, this command has been changed to increase
the resolution for the blocking alarm and log. Prior to CsV06,
the blocking threshold for alarm or log generation was from
0% to 100% in 1% increments. With CsV06, this range
changes to 0% to 25% in 0.1% increments. The user is
required to enter the number without a decimal place in a
similar fashion as the spectrum manager threshold setting. For
example, to enter a blocking percentage of 12.5%, the user
would enter 125.
Example Command
> conclog enable block 200
Successful Response
Log Output enabled for Blocking Percentage greater than
20.0 %.
>conclog query
Log Type | Operand | Threshold | Status
======================================================
CCS/Line | greater than | 200 CCS | Disabled
MinChan | less than or equal | ** chan | Disabled
BusyLine | greater than | ** min | Disabled
CallInfo | n/a | n/a | Disabled
Block % | greater than | 20.0 % | Enable
BlkAlarm | greater than | 20.0 % | Disabled
Error Response
EITHER incorrect optional parameter(s) OR too many parameters.
cvclear
Syntax
cvclear
Description
This command clears all traffic monitoring counters.
Parameters
None.
Example Command
> cvclear
Successful Response
Warning: This will PERMANENTLY erase all traffic
statistics.
Please confirm ("Yes" or "No"):
>Yes
Traffic statistics have been cleared.
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-114 CI tool user interface
trafunits
Syntax
trafunits <units>
Description
This command toggles the display between CCS and erlangs.
Parameters
<units> can be CCS or ERLANGS
Example Command
> trafunits ccs
Successful Response
Warning: This will change the display units and
disable the CCS/Erlang log.
Please confirm ("Yes" or "No"):
Error Response
None.
CVV5 commands
The CVV5 CI provides necessary OAM&P commands relating specifically to
the V5.2 switch interface.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts you to reenter the information.
Table 4-12
CVV5 commands
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-116 CI tool user interface
actIF
Syntax
ActIF <if_id> [<FORCE>]
Description
This command activates a V5.2 switch interface on the Cornerstone HDT.
Parameters
<if_id> is the V5.2 switch interfaceID: 0 to 16777215
Example Command
> actIF 119
Successful Response
---------------------------------------------------------
Activation of the V5 Interface may take a few minutes.
---------------------------------------------------------
Do you wish to continue ?
Please confirm ("Yes" or "No"):
>y
Activation of V5 Interface 119 has been requested.
Check V5 Log for completion.
Error Response
Undefined Interface ID (<if_id>)
The interface has not been provisioned; it must first be created with the
addIF command.
Interface reactivation timer (2 minutes) has not expired. Interface <if_id> will
be activated within 2 minutes. The DEACTIF command will cancel the delayed
activation.
Interface will activate automatically when the activation timer expires.
The DEACTIF command will cancel the delayed activation.
Interface <if_id> already activated
The specified interface has already been activated.
Another interface is currently being activated. This interface will activate when
resources allow.
Only one interface can be started simultaneously. As soon as the interface
currently being started completes, this interface will begin startup
automatically.
addIF
Syntax
addIF <if_id> <variant_id> <log_comm_chan_id>
[<error_timer>] [<ok_timer>]
Description
This command provisions a new V5.2 switch interface on the Cornerstone
HDT.
Log V5600 is generated as a result of this command.
Parameters
<if_id> is the new V5.2 interface ID: 0 to 16777215
<variant_id> is the Variant ID to associate with the V5.2 interface: 0 to 127
<log_comm_chan_id>
is the Logical Comm Channel identifier for this interface:
0 to 127
<error_timer> (optional) the time, in 100 ms increments, for Debounce
alarms for E1 facilities associated with this interface:
0 to 65535. Default: 2 (200ms)
<ok_timer> (optional) the time, in 100 ms increments, for an E1 alarm to
clear for facilities associated with this interface: 0 to 65535.
Default: 15 (1.5s)
Example Command
> addIF 111 0 0
Successful Response
Timers will be set to: Error=DEFAULT Ok=DEFAULT
V5 (Interface ID=111, Variant ID=0) add in progess.
Check V5 LOG for final result.
Error Response
Interface ID already in use
The interface has already been provisioned on the Cornerstone HDT. Use
the queryV5 CI to identify provisioned Interface ID values.
Maximum switch interfaces already provisioned.
The maximum number of concurrent switch interfaces has already been
provisioned.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-118 CI tool user interface
addLink
Syntax
addLink <e1_mapper> <e1_port> <if_id> <link_id>
<link_type>
Description
This command associates a physical E1 facility with a V5.2 switch interface,
specified by (Interface ID, Link ID).
The initial state of a newly added link is Local Blocked. The link state can be
put Available using the chgLinkState command.
The first link created with <link_type> = COMM is designated the Primary
link. The second link created with this type is designated the Secondary link.
A combination of the addLink, delLink, and chgLinkId commands can be
used to re-assign the Primary and Secondary designations.
Parameters
<e1_mapper> is the E1 mapper card: G1, G2, or G4
<e1_port> is the physical E1 link located on the given E1 mapper card: 1
to 7.
<if_id> is the V5.2 interface ID: 0 to 16777215.
<link_id> is the new Link ID.
<link_type> determines how time slot 16 of the E1 facility is used:
COMM — V5 communications
TRAF — voice traffic
Example Command
Assigning (E1 G1 1) facility to (Interface ID=111, Link ID=0) as a
Communication link. (It will be designated as Primary since it is the first
comm link within interface ID 111.)
Error Response
E1 facility (<mapper>, <port>) unavailable.
The specified <e1_facility> is currently in use. Either choose another
<e1_facility> or unassign the one currently using it.
Interface <if_id> undefined.
The specified <if_id> has not been provisioned on the Cornerstone HDT.
Use the queryV5 CI to identify provisioned Interface ID values.
Link ID <link_id> currently in use.
The specified <link_id> is already in use within the specified interface.
Choose another link id.
Too many COMM links.
Both the Primary and Secondary links have already been assigned. Use the
queryV5 CI to identify these links. To reprovision a link as a COMM link,
first use the delLink CI to deprovision an existing COMM link.
Too many TRAF links.
All available traffic links for the given interface id have been allocated.
The Interface must be Deactivated before you can add a link.
Use the deactIF CI to deactivate the interface before adding a link.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-120 CI tool user interface
chgIFVariant
Syntax
chgIFVariant <interfaceID> <variantID>
Description
This command assigns <variant_id> as the start Variant ID value for the V5.2
interface <if_id>. The interface must be deactivated at both the LE and HDT
for the new variant ID to take effect.
Parameters
<interfaceID> is the V5.2 interface ID: 0 to 16777215.
<variantID> is the new Variant ID value: 1 to 127.
Example Command
> chgIFVariant 111 5
Successful Response
Please ensure that the Variant ID has been changed on the
switch to match the change being made here.
**This change will not take effect until the next RTS**
-------------------------------------------------------
Do you wish to make the change here?
Please confirm (“Yes” or “No”):
>Yes
V5 Varient ID for interface 111 has been changed to 5.
Error Response
Undefined Interface ID <if_id>.
The specified <if_id> is not provisioned on the Cornerstone HDT. Use
the queryV5 command to identify provisioned Interface ID values.
chgInitialRing
Syntax
chgInitialRing <duration_type> <duration>
Description
This command modifies the initial ring pulse duration for each of the 32
allowed pulse duration types.
Parameters
<duration_type>is the Ring type: 0 to 31.
<duration> specifies the time, in 50ms increments, that ring is applied for
that interval: 0 to 5000 (0 to turn off the specified ring type.)
Example Command
ex1> chgInitialRing 0 400
ex2> chgInitialRing 13 0
Successful Response
ex1 Duration 0 : 400ms
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-122 CI tool user interface
chgLCtimings
Syntax
chglctimings <hit_time_max> <disc_time_min>
<flash_time_min> <idigits_time_min>
Description
This command changes Line Card timings.
Parameters
<hit_time_max>
is the maximum hit time in milliseconds. This value must be
less than all other parameters. 1 to 5000.
<disc_time_min>
is the minimum disconnect time in milliseconds.This value
must be greater than the flash_time_min. Also, this value must
be greater than the idigits_time_min. 1 to 5000.
<flash_time_min>
is the minimum flash time in milliseconds. 1 to 5000.
<idigits_time_min>
is the minimum digits time in milliseconds. 1 to 5000.
Example Command
> chglctimings 40 1000 100 150
Successful Response
Line Card Timings updated
-------------------------------------------------
| Current line card timing settings (msecs) |
-------------------------------------------------
| Hit Time Disc Time Flash Time Idigits Time |
| max min min min |
-------------------------------------------------
40 1000 100 150
Error Response
Disc Time Min must be a value greater than the Hit Time Max.
Flash Time Min must be a value greater than the Hit Time Max.
Flash Time Min must be a value less than the Disc Time Min.
Idigit Time Min must be a value greater than the Hit Time Max.
Re-execute the command with correct data values
chgLinkId
Syntax
chgLinkId <if_id> <link_id_old> <link_id_new>
Description
This command changes the value of an existing Link ID.
Parameters
<if_id> is the V5.2 interface ID: 0 to 16777215
<link_id_old> is the old V5.2 Link ID: 0 to 255
<link_id_new> is the new V5.2 Link ID: 0 to 255
Example Command
> chgLinkId 111 122 0
Successful Response
----------------------------------------------------------
Please ensure that the Link ID has been changed on the
switch to match the change being made here.
----------------------------------------------------------
Do you wish to continue? (y/n)
y
V5 (Interface ID=111, Link ID=122) reassigned as Link ID=0
in progress. Check V5 LOG for final result.
Error Response
Link ID <link_id_old> currently In-Service.
<link_id_old> is currently In-Service. Put the link OOS via the
chgLinkState CI.
Undefined Old Link ID.
The specified <link_id_old> is not provisioned on the Cornerstone HDT.
Use the queryV5 CI to identify provisioned Link ID values.
Link ID <link_id_new> already in use by Interface <if_id>.
<link_id_new> is an existing Link ID currently associated with <if_id>.
Use the queryV5 CI to identify provisioned Link ID values.
Undefined Interface ID.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-124 CI tool user interface
chgLinkState
Syntax
chgLinkState <if_id> <link_id> <link_state> [DEFER]
Description
This command attempts to put a V5.2 link in a given state.
Parameters
<if_id> is the V5.2 interface ID: 0 to 16777215.
<link_id> is the V5.2 Link ID: 0 to 255.
<link_state> is the state to place the V5.2 link into, one of:
IS — The Cornerstone HDT requests the LE to put the link into
an Unblocked state.
OOS — The Cornerstone HDT requests the LE to put the link
into a Blocked state immediately. (Non-Deferred Block)
DEFER optional, used only with the OOS state. If specified, the
Cornerstone HDT requests the LE to put the link into a
Blocked state when all traffic on that link has been completed
(Deferred Block).
Example Command
> chgLinkState 111 4 OOS
Successful Response
V5 (Interface ID=111, Link ID=4) Non-Deferred Block in
progress. Check V5 LOG for final result.
Error Response
Undefined Interface ID.
The specified <if_id> is not provisioned on the Cornerstone HDT. Use
the queryV5 CI to identify provisioned Interface ID values.
Undefined Link ID.
The specified <link_id> is not assigned to the specified <if_id>. Use the
queryV5 CI to identify Link ID associations.
Invalid state change request.
The specified <link_state> is not a valid state transition.
Change request rejected. Secondary COMM channel is not active.
Deactivate interface to put both COMM links OOS. Only one COMM link
can be put OOS (blocked). In order to disable both of the COMM links the
interface must be deactivated.
chgPortState
Syntax
chgPortState <if_id> <port_id> <port_state> [DEFER]
Description
This command attempts to put a V5.2 port in a given state.
Parameters
<if_id> is the V5.2 interface ID: 0 to 16777215.
<port_id> is the V5.2 Port ID: 0 to 32767.
<port_state> is the State to place the V5.2 link into.
IS — The Cornerstone HDT requests the LE to put the port into
an Unblocked state.
OOS — The Cornerstone HDT requests the LE to put the port
into a Blocked state immediately. (Non-Deferred Block)
DEFER optional, used only with the OOS state. If specified, the
Cornerstone HDT requests the LE to put the link into a
Blocked state when all traffic on that link has been completed
(Deferred Block).
Example Command
> chgPortState 111 4 OOS
Successful Response
V5 (Interface ID=111, Port ID=4) Non-Deferred Block in
progress.
Error Response
Undefined Interface ID.
The specified <if_id> is not provisioned on the Cornerstone HDT. Use
the queryV5 CI to identify provisioned Interface ID values.
Undefined Port ID.
The specified <port_id> is not assigned to the specified <if_id>. Use the
queryPort CI to identify Port ID associations.
Invalid state change request.
The specified <port_state> is not a valid state transition.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-126 CI tool user interface
chgRingCadence
Syntax
chgRingCadence <ring_type> <On_1> [<Off_1>] <On_2>
[<Off_2>]<On_3> [<Off_3>]<On_4> [<Off_4>]
Description
This command modifies the ring cadence for a particular ring type. This
command also allows a particular ring type to be turned off.
Parameters
<ring_type> is the type of ring: 0 to 127.
<On_x>
specifies the time, in 50ms increments, that ring is applied for
that interval: 50 to 12750 (rounded to nearest 50ms), or 0 to
turn off the specified ring type.
<Off_x>
specifies the time in 50ms increments of silence after ring for
that interval: 50 to 12750 (rounded to nearest 50ms).
Example Command
> chgRingCadence 0 1000 4000 500 500
> chgRingCadence 13 0
Successful Response
Example 1:
Interval 1 ON : 1000ms
Interval 1 OFF: 4000ms
Interval 2 ON : 500ms
Interval 2 OFF: 500ms
Record updated.
Example 2:
Ring Type 13 does not exist. Will be
created.
Ring Type 13 will be set to NOT USED.
Record updated.
Error Response
You must specify at least 1 OFF period.
Ring Type 0 cannot be set to NOT USED.
Ring Type 0 (default National Ringing) cannot be turned off.
Intervals must be at least 50ms in 50ms increments.
Specify a time greater than 50ms.
You must specify ON/OFF periods in pairs.
Specify an even number of timings.
deactIF
Syntax
deactIF <if_id>
Description
This command deactivated a V5.2 switch interface on the Cornerstone HDT.
A two minute timeout period is required after Deactivation before the Interface
can be reactivated.
Parameters
<if_id> is the V5.2 interface ID: 0 to 16777215.
Example Command
> deactIF 119
Successful Response
---------------------------------------------------------
Deactivation of the V5 Interface may take a few minutes.
---------------------------------------------------------
Do you wish to continue ?
Please confirm ("Yes" or "No"):
>y
Deactivation of V5 Interface 119 has been requested.
Check V5 Log for completion.
Error Response
Undefined Interface ID (<if_id>).
<if_id> has not been provisioned; it must first be created with the addIF
command.
Delayed activation of Interface <if_id> has been cancelled.
This is not an error. The deactIF command was used to cancel a delayed
activation request.
<if_id> already deactivated.
The specified interface has already been deactivated.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-128 CI tool user interface
delIF
Syntax
delIF <if_id>
Description
This command removes a V5.2 switch interface from the Cornerstone HDT.
Log V5600 is generated as a result of this command.
Parameters
<if_id> is the V5.2 interface ID: 0 to 16777215.
Example Command
> delIF 111
---------------------------------------------------------
Deleting a V5 switch interface requires symmetrical change
on the LE.
---------------------------------------------------------
Do you wish to continue?
Please confirm (“Yes” or “No”():
>yes
>
Successful Response
V5 Interface ID=111 delete in progress. Check V5 LOG for
final result.
Error Response
Interface <if_id> is currently In-Service.
The specified <if_id> is currently In-Service. Deactivate the interface
before deleting it, by using the deactIF command.
Undefined Interface ID <if_id>.
The specified <if_id> is not provisioned on the Cornerstone HDT. Use the
queryV5 command to identify provisioned Interface ID values.
Association to a Link ID exists.
A Link-ID is currently associated with the <if_id>. Use the delLink
command to remove the association.
Association to a Port ID exists.
Port-ID is currently associated with the <if_id>. Use the delLine
command to remove the association.
delLink
Syntax
delLink <if_id> <link_id>
Description
This command unassigns a physical E1 facility from a V5.2 interface.
Log V5601 is generated as a result of this command.
Parameters
<if_id> is the V5.2 interface ID: 0 to 16777215.
<link_id> is the V5.2 Link ID: 0 to 255.
Example Command
> delLink 111 0
----------------------------------------------------------
Removing this link requires a symmetrical change to the
LE.
----------------------------------------------------------
Do you wish to continue?
Please confirm (“Yes” or “No”():
>yes
>
Successful Response
Association between (G1 1) and V5 (Interface ID=111, Link
ID=0) is begin removed. Check V5 LOG for final result.
Error Response
Link In-Service.
The specified Link ID is currently in the In-Service state. Put the link OOS
using the chgLinkState command.
Interface-ID=<if_id>, Link-ID=<link_id>) is not provisioned.
The specified facility is currently not assigned to any interface.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-130 CI tool user interface
queryFreePort
Syntax
queryFreePort <if_id> [<how_many>] [<start>]
Description
This command displays up to 8 unassigned Port ID values.
Parameters
<if_id> is the V5.2 interface ID: 0 to 16777215.
<how_many> optional, specifies the number of Port IDs to display. The
default is 8.
<start> optional, specifies the beginning Port ID. The default is 0.
Example Command
> queryFreePort 111 8
Successful Response
12 102 103 104 105 106 109 120
Error Response
No more Port IDs.
All 3360 Port ID values have been assigned.
Undefined Interface ID.
Retry the queryFreePort command, specifying an interface ID.
queryInitialRing
Syntax
queryInitialRing <duration_type>
Description
This command displays current settings for a particular provisioned initial ring
pulse duration.
Parameters
<duration_type>is the ring type to display: 0 to 31.
Example Command
> queryInitialRing 0
Successful Response
| Duration | Interval |
| Type | Time |
|==========|==========|
| 0 | 400 |
Note: Times are expressed in milliseconds
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-132 CI tool user interface
queryLink
Syntax
queryLink
Description
This command displays the associations of the physical E1 facilities.
Parameters
None.
Example Command
> queryLink
Successful Response
Mapper Port Association
Card #
-------- ------ ------------
G1 1 V5 (IF ID=111, Link ID=0) COMM
G1 2 V5 (IF ID=222, Link ID=1) COMM
G1 3 V5 (IF ID=111, Link ID=2) COMM
G1 4 V5 (IF ID=111, Link ID=3) TRAF
G1 5 Unassigned
G1 6 Unassigned
G1 7 Unassigned
G2 1 V5 (IF ID=222, Link ID=0) COMM
G2 2 V5 (IF ID=111, Link ID=1) TRAF
G2 3 Unassigned
...
Error Response
None.
queryLCtimings
Syntax
queryLCtimings
Description
This command displays the current settings for Line Card Timings.
Parameters
None.
Example Command
> querylctimings
Successful Response
------------------------------------------------
| Current line card timing settings (msecs) |
------------------------------------------------
| Hit Time Disc Time Flash Time Idigits Time |
| max min min min |
------------------------------------------------
40 1000 100 150
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-134 CI tool user interface
queryPort
Syntax
queryPort [<if_id>] [<port_id>]
Description
This command displays the port status, as well as the association between the
Port ID value and a (Voice Port, Line Card).
If no parameters are specified, the a complete list of all assigned Port ID
values will be displayed. If this list will exceed the normal text screen (i.e. 24
lines), then the customer will be prompted to continue to display another
screen of information.
If an <if_id> is specified without the optional <port_id> value, then all Port
IDs assigned to <if_id> will be displayed.
If the optional <port_id> parameter is specified, then only the information for
(Interface ID=<if_id>, Port ID=<port_id>) will be displayed.
Parameters
<if_id> optional, specifies the V5.2 interface ID (0 to 16777215). The
default is to display a list of all assigned Port ID values on all
interfaces.
<port_id> optional, specifies the V5.2 Port ID (0 to 32767). The default
is to display all Port IDs assigned to the specified <if_id> (or
all Port IDs on all interfaces).
Example Command
ex1> queryPort 111 1
ex2> queryPort 111
ex3> queryPort
Successful Response
%%ex1>
Port Interface Port Vp Line Vp Alias LC
ID ID Status ID Card State
------- -------- --------- -------- ---- -------------------- -----------
95 111 Available 16780139 1 6015 STATE BRDG IS_NR
%%ex2>
Port Interface Port Vp Line Vp Alias LC
ID ID Status ID Card State
------- -------- --------- -------- ---- -------------------- -----------
2 111 Available 65 1 7748 MEDLOCK BRDG IS_NR
95 111 Available 16780139 1 6015 STATE BRDG IS_NR
%%ex3>
Port Interface Port Vp Line Vp Alias LC
ID ID Status ID Card State
------- -------- --------- -------- ---- -------------------- -----------
2 111 Available 65 1 7748 MEDLOCK BRDG IS_NR
95 111 Available 16780139 1 6015 STATE BRDG IS_NR
7 222 Available 50060001 1 SUMMIT BLDG 1 IS_NR
8 222 Local Blk 50060001 2 SUMMIT BLDG 1 IS_ANR
8 222 Local Blk 50060001 3 SUMMIT BLDG 1 IS_ANR
10 222 Local Blk 50060001 4 SUMMIT BLDG 1 IS_ANR
11 222 Local Blk 50060001 5 SUMMIT BLDG 1 IS_ANR
12 222 Local Blk 50060001 6 SUMMIT BLDG 1 IS_ANR
13 222 Available 50060001 7 SUMMIT BLDG 1 IS_NR
Error Response
Undefined Interface ID.
The specified <if_id> is not provisioned on the Cornerstone HDT. Use the
queryV5 CI to identify provisioned Interface ID values.
Undefined Port ID.
The specified <port_id> value is not provisioned within the Cornerstone
HDT.
No provisioned ports with V5.2 service.
Provision Ports via the addLine CI.
No provisioned ports for Interface ID.
Use the queryPort command without any parameters to display a complete
list of all V5.2 Port IDs and their associations to the Interface ID.
Port <port_id> is not provisioned on Interface ID <if_id>.
Use the queryPort command without any parameters to display a complete
list of all V5.2 Port IDs and their associations to the Interface ID.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-136 CI tool user interface
queryRingCadence
Syntax
queryRingCadence
Description
This command displays current settings for all provisioned ring cadence ring
types.
Parameters
None.
Example Command
> queryRingCadence
Successful Response
Ring |Interval 1 |Interval 2 |Interval 3 |Interval 4 |
Type | On Off | On Off | On Off | On Off |
==== |===== =====|===== =====|===== =====|===== =====|
0 | 400 200| 400 2000| 0 0| 0 0|
1 | 1500 4500| 0 0| 0 0| 0 0|
2 | 1500 500| 1500 2500| 0 0| 0 0|
3 | 1500 500| 500 3500| 0 0| 0 0|
4 | 1500 500| 500 500| 500 2500| 0 0|
5 | 1500 500| 500 500| 1000 2000| 0 0|
6 | 1000 500| 1000 3500| 0 0| 0 0|
7 | 500 500| 500 500| 1000 3000| 0 0|
8 | 500 500| 1000 500| 500 3000| 0 0|
9 | 1700 600| 250 250| 250 2950| 0 0|
10 | 1700 600| 250 250| 900 2300| 0 0|
11 | 250 5750| 0 0| 0 0| 0 0|
13 | 2500 50| 0 0| 0 0| 0 0|
Note: Times are expressed in milliseconds
Error Response
None.
queryV5
Syntax
queryV5 [<if_id>]
Description
This command displays the following information about the V5.2 interface(s)
provisioned on the Cornerstone HDT:
• State of the Interface
• Variant ID associated with Interface ID
• Links associated with Interface ID
• State of the links as discussed in
• Alarm currently raised against the interface
Parameters
<if_id> optional parameter, specifies a particular Interface ID to
display (0 to 16777215). The default is to display a list of
V5.2 Interface ID values provisioned on the system.
Example Command
ex1> queryV5
ex2> queryV5 111
ex3> queryV5 222
Successful Response
%% ex1>
Interface ID State Activation
------------ ----- ------------
111 IS Activated
222 IS-Wt-Strt Activated
%% ex2>
Interface ID: 111
Activation: Activated
State: IS
Variant ID: 0
Logical Comm Channel: 0
Link ID State E1 Facility State
------- --------------------------- ----------- -----
PRI 1 Available G1 1 In-Service
SEC 2 Available G2 1 In-Service
TRF 3 Blocked G1 2 In-Service Trouble
TRF 4 Available G1 3 In-Service
%% ex3>
Interface ID: 222
Activation: Activated
State: IS-Wt-Strt
Variant ID: 0
Logical Comm Channel: 0
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-138 CI tool user interface
Error Response
Undefined Interface ID.
The specified <if_id> is not provisioned on the Cornerstone HDT. Use the
queryV5 CI without any parameters.
V5 service not provisioned.
No V5.2 interfaces have been provisioned on the Cornerstone HDT.
No Links for this Interface
No V5.2 links have been added to the specified <if_id>. Use the addLink
CI to perform this provisioning.
setDefLCTimings
Syntax
setDefLCTimings
Description
This command sets default values for Line Card Timings.
Parameters
None.
Example Command
> setdeflctimings
Successful Response
Line Card Timings updated
------------------------------------------------
| Current line card timing settings (msecs) |
------------------------------------------------
| Hit Time Disc Time Flash Time Idigits Time |
| max min min min |
------------------------------------------------
20 1000 300 500
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-140 CI tool user interface
setDefRingCadence
Syntax
setDefRingCadence <region>
Description
This command sets default values for Line Card Timings.
Parameters
<region> specifies the set of default timings to use; one of:
• NORTH_AMERICAN_STANDARD (7 dB Rx / 5 dB Tx
loss plan)
• NORTH_AMERICAN_HIGH (3 dB Rx / 3 dB Tx high-gain
loss plan)
• CHILE
• JAPAN
• GERMANY
• NETHERLANDS
• PHILIPPINES
• AUSTRALIA
• AUSTRIA
• SPAIN
• FRANCE
• ARGENTINA
• BRAZIL
• COLUMBIA
• VENEZUELA
Example Command
> setDefRingCadence japan
Successful Response
The ring cadences have been set to the default for JAPAN
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-142 CI tool user interface
MVIPROV commands
When the first GR-303 MVI host is provisioned, Cornerstone sets up a
preprovisioning table (HDT slot association table) for all slots on the HDT.
Use the MVIPROV commands to display or modify the slot assignments as
follows:
• Set up the CRV ranges for each interface group (IG) in a Multi-IG
GR-303 MVI configuration. This is usually a required step in the
provisioning process. During autoprovisioning, the system sets up
CRVs 1 to 2048 on IG 1 and CRVs 1 to 1312 on IG 2.
• Change the service assignment on one or more HDT slots to
MVIPOTS or EBS. All slots initially default to MVIPOTS service.
(Service pre-assignment is required because GR-303 switch
provisioning commands do not uniquely distinguish MVIPOTS and
EBS service types.)
Note: Modifying the service type using MVIPROV at the HDT immediately
changes the current service to the new service type. This change is
immediately service affecting. You should delete the existing service (at the
switch) before reassigning its slot at the HDT
Table 4-13
MVIPROV commands
Requirements
A GR-303 MVI host switch has been added to HDT data using the OPC Host
Provisioning Manager tool before using the MVIPROV commands.
EditCRV
Syntax
editcrv <edit method>
Description
This command modifies call reference values (CRV) or interface group (IG)
values for one or more lines.
Parameters
<method> is the method for specifying the lines to modify; one of:
slot <shelftype> <CDS> <shelf> <slot> <CRV> — modified
CRVs based on shelftype
range <shelftype> — the shelftype can be <CDS> <start shelf>
<start slot> <end shelf> <end slot <start CRV> <end CRV> to
edit a range of CRVs on a certain shelf or MODEM <start
instance> <end instance> <start CRV> < end CRV> to edit a
range of CRVs by modem.
instance <instance> <CRV> — edit a range of CRVs by their
starting and ending line instance numbers (1 to 3360) and CRVs
(1 to 2048)
Example Command
editcrv instance 25 25 1
Successful Response
The command as entered:
Instance - 25
CRV - 25
IG - 1
Do you wish to continue?
>Y
Operation successful.
Error Response
Operation failed - GR-202 line termination exists on the slot range specified.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-144 CI tool user interface
MoveCRV
Syntax
movecrv <source start> <source end> <source IG> <dest
start> <dest end> <dest IG>
Description
This command reassigns lines to a different interface group and CRV.
Parameters
<source start> and <source end>
are the starting and ending CRVs on the source IG.
<source IG> is the IG currently assigned to the specified lines.
<dest start> and <dest end>
are the starting and ending CRVs on the destination IG.
<dest IG> is the new IG for the specified lines.
Example Command
MOVECRV 1 6 1 1 6 3 ↵
Successful Response
The command as entered:
Source Start CRV - 1 Dest Start CRV - 1
Source End CRV - 6 Dest End CRV - 6
Source Host - 1 Dest Host - 3
Error Response
Operation failed - Invalid dest CRV range.
CRV # IG # has service provisioned and will not be moved.
Operation complete. 0 CRVs moved.
QueryProv
Syntax
queryprov <method>
Description
This command displays the current line assignments.
Parameters
<method> specifies the lines to display; one of:
all — displays assignments for all lines on the HDT.
slot CDS <shelf> <slot> <CRV> — displays assignments for
all lines within the specified CDS shelf (1 to 7), slot (1 to 96)
and CRV (1 to 2048).
shelf CDS — displays assignments for all lines on a CDS (1 to
7).
range CDS <start shelf> <start slot> <end shelf> <end slot> —
displays assignments for all lines within a particular range of
start and end shelves (1 to 7) and slots (1 to 96).
range modem <start> <end> — displays assignments for the
specified line instance range: 1 to 3360.
instance <instance> — displays assignments of a particular
line instance (1 to 3360).
serv <service type> — displays assignments of a particular
service type (MVIPOTS, MVIUVG, MVICOIN, MVIMPY,
EBS).
CRV <CRV> <IG> — displays assignments of a particular
CRV (1 to 2048) on a particular IG (1 to 5).
Example Command
queryprov range modem 50 55
Successful Response
Note: Successful responses will vary depending on the parameters entered.
Error Response
No response from modem shelf.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-146 CI tool user interface
QueryIDT
Syntax
queryidt
Description
This command displays the IG, interface type, and CLLI (trunk group ID) for
the current HDT.
Parameters
None.
Example Command
queryidt
Successful Response
GR-303
IG CLLI IDT Interface
-- ---------------- ----- ---------
1 JCRKGALAB01 111 MVI
-------------------------------------
Error Response
None.
EditIDT
Syntax
editidt <IG> <host IDT>
Description
This command reassigns all lines in the specified interface group to a different
interface group.
Parameters
<IG> is the original IG number: 1 to 5.
<host IDT> is the new IG number: 0 to 9999.
Example Command
editidt 1 2
Successful Response
The IDT value for IG 1 is about to be changed to 111.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-148 CI tool user interface
FAMCI commands
Use the FAM tools to provision or de-provision a facility as well as display
current facility assignments. These tools apply only to E1-based systems.
famassign
Syntax
famassign <unit> <port#> <service type>
Description
This command provisions a facility.
Parameters
<unit> is the group number: G1, G2, or G4
<port#> is the port number: 1 to 7
<service type> is the service type; one of the following:
V5 <if_id> <link_id> <link_type> — provisions a V5.2 facility
with the specified interface ID (0 to 16777215), link ID (0 to
255), and type (COMM or TRAF).
VLCM <vlcm> <link> — provisions a VLCM facility with the
specified VLCM number (1 to 7) and link number (0 to 5).
DTA — provisions a Digital Test Access (DTA) facility.
Example Command
> famassign g2 1 vlcm 1 0
Successful Response
E1=G2 Port=1 Factype=VLCM VLCMNum=1 VLCMPort=0
Association (G2 1) to VLCM (Unit=1, Link=0) added.
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-150 CI tool user interface
famquery
Syntax
famquery
Description
This command displays current facility assignments (CsV04 and newer).
Parameters
None.
Example Command
> famquery
Successful Response
Mapper Port Association
====== ==== ===========
G1 1 V5 (IF ID=204, Link ID=1) Comm
G1 2 V5 (IF ID=206, Link ID=2) Comm
G1 3 V5 (IF ID=204, Link ID=3) Traffic
G1 4 V5 (IF ID=205, Link ID=3) Traffic
G1 5 Unassigned
G1 6 Unassigned
G1 7 Unassigned
G2 1 V5 (IF ID=205, Link ID=1) Comm
G2 2 V5 (IF ID=204, Link ID=2) Comm
G2 3 Unassigned
G2 4 Unassigned
G2 5 Unassigned
G2 6 Unassigned
G2 7 Unassigned
G4 1 V5 (IF ID=206, Link ID=1) Comm
G4 2 V5 (IF ID=205, Link ID=2) Comm
G4 3 Unassigned
G4 4 Unassigned
G4 5 Unassigned
G4 6 Unassigned
G4 7 Unassigned
Error Response
None.
famunassign
Syntax
famunassign <unit> <port#>
Description
This command deprovisions a facility.
Parameters
<unit> is the group: G1, G2, or G4
<port#> is the port number: 1 to 7
Example Command
> famunassign g2 1
----------------------------------------------------------
Removing this link requires a symmetrical change to the
LE.
----------------------------------------------------------
Do you wish to continue ?
Please confirm (“Yes” or “No”):
>y
Successful Response
Association between (G2 1) and VLCM (Unit=1, Link=0) has
been removed.
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-152 CI tool user interface
qbitinv
Syntax
qbitinv <unit> <port#>
Description
This command queries bit inversion on an E1 port.
Parameters
<unit> is the E1 group number: g1, g2 or g4
<port#> is the E1 port number: 1 to 7
Example Command
> qbitinv g1 1
Successful Response
TS 0 = NONE
TS 1 = ODD
TS 2 = NONE
...
Error Response
None.
sbitinv
Syntax
sbitinv <unit> <port#> <timeslot> <inv>
Description
This command sets bit inversion on a timeslot.
Parameters
<unit> is the E1 group number: g1, g2 or g4
<port#> is the E1 port number: 1 to 7
<timeslot> is the timeslot number: 1 to 31
<inv> is the bit inversion: none, odd, even, or all
Example Command
> sbitinv g1 1 2 odd
Successful Response
Setting bit inversion = ODD
Bit inversion set successfully.
Database updated successfully
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-154 CI tool user interface
OMCCI commands
Use the OMCCI commands to provision and maintain OMC links in DS1-fed
HDTs.
omc add
Syntax
omc add <link #> <unit> <port> <bandwidth> [<linkname>]
Description
Use this command to provision an OMC link. Any DS1 not assigned to carry
traffic can be provisioned as an OMC link.
Make sure that the OMC bandwidth and DS1 facility parameters are identical
at each end of the link.
The first OMC link added to an HDT automatically becomes the OMC
software download channel. This link is used as a backup software transfer
between the OPC and the HDT.
Parameters
<link #> is the OMC link number: 1 to 10.
<unit> is the HDT DS1 group number: g1, g2, or g4.
<port> is the DS1 port number within the group: 1 to 14.
<bandwidth> is the number of DS0s used for the OMC data link: 3 to 6.
<linkname> (optional) link name, up to 20 characters.
Example Command
omc add 1 g2 14 4 ‘Backup 111/113’
Successful Response
Success. Link 1 has been added
Success. Download channel set.
Error Response
****** Operation failed.
Ensure that the current facility is available and that the limit of 31 DS0s is not
being exceeded. Please check the Facility Assignments and/or the
provisioning information.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-156 CI tool user interface
omc setdlchan
Syntax
omc setdlchan <link #>
Description
Use this command to assign a software download channel to a different OMC
link. The first OMC link added to an HDT automatically becomes the OMC
software download channel; use this command to change it.
Parameters
<link #> is the OMC link number: 1 to 10.
Example Command
omc setdlchan 3
Successful Response
Success. Download channel set.
Error Response
****** Operation failed.
omc delete
Syntax
omc delete <link #>
Description
Use this command to delete an OMC link.
Parameters
<link #> is the OMC link number to delete: 1 to 10.
Example Command
omc delete 3
Successful Response
Success, Link 3 has been deleted
Error Response
Deletion of the OMC download channel is only allowed from an HMOI port..
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-158 CI tool user interface
omc query
Syntax
omc query <link #>
Description
Use this command to query OMC link assignments.
This command indicates the software download channel with an asterisk (*) in
the D/L column.
Parameters
<link #> is the OMC link number: 1 to 10 to display a single link, or all
to display all link assignments.
Example Command
omc query all
Successful Response
Link# Connected To #DS0 State D/L Name
1 Not Assigned
2 Not Assigned
3 Not Assigned
4 Not Assigned
5 Not Assigned
6 Not Assigned
7 Not Assigned
8 Not Assigned
9 Not Assigned
10 Not Assigned
Error Response
None.
VLCMCI commands
Use the VLCM maintenance commands to display vlcm status. These
commands are for use only with VLCM interfaces.
The detailed description of the commands includes syntax and parameters and
gives examples of their use. When a given parameter value exceeds the valid
range, the system indicates “out of range” followed by the proper range and
prompts the user to reenter the data.
Table 4-16
VLCMCI commands
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-160 CI tool user interface
linkstatus
Syntax
linkstatus <vlcm value>
Description
This command displays the current state of provisioned VLCM DS1/E1 links.
The tabular output displays five values for each DS1/E1 provisioned:
• The VLCM number the link is associated with
• The switch port number (0 to 5)
• The HDT VT number the link maps to
• The status of the link
• Whether the link is a PCM only or a PCM/signal link
Parameters
<vlcm value> is the VLCM link for which data is to be displayed or all
provisioned links: 1 to 8, or all.
Example Command
> linkstatus all
Successful Response
VLCM PORT DS1 STATE SIGNAL/PCM
---- ---- ----- ------ ----------
1 0 G1- 1 In Ser signal
1 3 G2- 1 In Ser signal
2 0 G1- 2 In Ser signal
2 3 G2- 2 In Ser signal
Error Response
No records found.
setloadname
Syntax
setloadname <VLCM instance number> <VLCM unit number>
<VLCM load number>
Description
This command sets the load name for VLCM in CsV04 and newer.
Parameters
<vlcm instance number>
is the VLCM instance: 1 to 8.
<vlcm unit number>
is the VLCM unit: 0 or 1.
<vlcm load number>
is the name of the VLCM load; this can be any alphanumeric
string.
Example Command
> setloadname 4 1 alpha
Successful Response
None.
Error Response
Cannot store the load name.
The DB error is : 1.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-162 CI tool user interface
unknown
Syntax
unknown
Description
This command displays unexpected messages.
Parameters
None.
Example Command
> unknown
Successful Response
MSG NUM COUNT
------- -----
44 32767
Error Response
None.
vlcmstatus
Syntax
vlcmstatus
Description
This command displays the current state of all provisioned VLCM units. The
tabular output lists the VLCM number, unit number within a VLCM, the state
for each unit, and whether the activity is raised.
Parameters
None.
Example Command
> vlcmstatus
Successful Response
VLCM NUM UNIT NUM STATE ACTIVITY
-------- -------- ----- --------
1 0 IS RAISED
1 1 IS RAISED
Error Response
None.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
4-164 CI tool user interface
zero
Syntax
zero
Description
This command resets the unexpected message list.
Parameters
None.
Example Command
> zero
Successful Response
VLCM NUM UNIT NUM STATE ACTIVITY
-------- -------- ----- --------
1 0 IS RAISED
1 1 IS RAISED
Error Response
No VLCM instances provisioned.
User-interface overview 5-
The term “user interface” refers to the method by which you give commands
to the system to tell it what to do. In the user interface, you control the
operations, administration, maintenance, and provisioning (OAM&P) of the
system.
Levels of control
For a Cornerstone system, there are three levels at which you can exert control
over the system. Each level has its own user interface, as summarized in the
following table.
Table 5-1
Levels of control
Note: For information on how to access the user interfaces, see “Access to
the user interfaces” on page 5-4.
Figure 5-1 shows the three levels of control. The illustration shows a network
with an external surveillance system, for example, Network Manager. The
network has two operations controllers, each of which serves a cluster of
network elements.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-2 User-interface overview
Figure 5-1
Scope of control for the Network Manager, the OPCUI, and the NEUI
CS-10167
CS-10167
OPC UI
OPC
Network
Manager
OPC UI
OPC
NE UI
HDT HDT HDT
While working in the OPC user interface, you can access the network element
user interface of any network element in the cluster.
While working with the Network Manager, you can access the OPC user
interface of any operations controller in the network, or the network element
user interface of any network element in the network.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-4 User-interface overview
NEUI
If you need to use the network element user interface (NEUI) to carry out an
operation, you can go to the network element and access its NEUI locally, or
you can access the NEUI remotely.
• If you have a Network Manager, it gives you access to the NEUI of each
network element in the network.
OPCUI
If you need to use the operations controller user interface (OPCUI) to carry out
an operation, you can go to the operations controller and access its OPCUI
locally, or you can access the OPCUI remotely.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-6 User-interface overview
You use the network element user interface (NEUI) to control a single network
element, for example, a host digital terminal (HDT). The NEUI is composed
of two parts:
• a set of menu-based screens that control the equipment in the access
bandwidth manager shelf
• a set of command interpreters (CIs) that control the modem shelf and the
Voice Ports
When you log in to the network element user interface, the first screen that
appears is the Network Element Status screen, as shown in the following
figure.
CS-10216
CS-10216
Critical Major minor warning FailProt Lockout ActProt PrfAlrt
1 . . . 1 . . . .
S/DMS Nodes
0 Quit Network Element Status Shelf: CE
2
3 Alarms NE ID Alarms Protection Prf
4 ListNEs Fac Eqp Env Fail Lckt Act Alrt
5 1 . . . . . * .
6 PerfMon
7 FWPUI:
8
9
10 Protectn
11
12
13 JackAcc
14
15 Equipmnt
16 Facility
17 Admin
18 Help
NE 1
Time 20:13 >
The menu-based screens are arranged in a tree structure, with the Network
Element Status screen at the root. You move through the tree structure from
one screen to another by:
• locating the command you want from the command menu display area at
the left side of the screen, then typing its number in the command input
area, or
• typing the command name in the command input area at the bottom of the
screen
Note: For information on how to access this user interface, see “Access to
the user interfaces” on page 5-4.
The OPC tools are grouped into toolsets. There is one toolset for each of the
following areas of OPC functionality:
• software administration
• OPC administration
• network administration
• network surveillance
• system lineup and test (SLAT)
• provisioning administration
• test administration
• utilities access
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-8 User-interface overview
This chapter shows examples of software tools using the character-based user
interface.
[ Logout ]
C0 M0 m1 w2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 11:09
The User Session Manager window is like the main menu for the OPC user
interface. It displays the OPC software tools that are available to you, as well
as the instances of tools that have already been opened. You can select a tool
and open an instance or, if there is an instance open already, you can access
that instance.
Note: In a session in the OPC user interface, you can open more than one
instance of the same tool. However, when you reach the maximum number
of instances allowed for the tool, no further instances of that tool are
allowed and a disable icon appears in front of the tool in the list of available
tools.
When you open an instance of an OPC software tool or access an already open
instance, the main menu for the tool appears. The main menus of many of the
OPC tools are shown on the following pages.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-10 User-interface overview
The software administration toolset allows you to manage the software in the
network elements in the cluster. The toolset includes the following tools:
• Reboot/Load Manager tool
• Backup/Restore Manager tool
• Event Browser tool
• NE Software Delivery Manager tool
• Network Upgrade Manager tool
CS-10046
>. Reboot/Load Manager Options
3 Select
4 Deselect
5 Help H
CS-10065
>• Backup/Restore Manager Options
Network Element Shelf
641 Montreal 1 1 Manage backups
642 Vancouver 1 2 Select
3 Deselect
4 Help H
You can also list all the backup files that exist, and delete backup files that are
no longer required.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-12 User-interface overview
Use the Event Browser tool to view the history of the OPC and network
element logs, alarms, and alerts for a network element. You can also display
and print details about specific events.
CS-10043
CS-10043
>. Event Browser
CS-10048
>. NE Software Delivery Manager Utilities
Destination OPCs
OPCM027P (Local OPC)
OPCM001B [ Transfer Return]
NE Loads To Transfer
Load Name Source Size (kB) Shelf Processor Vintage Release
<Load Name> DISK 8808 ABM RFT APU 0 <Rel #>
ABM RFT APU 0 <Rel #>
<Load Name> DISK 439 ABM RFT HMU 0 <Rel #>
ABM RFT HMU 0 <Rel #>
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-14 User-interface overview
6 Duplicate...
7 Enable
8 Disable
9 Delete
10 Help H
[ Create a new user... +]
CS-10051
> . Remote OPC Software Installation Utilities
[ Setup ] [ Install ]
Release to be installed:
Installations to be Performed
1 Cancel
2 Continue
3 Retry
4 Delete
5 Swap Order
6 Details...
7 Select >>
Status Messages 8 Deselect >>
9 Help H
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-16 User-interface overview
Scheduler is disabled.
3. [ Enable scheduler 3]
4. [ Edit schedule 4]
CAUTION
Risk of software damage
Only set the date or time forward. Setting an earlier date or time
causes a trap that requires reloading the OPC to recover.
Always use the OPC Date tool to change the date or time. Using
the Unix shell command to set the clock does not properly update
the system data.
You can also specify whether the OPC clock uses the system’s 1 Hz pulse as
its source.
CS-10053
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-18 User-interface overview
CS-10055
>. E2A Alarm Manager
Active Network Elements
Network Element Equipment
>. 7 RFT RFT
>. 8 RFT FCOT
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-20 User-interface overview
• View, set up, delete, or change all STS-1 connections in the configuration.
• Designate the type of traffic to be carried by DS1 facilities (TR-303 DMS
or GR-303 MVI traffic). E1 facilities use the FAMCI and CVV5 toolsets
for this purpose, instead of the Connection Manager tool.
• Provision nodal default connections to STS-1 cross-connects on DS1/E1
systems.
• Audit and back up connection data.
CS-10223
CS-10223
> . Connection Manager View Options
Connections sorted by End NE A
Showing: All STS-1 connections
CS-10058
>. Cluster Inventory Options
11 Save Report... S
12 Show Inventory Timestamps... T
13 Print details P
14 Help H
[ Retreive B] [ Update U] [ Save report S]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 13:12
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-22 User-interface overview
[ Add +]
Using the Host Provisioning Manager, you can select an HDT from the list of
provisioned HDTs in the OPC span of control. After you select an HDT, the
system displays the following:
• host names provisioned on the HDT
• interface group (IG) numbers
• interface types (GR-303 DMS or GR-303 MVI)
• the primary alarm recipient indicator
CS-10060
>. Alarm Provisioning Manager
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-24 User-interface overview
A number of tools are available to monitor the status of the network. You can
customize the display to include information for all the network elements in
the OPC span of control for elements of particular interest to you.
CS-10252
CS-10252
>. User Session Manager : netsurv
[ Logout ]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 16:33
CS-10044
>. Alarm Monitor Options
Critical Major Minor Warning FailProt Lockout ActProt PrfAlrt
Network View . 1 3 20 . . . .
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-26 User-interface overview
CS-10045
>. Network Summary Protection
Critical Major Minor Warning FailProt Lockout ActProt PrfAlrt
Network View . . *1* . . *2* *1* .
Showing alarms: active and (*) New since reset (*) Cleared since reset
Network Element Reset Crit Major Minor Warn Fail Lock ActP Prf
1 Ottawa On 14:46 Act . . . . . . . .
New . . . . . . . .
Clr . . . . . . . .
+2 Montreal_108 18:46 Act . . . . . 1 . .
New . . 1 .Reset Counts
. . 1 . .
Clr . . . . . . . .
+3 MONTPQ01D33 18:46 Act . . 2 .Select . . >> . 1 .
New . . 3 .Deselect
. . >> . . .
Clr . . . . . . 1 .
4 Ottawa_ne_4 Jun23 Act . . 4 .Help . . H . . .
New . . . . . . . .
Clr . . . . . . . .
+5 Ottawa_ne_5 18:46 Act . . . . . 1 . .
New . . . . . 1 . .
Clr . . . . . . . .
CS-10042
>• Network Browser
SLAT toolset
SLAT functions include bringing a new system on line or upgrading an
existing one, managing configuration data, defining the test type for network
elements, and loading or upgrading the software in network elements.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-28 User-interface overview
CS-10062
>. OS Connection Manager Options
7 Delete
8 Help H
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-30 User-interface overview
Utilities toolset
Utilities provide user management functions such as creating authorized users
for the OPC, creating and maintaining user groups, and performing security
checks when a user signs on to use the OPC or to access a remote network
element from the OPC.
When this tool is started, it displays a list of all the nodes that have established
communications with the OPC. From this list you can select a node to log in
to. You can also update this list periodically to include nodes that have
established communications with the OPC since the last update.
CS-10064
CS 10064
>. NE Login Manager
1 Exit )
Available Nodes:
2 Help H
NE ID NE Name
35 Ottawa
1 Refresh list R
36 London
Network Element: > 36 London 2 Help H
5 Help H
[Refresh list R]
CS-10047
>. Password Update for: User1
1 Exit )
2 Help H
[ Update ]
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
5-32 User-interface overview
If you cannot successfully complete these procedures, contact your next level
of support.
Logging in to the network element, and logging out 6-3 page 6-7
Logging in to a network element from the OPC, and 6-5 page 6-13
logging out
Logging in to the Cornerstone toolset 6-6 page 6-16
Opening a network element user interface session from 6-7 page 6-17
other levels of the interface
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-2 Network element user interface procedures
Requirements
Before performing the procedures in this chapter, review the following
requirements.
Procedure 6-1
Connecting a local terminal to the network element
LCAP
Use this procedure to:
• connect a local user terminal to the network element
• set the communication parameters of the user terminal
• display the login screen
Action
Perform the following steps:
1 Connect the RS-232C cable to the user terminal according to the
manufacturer’s instructions.
2 Connect the RS-232C cable to the female D-subminiature 25-pin connector
on the local craft access panel (LCAP) as shown in Figure 6-1 for the single
HDT and dual HDT LCAPs, respectively.
Figure 6-1
LCAP RS-232 ports
FW-11339
FW-11339
RS-232
User
interface
port
3 Plug in the power cord and switch on power to the user terminal.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-4 Network element user interface procedures
Procedure 6-2
Connecting a remote VT100-compatible terminal
using an external modem
Use this procedure to connect a remote VT100-compatible terminal to user
interface port 1 using an external modem.
Requirements
Verify that the remote terminal has been configured for VT100 emulation. The
following are default parameters (these are found on the terminal
communication setup screen):
• VT100
• data bits (8)
• stop bit (1)
• parity (none)
• no local echo (full duplex)
• baud rate = 2400 (most modems, default for modem [DTE] port on shelf
right wing)
To perform this procedure, one user interface cable, NT7E44EA or EB, is
required.
Action
Perform the following steps:
1 Connect the 9-pin end of the NT7E44EA/EB user interface cable to the port
1 connector J08 on the left hand side of ABM shelf.
2 Connect the 25-pin end of the cable directly to the modem. Pin assignments
for the shelf connector are provided in the following table:
Pin Function Pin Function
8 DCD 6 Not connected
3 Rx 4 RTS
2 Tx 5 CTS
20 DTR 1 Not connected
7 GND
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-6 Network element user interface procedures
3 Ensure that the User Interface Port 1 baud rate is set to 2400. Set these
parameters in the NEUI, from a local or LAN connection.
Enter:
admin ip ↵
dtlport 1↵
chgstate oos ↵
yes ↵
edit ↵
baudrate 2400 ↵
quit ↵
chgstate is ↵
4 Set the following parameters for the external modem:
Assignment On or Off
Enable DTR recognition On
Provide word result codes On
Send result codes On
Echo commands Off
Auto-answer enable On
Carrier detect On
RJ-11 jack On
Enable commands Off
Enable RTS detection Off
Constant CTS On
Note: The above setup procedure provides default configuration parameters
for user interface port 1. These default configurations are used when the shelf
is first installed or after a system reboot. However, these user interfaces may
have been reprovisioned. In this case, the terminal, or modem, or both, must
be configured accordingly.
—end—
Procedure 6-3
Logging in to the network element, and logging out
Use this procedure to:
• log in to the network element user interface from a local terminal
• log out of the network element session, and log out of the terminal
Action
Logging in
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-8 Network element user interface procedures
4 Enter:
<password> ↵
The Network Element Status screen appears, as shown below. You are now
logged in.
C
CS-10216
Critical Major minor warning FailProt Lockout ActProt PrfAlrt
1 . . . 1 . . . .
S/DMS Nodes
0 Quit Network Element Status Shelf: CE
2
3 Alarms NE ID Alarms Protection Prf
4 ListNEs Fac Eqp Env Fail Lckt Act Alrt
5 1 . . . . . * .
6 PerfMon
7 FWPUI:
8
9
10 Protectn
11
12
13 JackAcc
14
15 Equipmnt
16 Facility
17 Admin
18 Help
NE 1
Time 20:13 >
Note: If you cannot log in, obtain the current user ID and password from your
system administrator.
If you are the ninth person trying to log in, your login attempt will be rejected.
See page 6-10 for additional explanation.
If the system locks you out while you are typing your user name or password,
you or someone at another terminal might have accidentally typed Ctrl_S.
This prevents further keyboard input from any terminal connected to the DTE
and DCE ports of the network element.
To correct the lockout, type Ctrl_Q at your terminal, then retry this procedure.
If you are still locked out after typing Ctrl_Q, connect a terminal to the other
port (DCE or DTE), type Ctrl_Q, then retry this procedure.
—continued—
Line-by-line terminal
Logging out
At any level in the UI menu hierarchy, including the CI level, you can log out
directly, by entering:
logout ↵
The user interface ports on the network element have an autologout feature. If
you did not logout normally, the user interface session automatically
terminates five seconds after one of the following events:
If, once you turn off power to the user terminal, the DTE connection is lost:
• such as if the RS-232 cable to the LCAP is unplugged.
• such as if the modem carrier signal is lost, or if the cable to the Modem
connector on the left-side interconnect is unplugged.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-10 Network element user interface procedures
The local ports are the DTE port on the LCAP and the DCE port on the side
interconnect left circuit pack. One login session to FWPUI is supported from
each local port. The eight remote login sessions can include a login session
from another network element, and rlogin sessions from an OPC using the
rlogin manager.
If eight remote login sessions are in progress, then one of the following
messages appears to the person trying to log in to the ninth FWPUI session:
“Unable to connect to remote host: no session entity”
(if attempted from an OPC rlogin session)
“Could not connect to server”
(if attempted from another network element FWPUI session)
These messages are displayed because the communication connection to the
network element cannot be established when all remote communication ports
are in use. The messages will also be displayed if the network element is not
operational (software is not running) or if connection to the network element
is not possible due to network connectivity problems.
If eight login sessions are in progress, and at least one of the sessions is via the
local port, then the following message appears to the person trying to establish
the ninth login session:
“Maximum of 8 FWPUI sessions already active. Try again
later when some of the users currently logged in, have
logged out or quit from FWPUI.”
This message appears because, although the communication connection to the
network element is established (one local port and one remote port were
available, or two remote ports), the maximum number of FWPUI login
sessions is exceeded. In this condition, the user is locked out of FWPUI, but
retains the communication connection, with access to the command interpreter
(CI) and MAPCI. The user can continue in a CI or MAPCI session, or cancel
the communication connection using the logout command.
—end—
Procedure 6-4
Logging in to the far-end NE from the local NE
Use this procedure to log in to the far-end network element from the local
network element.
Requirements
You must be logged in to the user interface of the local network element, not
the OPC. (If you are logged in to the OPC user interface, then use the
procedure “Logging in to the network element from the OPC, and logging out”
on page 6-13 to gain access to another network element.)
You must have a username (userID) and password for the far-end network
element.
Action
Perform the following steps:
1 If you do not know the NE number of the far-end network element, display a
list of NEs by entering:
listnes ↵
A list of network element number displays.
2 From any screen of the local network element user interface, log in to the
far-end network element:
rlogin ne <NE #> ↵
The login screen for the far-end NE appears, with the following prompt:
Enter User Name
3 Enter:
<username> ↵
The terminal responds with:
Enter Password
4 Enter:
<password> ↵
You are now logged in to the far-end network element. (You also remain
logged in to the local network element.)
Note:
• If you can’t log in, obtain the current userID and password from your
system administrator.
• If you are the ninth person trying to log in, your login attempt will be
rejected. See page 6-10 for additional explanation.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-12 Network element user interface procedures
5 To log out of the far end and return to the local network element user interface,
enter the following command from any screen:
logout ↵
You are logged out of the far-end network element and the CI screen appears
for the local network element.
6 Display the main screen for the local network element:
fwp ↵
The Network Element Status screen appears for the local network element.
Note: When you need to log in to the far-end network element again, repeat
this procedure from step 2.
—end—
Procedure 6-5
Logging in to a network element from the OPC, and
logging out
Use the following procedure to log into or out of a network element from the
OPC. You can log in directly using the Auto login button. The tool then uses
the userID you entered for the current session. You can also log in by
specifying a new userID for this login session only. The maximum number of
NE login sessions from an OPC is 12.
Note 1: The Network Element field is case sensitive. Either select the node
from the Available Nodes list or type the network element name exactly as
it appears in the list.
Note 2: If you are denied access to the node, you can return to the NE
Login Manager main window by pressing Ctrl_B. When the question mark
(?) prompt appears, type “logout” then press Return.
Action
The following procedures describe how to log into and out of an NE.
Logging in
To log in, perform the following steps:
1 Log into the OPC and open the NE Login Manager tool.
The NE Login Manager main window appears.
FW-22023
FW 22023
NE ID NE Name
35 Ottawa
36 London
Network Element: >
[Refresh list R]
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-14 Network element user interface procedures
CS-10216
Critical Major minor warning FailProt Lockout ActProt PrfAlrt
1 . . . 1 . . . .
S/DMS Nodes
0 Quit Network Element Status Shelf: CE
2
3 Alarms NE ID Alarms Protection Prf
4 ListNEs Fac Eqp Env Fail Lckt Act Alrt
5 1 . . . . . * .
6 PerfMon
7 FWPUI:
8
9
10 Protectn
11
12
13 JackAcc
14
15 Equipmnt
16 Facility
17 Admin
18 Help
NE 1
Time 20:13 >
Note: If the Auto login was not successful, you will be prompted for a different
userID and password.
—continued—
Trying...
Trying...
Logging out
To log out, perform the following steps:
7 When you no longer need the connection, log out from the network element
by typing:
logout ↵
A message appears, prompting you to press Return.
8 Press Return to return to the NE Login Manager main window, then close the
tool.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-16 Network element user interface procedures
Procedure 6-6
Logging in to the Cornerstone toolset
Use this procedure to log in to the Cornerstone toolset from the network
element user interface (NEUI).
Action
Perform the following steps:
1 From any screen on the NEUI, quit to the CI level of the user interface by
entering:
quit all ↵
The CI prompt appears.
2 Log in to the Cornerstone toolset by entering:
cornerstone ↵
You are now logged into the Cornerstone toolset, and can enter any of the
Cornerstone tools by entering the tool name (CVALRM, CVEQPT,
CVLOADER, CVPATH, CVPROV, CVSPMN, VLCMCI).
—end—
Procedure 6-7
Opening a network element user interface session
from other levels of the interface
Use this procedure to open a network element user interface session at a
different level, while already logged in. You can begin either a full-screen or a
single-line session.
This procedure is most often used after you have finished an OPC session from
the network element and you want to return to the network element user
interface session.
Use Figure 6-2 to identify whether you are at the command interpreter (CI)
level or the maintenance and administration position command interpreter
(MAPCI) level.
Figure 6-2
Interface levels
FW-2529
CI software FW-10175
quit mapci
command command
quit fwpui
command command
Requirements
Identify your current network user interface level.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-18 Network element user interface procedures
Action
Perform the following steps:
1 Decide what type of user session you want:
If you want a... then go to...
Note: The single-line session provides very limited screen display capabilities
and is intended for experienced users.
2 You can begin a full-screen session from both levels of the interface as
follows:
If your screen prompt is:... then enter...
CI fwp ↵
MAPCI fwpui ↵
CS-10216
Critical Major minor warning FailProt Lockout ActProt PrfAlrt
1 . . . 1 . . . .
S/DMS Nodes
0 Quit Network Element Status Shelf: CE
2
3 Alarms NE ID Alarms Protection Prf
4 ListNEs Fac Eqp Env Fail Lckt Act Alrt
5 1 . . . . . * .
6 PerfMon
7 FWPUI:
8
9
10 Protectn
11
12
13 JackAcc
14
15 Equipmnt
16 Facility
17 Admin
18 Help
NE 1
Time 20:13 >
—continued—
3 You can begin a single-line session from either level of the interface as
follows:
If your screen prompt is:... then enter...
FW-2531
4 To end a session from any screen in the network user interface, log out from
the network element by typing:
logout ↵
A message appears, prompting you to press Return.
5 Return to the NE Login Manager main window and close the tool.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-20 Network element user interface procedures
Procedure 6-8
Working with line cards
Use this procedure to access the Line Card Provisioning screen and change the
State of a line card. This procedure applies to all switch interfaces.
Requirements
Identify your current network user interface level.
Action
Perform the following steps:
1 From any screen on the NEUI, enter either of the following commands:
eq vplc vp <vpid> <line> ↵
or
eq vplc v5 <interface> <port ID>↵
or
eq crvlc <ig #> <crv> ↵
or
eq almlc <lc instance> ↵
2
The line card equipment screen displays.
3 You can change the state of the line card by entering either of the following:
chgstate oos ↵
or
chgstate is ↵
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-22 Network element user interface procedures
Procedure 6-9
Determining NE status on V5.2 systems
The "fa comm;ports v5 IF id" command presents the V5 NE Status Screen for
V5 interfaces provisioned using the “addif CI.” This screen provides much the
same information as provided by the “queryv5” CI command, but is
automatically updated as interface and link status’ change. All the commands
associated with this screen act only with respect to the posted interface. The
only exception to this is the NextIF command.
NE status commands
The following table lists and describes each of the NE status commands:
Command Description
DtlLink This command provides details about the selected link. The link
can be specified using either the link id number, or the E1 circuit
pack/port identifiers. For example to detail the link on E1 G1 2:
DtlLink L 2 ( L – link)
or
DtlLink f g1 2 ( F – facility)
—continued—
Command Description
ClrLink This command removes the data displayed via the DtlLink
command.
Configuring LC Timings
It is possible to change the line card timing registers for all line cards on the
system. It should be noted that under normal conditions these values will not
need to be changed. These commands are only made available to provide
flexibility for the user. The following parameters can be configured:
Parameter Description
HIT_TIME_MAX The maximum time tip and ring can be shorted for the
line card to detect a "hit". A hit is considered noise and
is disregarded. Any short between tip and ring longer
than this value is considered an "event". An event can
be either a digit pulse, a flash or an on-hook. Default
value: 40 msec.
FLASH_TIME_MIN The minimum time tip and ring must be shorted for a
flash event to be recognized. Default value: 100 msec.
DISC_TIME_MIN The minimum time the tip and ring must be shorted for
an on-hook (or disconnect) event to be generated.
Default value: 1 sec.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
6-24 Network element user interface procedures
7-3 Connecting the portable OPC to the network element page 7-15
7-6 Logging in to the remote OPC from a local OPC page 7-23
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-2 OPC user interface procedures
Requirements
Before performing any of the procedures in this user guide, review the
following requirements:
• Procedures involving connection to an OPC or network element (NE),
require the following:
— You must have a terminal. It may be a VT100-compatible terminal or
laptop computer with VT100 terminal emulation. (The customer is
responsible for obtaining the laptop computer and emulation package
from a third-party source.)
— you must obtain the appropriate connection cable (see the section
“Cable connectors and pinouts” on page 7-5 for details on cable
requirements)
CAUTION
Risk of equipment damage
When handling the equipment, the following precautions
must always be observed.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-4 OPC user interface procedures
Procedure 7-1
Connecting a terminal to an OPC
Use this procedure to connect a local user terminal to a primary or backup OPC
via OPC port 1 (also referred to as OPC port B).
OPC port 3 can also be configured for terminal communications. Port 3 is only
available on an ABM shelf (on an I/O card in slot 40) or on a portable OPC
(ESP port 2).
Table 7-1 shows port locations and designations for an OPC in an ABM shelf.
Port connections can also be seen in following illustrations.
Table 7-1
Port locations and labels
Table 7-3 provides pinouts for the NT7E44RA and NT7E44RB cables.
Table 7-3
RS-232 cable pinouts
Pin number and function Wire color Pin number and function
(9-pin connector) (25-pin connector)
1 DCD BK 4 RTS
2 RXD BR 2 TXD
3 TXD R 3 RXD
4 DTR O 5 CTS
4 DTR Y 6 DSR
5 GND G 7 GND
6 DSR BL 20 DTR
7 RTS V 8 DCD
8 CTS W 20 DTR
9 Not connected — —
The network elements use the data carrier detect (DCD) line (pin 1) of the OPC
port 1 to ensure proper logging off when the terminal is disconnected or the
modem line is dropped.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-6 OPC user interface procedures
The North American version of the DEC VT320 and VT420 are two examples
of terminals that do not support the full RS-232 protocol through their RJ-11
connectors. This prevents the use of such terminals with the current
NT7E44RA/RB cable. The international version of these models support the
full RS-232 protocol (25-pin connector).
For such North American terminals to operate, the cable must be modified.
Connect pin 1 (DCD) to pin 4 (DTR) on the 9-pin connector side (going into
the OPC port 1 connector). This disables the security feature.
Table 7-4 provides pinouts for the NT7E44SA and NT7E44SB cables.
Table 7-4
Pinouts for NT7E44SA and NT7E44SB cables
2 Rx (receive) 3
3 Tx (transmit) 2
5 signal ground 5
9 not used
Note 1: Pin 9 at the ABM shelf end of the cable is not used.
Note 2: Pin 4 at the lap-top end of the cable connects to pins 1 and 6 at the ABM
shelf end of the cable.
Note 3: Pin 4 at the ABM shelf end of the cable connects to pins 1 and 6 at the Lap
Top end of the cable.
—continued—
Parameter Value
data bits 8
stop bits 1
parity none
emulation VT100
scroll jump
autowrap off
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-8 OPC user interface procedures
Figure 7-1
OPC and terminal connections
FW-11176
FW-11176
VT100 compatible
OPC
Port 1 (B)
Access
bandwidth
manager
OP
(J0 C
7)
Local craft
access panel
NEUI
Port 2
Action
Perform the following steps:
1 Proceed as follows:
• If you are using a VT100-compatible terminal, then go to step 7.
• If you are using a laptop computer, then go to step 2.
2 Power up the laptop.
3 Consult and follow the vendor documentation for the emulation package you
are using to determine how to configure your laptop as a VT100-compatible
terminal.
4 If required by the emulation package, select the following options:
baud rate 9600
data bits 8
stop bits 1
parity none
scroll jump
autowrap no
protocol ASCII
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-10 OPC user interface procedures
6 Connect the laptop to the OPC by first connecting one end of the RS-232
cable to OPC port 1 on the network element, then connect the other end of
the cable to the serial port A on the laptop.
Go to step 12.
7 Connect the terminal to OPC port 1, using the appropriate RS-232 cable.
8 Power up the terminal.
9 Press Return.
The OPC login prompt (login:) should appear on your screen:
If the prompt... then...
does appear you are successfully connected. Go to the procedure
“Logging in to the OPC” on page 7-19 to log in to the
OPC.
10 Check all connections between the OPC port and the terminal. Ensure that
the terminal is powered up, then repeat step 9. If the prompt still does not
appear, suspect that the port is not set up for terminal operation and proceed
to the next step.
11 Connect a VT100-compatible terminal to the network element, as described
in “Connecting a local terminal to the network element LCAP” on page 6-3.
12 Log in to the network element.
13 Log in to the OPC from the network element.
The User Session Manager appears.
14 Select the Port Configuration tool.
The Port Configuration main menu appears.
1.Query Port Configuration
2.Configure a service
3.Unconfigure a service
4.Exit
15 Query the port configuration by entering:
1↵
The OPC displays the current state of all available ports.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-12 OPC user interface procedures
26 Log out of the OPC, and if required, log out of the network element.
27 Go back to the beginning of the procedure and repeat the connection
procedure to connect the terminal to port 1 (or B) of the OPC.
Table 7-6
Suggested key mapping assignment for laptop function keys
Where possible, assign the following keyboard equivalents to the function keys
indicated. When using the keyboard, the symbol “_” denotes that the Control key
must be held down while you press the other key. For example, in the command
Ctrl_A, the Control key is be held down while pressing the “A” key.
Function Keyboard Operation
key equivalent
F4 Ctrl_L T Tool menu—displays the tool menu for the tool currently
in use
—end—
Procedure 7-2
Connecting a terminal to the portable OPC
Use this procedure to connect a terminal to a portable (slat) OPC. It is
recommended that you use a laptop as the display terminal.
Action
Perform the following steps:
1 Connect the VT100-compatible terminal to the portable OPC (see
Figure 7-2). Use the serial A port on the VT100-compatible terminal, and
Port B on the portable OPC.
Figure 7-2
Portable OPC terminal connection
CS-10243
CS-10243
VT100-compatible
(rear view)
Port B
Portable OPC
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-14 OPC user interface procedures
3 Power up the VT100 terminal. If you are using a laptop computer, ensure that
you have configured the terminal as an OPC terminal (see the System
Administration Guide, ARSVD00400, for terminal configuration procedures).
4 If you are using a terminal emulation program, start it and connect to the
OPC. The procedure for doing this is different for each program.
The VT100 emulation screen appears.
5 Press Return on the VT100 terminal.
When initialization is complete, the OPC logon prompt (login:) appears on
your terminal screen.
—end—
Procedure 7-3
Connecting the portable OPC to the network element
Use this procedure to connect the portable OPC to the side interconnect left
circuit pack of the common-equipment shelf. It is recommended that you use
a laptop as the display terminal. Either a VT100-compatible terminal or a
laptop computer with a VT100 emulation package can be used.
Requirements
• All required software is loaded on the portable OPC.
• A CNet cable, 9-pin D-sub (M) to 9-pin D-sub (M) (NT4K86).
• Two control-network terminator plugs (NT7E5072).
Action
Perform the following steps:
1 Connect the control-network cable to the CNET port on the portable OPC and
the Ctl Net In connector on the side interconnect left circuit pack on the
common-equipment shelf, as shown in Figure 7-3.
Figure 7-3
OPC connection to CNET
FW-10248
Common-equipment shelf
FW-10248
9-pin to 9-pin
CNet cable
Portable OPC
Note: Attach terminator
to unused CNet port.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-16 OPC user interface procedures
FW-10247
Caution
Caution
Co
(J1nt Ne
0) t In
OCI-12
OCI-12 Active
Active LOS Co
(J0nt Ne
LOS Fail
Fail
9) t O u
t
Terminator
plug
—end—
Procedure 7-4
Connecting a remote terminal to the OPC using an
external modem
Use this procedure to connect a terminal to the OPC port using an external
modem.
Requirements
Verify that the remote terminal has been configured for VT100 emulation. The
following are default parameters (these are found on the terminal
communication setup screen):
• VT100
• data bits (8)
• stop bit (1)
• parity (none)
• no local echo (full duplex)
• baud rate = 2400 (most modems, default for modem [DTE] port on shelf
right wing)
Action
Perform the following steps:
1 Connect one end of the NT7E44EA/EB 9/25-pin user interface cable to the
9-pin OPC port 1 connector J08.
2 Connect the 25-pin end of the cable directly to the modem. Pin assignments
for the shelf connector are provided in the following table:
Pin Function Pin Function
8 DCD 6 N/C
3 Rx 4 RTS
2 Tx 5 CTS
20 DTR 1 N/C
7 GND
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-18 OPC user interface procedures
Auto-answer enable ON
Carrier detect ON
RJ-11 jack ON
Constant CTS ON
Procedure 7-5
Logging in to the OPC
Use this procedure to log in to the active OPC using a VT100-compatible
terminal or laptop computer with VT100 terminal emulation. Logging in using
this method starts the login at the OPC login screen and results in the User
Session Manager being displayed. You can also use this procedure to log in
from an X terminal, in which case the login starts at the OPC login screen at
the X terminal.
Action
If you are using the... Then go to...
character-mode terminal (CMT) user interface step 1
graphical user interface step 6
login:
password:
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-20 OPC user interface procedures
[ Logout ]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 10:10
Note: You are finished with this procedure. If you want to open an OPC tool
listed in the User Session Manager window, see the procedure, “Opening an
OPC tool” on page 7-31.
—continued—
6 To log into the GUI, start your GUI interface then type your user ID in the User
ID field.
FW-21059
FW-21160
FIBER WORLD
This software contains material which is
confidential to Northern Telecom Limited
and is made available solely pursuant to
the terms of a written license agreement
with Northern Telecom Limited.
User ID:
Password:
Done Alt+Return
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-22 OPC user interface procedures
8 Tab to the Done button and press the Alt_Return key; or click on the
Done pushbutton.
The Alt key is labelled Alt on NCD, Extend Char on HP, Left or Right or the
<diamond symbol> on SUN.
The workspace appears, displaying the tools available. You are logged into
the OPC. See Chapter 3 for details on using the graphical user interface.
FW-21699
FW-21699
Pointer X
—end—
Procedure 7-6
Logging in to the remote OPC from a local OPC
Use this procedure to log in to a remote OPC with a graphical user interface
terminal session. CMTs do not have this ability. This procedure displays the
User Session Manager, not the graphical desktop for the remote OPC (at step
5). When you have logged in, you can perform any operation that can usually
be done on that OPC.
Requirements
Using the Commissioning Manager, ensure that the remote OPC has been
added to the list of OPCs that this OPC can reach.
Action
Perform the following steps:
1 Display the Utilities toolset and select the Remote OPC Login tool.
The Remote OPC Login dialog appears.
FW-20656
OPC:
2 In the OPC field, display the chooser menu by right clicking on the “- “ on the
right side of the OPC field and select the OPC that you want to log in to.
The name of the OPC appears in the OPC field.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-24 OPC user interface procedures
—continued—
[ Logout ]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 10:10
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-26 OPC user interface procedures
Procedure 7-7
Logging in to an OPC from a network element
Use this procedure to log in to an OPC from a network element.
The following table lists the commands entered for logging in to an OPC from
a network element.
rlogin opc sets up a session with the active OPC for the network
element that you issue the command from.
rlogin opc9999b sets up a session with the backup OPC that has an alias
of opc9999b.
rlogin opc9999p sets up a session with the primary OPC that has an alias
of opc9999p.
rlogin london does not set up a session if the real name of this network
element is London. For uppercase and lowercase names,
quotes must be used around the name.
Action
Perform the following steps:
1 From the network element user interface screen, type:
rlogin opc ↵
The login screen appears.
It is recommended that you use the opc name as the alias, that is, if you call
the primary OPC “opc9999p”, then this is the number you enter for the alias.
Similarly the alias for the backup is opc9999b. The alias name is the name
that is stored against the OPC serial number. In the current release, this is the
only way that you can set up a session with an OPC other than the active OPC
for the span of control that you are in.
2 Enter your userID after the login prompt and press Return. Your userID is
case sensitive.
You are prompted for a password.
—continued—
3 Enter the password after the password prompt and press Return. Your
password is case sensitive.
The password does not appear in the field when you type it.
4 If you log in as a root user, you access the UNIX shell layer of the interface.
To access the OPC user interface, enter:
opcui ↵
The User Session Manager appears showing you the tools that you are
allowed to use.
FW-21059
FW-21059
[ Logout ]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 10:10
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-28 OPC user interface procedures
Procedure 7-8
Logging in to the Cornerstone toolset
Use this procedure to log in to the Cornerstone tool set from the OPC.
Action
Perform the following steps:
1 Log in to the OPC and open the NE Login Manager tool.
The NE Login Manager main window appears.
FW-22023
FW-22023
NE ID NE Name
35 Ottawa
36 London
Network Element: >
[Refresh list R]
—continued—
2 Tab to the Available Nodes list and move the cursor to the node that you want.
Select it by pressing Ctrl_A (or Keypad 0).
The ID (and name) of the selected node appears in the Network Element
field.
If you... then go to...
log in with the same user ID and password used to log in step 3.
to the OPC
3 To log in without reentering your userID and password, tab to the Auto login
button and select it by pressing Ctrl_A (or Keypad 0).
If a connection is possible at this time, you are logged in directly to the node.
The main menu of the network element user interface appears. You can now
enter network element commands.
Proceed to step 5.
CS-10216
CS-10216
Critical Major minor warning FailProt Lockout ActProt PrfAlrt
1 . . . 1 . . . .
S/DMS Nodes
0 Quit Network Element Status Shelf: CE
2
3 Alarms NE ID Alarms Protection Prf
4 ListNEs Fac Eqp Env Fail Lckt Act Alrt
5 1 . . . . . * .
6 PerfMon
7 FWPUI:
8
9
10 Protectn
11
12
13 JackAcc
14
15 Equipmnt
16 Facility
17 Admin
18 Help
NE 1
Time 20:13 >
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-30 OPC user interface procedures
Trying...
Trying...
Procedure 7-9
Opening an OPC tool
Use this procedure to open an OPC tool.
Some tools allow you to open more than one instance of the same tool. For
example, you may have three instances of a tool open at one time. If a tool
cannot be opened because you have reached the maximum number of
instances, a disable icon appears in front of the tool name, and you must use
one of the open instances of the tool.
Action
Perform the following steps:
1 Display the User Session Manager by pressing Ctrl_T 0.
The Session Manager displays.
FW-21059
FW-21059
[ Logout ]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 10:10
2 In the User Session Manager window, look for the tool name in the Available
tools list.
If the tool name... then go to...
does not have a disable icon step 3.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-32 OPC user interface procedures
3 In the Available tools list, move to the tool you want to open and select it by
pressing Ctrl_A .
A progress dialog appears while the tool is opening. Then the main window
for the tool appears.
Go to step 6.
4 If the disable icon appears beside the tool name, you cannot open the tool,
but you can use an open instance of the tool. Look for the tool name in the
Open tools list. If the tool you want to view is listed there, tab to the Open tools
list.
5 Move to the tool you want to use and select it by pressing Ctrl_A.
The main window for that tool appears.
6 You have completed the procedure. Return to the main procedure that
directed you to this procedure.
—end—
Procedure 7-10
Closing an OPC tool
Use this procedure to close an OPC tool.
If you have only one instance of a tool open, then this procedure closes the tool
and automatically displays the Session Manager, leaving you logged in to the
OPC.
If you have more than one tool (or instance of a tool) open, then you must
repeat this procedure to close each open tool. Alternatively, go to the Session
Manager and log out from the OPC, as explained in the procedure titled
“Logging out of the OPC” on page 7-34.
Action
Perform the following steps:
1 Display the window menu by pressing Ctrl_L W (or Keypad 6).
The window menu is shown following:
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-34 OPC user interface procedures
Procedure 7-11
Logging out of the OPC
Use this procedure to log out of the OPC. This procedure automatically closes
all tools and removes their windows.
Action
Perform the following steps:
1 If the Session Manager is not displayed, display it by pressing Ctrl_T 0.
The Session Manager window appears.
FW-21059
FW-21059
[ Logout ]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 10:10
—continued—
2 In the Session Manager, tab to the Logout button and select it by pressing
Ctrl_A (or Keypad 0).
The following confirmation dialog appears.
FW-20664
FW-20664
3 In the confirmation dialog, tab to the Logout button and press Ctrl_A (or
Keypad 0).
The confirmation dialog closes, the User Session Manager window closes,
and the login screen appears.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-36 OPC user interface procedures
Procedure 7-12
Changing your password
Use this procedure to change your password for a particular userID on the
OPC. If you have a userID for some network elements and a different userID
for other network elements, you have to change the password for each userID
separately.
UserIDs are stored on the OPC. Therefore, you have different userIDs for
different spans of control.
Requirements
Select a new password that conforms to the security criteria of your
installation. It must be different from your current password.
Action
Perform the following steps:
1 Open the Password Update tool.
The Password Update tool main window appears.
FW-21120
FW-21120
>
[ Update ]
If... then...
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-38 OPC user interface procedures
3 Enter your new password by typing (the characters do not appear as you type
them but the cursor moves):
<new password> ↵
The field label indicates whether the new password is accepted or rejected.
If the password is accepted, the text above the field changes to “Retype new
password followed by Return”. If the password is rejected, an X is placed
beside the field.
If... then...
Procedure 7-13
Displaying OPC status
Knowing which OPC you are logged in to is important when you are
performing data backups or restores, installing software, or commissioning
network elements. Use this procedure to display the following information
about a particular OPC:
• OPC name, as defined by the SLAT user during OPC commissioning
• OPC function, which can be primary, or out of service
• OPC status, which can be active, inactive, or out of service
• the network element in which the OPC is located
• the shelf in which the OPC is equipped
• the version of software that is currently running in the OPC
Action
Perform the following steps:
1 Display the User Session Manager by pressing Ctrl_T 0.
The User Session Manager appears. Note that the OPC Status tool is at the
top of the Open tools list.
FW-20131A
FW-20131
[ Logout ]
C 0 M 0 m 1 w 2 FailProt 0 Lckt 0 ActProt 0 PrfAlrt 0 09:10
Note: The OPC Status tool is always open throughout a session; you cannot
close it. In the User Session Manager screen, it always appears in the Open
tools list, never in the Available tools list.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-40 OPC user interface procedures
4 After viewing the OPC status, return to the User Session Manager by
pressing Ctrl_ T 0.
The User Session Manager appears. The OPC Status tool remains at the top
of the Open tools list.
—end—
Procedure 7-14
Changing the name of an OPC
Use this procedure to change the name of an in-service OPC.
Requirements
Prior to carrying out this procedure, do the following:
• Obtain a userID and password for the SLAT security level of a network
element in the OPC span of control.
• Obtain a userID and password of the primary and the backup OPC at the
SLAT security level.
• Make the OPC, that you want to rename, the primary OPC for that span of
control.
• Log on to the network element at the slat security level. The default userID
is “SLAT” and the default password is “slat”.
• Log on to the primary OPC from the network element at the slat security
level. The default userID is “SLAT” and the default password is “slat.”
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-42 OPC user interface procedures
Action
Perform the following steps:
1 Open the Commissioning Manager tool.
The Commissioning Manager main window appears.
CS-10229
CS-10229
2 Tab to the Edit system data button and select it by pressing Ctrl_A
(or Keypad 0).
The following dialog appears.
FW-20677
FW-20677
—continued—
3 Tab to the OPC name field, and type in the name for the primary OPC. The
backup OPC will take this name also. OPC names must be unique within the
network, and have the following format:
OPC<nnnn>
Where... is...
4 Tab to the OK button and select it by pressing Ctrl_A (or Keypad 0).
5 Return to the User Session Manager on the OPC by entering Ctrl_T 0.
6 Copy the data from the primary OPC to the backup OPC (as described in the
procedure “Transferring data between OPCs” on page 8-24“.
7 Reboot the primary OPC (as described in the procedure “Shutting down an
OPC” on page 8-3“.
8 Log out of the primary OPC.
9 Log in to the backup OPC from the network element.
10 Reboot the backup OPC (as described in the procedure “Shutting down an
OPC” on page 8-3“.
All network elements in the OPC span of control are updated with the new
OPC name automatically. In the event of a network element rebooting, it will
be able to reach its newly named OPC and reload its software.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
7-44 OPC user interface procedures
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-2 Other OPC procedures
Requirements
Before performing the procedures in this user guide, review the following
requirements.
• You must be familiar with the OPC user interface. Descriptions of the
character mode terminal (CMT) and graphical user interfaces are given in
Chapters 2 and 3 respectively.
• You must be logged into the terminal connected to the OPC.
• To shut down an OPC, you must have a userID and password of a user that
has permission to shut down the OPC. Only users in the root, slat, or admin
class can shut down the active OPC; users in the root or standby class for
the inactive OPC.
• Procedures for identifying tape data and saving or restoring data to tape,
require that the OPC tape be installed in the OPC tape drive. (Always allow
the tape to reach room temperature. Never insert a tape that has been stored
at temperatures outside the range 10°C to 30°C (50°F to 90°F) until it has
reached room temperature.)
Procedure 8-1
Shutting down an OPC
Use this procedure to shut down or reboot an OPC.
The procedure is the same for restarting or halting. If you restart the OPC, the
OPC will shutdown and immediately restart. If you want to remove all power
from the OPC so that it can be removed from the shelf, select the halt option.
Action
Perform the following steps:
1 Open the OPC Shutdown tool.
The OPC Shutdown tool main window appears.
CS-10222
CS-10222
[ Shutdown ] [ Exit )]
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-4 Other OPC procedures
[ OK Return ]
In progress...
Shutdown in progress:
XXX..
This progress dialog indicates that the OPC is shutting down normally. Since
the shutdown continues while the console message in step 5 appears, the
shutdown might complete before you select the OK button. In this case, you
will not see the progress message.
A dialog stating that the OPC is out of service appears (to all users who are
currently logged in to the OPC).
—continued—
Information If you are NOT going to remove or power down the OPC,
select the Restart option and then select OK to complete
the shutdown.
[ OK Return ]
8 Depending on the task you are performing, you might be required to remove
the OPC module from its shelf or to power down a portable OPC. In these
cases, you must take the required action before the OPC attempts to reboot.
If you will be... then go to...
9 Tab to the Restart button and select it by pressing Ctrl_A (or Keypad 0).
This action causes the OPC to reboot without delay after the shutdown
completes. If you select this option, you will not have time to physically
remove the OPC without damaging the OPC.
10 Tab to the OK button and select it by pressing Ctrl_A (or Keypad 0).
The shutdown procedure completes. The OPC then initiates a reboot (takes
about 5–10 minutes). When it is complete, the OPC login prompt (login:)
appears.
The shutdown of the OPC terminates all user login sessions. You have to log
in again after the OPC returns to service.
You must not remove or power down the OPC during the reboot process.
When the login: prompt appears, return to the main procedure.
11 Select the OK button by pressing Ctrl_A (or Keypad 0).
The shutdown procedure continues. When it is complete, the green Activity
Indicator LED on the OPC turns off.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-6 Other OPC procedures
CAUTION
Risk of data corruption
Do not remove or power down the OPC after the red LED has
turned on. If you do, you will corrupt the data on its hard drive. The
shut down process takes 5 to 10 minutes.
12 Immediately after the green LED turns off, remove the OPC or power down
the portable OPC.
To power down a portable OPC:
• Switch the power switch at the back of the portable OPC to the OFF
position when the shutdown dialog informs you to do so.
• Remove the CNET cable from both the network element and the portable
OPC.
If the OPC is still in place or if the portable OPC is powered up 3 minutes after
the LED turns off, a start up is initiated. If you have not removed or powered
down the OPC by this time, the red Unit Fail LED turns on and an alarm is
raised.
—end—
Procedure 8-2
Checking the OPC tape identification
Use this procedure to confirm that the correct tape has been inserted in the
OPC tape drive or to determine the data that is on a particular tape.
Action
Perform the following steps:
1 Open the OPC Save and Restore tool.
The OPC Save and Restore main window appears. The Save to tape button
is selected and the buttons for saving OPC data to tape appear in the bottom
half of the window.
FW-20361A
FW-20361
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-8 Other OPC procedures
2 Select the Display tape details button by pressing Ctrl_A (or Keypad 0).
The Tape Details dialog appears. It shows information about the tape.
CS-10221A
CS-10221
Tape Details
3 Check the fields in the dialog to confirm that you have inserted the correct
tape into the tape drive.
If the tape has never been used, the “Tape type” will be “Unknown” and all
other fields will be blank.
You cannot change the information in this dialog. This information is written to
this dialog by the OPC when tape is used to record the backup data from the
OPC.
4 If the wrong tape has been inserted, insert the correct one.
5 To exit the Tape Details dialog, select the Done button by pressing Ctrl_A
(or Keypad 0).
The Tape Details dialog closes.
6 If you are finished with the tape, remove it and close the OPC Save and
Restore tool. Otherwise continue as follows:
If you want to... then go to...
restore data from the tape to an OPC Procedure 8-4 on page 8-15
—end—
Procedure 8-3
Saving OPC data to tape
Use this procedure to save OPC data to a backup tape in the OPC tape drive.
Once the save operation is started, you cannot access any other OPC tool until
the operation is canceled or completed. The save operation can take up to 40
minutes to complete depending on the amount of data on the disk.
CAUTION
Risk of damage to electrostatic-sensitive devices
Electrostatic-sensitive devices can be damaged by
electrostatic discharge. Always ground yourself before
handling the tape.
You cannot select individual files to be saved. The OPC Save and Restore tool
automatically selects and saves the appropriate files.
Note: When the tool is first opened, the “Save to tape” operation should be
selected by default, as shown in the illustration on the next page. If the
“Save to tape” button is disabled, the local OPC is inactive and you cannot
perform this procedure.
The tool contains two action buttons: Display tape details and Save OPC
data to tape. It is recommended that you select both buttons in the order that
they appear.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-10 Other OPC procedures
Action
Perform the following steps:
1 Open the OPC Save and Restore tool.
The OPC Save and Restore main window appears. The Save to tape button
is selected and the buttons for saving OPC data to tape appear in the bottom
half of the window.
FW-20361A
FW-20361
—continued—
2 Select the Display tape details button by pressing Ctrl_A (or Keypad 0).
The Tape Details dialog appears. It shows information about the tape.
CS-10221A
CS 10221
Tape Details
3 Check the fields in the dialog to confirm that you have inserted the correct
tape into the tape drive. If this is not the correct tape, remove it and insert the
correct one. Press Ctrl_A (or Keypad 0) to exit the dialog, then return to
step 2.
4 When the correct tape has been inserted in the tape drive, select the Done
button by pressing Ctrl_A (or Keypad 0).
The Tape Details dialog closes and the arrow in the main window moves down
to the Save OPC data to tape button in the OPC Save and Restore tool main
window.
5 Select the Save OPC data to tape button by pressing Ctrl_A (or Keypad 0).
The Save confirmation dialog appears, prompting you to confirm your
request.
FW-21001A
FW-21001
[Yes Return ] [ No - ]
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-12 Other OPC procedures
6 Tab to the Yes button and select it by pressing Ctrl_A (or Keypad 0).
If the backup tape... then...
is blank step 8.
A progress dialog appears, indicating that the save operation has been
initiated.
If you want to... then go to...
—continued—
If the tape contains a software load, the following dialog prompts you to
confirm your request to overwrite the existing data on the tape.
FW 21004 FW-21004A
Note: It is recommended that you not overwrite the contents of a tape which have
the OPC and Network Element Software. Find a clean blank tape and put it in the
tape drive after ejecting the Software tape.
8 Tab to the OK button and select it by pressing Ctrl_A (or Keypad 0).
A progress dialog appears, indicating the progress of the save operation.
FW-21002A
FW-21002
[ Cancel Del ]
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-14 Other OPC procedures
9 Tab to the Cancel button and select it by pressing Ctrl_A (or Keypad 0).
A confirmation dialog appears, prompting you to confirm your request to
cancel the save operation.
FW-21005A
FW-21005
10 Tab to the OK button and select it by pressing Ctrl_A (or Keypad 0).
The confirmation dialog closes and another progress dialog appears. This
indicates that the save operation is being canceled and the tape is being
erased.
When the save operation is canceled, a dialog appears stating so.
11 Select the Done button by pressing Ctrl_A (or Keypad 0).
Go to step 14.
12 After the save operation is completed, a completion dialog appears.
FW-21007A
[ Done Return ]
Procedure 8-4
Restoring OPC data from tape
Use this procedure to retrieve data from a backup tape to the OPC disk. This
procedure overwrites all existing data on the OPC disk.
For example, if the network element configuration data on the tape is different
from that on the OPC disk, the old data will be transferred to the disk after the
tape data is restored to the disk.
CAUTION
Risk of damage to electrostatic-sensitive devices
Electrostatic-sensitive devices can be damaged by electrostatic
discharge. Always ground yourself before handling the tape.
When the restore operation begins, you cannot cancel the operation or use any
other OPC tool until the operation is completed. During the restore operation,
the local OPC is taken out of service and all current OPC operations are
interrupted. At the end of the restore operation, a reboot occurs.
CAUTION
Risk of network outage
If the restore operation fails, check that the appropriate network
element loads remain on the OPC using the OPC Reboot/Load
Manager tool. If the network element loads have been corrupted,
you must attempt to restore the loads as quickly as possible or
transfer the standby OPC to duty. If you leave the loads off the
duty OPC, and a network element requires a reboot, no load will
be available and you risk causing a network outage.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-16 Other OPC procedures
This procedure overwrites existing data on the local OPC. Overwriting the
existing data affects any OPC tools that use this data. For example, restoring
OPC data on the local OPC can cause inaccurate download statistics in the
Reboot/Load Manager tool.
When the OPC Save and Restore tool is first opened, the main window appears
in default save mode. This procedure shows you how to toggle from this main
window so that it appears in restore mode. The main window displays the
buttons for selecting restore OPC data. These restore buttons are displayed at
the bottom of the main window. You need to select these restore buttons in the
order they are shown.
Note: Be aware that inconsistencies between the OPC and NE database can
be introduced after performing the restore operation. There can be a
mismatch between the NE and the OPC since the data from the OPC
database is based on the last save operation.
Requirements
To perform this procedure, you must meet the following requirements:
• allow the tape to reach room temperature. Never insert a tape that has been
stored at temperatures outside the range 10°C to 30°C (50°F to 90°F) until
it has reached room temperature.
• insert the backup tape in the local OPC tape drive
• have a userID and password that permit access to the OPC
Note: Read the command conventions in Chapter 2 and Chapter 3 for the
interface (CMT or graphical) you are using.
—continued—
Action
Perform the following steps:
1 Log in to the OPC and open the OPC Save and Restore tool.
If you do not know how to do this, see Chapter 7.
The OPC Save and Restore main window appears in save mode. The Save
to tape button is selected and the buttons for saving OPC data to tape appear
in the bottom half of the window.
FW-20361A
FW-20361
2 Tab to the Save to tape button at the top of the main window. Do not select it.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-18 Other OPC procedures
3 Using the down arrow key, move to the Restore from tape button and select
it by pressing Ctrl_A (or Keypad 0).
The buttons for restoring OPC data from tape appear in the main window. An
arrow appears to the left of the first button.
FW-22303
—continued—
4 To confirm that the correct tape is inserted in the tape drive, select the
Display tape details button by pressing Ctrl_A (or Keypad 0).
After an In progress message appears, the Tape Details dialog appears,
displaying information about the tape. If you do not have a tape inserted, the
Tape type field shows “unknown.”
FW-22304
FW-22304
Tape Details
[ Done Return ]
5 Check the fields in the Tape Details dialog to confirm that you have inserted
the correct tape into the tape drive.
6 To remove the Tape Details dialog, select the Done button by pressing Ctrl_A
(or Keypad 0).
The Tape Details dialog closes. In the main window, the arrow moves down
to the Restore OPC data from tape button.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-20 Other OPC procedures
7 In the main window, select the Restore OPC data from tape button by
pressing Ctrl_A (or Keypad 0).
A confirmation dialog appears, prompting you to confirm your request.
FW-21008A
FW-21008
[ Yes Return ] [ No -]
8 Tab to the Yes button and select it by pressing Ctrl_A (or Keypad 0).
The confirmation dialog closes. Several In progress messages appear in
succession showing the progress of the tape extraction. During this period the
local OPC becomes inactive. A dialog appears, indicating that the OPC is out
of service.
FW-20707
FW-20707
[ Done Return]
—continued—
9 To remove the information dialog, select the Done button by pressing Ctrl_A
(or Keypad 0).
The out-of-service dialog closes. A dialog appears, indicating the progress of
the restore operation. The restore operation can take up to 40 minutes to
complete. When the OPC becomes active again, the following information
dialog appears for each user session.
FW-21009A
FW-21009
[ Done Return ]
10 To remove the information dialog, select the Done button by pressing Ctrl_A
(or Keypad 0).
The information dialog closes. A completion dialog appears, indicating that
the restore operation is complete.
FW-22306
FW-22306
[ Done Return ]
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-22 Other OPC procedures
11 To remove the completion dialog, select the Done button by pressing Ctrl_A
(or Keypad 0).
The completion dialog closes. An In progress message appears indicating
the OPC Shutdown tool is being opened. The OPC Shutdown tool appears.
FW-22307
FW-22307
[ Shutdown ] [ Exit ]
—continued—
13 Tab to the Proceed button and select it by pressing Ctrl_A (or Keypad 0).
An information dialog appears.
FW-22309
FW-22309
( ) Halt ( ) Restart
[ OK Return ]
14 Tab to the Restart button and select it by pressing Ctrl_A (or Keypad 0).
An Information dialog appears indicating the OPC System is shutting down.
15 Select the OK button by pressing Ctrl_A (or Keypad 0).
An In progress message appears followed by the Out of service dialog.
FW-20707
FW-20707
[ Done Return]
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-24 Other OPC procedures
Procedure 8-5
Transferring data between OPCs
Use this procedure any time to transfer OPC data from the disk of one OPC in
a span of control to any other OPC in the same span of control. You can transfer
data between backup, primary, and portable OPCs, as long as you are
transferring the data from an active OPC.
Note: It is recommended that you transfer OPC data to the backup OPC
after you have restored data from a backup tape. This procedure is included
as part of Procedure 8-4, “Restoring OPC data from tape.”
Action
Perform the following steps:
1 Open the OPC Save and Restore tool on the OPC that contains the network
data that you want to save.
The OPC Save and Restore main window appears in save mode. The Save
to tape button is selected and the buttons for saving OPC data to tape appear
in the bottom half of the window.
FW-20361A
FW-20361
3 Move to the Restore from tape button and select it by pressing Ctrl_A
(or Keypad 0).
The buttons for restoring OPC data from tape are displayed.
FW-20374A
FW-20374
4 Tab to the Transfer data to Backup OPC button and select it by pressing
Ctrl_A (or Keypad 0).
If you are transferring data from the backup or portable OPC to the primary
OPC, this button reads Transfer data to Primary OPC.
A confirmation dialog appears, prompting you to confirm your request.
FW-21123
3
[Yes Return ] [ No - ]
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-26 Other OPC procedures
5 Tab to the Yes button and select it by pressing Ctrl_A (or Keypad 0).
The confirmation dialog closes and a progress dialog appears, indicating that
the data on the OPC disk is being copied to the other OPC. (This operation
can take up to 30 minutes to complete.) When the transfer is complete, the
following completion dialog appears.
FW-21124
FW-21124
[ Done Return ]
Procedure 8-6
Detecting and/or removing existing OPC software
Use this procedure to detect if an OPC software load exists on an OPC. Do not
use this procedure as part of the process for upgrading the software in an
in-service OPC. This procedure applies to any new or spare OPC that is
currently not in use, including modular (shelf-mountable) primary and backup
OPCs, and the portable OPC (also referred to as the SLAT OPC).
If software exists, but it is not the desired load, then you can use this procedure
to remove the existing OPC software. Note that the OPC database, which
contains all of the commissioning data, is not preserved by this operation, so
this procedure should only be performed on a spare or stored OPC that requires
an “initial” software load.
Requirements
A VT100-compatible terminal must be connected to OPC port 1 (or port B).
You also need the root password and tape(s) containing the OPC and NE
software loads.
You need a tape or tapes containing the desired OPC software load and
network element software loads.
CAUTION
Enter UNIX commands carefully
If you enter a UNIX command incorrectly, it may be difficult to
recover from the error. Be sure to read this procedure carefully
to distinguish between similar symbols such as !, |, and /, or -
and =. Commands shown in lower case must be entered in lower
case. Contact your next level of support if required.
Action
Perform the following steps:
1 Log in to the OPC using the root userID.
The “Term=(VT100)” prompt appears.
2 Press Return (↵).
The “opc>” prompt appears.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-28 Other OPC procedures
CAUTION
Risk of equipment damage
If you force the tape into the tape drive, you may damage the
drive, and you may not be able to remove the tape. If you
cannot insert the tape easily, it may be oriented the wrong way
(see the figure on page 8-30).
10 Load the “remove OPC load” file, RMOPCLD, from the tape and execute the
removal by entering the following, since these are Unix commands they must
be entered exactly as written (in lower case):
cd /tmp ↵
dd if=/dev/rdt/tape2 bs=20b | tar xvf - ↵
cd install ↵
rmopcld ↵
A message informing you that you are about to wipe out the OPC load
appears and prompts you for a confirmation.
y↵
A message asking you to continue or abort the removal process appears.
c↵
The script removes the existing software load. The OPC reboots.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-30 Other OPC procedures
11 Remove the tape from the OPC tape drive, using the tape eject button shown
in Figure 8-1.
Figure 8-1
Tape eject button
FW-10864
FW-10864
Operations
controller
(OPC)
Tape eject
button
il
N Fa
il
E LA Fa
et
CN e
tiv
Ac
il
Fa
Slide
white tab
open to
protect
data
—end—
Procedure 8-7
Installing software in a local OPC
Use this procedure to perform the initial transfer of OPC software and NE
software from tape to the local operations controller (OPC), prior to
commissioning a system and its network elements (NEs).
Do not use this procedure as part of the process for upgrading the software in
an in-service OPC. This procedure applies to a new or spare OPC that is
currently not in use, including modular (shelf-mountable) primary and backup
OPCs, and the portable (SLAT) OPC.
Requirements
A VT100-compatible terminal must be connected to OPC port 1 (or port B).
You also need the root password and tape(s) containing the OPC and NE
software loads.
Action
Perform the following steps:
1 Log in to the OPC using the root userID.
The “Term=(VT100)” prompt appears.
2 Press Return (↵).
The “opc>” prompt appears.
3 Carefully insert the tape that contains the desired OPC software load, into the
OPC tape drive, as shown in the figure on page 8-30.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-32 Other OPC procedures
CAUTION
Enter UNIX commands carefully
If you enter a UNIX command incorrectly, it may be
difficult to recover from the error. Be sure to read this
procedure carefully to distinguish between similar
symbols. Commands shown in lower case must be
entered in lower case.
5 To install the OPC software, enter the following, since these are Unix
commands they must be entered exactly as written (in lower case)::
cd /tmp ↵
dd if=/dev/rdt/tape2 bs=20b | tar xvf - ↵
cd install ↵
localOPCinstall ↵
A dialog appears prompting you to select the type of software you are
installing.
6 Select Cornerstone software by entering:
access ↵
A dialog appears asking you to proceed with or abort the “upgrade”. Although
you are not performing an upgrade, a confirmation is required to continue with
the installation process.
7 To confirm, enter:
y↵
The OPC software is installed and then the OPC reboots. When the OPC
becomes operational, the login prompt appears.
—continued—
8 Log in to the OPC as in step 1 and use the NE Software Delivery Manager to
load the NE software from tape into the OPC.
Note 1: The destination OPC is the actual local OPC. Transfer all Proc, HMU,
TAC, and LC loads.
Note 2: After you install the software, you may receive a message stating that
the software has been successfully transferred but not installed. If this
message appears, it does not mean that the installation was unsuccessful.
Software will be installed automatically as soon as the OPC is commissioned.
Therefore, continue with the next step.
9 Now that both the OPC and NE software has been installed, remove the tape
from the OPC tape drive. Refer to the figure on page 8-30 for the location of
the tape eject button.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-34 Other OPC procedures
Procedure 8-8
Restoring an NE database
Use this procedure to replace an active database on the HDT with a new
database. The new database may be on tape or already on the OPC hard drive.
Requirements
The following are necessary for performing this procedure:
Action
Perform the tasks in this procedure in the following order:
Task Page
—continued—
3 Use the arrow keys to move down to option 7 (Backup/Restore Manager) and
press b.
This disables automatic database backup.
4 Press q to quit the drmstat tool.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-36 Other OPC procedures
2 Use the arrow keys to move down to option 7 (Backup/Restore Manager) and
press r.
This restarts automatic database backup.
3 Press q to quit the drmstat tool.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-38 Other OPC procedures
Procedure 8-9
Setting the time zone, date, or time
Use the following procedure to change the time zone, date, or time for an
operational OPC. The time zone codes are listed in the date tool, and the
appropriate code is selected using this procedure. See Table 8-1 on page 8-46
at the end of this procedure for a list of valid time zones.
The OPC keeps track of local and Greenwich mean time, and provides a
system time-of-day clock for the NEs it controls. NEs synchronize their clocks
with the OPC every two hours.
Note: The OPC date must not be set backwards or the OPC must be
reloaded.
The local time and date must be set during initial commissioning and whenever
the OPC’s clock battery has discharged. It should not be necessary to set the
clock again unless the OPC is moved to a new time zone or replaced. Changing
the time or date of an operational OPC involves shutting it down.
Battery drain occurs only when the OPC is powered down. It takes at least two
weeks to discharge the battery from a fully-charged state.
CAUTION
Changing the OPC time can disguise the real time order of
event logs and alarms
Many activities in the OPC, such as the generation of event
logs, are time-stamped by the system. When you change the
time, a gap or an overlap in time is introduced to time-stamped
activities. It may be confusing to surveillance personnel to find
that logs arriving in sequence have unusually-spaced time
stamps.
If you set the system time to a future value and then restore it to
actual time, a log generated while the system was in future time
will appear at the top of the list (in the Event Browser tool) and
remain there. Any subsequent log generated in actual time will
not displace the earlier log until actual time catches up.
Be sure that the time you specify is correct, since the time
stamps created for events are not automatically adjusted when
the system time is changed; and they cannot be changed
manually.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-40 Other OPC procedures
Requirements
You need to know the local time, date, and the time zone code for your time
zone.
Action
Perform the following steps:
1 Open the OPC Date tool.
The OPC Date tool is opened and the main window appears.
FW-21186
FW-21186
2 Proceed as follows:
If you want to change the time by… Then go to…
30 minutes or less step 3
more than 30 minutes step 7
—continued—
3 Select the Adjust Time button by pressing Ctrl_A (or Keypad 0).
The time and date change dialog appears.
FW-21189
FW-21189
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-42 Other OPC procedures
6 Tab to the Update button; select it by pressing Ctrl_A (or Keypad 0).
The data you entered is validated. If incorrect, an error dialog appears, which
tells you what to do. If correct, the time and date dialog closes, returning you
to the main window. The clock rate is slightly modified to begin a gradual
adjustment.
If you select the Cancel button, the changes you have made will be ignored.
If you selected Update, proceed to step 15.
7 Tab to the Reset Time button; select it by pressing Ctrl_A (or Keypad 0).
A confirmation dialog appears, indicating the amount of time required for the
shutdown and allowing you a final chance to abort the shutdown.
FW-21190
FW-21190
8 Tab to the Proceed button; select it by pressing Ctrl_A (or Keypad 0).
The confirmation dialog closes and the OPC shutdown process starts. A
console message appears.
Note: The selection of the Proceed button commits the shutdown of the
OPC, even if you decide later to abort the changes to the time and date. To
abort the OPC shutdown procedure, select the Cancel button.
FW-20706
FW-20706
[ OK Return ]
—continued—
In progress...
Shutdown in progress:
XXX..
A dialog stating that the OPC is out of service appears to all users who are
currently logged in to the OPC.
10 Select the Done button by pressing Ctrl_A (or Keypad 0).
The dialog is replaced by the Time and Date Change dialog.
FW-20708
FW-20708
Specify new time, date or time zone, then select the Update button.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-44 Other OPC procedures
14 Tab to the Update button; select it by pressing Ctrl_A (or Keypad 0).
A confirmation message appears. If you made a mistake, a message appears
to tell you that selecting the new time and date requires a second OPC
shutdown to correct.
FW-21188
FW-21188
Warning
Please ensure that the new date entered is
correct, as you will have to reboot the
OPC to correct any errors.
Note: If you select the Cancel button, the changes you have made will be
ignored and you are returned to the time and date change dialog. The OPC
will continue to shut down.
15 Tab to the OK button; select it by pressing Ctrl_A (or Keypad 0).
The data you entered is validated. If incorrect, an error dialog appears, which
tells you what to do. If correct, the time and date information is saved, and the
OPC begins its reboot sequence. You may see the Session Manager screen
briefly.
The reboot process takes about 5 to 10 minutes. When it completes, the OPC
login prompt (login:) appears.
The shutdown of the OPC terminates all user login sessions, and you will
have to log in again, after the OPC returns to service.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-46 Other OPC procedures
Table 8-1
Time zone codes and GMT offsets
Table 8-1
Time zone codes and GMT offsets (continued)
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
8-48 Other OPC procedures
Table 8-1
Time zone codes and GMT offsets (continued)
Note: Offsets marked with an asterisk denote the NE offset that should be used when the Daylight
Saving Time is observed in the corresponding region.
—end—
This chapter contains procedures for opening and closing command interpreter
(CI) tools, as well as a procedure on how to get help within a CI tool.
If you cannot successfully complete these procedures, contact your next level
of support.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
9-2 Using the CI tool user interface
Procedure 9-1
Opening a CI tool
Use this procedure to open a CI tool.
Figure 9-1
Commands required to navigate through different levels of software
FW-2529
CI software FW-10175
quit mapci
command command
quit fwpui
command command
Action
Perform the following steps:
1 Log in to the OPC.
2 Open the NE Login Manager tool.
The NE Login Manager screen appears.
3 Log in to the network element.
The Network Element User Interface (NEUI) screen appears.
4 At the prompt, enter the following:
quit all ↵
The CI prompt appears.
If you want to use... then...
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
9-4 Using the CI tool user interface
Procedure 9-2
Displaying the help screen for a CI tool
Use this procedure to display the help screen for a CI tool.
Action
Perform the following steps:
1 Open the CI tool.
If you want to display... then go to...
Procedure 9-3
Entering a CI command
Use this procedure to enter a CI command.
Action
Perform the following steps:
1 Type the name of the command, i.e. queryvp vp <vp id#>, and press the
Return key (↵).
The CI displays any parameter that you need to enter before it can perform
the command.
2 Once you have entered the necessary parameters, the CI displays the
system responses.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
9-6 Using the CI tool user interface
Procedure 9-4
Closing the CI tool
Use this procedure to close the CI tool. See Figure 9-1 on page 9-2 for an
illustration of the commands required to navigate through the different levels
of software.
Action
Perform the following steps:
1 You have a choice:
If you are closing... then go to...
X terminals are graphical terminals that have a local memory, a processor, and
software to support the X Windows System. X terminals handle the graphical
display functions locally, for applications running within the OPC. The OPC
also has X Windows software which allows the OPC to control X terminal
displays and run X clients.
The X Display Manager (XDM) on the OPC generates a login banner which
appears on the X terminal displays. The user provides login information
through this login banner and the XDM starts the session if the login
information is correct. The XDM also handles session termination.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-2 OPC Ethernet port configuration and connections
If you cannot successfully complete these procedures, contact your next level
of support.
10-2 Enabling and disabling the OPC Ethernet port page 10-20
10-6 Loading the NCD19 configuration data from the OPC to page 10-29
an NCD19 X terminal running NCDware v.2
10-7 Loading the NCD19 configuration data from the OPC to page 10-31
an NCD19 X terminal running NCDware v.3
Requirements
To perform the procedures in this chapter you must do the following:
• obtain the necessary tools for installation
• obtain the appropriate connection cable (see “Cabling options” on
page 10-9)
• obtain the root password that enables access to the OPC Ethernet port
• familiarize yourself with the OPC graphical user interface (Chapter 3)
X terminal support
The X terminals specifically supported by the OPC include the following:
• models NCD19 and NCD19R which are manufactured by Network
Computing Devices of Mountain View, California. In this document, the
term NCD19 is used for both the NCD19 and the NCD19R
• model 700/RX which is manufactured by Hewlett-Packard
• model XP18 which is manufactured by Tektronix.
For administrators who have the freedom to choose any of the three terminals,
the NCD19 is recommended.
The OPC automatically provides the OPC font path to these terminals as well
as keyboard mapping.
X terminal models other than those listed above might be able to connect to the
OPC. If the OPC login banner (shown following) appears after a reboot of an
X terminal connected to the appropriate OPC port, then the OPC automatically
provides the OPC font path to the X terminal. For this to happen, the X
terminal must be able to have its font path changed remotely from a host.
FW-21160
FIBER WORLD
This software contains material which is
confidential to Northern Telecom Limited
and is made available solely pursuant to
the terms of a written license agreement
with Northern Telecom Limited.
User ID:
Password:
Done Alt+Return
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-4 OPC Ethernet port configuration and connections
General recommendations
The following recommendations apply to all X terminals:
• To connect with the OPC, the X Server software must run with at least X
version 11 Release 4 (X11 R4).
• X terminals connected to the OPC either directly or through a hub on a
LAN should be configured with a twisted-pair communication port (the
IEEE 802.3 10BaseT interface). The physical port is an RJ45 connector.
• X terminals must be equipped with local X server communications
software as the OPC does not support downloading of X server
communications software. Typically, this is available from the vendor in
the form of an X server programmable read only memory (PROM) or an X
server flash ROM. If local communications software is not provided, there
must be a network server available to the X terminal(s) that can provide it.
When setting up the X terminal, it will be necessary to identify the server.
NCD equipment
The NCD19 model should be ordered as follows:
• NCD19R model
• 19-in monochrome (19RP15TWKP) or color (19CP17TWKP) monitor
• X server PROM
• 8 megabytes of random access memory (RAM)
• N-101 keyboard
Note: For NCD X terminals, you must set the font path to “/iws/x11/fonts”
rather than the default.
Hewlett-Packard equipment
The 700/RX model should be ordered as follows:
• 700/RX X terminal model
• 19-in monochrome monitor
• 8 megabytes of RAM (in addition to the 2 megabytes of basic RAM)
• X server and fonts on ROM card
• North American HIL keyboard
Tektronix equipment
The XP18 model should be ordered as follows:
• XP18 X terminal model
• 17-in. color monitor
• 8 megabytes of RAM
• 2 megabytes of flash ROM
• boot ROM and fonts
• PC keyboard
Contact the terminal vendor to identify the appropriate value based on the type
of router or the LAN configuration that you are using.
Obtain the IP addresses and node names from the communications planning
department in your organization or, in the case of the IP addresses that the
planning department does not have, directly from DARPA.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-6 OPC Ethernet port configuration and connections
• if your network uses node names, specify the node name (IP address alias)
for both the X terminal and the OPC.
NCD-specific requirements
When an NCD19 X terminal reboots, the XDMCP enable flag and the IP
address of the OPC are lost. To compensate for this, the OPC provides an
automatic process for reestablishing these parameters on the NCD X terminal.
The process requires that a configuration file be created on the OPC for each
NCD X terminal. Instructions for adding, changing, or deleting entries in the
configuration file are provided later in this chapter.
700/RX-specific requirements
In addition to the parameters listed previously, the 700/RX has these additional
parameters to define:
• enable XDMCP with Direct Access
• for the XDMCP host, specify the IP address of the OPC
XP18-specific requirements
In addition to the parameters listed previously, the XP18 requires the definition
of the following Host File Access configuration parameters:
• enable XDMCP with Direct Access
• for the XDMCP host, specify the IP address of the OPC
• under Host File Access, set the Primary XP File Root to “/usr/lib/X11/XP”
(quotes not included)
The flash ROM for XP18 X terminals is not always delivered with the X server
software flashed on it. In such a case, the X server communications software
must be downloaded from a network server to the flash ROM. It is only
necessary to do this once.
Once the parameters have been defined, they must be saved to NVRAM. To
activate them, the X terminal must be rebooted.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-8 OPC Ethernet port configuration and connections
LAN considerations
The following issues should be considered when the OPC is connected to a
LAN:
• When there is WAN access to the LAN, the OPC does not distinguish
between X terminals on the local LAN and other X terminals located
anywhere on the WAN. This might present a security issue that must be
addressed through LAN and WAN administration.
• The OPC assumes that any user session from an OPC is started directly
from an X terminal. Logins to the OPC through an X terminal session
running on an intermediate host are not recommended since problems with
the LAN segment between the OPC and the host, or the host and the X
terminal, might affect the OPC user session. Problems with this type of
setup are beyond the control of the OPC.
• LAN configuration (that is, routers, hubs, connectors) and proper use of
LAN resources is the responsibility of the customer.
• Consider the impact on LAN integrity and performance that will result
when X terminals are connected to an OPC over the LAN. Analysis of the
particular LAN is recommended since LAN configurations vary widely,
making general guidelines inappropriate. LAN engineers using a protocol
analyzer can perform the required analysis.
Note: X clients running from an OPC are the same as X clients running
from a UNIX workstation.
• Modem connections with X terminals over serial lines are not supported on
the OPC (including access through the serial line protocol XRemote).
• At any given time, only one user session from one OPC is supported on an
X terminal.
Cabling options
X terminals, LANs, and Nortel’s Network Manager connect to the OPC using
the Ethernet port on the faceplate of the OPC. Figure Figure 10-1 illustrates the
cabling options for connecting the OPC to network equipment. Details on the
connector pinouts and the cabling options follow the figure.
Figure 10-1
Cabling options for connecting the OPC to the network element
FW-20041
Option A
FW-20041
Dupont connector RJ45 connector
Crossover cable
X terminal
OPC
RJ45 connector
Dupont connector plugged into MAU
MAU
Straight-through cable
X terminal
OPC
Option C
OPC
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-10 OPC Ethernet port configuration and connections
Connector pin-outs
Figure 10-2 shows the pinouts for the Dupont and RJ45 connectors.
Figure 10-2
Dupont and RJ-45 connector pinouts
FW-21702
Dupont connector
FW-21702
1 8
1 3 5 RJ45 connector
pin assignment
2 4 6
Dupont connector
pin assignment RJ45 connector
Cabling option A
Option A applies when there is a point-to-point connection between the OPC
and an X terminal that supports the recommended twisted-pair communication
port (the IEEE 802.3 10BaseT interface). Nortel prefabricated cables have a
2x3 Dupont male connector on one end for connection to the OPC. The other
end has an RJ45 connector for connection to the X terminal. Each cable has
two shielded twisted pairs with transmit and receive crossed over. The cables
conform to FCC Class A requirements. The available cables are as follows:
Pin assignments for the crossover cables are shown in the following table:
1 Tx+ 3 Rx+
2 Tx- 6 Rx-
5 Rx- 2 Tx-
6 Rx+ 1 Tx+
Cabling option B
Option B applies when there is a point-to-point connection between the OPC
and an X terminal and the X terminal has a 15-pin D-type connector that
conforms to the IEEE 802.3 pin configuration. Nortel prefabricated cables for
this application have a 2x3 Dupont male connector on one end for connection
to the OPC. The other end has an RJ45 connector for connection to the X
terminal. Each cable has two shielded twisted pairs with transmit and receive
wired straight through. The cables conform to FCC Class A requirements. The
available cables are as follows:
Length PEC
For Option B, a media access unit (MAU) is required to interface between the
RJ45 IEEE 802.3 connector of the straight through cable and the 15-pin D-type
IEEE 802.3 connector on the X terminal. The Hewlett-Packard HP28685B
Ethertwist Transceiver is a suitable MAU.
Pin assignments for the straight-through cables are shown in the following
table:
1 Tx+ 1 Tx+
2 Tx- 2 Tx-
5 Rx- 6 Rx-
6 Rx+ 3 Rx+
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-12 OPC Ethernet port configuration and connections
Cabling option C
Option C applies when the OPC is connected to a LAN. In this case, the
straight-through cables NT4K86LA, LB, LC are used to connect the OPC to
the LAN hub.
Note: For more information on the Network Manager, see the Nortel
Network Manager User Guide, 323-4001-050.
Session-terminating conditions
The OPC sends an audit message to the X terminal every minute and
terminates an active session if the X terminal does not respond within one
minute. Any condition that prevents the X terminal from responding to the
audit causes the session to terminate.
If the OPC is rebooting when one of these terminals initiates call setup, it is
possible that the time period will be exceeded before the OPC responds. In this
case, the OPC login banner never reappears. To get the OPC login banner to
reappear in such situations, reboot the X terminal after the OPC has returned
to service (allow five to ten minutes for the OPC to reboot).
To get the OPC login banner to reappear in such situations, reboot the X
terminals after the OPC has returned to service (allow five to ten minutes for
the OPC to reboot).
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-14 OPC Ethernet port configuration and connections
Wait until the OPC has returned to service (allow approximately five minutes
for the OPC to reboot), then select the OK button on this window. The OPC
login banner from the OPC appears.
Response time, execution, and tools startup decrease significantly with four
simultaneous X mode user sessions on the same OPC. This is due to full CPU
usage and shortage in available system swap space.
Table 10-1 shows how many tools can be started by the user before the OPC
runs out of swap space, depending on the number of X mode user sessions.
Table 10-1
User session vs. tool capacity
4 4 to 8
3 10 to 14
2 16 to 20
Note 1: The numbers shown do not include tools that are started automatically.
Note 2: The number of tools that can be started depends on the tools started as well as the
number of X mode user sessions.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-16 OPC Ethernet port configuration and connections
Procedure 10-1
Initializing the OPC Ethernet port
For the OPC to recognize and support communications with a Network
Manager or an X terminal using the Ethernet port on the OPC faceplate, the
OPC Ethernet port must be initialized. Use this procedure to initialize the OPC
Ethernet port so that it can communicate with a Network Manager or an X
terminal.
Requirements
Ensure that the OPC module is properly installed and has booted up.
Obtain the node name, Internet Protocol (IP) address, and IP netmask for the
OPC whose Ethernet port is being initialized.
Action
Perform the following steps:
1 Log in to the OPC using the root userID and password.
The UNIX shell prompt “opc>” appears.
2 Start the Ethernet administration script by typing:
/iws/lan/ether_admin ↵
The Ethernet port command list appears:
1. Initialize and enable the Ethernet port
2. Ethernet port control (enable/disable)
3. X terminals configuration
4. Help
5. Quit
Select one of the above commands [1-5]:
Note: The Ethernet port must be initialized before it can be enabled or
disabled.
3 Select the Ethernet port initialization command by typing:
1↵
A message describing the port initialization requirements appears, followed
by a node name prompt:
Enter the nodename:
4 Type the nodename assigned to the OPC.
The node name consists of up to eight alphanumeric characters. An example
node name is “OPCM001P.”
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-18 OPC Ethernet port configuration and connections
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-20 OPC Ethernet port configuration and connections
Procedure 10-2
Enabling and disabling the OPC Ethernet port
Use this procedure to enable or disable the OPC Ethernet port. The OPC can
communicate with the Network Manager or X terminal only when the Ethernet
port is enabled.
Requirements
Ensure that the OPC Ethernet port is initialized (Procedure 10-1). If you
attempt to control the Ethernet port before initializing it, a message that
indicates the port must be initialized before it can be controlled appears.
Action
Perform the following steps:
1 Log in to the OPC using the root userID and password.
The UNIX shell prompt “opc>” appears:
2 Start the Ethernet administration script by typing:
/iws/lan/ether_admin ↵
The Ethernet port command list appears.
1. Initialize and enable the Ethernet port
2. Ethernet port control (enable/disable)
3. X terminals configuration
4. Help
5. Quit
Select one of the above commands [1-5]:
3 Select the Ethernet port control command by typing:
2↵
A message that identifies the Ethernet port control values displays, followed
by a prompt for the new Ethernet port status:
You will be prompted for the following information:
new Ethernet port status: enabled or disabled
Type 'abort' at the prompt to terminate the command.
Enter new Ethernet port status [e - enable, d - disable]
—continued—
4 You must disable the Ethernet port to allow the OPC to communicate with the
Network Manager or X terminal. When the Ethernet port is disabled, the OPC
is disconnected from the network.
If you want to... then go to...
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-22 OPC Ethernet port configuration and connections
Procedure 10-3
Connecting the OPC to network equipment
Use this procedure to connect the OPC to an X terminal, a LAN, or Nortel’s
Network Manager. In this procedure, the term “network equipment” is used to
refer to an X terminal, a LAN, or the Network Manager.
Action
Perform the following steps:
1 Connect the cable to the OPC.
Note: The connector is located on the faceplate of the OPC, under the tape
drive cover.
2 Route the cable to the top of the shelf and secure it using the screws provided
with the cable.
3 Route the cable along the frame’s upright and secure it in place.
4 Run the cable either underneath the floor or on top of the cable troughs to the
location of the X terminal or to the Ethernet LAN’s hub connector.
5 Consult the documentation for the network equipment to identify the location
of the equipment’s Ethernet port.
If the network equipment then go to...
6 Connect the RJ45 connector of the cable to the appropriate port on the
network equipment.
Go to step 9.
7 Connect the RJ45 connector of the cable to the MAU.
8 Plug the MAU in to the appropriate port on the network equipment.
9 Ensure that all connectors are fully and firmly seated.
Note: Pin assignments for the cables are shown in the section “Cabling
options” on page 10-9.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-24 OPC Ethernet port configuration and connections
Procedure 10-4
Establishing a telnet session between an X terminal
and the OPC
Use this procedure to establish a telnet session with the OPC.
Requirements
Ensure that the Ethernet port is enabled and initialized.
Action
Perform the following steps:
1 From the X terminal documentation, determine how to start a telnet session.
When instructed to do so, enter the IP address of the OPC.
The OPC “login:” prompt appears.
2 Log in to the OPC as the root user.
The “TERM = (VT100)” prompt appears.
3 Press Return (↵).
The UNIX shell prompt “opc>” appears.
4 The X terminal is now connected to the OPC and is emulating a VT100
terminal in a UNIX session.
If you want to... then
—end—
Procedure 10-5
Adding, changing, or deleting an NCD19
configuration file
Because the NCD19 X terminal does not retain certain XDMCP parameters
following a reboot, an NCD19 configuration file on the OPC must be created
to store these parameters.
Requirements
Obtain the software version and IP address of the NCD19 X terminal.
Obtain the NCD19 booting source, either its PROM or the IP address of the
bootserver.
Action
Perform the following steps:
1 Log in to the OPC using the root userID and password on a character-mode
terminal (CMT) or through a telnet session from an X terminal.
The UNIX shell prompt “opc>” appears.
2 At the “opc>” prompt, start the Ethernet administration (ether_admin)
program by typing:
/iws/lan/ether_admin ↵
The Ethernet port command list appears.
1. Initialize and enable the Ethernet port
2. Ethernet port control (enable/disable)
3. X terminals configuration
4. Help
5. Quit
Select one of the above commands [1-5]:
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-26 OPC Ethernet port configuration and connections
4 To add or change a configuration file (the process is the same for both), type:
a↵
A message describing the requirements for adding an X terminal
configuration file appears. You are then prompted for the NCD19 software
version number.
If the software version number is... then enter...
v.2 2.
v.3 3.
8 Continue as required:
If you are... then go to...
changing an existing file step 9.
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-28 OPC Ethernet port configuration and connections
—end—
Procedure 10-6
Loading the NCD19 configuration data from the OPC
to an NCD19 X terminal running NCDware v.2
Use this procedure to load the NCD19 configuration parameters that were
created using the ether_admin program. This procedure applies to any version
v.2 of NCDware.
The HP 700/RX X terminal and the Tektronix XP18 X terminal are not covered
because these terminals are self-booting and do not need configuration data
from the OPC. Procedures are not required for these.
After you successfully complete this procedure, a graphical OPC login dialog
appears on the NCD19. Thereafter, the OPC login dialog appears each time
you power on or reset the NCD19.
Requirements
Review the NCD19 User's Manual, to become familiar with the configuration
screens and capabilities.
Action
Perform the following steps:
1 Set up the X terminal according to the requirements provided earlier in this
chapter, in “X terminal setup requirements” on page 10-5.
2 From the Main Menu, select Network Parameters in the Configuration Menus
group.
The Network Parameters window appears.
3 Set the Remote Configuration parameter field to Yes.
To change a parameter, click Select on the parameter's value field. The next
value appears in the field. Continue clicking on the field until the desired value
appears.
4 Move the pointer to the Configuration Server field and type the IP Address of
the OPC.
5 Return to the Main window by selecting the Main Menu button in the Network
Parameters window.
6 Select the Save Power-On Values button in the Main Menu window.
—continued—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-30 OPC Ethernet port configuration and connections
FIBER WORLD
This software contains material which is
confidential to Northern Telecom Limited
and is made available solely pursuant to
the terms of a written license agreement
with Northern Telecom Limited.
Copyright. Northern Telecom Limited, 1991
User ID:
Password:
Done Alt+Return
Procedure 10-7
Loading the NCD19 configuration data from the OPC
to an NCD19 X terminal running NCDware v.3
Use this procedure to load the NCD19 configuration parameters that were
created using the ether_admin program. This procedure applies to any version
v.3 of NCDware.
The HP 700/RX X terminal and the Tektronix XP18 X terminal are not covered
because these terminals are self-booting and do not need configuration data
from the OPC. Procedures are not required for these.
After you successfully complete this procedure, a graphical OPC login dialog
appears on the NCD19. Thereafter, the OPC login dialog appears each time
you power on or reset the NCD19.
Requirements
Review the NCD19 User's Manual, to become familiar with the configuration
screens and capabilities.
Action
Perform the following steps:
1 Set up the X terminal according to the requirements provided earlier in this
chapter, in the section “X terminal setup requirements” on page 10-5.
2 From the NCD User Services: Console window, pull down the Console menu
and select Reboot.
The Reboot dialog appears.
3 Select the OK button.
The NCD19 executes its reboot procedure. After some progress messages,
a grey pattern appears on the screen.
4 After a few seconds, an OPC login dialog appears (as shown on page 10-30).
5 The NCD19 is now fully configured and ready to use.
—end—
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
10-32 OPC Ethernet port configuration and connections
Procedure 10-8
Reconfiguring X terminals following an OPC upgrade
To display the OPC login banner on an X terminal following an OPC software
upgrade, reboot the terminal. The OPC login banner will appear enabling you
to log in to the OPC.
—end—
Index 11-
700/RX specific requirements 10-6 B
Bit inversion
A E1 port query 4-152
Access timeslot setting 4-153
NEUI 5-4 Blocking log 4-112
local 5-4 Busy hour 4-109, 4-110, 4-111
remote 5-4
OPCUI 5-5
local 5-5
C
remote 5-5 Cable connectors and pinouts 7-5
user interfaces 5-4 Cabling options 10-9
actIF 4-116 A 10-10
addCP 4-43 B 10-11
addDMC 4-11 C 10-12
addIF 4-117 Call
addLine 4-71 monitoring 4-105
addLink 4-118 statistics totals, display 4-108
Addresses, IP 10-5 Call reference values
Administration modify for one or more lines 4-143
IP routing 5-17 reassign lines 4-144
menus 1-27 Carrier path
OPC 5-14 add new to network 4-43
provisioning 5-29 change route diversity settings 4-65
Alarms channel service state, change 4-100
commands details 4-6 downstream, assign modem 4-47
history buffer, display 4-9 frequency channel range, assign 4-46
menus 1-21 frequency range, reduce or deallocate 4-53
Modem Shelf monitor upstream 4-51
details 4-6 noise threshold, show setting 4-58, 4-59, 4-66,
specific details, display 4-8 4-67
Voice Ports PCM channels 4-78
details 4-6 remove 4-55
allocMarshSpectCP 4-45 rename 4-50
allocSpectCP 4-46 table, frequency channel bands 4-57
alrmdisp 4-7 upstream
alrmrpt 4-8 assign modem 4-47
APU database query 4-87 Voice Port assigned 4-90
asgnModemCP 4-47 CATV
asgnVpHEM 4-73 modem, display 4-97
Autoband 6-4 service, disable 4-74
chanMap 4-99
Channel specified status 4-102
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
11-2 Index
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
11-4 Index
Firmware Line
downloading 4-33 assignments, display current 4-145
modem shelf equipment 4-33 deprovisioning
Voice Ports 4-33 service provisioning 4-71
freqMap 4-101 service, deleting 4-80
Frequency channel range, assign 4-46 Line-by-line terminal 6-9
Frequency range, reduce or deallocate 4-53 Line card 6-20
FWPUI. See FiberWorld product user interface. configuring 6-23
instance, display 4-97
provisioning 6-20
G timings
Gateway, IP routing 5-17 current settings,display 4-133
set default values 4-139, 4-140
H timings, changing 4-122
working with 6-20
HDT. See Host Digital Terminal.
Headend Link
CATV enabled 4-73 OMC
modem deleting 4-157
deassign 4-54 Link ID value, changing 4-123
Voice Ports 4-82, 4-83 linkStatus 4-160
set distance to VP 4-60 listdefaults 4-35
Help menus 1-29 Lists, using 2-18
Help, getting 2-22 Local Craft Access Panel (LCAP) 6-3
Hewlett-Packard equipment 10-5 Log monitoring 4-112
history 4-9 Logging
Host Digital Terminal (HDT) Cornerstone toolset, into 7-28
enable extended range 4-56 in and out of NEUI 6-7
software, reload or upgrade 4-34 into OPC 7-19
V5.2 switch interface, activate 4-116 into OPC from NE 7-26
wideband channels, enabling/disabling 4-96 into remote OPC from local OPC 7-23
Host Provisioning Manager tool 5-22 OPC, out of 7-34
HP host systems 2-1 out of the NEUI 6-9
Loop current specified line, setting 4-94
I M
IG. See Interface group.
Initializing OPC Ethernet port 10-16 Main menu, displaying 6-9
Installing software in a local OPC 8-31 Mapci menus 1-21
Interface group Mapping
display for current HDT 4-146 channels to frequencies 4-99
modify for one or more lines 4-143 frequencies to channels 4-101
reassign all lines 4-147 Marshalling
reassign lines 4-144 frequency channel
Interface type, display for current HDT 4-146 deallocate 4-52
Interface, OPC mode, change 4-49
character-mode user interface 2-1 OOB mode 4-52
graphical user interface (OPCUI) 3-1 Menus
IP addresses and node names 10-5 administration 1-27
alarms 1-21
displaying 2-14
L equipment 1-24
LAN considerations 10-8 facility 1-23
LC template, setting the 4-93 Help 1-29
LCAP. See Local Craft Access Panel. Mapci 1-21
LCM services provisioning data display 4-86 mode 2-15
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
11-6 Index
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
11-8 Index
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
11-10 Index
User Interfaces Reference Guide Release 8.1 Standard 1.0 September 2001
11-12 Index
configuration
data, loading from the OPC 10-29,
10-31
file, creating 10-25
considerations 10-12
reconfiguring after OPC upgrade 10-32
replacing or exchaning 10-8
session, terminating 10-12
setup 10-7
requirements 10-5
support 10-3
Telnet session with OPC, establishing 10-24
troubleshooting 10-13
XP18 specific requirements 10-7
Z
zero (command) 4-164