|
|
This section lists the commands that you use to monitor and control the CLI session. It also includes the ping command, which may be used with the set and show commands described in the first two chapters of this book to monitor and control the LightStream 2020 (LS2020) node from the CLI.
The CLI control commands are as follows:
| clear | Clear the screen. |
| exit | Exit protected mode or CLI program (same as quit). |
| help | Provide online help for CLI commands. |
| password | Change the password for protected mode. |
| ping | Send ICMP echo packets to a host and report on any returned packets. |
| protected | Allow access to protected mode. |
| quit | Exit protected mode or CLI program (same as exit). |
| shell | Execute a LynxOS command under a copy of the LynxOS shell. |
| source | Execute a CLI script (CLI commands stored in a disk file). |
Use the clear command to clear the screen.
Syntax
clear
Use the exit command to protected mode or the CLI program.
Syntax
exit
Description
In normal mode, the exit command halts the CLI program and returns you to the bash prompt. If you are in protected mode, the exit command returns you to normal mode in the CLI, so that you must type exit a second time to halt the CLI.
Example
*cli> exit cli> exit LSnode:2$>
Use the help command to provide online help for CLI commands.
Syntax
help [topic]
Argument
| topic | Specifies the name of the command on which you want help. The topic argument is optional. By default (if you do not enter a topic argument), the help command displays a list of all CLI commands. |
Description
The help command displays online help information about CLI commands.
Refer to the LightStream 2020 Operations Guide for a detailed description of the online help facility in the CLI.
Example
The following example shows the display that the help command displays with protected as its argument:
cli> help protected
NAME
protected - enter protected mode
SYNTAX
protected
DESCRIPTION
Enter protected mode. User will be prompted for a password.
Password will not be echoed as it is entered. Protected mode
is required for sensitive or potentially disruptive operations.
cli>
Use the password command to change the password for the npadmin account, which is also the password for protected mode. Requires protected mode.
Syntax
password
Description
Use the password command to change the password for the npadmin account, which is also the password for accessing protected mode in the CLI:
Example
*cli> password Changing NIS password for npadmin on Boston5. Old password: New password: Retype new password: NIS entry changed on Boston5 *cli>
Use the ping command to send ICMP echo packets to a host and report on any returned packets.
Syntax
ping [packet-size] host-name
Arguments
| packet-size | Specifies the size of the packets that are sent. The packet-size argument is optional. The default packet size is 64 bytes. |
| hostname | Specifies the name of the host to which to send packets. The hostname argument is an IP address specified either by name (e.g. nnsc.nsf.net or boston5) or by number (e.g. 197.5.0.8 or 198.113.178.17). See the LightStream 2020 Administration Guide for information about creating the hosts file that defines host names. |
Description
The ping command sends a series of ICMP echo packets at 1-second intervals to the specified IP address and reports on any returned ICMP echo-response packets. Press ^C (the control-C key) to stop the ping command and display a summary of the results.
Example
The following example shows four ping packets sent to the node named boston5:
cli> ping boston5 PING boston5 (198.113.178.17): 64 data bytes 64 bytes from 198.113.178.17: icmp_seq=0 time=26 ms 64 bytes from 198.113.178.17: icmp_seq=1 time=12 ms 64 bytes from 198.113.178.17: icmp_seq=2 time=13 ms 64 bytes from 198.113.178.17: icmp_seq=3 time=14 ms ^C ----boston5 PING Statistics---- 4 packets transmitted, 4 packets received, 0 packet loss round-trip (ms) min/avg/max = 12/17/26 cli>
The IP address 198.113.178.17 could have been used as the command argument instead of the alias boston5. The command used the default packet size of 64 bytes. The example shows the number of packets transmitted, the number received back from boston5, and the minimum, average, and maximum round-trip transmission time.
Use the protected command to allow access to protected mode.
Syntax
protected
Description
The protected command is used to access the CLI in protected mode. When you are in protected mode, you have access to additional commands. The command prompts you for the password for protected mode. You cannot enter protected mode unless you enter the correct password. When you are operating in protected mode, the cli> prompt is preceded by an asterisk (*cli>). To terminate protected mode and return to the cli> prompt, use the exit or quit command.
Example
To enter protected mode, enter the protected command. You are prompted for the password for the protected mode. When you enter the correct password and press [Return], you enter protected mode. In protected mode, the cli> prompt is always preceded by an asterisk, *cli>.
cli> protected Enter Password: *cli>
Use the quit command to exit protected mode or the CLI program.
Syntax
quit
Description
The quit command halts the CLI program. If you are in protected mode, the quit command exits from protected mode, but remains in the CLI (in normal mode), so that you must type quit a second time to exit from the CLI.
Example
*cli> quit cli> quit LSnode:2$#
Use the shell command to execute LynxOS commands under a copy of the LynxOS shell. Requires protected mode.
Syntax
shell "LynxOS command"
Arguments
| LynxOS command | Any LynxOS command that you can normally execute from the bash shell. Place the command in quotation marks. |
Description
The shell command executes a LynxOS command as if it were being run from the bash shell. The actual LynxOS command must be surrounded by quotes. For additional information about LynxOS commands, see the Operating System Guide. If more than one command is to be executed, it is often more convenient to start a subshell with the command shell bash at the cli> prompt. If you do this, it is very important to terminate the subshell afterward with the shell built-in command exit.
Example
The following example shows use of the shell command to run a LynxOS command that displays the date and time as known to the system. Because the command is a single word, the quotation marks are optional:
*cli> shell date Thu Feb 17 13:39:52 EST 1994 *cli>
The following example shows use of the ls command to display names of all files that begin with a dot (.) plus an
r
. Because the command contains a space, it must be entered within quotation marks:
*cli> shell "ls .r*" .rhosts .rhosts.dist *cli>
The metacharacter ? can be used in the quoted argument string of the shell command only awkwardly. (See the following shell bash example for the preferred method.) The CLI attempts to interpret ? as a request for help, then complains about a missing final quote. Type [^P] to repaint the command and continue typing. The following example demonstrates this workaround. Two ? characters are needed to display all files that begin with a dot, because .* and .?* would include .. (the abbreviation for the parent directory).
*cli> shell "ls .? missing quote *cli> shell "ls .?? missing quote *cli> shell "ls .??*" .bash_history .profile .rhosts .rhosts.dist *cli>
The following example shows use of the cbufpr command to display the last lines of the mma.traplog file. The command contains spaces, so it must be enclosed in quotation marks:
*cli> shell "cbufpr -t /usr/tmp/mma/mma.traplog"
PROGRAM: cbufpr: compiled Feb 02 1994 @ 16:07:57 [pid:35]
(OPER) NDD_3 at 02/17/94 16:35:29 EST (02/17/94 21:35:29 GMT)
Line Card lstb4:3 (MS-TR) up.
(INFO) NPTMM_2007 at 02/17/94 16:35:30 EST (02/17/94 21:35:30 GMT)
Slot 3 State Changed From DOWN To UP
(INFO) LC_2000 at 02/17/94 16:35:30 EST (02/17/94 21:35:30 GMT)
Slot 3: ND: ERMP channel to NP open
<Part of display omitted here>
(INFO) LC_2000 at 02/17/94 16:35:40 EST (02/17/94 21:35:40 GMT)
Slot 8: ports enabled 0x00
(OPER) NDD_3 at 02/17/94 16:35:46 EST (02/17/94 21:35:46 GMT)
Line Card lstb4:6 (LS-EDGE) up.
*cli>
Use the command bash to start a subshell. This is necessary for executing multiple commands, and it makes it easier to execute a command containing the metacharacter ? (described with an earlier example). The following example illustrates use of the cd command, then the vi editor, and finally the shell built-in command exit to return to the CLI:
*cli> shell bash LSnode:2$ cd /usr/app/base/config LSnode:2$ vi cli.groups <The displays from the vi editing session are omitted from this example.> LSnode:2$ exit exit *cli>
The effects of the cd command are lost when you terminate the subshell. The next use of the shell command will execute LynxOS commands in the user's login directory.
Use the source command to execute CLI commands stored in a disk file, known as a CLI script.
Syntax
source "scriptname"
Argument
"
scriptname
"
|
Identifies the file that contains the CLI commands that you want to execute. If the file scriptname is not in the current directory (usually the same directory as the user account you are using), you must enter the full pathname of the file. |
Description
The source command executes CLI commands that are stored in a disk file. This is referred to as a CLI script. The file does not have to be executable (it is not interpreted by the shell). Before executing each command, the CLI prints a
+
character as a prompt and echoes the command line as it appears in the script file.
The simplest way to create a CLI script is to use the echo command at the bash prompt as shown in the example below. You may also use the vi editor. Each command must begin on a new line. Comments may be included with the CLI commands in C programming style, between an initial /*
string and a final */ string.
You may interrupt extended output of a command in the script by typing [^C]. The software drops buffered output and goes on to the next command.
Example
The following example shows how to use the echo command to create a file containing multiple commands:
LSnode:2# echo "show chassis cards show card 2 ports" > card3.script
The following example shows how to use the cat command to verify the contents of the new script file:
LSnode:2# cat card3.script show chassis cards show card 2 ports LSnode:2#
The following example shows the output that results when the example script file is executed with the source command:
cli> source "scriptfile" + show chassis cards Slot 1: NP Slot 2: OC3 Trunk Slot 3: OC3 Edge Slot 4: MS Trunk Slot 5: MS Trunk Slot 6: MS Trunk Slot 7: LS Edge Slot 8: OC3 Trunk Slot 9: FDDI Slot 10: Ethernet Slot SA: Switch2 Slot SB: Switch2 + show card 2 ports Port 2000 CLC Trunk Name: tb5.2.0 cli>
|
Copyright 1988-1996 © Cisco Systems Inc.