Feedback
Table of Contents
Commands and Procedures
4.1.2 Input Format
4.1.3 Input Parameters
4.1.4 Normal Response
4.1.5 Error Response
4.1.6 Response Parameters
4.1.7 Normal Response Example
4.2.2 Input Format
4.2.3 Normal Response Format
4.2.4 Error Response Format
4.2.5 Response Parameters
4.2.6 Normal Response Example
4.3.2 Input Format
4.3.3 Input Parameters
4.3.4 Normal Response Format
4.3.5 Error Response Format
4.3.6 Response Parameters
4.3.7 Normal Response Example
4.4.2 Input Format
4.4.3 Input Parameters
4.4.4 Normal Response Format
4.4.5 Error Response Format
4.4.6 Normal Response Example
4.5.2 Input Format
4.5.3 Input Parameters
4.5.4 Normal Response Format
4.5.5 Error Response Format
4.5.6 Response Parameters
4.5.7 Normal Response Example
4.6.2 Input Format
4.6.3 Input Parameters
4.6.4 Normal Response Format
4.6.5 Error Response Format
4.6.6 Response Parameters
4.6.7 Normal Response Example
4.8 <parameter>
4.8.2 Input format
4.8.3 Input Parameters
4.8.4 Normal Response
4.8.5 Error Response
4.8.6 Response Parameters
4.8.7 Normal Response Example
4.8.8 Response Example
4.9.2 Input Format
4.9.3 Normal Response Format
4.9.4 Response Parameters
4.9.5 Normal Response Example
4.9.6 Error Response Example
4.10.2 Input Format
4.10.3 Input Parameters
4.10.4 Normal Response Format
4.10.5 Error Response Format
4.10.6 Response Parameters
4.10.7 Normal Response Example
4.11.2 Input Format
4.11.3 Input Parameters
4.11.4 Normal Response Format
4.11.5 Error Response Format
4.11.6 Response Parameters
4.11.7 Normal Response Example
4.12.1.2 Input Format
4.12.1.3 Input Parameters
4.12.1.4 Normal Response Format
4.12.1.5 Error Response Format
4.12.1.6 Response Parameters
4.12.1.7 Normal Response Example
4.12.2.2 Input Format
4.12.2.3 Input Parameters
4.12.2.4 Normal Response Format
4.12.2.5 Error Response Format
4.12.2.6 Response Parameters
4.12.2.7 Normal Response Example
4.12.3.2 Input Format
4.12.3.3 Input Parameters
4.12.3.4 Normal Response Format
4.12.3.5 Error Response Format
4.12.3.6 Response Parameters
4.12.3.7 Normal Response Example
4.12.4.2 Input Format
4.12.4.3 Input Parameters
4.12.4.4 Normal Response Format
4.12.4.5 Error Response Format
4.12.4.6 Response Parameters
4.12.4.7 Normal Response Example
4.12.5.2 Input Format
4.12.5.3 Input Parameters
4.12.5.4 Normal Response Format
4.12.5.5 Error Response Format
4.12.5.6 Response Parameters
4.12.5.7 Normal Response Example
4.12.6.2 Input Format
4.12.6.3 Input Parameters
4.12.6.4 Normal Response Format
4.12.6.5 Error Response Format
4.12.6.6 Response Parameters
4.12.6.7 Normal Response Example
4.12.7.2 Input Format
4.12.7.3 Input Parameters
4.12.7.4 Normal Response Format
4.12.7.5 Error Response Format
4.12.7.6 Response Parameters
4.12.7.7 Normal Response Example
4.12.8.2 Input Format
4.12.8.3 Input Parameters
4.12.8.4 Normal Response Format
4.12.8.5 Error Response Format
4.12.8.6 Response Parameters
4.12.8.7 Normal Response Example
4.12.9.2 Input Format
4.12.9.3 Input Parameters
4.12.9.4 Normal Response Format
4.12.9.5 Error Response Format
4.12.9.6 Response Parameters
4.12.9.7 Normal Response Example
4.12.10.2 Input Format
4.12.10.3 Input Parameters
4.12.10.4 Normal Response Format
4.12.10.5 Error Response Format
4.12.10.6 Response Parameters
4.12.10.7 Normal Response Example
4.12.11.2 Input Format
4.12.11.3 Input Parameters
4.12.11.4 Normal Response Format
4.12.11.5 Error Response Format
4.12.11.6 Response Parameters
4.12.11.7 Normal Response Example
4.12.12.2 Input Format
4.12.12.3 Input Parameters
4.12.12.4 Normal Response Format
4.12.12.5 Error Response Format
4.12.12.6 Response Parameters
4.12.12.7 Normal Response Example
4.12.13.2 Input Format
4.12.13.3 Input Parameters
4.12.13.4 Normal Response Format
4.12.13.5 Error Response Format
4.12.13.6 Response Parameters
4.12.13.7 Normal Response Example
4.13.1.2 Input Format
4.13.1.3 Input Parameters
4.13.1.4 Normal Response Format
4.13.1.5 Error Response Format
4.13.1.6 Response Parameters
4.13.1.7 Normal Response Example
4.15 Procedure: Upgrade the Sub-Network Manager (Windows)
Commands and Procedures
This chapter provides detailed descriptions of the ONS 15200 Command Line Interface commands supported by ONS 15200 system network elements (NE), as well as procedures for some commonly performed tasks. Commands are sent asynchronously during active sessions. To issue ONS 15200 Command Line Interface commands, the user must be connected to an NE and must have adequate permission.
ONS 15200 Command Line Interface commands are divided into several groups. These groups allow the user to quickly identify the type of command and the level at which the command is issued.
4.1 Commit
|
COMMAND CODE: |
commit <object type> [<name>] |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.1.1 Purpose
The commit command stores the current properties of an object in the flash memory of the Network Control Board (NCB) module. A committed object will automatically be restored after the system has been restarted. If <name> is omitted, all objects of the specified type are committed.
4.1.2 Input Format
commit <object type> [<name>]
4.1.3 Input Parameters
|
<object type> |
Object types include user, alias, community, management, and trap. |
|
<name> |
The name of the individual object. |
4.1.4 Normal Response
A normal response to the commit command is a blank command line.
4.1.5 Error Response
Responses indicating errors have the following format:
- -- Unknown `object type' `object name' --
4.1.6 Response Parameters
|
<object name> |
The name of the object that does not exist |
|
<object type> |
The object type that does not exist |
4.1.7 Normal Response Example
NCB:> commit user myuser NCB:>
4.2 Configure System
|
COMMAND CODE: |
configure system |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.2.1 Purpose
The configure system command is used to enter the system configuration mode. In system configuration mode, the operator can perform tasks such as defragmenting the file system, setting page lengths, executing command files, and other similar system functions. The functions are:
defrag <dev>: Defrag file system
exit: Exit system mode
format <dev> Format file system
fschk <dev>: Check file system
ipconf [<ipaddr><mask><gateway>]: Get/set the IP address
ldboot [<dev> <filename> <count>]: View/Load/Unload boot
ipfilt add|list|remove|set|commit: Update the IP filter
c [<drive> <filename> <tries>]: View/load/unload boot vector
list <dev>: List files
macaddr: System MAC address
page [<len>]: Get/set page length
password: Set new password
remove <dev> <filename> Remove files
reboot: System reboot
source <filename>: Execute a command file
syslog: Display system log
time [<yyyy:mm:dd> <hh:mm:ss>]: Get/set system time
version: Display software and hardware version
whoami: Current user
4.2.2 Input Format
configure system
4.2.3 Normal Response Format
NCB:>configure system NCB:=
4.2.4 Error Response Format
-- Not enough access --
-- Path not found --
-- Insufficient size --
4.2.5 Response Parameters
None.
4.2.6 Normal Response Example
NCB:>configure system NCB:=? defrag <dev> exit format <dev> fschk <dev> ipconf [<ipaddr><mask><gateway>] ipfilt add|list|remove|set|commit| ldboot [<dev> <filename> <count>] list <dev> macaddr page [<len>] password reboot remove <dev><filename> source <filename> syslog time [<yyyy:mm:dd><hh:mm:ss>] version whoami NCB:=
4.3 Configure User
|
COMMAND CODE: |
configure user |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.3.1 Purpose
The configure user command is used to modify the properties of a user. Table 4-1 shows the user parameters.
Table 4-1: User Privileges
|
Parameter |
Description |
|---|---|
|
Password |
The password can be set to any string that contains at least 6 characters and up to 30 characters. Valid characters are a through z, 0 through 9, A through Z, and the "_" (underscore) character. |
|
Privileges |
Access level of a selected user. Available privileges are:
|
|
State |
Condition of a selected user. Possible states are:
|
|
Timeout |
Numerical value in minutes that indicates the length of time a user can be inactive before the user is logged off automatically by the system. |
4.3.2 Input Format
configure user <user name>
See Table 4-1 for a description of the parameters.
4.3.3 Input Parameters
|
<user name> |
The name assigned to a specific user |
4.3.4 Normal Response Format
Configure `<user name>' <user name>:#
4.3.5 Error Response Format
-- Not enough access --
-- Wrong number of arguments [configure user <user name>] --
-- Missing argument --
-- Unexpected reply code <error code> --
4.3.6 Response Parameters
|
<user name> |
The name of the user to be configured. |
|
<error code> |
Number assigned to the error code. This number should be reported to Cisco personnel. |
4.3.7 Normal Response Example
NCB:>configure user testguest Configure `testguest' testguest:#list value testguest: password *** privileges guest state offline timeout 30
4.4 Create User
|
COMMAND CODE: |
create user <user name> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.4.1 Purpose
The create user command is used to add a new system user. Each user has a set of parameters. See Table 4-1 for a description of the user parameters.
Note The user name cannot begin with a digit.
4.4.2 Input Format
create user <user name>
4.4.3 Input Parameters
|
<user name> |
The name designated by the administrator for the new user |
4.4.4 Normal Response Format
NCB:>create user <user name> <user name>:#
4.4.5 Error Response Format
-- Not enough access --
-- Path not found --
-- Insufficient size --
-- Wrong number of arguments [create user <name>] --
-- Missing argument --
-- Could not create `name' --
-- User name `name' too short; minimum 6 characters --
-- User name `name' too long; maximum 30 characters --
-- Item named `name' already exists --
-- Name `name' does not follow naming convention --
-- Unexpected reply code <error code> --
4.4.6 Normal Response Example
NCB:>create user myuser myuser:#l v myuser: password **** privileges guest state offline timeout 30 myuser:#password firstpassword myuser:#privileges operator myuser:#l v myuser: password **** privileges operator state offline timeout 30 myuser:#
4.5 Delete User
|
COMMAND CODE: |
delete user <object name> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.5.1 Purpose
The delete user command is used to remove users from the system database.
4.5.2 Input Format
delete user <user name>
4.5.3 Input Parameters
|
<user name> |
The name of the selected user to be deleted. |
4.5.4 Normal Response Format
NCB:>delete user <user name> Deleted: `<user name>' NCB:>
4.5.5 Error Response Format
-- Not enough access --
-- Item not found --
-- Wrong number of arguments [delete user <name>] --
-- Unexpected reply code <error code> --
4.5.6 Response Parameters
|
<user name> |
The name of the selected object |
|
<error code> |
Number assigned to the error code. This number should be reported to Cisco personnel. |
4.5.7 Normal Response Example
NCB:>delete user myuser Deleted: `myuser' NCB:>
4.6 Display User
|
COMMAND CODE: |
display user <user name> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.6.1 Purpose
The display user command lists properties of a user.
4.6.2 Input Format
display user <user name>
4.6.3 Input Parameters
|
<user name> |
The name of the user to be displayed. |
4.6.4 Normal Response Format
NCB:>display user <user name> Display `<user name>' <user name>:>
4.6.5 Error Response Format
-- Not enough access --
-- Insufficient size --
-- Wrong number of arguments [display user <name>] --
-- Missing argument --
-- Unexpected reply code <error code> --
4.6.6 Response Parameters
|
<user name> |
The name of the user |
|
<error code> |
Number assigned to the error code. This number should be reported to Cisco personnel. |
4.6.7 Normal Response Example
NCB:>display user sdsguest Display 'sdsguest' sdsguest:>
4.7 Exit
|
COMMAND CODE: |
exit |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.7.1 Purpose
The exit command closes the current ONS 15200 Command Line Interface mode. When this command is issued at the NCB:> prompt, the telnet session is terminated.
4.7.2 Input Format
exit
4.7.3 Normal Response Format
NCB:=exit NCB:>
4.7.4 Normal Response Example
myuser:>exit NCB:>
4.8 <parameter>
|
COMMAND CODE: |
[<path>]* <parameter> [<new value>] |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP, RS-232 |
4.8.1 Purpose
The objects in the SNM database have tree structures. They consist of nodes and leaves, where the leaves contain the parameter values. The nodes and leaves may have different access rights. Some leaves may be possible to modify while other may contain read-only values. The values and structure of the objects can be viewed by the list command described above or by simply typing the relative path (the <parameter> command). Typing the path of a leaf followed by a `?' character prints the list of possible value to write. Printing a valid value will write the value to the leaf, omitting it will read the current value.
4.8.2 Input format
[<path>]*<parameter>
[<path>]*<parameter> <new value>
4.8.3 Input Parameters
|
<path> |
This is a "." or <space> separated list of tree nodes relative to the current path. |
|
<parameter> |
The name of the leaf |
4.8.4 Normal Response
The value of the read parameter
4.8.5 Error Response
-- Not enough access --
-- Path not found --
4.8.6 Response Parameters
None.
4.8.7 Normal Response Example
myuser:#privileges operator
myuser:#
4.8.8 Response Example
myuser:#privileges
operator
myuser:#privileges<?> [administrator operator guest]
myuser:#privileges guest
myuser:#privileges
guest
4.9 Password
|
COMMAND CODE: |
password |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.9.1 Purpose
The password command is used to change the password of the current logged-in user. The command will prompt for the new password and then will ask for a confirmation of the new password. If the two passwords are identical, the new password is automatically committed. he password can be set to any string that contains at least 6 characters and up to 30 characters. Valid characters are a through z, 0 through 9, A through Z, and the "_" (underscore) character.
4.9.2 Input Format
password
4.9.3 Normal Response Format
NCB:>password Type new password: ****** Confirm new password: ****** NCB:>
4.9.4 Response Parameters
|
****** |
The characters that represent the new password. |
4.9.5 Normal Response Example
NCB:>password Type new password: ****** Confirm new password: ****** NCB:>
4.9.6 Error Response Example
-- Confirmation failed, password not changed --
-- Password too short, minimum length is 6 characters --
-- Aborted, password not changed --
4.10 Show User
|
COMMAND CODE: |
show user [all|<name>] |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.10.1 Purpose
The show user command lists all users in the network. Information about privilege level and logon status (i.e. online, offline, suspended, or disabled) also appears. If only a specific user is of interest, that user's name can be specified as a parameter. If all is specified as a parameter, all internal users are listed.
See Table 4-1 for more information on user parameters.
4.10.2 Input Format
show user [all|<name>]
4.10.3 Input Parameters
None.
4.10.4 Normal Response Format
4.10.5 Error Response Format
None.
4.10.6 Response Parameters
|
name |
The logon name of the user |
|
privileges |
The privilege level of the user (administrator, operator, guest). |
|
state |
Condition of a selected user. Possible states are:
|
4.10.7 Normal Response Example
The normal response example is identical to the response format in Paragraph 4.10.4.
4.11 Whoami
|
COMMAND CODE: |
whoami |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.11.1 Purpose
The whoami command displays the current user and user privilege (administrator, operator, guest user).
4.11.2 Input Format
whoami
4.11.3 Input Parameters
None.
4.11.4 Normal Response Format
[user name] [user access level]
4.11.5 Error Response Format
None.
4.11.6 Response Parameters
|
user name |
The logon name of the user |
|
user access level |
The privilege level of the user |
4.11.7 Normal Response Example
The normal response example is identical to the response format in Paragraph 4.10.4.
4.12 System Configuration Commands
This group of commands is used to configure the system on the lowest level. This level includes items such as the real-time clock, IP address, boot sequence, and other related commands. A list of the available commands follows. These commands are available after using the configure system command (Paragraph 4.2).
4.12.1 Defrag
|
COMMAND CODE: |
defrag <device> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.1.1 Purpose
The defrag command is used to remove files from the file system on the NCB module. When a file is deleted, it is marked for deletion, but it is not removed until the defrag command is run or the system is rebooted.
Note This command can take up to 30 seconds to complete.
4.12.1.2 Input Format
defrag <device>
4.12.1.3 Input Parameters
|
<device> |
The equipment to be defragmented. |
4.12.1.4 Normal Response Format
NCB:=defrag 0
4.12.1.5 Error Response Format
None.
4.12.1.6 Response Parameters
None.
4.12.1.7 Normal Response Example
NCB:>defrag 0 Defragmentation in progress... NCB:=
4.12.2 Format
|
COMMAND CODE: |
format <device> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.2.1 Purpose
The format command reformats the specified device and erases all files.
4.12.2.2 Input Format
format <device>
4.12.2.3 Input Parameters
|
<device> |
The file system device to format |
4.12.2.4 Normal Response Format
NCB:= format 0 Format in progress... NCB:=
4.12.2.5 Error Response Format
When a nonexisting device number is entered:
-- Error, no such device --
When no device is specified:
-- Wrong number of arguments [format <dev>] --
4.12.2.6 Response Parameters
None.
4.12.2.7 Normal Response Example
NCB:= format 0 Format in progress... NCB:=
4.12.3 FSCHK
|
COMMAND CODE: |
fschk <device> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.3.1 Purpose
The fschk command displays information, contents, and the status of the specified device of the file system.
4.12.3.2 Input Format
fschk <device>
4.12.3.3 Input Parameters
|
<device> |
The number of the file system device to check. |
4.12.3.4 Normal Response Format
NCB:= fschk 0 Number of files: 5 Number of deleted files: 0 1147467 bytes used 949681 bytes left NCB:=
4.12.3.5 Error Response Format
When the device number is wrong:
-- Error, no such device --
When no device is specified:
-- Missing argument [fschk <dev>] --
4.12.3.6 Response Parameters
None.
4.12.3.7 Normal Response Example
NCB:= fschk 0 Number of files: 5 Number of deleted files: 0 1147467 bytes used 949681 bytes left NCB:=
4.12.4 Ipconf
|
COMMAND CODE: |
ipconf [<ip-address> <subnet mask> <default gateway>] |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.4.1 Purpose
The ipconf command is used to set or modify the IP properties of the Subnetwork Manager (SNM). This command assigns an IP address, a subnet mask, and a default gateway to the NCB module. When the module is started for the first time it does not have an IP address. The only way to communicate with the module is via the RS232 port using the ipconf command.
4.12.4.2 Input Format
ipconf [<ip address> <subnet mask> <default gateway>]
4.12.4.3 Input Parameters
|
<ip address> |
The Internet protocol (IP) address of the SNM |
|
<subnet mask> |
The subnetwork mask address of the SNM |
|
<default gateway> |
The default gateway address of the SNM |
4.12.4.4 Normal Response Format
NCB:=ipconf IP address: 10.52.18.225 Subnet mask: 255.255.255.0 Default gateway: 10.52.18.1 NCB:= ------------------------------------------------------------------------- NCB:=ipconf 192.10.23.45 255.255.255.0 192.10.23.1 IP address set, please reboot... NCB:=
4.12.4.5 Error Response Format
-- Error, could not read IP address parameters --
-- Error, invalid IP address --
-- Error, invalid subnet mask --
-- Error, invalid default gateway --
4.12.4.6 Response Parameters
None.
4.12.4.7 Normal Response Example
NCB:=ipconf IP address: 10.52.18.225 Subnet mask: 255.255.255.0 Default gateway: 10.52.18.1 NCB:= ------------------------------------------------------------------------- NCB:=ipconf 192.10.23.45 255.255.255.0 192.10.23.1 IP address set, please reboot... NCB:=
4.12.5 lpfilt
|
COMMAND CODE: |
lpfilt |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.5.1 Purpose
The ipfilt command is used to control which IP addresses are accepted by the system. By default the system will allow IP packages from any host to enter the system, but this can be insecure. The system has the ability to accept only hosts or host IP addresses that match a specified mask. There are five subcommands related to the ipfilt command:
The ipfilt add command adds individual acceptable IP addresses.
The ipfilt set command adds or modifies an IP address mask (note that only one mask is allowed). IP addresses that match the mask are either accepted or rejected depending on the <code> parameter.
The ipfilt list command displays the current filter list. All entries, apart from the filter, are assigned an entry number.
The ipfilt remove command removes selected IP addresses from the filter list. All entries in the list are assigned an entry number that must be specified when the ipfilt remove command is issued.
The ipfilt commit command stores the current settings.
The filtering mechanism will not allow the presence of filters (masks) that prevent the current user from accessing the system, unless access is explicitly granted by a separate IP address entry. This safeguard prevents the user from creating a filter that block the user's username.
4.12.5.2 Input Format
ipfilt add <ipaddress>
ipfilt commit
ipfilt list
ipfilt remove <entryno>
ipfilt set <mask> <code>
4.12.5.3 Input Parameters
|
<ipaddress> |
The Internet protocol (IP) address to be filtered |
|
<entryno> |
There can be more than one filter at any time. They are stored in a list. Each entry in the list has an entry number, which can be used when the entry should be deleted. |
|
<mask> |
This is a 32-bit number. A 0 in the mask means that the corresponding bit in the <ipaddress> must match the same bit in <code>. |
|
<code> |
This is a 32-bit number. All bits, where the corresponding bit in the <mask> is 0, must match the bit in the <ipaddress>. |
4.12.5.4 Normal Response Format
NCB:=ipfilt list IP filter mask: 0 IP filter code: 0 0: 10.52.18.225 1: 144.254.121.137 NCB:= --------------------------- NCB:=ipfilt remove 0 NCB:= --------------------------- NCB:=ipfilt set 0 2432596361 NCB:= -------------------------- NCB:=ipfilt commit NCB:=
4.12.5.5 Error Response Format
ipfilt set
-- Error, new filter will not accept your IP address --
-- Wrong number of arguments [ipfilt set <mask> <code>] --
ipfilt add
-- Wrong number of arguments [ipfilt add <ipaddr>] --
ipfilt remove
-- Wrong number of arguments [ipfilt remove <ipaddr seqno>] --
-- Error, new filter will not accept your IP address --
-- Error, IP address number out of range --
4.12.5.6 Response Parameters
None.
4.12.5.7 Normal Response Example
NCB:=ipfilt list IP filter mask: 4294967295 IP filter code: 0 0: 127.0.0.1 NCB:=ipfilt remove 0 NCB:= --------------------------- NCB:=ipfilt remove 0 NCB:= --------------------------- NCB:=ipfilt set 0 2432596361 NCB:= -------------------------- NCB:=ipfilt commit NCB:=
4.12.6 ldboot
|
COMMAND CODE: |
ldboot <drive> <filename> <tries> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.6.1 Purpose
The ldboot command is used to specify which application program to start when the system is booting. After setting up the NCB module, the boot software searches for an application to run. The application is specified by the ldboot command followed by a drive number and a number of tries. Currently, only drive 0 is supported. The number of tries prevents a malfunctioning application from blocking the system. An application is only granted a specified number of tries. When the number of tries has been exceeded, the system will enter boot mode again and the user can replace the malfunctioning combination of database (qdbs.cfg) and binary (snm.out) files.
Note The recommended number of tries is 10.
Running the ldboot command without arguments will display the current boot record settings, while running the ldboot command with arguments will update the boot record settings.
4.12.6.2 Input Format
ldboot [<drive> <filename> <tries>]
4.12.6.3 Input Parameters
|
<drive> |
The drive on which the file resides. Currently only drive 0 is supported. |
|
<filename> |
The name of the application |
|
<tries> |
Number of allowed reboot attempts. Setting <tries> to -1 disables the attempt mechanism, granting an unlimited number of boot attempts. The recommended number of tries is 10. |
4.12.6.4 Normal Response Format
NCB:=ldboot Boot image: /0/snm.out [2] NCB:= ------- NCB:=ldboot 0 snm.out 2 NCB:=
4.12.6.5 Error Response Format
-- Wrong number of arguments [ldboot [<drive> <filename> <tries>]] --
-- Error, no such device --
4.12.6.6 Response Parameters
None.
4.12.6.7 Normal Response Example
NCB:=ldboot Boot image: /0/snm.out [2] NCB:= ------- NCB:=ldboot 0 snm.out 2 NCB:=
4.12.7 List
|
COMMAND CODE: |
list <device> |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.7.1 Purpose
The list command displays a list of the files in the onboard file system. The NCB module has an onboard file system that contains the application and configuration files. Currently, only device 0 is available.
4.12.7.2 Input Format
list <device>
4.12.7.3 Input Parameters
|
<device> |
The drive number. Currently only drive 0 is supported. |
4.12.7.4 Normal Response Format
NCB:=list 0 Thu Sep 4 19:47:14 1980 2582 network.cfg Thu Sep 4 17:58:25 1980 41 sys_inet.sys Fri Mar 3 20:12:49 1972 39213 qdbs.cfg Thu Sep 4 19:30:54 1980 1104832 snm.out Tue Feb 20 18:58:42 2001 599 users.cfg NCB:=
4.12.7.5 Error Response Format
-- Error, no such device --
-- Wrong number of arguments [list <dev>] --
4.12.7.6 Response Parameters
None.
4.12.7.7 Normal Response Example
NCB:=list 0 Thu Sep 4 19:47:14 1980 2582 network.cfg Thu Sep 4 17:58:25 1980 41 sys_inet.sys Fri Mar 3 20:12:49 1972 39213 qdbs.cfg Thu Sep 4 19:30:54 1980 1104832 snm.out Tue Feb 20 18:58:42 2001 599 users.cfg NCB:=
4.12.8 Macaddr
|
COMMAND CODE: |
macaddr |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.8.1 Purpose
The macaddr command displays the MAC address (i.e., the Ethernet address) of the NCB module. The MAC address is set when the module is manufactured and cannot be changed.
4.12.8.2 Input Format
macaddr
4.12.8.3 Input Parameters
None.
4.12.8.4 Normal Response Format
NCB:=macaddr MAC address: 00-01-64-ff-c7-03 NCB:=
4.12.8.5 Error Response Format
-- Error, invalid MAC address --
4.12.8.6 Response Parameters
NCB:=macaddr MAC address: 00-01-64-ff-c7-03 NCB:=
4.12.8.7 Normal Response Example
macaddr
4.12.9 Page
|
COMMAND CODE: |
page |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.9.1 Purpose
The page command sets the maximum number of rows printed before the user is prompted. Some command replies are extensive in length. In such cases, a limited number of rows are printed to the screen before the user is prompted. At the prompt the user can press the Enter key to obtain one more row, or the Spacebar to obtain one more page. The length of a page is specified by the page command.
4.12.9.2 Input Format
page <len>
4.12.9.3 Input Parameters
|
<len> |
The number of rows printed before the user is prompted. |
4.12.9.4 Normal Response Format
NCB:=page -- Current page length is 24 rows -- NCB:= ------------------ NCB:=page 26 -- New page length is 26 rows -- NCB:=
4.12.9.5 Error Response Format
None.
4.12.9.6 Response Parameters
None.
4.12.9.7 Normal Response Example
NCB:=page -- Current page length is 24 rows -- NCB:= ------------------ NCB:=page 26 -- New page length is 26 rows -- NCB:=
4.12.10 Reboot
|
COMMAND CODE: |
reboot |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.10.1 Purpose
The reboot command restarts the system. The current Telnet or RS-232 connection is lost and must be re-established after the system restarts.
Note The restart takes approximately one minute.
4.12.10.2 Input Format
reboot
4.12.10.3 Input Parameters
None.
4.12.10.4 Normal Response Format
None.
4.12.10.5 Error Response Format
None.
4.12.10.6 Response Parameters
None.
4.12.10.7 Normal Response Example
NCB:=reboot
4.12.11 Remove
|
COMMAND CODE: |
remove |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.11.1 Purpose
The remove command deletes files from the NCB module file system. This command does not actually delete the file; it marks it for deletion. The file is deleted when the defrag command is issued or when the system is rebooted.
4.12.11.2 Input Format
remove <drive> <file>
4.12.11.3 Input Parameters
|
<drive> |
The drive designation where the file is located. Currently only the designation 0 is supported. |
|
<file> |
The name of the file to be marked for deletion. |
4.12.11.4 Normal Response Format
remove 0 netconf.cfg
4.12.11.5 Error Response Format
-- Wrong number of arguments [remove <drive> <file>] --
-- Error, no such file --
-- Error, no such device --
4.12.11.6 Response Parameters
None.
4.12.11.7 Normal Response Example
NCB:=remove 0 file.txt NCB:=
4.12.12 Syslog
|
COMMAND CODE: |
syslog |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.12.1 Purpose
The syslog command shows the internal low-level system log. The internal low-level system log contains low-level system events and errors.
4.12.12.2 Input Format
syslog
4.12.12.3 Input Parameters
None.
4.12.12.4 Normal Response Format
NCB:=syslog Thu Jul 22 17:58:24 2000 Booted NMS 1.0(0.4) Sat Feb 3 01:02:02 2001 New time: 2001:02:03 01:02:02 Tue Feb 20 15:45:00 2001 New time: 2001:02:20 15:45:00 NCB:=
4.12.12.5 Error Response Format
None.
4.12.12.6 Response Parameters
None.
4.12.12.7 Normal Response Example
NCB:=syslog Thu Jul 22 17:58:24 2000 Booted NMS 1.0(0.4) Sat Feb 3 01:02:02 2001 New time: 2001:02:03 01:02:02 Tue Feb 20 15:45:00 2001 New time: 2001:02:20 15:45:00 NCB:=
4.12.13 Time
|
COMMAND CODE: |
time |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.13.1 Purpose
The time command is used to read and set the current system time. When the time command is issued without parameters, the current time is presented. Both the date and time must be specified in order to set the current time.
4.12.13.2 Input Format
time [<yyyy:mm:dd> <hh:mm:ss>]
4.12.13.3 Input Parameters
|
<yyyy:mm:dd> |
The year, month, and date to which the system will be set. The year must be in 4-digit format, and the month and date must be in 2-digit format. |
|
<hh:mm:ss> |
The hour, minute, and second to which the system will be set. |
4.12.13.4 Normal Response Format
If no parameters are specified, the response is the current system time, in <yyy:mm:dd><hh:mm:ss> format.
4.12.13.5 Error Response Format
-- Syntax error --
-- Wrong number of arguments [time or time <yyyy:mm:dd> <hh:mm:ss>] --
4.12.13.6 Response Parameters
None.
4.12.13.7 Normal Response Example
NCB:=time Thu Feb 22 13:59:01 2001 NCB:= ---------------------- NCB:=time 2001:02:22 13:44:00 NCB:=
4.12.14 Version
|
COMMAND CODE: |
version |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.12.14.1 Purpose
The version command displays the following:
- NCB part number
- NCB revision number
- NCB serial number
- SNM part number
- SNM version number
4.12.14.2 Input Format
version
4.12.14.3 Input Parameters
None.
4.12.14.4 Normal Response Format
NCB:=version NCB Part No: 800-09474-01 NCB Revision No: 01 NCB Serial No: QEY05100217 SNM Part No: 36A0012 SNM Version No: 1.0(3.19) NCB:=
4.12.14.5 Error Response Format
None.
4.12.14.6 Response Parameters
None.
4.12.14.7 Normal Response Example
See the "Normal Response Format" section above.
4.13 QDBS Database Access Commands
This group of commands is used to manipulate the objects in the network database (QDBS).
4.13.1 List
|
COMMAND CODE: |
list |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.13.1.1 Purpose
The list command lists all parameters at the current focus. The list command has three options: list parameter names, list parameter values, and list recurse values. The list parameter command displays only the parameter names. The list value command displays the parameter names and their current values. The list recurse command lists parameter names and their current values by recursively scanning the subnodes found.
The list command also allows the user to specify a relative path to display other parameters below those at the current focus.
4.13.1.2 Input Format
list parameter [<path>|..]
list value [<path>|..]
list recurse [<path>|..]
4.13.1.3 Input Parameters
|
<path> |
The relative path for which the system displays parameters. |
|
.. |
These characters are used to specify "go up one level" relative to the current location. |
4.13.1.4 Normal Response Format
clip_301:# list parameter status value hat hwt lwt lat unit pmvalue clip_301:# --------------------------- clip_301:#list value status normal value -18.8 dbm hat -5.3 dbm hwt -12.6 dbm lwt -21.0 dbm lat -27.5 dbm unit dmb pmvalue - - -20.1 -18.7 -17.8 clip_301:
4.13.1.5 Error Response Format
-- Path not found--
4.13.1.6 Response Parameters
None.
4.13.1.7 Normal Response Example
See the "Normal Response Format" section.
4.13.2 Source
|
COMMAND CODE: |
source |
|
MESSAGE CATEGORY: |
All Categories |
|
TYPE: |
Generic |
|
PROTOCOL: |
TCP/IP |
4.13.2.1 Purpose
The source command changes the input stream. This command enables the Command Line Interface to read commands from a file specified by the <name> parameter. When the Command Line Interface reads an end-of-file (EOF) character, it automatically switches back to the original input stream.
4.13.2.2 Input Format
source <file name>
4.13.2.3 Input Parameters
|
<name> |
The name of the file used as the new input stream. |
4.13.2.4 Normal Response Format
The individual printouts from the commands in the specified file.
4.13.2.5 Error Response Format
-- Error, no such file --
-- Wrong number of arguments [source <file>] --
4.13.2.6 Response Parameters
None.
4.13.2.7 Normal Response Example
NCB:=source myfile.cmd
NCB:=
4.14 Procedure: Back Up the Database (Windows)
Before you can back up the database, you must know the IP address of the system, as well as make sure your PC is properly configured to communicate to the 15200 system. Contact your system administrator for more information on your network configuration.
If you want the database files to be saved in a particular folder, make sure the destination folder is created on your PC's C:\ drive. Perform the following steps to back up the 15200 database:
Step 1 To open a command prompt window, select Start>Programs and select Command Prompt (it may be under Accessories).
Step 2 At the C:\ prompt, type cd <foldername>, where foldername is the destination folder to which you want to save the database files. Press Enter.
Step 3 To ftp the 15200, type ftp <ipaddress>, where ipaddress is the IP address of the 15200 system database you want to back up. Press Enter.
Step 4 At the ftp prompt, log on as a user with administrator privileges.
Step 5 To list all of the database files, type dir and press Enter.
Step 6 Type get <filename>, where filename is the name of the first file that appears in the list, and press Enter.
Step 7 Repeat Step 6 for all of the files listed after the dir command.
Step 8 In your C:\ directory, find the destination folder and verify that all of the files you extracted are there.
Step 9 Close the ftp window.
The procedure for backing up the database is complete.
4.15 Procedure: Upgrade the Sub-Network Manager (Windows)
Before you upgrade the Sub-Network Manager (SNM), perform the database back up procedure above, and obtain the location of the SNM upgrade files on your PC. You must also be connected to the 15200 via Ethernet over a cross-over or straight cable, depending on how you are connected to the network.
Perform the following steps to upgrade the SNM:
Step 1 To telnet the 15200, type telnet <ipaddress>, where ipaddress is the IP address of the 15200 system to which you want to log in. Press Enter.
Step 2 Log on as a user with administrator privileges.
Step 3 At the NCB:> prompt, type configure system and press Enter.
Step 4 At the NCB:= prompt, type remove 0 qdbs.cfg and press Enter.
Step 5 Type remove 0 snm.out, where snm.out is the name of the boot file, and press Enter.
Step 6 Type defrag 0 and press Enter. (This process may take up to a minute.)
Step 7 Type ldboot 0 snm.out 10 and press Enter.
Step 8 Close the telnet session.
Step 9 To copy the SNM upgrade files from your local drive, open a command prompt window by selecting Start>Programs and select Command Prompt (it may be under Accessories).
Step 10 At the C:\ prompt, type cd <foldername>, where foldername is the folder where the new snm.out and qdbs.cfg files reside. Press Enter.
Step 11 To ftp the 15200, type ftp <ipaddress>, where ipaddress is the IP address of the 15200 system to which you want to copy the SNM upgrade. Press Enter.
Step 12 At the ftp prompt, log on as a user with administrator privileges.
Step 13 Type ascii and press Enter.
Step 14 Type put qdbs.cfg and press Enter.
Step 15 Type bin and press Enter.
Step 16 Type put snm.out and press Enter.
Step 17 Close the ftp window.
Step 18 To telnet the 15200, type telnet<ipaddress>, where ipaddress is the IP address of the 15200 system to which you want to log in. Press Enter.
Step 19 Log in as a user with administrative privileges.
Step 20 At the NCB:> prompt, type configure system and press Enter.
Step 21 At the NCB:= prompt, type reboot and press Enter. The system will reboot with the upgraded SNM.
The procedure for upgrading the SNM is complete.