Feedback
Table Of Contents
description (NetFlow exporter)
destination-profile alert-group
destination-profile email-addr
destination-profile message-level
destination-profile message-size
destination-profile transport-method
diagnostic clear result module
diagnostic monitor interval module
diagnostic ondemand action-on-failure
diagnostic test simulation clear
D Commands
This chapter describes the Cisco NX-OS system management commands that begin with the letter D.
description (EEM)
To add a description to an Embedded Event Manager (EEM) applet, use the description command. To remove the description, use the no form of this command.
description description
no description
Syntax Description
Defaults
None
Command Modes
Embedded event manager
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to add a description to an EEM applet:
switch# configure terminalswitch(config)# event manager applet counter-appletswitch(config-applet)# action 1.2 counter name count1 value $variable op decSwitch(config-applet)# description "counter policy for acme"switch(config-applet)#Related Commands
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
Defaults
None
Command Modes
NetFlow record configuration (config-flow-record)
Supported User Rolesnetwork-admin
vdc-adminCommand History
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-1switch(config-flow-record)# description Custom-Flow-Record-1switch(config-flow-record)#This example shows how to remove the description:
switch(config-flow-record)# no descriptionRelated Commands
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
Defaults
None
Command Modes
NetFlow monitor configuration (config-flow-monitor)
Supported User Rolesnetwork-admin
vdc-adminCommand History
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-1switch(config-flow-monitor)# description Custom-Monitor-1switch(config-flow-monitor)#This example shows how to remove the description:
switch(config-flow-monitor)# no descriptionRelated 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
Defaults
None
Command Modes
NetFlow exporter configuration (config-flow-exporter)
Supported User Rolesnetwork-admin
vdc-adminCommand History
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-1switch(config-flow-exporter)# description Custom-Exporter-1switch(config-flow-exporter)This example shows how to remove the description:
switch(config-flow-exporter)# no descriptionswitch(config-flow-exporter)Related Commands
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
Defaults
None
Command Modes
NetFlow sampler configuration (config-flow-sampler)
Supported User Rolesnetwork-admin
vdc-adminCommand History
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-1switch(config-flow-sampler)# description Custom-Sampler-1switch(config-flow-sampler)#This example shows how to remove the description:
switch(config-flow-sampler)# no descriptionRelated Commands
description (SPAN)
To add a description to an Ethernet Switched Port Analyzer (SPAN) session for analyzing traffic between ports, use the description command. To remove the description, use the no form of this command.
description description
no description
Syntax Description
Defaults
None
Command Modes
Monitor configuration (config-monitor)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to add a description to a SPAN session:
switch# configure terminalswitch(config)# monitor session 3switch(config-monitor)# description span_session_3Related Commands
monitor session
Places you into the Monitor configuration mode for configuring a SPAN session.
show monitor session
Displays the specified SPAN session configuration.
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.
Defaults
None
Command Modes
NetFlow exporter configuration (config-flow-exporter)
Supported User Rolesnetwork-admin
vdc-adminCommand History
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-1switch(config-flow-exporter)# destination 192.168.11.2switch(config-flow-exporter)#This example shows how to remove the destination:
switch(config-flow-exporter)# no destinationRelated Commands
destination interface (SPAN)
To add a destination interface to an Ethernet Switched Port Analyzer (SPAN) session for analyzing traffic between ports, use the destination interface command. To remove the destination, use the no form of this command.
destination interface {ethernet number | port-channel number}
no destination interface {ethernet number | port-channel number}
Syntax Description
Defaults
None
Command Modes
Monitor configuration (config-monitor)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to add a destination to a SPAN session:
switch# configure terminalswitch(config)# monitor session 3switch(config-monitor)# destination interface ethernet 2/5, ethernet 3/7Related Commands
destination-profile
To create and name a destination profile for Call home, use the destination-profile command. To remove a destination profile, use the no form of this command.
destination-profile profile_name
no destination-profile profile_name
Syntax Description
Defaults
None
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
Cisco NX-OS includes the following predefined destination profiles:
•
CiscoTAC-1—Supports the Cisco-TAC alert group in XML message format. This profile is preconfigured with the callhome@cisco.com e-mail contact, maximum message size, and message severity level 0. You cannot change any of the default information for this profile.
•
•
This command does not require a license.
Examples
This example shows how to create the Call home destination profile named Noc101:
switch(config)# callhomeswitch(config-callhome)# destination-profile Noc101This example shows how to remove the Call home Noc101 destination profile:
switch(config)# callhomeswitch(config-callhome)# no destination-profile Noc101Related Commands
show callhome destination-profile name
Displays the specified Call home destination profile.
show callhome
Displays the Call home configuration.
destination-profile alert-group
To specify which alerts a Call home destination will receive, use the destination-profile alert-group command. To remove an alert group, use the no form of this command.
destination-profile profile_name alert-group {All | Configuration | Diagnostic | EEM | Cisco-TAC | Environmental | Inventory | License | Linecard-Hardware | Supervisor-Hardware | Syslog-group-port | System | Test}
no destination-profile profile_name alert-group {All | Configuration | Diagnostic | EEM | Cisco-TAC | Environmental | Inventory | License | Linecard-Hardware | Supervisor-Hardware | Syslog-group-port | System | Test}
Syntax Description
Defaults
None
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to specify that the destination profile receives all Call home messages:
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# callhomeswitch(config-callhome)# destination-profile Noc101 alert-group Allswitch(config-callhome)# show callhome destination-profile profile Noc101Noc101 destination profile informationmaximum message size:2500000message format:XMLmessage-level:0email addresses configured:alert groups configured:allRelated Commands
destination-profile email-addr
To specify an e-mail address for a Call home destination, use the destination-profile email-addr command. To remove an e-mail address, use the no form of this command.
destination-profile profile-name email-addr email-address
no destination-profile profile-name email-addr email-address
Syntax Description
Defaults
None
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to specify an e-mail address for a Call home destination:
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# callhomeswitch(config-callhome)# destination-profile Noc101 email-addr jdoe@callhome.comswitch(config-callhome)# show callhome destination-profile profile Noc101Noc101 destination profile informationmaximum message size:2500000message format:XMLmessage-level:0email addresses configured:jdoe@callhome.comalert groups configured:allRelated Commands
destination-profile format
To specify a message format for sending messages to a Call home destination, use the destination-profile format command.
destination-profile profile_name format {full-txt | short-txt | XML}
Syntax Description
Defaults
XML
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure a message format for sending messages to a Call home destination:
switch(config-callhome)# destination-profile acme_destination format full-txtRelated Commands
show callhome destination-profile
Displays a Call home destination profiles.
show callhome
Displays the Call home configuration.
destination-profile http
To specify an HTTP or HTTPS URL for a Call home destination, use the destination-profile http command. To remove a URL, use the no form of this command.
destination-profile profile-name http url
no destination-profile profile-name http url
Syntax Description
profile-name
Name you have given the Call home destination profile.
http url
Specifies the HTTP or HTTPS URL to be added to the Call home destination profile.
Defaults
None
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure a URL for a Call home destination:
switch(config-callhome)# destination-profile acme_destination http http://my_url,com/callhomeRelated Commands
show callhome destination-profile
Displays a Call home destination profiles.
show callhome
Displays the Call home configuration.
destination-profile message-level
To specify a severity level for alerts that are sent to the Call home destination, use the destination-profile message-level command.
destination-profile profile_name message-level number
Syntax Description
Defaults
None
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to specify that messages with a severity level 5 or higher are sent to a Call home destination:
switch(config-callhome)# destination-profile acme_destination message-level 5Related Commands
show callhome destination-profile
Displays a Call home destination profiles.
show callhome
Displays the Call home configuration.
destination-profile message-size
To specify a maximum allowable size for messages that are sent to a Call home destination, use the destination-profile message-size command.
destination-profile profile_name message-size number
Syntax Description
Defaults
2500000
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure a maximum message size of 100000 for messages sent to a Call home destination:
switch(config-callhome)# destination-profile acme_destination message-size 100000Related Commands
show callhome destination-profile
Displays a Call home destination profiles.
show callhome
Displays the Call home configuration.
destination-profile transport-method
To specify a method of transporting Call home messages to a destination, use the destination-profile transport-method command. To remove the transport method, use the no form of this command.
destination-profile profile-name transport-method [email | http]
no destination-profile profile-name transport-method [email | http]
Syntax Description
Defaults
None
Command Modes
Call home configuration (config-callhome)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to specify HTTP for transporting Call home messages to a destination:
switch(config-callhome)# destination-profile acme_destination transport-method httpswitch(config-callhome)#Related Commands
show callhome destination-profile
Displays a Call home destination profiles.
show callhome
Displays the Call home configuration.
diagnostic bootup level
To configure the diagnostic bootup level to trigger diagnostics when the device boots, use the diagnostic bootup level command.
diagnostic bootup level {bypass | complete}
Syntax Description
bypass
Specifies to not perform any bootup diagnostics.
complete
Displays all bootup diagnostics. The default is complete.
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure the diagnostic bootup level:
switch(config)# diagnostic bootup level bypassswitch#Related Commands
diagnostic clear result module
To clear the diagnostic test result for the specified test, use the diagnostic clear result module command.
diagnostic clear result module [slot | all] test {test-id | all}
Syntax Description
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to clear a diagnostic test result:
switch# diagnostic clear result module 6 test 6Related Commands
diagnostic monitor interval module
To configure a diagnostic monitoring test interval on a module, use the diagnostic monitor interval module command. To remove the diagnostic monitoring test interval, use the no form of this command.
diagnostic monitor interval module module test {all | name | test-id} hour hour min min second sec
no diagnostic monitor interval module module test {all | name | test-id}
Syntax Description
Defaults
None
Command Modes
Global configuration (config)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure a diagnostic monitoring test interval on a module:
switch(config)# diagnostic monitor interval module 1 test 5 hour 10 min 30 sec 0switch(config)#This example shows how to remove a diagnostic monitoring test interval from a module:
switch(config)# no diagnostic monitor interval module 1 test 5 hour 10 min 30 sec 0switch(config)#Related Commands
show running-config diagnostic
Displays the running-configuration diagnostics.
diagnostic monitor module
Configures a diagnostic monitor test.
diagnostic monitor module
To configure a diagnostic monitor test, use the diagnostic monitor module command. To remove a diagnostic monitor test, use the no form of this command.
diagnostic monitor module module test {all | name | test-id}
no diagnostic monitor module module test {all | name | test-id}
Syntax Description
module
Module number.
test
Specifies a diagnostic test selection.
all
Specifies all test IDs.
name
Test name. The maximum number of characters is 32.
test-id
Test ID number.
Defaults
None
Command Modes
Global configuration (config)
Supported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure a diagnostic monitor test:
switch(config)# diagnostic monitor module 1 test allswitch(config)#This example shows how to remove a diagnostic monitor test:
switch(config)# no diagnostic monitor module 1 test allswitch(config)#Related Commands
show startup-config diagnostic
Displays the startup-configuration diagnostics.
show running-config diagnostic
Displays the running-configuration diagnostics.
diagnostic ondemand action-on-failure
To configure the action to take if the on-demand test fails, use the diagnostic ondemand action-on-failure command.
diagnostic ondemand action-on-failure {continue failure-count num-fails | stop}
Syntax Description
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure the action if the on-demand test fails:
switch# diagnostic ondemand action-on-failure continue failure-count 992switch#Related Commands
diagnostic ondemand iteration
To configure the number of times that the on-demand test runs, use the diagnostic ondemand iteration command.
diagnostic ondemand iteration number
Syntax Description
number
(Optional) Number of times that the on-demand test runs. The range is from 1 to 999. The default is 1.
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to configure the number of times that the on-demand test runs:
switch# diagnostic ondemand iteration 992Related Commands
diagnostic start
To start the on-demand diagnostic test for a module, use the diagnostic start command.
diagnostic start module slot test [test-id | test-name | all | non-disruptive] [port port-number | all]
Syntax Description
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to start the on-demand diagnostic test for a module:
switch# diagnostic start module 6 test allRelated Commands
diagnostic stop
To stop one or more diagnostic tests for a module, use the diagnostic stop command.
diagnostic stop module slot test [test-id | name | all]
Syntax Description
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to stop one or more diagnostic tests on a module:
switch# diagnostic stop module 6 test allswitch#Related Commands
diagnostic test simulation
To simulate a diagnostic test for a module, use the diagnostic test simulation command
diagnostic test simulation module slot test test-id [port {number | all}] {fail | random-fail | success}
Syntax Description
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to simulate a test result:
switch# diagnostic test simulation module 2 test 2 failswitch#Related Commands
diagnostic test simulation clear
To clear a diagnostic test simulation for a module, use the diagnostic test simulation clear command
diagnostic test simulation module number test test-id clear
Syntax Description
module number
Specifies the diagnostic test simulation module number. The range is from 1 to the number of modules in the chassis.
test test-id
Specifies the test ID. The range is from 1 to 15.
Defaults
None
Command Modes
Any command mode
Supported User Rolesnetwork-admin
network-operator
vdc-admin
vdc-operatorCommand History
Usage Guidelines
This command does not require a license.
Examples
This example shows how to clear the diagnostic test simulation:
switch# diagnostic test simulation module 2 test 2 clearswitch#Related Commands
distribute
To enable Cisco Fabric Service (CFS) to distribute configurations, use the distribute command. To disable distribution, use the no form of this command.
distribute [radius | tacacs+]
no distribute
Syntax Description
radius
(Optional) Specifies CFS to distribute RADIUS configurations.
tacacs+
(Optional) Specifies CFS to distribute TACACS+ configurations.
Defaults
None
Command Modes
Call home configuration
Global configurationSupported User Rolesnetwork-admin
vdc-adminCommand History
Usage Guidelines
This command does not require a license.
To enable CFS to distribute role configurations, see the role distribute command.
Examples
This example shows how to enable CFS to distribute Call home configurations:
switch(config)# callhomeswitch(config-callhome)# distributeThis example shows how to enable CFS to distribute RADIUS configurations:
switch(config)# distribute radiusThis example shows how to enable CFS to distribute TACACS+ configurations:
switch(config)# distribute tacacs+Related Commands
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
Defaults
None
Command Modes
NetFlow exporter configuration (config-flow-exporter)
Supported User Rolesnetwork-admin
vdc-adminCommand History
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-1switch(config-flow-exporter)# dscp 32switch(config-flow-exporter)#This example shows how to remove the DSCP parameter:
switch(config-flow-exporter)# no dscpswitch(config-flow-exporter)Related Commands