Cisco Nexus 3000 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.
- Updated:
- September 12, 2014
Chapter: System Management Commands
- abort (Call Home)
- abort (session)
- action cli
- action counter
- action event-default
- action policy-default
- action reload
- action snmp-trap
- action syslog
- alert-group (Call Home)
- callhome
- callhome send diagnostic
- callhome test
- clear counters mpls strip
- clear logging logfile
- clear logging nvram
- clear logging onboard
- clear logging session
- clear mpls strip label dynamic
- clear ntp session
- clear ntp statistics
- clear ptp counters
- clear scheduler logfile
- clear sflow statistics
- clock protocol
- commit (Call Home)
- commit (session)
- contract-id (Call Home)
- customer-id (Call Home)
- description
- description (SPAN, ERSPAN)
- destination ip (ERSPAN)
- destination interface (ERSPAN)
- destination-profile (Call Home)
- diagnostic bootup level
- duplicate-message throttle (Call Home)
- email-contact (Call Home)
- enable (Call Home)
- event cli
- event counter
- event fanabsent
- event fanbad
- event manager applet
- event manager environment
- event manager policy
- event manager policy internal
- event memory
- event oir
- event policy-default
- event snmp
- event storm-control
- event syslog
- event sysmgr
- event temperature
- event track
- feature ntp
- feature ptp
- feature scheduler
- feature sflow
- filter access-group
- hardware profile buffer info port-threshold
- hardware profile parity-error
- hardware profile tap-aggregation
- hardware profile unicast syslog host-table-detail
- ip access-list (session)
- ip domain-list
- ip domain-lookup
- ip domain-name
- ip host
- ip name-server
- ip port access-group (session)
- logging abort
- logging commit
- logging console
- logging distribute
- logging event
- logging event port
- logging ip access-list cache entries num_entries
- logging ip access-list cache interval seconds
- logging ip access-list cache threshold num_packets
- logging level
- logging logfile
- logging module
- logging monitor
- logging server
- logging source-interface
- logging timestamp
- mode tap-aggregation
- monitor erspan origin ip-address
- monitor session
- mpls strip dest-mac
- mpls strip
- mpls strip label
- mpls strip label-age
- ntp
- ntp abort
- ntp access-group
- ntp authenticate
- ntp authentication-key
- ntp broadcast
- ntp broadcastdelay
- ntp commit
- ntp disable
- ntp distribute
- ntp logging
- ntp master
- ntp multicast
- ntp multicast client
- ntp peer
- ntp server
- ntp source
- ntp source-interface
- ntp sync-retry
- ntp trusted-key
- periodic-inventory (Call Home)
- phone-contact (Call Home)
- ptp
- ptp announce
- ptp delay-request minimum interval
- ptp domain
- ptp priority1
- ptp priority2
- ptp source
- ptp sync interval
- ptp vlan
- rmon alarm
- rmon event
- rmon hcalarm
- scheduler
- sflow agent-ip
- sflow collector-ip
- sflow collector-port
- sflow counter-poll-interval
- sflow data-source
- sflow max-datagram-size
- sflow max-sampled-size
- sflow sampling-rate
- show callhome
- show callhome destination-profile
- show callhome transport-email
- show callhome user-def-cmds
- show diagnostic bootup level
- show diagnostic result
- show event manager environment
- show event manager event-types
- show event manager history events
- show event manager policy-state
- show event manager script system
- show event manager system-policy
- show forwarding mpls stats
- show hardware forwarding memory health summary
- show hosts
- show logging console
- show logging info
- show logging last
- show logging level
- show logging logfile
- show logging module
- show logging monitor
- show logging nvram
- show logging onboard
- show logging pending
- show logging pending-diff
- show logging session status
- show logging server
- show logging status
- show logging timestamp
- show monitor session
- show mpls strip labels
- show ntp access-groups
- show ntp authentication-keys
- show ntp authentication-status
- show ntp logging-status
- show ntp peers
- show ntp peer-status
- show ntp pending-diff
- show ntp pending peers
- show ntp session status
- show ntp status
- show ntp source
- show ntp source-interface
- show ntp statistics
- show ntp status
- show ntp trusted-keys
- show ptp brief
- show ptp clock
- show ptp clock foreign-masters-record
- show ptp corrections
- show ptp parent
- show ptp port
- show ptp time-property
- show rmon
- show running-config
- show running-config callhome
- show running-config eem
- show running-config exclude-provision
- show running-config interface
- show running-config monitor
- show running-config ptp
- show scheduler
- show sflow
- show sflow statistics
- show snmp community
- show snmp context
- show snmp engineID
- show snmp group
- show snmp host
- show snmp sessions
- show snmp trap
- show snmp user
- show startup-config
- show startup-config callhome
- show startup-config eem
- show startup-config exclude-provision
- show startup-config ptp
- show startup-config vtp
- show tech-support callhome
- shut (ERSPAN)
- site-id (Call Home)
- snmp-server community
- snmp-server contact
- snmp-server context
- snmp-server enable traps
- snmp-server enable traps link
- snmp-server enable traps vtp
- snmp-server globalEnforcePriv
- snmp-server host
- snmp-server location
- snmp-server mib community-map
- snmp-server tcp-session
- snmp-server user
- snmp trap link-status
- source (SPAN, ERSPAN)
- source ip (ERSPAN)
- streetaddress (Call Home)
- switching-mode store-forward
- switchport mode monitor buffer-limit
- switch-priority (Call Home)
- tag
- terminal event-manager bypass
- transport email (Call Home)
- verify (session)
- vrf (ERSPAN)
System Management Commands
This chapter describes the Cisco NX-OS system management commands available on Cisco Nexus 3000 Series switches.
abort (Call Home)
To discard Call Home configuration changes and release the Cisco Fabric Services (CFS) lock, use the abort command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command if you are the CFS lock owner or if you are logged into the device that holds the CFS lock.
Examples
This example shows how to discard Call Home configuration changes:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
abort (session)
To discard the current configuration session, use the abort command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to abort the current configuration session:
Related Commands
|
|
|
|---|---|
action cli
To configure a virtual shell (VSH) command string to be executed when an Embedded Event Manager (EEM) applet is triggered, use the action cli command. To disable the VSH command string, use the no form of this command.
action label num1 [.num2] cli [ local ] vsh_cmd
no action label num1 [.num2] cli
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure a VSH command string to be executed when an EEM applet is triggered:
Related Commands
action counter
To set or modify a named counter when an Embedded Event Manager (EEM) applet is triggered, use the action counter command. To restore the default value to the counter, use the no form of this command.
action label num1 [.num2] counter name name value value op {dec | inc | nop | set}
no action label num1 [.num2] counter name name
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to set the counter count1 to the value in $variable when the EEM counter-applet is triggered:
Related Commands
action event-default
To specify that the default action for the event is to be performed when an Embedded Event Manager (EEM) applet is triggered, use the action event-default command. To disable the default action, use the no form of this command.
action label num1 [.num2] event-default
no action num1 [.num2] event-default
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
If you want to allow the triggered event to process any default actions, you must configure the EEM policy to allow the default action. For example, if you match a CLI command in a match statement, you must add the event-default statement to the EEM policy or EEM does not allow the CLI command to execute. You can use the terminal event-manager bypass command to allow all EEM policies with CLI matches to execute the CLI command.
Examples
This example shows how to specify that the default action for the event is to be performed when an EEM applet is triggered:
Related Commands
action policy-default
To enable the default action of the policy being overridden, use the action policy-default command. To remove the default action, use the no form of this command.
action label num1 [.num2] policy-default
no action label num1 [.num2] policy-default
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable the default action of a policy being overridden when an EEM applet is triggered:
Related Commands
action reload
To specify the action of reloading the Cisco Nexus 3000 Series switch software when an Embedded Event Manager (EEM) applet is triggered, use the action reload command. To remove the action of reloading the Cisco Nexus 3000 Series switch software, use the no form of this command.
action label num1 [.num2] reload
no action label num1 [.num2] reload
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify the action of reloading the Cisco Nexus 3000 Series switch software when an EEM applet is triggered:
Related Commands
action snmp-trap
To specify the generation of a Simple Network Management Protocol (SNMP) trap when an Embedded Event Manager (EEM) applet is triggered, use the action snmp-trap command. To disable the SNMP trap, use the no form of this command.
action label num1 [.num2] snmp-trap [ intdata1 integer ] [ intdata2 integer ] [ strdata string ]
no action label num1 [.num2] snmp-trap [ intdata1 integer ] [ intdata2 integer ] [ strdata string ]
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify an SNMP trap to generate when an EEM applet is triggered:
Related Commands
action syslog
To configure a syslog message to generate when an Embedded Event Manager (EEM) applet is triggered, use the action syslog command. To disable the syslog message, use the no form of this command.
action label num1 [.num2] syslog [ priority { priority | priority-string }] msg message-text
no action label num1 [.num2] syslog [ priority { priority | priority-string }] msg message-text
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Messages written to the syslog from an EEM applet are not screened for EEM syslog events, which might lead to recursive EEM syslog events. Messages that are sent from an EEM applet include the applet name for identification.
Examples
This example shows how to configure a syslog message to save when an EEM applet is triggered:
Related Commands
alert-group (Call Home)
To configure a CLI show command for an alert group, use the alert-group command. To remove a CLI command from an alert group, use the no form of this command.
alert-group alert user-def-cmd CLI-command
no alert-group alert user-def-cmd CLI-command
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can customize predefined alert groups to execute additional CLI show commands when specific events occur and send that show output with the Call Home message. You can assign a maximum of five user-defined CLI show commands to an alert group.
You must enclose the show command in double quotes. Only valid show commands are accepted.
Note
You cannot add user-defined CLI show commands to the CiscoTAC-1 destination profile.
You can add show commands only to full text and XML destination profiles. Short text destination profiles do not support additional show commands because they only allow 128 bytes of text.
Examples
This example shows how to add a show command output to a Call Home message sent for an alert group:
Related Commands
|
|
|
|---|---|
Displays information about all user-defined show commands added to alert groups. |
callhome
To configure the Cisco Smart Call Home service and enter the callhome configuration mode, use the callhome command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must configure the e-mail, phone, and street address information for Call Home. You can optionally configure the contract ID, customer ID, site ID, and switch priority information.
Examples
This example shows how to enter callhome configuration mode:
Related Commands
|
|
|
|---|---|
callhome send diagnostic
To send a specified Call Home test message to all configured destinations, use the callhome send diagnostic command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can generate a test message to test your Call Home communications using the callhome send diagnostic command.
Examples
This example shows how to configure Call Home to send test messages to all configured destinations:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
callhome test
To send a Call Home test message to all configured destinations, use the callhome test command.
Syntax Description
(Optional) Specifies that a Call Home inventory message be sent for testing the Call Home configuration. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to send a Call Home test message to all configured destinations:
This example shows how to send a Call Home inventory message to all configured destinations:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
clear counters mpls strip
To clear all software and hardware MPLS stripping counters, use the clear counters mpls strip command.
Syntax Description
This command has no arguments or keywords
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to clear all MPLS stripping counters:
Related Commands
|
|
|
|---|---|
Configures the destination MAC address for stripped egress frames. |
|
clear logging logfile
To clears the contents of the log file, use the clear logging logfile command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to clear the logging logfile:
Related Commands
|
|
|
|---|---|
clear logging nvram
To clear the NVRAM logs, use the clear logging nvram command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to clear the NVRAM logs:
Related Commands
|
|
|
|---|---|
clear logging onboard
To clear the onboard failure logging (OBFL) entries in the persistent log, use the clear logging onboard command.
clear logging onboard [ environmental-history ] [ exception-log ] [ obfl-log ] [ stack-trace ]
Syntax Description
(Optional) Clears the OBFL (boot-uptime/device-version/obfl-history). |
|
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to clear the OBFL environmental history entries:
This example shows how to clear the OBFL exception-log entries:
This example shows how to clear the OBFL (boot-uptime/device-version/obfl-history) entries:
This example shows how to clear the OBFL stack trace entries:
Related Commands
|
|
|
|---|---|
clear logging session
To clear the current logging session, use the clear logging session command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to clear the current logging session:
Related Commands
|
|
|
|---|---|
clear mpls strip label dynamic
To clear dynamic label entries from the MPLS label table, use the clear mpls strip label dynamic command.
clear mpls strip label dynamic
Syntax Description
This command has no arguments or keywords
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to clear dynamic label entries:
Related Commands
|
|
|
|---|---|
Configures the destination MAC address for stripped egress frames. |
|
clear ntp session
To clear the Network Time Protocol (NTP) session, use the clear ntp session command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to discard the NTP distribution session in progress:
Related Commands
|
|
|
|---|---|
clear ntp statistics
To clear the Network Time Protocol (NTP) session, use the clear ntp statistics command.
clear ntp statistics { all-peers | io | local | memory }
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to discard the NTP I/O statistics:
Related Commands
|
|
|
|---|---|
clear ptp counters
To clear the Precision Time Protocol (PTP) packet counters, use the clear ptp counters command.
clear ptp counters { all | interface ethernet slot / port }
Syntax Description
Clears PTP counters from an IEEE 802.3z Ethernet interface. The slot number is from 1 to 255 and the port number is from 1 to 128. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to clear all PTP counters:
Related Commands
|
|
|
|---|---|
clear scheduler logfile
To clear the scheduler log file, use the clear scheduler logfile command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how clear the scheduler log file:
Related Commands
|
|
|
|---|---|
clear sflow statistics
To clear the sFlow statistics, use the clear sflow statistics command.
Note Beginning in Release 7.0(3)I2(1), the Total Samples and Total Samples fields are not cleared.
To clear Total Samples: clear hardware rate-limiter sflow
To clear Total Packets: clear hardware rate-limiter sflow
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how clear the sFlow statistics:
Related Commands
|
|
|
|---|---|
clock protocol
To set the synchronization protocol for the clock to a protocol, use the clock protocol command. To remove the clock protocol, use the no form of this command.
Note Beginning in Release 7.0(3)I2(1), this command will not set the clock. To change the clock manually, see the Cisco Nexus 3000 Series NX-OS Fundamentals Configuration Guide.
clock protocol { none | ntp | ptp }
no clock protocol { none | ntp | ptp }
Syntax Description
Specifies that the clock be set to the Network Time Protocol (NTP). |
|
Specifies that the clock be set to the Precision Time Protocol (PTP). |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to set the synchronization protocol for the clock to PTP:
Related Commands
|
|
|
|---|---|
commit (Call Home)
To commit Call Home configuration changes and distribute the changes to call Cisco Fabric Services (CFS)-enabled devices, use the commit command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to commit CFS Call Home configuration changes:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
commit (session)
To commit the current configuration session, use the commit command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to commit the current session:
Related Commands
|
|
|
|---|---|
contract-id (Call Home)
To configure the optional contract number for the customer, use the contract-id command. To remove a contract number, use the no form of this command.
Syntax Description
Contract number. The contract number can be up to 255 alphanumeric characters in free format. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can configure the customer identification information that Cisco Smart Call Home should use. The service agreement includes the customer identification information, such as the customer ID, contract ID, and site ID.
Examples
This example shows how to configure the contract number for the customer:
Related Commands
|
|
|
|---|---|
customer-id (Call Home)
To configure the optional unique identification number for the customer, use the customer-id command. To remove a customer number, use the no form of this command.
Syntax Description
Customer number, as specified in the service agreement. The customer number can be up to 255 alphanumeric characters in free format. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can configure the customer identification information that Cisco Smart Call Home should use. The service agreement includes the customer identification information, such as the customer ID, contract ID, and site ID.
Examples
This example shows how to configure a customer number:
Related Commands
|
|
|
|---|---|
description
To add a description to a user policy, use the description command. To remove the policy description, use the no form of this command.
description policy-description
no description policy-description
Syntax Descriptiona
Policy description. The description can be any case-sensitive, alphanumeric string up to 80 characters enclosed by quotation marks. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to add a description to a user policy:
This example shows how to remove the policy description:
Related Commands
|
|
|
|---|---|
Displays information about the status of the configured policy. |
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.
Syntax Description
String description of the SPAN session configuration. This string is limited to 80 characters. |
Command Default
Command Modes
SPAN session configuration mode
ERSPAN session configuration mode
Command History
|
|
|
Usage Guidelines
The description command is meant to provide a reminder in the configuration to describe what certain SPAN sessions are used for. The description appears in the output of the show monitor session and show running-config monitor commands.
Examples
This example shows how to add a description for a SPAN session:
This example shows how to add a description for an ERSPAN session:
Related Commands
|
|
|
|---|---|
Displays the running configuration information of a SPAN session. |
|
destination ip (ERSPAN)
To configure an Encapsulated Remote Switched Port Analyzer (ERSPAN) destination IP address, use the destination command. To remove the destination ERSPAN IP address, use the no form of this command.
Syntax Description
Command Default
Command Modes
ERSPAN source configuration mode
Command History
|
|
|
Usage Guidelines
You can configure only one destination IP address for an ERSPAN source session.
Examples
This example shows how to configure an ERSPAN destination IP address:
Related Commands
|
|
|
|---|---|
Displays the running configuration information of a SPAN session. |
|
destination interface (ERSPAN)
To configure interfaces for an Encapsulated Remote Switched Port Analyzer (ERSPAN) destination, use the destination interface command. To remove the interfaces from an ERSPAN session, use the no form of this command.
destination interface ethernet slot / port
no destination interface ethernet slot / port
Syntax Description
Ethernet interface slot number and port number. The slot number is from 1 to 255, and the port number is from 1 to 128. |
Command Default
Command Modes
ERSPAN destination configuration mode
Command History
|
|
|
Usage Guidelines
The destination port should be previously configured as a switchport monitor.
Examples
This example shows how to configure an ERSPAN destination interface:
Related Commands
|
|
|
|---|---|
Displays the running configuration information of a SPAN session. |
|
destination-profile (Call Home)
To create a user-defined destination profile, modify a predefined or user-defined destination profile, or 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 }]
Syntax Description
Command Default
Message size: 2500000 for full-txt-destination, 4000 for short-txt-destination, and 4000000 for XML format.
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
Command History
|
|
|
|---|---|
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 3000 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-1 lists each Call Home message level keyword.
|
|
|
|
|---|---|---|
Critical conditions that indicate that immediate attention is needed. |
||
Examples
This example shows how to create a user-defined Call Home destination profile to send Call Home messages through e-mail:
Related Commands
|
|
|
|---|---|
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
Specifies that all bootup diagnostics are performed. This is the default value. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure the bootup diagnostics level to trigger the complete diagnostics:
This example shows how to remove the bootup diagnostics level configuration:
Related Commands
|
|
|
|---|---|
duplicate-message throttle (Call Home)
To limit the number of duplicate messages received for the same event, use the duplicate-message throttle command. To disable duplicate message throttling for Call Home, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
By default, the switch limits the number of duplicate messages received for the same event. If the number of duplicate messages sent exceeds 30 messages within a 2-hour time frame, then the switch discards further messages for that alert type.
Examples
This example shows how to enable duplicate alert message throttling for Call Home:
Related Commands
|
|
|
|---|---|
email-contact (Call Home)
To configure the e-mail address for the primary person responsible for the switch, use the email-contact command. To remove an email contact, use the no form of this command.
Syntax Description
E-mail address. The address can be a maximum of 255 alphanumeric characters in e-mail address format and cannot contain spaces. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure an e-mail address:
Related Commands
|
|
|
|---|---|
Configures the phone number for the primary person responsible for the switch. |
|
enable (Call Home)
To enable the Cisco Smart Call Home service after you have configured the contact information, use the enable command. To disable the Smart Call Home service, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must configure an e-mail server. Your switch must have IP connectivity to an e-mail server. You must configure the contact name (SNMP server contact), phone, and street address information before you enable Call Home.
Examples
This example shows how to enable the Cisco Smart Call Home service:
This example shows how to disable the Cisco Smart Call Home service:
Related Commands
|
|
|
|---|---|
event cli
To specify the event criteria for an Embedded Event Manager configuration mode(EEM) applet that is run by matching a Cisco NX-OS command-line interface (CLI) command, use the event cli command. To remove the CLI command event criteria, use the no form of this command.
event cli [tag tag] match regex [count count-number ]
no event cli match regex [count count-number ]
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify a CLI command for the EEM applet to match:
event counter
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a named counter crossing a threshold, use the event counter command. To remove the counter event criteria, use the no form of this command.
event counter name name entry-val value entry-op {eq | ge | gt | le | lt | ne } [exit-val value exit-op {eq | ge | gt | le | lt | ne}]
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify an event criteria for an EEM applet that is run when the defined critical_errors counter exceeds the entry value:
event fanabsent
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a fan absent event, use the event fanabsent command. To remove the fan absent event criteria, use the no form of this command.
event fanabsent [fan number] time interval
no event fanabsent [fan number] time interval
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when a fan absent event occurs:
event fanbad
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a fan bad event, use the event fanbad command. To remove the fan bad event criteria, use the no form of this command.
event fanbad fan number time interval
no event fanbad [fan number] time interval
Syntax Description
Specifies a fan number to monitor for a fan bad event. The range is from 1 to 1. |
|
Specifies the time interval (in seconds) within which the fan can stay bad. The range is from 10 to 64000. |
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when a fan bad event occurs:
event manager applet
To register an applet with the Embedded Event Manager (EEM) and enter the applet configuration mode, use the event manager applet command. To remove the applet configuration, use the no form of this command.
event manager applet applet-name
no event manager applet applet-name
Syntax Descriptiona
Name of the applet. The applet name can be any case-sensitive, alphanumeric string up to 29 characters. The applet name cannot have an underscore in the first two characters. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to register an applet and enter the applet configuration mode:
This example shows how to remove the applet configuration:
Related Commands
|
|
|
|---|---|
Displays information about the status of the configured policy. |
event manager environment
To configure an environment variable for Embedded Event Manager (EEM), use the event manager environment command. To remove the environment variable, use the no form of this command.
event manager environment variable-name variable-value
no event manager environment variable-name variable-value
Syntax Descriptiona
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an event manager variable for EEM:
This example shows how to remove the event manager variable:
Related Commands
|
|
|
|---|---|
Displays information about the configured environment variables. |
event manager policy
To register and activate an Embedded Event Manager (EEM) script policy, use the event manager policy command. To remove the event manager policy, use the no form of this command.
event manager policy policy-script-file
no event track event manager policy script-policy-file
Syntax Description
Name of the script policy file. The policy scriptfile name can be any case-sensitive, alphanumeric string up to 29 characters. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Before using the event manager policy command, define a policy by using the virtual shell (VSH) script and copy the file to the system directory. For information on how to define a policy, see the Cisco Nexus 3000 Series NX-OS System Management Configuration Guide.
Examples
This example shows how to register and activate an EEM script policy:
event manager policy internal
To register and activate an Embedded Event Manager (EEM) script policy, use the event manager policy internal command. To remove the internal event manager policy, use the no form of this command.
event manager policy internal policy-name
no event manager policy internal policy-name
Syntax Description
Name of the internal policy. The policy name can be any case-sensitive alphanumeric string up to 29 characters. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Before using the event manager policy internal command, define a policy by using the virtual shell (VSH) script and copy the file to the system directory. For information on how to define a policy, see the Cisco Nexus 3000 Series NX-OS System Management Configuration Guide.
Examples
This example shows how to register and activate an EEM internal policy:
event memory
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a memory threshold, use the event memory command. To remove the memory event criteria, use the no form of this command.
event memory [critical | minor | severe]
no event memory [critical | minor | severe]
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when a memory threshold is exceeded:
event oir
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of an Online-Insertion-Removal (OIR), use the event oir command. To remove the OIR event criteria, use the no form of this command.
event oir {fan [anyoir | insert | remove] | module [anyoir | insert | remove] | powersupply [anyoir | insert | remove] | tag tag}
no event oir {fan [anyoir | insert | remove] | module [anyoir | insert | remove] | powersupply [anyoir | insert | remove] | tag tag}
Syntax Description
Identifies this specific event when multiple events are included in the policy. The tag name can be any alphanumeric string up to 29 characters. |
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when an OIR occurs:
event policy-default
To configure an event in case a system policy is being overridden, use the event policy-default command. To use the overridden policy, use the no form of this command.
event policy-default count count time seconds
no event policy-default count count time seconds
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an event in case a system policy is being overridden:
event snmp
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run by sampling Simple Network Management Protocol (SNMP) object identifier (OID) values, use the event snmp command. To remove the SNMP event criteria, use the no form of this command.
event snmp [tag tag] oid value get-type {exact | next} entry-op {gt | ge | eq | ne | lt | le} entry-val value [{exit-comb {or | and} exit-op {gt | ge | eq | ne | lt | le} exit-val value exit-time time } | {exit-op {gt | ge | eq | ne | lt | le} exit-val value }] poll-interval value
no event snmp [tag tag] oid value get-type {exact | next} entry-op {gt | ge | eq | ne | lt | le} entry-val value [{exit-comb {or | and} exit-op {gt | ge | eq | ne | lt | le} exit-val value exit-time time } | {exit-op {gt | ge | eq | ne | lt | le} exit-val value }] poll-interval value
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify the event criteria for an EEM applet that is run by sampling SNMP object identifier values:
event storm-control
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a storm-control, use the event storm-control command. To remove the storm-control event criteria, use the no form of this command.
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when a storm-control occurs:
event syslog
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a syslog, use the event syslog command. To remove the syslog event criteria, use the no form of this command.
event syslog [occurs occurs | pattern pattern | period period | priority {alerts | critical | debugging | emergencies | errors | informational | notifications | pattern pattern | warnings} pattern | tag]
no event syslog [occurs occurs | pattern pattern | period period | priority {alerts | critical | debugging | emergencies | errors | informational | notifications | pattern pattern | warnings} pattern | tag]
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when a syslog message is matched:
event sysmgr
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of the system manager event, use the event sysmr command. To remove the system manager event criteria, use the no form of this command.
event sysmgr [memory [major major-percent minor minor-percent clear clear-percent | module module-number] | switchover count count time time-interval]
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when a syslog message is matched:
event temperature
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a temperature event, use the event temperature command. To remove the temperature event criteria, use the no form of this command.
event temperature [module module ] [sensor number ] threshold {any | major | minor}
no event temperature [module module ] [sensor number ] threshold {any | major | minor}
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when a temperature event occurs:
event track
To specify the event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of an object tracking subsystem report for the specified object number, use the event track command. To remove the report event criteria, use the no form of this command.
event track [tag tag] object-id state {any | up | down}
no event track [tag tag] object-id
Syntax Description
Defaults
Command Modes
Embedded event manager configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify that an EEM applet runs when the state of a tracked object changes:
feature ntp
To enable the Network Time Protocol (NTP), use the feature ntp command. To disable NTP, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable NTP:
This example shows how to disable NTP:
Related Commands
|
|
|
|---|---|
Configures the device to act as an authoritative NTP server. |
feature ptp
To enable the Precision Time Protocol (PTP) feature, use the feature ptp command. To disable the PTP feature, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable the PTP feature:
This example shows how to disable the PTP feature:
Related Commands
|
|
|
|---|---|
Configures the priority1 value to use when advertising this clock. |
|
Configures the priority2 value to use when advertising this clock. |
|
feature scheduler
To enable the scheduler feature on a Cisco NX-OS device, use the feature scheduler command. To disable the schedule feature, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable the scheduler feature on a Cisco NX-OS device:
This example shows how to disable the scheduler feature on a Cisco NX-OS device:
Related Commands
|
|
|
|---|---|
feature sflow
To enable the scheduler feature on a Cisco NX-OS device, use the feature sflow command. To disable the schedule feature, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable the sFlow feature on a Cisco NX-OS device:
This example shows how to disable the sFlow feature on a Cisco NX-OS device:
Related Commands
|
|
|
|---|---|
filter access-group
To configure the SPAN source sessions so that ingress (RX) traffic is filtered by using ACLS, use the filter access-group command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
This command filters only ingress traffic for SPAN and ERSPAN source ports based on an IP access-list, not an access-map.
Examples
This example shows how to filter ingress traffic at a SPAN source port:
This example shows how to configure a port channel SPAN source with ACL filtering:
This example shows how to configure a VLAN SPAN source with ACL filtering:
Related Commands
|
|
|
|---|---|
hardware profile buffer info port-threshold
To configure the port buffer information threshold so that a syslog message is generated when the buffer capacity reaches the specified percentage, use the hardware profile buffer info port-threshold command. The no form of this command is not supported.
hardware profile buffer info port-threshold front-port port-number threshold percentage
Syntax Description
Percentage of buffer capacity. The range is from 1 to 95. The default value is 90 percent. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to set the port buffer information threshold to 80 percent for port 1:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup-configuration file. |
|
hardware profile parity-error
To clear a corresponding table entry (with 0s) when a parity error is detected, use the hardware profile parity-error command. To disable this feature, use the no form of this command.
hardware profile parity-error {l2-table | l3-table} clear
no hardware profile parity-error {l2-table | l3-table} clear
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The following guidelines apply:
- When the command is used for an l2_entry table, the cleared entry should be relearned due to the traffic pattern.
- When the command is used for an l3_entry_only (host) table, the cleared entry is not be relearned.
The command is useful in the following customer configurations:
If the L2_Entry table entry is cleared, the entry should be dynamically learned through the traffic pattern. It should not be learned through IGMP or multicast.
Customers should not use the host table. The hardware profile unicast enable-host-ecmp command should be enabled. In this case, the customer node does not have any valid entries in the L3_Entry_only table, so clearing the L3_Entry_only entry table should not have any impact.
This command is effective when it is present in the running configuration and the system is booting up. In addition, the command must be enabled and after the configuration is saved, the system should be rebooted for the command to take effect.
Examples
This example shows how to clear parity errors in a Layer 2 table:
This example shows how to clear parity errors in a Layer 3 table:
Related Commands
|
|
|
|---|---|
hardware profile tap-aggregation
|
|
|
|---|---|
To enable the tap aggregation feature and reserve entries in the interface table that are needed for VLAN tagging, use the hardware profile tap-aggregation command. To disable this feature, use the no form of this command.
hardware profile tap-aggregation [l2drop]
no hardware profile tap-aggregation [l2drop]
Syntax Description
Specifies to drop non IP traffic ingress on mode tap interfaces. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use this command on all Cisco Nexus 3000 Series and Cisco Nexus 3100 Series switches.
Ensure that you run the copy running-config to startup-config command to save the configuration to startup, and reload the switch to enable tap-aggregation.
Examples
This example shows how to configure Tap Aggregation globally on the switch:
Related Commands
|
|
|
|---|---|
hardware profile unicast syslog host-table-detail
When an IPv4 host table is full and the prefixes are programmed in LPM, the following syslog message is displayed:
$ %IPFIB-2-FIB_TCAM_RESOURCE_EXHAUSTION_HOST_IPV4: FIB TCAM exhausted for IPV4 routes in Host table, IPV4 Host routes will be programmed in LPM table if possible.
With the introduction of the ALPM Mode (system routing max-mode l3) on the Cisco Nexus 3100 series switches, an additional syslog is introduced (one of the two, depending on whether the ALPM mode is enabled or not). The following syslogs are for IPv4. IPv6 has a similar syslog message.
To prevent confusion between the two syslog messages, a new CLI has been added to suppress the first log. Use the [no] hardware profile unicast syslog host-table-detail command to suppress the syslog.
hardware profile unicast syslog host-table-detail
[no] hardware profile unicast syslog host-table-detail
Syntax Description
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to suppress the existing syslog when the IPv4 or IPv6 table is full:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup-configuration file. |
|
ip access-list (session)
|
|
|
|---|---|
To create an IPv4 access control list (ACL) within a configuration session, use the ip access-list command. To remove an ACL from a configuration session, use the no form of this command.
Syntax Description
Name of the IPv4 ACL. The name can be up to 64 alphanumeric characters and cannot contain a space or quotation mark. |
Command Default
Command Modes
Global session configuration mode
Command History
|
|
|
|---|---|
Examples
This example shows how to create an IPv4 ACL for a configuration session:
Related Commands
|
|
|
|---|---|
ip domain-list
To configure the IP domain list, use the ip domain-list command. To disable the IP domain list, use the no form of the command.
ip domain-list domain-name [ use-vrf name ]
no ip domain-list domain-name [ use-vrf name ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF context configuration mode
Command History
|
|
|
Usage Guidelines
Use the ip domain-list command to configure additional domain names for the device. Use the vrf context command to enter the VRF context mode to configure additional domain names for a particular VRF.
Examples
This example shows how to configure the IP domain list for the default VRF:
This example shows how to configure the IP domain list for the management VRF:
This example shows how to configure the IP domain list for the default VRF to use the management VRF as a backup if the domain name cannot be resolved through the default VRF:
Related Commands
|
|
|
|---|---|
Displays information about the IP domain name configuration. |
ip domain-lookup
To enable the Domain Name Server (DNS) lookup feature, use the ip domain-lookup command. Use the no form of this command to disable this feature.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the DNS server lookup feature:
Related Commands
|
|
|
|---|---|
ip domain-name
To configure a domain name, use the ip domain-name command. To delete a domain name, use the no form of the command.
ip domain-name domain-name [ use-vrf name ]
no ip domain-name domain-name [ use-vrf name ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF context configuration mode
Command History
|
|
|
Usage Guidelines
Use the ip domain-name command to configure the domain name for the device. Use the vrf context command to enter the VRF context mode to configure the domain monastery for a particular VRF.
Examples
This example shows how to configure the IP domain name for the default VRF:
This example shows how to configure the IP domain name for the management VRF:
This example shows how to configure the IP domain name for the default VRF to use the management VRF as a backup if the domain name cannot be resolved through the default VRF:
Related Commands
|
|
|
|---|---|
Displays information about the IP domain name configuration. |
ip host
To define static hostname-to-address mappings in the Domain Name System (DNS) hostname cache, use the ip host command. To remove a hostname-to-address mapping, use the no form of this command.
ip host name address1 [ address2... address6 ]
no ip host name address1 [ address2... address6 ]
Syntax Description
Hostname. The name can be any case-sensitive, alphanumeric string up to 80 characters. |
|
(Optional) Up to five additional IPv4 addresses in the x.x.x.x format. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to configure a static hostname:
Related Commands
|
|
|
|---|---|
Displays information about the IP domain name configuration. |
ip name-server
To configure a name server, use the ip name-server command. To disable this feature, use the no form of the command.
ip name-server ip-address [ use-vrf name ]
no ip name-server ip-address [ use-vrf name ]
Syntax Description
(Optional) Specifies the virtual routing and forwarding (VRF) to use to reach the name-server. The name can be any case-sensitive, alphanumeric string up to 32 characters. |
Command Default
Command Modes
Global configuration mode
VRF context configuration mode
Command History
|
|
|
Usage Guidelines
Use the ip name-server command to configure the name server for the device. Use the vrf context command to enter the VRF context mode to configure the domain names for a particular VRF.
Examples
This example shows how to configure the IP name server for the default VRF:
This example shows how to configure the IP name server for the management VRF:
This example shows how to configure the IP name server for the default VRF to use the management VRF as a backup if the IP name server cannot be reached through the default VRF:
Related Commands
|
|
|
|---|---|
Displays information about the IP domain name configuration. |
|
ip port access-group (session)
To apply an IPv4 access control list (ACL) to an interface as a port ACL, use the ip port access-group command. To remove an IPv4 ACL from an interface, use the no form of this command.
ip port access-group access-list-name { in | out }
no ip port access-group access-list-name { in | out }
Syntax Description
Name of the IPv4 ACL. The name can be up to 64 alphanumeric, case-sensitive characters. |
|
Command Default
Command Modes
Session interface configuration mode
Command History
|
|
|
|---|---|
Examples
This example shows how to apply an IPv4 ACL named ip-acl-01 to the Ethernet interface 1/2 as a port ACL:
This example shows how to remove an IPv4 ACL named ip-acl-01 from Ethernet interface 1/2:
Related Commands
|
|
|
|---|---|
logging abort
To discard the pending changes to the syslog server configuration, use the logging abort command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to discard the changes made to the syslog server configuration:
Related Commands
|
|
|
|---|---|
Enables the distribution of the syslog server configuration to network switches using the CFS infrastructure. |
|
Displays the pending changes to the syslog server configuration. |
|
logging commit
To commit the pending changes to the syslog server configuration for distribution to the switches in the fabric, use the logging commit command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to commit the distribution of the syslog server configuration:
Related Commands
|
|
|
|---|---|
Enables the distribution of the syslog server configuration to network switches using the CFS infrastructure. |
|
logging console
To enable logging messages to the console session, use the logging console command. To disable logging messages to the console session, use the no form of this command.
logging console [ severity-level ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to enable logging messages with a severity level of 4 (warning) or higher to the console session:
Related Commands
|
|
|
|---|---|
logging distribute
To enable the distribution of the syslog server configuration to network switches using the Cisco Fabric Services (CFS) infrastructure, use the logging distribute command. To disable the distribution, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to enable the distribution of the syslog server configuration:
This example shows how to disable the distribution of the syslog server configuration:
Related Commands
|
|
|
|---|---|
Cancels the pending changes to the syslog server configuration. |
|
Commits the changes to the syslog server configuration for distribution to the switches in the fabric. |
|
logging event
To log interface events, use the logging event command. To disable logging of interface events, use the no form of this command.
logging event { link-status | trunk-status } { default | enable }
no logging event { link-status | trunk-status } { default | enable }
Syntax Description
Specifies to the default logging configuration is used by interfaces not explicitly configured. |
|
Enables the logging to override the port level configuration. |
Command Default
Command Modes
Global configuration mode
Switch profile configuration mode
Command History
|
|
|
|---|---|
Support to log interface events was added in switch profiles. |
Examples
This example shows how to log interface events:
This example shows how to log TRUNK interface events in a switch profile:
Related Commands
|
|
|
|---|---|
Displays information about the switch profile and the configuration revision. |
|
logging event port
To log events on an interface, use the logging event port command. To disable logging of interface events, use the no form of this command.
logging event port { link-status | trunk-status } [ default ]
no logging event port { link-status | trunk-status }
Syntax Description
(Optional) Specifies the default logging configuration that is used by interfaces not explicitly configured. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to log interface events:
Related Commands
|
|
|
|---|---|
logging ip access-list cache entries num_entries
Sets the maximum number of log entries cached in software. The range is from 0 to 1000000 entries. The default value is 8000 entries.
logging ip access-list cache entries <num_entries>
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to log interface events:
Related Commands
|
|
|
|---|---|
logging ip access-list cache interval seconds
Sets the number of seconds between log updates. Also if an entry is inactive for this duration, it is removed from the cache. The range is from 5 to 86400 seconds. The default value is 300 seconds.
logging ip access-list cache interval <seconds>
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to log interface events:
Related Commands
|
|
|
|---|---|
logging ip access-list cache threshold num_packets
Sets the number of packet matches before an entry is logged. The range is from 0 to 1000000 packets. The default value is 0 packets, which means that logging is not triggered by the number of packet matches.
logging ip access-list cache threshold <num_packets>
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to log interface events:
Related Commands
|
|
|
|---|---|
logging level
To enable logging messages from a defined facility that have the specified severity level or higher, use the logging level command. To disable logging messages from a defined facility, use the no form of this command.
logging level facility severity-level
no logging level facility severity-level
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to enable logging messages from the AAA facility that have a severity level of 2 or higher:
This example shows how to enable error logging messages for the Precision Time Protocol (PTP) packets:
Related Commands
|
|
|
|---|---|
logging logfile
To configure the name of the log file used to store system messages and the minimum severity level to log, use the logging logfile command. To disable logging to the log file, use the no form of this command.
logging logfile logfile-name severity-level [ size bytes ]
no logging logfile [ logfile-name severity-level [ size bytes ]]]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to configure a log file called logfile to store system messages and set its severity level to 4:
Related Commands
|
|
|
|---|---|
logging module
To enable module log messages, use the logging module command. To disable module log messages, use the no form of this command.
logging module [ severity-level ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable module log messages:
Related Commands
|
|
|
|---|---|
logging monitor
To enable the device to log messages to the monitor (terminal line), use the logging monitor command. To disable monitor log messages, use the no form of this command.
logging monitor [ severity-level ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
This configuration applies to Telnet and Secure Shell (SSH) sessions.
Examples
This example shows how to enable monitor log messages:
Related Commands
|
|
|
|---|---|
logging server
To configure a remote syslog server at the specified hostname or IPv4/IPv6 address, use the logging server command. To disable the remote syslog server, use the no form of this command.
logging server host [ severity-level ] [ facility facility | use-vrf { vrf_name | management }]
no logging server host [ severity-level ] [ facility facility | use-vrf { vrf_name | management }]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure a remote syslog server at a specified IPv4 address, using the default outgoing facility:
This example shows how to configure a remote syslog server at a specified hostname with severity level 5 or higher:
Related Commands
|
|
|
|---|---|
logging source-interface
To enable a source interface for the remote syslog server, use the logging source-interface command. To disable the source interface, use the no form of this command.
logging source-interface [ ethernet slot / port | loopback interface-number | mgmt interface-number | port-channel port-channel-number | vlan interface-number | tunnel interface-number ]
no logging source-interface [ ethernet slot / port | loopback interface-number | mgmt interface-number | port-channel port-channel-number | vlan interface-number | tunnel interface-number ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to enable a source interface for the syslog server:
Related Commands
|
|
|
|---|---|
logging timestamp
To set the logging time-stamp units, use the logging timestamp command. To reset the logging time-stamp units to the default, use the no form of this command.
logging timestamp { microseconds | milliseconds | seconds }
no logging timestamp { microseconds | milliseconds | seconds }
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to set the logging time-stamp units to microseconds:
Related Commands
|
|
|
|---|---|
mode tap-aggregation
To allow the attachment of an ACL with a Tap Aggregation policy to an interface, use the mode tap-aggregation command. To disallow the attachment of such a policy to an interface, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can use this command on all Cisco Nexus 3000 Series and Cisco Nexus 3100 Series switches.
To be able to apply an ACL with a Tap Aggregation policy on an interface, you must run the mode tap-aggregation command.
Examples
This example shows how to enable mode tap-aggregation and apply the ACL on an interface:
Related Commands
|
|
|
|---|---|
monitor erspan origin ip-address
To configure the Encapsulated Remote Switched Port Analyzer (ERSPAN) global origin IP address, use the monitor espan origin ip-address command. To remove the ERSPAN global origin IP address configuration, use the no form of this command.
monitor erspan origin ip-address ip-address [ global ]
no monitor erspan origin ip-address ip-address [ global ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
When you change the origin IP address, it impacts all the sessions.
Note On a Cisco Nexus 3000 Series switch, only global origin IP address is supported.
Examples
This example shows how to configure the ERSPAN global origin IP address:
This example shows how to remove the ERSPAN global origin IP address:
Related Commands
|
|
|
|---|---|
monitor session
To create a new Switched Port Analyzer (SPAN) or an Encapsulated Remote Switched Port Analyzer (ERSPAN) session configuration for analyzing traffic between ports, or add to an existing session configuration, use the monitor session command. To clear SPAN or ERSPAN sessions, use the no form of this command.
monitor session { session-number [ shut | type { local | erspan-destination | erspan-source }] | all shut }
no monitor session { session-number | all } [ shut ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
To ensure that you are working with a completely new session, you can clear the desired session number or all SPAN sessions.
After you create an ERSPAN session, you can describe the session and add interfaces and VLANs as sources and destinations.
Examples
This example shows how to create a SPAN session:
This example shows how to enter the monitor configuration mode for configuring SPAN session number 9 for analyzing traffic between ports:
This example shows how to configure any SPAN destination interfaces as Layer 2 SPAN monitor ports before activating the SPAN session:
This example shows how to configure a typical SPAN destination trunk interface:
This example shows how to create an ERSPAN session:
Related Commands
|
|
|
|---|---|
Sets the maximum transmission value (MTU) for ERSPAN packets. |
|
mpls strip dest-mac
To configure the destination MAC address for stripped egress frames, use the mpls strip dest-mac command. To delete the configured destination MAC address, use the no form of this command.
mpls strip dest-mac mac-address
no mpls strip dest-mac mac-address
Syntax Description
Specifies the destination MAC address for egress frames that are stripped of their headers. The MAC address can be specified in one of the following four forms: |
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to configure the destination MAC address for egress frames:
Related Commands
|
|
|
|---|---|
mpls strip
To enable the MPLS stripping feature globally, use the mpls strip command. To disable this feature, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to enable MPLS stripping:
This example shows how to disable MPLS stripping:
Related Commands
|
|
|
|---|---|
Configures the destination MAC address for stripped egress frames. |
|
mpls strip label
To add a static MPLS label, use the mpls strip label command. To delete a static MPLS label, use the no form of this command.
no mpls strip label label | all
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Before adding static labels to the MPLS label table, ensure the following:
- Tap Aggregation is enabled.
- Tap Aggregation policy is configured.
- The Tap aggregation policy is attached to an interface.
You can store up to 1025 static labels in an MPLS label table. However, the table can store up to 15000 labels, including dynamic labels.
Examples
This example shows how to add a static MPLS label:
This example shows how to delete a static MPLS label:
This example shows how to delete all static MPLS labels:
Related Commands
|
|
|
|---|---|
Configures the destination MAC address for stripped egress frames. |
|
mpls strip label-age
To define the amount of time after which dynamic MPLS labels age out, use the mpls strip label-age command. To delete the defined age, use the no form of this command.
Syntax Description
Specifies the amount of time after which dynamic MPLS labels age out. The value of the age can range from 1 to 10000000 seconds. |
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to configure label age for dynamic MPLS labels:
Related Commands
|
|
|
|---|---|
Configures the destination MAC address for stripped egress frames. |
|
ntp
To configure the Network Time Protocol (NTP) peers and servers for the switch, use the ntp command. To remove configured peers and servers, use the no form of this command.
ntp { peer hostname | server hostname } [ prefer ] [ use-vrf vrf-name ]
no ntp { peer hostname | server hostname }
Syntax Description
(Optional) Specifies this peer/server as the preferred peer/server. |
|
(Optional) Specifies the virtual routing and forwarding (VRF) used to reach this peer/server. |
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to form a server association with a server:
This example shows how to form a peer association with a peer:
This example shows how to delete an association with a peer:
Related Commands
|
|
|
|---|---|
ntp abort
To discard the Network Time Protocol (NTP) configuration, use the ntp abort command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to abort the NTP configuration:
Related Commands
|
|
|
|---|---|
ntp access-group
To configure an access group to control Network Time Protocol (NTP) access, use the ntp access-group command. To remove the NTP peer access group, use the no form of this command.
ntp access-group {peer | serve | serve-only | query-only} access-list-name
no ntp access-group {peer | serve | serve-only | query-only} access-list-name
Syntax Description
Defaults
If you do not configure any access groups, NTP access is granted to all devices.
Command Modes
Command History
|
|
|
Usage Guidelines
The ntp access-group match-all command causes the access group options to be scanned in the following order, from least restrictive to most restrictive: peer, serve, serve-only, query-only. If the incoming packet does not match the peer access group, the packet goes to the serve access group to be processed. If the packet does not match the serve access group, it goes to the next access group and so on. This command also enables IPv6 access group processing.
Examples
This example shows how to configure a peer access group for NTP:
switch# configure terminal
switch(config)# ntp access-group peer Admin_Group_123
switch(config)#
This example shows how to remove an NTP peer access group:
switch# configure terminal
switch(config)# no ntp access-group peer Admin_Group_123
switch(config)#
Related Commands
|
|
|
|---|---|
ntp authenticate
To enable Network Time Protocol (NTP) authentication, use the ntp authenticate command. To disable NTP authentication, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable NTP authentication:
This example shows how to disable NTP authentication:
Related Commands
|
|
|
|---|---|
Configures one or more keys that a time source must provide in its NTP packets in order for the device to synchronize to it. |
|
ntp authentication-key
To configure a Network Time Protocol (NTP) authentication key, use the ntp authentication-key command. To remove the NTP authentication key, use the no form of this command.
no ntp authentication-key number
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
The device does not synchronize to a time source unless the source has one of these authentication keys and the key number is specified by the ntp trusted-key command.
Examples
This example shows how to configure an NTP authentication key:
switch# configure terminal
switch(config)# ntp authentication-key 42
switch(config)#
This example shows how to remove the NTP authentication key:
switch# configure terminal
switch(config)# no ntp authentication-key 42
switch(config)#
Related Commands
|
|
|
|---|---|
Configures one or more keys that a time source must provide in its NTP packets in order for the device to synchronize to it. |
ntp broadcast
To enable a Network Time Protocol (NTP) IPv4 broadcast server on the specified interface, use the ntp broadcast command. To disable the NTP IPv4 broadcast server, use the no form of this command.
ntp broadcast [destination ip-address] [key key-id] [version number]
no ntp broadcast [destination ip-address] [key key-id] [version number]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Use NTP broadcast or multicast associations when time accuracy and reliability requirements are modest, your network is localized, and the network has more than 20 clients. We recommend that you use NTP broadcast or multicast associations in networks that have limited bandwidth, system memory, or CPU resources.
Note Time accuracy is marginally reduced in NTP broadcast associations because information flows only one way.
Examples
This example shows how to enable an NTP IPv4 broadcast server on the interface:
ntp broadcastdelay
To configure the estimated Network Time Protocol (NTP) broadcast round-trip delay, use the ntp broadcastdelay command. To disable the estimated broadcast round-trip delay, use the no form of this command.
Syntax Description
(Optional) Broadcast round-trip delay in microseconds. The range is from 1 to 999999. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Use NTP broadcast or multicast associations when time accuracy and reliability requirements are modest, your network is localized, and the network has more than 20 clients. We recommend that you use NTP broadcast or multicast associations in networks that have limited bandwidth, system memory, or CPU resources.
Note Time accuracy is marginally reduced in NTP broadcast associations because information flows only one way.
Examples
This example shows how to configure the estimated broadcast round-trip delay:
ntp commit
To apply the pending configuration pertaining to the Network Time Protocol (NTP) distribution session in progress, use the ntp commit command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to commit changes to the active NTP configuration:
Related Commands
|
|
|
|---|---|
ntp disable
To disable Network Time Protocol (NTP), use the ntp disable command. To reenable NTP, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to disable NTP:
switch# ntp disable
ntp distribute
To enable configuration distribution for Network Time Protocol (NTP), use the ntp distribute command. To disable this feature, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to distribute the active NTP configuration:
Related Commands
|
|
|
|---|---|
Commits the NTP configuration changes to the active configuration. |
|
ntp logging
To enable Network Time Protocol (NTP) logging, use the ntp logging command. To disable NTP logging, use the no form of this command.
Syntax Description
Defaults
Command Modes
Global configuration mode (config)
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable NTP logging:
switch# configure terminal
switch(config)# ntp logging
switch(config)#
This example shows how to disable NTP logging:
switch# configure terminal
switch(config)# no ntp logging
switch(config)#
Related Commands
|
|
|
|---|---|
ntp master
To configure the device to act as an authoritative Network Time Protocol (NTP) server, use the ntp master command. To remove the device as an authoritative NTP server, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
This command enables the device to distribute time even when it is not synchronized to an existing time server.
Examples
This example shows how to configure the device to act as an authoritative NTP server:
This example shows how to remove a device as an authoritative NTP server:
Related Commands
|
|
|
|---|---|
Displays information about the NTP configuration that is currently running on the switch. |
ntp multicast
To enable an Network Time Protocol (NTP) IPv4 or IPv6 multicast server on the interface, use the ntp multicast command. To disable an NTP multicast server on the interface, use the no form of this command.
ntp multicast [ipv4-address | ipv6 address] [key key-id] [ttl value] [version number]
no ntp multicast [ipv4-address | ipv6 address] [key key-id] [ttl value] [version number]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You can use the ntp multicast command to configure an NTP IPv4 or IPv6 multicast server on an interface. The device then sends multicast packets through that interface periodically.
Use NTP broadcast or multicast associations when time accuracy and reliability requirements are modest, your network is localized, and the network has more than 20 clients. We recommend that you use NTP broadcast or multicast associations in networks that have limited bandwidth, system memory, or CPU resources.
Examples
This example shows how to configure an NTP IPv6 multicast server on an interface:
Related Commands
|
|
|
|---|---|
Displays information about the NTP configuration that is currently running on the switch. |
ntp multicast client
To configure a Network Time Protocol (NTP) multicast client on an interface, use the ntp multicast client command. To disable an NTP multicast client on the interface, use the no form of this command.
ntp multicast client [ipv4-address | ipv6 address]
no ntp multicast client [ipv4-address | ipv6 address]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You can use the ntp multicast client command to configure an NTP multicast client on an interface. The device then listens to NTP multicast messages and discards any messages that come from an interface for which multicast is not configured.
Use NTP broadcast or multicast associations when time accuracy and reliability requirements are modest, your network is localized, and the network has more than 20 clients. We recommend that you use NTP broadcast or multicast associations in networks that have limited bandwidth, system memory, or CPU resources.
Examples
This example shows how to configure an NTP IPv6 multicast server on an interface:
Related Commands
|
|
|
|---|---|
Displays information about the NTP configuration that is currently running on the switch. |
ntp peer
To configure a device as a Network Time Protocol (NTP) peer, use the ntp peer command. To remove the device as an NTP peer, use the no form of this command.
ntp peer { ip-address | ipv6-address | dns-name }
no ntp peer { ip-address | ipv6-address | dns-name }
Syntax Description
Defaults
Command Modes
Global configuration mode (config)
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an NTP peer:
switch(config)# configure terminal
switch(config)# ntp peer 190.0.2.1
switch(config)#
switch# configure terminal
switch(config)# no ntp peer 190.0.2.1
switch(config)#
Related Commands
|
|
|
|---|---|
ntp server
To configure a Network Time Protocol (NTP) server, use the ntp server command. To remove the NTP server, use the no form of this command.
ntp server { ip-address | ipv6-address | dns-name }
no ntp server { ip-address | ipv6-address | dns-name }
Syntax Description
Defaults
Command Modes
Global configuration mode (config)
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an NTP server:
switch(config) configure terminal
switch(config)# ntp server 190.0.2.10
switch(config)#
This example shows how to remove an NTP server:
switch# configure terminal
switch(config)# no ntp server 190.0.2.10
switch(config)#
Related Commands
|
|
|
|---|---|
ntp source
To configure the Network Time Protocol (NTP) source, use the ntp source command. To remove the NTP source, use the no form of this command.
Syntax Description
IPv4 or IPv6 address of the source. The IPv4 address format is dotted decimal, x.x.x.x. The IPv6 address format is hex A:B::C:D. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the NTP source:
switch(config)# ntp source 192.0.2.3
This example shows how to remove the NTP source:
switch(config)# no ntp source 192.0.2.3
Related Commands
|
|
|
|---|---|
ntp source-interface
To configure the Network Time Protocol (NTP) source interface, use the ntp source-interface command. To remove an NTP source interface, use the no form of this command.
ntp source-interface type interface-number
no ntp source-interface type interface-number
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an NTP source interface:
This example shows how to remove an NTP source configuration:
|
|
|
|---|---|
ntp sync-retry
To retry synchronization with the configured Network Time Protocol (NTP) servers, use the ntp sync-retry command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to retry synchronization with the configured NTP servers:
Related Commands
|
|
|
|---|---|
ntp trusted-key
To configure one or more keys that a time source must provide in its Network Time Protocol (NTP) packets in order for the device to synchronize to it, use the ntp trusted-key command. To remove the NTP trusted key, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
This command provides protection against accidentally synchronizing the device to a time source that is not trusted.
Examples
This example shows how to configure an NTP trusted key:
switch# configure terminal
switch(config)# ntp trusted-key 42
switch(config)#
This example shows how to remove the NTP trusted key:
switch# configure terminalswitch(config)# no ntp trusted-key 42
switch(config)#
Related Commands
|
|
|
|---|---|
periodic-inventory (Call Home)
To configure the switch to periodically send a message with an inventory of all software services currently enabled and running on the device with hardware inventory information, use the periodic-inventory command. To disable the periodic messages, use the no form of this command.
periodic-inventory notification [ interval time-period | timeofday time-of-day ]
no periodic-inventory notification [ interval time-period | timeofday time-of-day ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The switch generates two Call Home notifications: periodic configuration messages and periodic inventory messages.
Examples
This example shows how to configure a periodic inventory notification to generate every 5 days:
This example shows how to disable a periodic inventory notification for Call Home:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
phone-contact (Call Home)
To configure the phone number for the primary person responsible for the device, use the phone-contact command. To remove a phone contact, use the no form of this command.
Syntax Description
Phone number in international phone number format, such as +1-800-123-4567. The phone number can be a maximum of 17 alphanumeric characters and cannot contain spaces. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure a phone number for the primary person responsible for the device:
Related Commands
|
|
|
|---|---|
Configures the street address for the primary person responsible for the switch. |
ptp
To enable the Precision Time Protocol (PTP) on an interface, use the ptp command. To disable PTP on an interface, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable PTP on an interface:
This example shows how to disable PTP on an interface:
Related Commands
ptp announce
To configure the interval between Precision Time Protocol (PTP) announce messages on an interface or the number of PTP intervals before a timeout occurs on an interface, use the ptp announce command. To remove the interval configuration for PTP messages, use the no form of this command.
ptp announce { interval seconds | timeout count }
no ptp announce { interval seconds | timeout count }
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Make sure that you have globally enabled PTP on the switch and configured the source IP address for PTP communication.
Examples
This example shows how to configure the interval between PTP announce messages on an interface:
This example shows how to remove the interval configuration for PTP messages from an interface:
Related Commands
ptp delay-request minimum interval
To configure the minimum interval allowed between Precision Time Protocol (PTP) delay-request messages when the port is in the master state, use the ptp delay-request minimum interval command. To remove the minimum interval configuration for PTP delay-request messages, use the no form of this command.
ptp delay-request minimum interval seconds
no ptp delay-request minimum interval seconds
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Make sure that you have globally enabled PTP on the switch and configured the source IP address for PTP communication.
Examples
This example shows how to configure the minimum interval allowed between PTP delay-request messages:
This example shows how to remove the minimum interval configuration for PTP delay-request messages:
Related Commands
ptp domain
To configure a domain number for the Precision Time Protocol (PTP) clock, use the ptp domain command. To remove the domain configuration for the PTP clock, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure a domain number for the PTP clock:
This example shows how to remove the PTP domain configuration:
Related Commands
|
|
|
|---|---|
Configures the priority1 value to use when advertising this clock. |
|
Configures the priority2 value to use when advertising this clock. |
|
ptp priority1
To configure the priority1 value when advertising the Precision Time Protocol (PTP) clock, use the ptp priority1 command. To remove the priority1 value, use the no form of this command.
no ptp priority1 priority-number
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the priority1 value when advertising the PTP clock:
This example shows how to remove the priority1 value when advertising the PTP clock:
Related Commands
|
|
|
|---|---|
Configures the priority2 value to use when advertising this clock. |
|
ptp priority2
To configure the priority2 value when advertising the Precision Time Protocol (PTP) clock, use the ptp priority2 command. To remove the priority2 value when advertising the PTP, use the no form of this command.
no ptp priority2 priority-number
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the priority2 value when advertising the PTP clock:
This example shows how to remove the priority2 value configuration for use when advertising the PTP clock:
Related Commands
|
|
|
|---|---|
Configures the priority1 value to use when advertising this clock. |
|
ptp source
To configure the global source for all the Precision Time Protocol (PTP) packets, use the ptp source command. To remove the global source for PTP packets, use the no form of this command.
ptp source ip_address [ vrf { vrf-name | management ]
no ptp source ip_address [ vrf { vrf-name | management ]
Syntax Description
Specifies the virtual routing and forwarding (VRF) instance. |
|
Name of the VRF. The name can be a maximum of 32 alphanumeric characters and is case sensitive. |
|
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the global source for all the PTP packets:
This example shows how to remove the global source configuration for all the PTP packets:
Related Commands
|
|
|
|---|---|
Configures the priority1 value to use when advertising this clock. |
|
Configures the priority2 value to use when advertising this clock. |
|
ptp sync interval
To configure the interval between Precision Time Protocol (PTP) synchronization messages on an interface, use the ptp sync interval command. To remove the interval configuration for PTP messages synchronization, use the no form of this command.
Syntax Description
Log seconds. The range is from –6 to 1. Beginning in Release 7.0(3)|2(1), the value is -3 to 1. |
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Make sure that you have globally enabled PTP on the switch and configured the source IP address for PTP communication.
A Cisco Nexus 3000 Series switch must be synchronized on the Slave port with a sync log interval value of less than or equal to -3. Any Master ports on the switch that are connected to downlink Cisco Nexus 3000 Series switches must be configured for a sync log interval value that is less than or equal to -3.
Examples
This example shows how to configure the interval between PTP synchronization messages on an interface:
This example shows how to remove the interval configuration for PTP messages synchronization:
Related Commands
ptp vlan
To configure a VLAN to generate the Precision Time Protocol (PTP) messages for Layer 2 interfaces, use the ptp vlan command. To remove the PTP VLAN configuration from an interface, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Make sure that you have globally enabled PTP on the switch and configured the source IP address for PTP communication.
Use this command only on Layer 2 Ethernet interfaces (1 Gigabit, 10-Gigabit, 40-Gigabit) or port-channel members.
By default, VLAN 1 is used to generate the PTP messages on an interface. You must explicitly configure the following VLANs to generate PTP messages on interfaces:
Examples
This example shows how to configure the PTP VLAN value on an interface:
This example shows how to remove the PTP VLAN value from an interface:
Related Commands
rmon alarm
To configure Remote Monitoring (RMON) alarms on any integer-based Simple Network Management Protocol (SNMP) management information base (MIB) object, use the rmon alarm command. To remove an RMON alarm, use the no form of this command.
rmon alarm alarm-no MIB-obj sample-interval { absolute | delta } rising-threshold rising-threshold-value { event-index falling-threshold fall-threshold-value [ event-index ] [ owner name ] | falling-threshold fall-threshold-value [ event-index ] [ owner name ]}
no rmon alarm alarm-no MIB-obj sample-interval { absolute | delta } rising-threshold rising-threshold-value { event-index falling-threshold fall-threshold-value [ event-index ] [ owner name ] | falling-threshold fall-threshold-value [ event-index ] [ owner name ]}
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Before you use this command, you must have configured an SNMP user and enabled SNMP notifications using the snmp-server user and snmp-server enable traps command, respectively.
You can only configure an RMON alarm on an integer-based SNMP MIB object. The MIB object must be in standard dot notation. For example, 1.3.6.1.2.1.2.2.1.17 represents ifOutOctets.17.
Absolute samples take the current snapshot of the MIB object value. Delta samples take two consecutive samples and calculate the difference between them. For example, you can set a delta type rising alarm on an error counter MIB object. If the error counter delta exceeds this value, you can trigger an event that sends an SNMP notification and logs the rising alarm event. This rising alarm will not occur again until the delta sample for the error counter drops below the falling threshold.
You can associate a particular event to each RMON alarm. RMON supports the following event types:
- SNMP notification—Sends an SNMP risingAlarm or fallingAlarm notification when the associated alarm triggers.
- Log—Adds an entry in the RMON log table when the associated alarm triggers.
- Both—Sends an SNMP notification and adds an entry in the RMON log table when the associated alarm triggers.
You can specify a different event for a falling alarm and a rising alarm.
Examples
This example shows how to configure an RMON alarm:
Related Commands
|
|
|
|---|---|
Saves the running configuration to the startup configuration file. |
|
rmon event
To configure Remote Monitoring (RMON) events to associate with RMON alarms, use the rmon event command. To remove an RMON event, use the no form of this command.
rmon event event-index [ description string ] [ log ] [ trap ] [ owner name ]
no rmon event event-index [ description string ] [ log ] [ trap ] [ owner name ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Before you use this command, you must have configured an SNMP user and enabled SNMP notifications using the snmp-server user and snmp-server enable traps command, respectively.
Examples
This example shows how to configure an RMON event:
Related Commands
|
|
|
|---|---|
Saves the running configuration to the startup configuration file. |
|
rmon hcalarm
To configure a high-capacity Remote Monitoring (RMON) alarm, use the rmon hcalarm command. To remove a high-capacity RMON alarm, use the no form of this command.
rmon hcalarm alarm-no MIB-obj sample-interval { absolute | delta } startupalarm startup-alarm-type rising-threshold rising-threshold-value event-index falling-threshold fall-threshold-value [ event-index ] [ owner name ]
no rmon hcalarm alarm-no MIB-obj sample-interval { absolute | delta } startupalarm startup-alarm-type rising-threshold rising-threshold-value event-index falling-threshold fall-threshold-value [ event-index ] [ owner name ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Before you use this command, you must have configured an SNMP user and enabled SNMP notifications using the snmp-server user and snmp-server enable traps command, respectively.
You can configure a high-capacity RMON alarm on any integer-based SNMP MIB object. The MIB object must be in standard dot notation. For example, 1.3.6.1.2.1.2.2.1.17 represents ifOutOctets.17.
Absolute samples take the current snapshot of the MIB object value. Delta samples take two consecutive samples and calculate the difference between them. For example, you can set a delta type rising alarm on an error counter MIB object. If the error counter delta exceeds this value, you can trigger an event that sends an SNMP notification and logs the rising alarm event. This rising alarm does not occur again until the delta sample for the error counter drops below the falling threshold.
You can associate a particular event to each high-capacity RMON alarm. RMON supports the following event types:
- SNMP notification—Sends an SNMP risingAlarm or fallingAlarm notification when the associated high-capacity alarm triggers.
- Log—Adds an entry in the RMON log table when the associated high-capacity alarm triggers.
- Both—Sends an SNMP notification and adds an entry in the RMON log table when the associated high-capacity alarm triggers.
You can specify a different event for a falling high-capacity alarm and a rising high-capacity alarm.
Examples
This example shows how to configure an RMON high-capacity alarm:
Related Commands
|
|
|
|---|---|
Saves the running configuration to the startup configuration file. |
|
scheduler
To create or schedule a scheduler job, use the scheduler command. To remove a job or scheduled job, use the no form of this command.
scheduler {aaa-authentication [username username] password [0 | 7] password |
job name job-name | logfile size filesize | schedule name schedule-name | transport email [from email address] [reply to email address] [smtp-server]}
no scheduler {aaa-authentication [username username] password [0 | 7] password |
job name job-name | logfile size filesize | schedule name schedule-name | transport email [from email address] [reply to email address] [smtp-server]}
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
To use the scheduler command, you must enable the scheduler. To enable the scheduler, use the feature scheduler command.
Remote users must authenticate with the device by using the scheduler aaa-authentication command before using the scheduler command to configure a maintenance job.
Note The commands within a scheduler job must be entered in a single line separated by a semicolon (;).
Usage Guidelines
Examples
This example shows how to create a scheduler job that saves the running configuration to a file in bootflash and then copies the file from bootflash to a TFTP server. The filename is created using the current timestamp and switch name.
switch(config)# scheduler job name backup-cfg
switch(config-job)# cli var name timestamp $(TIMESTAMP);copy running-config bootflash:/$(SWITCHNAME)-cfg.$(timestamp);copy bootflash:/$(SWITCHNAME)-cfg.$(timestamp) tftp://1.2.3.4/ vrf management
switch(config-job)# end
This example shows how to remove a scheduler job:
switch(config)# no scheduler job name backup-cfg
This example shows how to schedule a scheduler job to run daily at 12:00 a.m.:
switch(config)# scheduler schedule name daily
switch(config-schedule)# job name backup-cfg
switch(config-schedule)# end
Related Commands
|
|
|
|---|---|
sflow agent-ip
To configure an IP address to the sFlow Agent, use the sflow agent-ip command. To remove the IP address, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You must specify a valid IP address to enable sFlow functionality.
Examples
This example shows how to configure the IPv4 address of the sFlow Agent.
switch(config)# sflow agent-ip 192.0.2.3
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
sflow collector-ip
To configure the sFlow analyzer address, use the sflow collector-ip command. To remove the sFlow analyzer address, use the no form of this command.
sflow collector-ip ip-address vrf-instance
no sflow collector-ip ip-address vrf-instance
Syntax Description
Specifies the virtual router context (VRF) instance. The VRF can be one of the following: |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You must use the vrf-management option if the sFlow data collector is on the network connected to the management port
You must use the vrf-default option if the sFlow data collector is on the network connected to the front panel ports.
Examples
This example shows how to configure the IPv4 address of the sFlow data collector that is connected to the management port.
switch# configure terminal
switch(config)# sflow collector-ip 192.0.2.5 vrf-management
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
sflow collector-port
To configure a destination port for the sFlow datagram, use the sflow collector-port command. To remove the destination port, use the no form of this command.
sflow collector-port collector-port
no sflow collector-port collector-port
Syntax Description
UDP port of the sFlow analyzer. The range for the collector-port is from 0 to 65535. The default value is 6343. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the destination port for the sFlow datagrams.
switch# configure terminal
switch(config)# sflow collector-port 7000
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
sflow counter-poll-interval
To configure an interval between sample counters associated with the datagram, use the sflow collector-poll-interval command. To remove the interval, use the no form of this command.
sflow counter-poll-interval poll-interval
no sflow counter-poll-interval poll-interval
Syntax Description
Poll interval for an interface. The range for the poll-interval is from 0 to 2147483647 seconds. The default value is 20. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the sFlow poll interval for an interface.
switch# configure terminal
switch(config)# sflow counter-poll-interval 100
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
sflow data-source
To configure a port or range of ports for the sFlow sampling data source, use the sflow data-source command. To remove the port, use the no form of this command.
sflow data-source interface [ ethernet slot / port [ -port ] | port-channel channel-number ]
no sflow data-source interface [ ethernet slot / port [ -port ] | port-channel channel-number ]
Syntax Description
The slot or port or range of ports for an Ethernet data source. |
|
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
If you want to use a port channel as the data source, enusre that you have already configured the port channel and you know the port channel number.
Examples
This example shows how to configure Ethernet ports 5 through 12 for the sFlow sampler.
switch# configure terminal
switch(config)# sflow data-source interface ethernet 1/5-12
switch(config)# copy running-config startup-config
This example shows how to configure port channel 100 for the sFlow sampler.
switch# configure terminal
switch(config)# sflow data-source interface port-channel 100
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
sflow max-datagram-size
To configure the maximum number of data bytes that can be sent in a single sample datagram, use the sflow max-datagram-size command. To remove the maximum of data bytes, use the no form of this command.
sflow max-datagram-size datagram-size
no sflow max-datagram-size datagram-size
Syntax Description
Maximum datagram size. The range for the datagram-size is from 200 to 9000 bytes. The default value is 1400. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure sFlow maximum datagram size.
switch# configure terminal
switch(config)# sflow maximum-datagram-size 2000
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
sflow max-sampled-size
To configure the maximum number of bytes copied from the sampled packet, use the sflow max-sampled-size command. To remove the maximum bytes, use the no form of this command.
sflow max-sampled-size sampling-size
no sflow max-sampled-size sampling-size
Syntax Description
sFlow maximum sampling size packets. The range for the sampling-size is from 64 to 256 bytes. The default value is 128. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the maximum sampling size for the sFlow Agent.
switch# configure terminal
switch(config)# sflow maximum-sampled-size 200
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
sflow sampling-rate
To configure the sFlow sample rate for packets, use the sflow sampling-rate command. To remove the sample rate, use the no form of this command.
sflow sampling-rate sampling-rate
no sflow max-sampling-rate sampling-rate
Syntax Description
sFlow sampling rate for packets. The sampling-rate can be an integer between 4096 and 1000000000. The default value is 4096. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to set the sampling rate to 50,000.
switch# configure terminal
switch(config)# sflow sampling-rate 50000
switch(config)# copy running-config startup-config
Related Commands
|
|
|
|---|---|
show callhome
To display the Call Home configuration information, use the show callhome command.
show callhome [ pending | pending-diff | session | status ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the Call Home configuration information:
Related Commands
|
|
|
|---|---|
show callhome destination-profile
To display the Call Home destination profile information, use the show callhome destination-profile command.
show callhome destination-profile [ profile { CiscoTAC-1 | profile-name | full-txt-destination | short-txt-destination }]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display information about the Call Home destination profiles:
This example shows how to display information about a specific Call Home destination profile:
Related Commands
|
|
|
|---|---|
show callhome transport-email
To display information about the e-mail configuration for Call Home, use the show callhome transport-email command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the transport configuration for Call Home:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
show callhome user-def-cmds
To display the user-defined CLI show commands added to a Call Home alert group, use the show callhome user-def-cmds command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the user-defined CLI show commands added to an alert group:
Related Commands
|
|
|
|---|---|
show diagnostic bootup level
To display the current bootup diagnostic level on the switch, use the show diagnostic bootup level command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the current bootup diagnostic level:
Related Commands
|
|
|
|---|---|
Configures the bootup diagnostic level for a faster module bootup time. |
|
show diagnostic result
To display the results of the diagnostic tests, use the show diagnostic result command.
show diagnostic result module { module-no | all }
Syntax Description
Specifies the module for which diagnostic results are displayed. |
|
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the diagnostic results for a specific module:
Related Commands
|
|
|
|---|---|
Configures the bootup diagnostic level for a faster module bootup time. |
|
show event manager environment
To display information about the configured environment variables, use the show event manager environment command.
show event manager environment {variable-name | all}
Syntax Descriptiona
Name of the environment variable. The variable name can be any alphanumeric string up to 29 characters. |
|
Displays information about all the configured environment variables. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the configured environment variables:
Related Commands
show event manager event-types
To display information about the event manager event types, use the show event manager event-types command.
show event manager event-types variable-name | all | module [slot]
Syntax Description
(Optional) Displays information about the specified event type. |
|
(Optional) Displays information about the event types on other module. The range is from 1 to 1. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the event manager event types:
Related Commands
show event manager history events
To display the history of events for all policies, use the show event manager history command.
show event manager history events {detail [maximum num-events | severity [catastrophic | minor | moderate | severe]}
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the history of events for all policies:
Related Commands
show event manager policy-state
To display information about a system policy, use the show event manager policy-state command.
show event manager policy-state system- policy-name
Syntax Description
Name of the internal system policy. The policy name can be any alphanumeric string up to 29 characters. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about a system policy:
Related Commands
show event manager script system
To display information about the script policies, use the show event manager script system command.
show event manager script system policy-name | all
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the script policies:
Related Commands
show event manager system-policy
To display information about the predefined system policies, use the show event manager system-policy command.
show event manager system-policy system- policy-name | all
Syntax Description
Displays all policies including advanced and the policies that cannot be overridden. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the predefined system policies:
Related Commands
show forwarding mpls stats
To display the MPLS statistics, use the show forwarding mpls stats command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the output statistics of a label. The output is now enhanced to display the output statistics. The output statistics is the sum of all egress adjacent statistics for a particular label.
show hardware forwarding memory health summary
To display the summary of parity error counts encountered for ASIC memory tables, use the show hardware forwarding memory health summary command.
show hardware forwarding memory health summary
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the summary of parity error counts encountered for ASIC memory tables:
show hosts
To display the Domain Name Server (DNS) name servers and domain names, use the show hosts command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the IP addresses of the DNS servers that are used to resolve hostnames:
Related Commands
|
|
|
|---|---|
show logging console
To display the console logging configuration, use the show logging console command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the console logging configuration:
Related Commands
|
|
|
|---|---|
show logging info
To display the logging configuration, use the show logging info command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the logging configuration:
Related Commands
|
|
|
|---|---|
show logging last
To display the last number of lines of the logfile, use the show logging last command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the last 42 lines of the log file:
Related Commands
|
|
|
|---|---|
Configures the name of the log file used to store system messages. |
show logging level
To display the facility logging severity level configuration, use the show logging level command.
show logging level [ facility ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the logging severity level configuration:
This example shows how to display the EtherChannel logging severity level configuration:
This example shows how to display the Address Resolution Protocol (ARP) logging severity level configuration:
Related Commands
|
|
|
|---|---|
show logging logfile
To display the messages in the log file that were timestamped within the span entered, use the show logging logfile command.
show logging logfile [ start-time yyyy mmm dd hh : mm : ss ] [ end-time yyyy mmm dd hh : mm : ss ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the messages in the log file that were timestamped within the span shown:
Related Commands
|
|
|
|---|---|
show logging module
To display the module logging configuration, use the show logging module command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the module logging configuration:
Related Commands
|
|
|
|---|---|
show logging monitor
To display the monitor logging configuration, use the show logging monitor command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the monitor logging configuration:
Related Commands
|
|
|
|---|---|
show logging nvram
To display the messages in the nonvolatile random access memory (NVRAM) log, use the show logging nvram command.
show logging nvram [ last number-lines ]
Syntax Description
(Optional) Specifies the number of lines to display. The number of lines is from 1 to 100. |
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the last 20 messages in the NVRAM log:
Related Commands
|
|
|
|---|---|
show logging onboard
To display the onboard logging information based on the error type, use the show logging onboard command.
show logging onboard { bcm_used | boot-uptime | device-version | endtime | environmental-history | exception-log | kernel-trace | obfl-history | obfl-logs | stack-trace | starttime | status | trident } [> file | | type ]
Syntax Description
Command Default
Command Modes
Command History
Usage Guidelines
The date and time arguments for the starttime and endtime keywords are entered as the date month/day/year ( mm / dd / yy), followed by a hyphen, and the time in 24-hour format in hours:minutes:seconds ( HH:MM:SS). For example:
The valid values for file are as follows:
The valid values for type are as follows:
– -i —Ignores the case difference when comparing the strings.
– -x —Prints only the lines where the match is a whole line.
– word —Specifies for the expression.
- count [ > file | | type ]—Counts number of lines.
- egrep | grep print-match —Egrep or Grep. Egrep searches for lines of text that match more sophisticated regular expression syntax than grep. Grep searches for lines of text that match one or many regular expressions, and outputs only the matching lines.
– -A num —Prints the specifies number of lines of context after every matching line. Range: 1 to 999.
– -B num —Prints the specifies number of lines of context before every matching line. Range: 1 to 999.
– -c —Prints a total count of matching lines only.
– -i —Ignores the case difference when comparing the strings.
– -n —Prints each match preceded by its line number.
– -v —Prints only the lines that contain no matches for the word argument.
– -w —Prints only lines where the match is a complete word.
– -x —Prints only the lines where the match is a whole line.
– word —Specifies for the expression.
– -i —Ignores the case difference when comparing the strings.
– -x —Prints only the lines where the match is a whole line.
– word —Specifies for the expression.
- head [ -n num ]—Stream Editor. The optional -n num keyword and argument allow you to specify the number of lines to print. Range: 0 to 2147483647.
- include [ -i ] [ -x ] [ word ]—Include the lines that match.
– -i —Ignores the case difference when comparing the strings.
– -x —Prints only the lines where the match is a whole line.
– word —Specifies for the expression.
- last [ num ]—Displays the last lines to print. The optional num specifies the number of lines to print. Range: 0 to 9999.
- less [-E | -d ]—Quits at the end of the file.
– -E —(Optional) Quits at the end of the file.
– -d —(Optional) Specifies a dumb terminal.
- no-more —Turns off pagination for command output.
- sed command —Stream Editor
- wc —Counts words, lines, and characters.
– -c —(Optional) Specifies the output character count.
– -l —(Optional) Specifies the output line count.
– -w —(Optional) Specifies the output word count.
– | —Pipes command output to filter.
Use this command to view OBFL data from the system hardware. The OBFL feature is enabled by default and records operating temperatures, hardware uptime, interrupts, and other important events and messages that can assist with diagnosing problems with hardware cards or modules installed in a Cisco router or switch. Data is logged to files stored in nonvolatile memory. When the onboard hardware is started up, a first record is made for each area monitored and becomes a base value for subsequent records.
The OBFL feature provides a circular updating scheme for collecting continuous records and archiving older (historical) records, ensuring accurate data about the system. Data is recorded in one of two formats: continuous information that displays a snapshot of measurements and samples in a continuous file, and summary information that provides details about the data being collected. The message “No historical data to display” is seen when historical data is not available.
Starting with Release 7.0(3)I2(1), while the induced errors are corrected on the switches, the log messages that notify the corrections stop after hitting a threshold (usually after 15 or 19 corrections). Also, an extra message gets printed when the parity error is injected.
Examples
This example shows how to display the OBFL boot and uptime information:
This example shows how to display the OBFL logging device information:
This example shows how to display the OBFL history information:
The show logging onboard obfl-history command displays the following information:
- Timestamp when OBFL is manually disabled.
- Timestamp when OBFL is manually enabled.
- Timestamp when OBFL data is manually cleared.
This example shows how to display the OBFL kernel stack trace information:
The show logging onboard stack-trace command displays the following information:
Related Commands
|
|
|
|---|---|
show logging pending
To display the pending changes to the syslog server configuration, use the show logging pending command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the pending changes to the syslog server configuration:
Related Commands
|
|
|
|---|---|
Cancels the pending changes to the syslog server configuration. |
show logging pending-diff
To display the differences from the current syslog server configuration to the pending changes of the syslog server configuration, use the show logging pending-diff command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the pending differences of the syslog server configuration:
Related Commands
|
|
|
|---|---|
Cancels the pending changes to the syslog server configuration. |
show logging session status
To display the logging session status, use the show logging session status command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the logging session status:
Related Commands
|
|
|
|---|---|
show logging server
To display the syslog server configuration, use the show logging server command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the syslog server configuration:
Related Commands
|
|
|
|---|---|
show logging status
To display the logging status, use the show logging status command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the logging status:
Related Commands
|
|
|
|---|---|
Enables the distribution of the syslog server configuration to network switches using the Cisco Fabric Services (CFS) infrastructure. |
show logging timestamp
To display the logging time-stamp configuration, use the show logging timestamp command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the logging time-stamp configuration:
Related Commands
|
|
|
|---|---|
show monitor session
To display information about the Switched Port Analyzer (SPAN) or Encapsulated Remote Switched Port Analyzer (ERSPAN) sessions, use the show monitor session command.
Note Beginning with Release 7.0(3)I2(1), the rx, tx, and both options are displayed for the source VLANs and an option for the filter VLANs is not displayed. Also, the number of TCAM entries available for ACL SPAN has been reduced by 6 entries.
show monitor session [ session | all [ brief ] | range range [ brief ]]
Syntax Description
(Optional) Number of the session. The range is from 1 to 18. |
|
(Optional) Displays a range of sessions. The range is from 1 to 18. |
Command Default
Command Modes
Command History
Examples
This example shows how to display information about SPAN session 1:
This example shows the information displayed beginning with release 7.0(3)I2(1).
This example shows how to display a range of SPAN sessions:
This example shows how to display the information about an ERSPAN session on a switch that runs Cisco NX-OS Release 5.0(3)U2(2):
Related Commands
|
|
|
|---|---|
Displays the running configuration information for SPAN and ERSPAN sessions. |
show mpls strip labels
To display the MPLS label configuration, use the show mpls strip labels command.
show mpls strip labels [label | all | dynamic | static]
Syntax Description
Specifies that all labels must be displayed. This is the default option. |
|
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display all MPLS labels:
This example shows how to display only static MPLS labels:
Related Commands
|
|
|
|---|---|
Configures the destination MAC address for stripped egress frames. |
|
show ntp access-groups
To display the Network Time Protocol (NTP) access group configuration, use the show ntp access-groups command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP access group configuration:
Related Commands
|
|
|
|---|---|
show ntp authentication-keys
To display the Network Time Protocol (NTP) authentication keys, use the show ntp authentication-keys command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP authentication keys:
switch# show ntp authentication-keys
-----------------------------
Auth key MD5 String
-----------------------------
3 cisco
42 Nice_Key
34567 nexus7k
switch#
Related Commands
|
|
|
|---|---|
Configures one or more keys that a time source must provide in its NTP packets in order for the device to synchronize to it. |
show ntp authentication-status
To display the status of the Network Time Protocol (NTP) authentication, use the show ntp authentication-status command.
show ntp authentication-status
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP authentication status:
switch# show ntp authentication-status
Authentication enabled.
switch#
Related Commands
|
|
|
|---|---|
show ntp logging-status
To display the Network Time Protocol (NTP) logging status, use the show ntp logging-status command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP logging status:
Related Commands
|
|
|
|---|---|
show ntp peers
To display information about Network Time Protocol (NTP) peers, use the show ntp peers command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display information about NTP peers:
switch# show ntp peers
Related Commands
|
|
|
|---|---|
show ntp peer-status
To display the status of the Network Time Protocol (NTP) peers, use the show ntp peer-status command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the peer status for NTP:
switch# show ntp peer-status
Related Commands
|
|
|
|---|---|
show ntp pending-diff
To display the differences between the pending Network Time Protocol (NTP) configuration and the active NTP configuration, use the show ntp pending-diff command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the differences between the pending NTP configuration and the active NTP configuration:
Related Commands
|
|
|
|---|---|
show ntp pending peers
To display pending Network Time Protocol (NTP) configuration changes on all peers, use the show ntp pending peers command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the pending NTP configuration changes on all peers:
Related Commands
|
|
|
|---|---|
show ntp session status
To display the Network Time Protocol (NTP) session status, use the show ntp session status command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP session status:
Related Commands
|
|
|
|---|---|
show ntp status
To display the Network Time Protocol (NTP) distribution status, use the show ntp status command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP distribution status:
Related Commands
|
|
|
|---|---|
show ntp source
To display information about the Network Time Protocol (NTP) source, use the show ntp source command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP source information:
switch(config)# show ntp source
Related Commands
|
|
|
|---|---|
show ntp source-interface
To display the Network Time Protocol (NTP) source interface, use the show ntp source-interface command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the NTP source interface:
Related Commands
|
|
|
|---|---|
Displays information about the startup NTP configuration of the switch. |
|
Displays information about the NTP configuration that is currently running on the switch. |
show ntp statistics
To display Network Time Protocol (NTP) statistics, use the show ntp statistics command.
show ntp statistics { io | local | memory | peer { ipaddr address | name name1 [.. nameN ]}
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Examples
This example shows how to display the statistics for NTP:
switch# show ntp statistics local
Related Commands
|
|
|
|---|---|
show ntp status
To display the Network Time Protocol (NTP) distribution status, use the show ntp status command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the distribution status for NTP.
switch(config)# show ntp status
Last operational state: No session
show ntp trusted-keys
To display the configured Network Time Protocol (NTP) trusted keys, use the show ntp trusted-keys command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display all the configured NTP trusted keys:
switch(config)# show ntp trusted-keys
show ptp brief
|
|
|
|---|---|
To display a brief status of the Precision Time Protocol (PTP) interfaces, use the show ptp brief command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display a brief status of the PTP interfaces:
Related Commands
|
|
|
|---|---|
Displays the state of foreign masters known to the PTP process. |
|
show ptp clock
To display the Precision Time Protocol (PTP) clock information, use the show ptp clock command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the PTP clock information:
Related Commands
|
|
|
|---|---|
Displays the state of foreign masters known to the PTP process. |
|
show ptp clock foreign-masters-record
To display information about the state of foreign masters known to the Precision Time Protocol (PTP) process, use the show ptp clock foreign-masters-record command.
show ptp clock foreign-masters-record [ interface ethernet slot / port ]
Syntax Description
Slot number of the Ethernet interface. The slot number is from 1 to 255 and the port number is form 1 to 128. |
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the state of foreign masters known to the PTP process:
This example shows how to display information about the state of foreign masters known to the PTP process for the Ethernet interface 1/5:
Related Commands
|
|
|
|---|---|
show ptp corrections
To display the history of the Precision Time Protocol (PTP) clock corrections on the Ethernet interfaces, use the show ptp corrections command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the history of the PTP clock corrections on the Ethernet interfaces:
Related Commands
|
|
|
|---|---|
Displays the state of foreign masters known to the PTP process. |
|
show ptp parent
To display information about the parent and grand master of the Precision Time Protocol (PTP) clock, use the show ptp parent command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the parent and grand master of the PTP clock:
Related Commands
|
|
|
|---|---|
Displays the state of foreign masters known to the PTP process. |
|
show ptp port
To display information about the Precision Time Protocol (PTP) port, use the show ptp port command.
show ptp port interface ethernet slot / port
Syntax DescriptionT
Specifies an IEEE 802.3z Ethernet interface. The slot number is from 1 to 255 and the port number is from 1 to 128. |
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the PTP port on the Ethernet interface 1/5:
Related Commands
|
|
|
|---|---|
Displays the state of foreign masters known to the PTP process. |
|
show ptp time-property
To display the Precision Time Protocol (PTP) clock properties, use the show ptp time-property command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the PTP clock properties:
Related Commands
|
|
|
|---|---|
Displays the state of foreign masters known to the PTP process. |
|
show rmon
To display information about Remote Monitoring (RMON) alarms or high-capacity alarms or events, use the show rmon command.
show rmon { alarms | events | hcalarms | info | logs }
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the RMON high-capacity alarms configured on the switch:
This example shows how to display the RMON events configured on the switch:
This example shows how to display the RMON configuration information:
Related Commands
|
|
|
|---|---|
show running-config
To display the contents of the currently running configuration file, use the show running-config command.
Syntax Description
(Optional) Displays the full operating information including default settings. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display information on the running configuration on a switch that runs Cisco NX-OS Release 5.0(3)U1(1):
This example shows how to display detailed information on the running configuration on a switch that runs Cisco NX-OS Release 5.0(3)U1(1):
This example shows how to display the running configuration on a switch that runs Cisco NX-OS Release 5.0(3)U2(1) and shows the Control Plane Policing (CoPP) policy maps, hardware port modes, and access control list (ACL) ternary content addressable memory (TCAM) changes:
Related Commands
|
|
|
|---|---|
show running-config callhome
To display the Call Home running configuration, use the show running-config callhome command.
show running-config callhome [ all ]
Syntax Description
(Optional) Displays all the default and configured information. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the Call Home running configuration:
This example shows how to display the entire Call Home running configuration, including the default values:
Related Commands
|
|
|
|---|---|
show running-config eem
To display information about running configuration for the Embedded Event Manager (EEM), use the show running-config eem command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about running configuration for the EEM:
Related Commands
|
|
|
|---|---|
Displays information about the configured environment variables. |
|
Displays information about the startup configuration for the Embedded Event Manager (EEM). |
show running-config exclude-provision
To display the running configuration without the configuration for offline preprovisioned interfaces, use the show running-config exclude-provision command.
show running-config exclude-provision
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the running configuration without the offline preprovisioned interfaces:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup configuration. |
|
Displays the startup configuration without the preprovisioning information for offline interfaces. |
|
show running-config interface
To display the running configuration information for interfaces, use the show running-config interface command.
show running-config interface [ all | ethernet slot / port | loopback if_number | mgmt mgmt_intf | port-channel po_number ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the running configuration for a specified Ethernet interface on a switch that runs Cisco NX-OS Release 5.0(3)U2(1):
Related Commands
|
|
|
|---|---|
Copies the running configuration information to the startup configuration file. |
show running-config monitor
To display the running configuration for the Switched Port Analyzer (SPAN) or Encapsulated Remote Switched Port Analyzer (ERSPAN) session, use the show running-config monitor command.
show running-config monitor [ all ]
Syntax Description
(Optional) Displays current SPAN configuration information including default settings. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display information on the running SPAN and ERSPAN configuration:
This example shows how to display detailed information on the running SPAN and ERSPAN configuration:
Related Commands
|
|
|
|---|---|
show running-config ptp
To display the Precision Time Protocol (PTP) running configuration, use the show running-config ptp command.
show running-config ptp [ all ]
Syntax Description
(Optional) Displays all the default and configured information. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the PTP running configuration:
This example shows how to display the entire PTP running configuration, including the default values:
Related Commands
|
|
|
|---|---|
Copies the PTP running configuration information to the startup configuration file. |
|
show scheduler
To display information about the scheduled maintenance jobs, use the show scheduler command.
show scheduler { config | internal [mem-stats] | job [ name jobname ] | logfile | schedule [ name schedulename ]}
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display the scheduler configuration:
Related Commands
|
|
|
|---|---|
Enables the scheduler feature for scheduling maintenance jobs. |
show sflow
To display information about the sFlow global configuration, use the show sflow command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure sFlow information:
switch(config)# sflow max-datagram-size 2000
switch(config)# sflow collector-ip 192.0.2. vrf management
switch(config)# sfow collector-port 7000
Related Commands
|
|
|
|---|---|
show sflow statistics
To display the sFlow statistics, use the show sflow statistics command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure sFlow information:
Related Commands
|
|
|
|---|---|
show snmp community
To display the Simple Network Management Protocol (SNMP) community strings configured on the switch, use the show snmp community command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the SNMP community strings:
Related Commands
|
|
|
|---|---|
Configures the community access string to permit access to the SNMP protocol. |
show snmp context
To display the Simple Network Management Protocol (SNMP) contexts configured on the switch, use the show snmp context command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the SNMP contexts:
Related Commands
|
|
|
|---|---|
show snmp engineID
To display the identification of the local Simple Network Management Protocol (SNMP) engine, use the show snmp engineID command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
An SNMP engine is a copy of SNMP that can reside on a local or remote device. SNMP passwords are localized using the SNMP engine ID of the authoritative SNMP engine.
Examples
This example shows how to display the SNMP engine ID:
Related Commands
|
|
|
|---|---|
show snmp group
To display the names of the Simple Network Management Protocol (SNMP) groups configured on the switch, use the show snmp group command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the SNMP groups:
Related Commands
|
|
|
|---|---|
show snmp host
To display the Simple Network Management Protocol (SNMP) host information, use the show snmp host command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the SNMP host:
Related Commands
|
|
|
|---|---|
show snmp sessions
To display the current Simple Network Management Protocol (SNMP) sessions, use the show snmp sessions command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the SNMP sessions:
Related Commands
|
|
|
|---|---|
show snmp trap
To display the Simple Network Management Protocol (SNMP) link trap generation information, use the show snmp trap command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the SNMP traps:
Related Commands
|
|
|
|---|---|
show snmp user
To display information on each Simple Network Management Protocol (SNMP) user, use the show snmp user command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the SNMP users configured on the switch:
This example shows how to display information about a specific SNMP user:
Related Commands
|
|
|
|---|---|
show startup-config
To display the contents of the currently running configuration file, use the show startup-config command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display information from the startup configuration file:
Related Commands
|
|
|
|---|---|
Displays the contents of the currently running configuration file. |
show startup-config callhome
To display the startup configuration for Call Home, use the show startup-config callhome command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the startup configuration for Call Home:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
show startup-config eem
To display information about the startup configuration for the Embedded Event Manager (EEM), use the show startup-config eem command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to display information about the startup configuration for EEM:
Related Commands
|
|
|
|---|---|
Displays information about the configured environment variables. |
|
Displays information about the running configuration for the Embedded Event Manager (EEM). |
|
show startup-config exclude-provision
To display the startup configuration that excludes the configuration for offline preprovisioned interfaces, use the show startup-config exclude-provision command.
show startup-config exclude-provision
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the startup configuration without the offline preprovisioned interfaces:
Related Commands
|
|
|
|---|---|
Displays the running configuration excluding the preprovisioned features. |
|
show startup-config ptp
To display the Precision Time Protocol (PTP) startup configuration, use the show startup-config ptp command.
show startup-config ptp [ all ]
Syntax Description
(Optional) Displays all the default and configured information. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the PTP startup configuration:
This example shows how to display the entire PTP startup configuration, including the default values:
Related Commands
|
|
|
|---|---|
Copies the running configuration information to the startup configuration file. |
|
show startup-config vtp
To display the VLAN Trunking Protocol (VTP) configuration from the startup configuration file, use the show startup-config vtp command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the VTP configuration stored in the startup configuration file:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup configuration file. |
|
show tech-support callhome
To display the technical support output for Call Home, use the show tech-support callhome command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to display the troubleshooting information for Call Home:
Related Commands
|
|
|
|---|---|
Displays the running configuration information for Call Home. |
shut (ERSPAN)
To shut down an Encapsulated Remote Switched Port Analyzer (ERSPAN) session, use the shut command. To enable an ERSPAN session, use the no form of this command.
Syntax Description
Command Default
Command Modes
ERSPAN session configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to shut down an ERSPAN session:
This example shows how to enable an ERSPAN session:
Related Commands
|
|
|
|---|---|
site-id (Call Home)
To configure the optional site number for the customer, use the site-id command. To remove a site number, use the no form of this command.
Syntax Description
Site number. The site number can be up to 255 alphanumeric characters in free format. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can configure the customer identification information that Cisco Smart Call Home should use. The service agreement includes the customer identification information, such as the customer ID, contract ID, and site ID.
Examples
This example shows how to configure a site number:
Related Commands
|
|
|
|---|---|
snmp-server community
To create Simple Network Management Protocol (SNMP) communities for SNMPv1 or SNMPv2c, use the snmp-server community command. To revert to the defaults, sue the no form of this command.
snmp-server community com-name [ group grp-name | ro | rw | use-acl acl-name ]
no snmp-server community com-name [ group grp-name | ro | rw | use-acl acl-name ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You can assign an access list (ACL) to a community to filter incoming SNMP requests. If the assigned ACL allows the incoming request packet, SNMP processes the request. If the ACL denies the request, SNMP drops the request and sends a system message.
See the Cisco Nexus 3000 Series NX-OS Security Configuration Guide for more information on creating ACLs. The ACL applies to both IPv4 and IPv6 over UDP and TCP. After creating the ACL, assign the ACL to the SNMP community.
Examples
This example shows how to create an SNMP community string and assign an ACL to the community to filter SNMP requests:
Related Commands
|
|
|
|---|---|
snmp-server contact
To configure the Simple Network Management Protocol (SNMP) contact (sysContact) information, use the snmp-server contact command. To remove the contact information, use the no form of this command.
Note Beginning with release 7.0(3)I2(1), snmp-server contact no longer has a default name and must be configured to enable callhome.
no snmp-server contact [ text ]
Syntax Description
(Optional) String that describes the system contact information. The text can be any alphanumeric string up to 32 characters and cannot contain spaces. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
This command no longer has a default name and must be configured to enable callhome. |
Examples
This example shows how to set an SNMP contact:
This example shows how to remove an SNMP contact:
Related Commands
|
|
|
|---|---|
snmp-server context
To configure the Simple Network Management Protocol (SNMP) context to logical network entity mapping, use the snmp-server context command. To remove the context, use the no form of this command.
snmp-server context context-name [ instance instance-name ] [ vrf { vrf-name | default | management }] [ topology topology-name ]
no snmp-server context context-name [ instance instance-name ] [ vrf { vrf-name | default | management }] [ topology topology-name ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the snmp-server context command to map between SNMP contexts and logical network entities, such as protocol instances or VRFs.
Examples
This example shows how to map the public1 context to the default VRF:
Related Commands
|
|
|
|---|---|
snmp-server enable traps
To enable the Simple Network Management Protocol (SNMP) notifications, use the snmp-server enable traps command. To disable SNMP notifications, use the no form of this command.
snmp-server enable traps [ aaa [ server-state-change ] | callhome [ event-notify | smtp-send-fail ] |
entity { entity_fan_status_change | entity_mib_change | entity_module_inserted | entity_module_removed | entity_module_status_change | entity_power_out_change | entity_power_status_change | entity_unrecognised_module } | fcdomain | fcns | fcs | fctrace | fspf | license [ notify-license-expiry | notify-license-expiry-warning | notify-licensefile-missing | notify-no-license-for-feature ] | link | rf [ redundancy_framework ] | rmon [ fallingAlarm | hcFallingAlarm | hcRisingAlarm | risingAlarm ] | rscn | snmp [ authentication ] | storm-control [trap-rate val] | vsan | zone [ default-zone-behavior-change | merge-failure | merge-success | request-reject1 | unsupp-mem ]]
no snmp-server enable traps [ aaa [ server-state-change ] | callhome [ event-notify | smtp-send-fail ] | entity { entity_fan_status_change | entity_mib_change | entity_module_inserted | entity_module_removed | entity_module_status_change | entity_power_out_change | entity_power_status_change | entity_unrecognised_module } | fcdomain | fcns | fcs | fctrace | fspf | license [ notify-license-expiry | notify-license-expiry-warning | notify-licensefile-missing | notify-no-license-for-feature ] | link | rf [ redundancy_framework ] | rmon [ fallingAlarm | hcFallingAlarm | hcRisingAlarm | risingAlarm ] | rscn | snmp [ authentication ] | storm-control [trap-rate] | vsan | zone [ default-zone-behavior-change | merge-failure | merge-success | request-reject1 | unsupp-mem ]]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The snmp-server enable traps command enables both traps and informs, depending on the configured notification host receivers.
The no snmp-server enable traps storm-control command disables SNMP traps for Storm Control.
Examples
This example shows how to enable SNMP notifications for the server state change:
This example shows how to enable SNMP notifications for Storm Control:
This example shows how to specify the number of Storm Control traps per minute:
This example shows how to disable all SNMP notifications:
Related Commands
|
|
|
|---|---|
Enables the Simple Network Management Protocol (SNMP) notifications on link traps. |
|
snmp-server enable traps link
To enable the Simple Network Management Protocol (SNMP) notifications on link traps, use the snmp-server enable traps link command. To disable SNMP notifications on link traps, use the no form of this command.
snmp-server enable traps link [ notification-type ]
no snmp-server enable traps link [ notification-type ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
This command is disabled by default. Most notification types are disabled.
If you enter this command with no notification-type arguments, the default is to enable all notification types controlled by this command.
Examples
This example shows how to enable the SNMP link trap notification on the switch:
This example shows how to disable the SNMP link trap notification on the switch:
Related Commands
|
|
|
|---|---|
snmp-server enable traps vtp
To enable the Simple Network Management Protocol (SNMP) notifications for a VLAN Trunking Protocol (VTP) domain, use the snmp-server enable traps vtp command. To disable SNMP notifications on a VTP domain, use the no form of this command.
no snmp-server enable traps vtp
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The snmp-server enable traps command enables both traps and informs, depending on the configured notification host receivers.
Examples
This example shows how to enable SNMP notifications on a VTP domain:
This example shows how to disable all SNMP notifications on a VTP domain:
Related Commands
|
|
|
|---|---|
snmp-server globalEnforcePriv
To configure Simple Network Management Protocol (SNMP) message encryption for all users, use the snmp-server globalEnforcePriv command. To remove the encryption, use the no form of this command.
no snmp-server globalEnforcePriv
Syntax Description
Command Default
The SNMP agent accepts SNMPv3 messages without authentication and encryption.
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure SNMP message encryption for all users:
This example shows how to remove SNMP message encryption for all users:
Related Commands
|
|
|
|---|---|
snmp-server host
To specify the recipient of a Simple Network Management Protocol (SNMP) notification operation, use the snmp-server host command. To remove the specified host, use the no form of this command.
snmp-server host host-address { community-string | filter-vrf { vrf-name | default | management } | { informs | traps } { community-string | version { 1 | 2c | 3 { auth | noauth | priv }} community-string [ udp-port port ]} | version { 1 | 2c | 3 { auth | noauth | priv }} community-string [ udp-port port ]}
no snmp-server host host-address { community-string | filter-vrf { vrf-name | default | management } | { informs | traps } { community-string | version { 1 | 2c | 3 { auth | noauth | priv }} community-string [ udp-port port ]} | version { 1 | 2c | 3 { auth | noauth | priv }} community-string [ udp-port port ]}
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
SNMP notifications can be sent as traps or inform requests. Traps are unreliable because the receiver does not send acknowledgments when it receives traps. The sender cannot determine if the traps were received. However, an SNMP entity that receives an inform request acknowledges the message with an SNMP response PDU. If the sender never receives the response, the inform request can be sent again. Therefore, informs are more likely to reach their intended destination.
Examples
This example shows how to sends the SNMP traps to the host specified by the IPv4 address 192.168.0.10. The community string is defined as my_acl_for_public:
This example shows how to send all inform requests to the host myhost.cisco.com using the community string my_acl_for_public:
Related Commands
|
|
|
|---|---|
snmp-server location
To set the Simple Network Management Protocol (SNMP) system location string, use the snmp-server location command. To remove the location string, use the no form of this command.
no snmp-server location [ text ]
Syntax Description
(Optional) String that describes the system location information. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to set a system location string:
This example shows how to remove the system location string:
Related Commands
|
|
|
|---|---|
snmp-server mib community-map
To configure a Simple Network Management Protocol (SNMP) context to map to a logical network entity, such as a protocol instance or VRF, use the snmp-server mib community-map command. To remove the mapping, use the no form of this command.
snmp-server mib community-map community-string context context-name
no snmp-server mib community-map community-string context context-name
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to map an SNMPv2c community named my_acl_for_public to an SNMP context public1:
This example shows how to remove the mapping of an SNMPv2c community to an SNMP context:
Related Commands
|
|
|
|---|---|
snmp-server tcp-session
To enable a one-time authentication for Simple Network Management Protocol (SNMP) over a TCP session, use the snmp-server tcp-session command. To disable the one-time authentication, use the no form of this command.
snmp-server tcp-session [ auth ]
no snmp-server tcp-session [ auth ]
Syntax Description
(Optional) Specifies that one-time authentication for SNMP be enabled over the TCP session. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to enable one-time authentication for SNMP over a TCP session:
This example shows how to disable one-time authentication for SNMP over a TCP session:
Related Commands
|
|
|
|---|---|
snmp-server user
To configure a new user to a Simple Network Management Protocol (SNMP) group, use the snmp-server user command. To remove a user from an SNMP group, use the no form of this command.
snmp-server user username [ groupname ] [ auth { md5 | sha } auth-password [{ engineID engine-ID | localizedkey | priv { priv-password | aes-128 }}]]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure an SNMP user named authuser with authentication and privacy parameters:
This example shows how to delete an SNMP user:
Related Commands
|
|
|
|---|---|
snmp trap link-status
To enable Simple Network Management Protocol (SNMP) link trap generation on an interface, use the snmp trap link-status command. To disable SNMP link traps, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
By default, SNMP link traps are sent when a Layer 2 interface goes up or down. You can disable SNMP link trap notifications on an individual interface. You can use these limit notifications on a flapping interface (an interface that transitions between up and down repeatedly).
You can use this command on the following interfaces:
Note Use the no switchport command to configure an interface as a Layer 3 interface.
Examples
This example shows how to disable SNMP link-state traps for a specific Layer 2 interface:
This example shows how to enable SNMP link-state traps for a specific Layer 3 interface:
This example shows how to enable SNMP link-state traps for a specific Layer 2 interface:
Related Commands
|
|
|
|---|---|
source (SPAN, ERSPAN)
To add an Ethernet Switched Port Analyzer (SPAN) or an Encapsulated Remote Switched Port Analyzer (ERSPAN) source port, use the source command. To remove the source SPAN or ERSPAN port, use the no form of this command.
source { interface { ethernet slot / port | port-channel channel-num } [{ both | rx | tx }] | vlan vlan-num }
no source { interface { ethernet slot / port | port-channel channel-num } | vlan vlan-num }
Syntax Description
Command Default
Command Modes
SPAN session configuration mode
ERSPAN session configuration mode
Command History
|
|
|
Usage Guidelines
A source port (also called a monitored port) is a switched port that you monitor for network traffic analysis. In a single local SPAN session, you can monitor source port traffic such as received (Rx), transmitted (Tx), or bidirectional (both).
A source port can be an Ethernet port, port channel, SAN port channel, or a VLAN port. It cannot be a destination port.
For ERSPAN, if you do not specify both, rx, or tx, the source traffic is analyzed for both directions.
Examples
This example shows how to configure an Ethernet SPAN source port:
This example shows how to configure a port channel SPAN source:
This example shows how to configure an ERSPAN source port to receive traffic on the port:
Related Commands
|
|
|
|---|---|
Displays the running configuration information of a SPAN session. |
source ip (ERSPAN)
To configure the source IP address for an an Encapsulated Remote Switched Port Analyzer (ERSPAN) destination, use the source ip command. To remove the source IP configuration, use the no form of this command.
Syntax Description
Command Default
Command Modes
ERSPAN destination configuration mode
Command History
|
|
|
|---|---|
Usage Guidelines
An ERSPAN destination session supports only one source IP address.
Examples
This example shows how to configure a source IP address for an ERSPAN session:
Related Commands
|
|
|
|---|---|
Displays the running configuration information of a SPAN session. |
streetaddress (Call Home)
To configure the street address for the primary person responsible for the switch, use the streetaddress command. To remove the street address, use the no form of this command.
Syntax Description
Street address. The address can be a maximum of 255 alphanumeric characters and can include white spaces. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure the street address for the primary person responsible for the switch:
Related Commands
|
|
|
|---|---|
switching-mode store-forward
To enable store-and-forward switching mode on a Cisco NX-OS device, use the switching-mode store-forward command. To reenable cut-through switching on a Cisco NX-OS device, use the no form of this command.
no switching-mode store-forward
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Enabling store-and-forward switching mode might impact your port-to-port switching latency.
Examples
This example shows how to enable store-and-forward switching mode on a Cisco NX-OS device:
switchport mode monitor buffer-limit
To configure the SPAN buffer limit on a monitor port, use the switchport mode monitor buffer-limit command. To remove the configuration and restore the default, use the no form of this command.
switchport mode monitor buffer-limit limit [ bytes | kbytes | mbytes | packets ]
no switchport mode monitor buffer-limit limit [ bytes | kbytes | mbytes | packets ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
This command can be configured on any physical interface.
When configuring a high SPAN buffer limit, it may affect regular data plane traffic as they both use the same memory pool.
Examples
This example shows how to configure the SPAN buffer limit to 100 bytes:
Related Commands
|
|
|
|---|---|
switch-priority (Call Home)
To configure the switch priority for the switch, use the switch-priority command. To remove the switch priority, use the no form of this command.
switch-priority priority-value
Syntax Description
Switch priority value. The range is from 0 to 7, with 0 being the highest priority and 7 the lowest. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure the switch priority:
Related Commands
|
|
|
|---|---|
tag
To correlate multiple events in the policy, use the tag command.
tag tag {and | andnot | or} tag [and | andnot | or {tag}]{happens occurs in seconds}
Syntax Descriptiona
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to correlate multiple events in the policy:
Related Commands
|
|
|
|---|---|
Displays information about the status of the configured policy. |
terminal event-manager bypass
To specify the command-line interface (CLI) events that match the Embedded Event Manager (EEM) policies to bypass the EEM events, use the terminal event-manager bypass command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to specify the command-line interface (CLI) events that match the Embedded Event Manager (EEM) policies to bypass the EEM events:
Related Commands
|
|
|
|---|---|
Specifies that the default action for the event is to be performed when an EEM applet is triggered. |
transport email (Call Home)
To configure the Simple Mail Transport Protocol (SMTP) server address for the Call Home functionality to work, and optionally the from and reply-to e-mail addresses, use the transport email command. To remove the SMTP server, use the no form of this command.
transport email { from email-addr | mail-server ip-address [ port port-no ] [ priority priority-no ] | reply-to email-addr | smtp-server ip-address [ port port-no ] [ use-vrf vrf-name ]}
no transport email { from | mail-server ip-address [ port port-no ] [ priority priority-no ] | reply-to | smtp-server }
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to configure the SMTP server for the Call Home service:
This example shows how to configure the e-mail from and reply-to field for Call Home messages:
Related Commands
|
|
|
|---|---|
Displays information about the e-mail configuration for Call Home. |
|
verify (session)
To verify the current configuration session, use the verify command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
This example shows how to verify a session:
Related Commands
|
|
|
|---|---|
vrf (ERSPAN)
To configure a virtual routing and forwarding (VRF) instance for Encapsulated Remote Switched Port Analyzer (ERSPAN) traffic forwarding in the source, use the vrf command. To revert to the default settings, use the no form of this command.
vrf { vrf_name | default | management }
no vrf { vrf_name | default | management }
Syntax Description
Name of the VRF. The VRF name can be any case-sensitive, alphanumeric string up to 32 characters. |
|
Command Default
Command Modes
ERSPAN session configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure a VRF instance for the ESRSPAN source:
Feedback