Cisco Nexus 5000 Series Command Reference

Basic System Commands

This chapter describes the basic Cisco NX-OS system commands available on Cisco Nexus 5000 Series switches. These commands allow you to navigate and control the switch.

banner motd

To configure the message-of-the-day (MOTD) banner that displays when the user logs in to a Cisco Nexus 5000 Series switch, use the banner motd command. To revert to the default, use the no form of this command.

banner motd delimiter message delimiter

no banner motd

Syntax Description

Command Default

"Nexus 5000 Switch" is the default MOTD string.

Command Modes

Interface configuration mode

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:

switch(config)# banner motd #Unauthorized access to this device is prohibited!# 

This example shows how to configure a multiple-line MOTD banner:

switch(config)# banner motd #Welcome Authorized Users Unauthorized access prohibited!# 

This example shows how to revert to the default MOTD banner:

switch(config)# no banner motd 

Related Commands

boot

To configure the boot variable for the Cisco Nexus 5000 Series kickstart or system software image, use the boot command. To clear the boot variable, use the no form of this command.

boot {kickstart | system} [bootflash:] [//server/] [directory] filename

no boot {kickstart | system}

Syntax Description

Note There can be no spaces in the bootflash://server/directory/filename string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

None

Command Modes

Global configuration mode

Command History

Usage Guidelines

The Cisco NX-OS software uses the boot variable for loading images when booting up. You must copy the correct image to the switch before you reload.

Examples

This example shows how to configure the system boot variable:

switch(config)# boot system bootflash:n5000.bin  

This example shows how to configure the kickstart boot variable:

switch(config)# boot kickstart bootflash:n5000-kickstart.bin  

This example shows how to clear the system boot variable:

switch(config)# no boot system  

This example shows how to clear the kickstart boot variable:

switch(config)# no boot kickstart  

Related Commands

cd

To change the current working directory in the device file system, use the cd command.

cd [filesystem:] [//server/] directory

Syntax Description

Note There can be no spaces in the filesystem://server/directory string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

Use the pwd command to verify the current working directory.

Examples

This example shows how to change the current working directory on the current file system:

switch# cd my-scripts  

This example shows how to change the current working directory to another file system:

switch# cd volatile:  

Related Commands

clear cli history

To clear the command history, use the clear cli history command.

clear cli history

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

EXEC mode

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:

switch# clear cli history  

Related Commands

clear cores

To clear the core files, use the clear cores command.

clear cores

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

Use the show system cores command to display information about the core files.

Examples

This example shows how to clear the core file:

switch# clear cores  

Related Commands

clear debug-logfile

To clear the contents of the debug log file, use the clear debug-logfile command.

clear debug-logfile filename

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how to clear the debug log file:

switch# clear debug-logfile syslogd_debugs  

Related Commands

clear install failure-reason

To clear the reason for software installation failures, use the clear install failure-reason command.

clear install failure-reason

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how to clear the reason for software installation failures:

switch# clear install failure-reason  

Related Commands

clear license

To uninstall a license, use the clear license command.

clear license filename

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how to clear a specific license:

switch# clear license fm.lic  

Related Commands

clear user

To log out a particular user, use the clear user command.

clear user username

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how to log out a specific user:

switch# clear user admin  

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

no cli var name variable-name

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

You can reference a CLI variable using the following syntax:

$(variable-name) 

Instances where you can use variables include the following:

•Command scripts

•Filenames

You cannot reference a variable in the definition of another variable.

The Cisco NX-OS software provides a predefined variable, TIMESTAMP, that you can use to insert the time of day. You cannot change or remove the TIMESTAMP CLI variable.

You cannot change the definition of a CLI variable. You must remove the variable and then create it again with the new definition.

Examples

This example shows how to define a CLI variable:

switch# cli var name testvar interface ethernet 1/3  

This example shows how to reference a CLI variable:

switch# show $(testvar)  

This example shows how to reference the TIMESTAMP variable:

switch# copy running-config > bootflash:run-config-$(TIMESTAMP).cnfg  

This example shows how to remove a CLI variable:

switch# cli no var name testvar  

Related Commands

clock set

To manually set the clock on a Cisco Nexus 5000 Series switch, use the clock set command.

clock set time day month year

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

Use this command when you cannot synchronize the switch with an outside clock source, such as an NTP server.

Examples

This example shows how to manually configure the clock:

switch# clock set 12:00:00 04 July 2008  

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

no clock summer-time

Syntax Description

Command Default

None

Command Modes

Interface configuration mode

Command History

Examples

This example shows how to configure the offset for summer-time or daylight saving time:

switch(config)# clock summer-time PDT 1 Sunday March 02:00 5 Sunday November 02:00 60  

This example shows how to revert to the default offset for summer-time:

switch(config)# no clock summer-time  

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

no clock timezone

Syntax Description

Command Default

None

Command Modes

Interface configuration mode

Command History

Usage Guidelines

Use this command to offset the device clock from UTC.

Examples

This example shows how to configure the time zone offset from UTC:

switch(config)# clock timezone PST -8 0  

This example shows how to revert the time zone offset to the default:

switch# no clock timezone  

Related Commands

configure session

To create or modify a configuration session, use the configure session command.

configure session name

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how to create a configuration session:

switch# configure session MySession  
switch(config-s)#  

Related Commands

configure terminal

To enter configuration mode, use the configure terminal command.

configure terminal

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

Use this command to enter configuration mode. Commands in this mode are written to the running configuration file as soon as you enter them (using the Enter key/Carriage Return).

After you enter the configure terminal command, the system prompt changes from switch# to switch(config)#, indicating that the router is in configuration mode. To leave configuration mode and return to EXEC mode, type end or press Ctrl-Z.

To view the changes to the configuration that you have made, use the show running-config command.

Examples

This example shows how to enter configuration mode:

switch# configure terminal  
switch(config)#  

Related Commands

copy

To copy any file from a source to a destination, use the copy command.

copy source-url destination-url

Syntax Description

Command Default

The default name for the destination file is the source filename.

Command Modes

EXEC mode

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 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.

Format of Source and Destination URL

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 (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 router looks for a file in the current directory.

Table 1-1 lists URL prefix keywords for local writable storage file systems. Table 1-2 lists the URL prefix keywords for remote file systems. Table 1-3 lists the URL prefix keywords for nonwritable file systems.

This section contains usage guidelines for the following topics:

•Copying Files from a Server to Bootflash Memory

•Copying a Configuration File from a Server to the Running Configuration

•Copying a Configuration File from a Server to the Startup Configuration

•Copying the Running or Startup Configuration on a Server

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 router 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 copy as a backup.

Examples

This example shows how to copy a file within the same directory:

switch# copy file1 file2  

This example shows how to copy a file to another directory:

switch# copy file1 my-scripts/file2  

This example shows how to copy a file to another file system:

switch# copy file1 bootflash:  

This example shows how to copy a file to another supervisor module:

switch# copy file1 bootflash://sup-1/file1.bak  

This example shows how to copy a file from a remote server:

switch# copy scp://192.168.1.1/image-file.bin bootflash:image-file.bin  

Related Commands

copy running-config startup-config

To save the running configuration to the startup configuration file so that all current configuration details are available after a reboot, use the copy running-config startup-config command.

copy running-config startup-config

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

To view the changes to the configuration that you have made, use the show startup-config command.

Note Once you enter the copy running-config startup-config command, the running and the startup copies of the configuration are identical.

Examples

This example shows how to save the running configuration to the startup configuration:

switch# copy running-config startup-config  

Related Commands

databits

To configure the number of data bits in a character for the terminal port, use the databits command. To revert to the default, use the no form of this command.

databits bits

no databits bits

Syntax Description

Command Default

8 bits

Command Modes

Terminal line configuration mode

Command History

Usage Guidelines

You can configure the console port only from a session on the console port.

Examples

This example shows how to configure the number of data bits for the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# databits 7  

This example shows how to revert to the default number of data bits for the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# no databits 7  

Related Commands

debug logfile

To direct the output of the debug commands to a specified file, use the debug logfile command. To revert to the default, use the no form of this command.

debug logfile filename [size bytes]

no debug logfile filename [size bytes]

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

The Cisco NX-OS software creates the logfile in the log: file system root directory. Use the dir log: command to display the log files.

Examples

This example shows how to specify a debug log file:

switch# debug logfile debug_log  

This example shows how to revert to the default debug log file:

switch# no debug logfile debug_log  

Related Commands

debug logging

To enable debug command output logging, use the debug logging command. To disable debug logging, use the no form of this command.

debug logging

no debug logging

Syntax Description

This command has no arguments or keywords.

Command Default

Disabled

Command Modes

EXEC mode

Command History

Examples

This example shows how to enable the output logging for the debug command:

switch# debug logging  

This example shows how to disable the output logging for the debug command:

switch# no debug logging  

Related Commands

delete

To delete a file or directory, use the delete command.

delete [filesystem:] [//server/] [directory] filename

Syntax Description

Note There can be no spaces in the filesystem://server/directory/filename string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

Use the dir command to locate the file you that want to delete.

The delete command will delete a directory and its contents. Exercise caution when using this command to delete directories.

Examples

This example shows how to delete a file:

switch# delete bootflash:old_config.cfg  

This example shows how to delete a directory:

switch# delete my_dir  
This is a directory.  Do you want to continue (y/n)?  [y] y  

Related Commands

dir

To display the contents of a directory, use the dir command.

dir [filesystem:] [//server/] [directory]

Syntax Description

Note There can be no spaces in the filesystem://server/directory string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

Displays the contents of the current working directory.

Command Modes

EXEC mode

Command History

Usage Guidelines

The dir command displays a listing of the files in the specified directory. For each file, it lists the size of the file in bytes, the last modified time of the file, and the filename of the file. This command then displays the usage statistics for the file system.

Use the pwd command to verify the current working directory.

Use the cd command to change the current working directory.

Examples

This example shows how to display the contents of the root directory in bootflash:

switch# dir bootflash:  

This example shows how to display the contents of the current working directory:

switch# dir  

Related Commands

echo

To display a text string on the terminal, use the echo command.

echo [text]

Syntax Description

Command Default

Blank line

Command Modes

EXEC mode

Command History

Usage Guidelines

You can use this command in a command script to display status information or prompts while the script is running.

Examples

This example shows how to display a blank line at the command prompt:

switch# echo  

This example shows how to display a line of text at the command prompt:

switch# echo Script run at $(TIMESTAMP).  

Related Commands

end

To end the current configuration session and return to EXEC mode, use the end command.

end

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Global configuration mode

Command History

Usage Guidelines

This command returns you to EXEC mode regardless of which configuration mode you are in. Use this command when you are done configuring the system and you want to return to EXEC mode to perform verification steps.

Examples

This example shows how the end command is used to exit from interface configuration mode and return to EXEC mode. A show command is used to verify the configuration.

switch# configure terminal  
switch(config)# interface ethernet 1/1  
switch(config-if)# switchport host  
switch(config-if)# end  
switch# show interface ethernet 1/1  

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.

exec-timeout minutes

no exec-timeout

Syntax Description

Command Default

Timeout is disabled.

Command Modes

Terminal line configuration mode

Command History

Usage Guidelines

You can configure the console port only from a session on the console port.

Examples

This example shows how to configure the inactive session timeout for the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# exec-timeout 30  

This example shows how to revert to the default inactive session timeout for the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# no exec-timeout  

This example shows how to configure the inactive session timeout for the virtual terminal:

switch# configure terminal  
switch(config)# line vty  
switch(config-line)# exec-timeout 30  

This example shows how to revert to the default inactive session timeout for the virtual terminal:

switch# configure terminal  
switch(config)# line vty  
switch(config-line)# no exec-timeout  

Related Commands

exit (EXEC)

To close an active terminal session by logging off the switch, use the exit command.

exit

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how the exit (global) command is used to move from configuration mode to EXEC mode and the exit (EXEC) command is used to log off (exit the active session):

switch(config)# exit  
switch# exit  

Related Commands

exit (global)

To exit any configuration mode to the next highest mode in the CLI mode hierarchy, use the exit command in any configuration mode.

exit

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

All configuration modes

Command History

Usage Guidelines

Use the exit command in configuration mode to return to EXEC mode. Use the exit command in interface, VLAN, or zone configuration mode to return to configuration mode. At the highest level, EXEC mode, the exit command will exit the EXEC mode and disconnect from the switch (see the description of the exit (EXEC) command for details).

Examples

This example shows how to exit from the interface configuration mode and to return to the configuration mode:

switch(config-if)# exit  
switch(config)#  

Related Commands

feature fcoe

To enable virtual and native Fibre Channel interfaces after installing the FC_FEATURES_PKG license, use the feature fcoe command. To disable Fibre Channel interfaces and return the FC_FEATURES_PKG license to the license manager software, use the no form of this command.

feature fcoe

no feature fcoe

Syntax Description

This command has no arguments or keywords.

Command Default

Disabled

Command Modes

Global configuration mode

Command History

Usage Guidelines

You must save the configuration, and then reboot the switch to enable or disable the FCoE feature.

Examples

This example shows how to enable FCoE on the switch:

switch(config)# feature fcoe  

Related Commands

feature fex

To enable Fabric Extender (FEX) features on the switch, use the feature fex command. To disable FEX, use the no form of this command.

feature fex

no feature fex

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Global configuration mode

Command History

Examples

This example shows how to enable FEX features on the switch:

switch(config)# feature fex 

switch(config)#

Related Commands

feature interface-vlan

To enable the creation of VLAN interfaces, use the feature interface-vlan command. To disable the VLAN interface feature, use the no form of this command.

feature interface-vlan

no feature interface-vlan

Syntax Description

This command has no arguments or keywords.

Command Default

VLAN interfaces are disabled.

Command Modes

Global configuration mode

Command History

Usage Guidelines

You must use the feature interface-vlan command before you can create VLAN interfaces.

Examples

This example shows how to enable the interface VLAN feature on the switch:

switch(config)# feature interface-vlan  

Related Commands

feature lacp

To enable Link Aggregation Control Protocol (LACP), which bundles a number of physical ports together to form a single logical channel, use the feature lacp command. To disable LACP on the switch, use the no form of this command.

feature lacp

no feature lacp

Syntax Description

This command has no arguments or keywords.

Command Default

LACP is disabled.

Command Modes

Global configuration mode

Command History

Usage Guidelines

You must remove all the LACP configuration parameters from all EtherChannels on the switch before you can disable LACP.

Even after you enable LACP globally, you do not have to run LACP on all EtherChannels on the switch. You enable LACP on each channel mode using the channel-group mode command.

Examples

This example shows how to enable LACP EtherChannels on the switch:

switch(config)# feature lacp  

Related Commands

feature lldp

The Link Layer Discovery Protocol (LLDP), which is a neighbor discovery protocol that is used for network devices to advertise information about themselves to other devices on the network, is enabled on the switch by default.

Command Default

Enabled

Command History

Usage Guidelines

You cannot enable or disable LLDP on a Cisco Nexus 5000 Series switch. LLDP is enabled on the switch by default. However, the feature lldp command shows as part of the running configuration on the switch.

The Cisco Discovery Protocol (CDP) is a device discovery protocol that runs over Layer 2 (the data link layer) on all Cisco-manufactured devices (routers, bridges, access servers, and switches). CDP allows network management applications to automatically discover and learn about other Cisco devices connected to the network.

To support non-Cisco devices and to allow for interoperability between other devices, the switch supports the Link Layer Discovery Protocol (LLDP). LLDP is a neighbor discovery protocol that is used for network devices to advertise information about themselves to other devices on the network. This protocol runs over the data-link layer, which allows two systems running different network layer protocols to learn about each other.

Examples

This example shows how to enable LLDP on the switch:

switch(config)# feature lldp 

switch(config)# 

This example shows how to disable LLDP on the switch:

switch(config)# no feature lldp 

switch(config)# 

Related Commands

feature private-vlan

To enable private VLANs, use the feature private-vlan command. To return to the default settings, use the no form of this command.

feature private-vlan

no feature private-vlan

Syntax Description

This command has no arguments or keywords.

Command Default

Private VLANs are disabled.

Command Modes

Global configuration mode

Command History

Usage Guidelines

The private VLAN commands are not available until you enable the private VLAN feature.

You cannot disable the private VLANs if there are operational ports on the switch that are in private VLAN mode.

Note A private VLAN-isolated port on a Cisco Nexus 5000 Series switch running the current release of Cisco NX-OS does not support IEEE 802.1Q encapsulation and cannot be used as a trunk port.

Examples

This example shows how to enable private VLAN functionality on the switch:

switch(config)# feature private-vlan  

Related Commands

feature tacacs+

To enable TACACS+, use the feature tacacs+ command. To disable TACACS+, use the no form of this command.

feature tacacs+

no feature tacacs+

Syntax Description

This command has no arguments or keywords.

Command Default

Disabled

Command Modes

Global configuration mode

Command History

Usage Guidelines

You must use the feature tacacs+ command before you configure TACACS+.

Note When you disable TACACS+, the Cisco NX-OS software removes the TACACS+ configuration.

Examples

This example shows how to enable TACACS+:

switch(config)# feature tacacs+  

This example shows how to disable TACACS+:

switch(config)# no feature tacacs+  

Related Commands

feature udld

To enable the Cisco-proprietary Unidirectional Link Detection (UDLD) protocol, which allows ports that are connected through fiber optics or copper Ethernet cables to monitor the physical configuration of the cables and detect when a unidirectional link exists, use the feature udld command. To disable UDLD on the switch, use the no form of this command.

feature udld

no feature udld

Syntax Description

This command has no arguments or keywords.

Command Default

UDLD is disabled.

Command Modes

Global configuration mode

Command History

Examples

This example shows how to enable UDLD on the switch:

switch(config)# feature udld  

Related Commands

feature vpc

To enable virtual port channel (vPC), which allows links that are physically connected to two different Cisco Nexus 5000 Series devices to appear as a single port channel to a third device, use the feature vpc command. To disable vPC on the switch, use the no form of this command.

feature vpc

no feature vpc

Syntax Description

This command has no arguments or keywords.

Command Default

Disabled

Command Modes

Global configuration mode

Command History

Usage Guidelines

In a vPC configuration, the third device can be a Cisco Nexus 2000 Series Fabric Extender or a switch, server, or any other networking device.

Examples

This example shows how to enable vPC on the switch:

switch(config)# feature vpc  

Related Commands

find

To find filenames beginning with a character string, use the find command.

find filename-prefix

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

The find command searches all subdirectories under the current working directory. You can use the cd and pwd commands to navigate to the starting directory.

Examples

This example shows how to display filenames beginning with "n5000":

switch# find n5000  

Related Commands

format

To format the bootflash device, which erases its contents and restores it to its factory-shipped state, use the format command.

format bootflash:

Syntax Description

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how to format the bootflash device:

switch# format bootflash:  

Related Commands

gunzip

To uncompress a compressed file, use the gunzip command.

gunzip [filesystem:] [//server/] [directory] filename

Syntax Description

Note There can be no spaces in the filesystem://server/directory/filename string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

The compressed filename must have the .gz extension.

The Cisco NX-OS software uses Lempel-Ziv 1977 (LZ77) coding for compression.

Examples

This example shows how to uncompress a compressed file:

switch# gunzip run_cnfg.cfg.gz  

Related Commands

gzip

To compress a file, use the gzip command.

gzip [filesystem:] [//server/] [directory] filename

Syntax Description

Note There can be no spaces in the filesystem://server/directory/filename string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

After you run this command, the named file is replaced with a compressed file that has the .gz extension added to its filename.

The Cisco NX-OS software uses Lempel-Ziv 1977 (LZ77) coding for compression.

Examples

This example shows how to compress a file:

switch# gzip run_cnfg.cfg  

Related Commands

hostname

To configure the hostname for the switch, use the hostname command. To revert to the default, use the no form of this command.

hostname name

no hostname

Syntax Description

Command Default

"switch" is the default hostname.

Command Modes

EXEC mode

Command History

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 hostname for a Cisco Nexus 5000 Series switch:

switch# configure terminal  
switch(config)# hostname Engineering2  
Engineering2(config)#  

This example shows how to revert to the default hostname:

Engineering2# configure terminal  
Engineering2(config)# no hostname  
switch(config)#  

Related Commands

install all

To install the kickstart and system images on a Cisco Nexus 5000 Series switch, use the install all command.

install all [kickstart kickstart-url] [system system-url]

Syntax Description

Command Default

If you do not enter any parameters, the boot variable values are used.

Command Modes

EXEC mode

Command History

Usage Guidelines

The format of the kickstart and system URLs varies according to the file system, directory, and file location.

The following tables list URL prefix keywords by the file system type. If you do not specify a URL prefix keyword, the router looks for a file in the current directory.

Table 1-4 lists URL prefix keywords for local writable storage file systems. Table 1-5 lists the URL prefix keywords for remote file systems. For remote file systems, if it is not otherwise specified, the path is the default for the user on the remote server.

If you do not enter the information about the server or username when downloading and installing the image files from a remote server, you are prompted for the information.

This command sets the kickstart and system boot variables and copies the image files to the redundant supervisor module.

The install all command upgrades the switch software and also upgrades the Fabric Extender software of all attached chassis. The Fabric Extender remains online passing traffic while the software is copied. Once the software images have successfully been installed, the parent switch and the Fabric Extender chassis are rebooted automatically to maintain the software version compatibility between the parent switch and the Fabric Extender.

You can use the install all command to downgrade the Cisco NX-OS software on the switch. To determine if the downgrade software is compatible with the current configuration on the switch, use the show incompatibility system command and resolve any configuration incompatibilities.

Examples

This example shows how to install the Cisco NX-OS software from the bootflash: directory:

switch# install all kickstart bootflash:nx-os_kick.bin system bootflash:nx-os_sys.bin  

This example shows how to install the Cisco NX-OS software using the values configured in the kickstart and system boot variables:

switch# configure terminal  
switch(config)# boot kickstart bootflash:nx-os_kick.bin  
switch(config)# boot system bootflash:nx-os_sys.bin  
switch(config)# exit  
switch# copy running-config startup-config  
switch# install all  

This example shows how to install the Cisco NX-OS software from an SCP server:

switch# install all kickstart scp://adminuser@192.168.1.1/nx-os_kick.bin system 
bootflash:scp://adminuser@192.168.1.1/nx-os_sys.bin  

Related Commands

install license

To install a license, use the install license command.

install license [filesystem:] [//server/] [directory] src-filename [target-filename]

Syntax Description

Note There can be no spaces in the filesystem://server/directory/filename string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

All licenses for the Cisco Nexus 5000 Series switches are factory installed. Manual installation is not required.

Command Modes

EXEC mode

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 URL is used. This command also verifies the license file before installing it.

Examples

This example shows how to install a file named license-file that resides in the bootflash: directory:

switch# install license bootflash:license-file  

Related Commands

line console

To specify the console port and enter console port configuration mode, use the line console command.

line console

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Interface configuration mode

Command History

Usage Guidelines

You can configure the console line only from a console port session.

Examples

This example shows how to enter console port configuration mode:

switch# configure terminal  
switch(config)# line console  
switch(config-console)#  

Related Commands

line vty

To specify the virtual terminal and enter line configuration mode, use the line vty command.

line vty

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Interface configuration mode

Command History

Examples

This example shows how to enter console port configuration mode:

switch# configure terminal  
switch(config)# line vty  
switch(config-line)#  

Related Commands

modem in

To enable the modem connection on the console port, use the modem in command. To disable the modem connection, use the no form of this command.

modem in

no modem in

Syntax Description

This command has no arguments or keywords.

Command Default

Timeout is disabled.

Command Modes

Terminal line configuration mode

Command History

Usage Guidelines

You can configure the console port only from a session on the console port.

Examples

This example shows how to enable a modem connection on the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# modem in  

This example shows how to disable a modem connection on the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# no modem in  

Related Commands

modem init-string

To download the initialization string to a modem connected to the 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}

no modem init-string

Syntax Description

Command Default

The default initialization string is ATE0Q1&D2&C1S0=1\015.

Command Modes

Terminal line configuration mode

Command History

Usage Guidelines

You can configure the console port 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 console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# modem init-string default  

This example shows how to download the user-input initialization string to the modem connected to the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# modem init-string user-input  

This example shows how to remove the initialization string to the modem connected to the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# no modem init-string  

Related Commands

modem set-string user-input

To configure the user-input initialization string to download to a modem connected to the 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

no modem set-string

Syntax Description

Command Default

None

Command Modes

Terminal line configuration mode

Command History

Usage Guidelines

You can configure the console port 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 console port:

switch# configure terminal 

switch(config)# line console 

switch(config-console)# modem set-string user-input ATE0Q1&D2&C1S0=3\015 

This example shows how to revert to the default user-input initialization string for the modem connected to the console port:

switch# configure terminal 

switch(config)# line console 

switch(config-console)# no modem set-string 

Related Commands

move

To move a file from one directory to another, use the move command.

move {[filesystem:] [//server/] [directory] source-filename} [filesystem:] [//server/] [directory] [destination-filename]

Syntax Description

Command Default

The default filename for the destination file is the same as the source file.

Command Modes

EXEC mode

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:

switch# move file1 my_files/file2  

This example shows how to move a file to another file system:

switch# move file1 volatile:  

This example shows how to move a file to another supervisor module:

switch# move file1 bootflash://sup-1/file1.bak  

Related Commands

parity

To configure the parity for the console port, use the parity command. To revert to the default, use the no form of this command.

parity {even | none | odd}

no parity {even | none | odd}

Syntax Description

Command Default

The none keyword is the default.

Command Modes

Terminal line configuration mode

Command History

Usage Guidelines

You can configure the console port only from a session on the console port.

Examples

This example shows how to configure the parity for the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# parity even  

This example shows how to revert to the default parity for the console port:

switch# configure terminal  
switch(config)# line console  
switch(config-console)# no parity even  

Related Commands

ping

To determine the network connectivity to another network device, use the ping command.

ping {dest-address | hostname} [count {number | unlimited}] [df-bit] [interval seconds] [packet-size bytes] [source src-address] [timeout seconds] [vrf {vrf-name | default | management}]

Syntax Description

Command Default

For the default values, see the "Syntax Description" section for this command.

Command Modes

EXEC mode

Command History

Examples

This example shows how to determine connectivity to another network device:

switch# ping 192.168.2.246  

Related Commands

ping6

To determine the network connectivity to another device using IPv6 addressing, use the ping6 command.

ping6 {dest-address | hostname} [count {number | unlimited}] [interface intf-id] [interval seconds] [packet-size bytes] [source address] [timeout seconds] [vrf {vrf-name | default | management}]

Syntax Description

Command Default

For the default values, see the "Syntax Description" section for this command.

Command Modes

EXEC mode

Command History

Examples

This example shows how to determine connectivity to another device using IPv6 addressing:

switch# ping6 2001:0DB8::200C:417A vrf management  

Related Commands

reload

To reload the switch and all attached Fabric Extender chassis or a specific Fabric Extender, use the reload command.

reload {all | fex chassis_ID}

Syntax Description

Command Default

Reloads the Cisco Nexus 5000 Series switch.

Command Modes

EXEC mode

Command History

Usage Guidelines

The reload command disrupts traffic on the switch and Fabric Extender.

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.

Examples

This example shows how to reload the Cisco Nexus 5000 Series switch:

switch# copy running-config startup-config  
switch# reload  
This command will reboot the system. (y/n)?  [n] y  

This example shows how to reload a Fabric Extender:

switch# reload fex 101  
WARNING: This command will reboot FEX 101

Do you want to continue? (y/n) [n] y  

Related Commands

rmdir

To remove a directory, use the rmdir command.

rmdir [filesystem: [//server/]] directory

Syntax Description

Note There can be no spaces in the filesystem://server/directory string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

None

Command Modes

EXEC mode

Command History

Examples

This example shows how to remove a directory:

switch# rmdir my_files  

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

Note There can be no spaces in the filesystem://server/directory/filename string. Individual elements of this string are separated by colons (:) and slashes (/).

Command Default

None

Command Modes

EXEC mode

Command History

Usage Guidelines

You must create the command file on a remote device and download it to the Cisco Nexus 5000 Series switch using the copy command.

Examples

This example shows how to run a command script file:

switch# run-script script-file  

Related Commands

save

To save the current configuration session to a file, use the save command.

save location

Syntax Description

Command Default

None

Command Modes

Session configuration mode

Command History

Examples

This example shows how to save a configuration session to a file in bootflash:

switch# configure session MySession  
switch(config-s)# save bootflash:sessions/MySession  

Related Commands

send

To send a message to the active user sessions, use the send command.

send [session line] text

Syntax Description

Command Default

Sends a message to all active user sessions.

Command Modes

EXEC mode

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 switch:

switch# send The system will reload in 15 minutes!  
The system will reload in 15 minutes!  

This example shows how to send a message to a specific user session:

switch# send session pts/0 You must log off the switch.  

Related Commands

setup

To enter the basic device setup dialog, use the setup command.

setup [ficon]

Syntax Description