Cisco Nexus 5600 Series NX-OS System Management Command Reference

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book

Results

Updated:
May 20, 2016

Chapter: D Commands

D Commands

description (NetFlow exporter)

To add a description to a NetFlow exporter, use the description command. To remove the description, use the no form of this command.

description line

no description [line]

Syntax Description

line

Description string. The string can have a maximum of 63 alphanumeric characters.

Command Default

None

Command Modes

NetFlow exporter configuration (config-flow-exporter)

Command History

Release

Modification

7.0(0)N1(1)

This command was introduced.

Usage Guidelines

This command does not require a license.

Examples

This example shows how to add a description to a NetFlow exporter: 


switch(config)#flow export Netflow-Exporter-1
switch(config-flow-exporter)# description Custom-Exporter-1
switch(config-flow-exporter)

This example shows how to remove the description: 


switch(config-flow-exporter)#no description
switch(config-flow-exporter)

Related Commands

Command

Description

show flow exporter

Displays information about NetFlow exporters.

description (NetFlow monitor)

To add a description to a NetFlow monitor, use the description command. To remove the description, use the no form of this command.

description line

no description [line]

Syntax Description

line

Description string. The string can have a maximum of 63 alphanumeric characters.

Command Default

None

Command Modes

NetFlow monitor configuration (config-flow-monitor)

Command History

Release

Modification

7.0(0)N1(1)

This command was introduced.

Usage Guidelines

This command does not require a license.

Examples

This example shows how to add a description to a NetFlow monitor: 


switch(config)#flow monitor NetFlow-Monitor-1
switch(config-flow-monitor)#description Custom-Monitor-1
switch(config-flow-monitor)#

This example shows how to remove the description: 


switch(config-flow-monitor)#no description

Related Commands

Command

Description

show flow record

Displays information about NetFlow records.

description (NetFlow record)

To add a description to a NetFlow record, use the description command. To remove the description, use the no form of this command.

description line

no description [line]

Syntax Description

line

Description string. The string can have a maximum of 63 alphanumeric characters.

Command Default

None

Command Modes

NetFlow record configuration (config-flow-record)

Command History

Release

Modification

7.0(0)N1(1)

This command was introduced.

Usage Guidelines

This command does not require a license.

Examples

This example shows how to add a description to a NetFlow record: 


switch(config)#flow record NetFlow-Record-1
switch(config-flow-record)#description Custom-Flow-Record-1
switch(config-flow-record)#

This example shows how to remove the description: 


switch(config-flow-record)#no description

Related Commands

Command

Description

show flow record

Displays information about NetFlow records.

description (NetFlow sampler)

To add a description to a NetFlow sampler, use the description command. To remove the description, use the no form of this command.

description line

no description [line]

Syntax Description

line

Description string. The string can have a maximum of 63 alphanumeric characters.

Command Default

None

Command Modes

NetFlow sampler configuration (config-flow-sampler)

Command History

Release

Modification

7.0(0)N1(1)

This command was introduced.

Usage Guidelines

This command does not require a license.

Examples

This example shows how to add a description to a NetFlow sampler: 


switch(config)# sampler Netflow-Sampler-1
switch(config-flow-sampler)#description Custom-Sampler-1
switch(config-flow-sampler)#

This example shows how to remove the description: 


switch(config-flow-sampler)#no description

Related Commands

Command

Description

show sampler

Displays information about NetFlow samplers.

description (SPAN, ERSPAN)

To add a description to an Ethernet Switched Port Analyzer (SPAN) or an Encapsulated Remote Switched Port Analyzer (ERSPAN) session configuration, use the description command. To remove the description, use the no form of this command.

description description

no description

Syntax Description

description

String description of the SPAN session configuration. This string is limited to 32 characters.

Command Default

No description is added.

Command Modes

SPAN session configuration mode (config-monitor)

ERSPAN source session configuration mode (config-erspan-src)

ERSPAN destination session configuration mode (config-erspan-dst)

SPAN-on-Drop session configuration mode (config-span-on-drop)

SPAN-on-Drop ERSPAN session configuration mode (config-span-on-drop-erspan)

SPAN-on-Latency session configuration mode (config-span-on-latency)

SPAN-on-Latency ERSPAN session configuration mode (config-span-on-latency-erspan)

Command History

Release

Modification

7.0(0)N1(1)

This command was modified. This command was implemented in the following modes: ERSPAN destination session configuration mode, SPAN-on-Drop session configuration mode, SPAN-on-Drop ERSPAN session configuration mode, SPAN-on-Latency session configuration mode, and SPAN-on-Latency ERSPAN session configuration mode.

6.0(2)N1(1)

This command was introduced.

Usage Guidelines

Use the description command to provide a reminder in the configuration to describe what certain SPAN and ERSPAN sessions are used for. The description appears in the output of the following commands such as show monitor session and show running-config monitor .

Examples

This example shows how to add a description for a SPAN session: 


switch# configure terminal
switch(config)# monitor session 9 type local
switch(config-monitor)# description A Local SPAN session
switch(config-monitor)#

This example shows how to add a description for an ERSPAN source session: 


switch# configure terminal
switch(config)# monitor session 9 type erspan-source
switch(config-erspan-src)# description ERSPAN-source-session
switch(config-erspan-src)#

This example shows how to add a description for an ERSPAN destination session: 


switch# configure terminal
switch(config)# monitor session 9 type erspan-destination
switch(config-erspan-dst)# description ERSPAN-destination-session
switch(config-erspan-dst)#

This example shows how to add a description for an SPAN-on-Drop session: 


switch# configure terminal
switch(config)# monitor session 9 type span-on-drop
switch(config-span-on-drop)# description span-on-drop-session
switch(config-span-on-drop)#

This example shows how to add a description for an ERSPAN SPAN-on-Drop session: 


switch# configure terminal
switch(config)# monitor session 9 type span-on-drop-erspan
switch(config-span-on-drop-erpsan)# description span-on-drop-erspan-session
switch(config-span-on-drop-erspan)#

This example shows how to add a description for an SPAN-on-Latency session: 


switch# configure terminal
switch(config)# monitor session 9 type span-on-latency
switch(config-span-on-latency# description span-on-latency-session
switch(config-span-on-latency)#

This example shows how to add a description for an ERSPAN SPAN-on-Latency session: 


switch# configure terminal
switch(config)# monitor session 9 type span-on-latency-erspan
switch(config-span-on-latency-erpsan)# description span-on-latency-erspan-session
switch(config-span-on-latency-erspan)#

Related Commands

Command

Description

destination (SPAN session)

Configures a destination SPAN port.

monitor session

Creates a new SPAN session configuration.

show monitor session

Displays SPAN session configuration information.

show running-config monitor

Displays the running configuration information of a SPAN session.

source (SPAN session)

Configures a source SPAN port.

destination

To specify the destination for a NetFlow exporter, use the destination command. To remove a destination, use the no form of this command.

destination {ipaddr | ipv6addr} [use-vrf vrf_name]

no destination {ipaddr | ipv6addr} [use-vrf vrf_name]

Syntax Description

ipaddr

Destination IP address for a collector.

ipv6addr

Destination IPv6 address for a collector.

use-vrf vrf_name

(Optional) Specifies the Virtual Routing and Forwarding (VRF) label.

Command Default

None

Command Modes

NetFlow exporter configuration (config-flow-exporter)

Command History

Release

Modification

7.0(0)N1(1)

This command was introduced.

Usage Guidelines

This command does not require a license.

Examples

This example shows how to specify the destination for a NetFlow exporter: 


switch(config)# Flow exporter NetFlow-Exporter-1
switch(config-flow-exporter)# destination 192.168.11.2
switch(config-flow-exporter)#

This example shows how to remove the destination: 


switch(config-flow-exporter)#no destination

Related Commands

Command

Description

show flow exporter

Displays information about NetFlow exporters.

destination (ERSPAN session)

To configure an Encapsulated Remote Switched Port Analyzer (ERSPAN) session destination IP address, use the destination command. To remove the destination ERSPAN IP address, use the no form of this command.

destination ip ip_address

no destination ip ip_address

Syntax Description

ip

Configures the remote IP address.

ip_address

IPv4 address in the format A .B .C .D .

Command Default

None

Command Modes

ERSPAN source session configuration mode (config-erspan-src)

SPAN-on-Drop ERSPAN session configuration mode (config-span-on-drop-erspan)

SPAN-on-Latency ERSPAN session configuration mode (config-span-on-latency-erspan)

Command History

Release

Modification

7.0(0)N1(1)

This command was modified. This command was implemented in the following modes: SPAN-on-Drop ERSPAN session configuration mode and SPAN-on-Latency ERSPAN session configuration mode.

6.0(2)N1(1)

This command was introduced.

Usage Guidelines

You can configure only one destination IP address for an ERSPAN.

This command does not require a license.

Examples

This example shows how to configure an ERSPAN source session destination IP address: 


switch# configure terminal
switch(config)# monitor session 1 type erspan-source
switch(config-erspan-src)# destination ip 192.0.3.1
switch(config-erspan-src)#

This example shows how to configure an ERSPAN SPAN-on-Drop session destination IP address: 


switch# configure terminal
switch(config)# monitor session 9 type span-on-drop-erspan
switch(config-span-on-drop-erpsan)# destination ip 192.0.3.1
switch(config-span-on-drop-erspan)#

This example shows how to configure an ERSPAN SPAN-on-Latency session destination IP address: 


switch# configure terminal
switch(config)# monitor session 9 type span-on-latency-erspan
switch(config-span-on-latency-erpsan)# destination ip 192.0.3.1
switch(config-span-on-latency-erspan)#

Related Commands

Command

Description

monitor session

Creates a new SPAN session configuration.

show monitor session

Displays SPAN session configuration information.

show running-config monitor

Displays the running configuration information of a SPAN session.

source (ERSPAN session)

Configures a source SPAN port.

source (SPAN session)

Configures a source SPAN port.

destination (SPAN session)

To configure a Switched Port Analyzer (SPAN) destination port, use the destination command. To remove the destination SPAN port, use the no form of this command.

destination {interface {ethernet slot / [QSFP-module/ ] port | port-channel channel-num} | vlan vlan-num | vsan vsan-num}

no destination {interface {ethernet slot / [QSFP-module/ ] port | port-channel channel-num} | vlan vlan-num | vsan vsan-num}

Syntax Description

interface

Specifies the interface type to use as the destination SPAN port.

ethernet slot/[QSFP-module/]port

Specifies the Ethernet interface to use as the destination SPAN port. The slot number is from 1 to 255. The QSFP-module number is from 1 to 199. The port number is from 1 to 128.

port-channel channel-num

Specifies the EtherChannel interface to use as the destination SPAN port. The EtherChannel number is from 1 to 4096.

vlan vlan-num

Specifies the VLAN interface to use as the destination SPAN port. The range is from 1 to 3967 and 4048 to 4093.

vsan vsan-num

Specifies the virtual storage area network (VSAN) to use as the destination SPAN port. The range is from 1 to 4093.

Command Default

None

Command Modes

SPAN session configuration mode (config-monitor)

SPAN-on-Drop session configuration mode (config-span-on-drop)

SPAN-on-Latency session configuration mode (config-span-on-latency)

ERSPAN destination session configuration mode (config-erspan-dst)

Command History

Release

Modification

7.0(0)N1(1)

This command was modified. This command was implemented in the following modes: ERSPAN destination session configuration mode, SPAN-on-Drop session configuration mode, SPAN-on-Latency session configuration mode.

6.0(2)N1(1)

This command was introduced.

Usage Guidelines

Each local SPAN, SPAN-on-Drop, and ERSPAN destination session must have a destination port (also called a monitoring port) that receives a copy of traffic from the source port.

The destination port can be any Ethernet physical port and must reside on the same switch as the source port (for a local SPAN session). The destination port cannot be a source port, a port channel, a VLAN, Host Interface (HIF), or a SAN port channel group.

A destination port receives copies of sent and received traffic for all monitored source ports. If a destination port is oversubscribed, it can become congested. This congestion can affect traffic forwarding on one or more of the source ports.

Examples

This example shows how to configure an Ethernet interface SPAN destination port and activate the SPAN session: 


switch# configure terminal
switch(config)# interface ethernet 1/5
switch(config-if)# switchport monitor
switch(config-if)# exit
 
switch(config)# monitor session 9 type local
switch(config-monitor)# description A Local SPAN session
switch(config-monitor)# source interface ethernet 1/1
switch(config-monitor)# destination interface ethernet 1/5
switch(config-monitor)# no shutdown
switch(config-monitor)#

This example shows how to configure an Ethernet interface SPAN destination port and activate the SPAN-on-Drop session : 


switch# configure terminal
switch(config)# interface ethernet 3/5
switch(config-if)# switchport monitor
switch(config-if)# exit
 
switch(config)# monitor session 11 type span-on-drop
switch(config-span-on-drop)# source interface ethernet 3/1
switch(config-span-on-drop)# destination interface ethernet 3/5 
switch(config-span-on-drop)#

This example shows how to configure an Ethernet interface SPAN destination port and activate the SPAN-on-Latency session: 


switch# configure terminal
switch(config)# interface ethernet 4/5
switch(config-if)# switchport monitor
switch(config-if)# exit
 
switch(config)# monitor session 12 type span-on-latency
switch(config-span-on-latency)# source interface ethernet 4/1
switch(config-span-on-latency)# destination interface ethernet 4/5 
switch(config-span-on-latency)#

This example shows how to configure an Ethernet interface SPAN destination port and activate the ERSPAN destination session: 


switch# configure terminal
switch(config)# interface ethernet 2/5
switch(config-if)# switchport monitor
switch(config-if)# exit
 
switch(config)# monitor session 10 type erspan-destination
switch(config-erspan-dst)# source ip 10.1.1.1
switch(config-erspan-dst)# destination interface ethernet 2/5
switch(config-erspan-dst)#

Related Commands

Command

Description

source (SPAN session)

Configures a source SPAN port.

monitor session

Creates a new SPAN session configuration.

show monitor session

Displays SPAN session configuration information.

show running-config monitor

Displays the running configuration information of a SPAN session.

destination-profile (Call Home)

To create a user-defined destination profile, or modify a predefined or user-defined destination profile, and configure the message format for that new destination profile, use the destination-profile command. To remove the destination profile, use the no form of this command.

destination-profile {CiscoTAC-1 | {full-txt-destination | short-txt-destination} {message-level level | message-size size}} {alert-group alert | email-addr email-address | http url | transport-method {email | http}}

destination-profile profile-name [alert-group alert | email-addr email-address | format {XML | full-txt | short-txt} | http url | message-level level | message-size size | transport-method {email | http}]

no destination-profile

Syntax Description

CiscoTAC-1

Configures a destination profile for Extensible Markup Language (XML) messages.

full-txt-destination

Configures a destination profile for plain text messages.

short-txt-destination

Configures a destination profile for short text message.

message-level level

Specifies the Call Home message severity level. The range is from 0 to 9, with 0 being the lowest urgency, and 9 the highest urgency.

message-size size

Specifies the maximum message size. The range is as follows:

  • full-txt-destination —From 0 to 5000000, and the default is 2500000.
  • short-txt-destination —From 0 to 100000, and the default is 4000.
  • CiscoTAC-1 —5000000, which is not changeable.

alert-group alert

Associates one or more alert groups with a destination profile. The alert group can be one of the following:

  • All —All alert groups
  • Cisco-TAC —Cisco TAC events
  • Configuration —Configuration events
  • Diagnostic —Diagnostic events
  • EEM —EEM events
  • Environmental —Power, fan, and temperature-related events
  • Inventory —Inventory status events
  • License —Licensing events
  • Linecard-Hardware —Linecard-related events
  • Supervisor-Hardware —Supervisor-related events
  • Syslog-group-port —Syslog message events filed by the port manager
  • System —Software-related events
  • Test —User-generated test events

email-addr

Specifies the e-mail address to which the alert should be sent.

email-address

E-mail address in email address format. The address can be a maximum of 255 alphanumeric characters and cannot contain white spaces; for example, personname @companyname .com .

http url

Specifies the HTTP or HTTPS URL. The url can be a maximum of 255 alphanumeric characters and cannot contain white spaces; for example,

http://site.com/services/callserv

https://site2.com/serv/CALL

transport-method

Specifies the transport method for sending Call Home messages.

email

Specifies that Call Home messages be sent through e-mail.

http

Specifies that Call Home messages be sent using HTTP.

profile-name

User-defined profile name. The profile name can be a maximum of 31 alphanumeric characters.

format

(Optional) Specifies the Call Home message format. The default is XML.

XML

Specifies that the Call Home message format is XML.

full-txt

Specifies that the Call Home message format is plain text.

short-txt

Specifies that the Call Home message format is a short text message.

Command Default

Message format: XML.

Message size: 2500000 for full-txt-destination, 4000 for short-txt-destination, and 4000000 for XML format.

Message level: 0

Alert group: All for full-text-destination and short-text-destination profiles. The cisco-tac alert group for the CiscoTAC-1 destination profile.

Command Modes


Callhome configuration mode

Command History

Release

Modification

This command was introduced.

Usage Guidelines

You can modify the following attributes for a predefined or user-defined destination profile:

  • Destination e-mail address—The e-mail address to which the alert should be sent.
  • Message formatting—The message format used for sending the alert (full text, short text, or XML).
  • Message level—The Call Home message severity level for this destination profile.
  • Message size—The allowed length of a Call Home message sent to the e-mail addresses in this destination profile.

Note
You cannot modify or delete the CiscoTAC-1 destination profile.

The Cisco Nexus 5000 Series switch does not generate an alert if the Call Home severity level of the alert is lower than the message severity level set for the destination profile.

Table 1 lists each Call Home message level keyword.

Table 1. Call Home Message Severity Level

Call Home Level

Keyword

Description

9

Catastrophic

Network-wide catastrophic failure.

8

Disaster

Significant network impact.

7

Fatal

System is unusable.

6

Critical

Critical conditions that indicate that immediate attention is needed.

5

Major

Major conditions.

4

Minor

Minor conditions.

3

Warning

Warning conditions.

2

Notification

Basic notification and informational messages.

1

Normal

Normal event signifying return to normal state.

0

Debugging

Debugging messages.

Examples

This example shows how to create a user-defined Call Home destination profile to send Call Home messages through e-mail: 


switch(config-callhome)# destination-profile myProfile alert-group Configuration email-addr myname@somecompany.com message-level 3 transport-method email
 
switch(config-callhome)#

Related Commands

Command

Description

callhome

Configures a Call Home service.

copy running-config startup-config

Saves this configuration change.

show callhome

Displays Call Home configuration information.

show callhome destination-profile

Displays Call Home information for a destination profile.

diagnostic bootup level

To configure the bootup diagnostic level to trigger diagnostics when the device boots, use the diagnostic bootup level command. To remove bootup diagnostic level configuration, use the no form of this command.

diagnostic bootup level {bypass | complete}

no diagnostic bootup level {bypass | complete}

Syntax Description

bypass

Specifies that all bootup tests are skipped.

complete

Specifies that all bootup diagnostics are performed. This is the default value.

Command Default

Complete

Command Modes

Global configuration mode

Command History

Release

Modification

6.0(2)N1(1)

This command was introduced.

Examples

This example shows how to configure the bootup diagnostics level to trigger the complete diagnostics: 


switch(config)# diagnostic bootup level complete
 
switch(config)#

This example shows how to remove the bootup diagnostics level configuration: 


switch(config)# no diagnostic bootup level complete
 
switch(config)#

Related Commands

Command

Description

show diagnostic bootup level

Displays the bootup diagnostics level.

show diagnostic bootup result

Displays the results of the diagnostics tests.

dscp

To specify the differentiated services code point (DSCP) for a NetFlow exporter, use the dscp command. To remove the DSCP parameter, use the no form of this command.

dscp dscp

no dscp [dscp]

Syntax Description

dscp

Differentiated services code point value. The range is from 0 to 63.

Command Default

None

Command Modes

NetFlow exporter configuration (config-flow-exporter)

Command History

Release

Modification

7.0(0)N1(1)

This command was introduced.

Usage Guidelines

This command does not require a license.

Examples

This example shows how to configure the DSCP parameter: 


switch(config)# Flow exporter Custom-NetFlow-Exporter-1
switch(config-flow-exporter)# dscp 32
switch(config-flow-exporter)#

This example shows how to remove the DSCP parameter: 


switch(config-flow-exporter)# 
no dscp
switch(config-flow-exporter)

Related Commands

Command

Description

show flow exporter

Displays information about NetFlow exporters.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco