Chapter 4. Support Commands. TimePlex LINK/2+, LINK/2+ miniLINK/2+, LINK/2+ microLINK/2+
광고
광고
Chapter
4
Support Commands
Supervisory port support commands allow you to:
●
Load or copy operational software
●
Backup and restore configuration database
●
Toggle operational software between banks of memory
●
Enable or disable password protection on the supervisory port
●
Set or clear supervisory port pagination
●
Set the time and date
●
Display or inhibit the display of unsolicited messages
●
Display a list of supervisory port commands
●
Set up command files
The supervisory port also recognizes several supervisory terminal control key editing functions, which are used to support all phases of supervisory port operations.
Table 4-1 lists support commands and control key editing functions in alphabetical order by command mnemonic and key name.
SUPPORT COMMANDS
Supervisory port support commands are described in the following paragraphs. Commands are in alphabetical order by command mnemonic. Related commands are discussed together.
Commands used for command file applications are described in the "Command File Commands" and "Using Command Files" paragraphs.
Clear (Unmask) Unsolicited Messages (CLR MUM) Command
See "Mask and Unmask Unsolicited Messages (SET MUM, CLR MUM) Commands" paragraph.
L2UG
6/30/94
4-1
Table 4-1. Support Commands
G
G
G
G
G
N
#
#
Command
B key
Description: Scrolls backward through a menu.
BACKSPACE key
Description: Backspaces to correct typing errors on same line.
BREAK key
Description: Cancels command, causes prompt to be displayed, exits repetitive command file command, and halts connect/disconnect messages.
CLR MUM LOC
Description: Clears the supervisory port of masking unsolicited messages from local node.
CLR MUM REM
Description: Allows the local node to transmit unsolicited alarms to the nodes on alarm notification list of local node.
CLR PG
#
Description: Clears pagination on supervisory terminal.
#
CLR PW
Description: Clears supervisory port of old passwords for password 1 (PW1) and password 2 (PW2), and disables password protection.
CLR TMO
Description: Disables 30-minute timer and allows user unlimited time on the supervisory terminal (used only if password protection is enabled).
CLR @ file
Description: Clears preset execution time of command file, where file is a number between 1 and 8.
CLS
Description: Clears screen and moves cursor to upper left-hand corner of screen.
CONTROL A keys
Description: When entered at the prompt, displays last command entered but does not execute the command. Entering
Control A when the cursor is within a command line moves the cursor to the end of the command. Entering Control A at the end of a command line will repeat any characters from the previous command that are to the right of the cursor.
CONTROL B keys
Description: When repeatedly entered at the prompt, scrolls backward through the last 20 commands executed. Any command can be executed by pressing RETURN key.
CONTROL C keys
Description: Same as BREAK key.
CONTROL D keys
Description: Displays and executes last command entered.
4-2
L2UG
6/30/97
G N
G
G
G
#
#
#
Table 4-1. Support Commands (Cont’d)
Command
CONTROL F keys
Description: Same as Control A, plus when repeatedly entered at the prompt, scrolls forward through the last 20 commands executed. Any command can be executed by pressing RETURN key.
CONTROL H keys
Description: Same as BACKSPACE key.
CONTROL Q keys
Description: Enables output of data to terminal (X-ON).
CONTROL R keys
Description: Lists the last 20 commands executed.
CONTROL S keys
Description: Disables output of data to terminal (X-OFF).
CONTROL Z keys
Description: Ends insert mode of command file editor when used in the first position of a line.
COP SW n:ss n:ss
COP SW 1:ss
Description: In the first command format, copies operational software from the online Network Module, Integrated Trunk
Module, or X.50 Server Module to the offline Network Module, Integrated Trunk Module, or X.50 Server Module. In the second command format, copies operational software from the online memory bank to the offline memory bank of the online
Network Module.
DEF PW1
Description: Defines new password for password level 1 and enables password protection after both PW1 and PW2 are defined.
DEF PW2
Description: Defines new password for password level 2 and enables password protection.
DEF @ file
Description: Opens a command file for creating, editing, or deleting with the command file editor, where file is a number between 1 and 8.
DEL key
Description: Backspaces to correct typing errors on same line.
DSP @
{
* or d[-d]...
[
,d[-d]
]}
Description: Displays contents of command file(s).
ESC key
Description: Ends insert mode of command file editor when used in the first position of a line.
EX
Description: Exits or logs out user from LINK/2+ System, preventing unauthorized user access via the supervisory terminal.
L2UG
6/30/97
4-3
G N
G
G
G
G
G
G
G
G
#
#
#
#
#
#
Table 4-1. Support Commands (Cont’d)
Command
F key
Description: Scrolls forward through a menu.
HELP
Description: Lists available LINK/2+ System supervisory port commands.
HOME
Description: Moves cursor to upper left-hand corner of screen without clearing screen.
LOA DB[/F]
Description: Downloads previously stored configuration parameters (database) to the online Network Module from a microcomputer connected to the supervisory port. Optional /F modifier causes database to be downloaded at speed of
57.6 kbps.
LOA SW n:ss[/F]
Description: Loads operational software from a microcomputer to a Network Module, Integrated Trunk Module, or X.50
Server Module. Optional /F modifier causes operational software to be downloaded at speed of 57.6 kbps.
RETURN key
Description: Enters command or moves to next line of parameters.
SAV DB[/F]
Description: Uploads the Network Module database (configuration parameters) from the Network Module to a microcomputer connected to the supervisory port. Optional /F modifier causes database to be uploaded at speed of 57.6 kbps.
SET DAT mm-dd-yyyy
Description: Sets month-day-year of real-time clock.
SET MUM LOC
Description: Causes the supervisory port to mask unsolicited messages from the local node.
SET MUM REM
Description: Causes the local node to not transmit unsolicited alarms to the nodes on alarm notification list of local node.
SET PG
Description: Sets pagination on supervisory terminal.
SET TIM tt:tt:tt [/OFF=±hh:mm]
Description: Sets time of day in hours:minutes:seconds and initializes real-time clock. Optional /OFF modifier permits introducing a plus or minus offset in hours:minutes for network management alarm time-stamping purposes.
SET TMO
Description: Enables 30-minute timer to log out user if no keystroke is made for 30 minutes (used only if password protection is enabled).
SPACE bar
Description: Advances cursor from one parameter to the next on a line of a menu. When pagination is set, advances to the next screen.
4-4
L2UG
6/30/97
G N
G #
#
#
Table 4-1. Support Commands (Cont’d)
Command
STP
Description: Stops currently executing command file from continuing. No commands following STP command will execute.
TGL BNK n:ss
"
Description: Switches execution of operational software between two independent banks of flash EPROM that are part of a
Network Module.
Description: Sends text message, up to 48 characters, to supervisory port of specified remote node.
?
Description: Displays keyword information for available LINK/2+ System supervisory port commands.
@ file [/tt:tt:tt]
@ file [/tt:tt:tt mm-dd-yyyy]
@ file [/mm-dd-yyyy tt:tt:tt]
@ file [/mm-dd-yyyy]
Description: Executes command file specified, where file is a number from 1-8. If a time and/or date is entered as part of the command, the command file is executed at the time specified.
FOR COMMAND FILES ONLY
BACKSPACE key
Description: Repositions cursor for editing command lines after using E command.
CONTROL C
Description: Exits the command file editor without saving the current changes.
CONTROL Z
Description: Ends insert mode of command file editor when used in the first position of a line.
D
{i
or i-j
}
Description: Deletes line i or lines i through j of a command file after the file has been opened with the DEF @ command, where i and j are line numbers.
E
{ i
}
Description: Places cursor at end of line i of a command file for editing after the file has been opened with the DEF @ command, where i is a line number. The backspace key is used to reposition the cursor.
ESC key
Description: Ends insert mode of command file editor when used in the first position of a line.
I [i]
Description: Allows the insertion of new lines into a command file after the file has been opened with the DEF @ command, where i is 0 or a line number. If no line number or 0 is used, new lines are inserted before the first line. If a line number is used, new lines are inserted after the specified line.
L2UG
6/30/97
4-5
Table 4-1. Support Commands (Cont’d)
G N Command
RETURN key
Description: Moves cursor to next line of command file when used at the end of a line. Ends insert mode of editor when used in the first position of a line.
X
Description: Saves the current command file, as edited, and exits the command file editor.
*tt:tt:tt
Description: Enters a time delay into a command file. The LINK/2+ System waits the specified length of time before executing the next command in the command file.
&x
1
… x
254
Description: Enters terminal screen control characters and text into a command file.
G entry in “G” column indicates a nonglobal gateway command.
# entry in “N” column indicates that a command can be issued to a remote node by preceding the command with NOD xxxx.
d = command file number (1 to 8) mm-dd-yyyy = month-day-year n = nest number: 1 = Control Mainframe; 2 = Expander A Mainframe (upper); 3 = Expander B Mainframe (lower) ss = slot number tt:tt:tt = hour:minute:second (24-hour clock) x
1
… x
254
= up to 254 characters
[ ] = optional parameter. Brackets are never entered as part of command.
{ } = required parameter. Choose one of the elements within braces. Braces are never entered as part of command.
…
= used before [ ] symbol to indicate command can be entered with several parameter values. Dots are never entered as part of command.
Clear Supervisory Port Pagination (CLR PG) Command
See "Set and Clear Supervisory Port Pagination (SET PG, CLR PG) Commands" paragraph.
Clear Password (CLR PW) Command
See "Define and Clear Password (DEF PW1, DEF PW2, CLR PW) Commands" paragraph.
Clear Time Out (CLR TMO) Command
See "Set and Clear Time Out (SET TMO, CLR TMO) Commands" paragraph.
4-6
L2UG
6/30/97
Clear Screen and Home Cursor (CLS) Command
The CLS command is used to clear the screen and move the cursor to the upper left-hand corner of the screen.
Copy Software (COP SW) Command
The COP SW command is used to copy operational software from the online Network Module,
Integrated Trunk Module, or X.50 Server Module to the offline Network Module, Integrated
Trunk Module, or X.50 Server Module respectively; or to copy the operational software from the online memory bank to the offline memory bank of the online Network Module. This command can only be issued locally.
The COP SW command is also used to copy operational software from one VSM.3 Voice Server
Module to another VSM.3 Voice Server Module, and from one VSM.5 Voice Server Module to another VSM.5 Voice Server Module.
Commands:
[NODxxxx] COP SW n:ss n:ss where: first n:ss = nest and slot number of online Network Module, Integrated Trunk Module,or
X.50 Server Module that operational software is to be copied from second n:ss = nest and slot number of offline Network Module, Integrated Trunk Module, or
X.50 Server Module that operational software is to be copied to
NOTE:
For the Integrated Trunk Module and X.50 Server Module, the source module must be defined and online. The destination module must be logically removed prior to issuing the COP SW command and then logically inserted after the copy process completes.
For the VSM.3 and VSM.5 Voice Server Modules, both the source and destination modules must be logically removed prior to issuing the COP SW command and then logically inserted after the copy process completes.
[NODxxxx] COP SW 1:ss where:
1:ss = slot number of online Network Module. This command copies the operational software from the online memory bank to the offline memory bank.
L2UG
6/30/97
4-7
Define and Clear Password (DEF PW1, DEF PW2, CLR PW) Commands
The DEF PW1 and DEF PW2 commands enable password protection. The CLR PW command disables password protection.
Commands:
[NOD xxxx] DEF PW1
[NOD xxxx] DEF PW2
[NOD xxxx] CLR PW
The DEF PW1 and DEF PW2 commands enable password protection and allow the user to define new passwords for password level 1 and password level 2. If the supervisory port is designated as a gateway, password level 2 offers gateway mode, while password level 1 offers nongateway mode.
NOTE:
PW2 can be defined without defining PW1. However, if PW1 is defined, PW2 must also be defined.
After entering each command, the LINK/2+ System prompts:
ENTER OLD/DEFAULT PASSWORD:
Enter the old password. If the password was not previously defined, enter the default password
TIMEPLEX. The LINK/2+ System prompts:
ENTER NEW PASSWORD:
Enter the new password of 4 to 8 ASCII characters. An entry that is invalid causes an invalid message response. After a valid password is entered, the LINK/2+ System prompts for verification of the password:
ENTER AGAIN:
Enter the new password again. If the verification is incorrect, the LINK/2+ System prompts for the new password again.
If password protection is enabled, the DSP ST SY command display includes one of the following messages:
SP USER STATUS = GATEWAY
SP USER STATUS = NONGATEWAY
SP USER STATUS = NOT LOGGED IN
NOTE:
The SP USER STATUS message will not be displayed after passwords are defined, until the user logs off and logs on again.
The CLR PW command disables password protection and clears the supervisory port of old passwords for password 1 (PW1) and password 2 (PW2). After entering the CLR PW command, the LINK/2+ System prompts:
ENTER PASSWORD:
4-8
L2UG
6/30/97
Enter the password for PW2. If the entry is correct, passwords 1 and 2 will be disabled. If password protection is desired, the user must define PW1 and PW2 after clearing passwords.
While defining or clearing passwords, if the user enters the old/default password incorrectly three times, the user will be logged out.
NOTE:
If the user’s password does not work or if the user has forgotten the password, password protection can also be disabled with a DIP switch on the Network Module. See the Network Module chapter in the LINK/2+ Installation and Maintenance Manual.
Log Out (EX) Command
The EX command logs the user out of the LINK/2+ System, preventing unauthorized user access via the supervisory terminal.
Command:
EX
Help (HELP) Command
The HELP command scrolls through the list of available LINK/2+ System supervisory port commands. To view the list of commands, enter the SET PG command, then enter the HELP command. To view more commands, press the SPACE bar.
Command:
[NOD xxxx] HELP
Home Cursor (HOME) Command
The HOME command is used to move the cursor to the upper left-hand corner of the screen
without clearing the screen.
Load Database (LOA DB) Command
The LOA DB command downloads (restores) previously stored configuration parameters
(database) to the online Network Module from a microcomputer connected to the supervisory port. This command can only be issued to a local node (either by directly connecting the microcomputer or by connecting it remotely via modems) and should only be used for database
recovery.
The microcomputer requires a communications program that supports the XMODEM file transfer protocol using 128 byte data packets and CRC error checking. If needed, see the LINK/2+
Installation and Maintenance Manual appendixes for the database recovery procedure.
L2UG
6/30/97
4-9
Command:
LOA DB[/F] where:
/F = causes the database to be downloaded at speed of 57.6 kbps.
PRECAUTION: This command will cause the node to reset when the transfer is complete.
After the database has been downloaded, the online Network Module will automatically reset. If a redundant Network Module pair exists, the node will not toggle redundancy.
Load Software (LOA SW) Command
The LOA SW command downloads operational software from a microcomputer to a Network
Module, Integrated Trunk Module, X.50 Server Module, or VSM.3 or VSM.5 Voice Server
Module. This command can only be issued to a local node (either by directly connecting the microcomputer or by connecting it remotely via modems).
The microcomputer requires a communications program that supports the XMODEM file transfer protocol using 128 byte data packets and CRC error checking. If a new software release needs to be loaded, see the loading operational software procedures in the Getting Started chapter of this
User’s Guide.
When loading Network Module operational software , this command must always be directed to an online Network Module. When loading operational software to an Integrated Trunk Module,
X.50 Server Module, or VSM.3 or VSM.5 Voice Server Module, the module must be logically removed prior to issuing the LOA SW command and then logically inserted after the software has been loaded.
Command:
LOA SW n:ss[/F] where:
/F = causes operational software to be downloaded at speed of 57.6 kbps.
Save Database (SAV DB) Command
The SAV DB command uploads (saves) the Network Module database (configuration parameters) from the Network Module to a microcomputer. This command can only be issued locally.
The microcomputer requires a communications program that supports the XMODEM file transfer protocol using 128 byte data packets and CRC error checking. See the database backup procedure in the Getting Started chapter of this User’s Guide.
4-10
L2UG
6/30/97
NOTE:
The SAV DB command does not include the supervisory port parameters in the backed up database. Prior to issuing the SAV DB command, confirm and record the supervisory port parameters using the DSP SP command.
Command:
SAV DB[/F] where:
/F = causes database to be uploaded at speed of 57.6 kbps.
Set Day of Year (SET DAT) Command
The SET DAT command sets the day of the year of the real time clock.
Command:
[NOD xxxx] SET DAT mm-dd-yyyy where: mm-dd-yyyy = month-day-year
The response includes the time, the day of the week, and month in literal format.
For example:
SET DAT 12-14-1990
TIME: 10:24:30 DATE: FRI DEC-14-1990
Mask and Unmask Unsolicited Messages (SET MUM, CLR MUM)
Commands
The SET MUM LOC command causes the supervisory port to mask (not to display) unsolicited messages from the local node. The SET MUM REM command causes the local node to inhibit transmission of unsolicited alarms to the nodes on the alarm notification list of the local node.
The CLR MUM LOC command clears the supervisory port of masking unsolicited messages from the local node. The CLR MUM REM command allows the local node to transmit unsolicited alarms to the nodes on the alarm notification list of the local node.
Commands:
[NOD xxxx] SET MUM LOC
[NOD xxxx] SET MUM REM
[NOD xxxx] CLR MUM LOC
[NOD xxxx] CLR MUM REM
L2UG
6/30/97
4-11
Set and Clear Supervisory Port Pagination (SET PG, CLR PG)
Commands
The SET PG command causes the supervisory port to output one page (23 lines) of data to the supervisory terminal and then wait for any key (except Control S, Control C, or BREAK) to be pressed before outputting the next page.
The CLR PG command causes the supervisory port to continuously output data to the supervisory terminal.
Commands:
SET PG
CLR PG
Set Time of Day (SET TIM) Command
The SET TIM command sets the time of day and initializes the real time clock. Enter hours, minutes, and seconds separated by colons.
Command:
[NOD xxx] SET TIM tt:tt:tt [/OFF=±hh:mm] where: tt:tt:tt = hours:minutes:seconds (24-hour clock)
/OFF=±hh:mm = Optional plus or minus offset in hours and minutes
(12-hour clock) separated by colons. This offset is used by the
Network Management System for alarm time-stamping.
NOTES:
The offset time is expressed as an offset from Greenwich Mean Time
(GMT)/Universal Coordinated Time (UCT).
The LINK/2+ System does not automatically adjust for daylight savings time.
Set and Clear Time Out (SET TMO, CLR TMO) Commands
The SET TMO and CLR TMO commands enable and disable the 30-minute timer that can be used when password protection is enabled.
Commands:
[NOD xxxx] SET TMO
[NOD xxxx] CLR TMO
The SET TMO command enables the 30-minute timer. The user will be logged out if no keystroke is made at the supervisory terminal for 30 minutes.
The CLR TMO command disables the 30-minute timer and allows the user unlimited time on the supervisory terminal until the user manually logs out with the EX command.
4-12
L2UG
6/30/97
If password protection is enabled, the DSP SY command display includes one of the following messages to show if the 30-minute timer is enabled or disabled:
SP TIMEOUT: ENABLED
SP TIMEOUT: DISABLED
Stop Command File Execution (STP) Command
The STP command stops a currently executing command file from continuing, once the system processes the STP command.
No commands, following the STP command, in the command file sequence will execute.
Toggle Bank (TGL BNK) Command
The TGL BNK command is issued to a Network Module. This command switches execution of operational software from the Network Module’s current online flash EPROM bank to the current offline flash EPROM bank. For example, if the Network Module is currently executing from the operational software in bank B, it will execute from bank A after the TGL BNK command is executed.
Before switching to the other memory bank, the Network Module performs a checksum on the operational software in the new memory bank, and will only switch after confirming that the software in the new bank is satisfactory.
PRECAUTION: The TGL BNK command also resets the Network Module, but the online Network Module remains the online module after resetting.
Command:
[NOD xxxx] TGL BNK n:ss
Send Message (") Command
The " command sends up to 48 characters of text to the supervisory port of the specified remote node. If the remote node is unable to display the text message for any reason, the " command times out after 14 seconds and displays the message "BUSY" at the local supervisory terminal.
The receiving supervisory terminal precedes the output text with an identifier of the sending node.
Command:
NOD xxxx "text where: text = up to 48 printable characters.
A quotation mark after the text is not required.
L2UG
6/30/97
4-13
NOTES:
This command does not function if the receiving intermachine link security is enabled.
The Send Message command can send text only to LINK/2+ Release
7 and higher nodes.
Command Keyword Information (?) Command
The ? command displays keyword information for available LINK/2+ System supervisory port commands, Figure 4-1. Initially, the keywords displayed are the 1-, 2-, or 3-character instruction part of each LINK/2+ command.
Command:
[NOD xxxx] ?
A plus sign (+) following a 2- or 3-character keyword in the display indicates that more information is available. To display more information about that command, enter the keyword abbreviation followed by a ?. Figure 4-1 shows how to use the ? command to find more information about the CLR command.
If the character string ’ ’ appears in the display, this indicates that no additional keyword is required.
N0100>?
?, @, CLR+, CON+, DEF+, DSC+, DSP+, INS, LP+, MON+, NOD, RMV, RST, SET+,
TRC+, TST+, BSY, CEN+, HEL, EP, CNV+, EX, DEL+
N0100>
N0100>CLR ?
@, AQ, BP+, CH, DL, MG, PG, PH, RDN, RLY, RTE, MC, FMC, DS0, DS1, TON, LCL,
MUM+, SEC, PW, TMO, REG, POL, PRO, MM, VPR, SPR
N0100>
N0100>CLR BP ?
LP, PH
NOTE: CLR GWY and SET GWY commands do not appear on the screen because these commands can only be issued remotely, e.g., NOD 1234 SET GWY SP.
Figure 4-1. Typical Command Keyword Information (?) Command
4-14
L2UG
6/30/97
COMMAND FILE COMMANDS
Command files allow the user to replace complex commands, or a sequence of commands, with a single macro command that is stored in the database. The following paragraphs describe the commands for defining, displaying, editing, executing, and clearing command files.
Delete Command Lines (D) Command
The D command deletes a specified line or range of lines in a command file when the supervisory terminal is in command file edit mode.
Command at the CMD? prompt:
D {i or i-j} where: i = number of command line to be deleted i-j = range of command line numbers for lines to be deleted, where i < j.
Define/Clear Command File (DEF @) Command
The DEF @ command opens a new or existing command file for editing and displays the command file editor prompt for edit commands. Up to eight separate command files can be defined. Each command file can contain a maximum of 254 characters (including spaces and carriage returns). Each command file is given a unique 1-digit identifier from 1 to 8.
The edit commands available through the DEF @ command are also used to clear a command file.
Command:
DEF @ file where: file = specified command file (a number from 1 to 8)
The following guidelines apply when defining command files:
●
If more than 254 characters are entered in a command file, the message "Out of Space" is displayed when the editor is exited. Redefine the command file. See "Linking Command
Files" paragraph to program a command file of more than 254 characters.
●
A LINK/2+ System can be programmed to execute a command file repeatedly. See
"Repeating Command Files" paragraph.
●
Two special supervisory port commands are available only for use within a command file. See
"Terminal Control and Banner Command" and "Delay Time Command" paragraphs.
●
If the Copy Software (COP SW) command follows the Remove Module (RMV) command in a command file, use the Delay Time (*) command to include at least a 5 second delay preceding the COP SW command.
L2UG
6/30/97
4-15
4-16
To define a new command file:
1.
At the supervisory port prompt, enter the DEF @ command with the number of the command file to be defined. The system displays the command file number followed by the command file editor prompt (CMD?) to indicate the LINK/2+ System is in the command file edit mode.
2.
At the CMD? prompt, type I and press the RETURN key. The system displays a 1 for the first line.
3.
Type a supervisory port command followed by the RETURN key. The system displays the number for the next line and places the cursor in the first position of the new line.
4.
Repeat step 3 until all commands for the command file have been entered.
5.
In the first position of the next line, press the RETURN key to exit insert mode and return to the CMD? prompt. (Instead of the RETURN key, you can also use the ESCAPE key or
CONTROL Z.) The system displays the number of the command file and all the lines of the file followed by the CMD? prompt.
6.
Type X followed by the RETURN key to save the file and exit to the supervisory port prompt. To exit without saving the file or any changes, type CONTROL C.
For example, to create command file 1 consisting of the DSP ST SY and DSP SY commands, use these steps:
1.
At the supervisory port prompt, enter DEF @ 1 to display:
VALID COMMANDS ARE: DELETE, EDIT, INSERT, E(X)IT
Command File #1
CMD? _
2.
Enter I to be prompted with the first line number.
3.
Enter DSP ST SY to display:
1 DSP ST SY
2 _
4.
Enter DSP SY to display:
1 DSP ST SY
2 DSP SY
3 _
5.
Press the RETURN key to display:
Command File #1
1 DSP ST SY
2 DSP SY
CMD? _
L2UG
6/30/97
L2UG
6/30/97
6.
Enter X to save the file and display the supervisory port prompt.
To edit a command file:
1.
At the supervisory port prompt, enter the DEF @ command with the number of the file to be edited. The system displays the command file number and the complete file followed by the command file editor prompt (CMD?) to indicate the LINK/2+ System is in the command file edit mode.
2.
To edit a line of the file, enter E and the number of the line to display the line with the cursor positioned at the end of the line.
3.
Use the BACKSPACE key to move the cursor to the first character to be changed and type over the existing characters to make the changes. Press the RETURN key to display the edited file followed by the CMD? prompt.
4.
To delete one or more lines of the file, enter D and the number of the line or the range of lines to be deleted. The system displays the edited file followed by the CMD? prompt.
5.
To insert lines into the file, enter I and the number of the line just before the insertion point.
Use I 0 or I without any line number to insert lines at the beginning of the file before line 1.
The system displays the next line number so the new lines can be inserted.
6.
Type the supervisory port command to be inserted and press the RETURN key at the end of the line to display the next line number.
7.
Repeat step 6 as many times as required to insert the new lines.
8.
In the first position of the next line, press the RETURN key to exit insert mode. (Instead of the RETURN key, you can also use the ESCAPE key or CONTROL Z.) The system displays the number of the command file and all the lines of the file followed by the CMD?
prompt.
9.
Type X followed by the RETURN key to save the edited file and exit to the supervisory port prompt. To exit without saving the file or any changes, type CONTROL C.
For example, to edit command file 1 of the previous example:
1. Enter DEF @ 1 to display:
VALID COMMANDS ARE: DELETE, EDIT, INSERT, E(X)IT
Command File #1
1 DSP ST SY
2 DSP SY
CMD? _
2.
To edit the first line, enter E 1 to display:
1 DSP ST SY_
4-17
4-18
3.
Backspace to the beginning of SY, type QUA * and press the RETURN key to complete the edit and display:
Command File #1
1 DSP ST QUA *
2 DSP SY
CMD? _
4.
To begin inserting lines after line 1, enter I 1 to display:
2 _
5.
Enter command lines such as:
2 DSP AQ
3 DSP ST ALM 26
4 _
6.
Press the RETURN key to exit insert mode, reassign line numbers, and display:
Command File #1
1 DSP ST QUA *
2 DSP AQ
3 DSP ST ALM 26
4 DSP SY
CMD? _
7.
To delete line 2, enter D 2 to display:
Command File #1
1 DSP ST QUA *
2 DSP ST ALM 26
3 DSP SY
CMD? _
8.
Enter X to save the edited file and display the supervisory port prompt.
To clear a command file:
1.
At the supervisory port prompt, enter the DEF @ command with the number of the command file to be cleared. The system displays the command file number and the complete file followed by the command file editor prompt (CMD?).
2.
Type D 1-N followed by the RETURN key, where N is the number of the last line in the file. The system deletes all lines of the file and displays just the command file number followed by the CMD? prompt.
3.
Type X followed by the RETURN key to exit to the supervisory prompt.
L2UG
6/30/97
For example, to clear the command file of the previous example:
1.
Enter DEF @ 1 to display:
VALID COMMANDS ARE: DELETE, EDIT, INSERT, E(X)IT
Command File #1
1 DSP ST QUA *
2 DSP ST ALM 26
3 DSP SY
CMD? _
2.
Enter D 1-3 to delete all lines and display:
Command File #1
CMD? _
3.
Enter X to return to the supervisory port prompt.
Display Command File (DSP @) Command
The DSP @ command displays the contents of a command file.
Command:
DSP @
{
* or d[-d]...
[
,d[-d]
]}
where: d = command file number (1 to 8)
NOTE:
Range of command file numbers must be in ascending order.
For example, to display command file 1, enter DSP @ 1. The supervisory terminal will then display the individual commands that comprise command file 1, Figure 4-2.
N0100>DSP @ 1
Command File #1
DSP ST SY
DSP SY
Figure 4-2. Typical Command File Display (DSP @)
Edit Command Lines (E) Command
The E command displays a specified line for editing in a command file when the supervisory terminal is in command file edit mode. The E command places the cursor at the end of the displayed line, and the BACKSPACE key can be used to position the cursor for overtyping the characters to be changed.
L2UG
6/30/97
4-19
Command at the CMD? prompt:
E {i} where: i = number of command line to be edited
Insert Command Lines (I) Command
The I command allows the insertion of new lines into a command file when the supervisory terminal is in command file edit mode. The I command displays the line number of the first new line followed by the cursor. After the new line is typed followed by the RETURN key, the system displays the next line number and cursor for additional lines.
Command at the CMD? prompt:
I [i] where: i = number of command line just before the insertion point
If 0 or no line number is used, the new line is inserted before the current line 1 of the file.
Exit Command File Editor (X) Command
The X command exits the command file editor and returns the supervisory prompt to the screen.
Command at the CMD? prompt:
X
Execute Command File (@) Command
The @ command executes a command file. Command files can be executed either manually
or automatically at a specified time of day. The individual commands that were entered into the specified command file via the DEF @ command are executed one at a time in the order in which the commands were originally entered.
Commands:
@ file [/tt:tt:tt]
@ file [/tt:tt:tt mm-dd-yyyy]
@ file [/mm-dd-yyyy tt:tt:tt]
@ file [/mm-dd-yyyy] where: file = specified command file (a number from 1 to 8) tt:tt:tt = (optional) time in hours:minutes:seconds when the command file is to be executed (24-hour clock) tt:tt:tt mm-dd-yyyy = (optional) time in hours:minutes:seconds and date as month-day-year when the command file is to be executed mm-dd-yyyy tt:tt:tt = (optional) date as month-day-year and time in hours:minutes:seconds when the command file is to be executed
4-20
L2UG
6/30/97
mm-dd-yyyy = (optional) date as month-day-year when the command file is to be executed
If the @ command is entered without the time modifier, the command file is executed only once
(upon entry).
Time of Day Execution
If the time modifier, i.e., tt:tt:tt, is included in the @ command, the specified command file is executed once every 24 hours, at the time specified, until the time is cleared using the CLR @ command.
Time and Date Execution
If the time and date modifier is included in the @ command, the specified command file is executed once on the time and date specified.
Date Execution
If the date modifier is included in the @ command, the specified command file is executed on the date specified, at the time the command file was entered.
For example, to program the LINK/2+ System to execute command file 2 at 5:00 P.M. every day, enter:
@ 2/17:00:00 where: @ = instruction
2 = specifies command file 2
17:00:00 = sets execution time for 5 P.M.
Clear Preset Time (CLR @) Command
The CLR @ command clears the time that the LINK/2+ System is programmed to automatically execute a command file.
Command:
CLR @ file where: file = specified command file (a number from 1 to 8)
Only the time that the LINK/2+ System is programmed to execute the command file is cleared from the database, not the command file itself.
NOTE:
A reset to a nonredundant Network Module or loss of power to the
LINK/2+ System also clears the time at which a command file will automatically be executed.
L2UG
6/30/97
4-21
For example, to clear the preset time from command file 2, enter:
CLR @ 2 where:
CLR @ = instruction
2 = specifies command file 2
USING COMMAND FILES
The following paragraphs describe how to use command files more efficiently by linking command files, repeating a command file, and using the special commands that can only be used as instructions within a command file.
Linking Command Files
To enter a sequence of commands containing more than 254 characters, command files can be linked together. Enter the @ command as the final command in the current command file and specify the identification number of the command file to which you wish to link.
For example, Figure 4-3 shows how command file 5 is programmed so that the last instruction, i.e., @ 6, executes command file 6.
N0100> DEF @ 5
VALID COMMANDS ARE: DELETE, EDIT, INSERT, E(X)IT
Command File #5
1 DEF DST CH 1:8:*/N2 C1:10:*
2 NOD 2 DEF DST CH 1:10:*/N1 C1:8:8
3 DSC CH 1:9:11:9
4 @ 6
CMD? X
Figure 4-3. Typical Programming to Link Command Files
Repeating Command Files
To program a LINK/2+ System to execute a specified command file repeatedly, enter the @ command as the final command in the current command file and specify the identification number of the current command file.
To stop execution of a repeating command file, press BREAK key or enter Control C character.
For example, Figure 4-4 shows how to program the LINK/2+ System to repeatedly execute command file 4, which displays intermachine link status of the Interlink Module in slot 11.
4-22
L2UG
6/30/97
N0100> DEF @ 4
VALID COMMANDS ARE: DELETE, EDIT, INSERT, E(X)IT
Command File #4
1 DSP ST DL 11
2 @ 4
CMD? X
Figure 4-4. Typical Programming to Repeat Command File
Delay Time (*) Command
The Delay Time (*) command is used to enter a time delay within a command file. After a * command is executed, the system waits the amount of time specified by the * command before executing the next command in the file.
Command:
*tt:tt:tt where: tt:tt:tt = time in hours:minutes:seconds (24-hour clock)
For example, Figure 4-5 shows a command file that displays intermachine link status for the
Interlink Module in slot 11 every 15 seconds.
NOTE:
The Delay Time command is a special supervisory port command that can only be entered as an instruction within a command file.
N0100> DEF @ 4
VALID COMMANDS ARE: DELETE, EDIT, INSERT, E(X)IT
Command File #4
1 DSP ST DL 11
2 *00:00:15
3 @ 4
CMD? X
Figure 4-5. Typical Use of Delay Time Command
Terminal Control and Banner (&) Command
The & command is used to enter terminal screen control characters and text into a line of a command file. Typically, the control characters are used to clear the screen and position text that is used as a banner while a command file is being executed.
L2UG
6/30/97
4-23
4-24
Command:
&x
1
... x
254 where: x
1
... x
254
= up to 254 terminal screen control characters and alphanumeric characters that can be typed in a command file
To enter a terminal screen control character (e.g., home, clear, or cursor forward), press the appropriate key on the keyboard or enter the sequence of special characters specified by your terminal user’s manual. When the & key is entered as the first character on a line in a command file:
●
The terminal echoes the control characters and text on the screen as they are entered.
●
The terminal screen control functions are executed and text is displayed on the screen when the command file is executed.
For example, Figure 4-6 shows a typical example of how to program the LINK/2+ System to clear the supervisory terminal screen, return the cursor to the home position, and display the banner "DISPLAYING DATA LINK STATISTICS" each time command file 4 is executed.
All the key entries that follow the & command are displayed when the DSP @ command is entered, including terminal control character sequences, Figure 4-7.
NOTE:
The Terminal Control and Banner command is a special supervisory port command that can only be entered as an instruction within a command file.
L2UG
6/30/97
ACTION
ENTER COMMAND FILE
EDIT MODE AND SELECT
COMMAND FILE 4.
TO DEFINE TERMINAL
CONTROL AND BANNER
FOR RUN TIME:
ENTRY
DEF @ 4
RETURN
DISPLAY
N0100>DEF @ 4
VALID COMMANDS ARE: DELETE,
EDIT, INSERT, E(XIT)
Command File #4
CMD? _
N0100>DEF @ 4
VALID COMMANDS ARE: DELETE,
EDIT, INSERT, E(XIT)
Command File #4
CMD? I
1 _
• TYPE TERMINAL
CONTROL SEQUENCE
TO MOVE CURSOR TO
HOME POSITION.
• TYPE TERMINAL
CONTROL SEQUENCE
TO CLEAR TERMINAL
SCREEN.
RETURN
• GO TO INSERT MODE I
• TYPE TERMINAL
CONTROL AND
BANNER COMMAND.
&
CONTROL
ESCAPE
N0100>DEF @ 4
VALID COMMANDS ARE: DELETE,
EDIT, INSERT, E(X)IT
Command File #4
CMD? I
1 &_
A
VALID COMMANDS ARE: DELETE,
EDIT, INSERT, E(X)IT
Command File #4
CMD? I
1 &
_
K
RESULT
CMD? PROMPT IS
DISPLAYED INDICATING
YOU ARE IN COMMAND
FILE EDIT MODE.
CURSOR MOVES TO
THE FIRST LINE OF
FILE.
CURSOR MOVES TO
UPPER LEFT-HAND
CORNER OF SCREEN
(HOME POSITION).
SUPERVISORY
TERMINAL SCREEN
GOES BLANK.
• DEFINE BANNER
WHICH WILL BE
DISPLAYED ON
SUPERVISORY
TERMINAL AT RUN
TIME.
DISPLAYING DATA LINK
STATISTICS
RETURN
DISPLAYING DATA LINK STATISTICS
2_
TERMINAL CONTROL
SEQUENCE AND
BANNER ARE ENTERED
INTO COMMAND FILE.
CURSOR MOVES TO
THE BEGINNING OF
NEXT LINE.
ENTER DSP ST DL
COMMAND FOR
INTERLINK MODULE IN
SLOT 6 INTO COMMAND
FILE.
DSP ST DL 6
RETURN
ENTER COMMAND TO
WAIT 15 SECONDS
BEFORE EXECUTING
THE NEXT COMMAND IN
THE COMMAND FILE.
*00:00:15
RETURN
= Control sequence is terminal dependent.
DISPLAYING DATA LINK STATISTICS
2DSP ST DL 6
3_
CURSOR MOVES TO
THE BEGINNING OF
NEXT LINE.
DISPLAYING DATA LINK STATISTICS
2DSP ST DL 6
3*00:00:15
4_
CURSOR MOVES TO
THE BEGINNING OF
NEXT LINE.
Figure 4-6. Typical Use of Terminal Control and Banner (&) Command (Sheet 1 of 2)
L2UG
6/30/97
4-25
ACTION
ENTER COMMAND TO
CONTINUALLY EXECUTE
COMMAND FILE 4.
@ 4
ENTRY
RETURN
DISPLAY RESULT
DISPLAYING DATA LINK STATISTICS
2DSP ST DL 6
3*00:00:15
4@ 4
5_
CURSOR MOVES TO
THE BEGINNING OF
NEXT LINE.
LEAVE INSERT MODE
BY PRESSING Z KEY
WHILE HOLDING DOWN
CONTROL KEY.
SAVE AND EXIT THE
COMMAND FILE.
X
CONTROL
RETURN
Z
DISPLAYING DATA LINK STATISTICS
2DSP ST DL 6
3*00:00:15
4@ 4
CMD?_
CMD? PROMPT
RETURNS.
DISPLAYING DATA LINK STATISTICS
2DSP ST DL 6
3*00:00:15
4@ 4
CMD? X
N0100>_
COMMAND FILE
EDIT MODE IS
EXITED.
SUPERVISORY PORT
PROMPT IS
DISPLAYED.
Figure 4-6. Typical Use of Terminal Control and Banner (&) Command (Sheet 2)
N0100>DSP @ 4
Command File #4
& ^A^[kDISPLAYING DATA LINK STATISTICS
DSP ST DL 6
@ 4
Figure 4-7. Typical Display of Command File with Terminal Control Character Sequences and Banner
4-26
L2UG
6/30/97
다운로드
공개 링크 업데이트됨
문서 공개 링크
광고
