- attach module
- allow feature-set
- banner exec
- banner motd
- boot auto-copy
- boot kickstart
- boot system
- cd
- clear cli history
- clear debug-logfile
- clear fault-management logs
- clear inactive-config acl
- clear inactive-config acl qos
- clear inactive-config qos
- clear install all failed-standby
- clear install failure-reason
- clear license
- cli alias name
- cli var name
- clock set
- clock protocol
- clock summer-time
- clock timezone
- configure terminal
- copy scheduled-config
- copy
- copy running-config startup-config
- databits
- delete
- diff-clean
- dir
- echo
- end
- exec-timeout
- exit
- fault-management auto-capture
- fault-management yaml reconfigure
- feature pong
- feature-set
- find
- flowcontrol hardware
- format
- gunzip
- gzip
- hostname
- install all
- install all epld
- install all parallel
- install fan-module epld
- install feature-set
- install license
- install module epld
- install xbar-module epld
- install xbar-module epld
- license smart conversion start1
- license smart conversion stop1
- line com1
- line console
- line vty
- load
- modem connect line
- modem in
- modem init-string
- modem restart line
- modem set-string user-input
- move
- parity
- ping
- ping6
- pong
- pop
- power redundancy-mode
- purge module running-config
- push
- python
- reload
- reload ascii
- reload cmp module
- reload module
- reload vdc
- rmdir
- run-script
- send
- setup
- session-limit
- show banner exec
- show banner motd
- show boot
- show cli alias
- show cli history
- show cli list
- show cli syntax
- show cli variables
- show clock
- show copyright
- show feature-set
- show file
- show hostname
- show incompatibility system
- show install all
- show license
- show license feature package mapping
- show license host-id
- show license usage
- show line
- show running-config
- show running-config diff
- show startup-config
- show switchname
- show system internal dir
- show system statistics mts
- show tech-support
- show terminal
- show time-stamp running-config last-changed
- show version
- sleep
- slot
- source
- sscp
- stopbits
- switchname
- system statistics mts
- tac-pac
- tail
- tar append
- tar create
- tar extract
- tar list
- terminal alias
- terminal color
- terminal dont-ask
- terminal edit-mode vi
- terminal history no-exec-in-config
- terminal length
- terminal log-all
- terminal redirection-mode
- terminal session-timeout
- terminal type
- terminal width
- traceroute
- traceroute6
- update license
- where
- write erase
Cisco Nexus 7000 Series NX-OS Fundamentals Commands
This chapter describes the Cisco Nexus 7000 Series NX-OS fundamentals commands.
attach module
To start a command session on an I/O module, use the attach module command.
Syntax Description
Slot numbers in the chassis for the I/O module. The range is from 1 to 10. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To exit the I/O module session, use the exit command. To abort the session, press the $ character sequence.
You can also use the slot command to send commands to an I/O module from the supervisor module session.
Use the question mark character (?) to obtain context-sensitive help.
Examples
This example shows how to start a command session on an I/O module:
Related Commands
|
|
|
|---|---|
allow feature-set
To allow a virtual device context (VDC) to enable a feature set, use the allow feature-set command. To disable a feature set on a VDC, use the no form of this command.
allow feature-set [ fcoe | fex | l2mp ]
no allow feature-set [ fcoe | fex | l2mp ]
Syntax Description
Defaults
Command Modes
network-admin
network-operator
vdc-admin
vdc-operator
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable a feature set on a VDC:
This example shows how to disable a feature set on a VDC:
Related Commands
|
|
|
|---|---|
banner exec
To configure the EXEC banner that displays after a user logs in to a switch, use the banner exec command. To revert to the default, use the no form of this command.
banner exec delimiting-character message delimiting-character
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To create a multiple-line EXEC banner, press Enter before typing the delimiting character to start a new line. You can enter up to 40 lines of text and a maximum of 254 characters per line including the delimiting characters.
Examples
This example shows how to configure a single-line EXEC banner:
This example shows how to revert to the default EXEC banner:
Related Commands
|
|
|
|---|---|
banner motd
To configure the message-of-the-day (MOTD) banner that displays when the user logs in to the device, use the banner motd command. To revert to the default, use the no form of this command.
banner motd delimiting-character message delimiting-character
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To create a multiple-line MOTD banner, press Enter before typing the delimiting character to start a new line. You can enter up to 40 lines of text.
Examples
This example shows how to configure a single-line MOTD banner:
This example shows how to configure a multiple-line MOTD banner:
This example shows how to revert to the default MOTD banner:
Related Commands
|
|
|
|---|---|
boot auto-copy
To enable automatic copying of boot image files to the standby supervisor module, use the boot auto-copy command. To disable automatic copying, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
When automatic copying of image files is enabled, the Cisco NX-OS software copies the image files referred to by the boot variable to the standby supervisor module. These image files must be present in local memory on the active supervisor module. For kickstart and system boot variables, only those image files that are configured for the standby supervisor module are copied. For module images, all modules present in the corresponding locations (bootflash: or slot0:) of the standby supervisor module will be copied.
Examples
This example shows how to enable automatic copying of boot image files to the standby supervisor module:
Related Commands
|
|
|
|---|---|
boot kickstart
To configure the boot variable for the Cisco NX-OS software kickstart image, use the boot kickstart command. To clear the kickstart image boot variable, use the no form of this command.
boot kickstart [ filesystem: [ //directory ] | directory ] filename [ sup-1 ] [ sup-2 ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The Cisco NX-OS software uses the boot variable for loading images when booting up using the reload or install all command. You must copy the kickstart image to the device before you set the kickstart boot variable. You must also set the system boot variable using the boot system command.
Note
We recommend that you use the install all command to update the system image on your device.
For information on upgrading and downgrading images on your Cisco NX-OS device, see the Cisco Nexus 7000 Series NX-OS Software Upgrade and Downgrade Guide, Release 6.x. This command does not require a license.
Examples
This example shows how to configure the kickstart boot variable for both supervisor modules:
This example shows how to configure the kickstart boot variable for the sup-1 supervisor module:
This example shows how to clear the kickstart boot variable:
Related Commands
|
|
|
|---|---|
boot system
To configure the boot variable for the Cisco NX-OS software system image, use the boot system command. To clear the system image boot variable, use the no form of this command.
boot system [ filesystem: [ //directory ] | directory ] filename [ sup-1 ] [ sup-2 ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The Cisco NX-OS software uses the boot variable for loading images when booting up using the reload or install all command. You must copy the system image to the device before you set the system boot variable. You must also set the kickstart boot variable using the boot kickstart command.
Note
We recommend that you use the install all command to update the system image on your device.
For information on upgrading and downgrading images on your Cisco NX-OS device, see the Cisco Nexus 7000 Series NX-OS Software Upgrade and Downgrade Guide, Release 6.x.
Examples
This example shows how to configure the system boot variable for both supervisor modules:
This example shows how to configure the system boot variable for the sup-1 supervisor module:
This example shows how to clear the system boot variable:
Related Commands
|
|
|
|---|---|
cd
To change the current working directory in the device file system, use the cd command.
cd [ filesystem: [ //directory ] | directory ] filename ]
Syntax Description
(Optional) Name of the file system. Valid values are bootflash, slot0, volatile, usb1, or usb2. |
|
(Optional) Name of the directory. The directory name is case sensitive. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the pwd command to verify the current working directory.
You can change only the directories that reside on the active supervisor module.
Examples
This example shows how to change the current working directory on the current file system:
This example shows how to change the current working directory to another file system:
This example shows how to revert back to the default working directory (bootflash):
Related Commands
|
|
|
|---|---|
clear cli history
To clear the command history, use the clear cli history command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the show cli history command to display the history of the commands that you entered at the command-line interface (CLI).
Examples
This example shows how to clear the command history:
Related Commands
|
|
|
|---|---|
clear debug-logfile
To clear the contents of the debug logfile, use the clear debug-logfile command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to clear the debug logfile:
Related Commands
|
|
|
|---|---|
clear fault-management logs
To clear the fault-management logs, use the clear fault-management logs command.
clear fault-management logs [ active | standby ] { vdc vdc ID } [ all ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to clear all the fault-management logs:
Related Commands
|
|
|
|---|---|
clear inactive-config acl
To clear inactive access control list (ACL) configurations, use the clear inactive-config acl command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
This command does not require a license.
Note
The automatic clear inactive-config acl command that clears an inactive configuration will delete the port channel policies even if one of the ports in a port channel has inactive policies.During a manual removal, when the interface is part of a port channel, remove the policy map or access list from the port channel or remove the interface from the port channel before performing the ISSU or ISSD. For all other interface types, remove the policy map or access list from the interface.
Examples
This example shows how to clear inactive ACL configurations:
switch(config)#
Related Commands
|
|
|
|---|---|
clear inactive-config acl qos
To clear inactive access control list (ACL) configurations for quality of service (QoS), use the clear inactive-config acl qos command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to clear inactive ACL configurations for QoS:
switch(config)#
Related Commands
|
|
|
|---|---|
clear inactive-config qos
To clear inactive quality of service (QoS) configurations, use the clear inactive-config qos command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to clear inactive QoS configurations:
switch(config)#
Related Commands
|
|
|
|---|---|
clear install all failed-standby
To clear the software installation failure log on the standby supervisor module, use the clear install all failed-standby command.
clear install all failed-standby
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to clear the software installation failure log on the standby supervisor module:
Related Commands
|
|
|
|---|---|
clear install failure-reason
To clear the reason for software installation failures, use the clear install failure-reason command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to clear the reason for software installation failures:
Related Commands
|
|
|
|---|---|
clear license
To uninstall a license, use the clear license command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to clear a specific license:
Related Commands
|
|
|
|---|---|
cli alias name
To configure a command alias, use the cli alias name command. To delete a command alias, use the no form of this command.
cli alias name alias-name alias-text
no cli alias name alias-name alias-text
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the command to create aliases for commands that you use frequently.
The Cisco NX-OS software has one predefined command alias called alias. You can use it to display the currently configured command aliases.
Examples
This example shows how to configure a command alias:
This example shows how to delete a command alias:
Related Commands
|
|
|
|---|---|
cli var name
To define a command-line interface (CLI) variable for a terminal session, use the cli var name command. To remove the CLI variable, use the no form of this command.
cli var name variable-name variable-text
Syntax Description
Name of the variable. The name is alphanumeric, case sensitive, and has a maximum of 31 characters. |
|
Variable text. The text is alphanumeric, can contain spaces, and has a maximum of 200 characters. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can reference a CLI variable using the following syntax:
Instances where you can use variables include the following:
You cannot reference a variable in the definition of another variable.
The Cisco NX-OS software provides predefined variable TIMESTAMP, which you can use to insert the time of day. You cannot change or remove the TIMESTAMP CLI variable.
You must remove a CLI variable before you can change its definition.
Examples
This example shows how to define a CLI variable:
This example shows how to reference a CLI variable:
This example shows how to reference the TIMESTAMP variable:
This example shows how to remove a CLI variable:
Related Commands
|
|
|
|---|---|
clock set
To set the system clock of the Cisco NX-OS Nexus 7000 Series switch to a user-defined value, use the clock set command.
clock set HH:MM:SS day month year
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You can use the clock set command to set the supervisor clock. Use the clock protocol none command before using the clock set command.
When you use the clock set command, NTP and PTP synchronization of the clock stops.
Examples
This example shows how to set the system clock of the Cisco NX-OS Nexus 7000 Series switch to a user defined value:
Related Commands
|
|
|
|---|---|
Sets the system clock on a Cisco NX-OS Nexus 7000 Series switch. |
clock protocol
To set the protocol for the clock on a virtual device context (VDC), use the clock protocol command. To remove the protocol settings of the clock on the VDC, use the no form of this command.
clock protocol {ntp | ptp | none} vdc vdc-id
no clock protocol {ntp | ptp |none} vdc vdc-id
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to set the PTP for a clock on a VDC:
This example shows how to remove the PTP from a clock on a VDC:
Related Commands
|
|
|
|---|---|
clock summer-time
To configure the summer-time (daylight saving time) offset, use the clock summer-time command. To revert to the default, use the no form of this command.
clock summer-time zone-name start-week start-day start-month start-time end-week end-day end-month end-time offset-minutes
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to configure the offset for summer-time or daylight saving time:
This example shows how to remove the summer-time offset:
Related Commands
|
|
|
|---|---|
clock timezone
To configure the time zone offset from Coordinated Universal Time (UTC), use the clock timezone command. To revert to the default, use the no form of this command.
clock timezone zone-name offset-hours offset-minutes
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to configure the time zone offset from UTC:
This example shows how to remove the time zone offset:
Related Commands
|
|
|
|---|---|
configure terminal
To enter global configuration mode, use the configure terminal command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the configure terminal command to enter global configuration mode. The commands that you enter in this mode are written to the running configuration file after you press the Enter key.
Examples
This example shows how to enter global configuration mode:
Related Commands
|
|
|
|---|---|
copy scheduled-config
To configure a file containing cli commands to be applied on the next reboot, use the copy scheduled-config command.
copy filename scheduled-config
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
This command should be called explicitly within the poap script to allow the poap boot-up process to continue at the next reboot. When PowerOn Auto Provisioning (POAP) is in progress, any important information or errors are displayed over the serial console aiding the administrator to troubleshoot in case of problems.
This command does not require a license.
Note
This is used in POAP script.
Examples
This example shows how to specify the file VRF-Tenant-Profile.cfg, located in the switch's bootflash: drive, to be applied to the running configuration at the next switch reload:
Related Commands
|
|
|
|---|---|
copy
To copy one file from another, use the copy command.
copy source-url destination-url
Syntax Description
Defaults
The default name for the destination file is the source filename.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The copy command allows you to copy a file (such as a system image or configuration file) from one location to another location. The source and destination for the file is specified by using a Cisco NX-OS file system URL, which allows you to specify a local or remote file location. The file system being used (such as a local memory source or a remote server) determines the syntax used in the command.
You can enter on the command line all necessary source- and destination-URL information and the username to use, or you can enter the copy command and have the CLI prompt you for any missing information.
The entire copying process may take several minutes, depending on the network conditions and the size of the file, and differs from protocol to protocol and from network to network.
The colon character (:) is required after the file system URL prefix keywords (such as bootflash).
In the URL syntax for ftp:, scp:, sftp:, and tftp:, the server is either an IPv4 address or a hostname.
The format of the source and destination URLs varies according to the file or directory location. You can enter either a command-line interface (CLI) variable for a directory or a filename that follows the Cisco NX-OS file system syntax in this format: filesystem :[/ directory ][/ filename ].
The following tables list URL prefix keywords by the file system type. If you do not specify a URL prefix keyword, the switch looks for a file in the current directory.
Table 1 lists URL prefix keywords for local writable storage file systems. Table 2 lists the URL prefix keywords for remote file systems. Table 3 lists the URL prefix keywords for nonwritable file systems.
This command does not require a license.
Copying Files from a Server to Bootflash Memory
Use the copy source-url bootflash: command (for example, copy tftp: source-url bootflash:) to copy an image from a server to the local bootflash memory.
Copying a Configuration File from a Server to the Running Configuration
Use the copy { ftp: | scp: | sftp: | tftp: } source-url running-config command to download a configuration file from a network server to the running configuration of the device. The configuration is added to the running configuration as if the commands were typed in the CLI. The resulting configuration file is a combination of the previous running configuration and the downloaded configuration file. The downloaded configuration file has precedence over the previous running configuration.
You can copy either a host configuration file or a network configuration file. Accept the default value of host to copy and load a host configuration file containing commands that apply to one network server in particular. Enter network to copy and load a network configuration file that contains commands that apply to all network servers on a network.
Copying a Configuration File from a Server to the Startup Configuration
Use the copy { ftp: | scp: | sftp: | tftp: } source-url startup-config command to copy a configuration file from a network server to the switch startup configuration. These commands replace the startup configuration file with the copied configuration file.
Copying the Running or Startup Configuration on a Server
Use the copy running-config { ftp: | scp: | sftp: | tftp: } destination-url command to copy the current configuration file to a network server that uses FTP, SCP, SFTP, or TFTP. Use the copy startup-config { ftp: | scp: | stfp: | tftp: } destination-url command to copy the startup configuration file to a network server.
You can use the copied configuration file as a backup.
Table 1 , Table 2 , and Table 3 , list the URL prefix keywords.
Examples
This example shows how to copy a file within the same directory:
This example shows how to copy a file to another directory:
This example shows how to copy a file to another file system:
This example shows how to copy a file to another supervisor module:
This example shows how to copy a file from a remote server:
Related Commands
|
|
|
|---|---|
copy running-config startup-config
To copy the running configuration to the startup configuration, use the copy running-config startup-config command.
copy running-config startup-config
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the copy running-config startup-config command to save your configuration changes in the running configuration to the startup configuration in persistent memory. When a device reload or switchover occurs, the saved configuration is applied.
Examples
This example shows how to save the running configuration to the startup configuration:
Related Commands
|
|
|
|---|---|
Displays the differences between the running configuration and the startup configuration. |
|
databits
To configure the number of data bits in a character for the COM1 port or console port, use the databits command. To revert to the default, use the no form of this command.
Syntax Description
Number of data bits in a character. The range is from 5 to 8. |
Defaults
Command Modes
COM1 port configuration mode
Console port configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
Use the databits command only in the default virtual device context (VDC).
You can configure the console and COM1 ports only from a session on the console port.
Examples
This example shows how to configure the number of data bits for the COM1 port:
This example shows how to configure the number of data bits for the console port:
This example shows how to revert to the default number of data bits for the COM1 port:
This example shows how to revert to the default number of data bits for the console port:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 port and console port configuration. |
delete
To delete a file, use the delete command.
delete [ filesystem : [ // directory / ] | directory / ] filename
Syntax Description
(Optional) Name of the file system. Valid values are bootflash, slot0, usb1, usb2, or volatile. |
|
(Optional) Name of the directory. The directory name is case sensitive. |
|
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the dir command to locate the file that you want to delete.
Examples
This example shows how to delete a file:
Related Commands
|
|
|
|---|---|
diff-clean
To remove the temporary files created automatically when you use diff filtering in show commands, use the diff-clean command.
diff-clean [ all-sessions | all-users ]
Syntax Description
(Optional) Removes the temporary files for all sessions, current and past, for the current user. |
|
(Optional) Removes the temporary files for all sessions, current and past, for all users. |
Defaults
Removes the temporary files for the current session of the current user.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to remove the temporary files for the current session of the current user:
This example shows how to remove the temporary files for the current session and all past sessions of the current user:
This example shows how to remove the temporary files for the current session and all past sessions of all users:
dir
To display the contents of a directory, use the dir command.
dir [ filesystem : [ // directory / ] | directory / ]
Syntax Description
(Optional) Name of the file system. Valid values are bootflash, debug, log, logflash, slot0, usb1, usb2, or volatile. |
|
(Optional) Name of the directory. The directory name is case sensitive. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Use the pwd command to verify the current working directory.
Examples
This example shows how to display the contents of the root directory in bootflash:
This example shows how to display the contents of the current working directory:
Related Commands
|
|
|
|---|---|
echo
To display a text string on the terminal session, use the echo command.
echo [ backslash-interpret ] [ text ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Replaced the -e keyword with the backslash-interpret keyword. |
|
Usage Guidelines
Use the echo command in a command script to display information while the script is running.
Table 4 lists the formatting keywords that you can insert in the text when you include the backslash-interpret keyword.
|
|
|
|---|---|
Removes the new line character at the end of the text string. |
|
Examples
This example shows how to display a blank line at the command prompt:
This example shows how to display a line of text at the command prompt:
This example shows how to use a formatting option in the text string:
Related Commands
|
|
|
|---|---|
end
To exit a configuration mode and return to EXEC mode, use the end command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to return to EXEC mode from global configuration mode:
This example shows how to return to EXEC mode from interface configuration mode:
Related Commands
|
|
|
|---|---|
exec-timeout
To configure the inactive session timeout on the console port or the virtual terminal, use the exec-timeout command. To revert to the default, use the no form of this command.
Syntax Description
Number of minutes. The range is from 0 to 525600. A setting of 0 minutes disables the timeout. |
Defaults
Command Modes
Console port configuration mode
Line configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
Use the exec-timeout command only in the default virtual device context (VDC).
You can configure the console ports only from a session on the console port.
Examples
This example shows how to configure the inactive session timeout for the console port:
This example shows how to configure the inactive session timeout for the virtual terminal:
This example shows how to revert to the default inactive session timeout for the console port:
This example shows how to revert to the default inactive session timeout for the virtual terminal:
Related Commands
|
|
|
|---|---|
exit
To exit a configuration mode and return to the previous configuration mode, use the exit command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to return to EXEC mode from global configuration mode:
This example shows how to return to global configuration mode from interface configuration mode:
Related Commands
|
|
|
|---|---|
fault-management auto-capture
To enable the auto-capture feature, use the fault-management auto-capture command. To disable this feature, use the no form of this command.
no fault-management auto-capture
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to enable the fault-management auto-capture feature:
Related Commands
|
|
|
|---|---|
fault-management yaml reconfigure
To program the system YAML file incrementally, use the fault-management yaml reconfigure command. To restore the default YAML file, use the no form of this command.
fault-management yaml reconfigure
no fault-management yaml reconfigure
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can program a custom YAML file. Use the fault-management yaml reconfigure command to program the system YAML file incrementally.
Examples
This example shows how to create a flow record and enter flow record configuration mode:
Related Commands
|
|
|
|---|---|
feature pong
To enable the Pong feature, use the feature pong command. To disable the Pong feature, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable the Pong feature:
Related Commands
feature-set
To enable a feature set on a virtual device context (VDC), use the feature-set command. To disable a feature set on a VDC, use the no form of this command.
feature-set [ fcoe | fex | l2mp ]
no feature-set [ fcoe | fex | l2mp ]
Syntax Description
Defaults
Command Modes
network-admin
network-operator
vdc-admin
vdc-operator
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable a feature set on a VDC:
This example shows how to disable a feature set on a VDC:
Related Commands
|
|
|
|---|---|
Allows a virtual device context (VDC) to enable a feature set. |
|
find
To find filenames beginning with a character string, use the find command.
Syntax Description
First part or all of a filename. The filename prefix is a case sensitive, alphanumeric string with a maximum of 64 characters. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The find command searches all subdirectories under the current working directory. Use the cd and pwd commands to navigate to the starting directory.
Examples
This example shows how to display filenames beginning with ospf:
Related Commands
|
|
|
|---|---|
flowcontrol hardware
To enable flow control on the COM1 port, use the flowcontrol hardware command. To disable flow control, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the flowcontrol hardware command only in the default virtual device context (VDC).
You can configure the COM1 ports only from a session on the console port or COM1 port.
Examples
This example shows how to enable flow control for the COM1 port:
This example shows how to disable flow control for the COM1 port:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 port and console port configuration. |
format
To format an external Flash device to erase the contents and restore it to its factory-shipped state, use the format command.
Syntax Description
Name of the file system. The valid values are slot0, usb1, or usb2. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use this command only in the default virtual device context (VDC).
Note
For information about formatting and recovering a corrupted bootflash, see the Cisco Nexus 7000 Series NX-OS Troubleshooting Guide.
Examples
This example shows how to format an external Flash device:
Related Commands
|
|
|
|---|---|
gunzip
To uncompress a compressed file, use the gunzip command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The compressed filename must have the.gz extension. You do not have to enter the.gz extension as part of the filename.
The Cisco NX-OS software uses Lempel-Ziv 1977 (LZ77) coding for compression.
Examples
This example shows how to uncompress a compressed file:
Related Commands
|
|
|
|---|---|
gzip
To compress a file, use the gzip command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
After you use this command, the file is replaced with the compressed filename that has the.gz extension.
The Cisco NX-OS software uses Lempel-Ziv 1977 (LZ77) coding for compression.
Examples
This example shows how to compress a file:
Related Commands
|
|
|
|---|---|
hostname
To configure the hostname for the device, use the hostname command. To revert to the default, use the no form of this command.
Syntax Description
Name for the device. The name is alphanumeric, case sensitive, can contain special characters, and can have a maximum of 63 characters. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
This command was modified. The character limit of a hostname is increased from 32 to 63 alphanumeric characters. |
|
Usage Guidelines
The Cisco NX-OS software uses the hostname in command-line interface (CLI) prompts and in default configuration filenames.
The hostname command performs the same function as the switchname command.
Examples
This example shows how to configure the device hostname:
This example shows how to revert to the default device hostname:
Related Commands
|
|
|
|---|---|
install all
To install the kickstart and system images on your Cisco NX-OS device, use the install all command.
install all
[ kickstart { bootflash: | ftp: [ // server ][ / path ] | scp: [ // [ username @ ] server ][ / path ] | sftp: [ // [ username @ ] server ][ / path ] | slot0: | tftp: [ // server [ : port ]][ / path ] | volatile: } kickstart-filename ]
[ system { bootflash: | ftp: [ // server ][ / path ] | scp: [ // [ username @ ] server ][ / path ] | sftp: [ // [ username @ ] server ][ / path ] | slot0: | tftp: [ // server [ : port ]][ / path ] | volatile: } system-filename ]
Syntax Description
(Optional) Server IPv4 address or name. The name is case sensitive. |
|
(Optional) Username on the server. The name is case sensitive. |
|
Name of the kickstart image file. The name is case sensitive. |
|
Defaults
If you do not enter any parameters, the boot variable values are used.
Command Modes
Command History
|
|
|
Usage Guidelines
If you do not enter the information about the server or username when downloading and installing the image files from a remote server, you will be prompted for the information.
This command sets the kickstart and system boot variables and copies the image files to the redundant supervisor module.
You can use the install all command to downgrade the Cisco NX-OS software on the device. To determine the incompatibility of the downgrade Cisco NX-OS software with the current Cisco NX-OS configuration on the device, use the show incompatibility system command.
This command installs Cisco NX-OS software only on devices with dual supervisor modules. To install new Cisco NX-OS software on a device with a single supervisor, you must use the reload command to boot the system after you use the install all command. For information on upgrading and downgrading images on your Cisco NX-OS device, see the Cisco Nexus 7000 Series NX-OS Software Upgrade and Downgrade Guide, Release 6.x.
The install all command does not install electronically programmable logical device (EPLD) images.
Examples
This example shows how to install the Cisco NX-OS software from the bootflash: directory:
This example shows how to install the Cisco NX-OS software using the values configured in the kickstart and system boot variables:
This example shows how to install the Cisco NX-OS software from an SCP server:
Related Commands
|
|
|
|---|---|
Displays configuration incompatibilities between Cisco NX-OS system software images. |
|
install all epld
To upgrade the electronic programmable logical device (EPLD) image, use the install all epld command.
install all epld [ bootflash : epld-image-name | slot0 : epld-image-name | volatile : epld-image-name ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Follow these guidelines when you upgrade or downgrade the EPLD:
- You can perform an upgrade from the active supervisor module only. All the modules, including the active supervisor module, can be updated individually.
- You can individually update each module whether it is online or offline as follows:
–
If you upgrade EPLD images on an online module, only the EPLD images with version numbers that differ from the new EPLD images are upgraded.
–
If you upgrade EPLD images on an offline module, all of the EPLD images are upgraded.
- On a switch that has two supervisor modules, upgrade the EPLDs for the standby supervisor and then switch the active supervisor to standby mode to upgrade its EPLDs (the supervisor switchover is not disruptive to traffic on Cisco Nexus 7000 switches). On a switch that has only one supervisor module, you can upgrade the active supervisor, but this will disrupt its operations during the upgrade.
- If you interrupt an upgrade, you must upgrade the module that is being upgraded again.
- The upgrade process disrupts traffic on the targeted module.
- Do not insert or remove any modules while an EPLD upgrade is in progress.
Examples
This example shows how to upgrade a Cisco NX-OS EPLD image:
Related Commands
|
|
|
|---|---|
Installs the kickstart and system images on the Cisco NX-OS device. |
|
Displays configuration incompatibilities between Cisco NX-OS system software images. |
|
install all parallel
To upgrade the line cards in the system concurrently, use the install all parallel command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You can upgrade up to three line cards concurrently by using the install all parallel command.
The parallel install all parallel is supported only when you are upgrading from Cisco NX-OS Release 5.2 to a later release.
Examples
This example shows how to upgrade the line cards in the system concurrently:
Related Commands
|
|
|
|---|---|
Displays configuration incompatibilities between Cisco NX-OS system software images. |
install fan-module epld
To install an electronically programmable logical device (EPLD) image on a fan module, use the install fan-module epld command.
install fan-module slot epld { bootflash: | slot0: | volatile: } filename
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You must copy the EPLD image file to local storage before you can install it.
Enter the install fan-module epld command from the active supervisor module to update any other module.
Use the show version fan slot epld command to display the EPLD version for a fan module.
Examples
This example shows how to install an EPLD image on a module:
Related Commands
|
|
|
|---|---|
install feature-set
To install a feature set on a module, use the install feature-set command. To uninstall a feature set from a module, use the no form of this command.
install feature-set [fcoe | fex | l2mp]
no install feature-set [fcoe | fex | l2mp]
Syntax Description
Defaults
Command Modes
network-admin
network-operator
vdc-admin
vdc-operator
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to install a feature set:
This example shows how to uninstall a feature set:
Related Commands
|
|
|
|---|---|
install license
To install a license, use the install license command.
install license { bootflash: | slot0: | usb0: | usb1: } src-filename [ target-filename ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
If a target filename is provided after the source location, the license file is installed with that name. Otherwise, the filename in the source uniform resource locator (URL) is used. This command also verifies the license file before installing it.
For information on installing licenses on your Cisco NX-OS device, see the Cisco NX-OS Licensing Guide.
Examples
This example shows how to install a file named “license-file” that resides in the bootflash: directory:
Related Commands
|
|
|
|---|---|
install module epld
To install an electronically programmable logical device (EPLD) image on an I/O module, use the install module epld command.
install module slot epld { bootflash: | slot0: | volatile: } filename
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You must copy the EPLD image file to local storage before you can install it.
Enter the install module epld command from the active supervisor module to update any other module.
Use the show version module slot epld command to display the EPLD version for a fabric module.
Examples
This example shows how to install an EPLD image on a fabric module:
Related Commands
|
|
|
|---|---|
install xbar-module epld
To install an electronically programmable logical device (EPLD) image on a fabric module, use the install xbar-module epld command.
install xbar-module slot epld { bootflash: | slot0: | volatile: } filename
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You must copy the EPLD image file to local storage before you can install it.
Enter the install xbar-module epld command from the active supervisor module to update any other module.
Use the show version xbar slot epld command to display the EPLD version for an I/O module.
Examples
This example shows how to install an EPLD image on an I/O module:
Related Commands
|
|
|
|---|---|
install xbar-module epld
To install an electronically programmable logical device (EPLD) image on a fabric module, use the install xbar-module epld command.
install xbar-module slot epld { bootflash: | slot0: | volatile: } filename
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You must copy the EPLD image file to local storage before you can install it.
Enter the install xbar-module epld command from the active supervisor module to update any other module.
Use the show version xbar slot epld command to display the EPLD version for an I/O module.
Examples
This example shows how to install an EPLD image on an I/O module:
Related Commands
|
|
|
|---|---|
license smart conversion start1
To manually convert a traditional license to a smart license, use the license smart conversion start command in Privileged EXEC mode.
license smart conversion start
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to convert a traditional license to smart license using the command line interface:
Related Commands
|
|
|
|---|---|
license smart conversion stop1
To stop a manual conversion of a traditional license to a smart license, use the license smart conversion stop command in Privileged EXEC mode.
license smart conversion start
Syntax Descriptionlicense smart conversion start
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to stop a manual conversion of a traditional license to a smart license using the command line interface:
Related Commands
|
|
|
|---|---|
line com1
To specify the COM1 port and enter COM1 port configuration mode, use the line com1 command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can configure the COM1 line from a console port session or a COM1 port session.
Examples
This example shows how to enter COM1 port configuration mode:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 port and console port configuration. |
line console
To specify the console port and enter console port configuration mode, use the line console command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the line console command only in the default virtual device context (VDC).
You can configure the console line only from a console port session.
Examples
This example shows how to enter console port configuration mode:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 port and console port configuration. |
line vty
To specify the virtual terminal and enter line configuration mode, use the line vty command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to enter the line configuration mode:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 port and console port configuration. |
load
To load either a image file or debug plugin, use the load command.
Syntax Description
Storage device and filename of the image file or debug plugin. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the load command to load either a image file or debug plugin. You can use the load command in boot-up configuration mode to load the image file. Similarly, you can use the load command to load the debug plugin in the EXEC mode.
Examples
The following example shows how to load the debug plugin on the Nexus platform.
The following example shows how to load a system image on the Nexus platform.
modem connect line
To notify the Cisco NX-OS device that you connected a modem, use the modem connect line command.
modem connect line { com1 | console }
Syntax Description
Specifies that you have connected the modem to the COM1 port. |
|
Specifies that you have connected the modem to the console port. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the modem connect line command only in the default virtual device context (VDC).
Examples
This example shows how to notify the device that you have connected a modem to the COM1 port:
This example shows how to notify the device that you have connected a modem to the console port:
Related Commands
|
|
|
|---|---|
Enables the modem connection on the COM1 port or console port. |
|
Displays information about the COM1 and console port configuration. |
modem in
To enable the modem connection on the COM1 or console port, use the modem in command. To disable the modem connection, use the no form of this command.
Syntax Description
Defaults
Command Modes
COM1 port configuration mode
Console port configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the modem in command only in the default virtual device context (VDC).
You can configure the console and COM1 ports only from a session on the console port.
Examples
This example shows how to enable a modem connection on the COM1 port:
This example shows how to enable a modem connection on the console port:
This example shows how to disable a modem connection on the console port:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 and console port configuration. |
modem init-string
To download the initialization string to a modem connected to the COM1 or console port, use the modem init-string command. To revert to the default, use the no form of this command.
modem init-string { default | user-input }
Syntax Description
Defaults
Command Modes
COM1 port configuration mode
Console port configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the modem init-string command only in the default virtual device context (VDC).
You can configure the console and COM1 ports only from a session on the console port.
The default initialization string ATE0Q1&D2&C1S0=1\015 is defined as follows:
- AT—Attention
- E0 (required)—No echo
- Q1—Result code on
- &D2—Normal data terminal ready (DTR) option
- &C1—Enable tracking the state of the data carrier
- S0=1—Pick up after one ring
- \015 (required)—Carriage return in octal
Use the modem set-string command to configure the user-input initialization string.
Examples
This example shows how to download the default initialization string to the modem connected to the COM1 port:
This example shows how to download the default initialization string to the modem connected to the console port:
This example shows how to download the user-input initialization string to the modem connected to the COM1 port:
This example shows how to download the user-input initialization string to the modem connected to the console port:
This example shows how to revert to the default initialization string for the modem connected to the COM1 port:
This example shows how to revert to the default initialization string for the modem connected to the console port:
Related Commands
|
|
|
|---|---|
Configures the user-input initialization string for a modem. |
|
Displays information about the COM1 and console port configuration. |
modem restart line
To restart a modem connection on the COM1 port or console port, use the modem restart line command.
modem restart line { com1 | console }
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the modem restart line command only in the default virtual device context (VDC).
Examples
This example shows how to restart a modem connected to the COM1 port:
This example shows how to restart a modem connected to the console port:
Related Commands
|
|
|
|---|---|
Enables the modem connection on the COM1 port or console port. |
|
Displays information about the COM1 and console port configuration. |
modem set-string user-input
To configure the user-input initialization string to download to a modem connected to the COM1 or console port, use the modem set-string user-input command. To revert to the default, use the no form of this command.
modem set-string user-input string
Syntax Description
User-input string. This string is alphanumeric and case sensitive, can contain special characters, and has a maximum of 100 characters. |
Defaults
Command Modes
COM1 port configuration mode
Console port configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the modem set-string user-input command only in the default virtual device context (VDC).
You can configure the console and COM1 ports only from a session on the console port.
Examples
This example shows how to configure the user-input initialization string for the modem connected to the COM1 port:
This example shows how to configure the user-input initialization string for the modem connected to the console port:
This example shows how to revert to the default user-input initialization string for the modem connected to the COM1 port:
This example shows how to revert to the default user-input initialization string for the modem connected to the console port:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 and console port configuration. |
move
To move a file from one directory to another, use the move command.
move [ filesystem : [ // module / ][ directory / ] | directory /] source-filename {{ filesystem :[ // module /][ directory / ] | directory / }[ destination-filename ] | target-filename }
Syntax Description
Defaults
The default name for the destination file is the same as the source filename.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can make a copy of a file by using the copy command.
Tip
You can rename a file by moving it within the same directory.
Examples
This example shows how to move a file to another directory:
This example shows how to move a file to another file system:
This example shows how to move a file to another supervisor module:
Related Commands
|
|
|
|---|---|
parity
To configure the parity for the COM1 port or console port, use the parity command. To revert to the default, use the no form of this command.
no parity { even | none | odd }
Syntax Description
Defaults
Command Modes
COM1 port configuration mode
Console port configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the parity command only in the default virtual device context (VDC).
You can configure the console and COM1 ports only from a session on the console port.
Examples
This example shows how to configure the parity for the COM1 port:
This example shows how to configure the parity for the console port:
This example shows how to revert to the default parity for the COM1 port:
This example shows how to revert to the default parity for the console port:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 port and console port configuration. |
ping
To determine the network connectivity to another device using IPv4 addressing, use the ping command.
ping { dest-ipv4-address | hostname } [ count { number | unlimited }] [ df-bit ] [ interval seconds ] [ packet-size bytes ] [ source src-ipv4-address ] [ timeout seconds ] [ vrf vrf-name ]
Syntax Description
Defaults
For the default values, see the “Syntax Description” section for this command.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To determine the network connectivity to another device using IPv6 addressing, use the ping6 command.
Examples
This example shows how to determine connectivity to another device using IPv4 addressing:
Related Commands
|
|
|
|---|---|
Determines connectivity to another device using IPv6 addressing. |
ping6
To determine the network connectivity to another device using IPv6 addressing, use the ping6 command.
ping6 { dest-ipv6-address | hostname } [ count { number | unlimited }] [ interface intf-id ] [ interval seconds ] [ packet-size bytes ] [ source ipv6-address ] [ timeout seconds ] [ vrf vrf-name ]
Syntax Description
Defaults
For the default values, see the “Syntax Description” section for this command.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To determine the network connectivity to another device using IPv4 addressing, use the ping command.
Examples
This example shows how to determine connectivity to another device using IPv6 addressing:
Related Commands
|
|
|
|---|---|
Determines connectivity to another device using IPv4 addressing. |
pong
To start the pong service on the current virtual device context (VDC), use the pong command.
pong {source mac destination mac} vlan vlan-id count numbers cos | details | inject | interface interface-id | interval seconds | timeout seconds ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows the Pong service between FabricPath switch-ids:
This example shows the Pong service using static MAC for injection:
This example shows the CE Pong with source MAC specified:
Related Commands
|
|
|
|---|---|
Enables the Precision Time Protocol (PTP) feature. This command is documented in the Cisco Nexus 7000 Series NX-OS System Management Command Reference. |
pop
To restore a saved command mode context, use the pop command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to restore an unnamed command mode context:
This example shows how to restore a named command mode context:
Related Commands
|
|
|
|---|---|
power redundancy-mode
To configure the power supply redundancy mode, use the power redundancy-mode command. To revert to the default, use the no form of this command.
power redundancy-mode { combined | insrc-redundant | ps-redundant | redundant }
no power redundancy-mode { combined | insrc-redundant | ps-redundant | redundant }
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the power redundancy-mode command only in the default virtual device context (VDC).
You can configure the power supplies with the following modes:
- Combined mode—This is the simplest power mode, but it does not provide power redundancy. The available power for this mode is the total power capacity of all power supplies.
- Power supply redundancy mode—This mode provides an extra power supply in case an active power supply goes down. With this mode, the power supply that can supply the most power operates in the standby mode. The other one or two power supplies are active. The available power is the amount of power provided by the active power supply units.
- Input source redundancy mode—This mode uses two electrical grids, each one powering a half module within each power supply. If one power grid goes down, each power supply continues to draw power through its other half module. The available power is the amount of power by the lesser of the two grids through the power supplies.
- Full redundancy mode—This mode combines power supply redundancy and input source redundancy, which means that the chassis has an extra power supply and each half of each power supply is connected to one electrical grid while the other half of each power supply is connected to the other electrical grid. The available power is the lesser of the available power for the power supply mode and input source mode.
Examples
This example shows how to configure the full power supply redundancy mode:
This example shows how to disable the full power supply redundancy mode:
Related Commands
|
|
|
|---|---|
purge module running-config
To remove the configuration for a missing module from the running configuration, use the purge module running-config command.
purge module slot running-config
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the purge module running-config command only in the default virtual device context (VDC).
Use the show hardware command to verify which modules are missing.
Examples
This example shows how to remove the configuration for a missing module from the running configuration:
Related Commands
|
|
|
|---|---|
push
To save a command mode context, use the push command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can save only one command mode context. Use the pop command to restore a saved command mode context.
Examples
This example shows how to save an unnamed command mode context:
This example shows how to save a named command mode context:
Related Commands
|
|
|
|---|---|
python
To invoke the Python Interpreter in interactive mode from the CLI, use the python command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To run CLI commands in Python, you must import the cisco module. The cisco module contains the code that integrates with the command-line interface (CLI).
The functions contained in the cisco module that enable the CLI commands are imported automatically when you use the python command to invoke the Python interactive mode (or when you use the source command when invoking the Python noninteractive mode).
The Python programming language has three APIs that can execute CLI commands. See the Cisco Nexus 7000 Series NX-OS Fundamentals Configuration Guide, Release 6.x for a list of CLI commands.
Examples
This example shows how to invoke Python from the CLI:
Note
The Python interpreter is designated with the ">>>" or "..." prompt.
Python is forked from the CLI shell, which means the following::
- No state is preserved between invocations of the Python interpreter.
- The CLI mode is lost when exiting the Python interpreter.
This example shows the nonpersistence of the Python interpreter:
switch# python !-- Invoke Python interpreter
Related Commands
|
|
|
|---|---|
reload
To reload the entire Cisco NX-OS device, use the reload command.
Syntax Description
(Optional) Specifies to not reload the Connectivity Management Processor (CMP) on the active supervisor module. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the reload command only in the default virtual device context (VDC).
The reload command uses the kickstart and system images referenced in the boot variables to reboot the device. Use the show boot command to verify the contents of the kickstart and system boot variables. To set the boot variables to reference the correct images, use the boot kickstart and boot system commands.
If the boot variables do not reference images on the device, the device comes up at the loader> prompt after you enter the reload command. For information about recovering from the loader> prompt, see the Cisco Nexus 7000 Series NX-OS Troubleshooting Guide.
Note
The reload command does not save the running configuration. Use the copy running-config startup-config command to save the current configuration on the device.
For information on upgrading and downgrading images on your Cisco NX-OS device, see the Cisco Nexus 7000 Series NX-OS Software Upgrade and Downgrade Guide, Release 6.x.
Examples
This example shows how to reload the Cisco NX-OS device:
Related Commands
reload ascii
To copy an ASCII version of the configuration to the startup configuration when reloading the entire Cisco NX-OS device, use the reload ascii command.
Syntax Description
Defaults
Reloads the entire device, including any unsaved configurations and binary configuration in the VDC.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The reload ascii command erases the binary configuration in the VDC and reboots the system with an ASCII configuration.
Note
The reload ascii command does not save the running configuration. Use the copy running-config startup-config command to save the current configuration on the device.
Examples
This example shows how to copy an ASCII version of the configuration to the startup configuration when reloading the entire Cisco NX-OS device :
Related Commands
|
|
|
|---|---|
Copies the current running configuration to the startup configuration. |
|
reload cmp module
To reload the Connectivity Management Processor (CMP), use the reload cmp module command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the reload cmp module command only in the default virtual device context (VDC).
Use the show hardware command to determine the location of the CMPs on your device.
Examples
This example shows how to reload the CMP on the supervisor module on a slot:
Related Commands
|
|
|
|---|---|
Copies an ASCII version of the configuration to the startup configuration when reloading the entire Cisco NX-OS device. |
|
reload module
To reload a module in the device, use the reload module command.
reload module slot [ force-dnld ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the reload module command only in the default virtual device context (VDC).
Use the show hardware command to display information about the hardware on your device.
Examples
This example shows how to reload a module:
Related Commands
|
|
|
|---|---|
Copies an ASCII version of the configuration to the startup configuration when reloading the entire Cisco NX-OS device. |
|
reload vdc
To reload a nondefault virtual device context (VDC), use the reload vdc command.
Syntax Description
Defaults
Command Modes
Any command mode in a nondefault VDC
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the reload vdc command only in the default virtual device context (VDC). Use the
reload vdc ? command to view all VDCs.
Note
Use the reload command to reload the default VDC, which also reloads all nondefault VDCs.
Examples
This example shows how to restard a VDC:
Related Commands
|
|
|
Copies an ASCII version of the configuration to the startup configuration when reloading the entire Cisco NX-OS device. |
|
rmdir
To remove a directory, use the rmdir command.
rmdir [ filesystem : [ // module / ]] directory
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to remove a directory:
Related Commands
|
|
|
|---|---|
run-script
To run a command script file at the command-line interface (CLI), use the run-script command.
run-script [ filesystem : [ // module / ]][ directory / ] filename
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must create the command file on a remote device and download it to the Cisco NX-OS device by using the copy command.
Examples
This example shows how to run a command script file:
Related Commands
|
|
|
|---|---|
send
To send a message to the active user sessions, use the send command.
Syntax Description
Text string. The text string can be up to 80 alphanumeric characters and is case sensitive. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the show users command to display information about the active user sessions.
Examples
This example shows how to send a message to all active user sessions on the device:
This example shows how to send a message to a specific user session:
Related Commands
|
|
|
|---|---|
setup
To enter the basic device setup dialog, use the setup command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
When you use the setup command to change your device configuration, the setup utility uses the factory-default values, not the values that you have configured, when you accept the default values in the dialog.
You can exit the setup utility dialog at any time by pressing Ctrl+C.
Examples
This example shows how to enter the basic device setup script:
Related Commands
|
|
|
|---|---|
session-limit
To configure the maximum number of the concurrent virtual terminal sessions on a device, use the session-limit command. To revert to the default, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to configure the maximum number of concurrent virtual terminal sessions:
This example shows how to revert to the default maximum number of concurrent virtual terminal sessions:
Related Commands
|
|
|
|---|---|
show banner exec
To display the EXEC banner, use the show banner exec command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the EXEC banner:
Related Commands
|
|
|
|---|---|
show banner motd
To display the message-of-the-day (MOTD) banner, use the show banner motd command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the MOTD banner:
Related Commands
|
|
|
|---|---|
show boot
To display the boot variable configuration, use the show boot command.
show boot [ auto-copy | module [ slot ] | sup-1 | sup-2 | variables ]
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Sup-1 refers to the top supervisor module in a chassis with two supervisor modules, and sup-2 refers to the bottom supervisor module. For example, in the Cisco NX-OS 7010 device, sup-1 is in slot 5, and sup-2 is in slot 6.
Examples
This example shows how to display all configured boot variables:
This example shows how to display the boot variables for supervisor module 1:
This example shows how to display the list of boot variable names (see Table 5 for field descriptions):
|
|
|
|---|---|
Related Commands
|
|
|
|---|---|
Enables automatic copy of boot images to the standby supervisor module. |
|
show cli alias
To display the command alias configuration, use the show cli alias command.
show cli alias [ name alias-name ]
Syntax Description
(Optional) Specifies the name of a command alias. The alias name is not case sensitive and it can be up to 30 characters. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display all configured command aliases:
This example shows how to display a specific command alias:
Related Commands
|
|
|
|---|---|
show cli history
To display the command history, use the show cli history command.
show cli history [ lines ] [ unformatted ]
Syntax Description
(Optional) Number of lines at the end of the command history to display. |
|
(Optional) Displays the commands without line numbers or time stamps. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display all of the command history:
This example shows how to display the last 10 lines of the command history:
This example shows how to display unformatted command history:
show cli list
To list the Cisco NX-OS commands available in a command mode, use the show cli list command.
show cli list [ combinations ] [ component-name ] [ recurse ]
Syntax Description
Defaults
Displays the commands for the command mode in a single-line format.
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
To exit a long listing generated by this command, press Ctrl-C.
Examples
This example shows how to display all commands available in EXEC mode:
This example shows how to display all commands related to the Address Resolution Protocol (ARP) available in configuration command mode:
This example shows how to display commands related to Open Shortest Path First (OSPF) available in the loopback interface command mode:
Related Commands
|
|
|
|---|---|
Displays the Cisco NX-OS command syntax available in a command mode. |
show cli syntax
To display the Cisco NX-OS command syntax available in a command mode, use the show cli syntax command.
show cli syntax [ component-name ] [ long ] [ mode mode-name ] [ recurse ]
Syntax Description
Defaults
Displays the command syntax for the command mode in a single-line format.
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the command syntax for commands available in the role configuration command mode in the default format:
This example shows how to display the command syntax for commands available in the role configuration command mode in long format:
This example shows how to display the command syntax for commands and subcommands available in the role configuration command mode in the default format:
show cli variables
To display the configuration of the CLI variables, use the show cli variables command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the CLI variables:
Related Commands
|
|
|
|---|---|
show clock
To display the clock configuration, use the show clock command.
Syntax Description
(Optional) Displays the summer-time (daylight saving time) offset configuration. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the clock setting:
This example shows how to display the clock setting and the summer-time (daylight saving time) configuration:
Related Commands
|
|
|
|---|---|
show copyright
To display the Cisco NX-OS software copyright information, use the show copyright command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the Cisco NX-OS copyright information:
show feature-set
To display the status of a feature set, use the show feature-set command.
Syntax Description
Defaults
Command Modes
network-admin
network-operator
vdc-admin
vdc-operator
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the status of a feature set:
Related Commands
|
|
|
|---|---|
Displays information related to the operation of the install all command. |
show file
To display the contents of a file on the local memory, use the show file command.
show file [ filesystem : ][ // directory / ] filename
Syntax Description
(Optional) Name of a file system. Valid values are bootflash, debug, logflash, slot0, usb1, usb2,or volatile. |
|
(Optional) Name of a directory. The directory name is case sensitive. |
|
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the contents of a file:
Related Commands
|
|
|
|---|---|
show hostname
To display the hostname for the device, use the show hostname command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
The show switchname command also displays the device hostname.
Examples
This example shows how to display the hostname for the device:
Related Commands
|
|
|
|---|---|
show incompatibility system
To display the configuration incompatibilities between the running system image and an earlier system image prior to downgrading the Cisco NX-OS software, use the show incompatibility system command.
show incompatibility system { bootflash: | slot0: | volatile: } filename
Syntax Description
System image filename to compare with the loaded software image. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the show incompatibility system command only in the default virtual device context (VDC).
Examples
This example shows how to display the configuration incompatibilities:
show install all
To display information related to the operation of the install all command, use the show install all command.
show install all { failed-standby | failure-reason | impact [ kickstart | system ] | status }
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the show install all command only in the default virtual device context (VDC).
Examples
This example shows how to display the installation failure reason:
This example shows how to display the impact of installing new images:
This example shows how to display the status of a software installation:
Related Commands
|
|
|
|---|---|
Clears the software installation failure log for the standby supervisor module. |
|
show license
To display license information, use the show license command.
show license [ brief | file filename ]
Syntax Description
(Optional) Displays a list of license files installed on a device. |
|
(Optional) Displays information for a specific license file. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display a specific license installed on a device:
This example shows how to display a list of license files installed on a device:
This example shows how to display all licenses installed on a device:
show license feature package mapping
To display license information of the packages that are available for the features on a Cisco NX-OS device, use the show license feature package mapping command.
show license feature package mapping
Syntax Description
Defaults
Command Modes
network-admin
network-operator
vdc-admin
vdc-operator
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display license information about the packages that are available for the features:
Related Commands
|
|
|
|---|---|
show license host-id
To display the serial number for the chassis to use for licensing, use the show license host-id command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
The serial number is the entire string that appears after the colon (:).
Examples
This example shows how to display the host ID, which is required to request node-locked licenses:
show license usage
To display license usage information, use the show license usage command.
show license usage [ vdc-all ] [ LAN_ADVANCED_SERVICES_PKG | LAN_ENTERPRISE_SERVICES_PKG ]
Syntax Description
(Optional) Displays a list of licensed features in use for the Advanced Services license package. |
|
(Optional) Displays a list of licensed features in use for the Enterprise Services license package. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display information about the current license usage for the local VDC:
Note
Starting from Cisco NX-OS Release 8.2(4), the grace period feature is not supported on Cisco Nexus 7000 Series switches.
Table 6 describes the significant fields shown in the display.
This example shows how to display a list of features in use for a specific license:
This example shows how to display a list of features in use for a specific license for all VDCs:
Note
The “@2” characters after the feature name in the command output indicate that the feature is enabled in VDC 2. Use the show vdc command to display the VDC name and identifier information.
Starting from Cisco NX-OS Release 8.2(4), Honor mode licensing is supported. This example displays how to show the time elapsed since honor-mode licensing is enabled for a package:
Count
show line
To display COM1 and console port configuration information, use the show line command.
Syntax Description
(Optional) Displays only information about the COM1 port configuration. |
|
(Optional) Displays only information about the console port configuration. |
Defaults
Displays information about the COM1 port and the console port configuration.
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display information about the console port and COM1 port configuration:
This example shows how to display only information about the console port configuration:
Related Commands
|
|
|
|---|---|
show running-config
To display the running configuration, use the show running-config command.
show running-config [ all | exclude component-list ]
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the context-sensitive command-line interface (CLI) help to display the list of valid component names.
Examples
This example shows how to display the changes that you have made to the running configuration:
This example shows how to display the entire running configuration, including the default values:
This example shows how to exclude the ACL manager and Control Plane Policing (CoPP) components from the command output:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup configuration. |
|
Displays the differences between the running configuration and the startup configuration. |
|
show running-config diff
To display the differences between the running configuration and the startup configuration, use the show running-config diff command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Table 7 describes the notations used in the command output.
Examples
This example shows how to display the difference between the running configuration and the startup configuration:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup configuration. |
|
show startup-config
To display the startup configuration, use the show startup-config command.
show startup-config [ exclude component-list ]
Syntax Description
(Optional) Removes the components from the command output. The component-list argument is a space-separated list and can contain a maximum of four component names. |
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the context-sensitive command-line interface (CLI) help to display the list of valid component names.
Examples
This example shows how to display the startup configuration:
This example shows how to exclude the ACL manager and Control Plane Policing (CoPP) components from the command output:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup configuration. |
|
Displays the differences between the running configuration and the startup configuration. |
show switchname
To display the hostname for the device, use the show switchname command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
The show hostname command also displays the device hostname.
Examples
This example shows how to display the hostname for the device:
Related Commands
|
|
|
|---|---|
show system internal dir
To display the temporary (tmp) directory files in the file system, use the show system internal dir command.
show system internal dir dir-path
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Use the show system internal dir /var/tmp command to check which files are in the tmp directory.
Examples
This example shows how to display the files in the tmp directory:
Related Commands
|
|
|
|---|---|
show system statistics mts
To display the MTS statistics, use the show system statistics mts command.
show system statistics mts sap { sap-number | all } { brief | module | receive | transmit } { us | ms | detail } [ sort { ascending | descending } by { last-time | max-time | avg-time | count }]
Syntax Description
Specifies to add all the modules to be included for MTS statistics. |
|
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to display the MTS statistics:
Related Commands
|
|
|
|---|---|
show tech-support
To display information about Cisco technical support, use the show tech-support command.
show tech-support [ brief | commands | details | feature ]
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
The output from the show tech-support command is very long. To better manage this output, you can redirect the output to a file (for example, show tech-support > bootflash: filename).
If you need to contact your customer support representative or Cisco TAC to resolve an issue, use the show tech-support details command to collect system information and configuration details. Redirect the output of the show tech-support details command to a file using the tac-pac command.
Examples
This example shows how to display technical support information and redirect it to a file:
This example shows how to display the brief technical support information for the device:
This example shows how to display the technical support information for a feature:
This example shows how to display the commands to generate the technical support information:
Related Commands
|
|
|
|---|---|
show terminal
To display information about the terminal configuration for a session, use the show terminal command.
Syntax Description
Defaults
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display information about the terminal configuration for a session:
Related Commands
|
|
|
|---|---|
Configures the terminal inactive session timeout for a session. |
|
show time-stamp running-config last-changed
To display the time stamp on when the running configuration was last changed, use the show time-stamp running-config last-changed command.
show time-stamp running-config last-changed
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows the display after a normal reload when there is no change in running configuration:
This example shows the display of time stamp after making some changes in running configuration:
This example shows the display of show running-configuration command that shows information about the last changed configuration.
This example shows the display of time stamp after a configuration:
Related Commands
|
|
|
|---|---|
Displays the differences between the running configuration and the startup configuration. |
|
show version
To display information about the software version, use the show version command.
show version [ build-info [ all ] | epld filename | fan fan-number epld | image filename | module slot [ epld ] | xbar xbar-number epld ]
Syntax Description
Defaults
Displays software version information for the running kickstart and system images.
Command Modes
network-admin
vdc-admin
network-operator
vdc-operator
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the version information for the kickstart and system images running on the device:
This example shows how to display the version information for an image file:
This example shows how to display the version information for an I/O module:
This example shows how to display the version information for the EPLD images on an I/O module:
This example shows how to display the version information for the EPLD images on a fabric module:
sleep
To cause the command-line interface (CLI) to pause before displaying the prompt, use the sleep command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the sleep command scripts to delay the execution of the script.
Examples
This example shows how to cause the CLI to pause before displaying the prompt:
slot
To issue commands to an I/O module from the supervisor module session, use the slot command.
slot slot-number { command-string | quoted “ command-string ” }
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the slot command instead of starting a session on the I/O module with the attach command.
By default, the keyword and arguments in the command-string argument are separated by a space. To send more than one command to a module, separate the commands with a space character, a semicolon character (;), and a space character.
The quoted keyword indicates that the command string begins and ends with double quotation marks (“ ”). Use this keyword when you want to redirect the module command output to a filtering utility, such as diff, that is supported only on the supervisor module session.
Examples
This example shows how to send commands to an I/O module from the supervisor module session:
This example shows how to send a quoted command to an I/O module from the supervisor module session:
Related Commands
|
|
|
|---|---|
source
To run a tcl/python script, use the source command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Python is operated in noninteractive mode when using the source command. To invoke interactive mode, use the python command.
Examples
This example shows how to invoke a Python script:
This example shows how a script accepts an argument:
Related Commands
|
|
|
|---|---|
sscp
To copy command output to or from Cisco devices securely, use the sscp command.
command | sscp mybox /users/user-name/host-name
Syntax Description
Specifies a command that produces command-line interface (CLI) output. |
|
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must create a Secure Shell (SSH) connection before using the sscp command. You can create an SSH connection by using the ssh name command. Password is specified only once at the time of creation of the ssh-master-connection. So, you do not have to enter the password again.
If the SSH server is running on a Windows system, you must copy the cat.exe file from the binutils of GNU into the Windows path.
Examples
This example shows how to use the Streaming Secure Copy Protocol (SSCP) as the transfer mechanism:
stopbits
To configure the stop bits for the COM1 port or console port, use the stopbits command. To revert to the default, use the no form of this command.
Syntax Description
Defaults
Command Modes
COM1 port configuration mode
Console port configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
You can use the stopbits command only in the default virtual device context (VDC).
You can configure the console and COM1 ports only from a session on the console port.
Examples
This example shows how to configure the number of stop bits for the COM1 port:
This example shows how to configure the number of stop bits for the console port:
This example shows how to revert to the default number of stop bits for the COM1 port:
This example shows how to revert to the default number of stop bits for the console port:
Related Commands
|
|
|
|---|---|
Displays information about the COM1 port and console port configuration. |
switchname
To configure the hostname for the device, use the switchname command. To revert to the default, use the no form of this command.
Syntax Description
Name for the device. The name is alphanumeric, case sensitive, can contain special characters, and can have a maximum of 63 characters. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
This command was modified. The character limit of a switch name is increased from 32 to 63 alphanumeric characters. |
|
Usage Guidelines
The Cisco NX-OS software uses the hostname in command-line interface (CLI) prompts and in default configuration filenames.
The switchname command performs the same function as the hostname command.
Examples
This example shows how to configure the device hostname:
This example shows how to revert to the default device hostname:
Related Commands
|
|
|
|---|---|
system statistics mts
To enable the MTS statistics feature, use the system statistics mts command. To disable the MTS statistics feature, use the no form of this command.
system statistics mts sap sap-number | all [ module module-number ]
no system statistics mts sap sap-number | all [ module module-number ]
Syntax Description
Specifies to add all the modules to be included for MTS statistics. |
|
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to configure the device hostname:
Related Commands
|
|
|
|---|---|
tac-pac
To save system information in a compressed.gz file at a specific location, use the tac-pac command.
tac-pac [bootflash: | ftp: | scp: | sftp: | slot0: | tftp: | volatile:]
Syntax Description
(Optional) Uses Secure Copy Protocol (SCP) to download the file. |
|
(Optional) Uses Secure Shell FTP (SFTP) to download the file. |
|
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the tac-pac command to redirect the output of the show tech-support details command to a file, and then gzip the file.
If you do not specify a filename, Cisco NX-OS creates the file as volatile:show_tech_out.gz.
Examples
This example shows how to save the output of the show tech-support details command to the bootflash:.
Related Commands
|
|
|
|---|---|
tail
To display the last lines of a file, use the tail command.
tail [ filesystem : [ // module / ]][ directory / ] filename lines ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to display the last 10 lines of a file:
This example shows how to display the last 20 lines of a file:
Related Commands
|
|
|
|---|---|
tar append
To append files to a tar archive file, use the tar append command.
tar append { bootflash: | volatile: } archive-filename [ absolute ] [ remove ] [ verbose ] filename-list
Syntax Description
Defaults
Adds the tar.gz extension to the archive filename if you do not enter an extension.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must create an archive file using the tar create command before you can append files to it.
Examples
This example shows how to append two files to the end of an archive file:
This example shows how to append two files to the end of an archive file and display the filenames as they are appended:
This example shows how to append two files to the end of an archive file and remove those files from the device:
Related Commands
|
|
|
|---|---|
tar create
To create a tar archive file, use the tar create command.
tar create { bootflash: | volatile: } archive-filename [ absolute ] [ bz2-compress ] [ gz-compress ] [ remove ] [ uncompressed ] [ verbose ] filename-list
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Added the absolute , bz2-compress , and uncompressed optional keywords. |
|
Usage Guidelines
Examples
This example shows how to create a tar archive file and add two files:
This example shows how to create a tar archive file, add two files, and display the filenames as they are appended:
This example shows how to create a tar archive file, add two files, and remove those files from the device:
Related Commands
|
|
|
|---|---|
tar extract
To extract files from a tar archive file, use the tar extract command.
tar extract { bootflash: | volatile: } archive-filename [ keep-old ] [ screen ] [ to { bootflash: | volatile: } filename ] [ verbose ]
Syntax Description
Defaults
Adds the tar.gz extension to the archive filename if you do not enter an extension.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must create an archive file using the tar create command before you can extract files from it.
Examples
This example shows how to extract files from an archive file:
This example shows how to extract files from an archive file and display the filenames as they are extracted:
Related Commands
|
|
|
|---|---|
tar list
To list the files in a tar archive file, use the tar list command.
tar list { bootflash: | volatile: } archive-filename
Syntax Description
Defaults
Adds the tar.gz extension to the archive filename if you do not enter an extension.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must create an archive file using the tar create command before you can list files.
Examples
This example shows how to list files in an archive file:
Related Commands
|
|
|
|---|---|
terminal alias
To display and define command aliases for the user session, use the terminal alias command. To remove the alias definition, use the no form of this command.
terminal alias [ persist ] [ alias-name alias-definition ]
no terminal alias [ persist ] [ alias-name alias-definition ]
Syntax Description
(Optional) Makes the setting persistent for the current and future sessions for the current user. |
|
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Aliases that you define with the terminal alias command are available only to the current user. Other users cannot use these command aliases. To create aliases that other users can access, use the cli alias name command.
Examples
This example shows how to define a command alias only for the current user session:
This example shows how to define a command alias to persist across sessions for the current user:
This example shows how to display the command aliases available to the current user session:
This example shows how to remove a temporary command alias for the user session:
Related Commands
|
|
|
|---|---|
terminal color
To change the colors used when displaying the commands and output on the command-line interface (CLI) for the user session, use the terminal color command. To revert to the default, use the no form of this command.
Syntax Description
(Optional) Makes the setting persistent for the current and future sessions for the current user. |
Defaults
All CLI prompts, commands, and command outputs display in colors that are defined by the terminal emulator.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The terminal color command changes the CLI colors as follows:
- Displays the command prompt in green if the previous command was successful.
- Displays the command prompt in red if an error occurred in the previous command.
- Displays the command in blue.
- Displays the output in the default color defined by the terminal emulator.
The terminal colors setting applies only to the current user session. Use the persist keyword to change the setting for the current and future sessions for the current user.
Examples
This example shows how to change the terminal display colors for the current user session:
This example shows how to change the terminal display colors for the current and future sessions for the current user:
This example shows how to revert to the default for the current user session:
This example shows how to revert to the default for the current and future sessions for the current user:
terminal dont-ask
To disable confirmation prompts on the command-line interface (CLI), use the terminal dont-ask command. To revert to the default, use the no form of this command.
no terminal dont-ask [ persist ]
Syntax Description
(Optional) Makes the setting persistent for the current and future sessions for the current user. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The terminal confirmation prompt setting applies only to the current user session. Use the persist keyword to change the setting for the current and future sessions for the current user.
Examples
This example shows how to disable the CLI confirmation prompts for the current user session:
This example shows how to disable the CLI confirmation prompts for the current and future sessions for the current user:
This example shows how to enable the CLI confirmation prompts for the current user session:
This example shows how to enable the CLI confirmation prompts for the current and future sessions for the current user:
terminal edit-mode vi
To enable vi editing of recalled commands, use the terminal edit-mode vi command. To revert to the default, use the no form of this command.
terminal edit-mode vi [ persist ]
no terminal edit-mode vi [ persist ]
Syntax Description
(Optional) Makes the setting persistent for the current and future sessions for the current user. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The edit mode setting applies only to the current user session. Use the persist keyword to change the setting for the current and future sessions for the current user.
Examples
This example shows how to change the edit mode for recalled commands to vi for the current user session:
This example shows how to change the edit mode for recalled commands to vi for the current and future sessions for the current user:
This example shows how to revert the edit mode for recalled commands to emacs for the current user session:
This example shows how to revert the edit mode for recalled commands to emacs for the current and future sessions for the current user:
Related Commands
|
|
|
|---|---|
terminal history no-exec-in-config
To remove the EXEC commands from the show history command output, use the terminal history no-exec-in-config command. To revert to the default, use the no form of this command.
terminal history no-exec-in-config
no terminal history no-exec-in-config
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The terminal history setting applies only to the current session.
Examples
This example shows how to remove the EXEC commands when recalling the command history from a configuration command mode:
This example shows how to revert to the default:
terminal length
To set the number of lines of output to display on the terminal screen for the current session before pausing, use the terminal length command. To revert to the default, use the no form of this command.
Syntax Description
Number of lines to display. The range is from 0 to 511. Use 0 to not pause while displaying output. |
Defaults
The initial default for the console is 0.
The initial default for virtual terminal sessions is 31.
The default for the no form is 24 lines.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The session pauses after displaying the number of lines set in the terminal length. Press the space bar to display another screen of lines or press the Enter key to display another line. To return to the command prompt, press Ctrl-C.
The terminal length setting applies only to the current session.
Examples
This example shows how to set the number of lines of command output to display on the terminal before pausing:
This example shows how to revert to the default number of lines:
Related Commands
|
|
|
|---|---|
terminal log-all
To enable logging of all commands, including the show commands, to the accounting log, use the terminal log-all command. To revert to the default, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The terminal log setting applies only to the current session.
Examples
This example shows how to enable logging of all commands in the accounting log:
This example shows how to disable logging of all commands in the accounting log:
Related Commands
|
|
|
|---|---|
terminal redirection-mode
To configure the format of the output from show commands, use the terminal redirection-mode command.
terminal redirection-mode { ascii | zipped }
Syntax Description
Specifies the standard character format when redirecting show command output. |
|
Specifies the zipped format when redirecting show command output. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Some of the show commands have lengthy outputs, especially the debugging show commands such as the show tech-support command. You can use the terminal redirection-mode command to reduce the size of the file when you redirect the output from the command.
The terminal redirection mode setting applies only to the current session.
Examples
This example shows how to configure the zipped format for the terminal redirection mode:
This example shows how to configure the ASCII format for the terminal redirection mode:
Related Commands
|
|
|
|---|---|
terminal session-timeout
To set the terminal inactivity timeout for the current session, use the terminal session-timeout command. To revert to the default, use the no form of this command.
terminal session-timeout minutes
Syntax Description
Number of minutes. The range is from 0 to 525600 minutes (8760 hours). |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
A value of 0 minutes disables the session timeout.
The terminal session inactivity timeout setting applies only to the current session.
Examples
This example shows how to set the terminal inactivity timeout for the session:
This example shows how to revert to the default terminal inactivity timeout for the session:
Related Commands
|
|
|
|---|---|
terminal type
To set the terminal type for the current session, use the terminal type command. To revert to the default, use the no form of this command.
Syntax Description
Type of terminal. The type string is case sensitive, must be a valid type (for example, vt100 or xterm), and has a maximum of 80 characters. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The terminal type setting applies only to the current session.
Examples
This example shows how to set the terminal type:
This example shows how to revert to the default terminal type:
Related Commands
|
|
|
|---|---|
terminal width
To set the number of character columns on the terminal screen for the current line for a session, use the terminal width command. To revert to the default, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The terminal width setting applies only to the current session.
Examples
This example shows how to set the number of columns to display on the terminal:
This example shows how to revert to the default number of columns:
Related Commands
|
|
|
|---|---|
traceroute
To discover the routes that packets take when traveling to an IPv4 address, use the traceroute command.
traceroute { dest-ipv4-addr | hostname } [ vrf vrf-name ] [ show-mpls-hops ] [ source src-ipv4-addr ]
Syntax Description
Defaults
Uses the default VRF.
Does not show the MPLS hops.
Uses the management IPv4 address for the source address.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To use IPv6 addressing for discovering the route to a device, use the traceroute6 command.
Examples
This example shows how to discover a route to a device:
Related Commands
|
|
|
|---|---|
traceroute6
To discover the routes that packets take when traveling to an IPv6 address, use the traceroute6 command.
traceroute6 { dest-ipv6-addr | hostname } [vrf vrf-name ] [ source src-ipv6-addr ]
Syntax Description
Defaults
Uses the default VRF.
Uses the management IPv6 address for the source address.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
To use IPv4 addressing for discovering the route to a device, use the traceroute command.
Examples
This example shows how to discover a route to a device:
Related Commands
|
|
|
|---|---|
update license
To update an existing license, use the update license command.
update license { bootflash: | slot0: | usb0: | usb1: } filename license-filename
Syntax Description
Specifies the license file location in the internal bootflash memory. |
|
Specifies the license file in the CompactFlash memory or PCMCIA card. |
|
Command Modes
Command History
|
|
|
Usage Guidelines
To view the existing license file name, use the show license command.
Note
After installing the license, the system copies it to a hidden location. You can delete the license file from bootflash after installing it on the system.
You can use the update license command only in the default virtual device context (VDC).
Examples
This example shows how to update a specific license:
Related Commands
|
|
|
|---|---|
where
To display your current context in the command-line interface (CLI), use the where command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The where command helps you to keep track of where you are in the CLI and how you got to that place.
Examples
This example shows how to display summary context information:
This example shows how to display detailed context information:
write erase
To erase configurations in persistent memory areas, use the write erase command.
Syntax Description
(Optional) Erases only the boot variable and mgmt0 interface configuration. |
|
Defaults
Erases all configuration in persistent memory except for the boot variable, mgmt0 interface, and debug configuration.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the write erase command to erase the startup configuration in the persistent memory when information is corrupted or otherwise unusable. Erasing the startup configuration returns the device to its initial state, except for the boot variable, mgmt0 interface, and debug configurations. You have to explicitly erase those configurations with the boot and debug options.
Examples
This example shows how to erase the startup configuration:
This example shows how to erase the boot variable and mgmt0 interface configuration in the persistent memory:
This example shows how to erase the debug configuration in the persistent memory:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup configuration. |
|
Feedback