Table Of Contents
Information About the CLI Prompt
Global Configuration Command Mode
Interface Configuration Command Mode
Subinterface Configuration Command Mode
Exiting a Configuration Command Mode
Identifying Your Location in the Command Hierarchy
Using the no Form of a Command
Echoing Information to the Terminal
Understanding Regular Expressions
Searching and Filtering show Command Output
Filtering and Searching Keywords
Searching and Filtering from the --More-- Prompt
Using the System-Defined Timestamp Variable
Understanding the CLI
This chapter describes the Cisco NX-OS software CLI.
This chapter includes the following sections:
•
Information About the CLI Prompt
•
•
•
•
Information About the CLI Prompt
Once you have successfully accessed the device, the CLI prompt displays in the terminal window of your console port or remote workstation (see Example 3-1).
Example 3-1 Initial CLI Prompt
User Access Verificationlogin: adminPassword:<password>Cisco Nexus Operating System (NX-OS) SoftwareTAC support: http://www.cisco.com/tacCopyright (c) 2002-2008, Cisco Systems, Inc. All rights reserved.The copyrights to certain works contained in this software are owned by other third parties and used and distributed under license. Certain components of this software are licensed under the GNU General Public License (GPL) version 2.0 or the GNU Lesser General Public License (LGPL) Version 2.1. A copy of each such license is available athttp://www.opensource.org/licenses/gpl-2.0.php andhttp://www.opensource.org/licenses/lgpl-2.1.phpswitch#You can change the default device hostname (see the "Changing the Device Hostname" section on page 5-5).
From the CLI prompt, you can do the following:
•
•
•
Command Modes
This section includes the following topics:
•
•
•
•
About Command Modes
The Cisco NX-OS CLI is divided into command modes, which define the actions available to the user. Command modes are "nested" and must be accessed in sequence. As you navigate from one command mode to another, an increasingly larger set of commands become available. All commands in a higher command mode are accessible from lower command modes. For example, the show commands are available from any configuration command mode. Figure 3-1 shows how command access builds from EXEC mode to global configuration mode.
Figure 3-1 Command Modes
EXEC Command Mode
When you first log in, the Cisco NX-OS software places you in EXEC mode. The commands available in EXEC mode include the show commands that display device status and configuration information, the clear commands, and other commands that perform actions that you do not save in the device configuration.
Global Configuration Command Mode
Global configuration mode provides access to the broadest range of commands. The term "global" indicates characteristics or features that affect the device as a whole. You can enter commands in global configuration mode to configure your device globally, or to enter more specific configuration modes to configure specific elements such as interfaces or protocols.
To access the global configuration mode, follow this step:
Interface Configuration Command Mode
One example of a specific configuration mode that you enter from global configuration mode is interface configuration mode. To configure interfaces on your device, you must specify the interface and enter interface configuration mode.
You must enable many features on a per-interface basis. Interface configuration commands modify the operation of the interfaces on the device, such as Ethernet interfaces or management interfaces (mgmt 0).
For more information about configuring interfaces, see the Cisco Nexus 7000 Series NX-OS Interfaces Configuration Guide, Release 4.0.
For more information about interface commands, see the Cisco Nexus 7000 Series NX-OS Interfaces Command Reference, Release 4.0.
SUMMARY STEPS
1.
2.
DETAILED STEPS
Subinterface Configuration Command Mode
From global configuration mode, you can access a configuration submode for configuring VLAN interfaces called subinterfaces. In subinterface configuration mode, you can configure multiple virtual interfaces on a single physical interface. Subinterfaces appear to a protocol as distinct physical interfaces.
Subinterfaces also allow multiple encapsulations for a protocol on a single interface. For example, you can configure IEEE 802.1Q encapsulation to associate a subinterface with a VLAN.
For more information about configuring subinterfaces, see the Cisco Nexus 7000 Series NX-OS Interfaces Configuration Guide, Release 4.0.
For more information about subinterface commands, see the Cisco Nexus 7000 Series NX-OS Interfaces Command Reference, Release 4.0.
SUMMARY STEPS
1.
2.
DETAILED STEPS
Exiting a Configuration Command Mode
To exit from any configuration command mode, perform one of the following tasks:
Command Mode Summary
Table 3-1 summarizes information about the main command modes.
Table 3-1 Command Mode Summary
EXEC
From the login prompt, enter your username and password.
switch#
To exit to the login prompt, use the exit command.
Global configuration
From EXEC mode, use the configure terminal command.
switch(config)#
To exit to EXEC mode, use the end or exit command or press Ctrl-Z.
Interface configuration
From global configuration mode, use an interface command and specify an interface with an interface command.
switch(config-if)#
To exit to global configuration mode, use the exit command.
To exit to EXEC mode, use the end command or press Ctrl-Z.
Subinterface configuration
From global configuration mode, specify a subinterface with an interface command.
switch(config-subif)#
To exit to global configuration mode, use the exit command.
To exit to EXEC mode, use the end command or press Ctrl-Z.
VDC configuration
From global configuration mode, use the vdc command and specify a VDC name.
switch(config-vdc)#
To exit to global configuration mode, use the exit command.
To exit to EXEC mode, use the end command or press Ctrl-Z.
VRF configuration
From global configuration mode, use the vrf command and specify a routing protocol.
switch(config-vrf)#
To exit to global configuration mode, use the exit command.
To exit to EXEC mode, use the end command or press Ctrl-Z.
EXEC for a nondefault VDC
From EXEC mode, use the switchto vdc command and specify a VDC.
To exit to the default VDC, use the exit command or the switchback command.
EXEC for a nondefault VRF
From EXEC mode, use the routing-context vrf command and specify a VRF.
To exit to the default VRF, use the routing-context vrf default command.
Special Characters
Table 3-2 lists the characters that have special meaning in Cisco NX-OS text strings and should be used only in regular expressions or other special contexts.
Table 3-2 Special Characters
%
Percent
#
Pound, hash, or number
...
Ellipsis
|
Vertical bar
< >
Less than or greater than
[ ]
Brackets
{ }
Braces
Keystroke Shortcuts
Table 3-3 lists command key combinations that can be used in both EXEC and configuration modes:
Table 3-3 Keystroke Shortcuts
Ctrl-A
Moves the cursor to the beginning of the line.
Ctrl-B
Moves the cursor one character to the left.
When you enter a command that extends beyond a single line, you can press the Left Arrow or Ctrl-B keys repeatedly to scroll back toward the system prompt and verify the beginning of the command entry, or you can press the Ctrl-A key combination.Ctrl-C
Cancels the command and returns to the command prompt.
Ctrl-D
Deletes the character at the cursor.
Ctrl-E
Moves the cursor to the end of the line.
Ctrl-F
Moves the cursor one character to the right.
Ctrl-G
Exits to the previous command mode without removing the command string.
Ctrl-K
Deletes all characters from the cursor to the end of the command line.
Ctrl-L
Redisplays the current command line.
Ctrl-N
Displays the next command in the command history.
Ctrl-O
Clears the terminal screen.
Ctrl-P
Displays the previous command in the command history.
Ctrl-R
Redisplays the current command line.
Ctrl-T
Transposes the character to the left of the cursor with the character located to the right of the cursor.
Ctrl-U
Deletes all characters from the cursor to the beginning of the command line.
Ctrl-V
Removes any special meaning for the following keystroke. For example, press Ctrl-V before entering a question mark (?) in a regular expression.
Ctrl-W
Deletes the word to the left of the cursor.
Ctrl-X, H
Lists the history of commands you have entered.
When using this key combination, press and release the Ctrl and X keys together before pressing H.
Ctrl-Y
Recalls the most recent entry in the buffer (press keys simultaneously).
Ctrl-Z
Ends a configuration session, and returns you to EXEC mode.
When used at the end of a command line in which a valid command has been typed, the resulting configuration is first added to the running configuration file.
Displays the previous command in the command history.
Displays the next command in the command history.
Moves your cursor through the command history, either forward or backwards, to locate a command string.
?
Displays a list of available commands.
Tab
Completes the word for you after entering the first characters of the word, and then pressing the Tab key. All options that match are presented.
Use tabs to complete the following items:
•
•
•
•
Exampleswitch(config)# xm<Tab>switch(config)# xml <Tab>switch(config)# xml server
Abbreviating Commands
You can abbreviate commands and keywords by entering the first few characters of a command. The abbreviation must include sufficient characters to make it unique from other commands or keywords. If you are having trouble entering a command, check the system prompt and enter the question mark (?) for a list of available commands. You might be in the wrong command mode or using incorrect syntax.
Table 3-4 lists examples of command abbreviations.
Identifying Your Location in the Command Hierarchy
Some features have configuration submode hierarchy nested more than one level. In these cases, you can display information about your present working context (PWC).
SUMMARY STEPS
1.
DETAILED STEPS
Using the no Form of a Command
Almost every configuration command has a no form that can be used to disable a feature, revert to a default value, or remove a configuration. The Cisco NX-OS command reference publications describe the function of the no form of the command whenever a no form is available.
This example shows how to disable a feature:
switch# configure terminalswitch(config)# feature bgpswitch(config)# no feature bgpThis example shows how to revert to the default value for a feature:
switch# configure terminalswitch(config)# banner motd #Welcome to the switch#switch(config)# show banner motdWelcome to the switchswitch(config)# no banner motdswitch(config)# show banner motdUser Access VerificationThis example shows how to remove the configuration for a feature:
switch# configure terminalswitch(config)# role feature-group name securityswitch(config-role-featuregrp)# feature aaaswitch(config-role-featuregrp)# feature radiusswitch(config-role-featuregrp)# feature tacacsswitch(config-role-featuregrp)# exitswitch(config)# show role feature-groupfeature group: L3feature: router-bgpfeature: router-eigrpfeature: router-isisfeature: router-ospffeature: router-ripfeature group: securityfeature: aaafeature: radiusfeature: tacacsswitch(config)# no role feature-group name securityswitch(config)# show role feature-groupfeature group: L3feature: router-bgpfeature: router-eigrpfeature: router-isisfeature: router-ospffeature: router-ripThis example shows how to use the no form of a command in EXEC mode:
switch# system standby manual-bootsystem standby manual-boot option enabledswitch# system no standby manual-bootsystem standby manual-boot option disabledConfiguring CLI Variables
This section includes the following topics:
About CLI Variables
The Cisco NX-OS software supports the definition and use of variables in CLI commands.
You can use CLI variables in the following ways: ï
•
•
CLI variables have the following characteristics: ï
•
•
Cisco NX-OS supports one predefined variable: TIMESTAMP. This variable refers to the time of execution of the command in the format YYYY-MM-DD-HH.MM.SS.
Note
Configuring CLI Variables
You can define CLI session variables to persist only for the duration of your CLI session. These variables are useful for scripts that you execute periodically. You can reference the variable by enclosing the name in parentheses and preceding it with a dollar sign ($), for example $(variable-name).
SUMMARY STEPS
1.
2.
DETAILED STEPS
Command Aliases
You can define command aliases to replace frequently used commands. The command aliases can represent all or part of the command syntax.
Note
This section includes the following topics:
About Command Aliases
Command alias support has the following characteristics:
•
•
•
•
•
•
•
•
•
Defining Command Aliases
You can define command aliases for commonly used commands.
SUMMARY STEPS
1.
2.
3.
4.
5.
DETAILED STEPS
Command Scripts
You can create scripts of commands to perform multiple tasks.
This section includes the following topics:
•
•
Running a Command Script
You can create a list of command in a file and execute them from the CLI. You can use CLI variables in the command script (see the "Configuring CLI Variables" section).
Note
SUMMARY STEPS
1.
DETAILED STEPS
Step 1
run-script filename
Example:
switch# run-script testfile
Executes the commands in the file.
Echoing Information to the Terminal
You can echo information to the terminal, which is particularly useful from a command script. You can reference CLI variables and use formatting options in the echoed text. Table 3-5 lists the formatting options you can insert in the text.
SUMMARY STEPS
1.
echo [backslash-interpret] [text]
DETAILED STEPS
Step 1
echo [-e] [text]
Example:
switch# echo This is a test.
This is a test.
Displays information on the terminal. In Cisco NX-OS Release 4.0(2) and earlier releases, the -e keyword indicates that the text string contains formatting options (see Table 3-5). The text argument is alphanumeric, case sensitive and can contain blanks. The maximum length is 200 characters. The default is a blank line.
echo [backslash-interpret] [text]
Example:
switch# echo This is a test.
This is a test.
Displays information on the terminal. In Cisco NX-OS Release 4.0(3) and later releases, the backslash-interpret keyword indicates that the text string contains formatting options (see Table 3-5). The text argument is alphanumeric, case sensitive and can contain blanks. The maximum length is 200 characters. The default is a blank line.
Delaying Command Action
You can delay a command action for a period of time, which is particularly useful with in a command script.
SUMMARY STEPS
1.
DETAILED STEPS
Step 1
sleep seconds
Example:
switch# sleep 30
Cause a delay for a number of second. The range is from 0 to 2147483647.
Context-Sensitive Help
The Cisco NX-OS software provides context-sensitive help in the CLI. You can use a question mark (?) at any point in a command to list the valid input options.
CLI uses the caret (^) symbol to isolate input errors. The ^ symbol appears at the point in the command string where you have entered an incorrect command, keyword, or argument.
Table 3-6 shows how to use error isolation and context-sensitive help when setting the clock.
Understanding Regular Expressions
The Cisco NX-OS software supports regular expressions for search and filtering in the commands, such as the show commands. Regular expressions are case sensitive and allow for complex matching requirements.
This section includes the following topics:
Special Characters
You can also use other keyboard characters (such as ! or ~) as single-character patterns, but certain keyboard characters have special meanings when used in regular expressions. Table 3-7 lists the keyboard characters that have special meanings.
To use these special characters as single-character patterns, remove the special meaning by preceding each character with a backslash (\). This example contains single-character patterns that match a dollar sign ($), an underscore (_), and a plus sign (+), respectively:
\$ \_ \+
Single-Character Patterns
The simplest regular expression is a single character that matches the same single character in the command output. You can use any letter (A-Z, a-z) or digit (0-9) as a single-character pattern. You can specify a range of single-character patterns to match against command output.
To specify a range of single-character patterns, enclose the single-character patterns in square brackets ([ ]). For example, you can create a regular expression that matches a string containing one of the following letters: a, e, i, o, or u. Only one of these characters must exist in the string for pattern matching to succeed. In this case, [aeiou] matches any one of the five vowels of the lowercase alphabet, while [abcdABCD] matches any one of the first four letters of the lowercase or uppercase alphabet. You can simplify ranges by entering only the endpoints of the range separated by a dash (-). Also, you can including a caret (^) at the start of the range to match strings that do not include the range of characters.
Table 3-8 shows examples of regular expressions with ranges of characters.
Multiple-Character Patterns
You can also specify a pattern containing multiple characters by joining letters, digits, or keyboard characters that do not have special meanings. For example, a4% is a multiple-character regular expression.
With multiple-character patterns, the order is important. The regular expression a4% matches the character a followed by a 4 followed by a percent sign (%). If the string does not have a4%, in that order, pattern matching fails. The multiple-character regular expression a. (the character a followed by a period) uses the special meaning of the period character to match the letter a followed by any single character. With this example, the strings ab, a!, or a2 are all valid matches for the regular expression.
You can remove the special meaning of a special character by inserting a backslash before it. For example, when the expression a\. is used in the command syntax, only the string a. will be matched.
Anchoring
You can match a regular expression pattern against the beginning or the end of the string by "anchoring" these regular expressions to a portion of the string using the special characters shown in Table 3-9.
Table 3-9 Special Characters Used for Anchoring
^
Matches the beginning of the string.
$
Matches the end of the string.
For example, the regular expression ^con matches any string that starts with con, and $sole matches any string that ends with sole.
Note
Searching and Filtering show Command Output
Often, the output from show commands can be lengthy and cumbersome. The Cisco NX-OS software provides the means to search and filter the output so that you can easily locate information. The searching and filtering options follow a pipe character (|) at the end of the show command. You can display the options using the using the CLI context-sensitive help facility:
switch# show running-config | ?egrep Egrepgrep Grephead Stream Editorlast Display last linesless Stream Editorno-more Turn-off pagination for command outputsed Stream Editorwc Count words, lines, charactersbegin Begin with the line that matchescount Count number of linesexclude Exclude lines that matchinclude Include lines that matchFiltering and Searching Keywords
The Cisco NX-OS CLI provides a set of keywords that you can use with the show commands to search and filter the command output (see Table 3-10).
grep and egrep Utilities
You can use the Global Regular Expression Print (grep) and Extended grep (egrep) command-line utilities to filter the show command output as follows:
{grep | egrep} [-A lines] [-B lines] [-c] [-i] [-n] [-v] [-w] [-x] expression
Table 3-11 describes the grep and egrep parameters.
less Utility
You can use the less utility to display the contents of the show command output one screen at a time. You can enter less commands at the : prompt. To display all less commands you can use, enter h at the : prompt.
sed Utility
You can use the Stream Editor (sed) utility to filter and manipulate the show command output as follows:
sed command
The command argument contains sed utility commands.
Searching and Filtering from the --More-- Prompt
You can search and filter output from --More-- prompts. To search and filter the show command output from a --More-- prompt, use the commands described in Table 3-13.
BIOS Loader> Prompt
When the supervisor modules power up, a specialized BIOS image automatically loads and tries to locate a valid kickstart image for booting the system. If a valid kickstart image is not found, the following BIOS loader prompt displays:
loader>
For information on how to load the Cisco NX-OS software from the loader> prompt, see the
Cisco Nexus 7000 Series NX-OS Troubleshooting Guide, Release 4.0.Examples Using the CLI
This section includes the following topics:
•
Defining Command Aliases
This example shows how to define command aliases:
cli alias name ethint interface ethernetcli alias name shintbr show interface briefcli alias name shintupbr shintbr | include up | include ethernetThis example shows how to use a command alias:
switch# configure terminalswitch(config)# ethint 2/3switch(config-if)#Using CLI Session Variables
You can reference a variable using the syntax $(variable-name).
This example shows how to reference a user-defined CLI session variable:
switch# show interface $(testinterface)Ethernet2/1 is down (Administratively down)Hardware is 10/100/1000 Ethernet, address is 0000.0000.0000 (bia 0019.076c.4dac)MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec,reliability 255/255, txload 1/255, rxload 1/255Encapsulation ARPAauto-duplex, auto-speedBeacon is turned offAuto-Negotiation is turned onInput flow-control is off, output flow-control is offAuto-mdix is turned onSwitchport monitor is offLast clearing of "show interface" counters never5 minute input rate 0 bytes/sec, 0 packets/sec5 minute output rate 0 bytes/sec, 0 packets/secL3 in Switched:ucast: 0 pkts, 0 bytes - mcast: 0 pkts, 0 bytesL3 out Switched:ucast: 0 pkts, 0 bytes - mcast: 0 pkts, 0 bytesRx0 input packets 0 unicast packets 0 multicast packets0 broadcast packets 0 jumbo packets 0 storm suppression packets0 bytesTx0 output packets 0 multicast packets0 broadcast packets 0 jumbo packets0 bytes0 input error 0 short frame 0 watchdog0 no buffer 0 runt 0 CRC 0 ecc0 overrun 0 underrun 0 ignored 0 bad etype drop0 bad proto drop 0 if down drop 0 input with dribble0 input discard0 output error 0 collision 0 deferred0 late collision 0 lost carrier 0 no carrier0 babble0 Rx pause 0 Tx pause 0 resetUsing the System-Defined Timestamp Variable
This example uses $(TIMESTAMP) when redirecting show command output to a file.
switch# show running-config > rcfg.$(TIMESTAMP)Preparing to copy....doneswitch# dir12667 May 01 12:27:59 2008 rcfg.2008-05-01-12.27.59Usage for bootflash://sup-local8192 bytes used20963328 bytes free20971520 bytes totalRunning a Command Script
This example displays the CLI commands specified in the script file:
switch# show file testfileconfigure terminalinterface ethernet 2/1no shutdownendshow interface ethernet 2/1This example displays the run-script command execution output:
switch# run-script testfile`configure terminal``interface ethernet 2/1``no shutdown``end``show interface ethernet 2/1 `Ethernet2/1 is down (Link not connected)Hardware is 10/100/1000 Ethernet, address is 0019.076c.4dac (bia 0019.076c.4dac)MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec,reliability 255/255, txload 1/255, rxload 1/255Encapsulation ARPAPort mode is trunkauto-duplex, auto-speedBeacon is turned offAuto-Negotiation is turned onInput flow-control is off, output flow-control is offAuto-mdix is turned onSwitchport monitor is offLast clearing of "show interface" counters 1d26.2uh5 minute input rate 0 bytes/sec, 0 packets/sec5 minute output rate 0 bytes/sec, 0 packets/secRx0 input packets 0 unicast packets 0 multicast packets0 broadcast packets 0 jumbo packets 0 storm suppression packets0 bytesTx0 output packets 0 multicast packets0 broadcast packets 0 jumbo packets0 bytes0 input error 0 short frame 0 watchdog0 no buffer 0 runt 0 CRC 0 ecc0 overrun 0 underrun 0 ignored 0 bad etype drop0 bad proto drop 0 if down drop 0 input with dribble0 input discard0 output error 0 collision 0 deferred0 late collision 0 lost carrier 0 no carrier0 babble0 Rx pause 0 Tx pause 0 resetAdditional References
For additional information related to implementing Feature-1, see the following sections:
Related Documents
Licensing
Cisco Nexus 7000 Series NX-OS Licensing Guide, Release 4.0
Command reference
Cisco Nexus 7000 Series NX-OS Fundamentals Command Reference, Release 4.0
