Command Reference, Cisco IOS XE 17.15.x (Catalyst 9300 Switches) - Interface and Hardware Commands [Cisco Catalyst 9300 Series Switches] (2024)

To configure a new Bluetooth pin, use the bluetooth pin command in interface configuration or global configuration mode.

bluetooth pin pin

Command Modes

Interface configuration (config-if)

Global configuration (config)

Usage Guidelines

The bluetooth pin command can be configured either in the interface configuration or global configuration mode. Cisco recommends using the global configuration mode to configure the Bluetooth pin.

Examples

This example shows how to configure a new Bluetooth pin using the bluetooth pin command.

Device> enableDevice# configure terminalDevice(config)# bluetooth pin 1111Device(config)#

Related Commands

To remove the macro applied configuration from the interfaces, use the clear macro auto configuration command.

Note	Before executing the clear macro auto configuration command, you must disable Auto SmartPorts on the switch.

clear macro auto configuration {all | interface [interface-id] }

Command Default

This command has no default setting.

Command Modes

User EXEC (>)

Usage Guidelines

Use the command to remove configuration applied by macros from all the interfaces or a particular interface on the switch.

You can verify your settings by entering the show macro auto interface command in privileged EXEC mode.

Examples

This example shows how to remove the configuration from all the switch interfaces:

Device(config)# clear macro auto configuration all

To enable the device classifier, use the device classifier command in global configuration mode. Use the no form of this command to disable the device classifier.

device classifier

no device classifier

Command Default

This command is disabled by default.

Command Modes

Global configuration (config)

Usage Guidelines

Use the no device classifier command, in global configuration mode, to disable the device classifier. You cannot disable the device classifier while it is being used by features such as Auto SmartPorts (ASP).

Examples

This example shows how to enable the ASP device classifier on a switch:

Device(config)# device classifierDevice(config)# end

To enable debugging of the power controller and Power over Ethernet (PoE) system, use the debug ilpower command in privileged EXEC mode. To disable debugging, use the no form of this command.

debug ilpower {cdp | event | ha | ipc | police | port | powerman | registries | scp | sense}

no debug ilpower {cdp | event | ha | ipc | police | port | powerman | registries | scp | sense}

Command Default

Debugging is disabled.

Command Modes

Privileged EXEC

Usage Guidelines

This command is supported only on PoE-capable switches.

When you enable debugging on a switch stack, it is enabled only on the active switch. To enable debugging on a stack member, you can start a session from the active switch by using the session switch-number EXEC command. Then enter the debug command at the command-line prompt of the stack member. You also can use the remote command stack-member-number LINE EXEC command on the active switc to enable debugging on a member switch without first starting a session.

To enable debugging of interface-related activities, use the debug interface command in privileged EXEC mode. To disable debugging, use the no form of this command.

debug interface {interface-id | counters {exceptions | protocol memory} | null interface-number | port-channel port-channel-number | states| vlan vlan-id}

no debug interface {interface-id | counters {exceptions | protocol memory} | null interface-number | port-channel port-channel-number | states| vlan vlan-id}

Command Default

Debugging is disabled.

Command Modes

Privileged EXEC (#)

Usage Guidelines

If you do not specify a keyword, all debug messages appear.

The undebug interface command is the same as the no debug interface command.

When you enable debugging on a switch stack, it is enabled only on the active switch. To enable debugging on a stack member, you can start a session from the active switch by using the session switch-number EXEC command. Then enter the debug command at the command-line prompt of the stack member. You also can use the remote command stack-member-number LINE EXEC command on the active switch to enable debugging on a member switch without first starting a session.

To enable debugging of Link Layer Discovery Protocol (LLDP) packets, use the debug lldp packets command in privileged EXEC mode. To disable debugging, use the no form of this command.

debug lldp packets

no debug lldp packets

Syntax Description

This commnd has no arguments or keywords.

Command Default

Debugging is disabled.

Command Modes

Privileged EXEC (#)

Usage Guidelines

The undebug lldp packets command is the same as the no debug lldp packets command.

When you enable debugging on a switch stack, it is enabled only on the active switch. To enable debugging on a stack member, you can start a session from the active switch by using the session switch-number EXEC command.

To enable debugging of a Power over Ethernet (PoE) port, use the debug platform poe command in privileged EXEC mode. To disable debugging, use the no form of this command.

debug platform poe [error | info] [switch switch-number]

no debug platform poe [error | info] [switch switch-number]

Command Default

Debugging is disabled.

Command Modes

Privileged EXEC (#)

Usage Guidelines

The undebug platform poe command is the same as the no debug platform poe command.

To enable debugging of packets during high CPU utilization, for an active switch, use the debug platform software fed switch active punt packet-capture start command in privileged EXEC mode. To disable debugging of packets during high CPU utilization, for an active switch, use the debug platform software fed switch active punt packet-capture stop command in privileged EXEC mode.

debug platform software fed switch active punt packet-capture start

debug platform software fed switch active punt packet-capture stop

Command Modes

Privileged EXEC (#)

Usage Guidelines

The debug platform software fed switch active punt packet-capture start command starts the debugging of packets during high CPU utilization. The packet capture is stopped when the 4k buffer size is exceeded.

Examples

The following is a sample output from the debug platform software fed switch active punt packet-capture start command:

Device# debug platform software fed switch active packet-capture start Punt packet capturing started.

The following is a sample output from the debug platform software fed switch active punt packet-capture stop command:

Device# debug platform software fed switch active packet-capture stop Punt packet capturing stopped. Captured 101 packet(s)

To specify the duplex mode of operation for a port, use the duplex command in interface configuration mode. To return to the default value, use the no form of this command.

duplex {auto | full | half}

no duplex {auto | full | half}

Command Default

The default is auto for Gigabit Ethernet ports.

Duplex options are not supported on the 1000BASE-x or 10GBASE-x (where -x is -BX, -CWDM, -LX, -SX, or -ZX) small form-factor pluggable (SFP) modules.

Command Modes

Interface configuration

Usage Guidelines

For Gigabit Ethernet ports, setting the port to auto has the same effect as specifying full if the attached device does not autonegotiate the duplex parameter.

Note	Half-duplex mode is supported on Gigabit Ethernet interfaces if the duplex mode is auto and the connected device is operating at half duplex. However, you cannot configure these interfaces to operate in half-duplex mode.

Certain ports can be configured to be either full duplex or half duplex. How this command is applied depends on the device to which the switch is attached.

If both ends of the line support autonegotiation, we highly recommend using the default autonegotiation settings. If one interface supports autonegotiation and the other end does not, configure duplex and speed on both interfaces, and use the auto setting on the supported side.

If the speed is set to auto , the switch negotiates with the device at the other end of the link for the speed setting and then forces the speed setting to the negotiated value. The duplex setting remains as configured on each end of the link, which could result in a duplex setting mismatch.

You can configure the duplex setting when the speed is set to auto .

Caution

Changing the interface speed and duplex mode configuration might shut down and re-enable the interface during the reconfiguration.

You can verify your setting by entering the show interfaces privileged EXEC command.

Examples

This example shows how to configure an interface for full-duplex operation:

Device(config)# interface gigabitethernet1/0/1Devic(config-if)# duplex full

To enable error-disable detection for a specific cause or for all causes, use the errdisable detect cause command in global configuration mode. To disable the error-disable detection feature, use the no form of this command.

errdisable detect cause {all | arp-inspection | bpduguard shutdown vlan | dhcp-rate-limit | dtp-flap | gbic-invalid | inline-power | link-flap | loopback | pagp-flap | pppoe-ia-rate-limit | psp shutdown vlan | security-violation shutdown vlan | sfp-config-mismatch}

no errdisable detect cause {all | arp-inspection | bpduguard shutdown vlan | dhcp-rate-limit | dtp-flap | gbic-invalid | inline-power | link-flap | loopback | pagp-flap | pppoe-ia-rate-limit | psp shutdown vlan | security-violation shutdown vlan | sfp-config-mismatch}

Command Default

Detection is enabled for all causes. All causes, except per-VLAN error disabling, are configured to shut down the entire port.

Command Modes

Global configuration

Usage Guidelines

A cause (such as a link-flap or dhcp-rate-limit) is the reason for the error-disabled state. When a cause is detected on an interface, the interface is placed in an error-disabled state, an operational state that is similar to a link-down state.

When a port is error-disabled, it is effectively shut down, and no traffic is sent or received on the port. For the bridge protocol data unit (BPDU) guard, voice-aware 802.1x security, and port-security features, you can configure the switch to shut down only the offending VLAN on the port when a violation occurs, instead of shutting down the entire port.

If you set a recovery mechanism for the cause by entering the errdisable recovery global configuration command, the interface is brought out of the error-disabled state and allowed to retry the operation when all causes have timed out. If you do not set a recovery mechanism, you must enter the shutdown and then the no shutdown commands to manually recover an interface from the error-disabled state.

For protocol storm protection, excess packets are dropped for a maximum of two virtual ports. Virtual port error disabling using the psp keyword is not supported for EtherChannel and Flexlink interfaces.

To verify your settings, enter the show errdisable detect privileged EXEC command.

Examples

This example shows how to enable error-disabled detection for the link-flap error-disabled cause:

Device(config)# errdisable detect cause link-flap

This command shows how to globally configure BPDU guard for a per-VLAN error-disabled state:

Device(config)# errdisable detect cause bpduguard shutdown vlan

This command shows how to globally configure voice-aware 802.1x security for a per-VLAN error-disabled state:

Device(config)# errdisable detect cause security-violation shutdown vlan

To enable the error-disabled mechanism to recover from a specific cause, use the errdisable recovery cause command in global configuration mode. To return to the default setting, use the no form of this command.

errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure | pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control | udld}

no errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure | pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control | udld}

Command Default

Recovery is disabled for all causes.

Command Modes

Global configuration (config)

Usage Guidelines

A cause (such as all or BDPU guard) is defined as the reason that the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in the error-disabled state, an operational state similar to link-down state.

When a port is error-disabled, it is effectively shut down, and no traffic is sent or received on the port. For the BPDU guard and port-security features, you can configure the switch to shut down only the offending VLAN on the port when a violation occurs, instead of shutting down the entire port.

If you do not enable the recovery for the cause, the interface stays in the error-disabled state until you enter the shutdown and the no shutdown interface configuration commands. If you enable the recovery for a cause, the interface is brought out of the error-disabled state and allowed to retry the operation again when all the causes have timed out.

Otherwise, you must enter the shutdown and then the no shutdown commands to manually recover an interface from the error-disabled state.

You can verify your settings by entering the show errdisable recovery privileged EXEC command.

Examples

This example shows how to enable the recovery timer for the BPDU guard error-disabled cause:

Device# Device#configure terminalDevice(config)# errdisable recovery cause bpduguard

To enable the error-disabled mechanism to recover from a specific cause, use the errdisable recovery cause command in global configuration mode. To return to the default setting, use the no form of this command.

errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure | pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control | udld}

no errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure | pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control | udld}

Command Default

Recovery is disabled for all causes.

Command Modes

Global configuration (config)

Usage Guidelines

A cause (such as all or BDPU guard) is defined as the reason that the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in the error-disabled state, an operational state similar to link-down state.

When a port is error-disabled, it is effectively shut down, and no traffic is sent or received on the port. For the BPDU guard and port-security features, you can configure the switch to shut down only the offending VLAN on the port when a violation occurs, instead of shutting down the entire port.

If you do not enable the recovery for the cause, the interface stays in the error-disabled state until you enter the shutdown and the no shutdown interface configuration commands. If you enable the recovery for a cause, the interface is brought out of the error-disabled state and allowed to retry the operation again when all the causes have timed out.

Otherwise, you must enter the shutdown and then the no shutdown commands to manually recover an interface from the error-disabled state.

You can verify your settings by entering the show errdisable recovery privileged EXEC command.

Examples

This example shows how to enable the recovery timer for the BPDU guard error-disabled cause:

Device# Device#configure terminalDevice(config)# errdisable recovery cause bpduguard

To control the beacon LED on a device, use the hw-module beacon command in the privileged EXEC mode or global configuration mode.

Cisco IOS XE Fuji 16.8.x and Earlier Releases

hw-module beacon { off | on } switch switch-number

Cisco IOS XE Fuji 16.9.1 and Later Releases

hw-module beacon slot { switch-number | active | standby } { off | on }

Command Default

This command has no default settings.

Command Modes

Global configuration (config) (Cisco IOS XE Fuji 16.8.x and Earlier Releases)

Privileged EXEC (#) (Cisco IOS XE Fuji 16.9.1 and Later Releases)

Usage Guidelines

Use this command to enable or disable the switch LED. Blue indicates the switch LED is on and black indicates that it is off.

Examples

The following example shows how to switch on the LED beacon of the active switch:

Device> enableDevice# hw-module beacon slot active on

To turn off all port LEDs on the device, use the hw-module switch switch-number ecomode led comamnd in the Global Configuration mode. To turn on the port LEDs, use the no form of the command.

hw-module switch { switch-number | all } ecomode led

no hw-module switch { switch-number | all } ecomode led

Command Modes

Global Configuration (config)

Usage Guidelines

When the device boots up, all port LEDs are turned on by default. Use the hw-module switch switch-number ecomode led command to turn off port LEDs on the device. However, when you press the Mode button, all the LEDs will turn on for 10 minutes.

Examples

The following command turn off all port LEDs on the switch which is the second member of the stack.

Device> enableDevice# configure terminal Device(config)# hw-module switch 2 ecomode led

The following command turn off all port LEDs on all the switches of the stack.

Device> enableDevice# configure terminal Device(config)# hw-module switch all ecomode led

To disable ecomode, use the hw-module switch switch-number ecomode serdes-disable command in global configuration mode. To enable ecomode again, use the no form of the command.

hw-module switch switch-number ecomode serdes-disable no hw-module switch switch-number ecomode serdes-disable

Command Modes

Global Configuration (config)

Usage Guidelines

Ports with no small form-factor pluggables (SFPs) inserted have ecomode enabled by default to save power. Use the hw-module switch switch-number ecomode serdes-disable command to turn off ecomode.

Examples

The following example shows how to turn off ecomode.

Device> enableDevice# configure terminal Device(config)#hw-module switch 1 ecomode serdes disable 

To enable the 802.3bt mode on the device, use the hw-module switch upoe-plus comamnd in the Global Configuration mode. To unconfigure the 802.3bt mode, use the no form of the command.

hw-module switch switch-number upoe-plusno hw-module switch switch-number upoe-plus

Command Default

The device is in 802.3at mode.

Command Modes

Global Configuration (config)

Usage Guidelines

When the device boots up, it is in 802.3at-compliant mode by default. Use the hw-module switchswitch-number upoe-plus command to enable 802.3bt Type 3 mode ton the device. This command causes the device to be power-cycled to enable 802.3bt compliance.

Examples

The following command enables 802.3bt mode on the switch which is the second member of the stack.

Device> enableDevice# configure terminal Device(config)# hw-module switch 2 upoe-plus!!!WARNING!!!This configuration will power cycle the switch to make it effective. Would you like to continue y/n?

To configure an interface, use the interface command.

interface {Auto-Template interface-number | FiveGigabitEthernet switch-number/slot-number/port-number | GigabitEthernet switch-number/slot-number/port-number | Loopback interface-number Null interface-number Port-channel interface-number TenGigabitEthernet switch-number/slot-number/port-number TwentyFiveGigE switch-number/slot-number/port-number TwoGigabitEthernet switch-number/slot-number/port-number Tunnel interface-number Vlan interface-number }

Command Default

None

Command Modes

Global configuration (config)

Usage Guidelines

You can not use the "no" form of this command.

Examples

The following example shows how to configure a tunnel interface:

Device(config)# interface Tunnel 15Device(config-if)#

The following example shows how to configure a 25-Gigabit Ethernet interface

Device(config)# interface TwentyFiveGigE 1/1/1Device(config-if)#

The following example shows how to configure a 40-Gigabit Ethernet interface

Device(config)# interface FortyGigabitEthernet 1/1/2Device(config-if)#

To configure an interface range, use the interface range command.

interface range {Auto-Template interface-number | FiveGigabitEthernet switch-number/slot-number/port-number | FortyGigabitEthernet switch-number/slot-number/port-number | GigabitEthernet switch-number/slot-number/port-number | Loopback interface-number Null interface-number Port-channel interface-number TenGigabitEthernet switch-number/slot-number/port-number TwentyFiveGigE switch-number/slot-number/port-number TwoGigabitEthernet switch-number/slot-number/port-number Tunnel interface-number Vlan interface-number }

Command Default

None

Command Modes

Global configuration (config)

Examples

This example shows how you can configure interface range:

Device(config)# interface range vlan 1-100

To set the IP maximum transmission unit (MTU) size of routed packets on all routed ports of the switch or switch stack, use the ip mtu command in interface configuration mode. To restore the default IP MTU size, use the no form of this command.

ip mtu bytes

no ip mtu bytes

Command Default

The default IP MTU size for frames received and sent on all switch interfaces is 1500 bytes.

Command Modes

Interface configuration (config-if)

Usage Guidelines

The upper limit of the IP value is based on the switch or switch stack configuration and refers to the currently applied system MTU value. For more information about setting the MTU sizes, see the system mtu global configuration command.

To return to the default IP MTU setting, you can apply the default ip mtu command or the no ip mtu command on the interface.

You can verify your setting by entering the show ip interface interface-id or show interfaces interface-id privileged EXEC command.

Examples

The following example sets the maximum IP packet size for VLAN 200 to 1000 bytes:

Device(config)# interface vlan 200Device(config-if)# ip mtu 1000

The following example sets the maximum IP packet size for VLAN 200 to the default setting of 1500 bytes:

Device(config)# interface vlan 200Device(config-if)# default ip mtu

This is an example of partial output from the show ip interface interface-id command. It displays the current IP MTU setting for the interface.

Device# show ip interface gigabitethernet4/0/1GigabitEthernet4/0/1 is up, line protocol is up Internet address is 18.0.0.1/24 Broadcast address is 255.255.255.255 Address determined by setup command MTU is 1500 bytes Helper address is not set<output truncated>

To set the IPv6 maximum transmission unit (MTU) size of routed packets on all routed ports of the switch or switch stack, use the ipv6 mtu command in interface configuration mode. To restore the default IPv6 MTU size, use the no form of this command.

ipv6 mtu bytes

no ipv6 mtu bytes

Command Default

The default IPv6 MTU size for frames received and sent on all switch interfaces is 1500 bytes.

Command Modes

Interface configuration

Usage Guidelines

The upper limit of the IPv6 MTU value is based on the switch or switch stack configuration and refers to the currently applied system MTU value. For more information about setting the MTU sizes, see the system mtu global configuration command.

To return to the default IPv6 MTU setting, you can apply the default ipv6 mtu command or the no ipv6 mtu command on the interface.

You can verify your setting by entering the show ipv6 interface interface-id or show interface interface-id privileged EXEC command.

Examples

The following example sets the maximum IPv6 packet size for an interface to 2000 bytes:

Device(config)# interface gigabitethernet4/0/1Device(config-if)# ipv6 mtu 2000

The following example sets the maximum IPv6 packet size for an interface to the default setting of 1500 bytes:

Device(config)# interface gigabitethernet4/0/1Device(config-if)# default ipv6 mtu

This is an example of partial output from the show ipv6 interface interface-id command. It displays the current IPv6 MTU setting for the interface.

Device# show ipv6 interface gigabitethernet4/0/1GigabitEthernet4/0/1 is up, line protocol is up Internet address is 18.0.0.1/24 Broadcast address is 255.255.255.255 Address determined by setup command MTU is 1500 bytes Helper address is not set<output truncated>

To enable Link Layer Discovery Protocol (LLDP) on an interface, use the lldp command in interface configuration mode. To disable LLDP on an interface, use the no form of this command.

lldp {med-tlv-select tlv | receive | tlv-select power-management | transmit}

no lldp {med-tlv-select tlv | receive | tlv-select power-management | transmit}

Command Default

LLDP is disabled.

Command Modes

Interface configuration (config-if)

Usage Guidelines

This command is supported on 802.1 media types.

If the interface is configured as a tunnel port, LLDP is automatically disabled.

Examples

The following example shows how to disable LLDP transmission on an interface:

Device(config)# interface gigabitethernet1/0/1Device(config-if)# no lldp transmit

The following example shows how to enable LLDP transmission on an interface:

Device(config)# interface gigabitethernet1/0/1Device(config-if)# lldp transmit

To enable the logging of Power over Ethernet (PoE) events, use the logging event power-inline-status command in interface configuration mode. To disable the logging of PoE status events, use the no form of this command.

logging event power-inline-status

no logging event power-inline-status

Syntax Description

This command has no arguments or keywords.

Command Default

Logging of PoE events is enabled.

Command Modes

Interface configuration (config-if)

Usage Guidelines

The no form of this command does not disable PoE error events.

Examples

This example shows how to enable logging of PoE events on a port:

Device(config-if)# interface gigabitethernet1/0/1Device(config-if)# logging event power-inline-status Device(config-if)#

To apply a macro to an interface or to apply and debug a macro on an interface, use the macro command in interface configuration mode.

macro {apply | trace} macro-name [parameter {value}] [parameter {value}] [parameter {value}]

Command Default

This command has no default setting.

Command Modes

Interface configuration (config-if)

Usage Guidelines

You can use the macro apply macro-name command to apply and show the macros running on an interface.

You can use the macro trace macro-name command to apply and then debug the macro to find any syntax or configuration errors.

If a command fails because of a syntax error or a configuration error when you apply a macro, the macro continues to apply the remaining commands to the interface.

When creating a macro that requires the assignment of unique values, use the parameter value keywords to designate values specific to the interface.

Keyword matching is case sensitive. All matching occurrences of the keyword are replaced with the corresponding value. Any full match of a keyword, even if it is part of a larger string, is considered a match and is replaced by the corresponding value.

Some macros might contain keywords that require a parameter value. You can use the macro apply macro-name ? command to display a list of any required values in the macro. If you apply a macro without entering the keyword values, the commands are invalid and are not applied.

There are Cisco-default SmartPorts macros embedded in the switch software. You can display these macros and the commands that they contain by using the show parser macro command in user EXEC mode.

Follow these guidelines when you apply a Cisco-default SmartPorts macro on an interface:

• Display all macros on the switch by using the show parser macro command in user EXEC mode. Display the contents of a specific macro by using the show parser macro macro-name command in user EXEC mode.

• Keywords that begin with $ mean that a unique parameter value is required. Append the Cisco-default macro with the required values by using the parameter value keywords.

The Cisco-default macros use the $ character to identify required keywords. You can use the $ character to define keywords when you create a macro.

When you apply a macro to an interface, the macro name is automatically added to the interface. You can display the applied commands and macro names by using the show running-config interface interface-id command in user EXEC mode.

A macro applied to an interface range behaves the same way as a macro applied to a single interface. When you use an interface range, the macro is applied sequentially to each interface within the range. If a macro command fails on one interface, it is still applied to the remaining interfaces.

You can delete a macro-applied configuration on an interface by entering the default interface interface-id command in interface configuration mode.

Examples

After you use the macro name command, in interface configuration mode, you can apply it to an interface. This example shows how to apply a user-created macro called duplex to an interface:

Device(config-if)# macro apply duplex

To debug a macro, use the macro trace command, in interface configuration mode, to find any syntax or configuration errors in the macro as it is applied to an interface.

Device(config-if)# macro trace duplexApplying command...‘duplex auto’%Error Unknown error.Applying command...‘speed nonegotiate’

This example shows how to display the Cisco-default cisco-desktop macro and how to apply the macro and set the access VLAN ID to 25 on an interface:

Device# show parser macro cisco-desktop--------------------------------------------------------------Macro name : cisco-desktopMacro type : default# Basic interface - Enable data VLAN only# Recommended value for access vlan (AVID) should not be 1switchport access vlan $AVIDswitchport mode access# Enable port security limiting port to a single# MAC address -- that of desktopswitchport port-securityswitchport port-security maximum 1# Ensure port-security age is greater than one minute# and use inactivity timerswitchport port-security violation restrictswitchport port-security aging time 2switchport port-security aging type inactivity# Configure port as an edge network portspanning-tree portfastspanning-tree bpduguard enable--------------------------------------------------------------Device# Device# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Device(config)# interface gigabitethernet1/0/4Device(config-if)# macro apply cisco-desktop $AVID 25

To configure and apply a global macro using the CLI, use the macro auto command in privileged EXEC mode.

Use the no form of this command to return to the default setting.

macro auto {apply | config} macro-name

Command Default

No macros are applied to the switch.

Command Modes

Privileged EXEC (#)

Usage Guidelines

To remove the macro from the switch, enter the no forms of the macro commands.

If you enter the macro auto config macro-name command, you are prompted to enter values for all the macro parameters.

Use the exact text string when entering the macro-name. The entries are case sensitive.

The user-defined values appear only in the show macro auto or show running-config command output.

Examples

This example shows how to display global macros:

Device# macro auto apply ?CISCO_SWITCH_AAA_ACCOUNTING Configure aaa accounting parametersCISCO_SWITCH_AAA_AUTHENTICATION Configure aaa authentication parametersCISCO_SWITCH_AAA_AUTHORIZATION Configure aaa authorization parametersCISCO_SWITCH_AUTO_IP_CONFIG Configure the ip parametersCISCO_SWITCH_AUTO_PCI_CONFIG Configure PCI compliant parametersCISCO_SWITCH_DOMAIN_NAME_CONFIG Configure domain nameCISCO_SWITCH_ETHERCHANNEL_CONFIG Configure the etherchannel parametersCISCO_SWITCH_HOSTNAME_CONFIG Configure hostnameCISCO_SWITCH_HTTP_SERVER_CONFIG Configure http serverCISCO_SWITCH_LOGGING_SERVER_CONFIG Configure logging serverCISCO_SWITCH_MGMT_VLAN_CONFIG Configure management vlan parametersCISCO_SWITCH_NAME_SERVER_CONFIG Configure name server parametersCISCO_SWITCH_NTP_SERVER_CONFIG Configure NTP serverCISCO_SWITCH_RADIUS_SERVER_CONFIG Configure radius serverCISCO_SWITCH_SETUP_SNMP_TRAPS Configure SNMP trap parametersCISCO_SWITCH_SETUP_USR_CONFIG Configure the user parametersCISCO_SWITCH_SNMP_SOURCE_CONFIG Configure snmp source interfaceCISCO_SWITCH_TACACS_SERVER_CONFIG Configure tacacs serverCISCO_SWITCH_USER_PASS_CONFIG Configure username and password

Device# macro auto config ?CISCO_SWITCH_AAA_ACCOUNTING Configure aaa accounting parametersCISCO_SWITCH_AAA_AUTHENTICATION Configure aaa authentication parametersCISCO_SWITCH_AAA_AUTHORIZATION Configure aaa authorization parametersCISCO_SWITCH_AUTO_IP_CONFIG Configure the ip parametersCISCO_SWITCH_AUTO_PCI_CONFIG Configure PCI compliant parametersCISCO_SWITCH_DOMAIN_NAME_CONFIG Configure domain nameCISCO_SWITCH_ETHERCHANNEL_CONFIG Configure the etherchannel parametersCISCO_SWITCH_HOSTNAME_CONFIG Configure hostnameCISCO_SWITCH_HTTP_SERVER_CONFIG Configure http serverCISCO_SWITCH_LOGGING_SERVER_CONFIG Configure logging serverCISCO_SWITCH_MGMT_VLAN_CONFIG Configure management vlan parametersCISCO_SWITCH_NAME_SERVER_CONFIG Configure name server parametersCISCO_SWITCH_NTP_SERVER_CONFIG Configure NTP serverCISCO_SWITCH_RADIUS_SERVER_CONFIG Configure radius serverCISCO_SWITCH_SETUP_SNMP_TRAPS Configure SNMP trap parametersCISCO_SWITCH_SETUP_USR_CONFIG Configure the user parametersCISCO_SWITCH_SNMP_SOURCE_CONFIG Configure snmp source interfaceCISCO_SWITCH_TACACS_SERVER_CONFIG Configure tacacs serverCISCO_SWITCH_USER_PASS_CONFIG Configure username and password

This example shows how to display the parameters for a specific macro:

Device# macro auto config CISCO_SWITCH_AUTO_IP_CONFIG ?CISCO_SWITCH_DOMAIN_NAME_CONFIG domain name parametersCISCO_SWITCH_LOGGING_SERVER_CONFIG logging host parametersCISCO_SWITCH_NAME_SERVER_CONFIG name server parametersCISCO_SWITCH_NTP_SERVER_CONFIG ntp server parametersLINE Provide parameters of form [Parameters name=value]<cr>

Device# macro auto config CISCO_SWITCH_AUTO_PCI_CONFIG ?CISCO_SWITCH_AAA_ACCOUNTING aaa accounting parametersCISCO_SWITCH_AAA_AUTHENTICATION aaa authentication parametersCISCO_SWITCH_AAA_AUTHORIZATION aaa authorization parametersCISCO_SWITCH_HTTP_SERVER_CONFIG http server parametersCISCO_SWITCH_RADIUS_SERVER_CONFIG radius server parametersCISCO_SWITCH_TACACS_SERVER_CONFIG tacacs server parametersLINE Provide parameters of form [Parameters name=value]<cr>

Device# macro auto config CISCO_SWITCH_SETUP_SNMP_TRAPS ?CISCO_SWITCH_SNMP_SOURCE_CONFIG snmp source parametersLINE Provide parameters of form [Parameters name=value]<cr>

Device# macro auto config CISCO_SWITCH_SETUP_USR_CONFIG ?CISCO_AUTO_TIMEZONE_CONFIG timezone parametersCISCO_SWITCH_HOSTNAME_CONFIG hostname parameterLINE Provide parameters of form [Parameters name=value]<cr>

This example shows how to set macro parameters and apply the macro using the CLI:

Device# macro auto config CISCO_SWITCH_ETHERCHANNEL_CONFIGEnter the port channel id[1-48] for 3K & 2350,[1-6] for 2K: 2Enter the port channel type, Layer:[2-3(L3 not supported on 2K)]: 2Enter etherchannel mode for the interface[auto/desirable/on/active/passive]: activeEnter the channel protocol[lacp/none]: lacpEnter the number of interfaces to join the etherchannel[8-PAGP/MODE:ON,16-LACP]: 7Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/1Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/2Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/3Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/4Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/5Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/6Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/7Do you want to apply the parameters? [yes/no]: yesEnter configuration commands, one per line. End with CNTL/Z.Enter configuration commands, one per line. End with CNTL/Z.Enter configuration commands, one per line. End with CNTL/Z.Enter configuration commands, one per line. End with CNTL/Z.Enter configuration commands, one per line. End with CNTL/Z.Enter configuration commands, one per line. End with CNTL/Z.Enter configuration commands, one per line. End with CNTL/Z.Device# macro auto apply CISCO_SWITCH_ETHERCHANNEL_CONFIGEnter configuration commands, one per line. End with CNTL/Z.Device#

To configure and apply a global macro using the Cisco IOS shell scripting capability, use the macro auto apply command in privileged EXEC mode. Use the no form of this command to return to the default setting.

macro auto apply macro-name

Command Default

No macros are applied to the switch.

Command Modes

Privileged EXEC (#)

Usage Guidelines

To remove the macro from the switch, enter the no forms of the macro commands.

Use the exact text string when entering the macro-name . The entries are case sensitive.

The user-defined values appear only in the show macro auto or show running-config command output.

You can also use the Cisco IOS shell scripting capability to set the parameters. For examples, see the

“Configuring and Applying Global Macros” section in the “Configuring Auto Smartports and Static Smartports Macros” chapter.

Examples

This example shows how to display global macros:

Device# macro auto apply ?CISCO_SWITCH_AAA_ACCOUNTING Configure aaa accounting parametersCISCO_SWITCH_AAA_AUTHENTICATION Configure aaa authentication parametersCISCO_SWITCH_AAA_AUTHORIZATION Configure aaa authorization parametersCISCO_SWITCH_AUTO_IP_CONFIG Configure the ip parametersCISCO_SWITCH_AUTO_PCI_CONFIG Configure PCI compliant parametersCISCO_SWITCH_DOMAIN_NAME_CONFIG Configure domain nameCISCO_SWITCH_ETHERCHANNEL_CONFIG Configure the etherchannel parametersCISCO_SWITCH_HOSTNAME_CONFIG Configure hostnameCISCO_SWITCH_HTTP_SERVER_CONFIG Configure http serverCISCO_SWITCH_LOGGING_SERVER_CONFIG Configure logging serverCISCO_SWITCH_MGMT_VLAN_CONFIG Configure management vlan parametersCISCO_SWITCH_NAME_SERVER_CONFIG Configure name server parametersCISCO_SWITCH_NTP_SERVER_CONFIG Configure NTP serverCISCO_SWITCH_RADIUS_SERVER_CONFIG Configure radius serverCISCO_SWITCH_SETUP_SNMP_TRAPS Configure SNMP trap parametersCISCO_SWITCH_SETUP_USR_CONFIG Configure the user parametersCISCO_SWITCH_SNMP_SOURCE_CONFIG Configure snmp source interfaceCISCO_SWITCH_TACACS_SERVER_CONFIG Configure tacacs serverCISCO_SWITCH_USER_PASS_CONFIG Configure username and password

To configure and apply a global macro, use the macro auto config command in privileged EXEC mode. Use the no form of this command to return to the default setting.

macro auto config macro-name [parameter=value [parameter=value]...]

Command Default

No macros are applied to the switch.

Command Modes

Privileged EXEC (#)

Usage Guidelines

To remove the macro from the switch, enter the no forms of the macro commands.

If you enter the macro auto config macro-name command, you are prompted to enter values for all the macro parameters.

Use the exact text string when entering the macro-name and parameters . The entries are case sensitive.

The user-defined values appear only in the show macro auto or show running-config command output.

You can also use the Cisco IOS shell scripting capability to set the parameters. For examples, see the “Configuring and Applying Global Macros” section in the “Configuring Auto Smartports and Static Smartports Macros” chapter.

To specify when the switch applies an Auto Smartports macro based on the detection method, device type, or trigger (referred to as event trigger control), use the macro auto control command in interface configuration mode. Use the no form of this command to disable trigger-to-macro mapping. The switch then does not apply macros based on event triggers.

macro auto control {detection [cdp] [lldp] [mac-address] | device [ip-camera] [media-player] [phone] [lightweight-ap] [access-point] [router] [switch] | trigger [last-resort]}

no macro auto control {detection [cdp] [lldp] [mac-address] | device [ip-camera] [media-player] [phone] [lightweight-ap] [access-point] [router] [switch] | trigger [last-resort]}

Command Default

The switch uses the device type as the event trigger. If the switch cannot determine the device type, it uses MAC address groups, MAB messages, 802.1x authentication messages, and LLDP messages in random order.

Command Modes

Interface configuration (config-if)

Usage Guidelines

If you do not set event triggers, the switch uses the device type as the event trigger. If the switch cannot determine the device type, it uses MAC address groups, MAB messages, 802.1x authentication messages, and LLDP messages in random order.

To verify that a macro is applied to an interface, use the show macro auto interface command in user EXEC mode.

Examples

This example shows how to set LLDP messages and MAC address groups as event triggers:

Device(config)# interface gigabitethernet 5/0/2Device(config-if)# macro auto control detection lldp mac-addressDevice(config-if)# exitDevice(config)# end

This example shows how to set access points, video surveillance cameras, and digital media players as event triggers:

Note	The switch applies a built-in macro only when it detects an access point, video surveillance camera, or digital media player.

Device(config)# interface gigabitethernet 5/0/1Device(config-if)# macro auto control device access-point ip-camera media-playerDevice(config-if)# exitDevice(config)# end

To replace built-in macro default values and to configure mapping from an event trigger to a built-in or user-defined macro, use the macro auto execute command in global configuration mode.

macro auto execute event trigger {builtin built-in macro | remote url} {parameter | = | value} {function | contents}

no macro auto execute event trigger {builtin built-in macro | remote url} {parameter | = | value} {function | contents}

Command Default

None

Command Modes

Global configuration (config)

Usage Guidelines

Use the macro auto execute command to replace the built-in macro default values with values that are specific to your switch.

The switch automatically maps from event triggers to built-in macros. The built-in macros are system-defined macros in the software image. You can also create user-defined macros by using the Cisco IOS shell scripting capability.

You can create new event triggers by using the shell trigger commands in global configuration mode. Use the show shell triggers command in privileged EXEC to display the contents of the user-defined triggers and macros.

You can use the macro auto mac-address-group command in global configuration mode to create event triggers for devices that do not support Cisco Discovery Protocol (CDP) or Link Layer Discovery Protocol (LLDP).

You can use the remote macro feature to store macros in a central location for designated network switches to use. You can then maintain and update the macro files for use by multiple switches. Use remote url to configure the remote server location and macro path information. There are no specific file extension requirements for saved macro files.

Auto Smartports macros and antimacros (the antimacro is the portion of the applied macro that removes it at link down) have these guidelines and limitations:

• You can delete or change the built-in macros. However, you can override a built-in macro by creating a user-defined macro with the same name. To restore the original built-in macro, delete the user-defined macro.

• If you enable both the macro auto device and the macro auto execute commands, the parameters specified in the command last executed are applied to the switch. Only one command is active on the switch.

• To avoid system conflicts when macros are applied, remove all port configurations except for 802.1x authentication.

• Do not configure port security when enabling Auto SmartPorts on the switch.

• If the macro conflicts with the original configuration, either the macro does not apply some of the original configuration commands, or the antimacro does not remove them. (The antimacro is the portion of the applied macro that removes the macro at a link-down event.)

• For example, if 802.1x authentication is enabled, you cannot remove the switchport-mode access configuration. Remove the 802.1x authentication before removing the switchport mode configuration.

• A port cannot be a member of an EtherChannel when you apply Auto SmartPorts macros.

• The built-in-macro default data VLAN is VLAN 1. The default voice VLAN is VLAN 2. If your switch uses different access, native, or voice VLANs, use the macro auto device or the macro auto execute commands to configure the values.

• For 802.1x authentication or MAC authentication bypass (MAB), to detect non-Cisco devices, configure the RADIUS server to support the Cisco attribute-value pair auto-smart-port=event trigger

• The switch supports Auto SmartPort macros only on directly connected devices. Multiple device connections, such as hubs, are not supported.

• If authentication is enabled on a port, the switch ignores a MAC address trigger if authentication fails.

• The order of CLI commands within the macro and the corresponding antimacro can be different.

Examples

This example shows how to use two built-in macros for connecting Cisco switches and Cisco IP phones to the switch. This example modifies the default voice VLAN, access VLAN, and native VLAN for the trunk interface:

Device(config)# !!! the next command modifies the access and voice vlansDevice(config)# !!! for the built in Cisco IP phone auto smartport macroDevice(config)# macro auto execute CISCO_PHONE_EVENT builtin CISCO_PHONE_AUTO_SMARTPORT ACCESS_VLAN=10 VOICE_VLAN=20Device(config)# !!! the next command modifies the Native vlan used for inter switch trunksDevice(config)# macro auto execute CISCO_SWITCH_EVENT builtin CISCO_SWITCH_AUTO_SMARTPORT NATIVE_VLAN=10Device(config)# !!! the next command enables auto smart ports globallyDevice(config)# macro auto global processing Device(config)# exitDevice# !!! here is the running configuration of the interface connectedDevice# !!! to another Cisco Switch after the Macro is appliedDevice# show running-config interface gigabitethernet1/0/1Building configuration... Current configuration : 284 bytes!interface GigabitEthernet1/0/1 switchport trunk encapsulation dot1q switchport trunk native vlan 10 switchport mode trunk srr-queue bandwidth share 10 10 60 20 queue-set 2 priority-queue out mls qos trust cos auto qos voip trust macro description CISCO_SWITCH_EVENTend

Examples

This example shows how to map a user-defined event trigger called media player to a user-defined macro

1. Connect the media player to an 802.1x- or MAB-enabled switch port.

2. On the RADIUS server, set the attribute-value pair to auto-smart-port=DMP_EVENT

3. On the switch, create the event trigger DMP_EVENT, and enter the user-defined macro commands.

4. The switch recognizes the attribute-value pair=DMP_EVENT response from the RADIUS server and applies the macro associated with this event trigger.

Device(config)# shell trigger DMP_EVENT mediaplayer Device(config)# macro auto execute DMP_EVENT {if [[ $LINKUP == YES ]]; then conf t interface $INTERFACE macro description $TRIGGER switchport access vlan 1 switchport mode access switchport port-security switchport port-security maximum 1 switchport port-security violation restrict switchport port-security aging time 2 switchport port-security aging type inactivity spanning-tree portfast spanning-tree bpduguard enable exit fi if [[ $LINKUP == NO ]]; then conf t interface $INTERFACE no macro description $TRIGGER no switchport access vlan 1 if [[ $AUTH_ENABLED == NO ]]; then no switchport mode access fi no switchport port-security no switchport port-security maximum 1 no switchport port-security violation restrict no switchport port-security aging time 2 no switchport port-security aging type inactivity no spanning-tree portfast no spanning-tree bpduguard enable exit fi

To specify when the switch applies an Auto Smartports macro based on the device type or trigger (referred to as event trigger control), use the macro auto global control command in global configuration mode. Use the no form of this command to disable trigger-to-macro mapping.

macro auto global control {detection [cdp] [lldp] [mac-address] | device [access-point] [ip-camera] [lightweight-ap] [media-player] [phone] [router] [switch] | trigger [last-resort]}

no macro auto global control {detection [cdp] [lldp] [mac-address] | device [access-point] [ip-camera] [lightweight-ap] [media-player] [phone] [router] [switch] | trigger [last-resort]}

Command Default

The switch uses the device type as the event trigger. If the switch cannot determine the device type, it uses MAC address groups, MAB messages, 802.1x authentication messages, and LLDP messages in random order.

Command Modes

Global configuration (config)

Usage Guidelines

If you do not set event triggers, the switch uses the device type as the event trigger. If the switch cannot determine the device type, it uses MAC address groups, MAB messages, 802.1x authentication messages, and LLDP messages in random order.

To verify that a macro is applied to a switch, use the show macro auto global command in user EXEC mode.

Examples

This example shows how to set CDP messages, LLDP messages and MAC address groups as event triggers:

Device(config)# macro auto global control detection cdp lldp mac-addressDevice(config)# end

This example shows how to set autonomous access points, lightweight access points, and IP phones:

Device(config)# macro auto global control device access-point lightweight-ap phoneDevice(config)# end

To enable Auto SmartPorts macros on the switch, use the macro auto global processing command in global configuration mode. Use the no form of this command to disable the macros.

macro auto global processing

no macro auto global processing

Command Default

Auto Smartports is disabled.

Command Modes

Global configuration (config)

Usage Guidelines

Use the macro auto global processing command to globally enable macros on the switch. To disable macros on a specific port, use the no macro auto processing command in interface mode.

When using 802.1x or MAB authentication, you need to configure the RADIUS server to support the Cisco attribute-value pair auto-smart-port =event trigger . If authentication fails, the macro is not applied. If the 802.1x or MAB authentication fails on the interface, the switch does not use the fallback CDP event trigger.

When CDP-identified devices advertise multiple capabilities, the switch chooses a capability first by switch and then by router.

To verify that a macro is applied to an interface, use the show macro auto interface command in privileged EXEC mode.

Examples

This example shows how to enable Auto SmartPorts on the switch and to disable the feature on a specific interface:

Device(config)# macro auto global processingDevice(config)# interface gigabitethernet 0/1Device(config-if)# no macro auto processingDevice(config-if)# exitDevice(config)#

To create an event trigger for devices that do not support Cisco Discovery Protocol (CDP) or Link Layer Discover Protocol (LLDP), use the macro auto mac-address-group command in global configuration mode. Use the no form of this command to delete the group.

macro auto mac-address-group name {mac-address list list | oui {list list | range start-value size number}}

no macro auto mac-address-group name {mac-address list list | oui {list list | range start-value size number}}

Command Default

No groups are defined.

Command Modes

Group configuration (config-addr-grp-mac)

Usage Guidelines

Use the macro auto mac-address-group command to create an event trigger for devices that do not support CDP or LLDP. Use the MAC address group as a trigger to map to a built-in or user-defined macro by using the macro auto execute command. At link-up the switch detects the device type and applies the specified macro.

The switch supports up to ten MAC address groups. Each group can have up to 32 OUI and 32 MAC configured addresses.

Examples

This example shows how to create a MAC-address-group event trigger called address_trigger and how to verify your entries:

Device(config)# macro auto mac-address-group mac address_triggerDevice(config-addr-grp-mac)# mac-address list 2222.3333.3334 22.33.44 a.b.cDevice(config-addr-grp-mac)# oui list 455555 233244Device(config-addr-grp-mac)# oui range 333333 size 2Device(config-addr-grp-mac)# exitDevice(config)# endDevice# show running configuration!!macro auto mac-address-group address_trigger oui list 333334 oui list 333333 oui list 233244 oui list 455555 mac-address list 000A.000B.000C mac-address list 0022.0033.0044 mac-address list 2222.3333.3334!<output truncated>

To enable Auto SmartPorts macros on an interface, use the macro auto processing command in interface configuration mode. Use the no form of this command to disable the macros.

macro auto processing

no macro auto processing

Command Default

Auto SmartPorts is disabled.

Command Modes

Interface configuration (config-if)

Usage Guidelines

Use the macro auto processing command, in interface configuration mode, to enable macros on a specific interface. To disable macros on a specific interface, use the no macro auto processing command, in interface configuration mode.

A port cannot be a member of an EtherChannel when you apply Auto SmartPorts macros. If you use EtherChannels, disable Auto SmartPorts on the EtherChannel interface by using the no macro auto processing command. The EtherChannel interface applies the configuration to the member interfaces.

To verify that a macro is applied to an interface, use the show macro auto interface command in privileged EXEC mode.

Examples

This example shows how to enable Auto SmartPorts on the switch and to disable the feature on a specific interface:

Device(config)# interface gigabitethernet 0/1Device(config-if)# no macro auto processingDevice(config-if)# exitDevice(config)# macro auto global processing

To configure macros to remain active after a link-down event, referred to as macro persistence, use the macro auto sticky command in global configuration mode. Use the no form of this command to disable the macro persistence.

macro auto sticky

no macro auto sticky

Command Default

Macro persistence is disabled.

Command Modes

Global configuration (config)

Usage Guidelines

Use the macro auto sticky command so that macros remain active after a link-down event.

Examples

This example shows how to enable macro persistence on an interface:

Device(config)# interface gigabitethernet 5/0/2Device(config-if)# macro auto port stickyDevice(config-if)# exitDevice(config)# end

To enter the configure-macro-trigger mode and define a trigger for a device that has no built-in trigger and associate the trigger with a device or profile, use the macro auto trigger command in global configuration mode. To remove the user-defined trigger, use the no form of this command.

macro auto trigger trigger_name {device | exit | no | profile}

no macro auto trigger trigger_name {device | exit | no | profile}

Command Default

No user-defined triggers are configured.

Command Modes

Global configuration (config)

Usage Guidelines

If a device is classified by the Device Classifier, but does not have a built-in trigger defined, use the macro auto trigger command, in global configuration mode, to define a trigger based on a device name or a profile name. After you enter the command, the switch is in the configure-macro-trigger mode and the device , exit , no , and profile keywords are visible. In this mode, you can provide a device name or a profile name to map to the trigger. It is not necessary to map the trigger to both a device name and a profile name. If you map the trigger to both names, the trigger-to-profile name mapping has preference for macro application.

You must use this command to configure a trigger when you configure a user-defined macro. The trigger name is required for the custom macro configuration.

After the device is profiled, you must add the complete string to the device-group database.

Examples

This example shows how to configure a user-defined trigger for a profile called DMP_EVENT mediaplayer for use with a media player that has no built-in trigger:

Device(config)# macro auto trigger DMPDevice(config-macro-trigger)# profile mediaplayer-DMPDevice(config-macro-trigger)# exit

To enter a description about which macros are applied to an interface, use the macro description command in interface configuration mode. Use the no form of this command to remove the description. This command is mandatory for Auto SmartPorts to work.

macro description text

no macro description text

Command Default

This command has no default setting.

Command Modes

Interface configuration (config-if)

Usage Guidelines

Use the description keyword to associate comment text or the macro name with an interface. When multiple macros are applied on a single interface, the description text is from the last applied macro.

You can verify your settings by entering the show parser macro description command in privileged EXEC mode.

Examples

This example shows how to add a description to an interface:

(config-if)# macro description duplex settings

To apply a macro to a switch or to apply and debug a macro on a switch, use the macro global command in global configuration mode.

macro global {apply | trace} macro-name [parameter {value}] [parameter {value}] [parameter {value}]

Command Default

This command has no default setting.

Command Modes

Global configuration (config)

Usage Guidelines

Note	You can delete a global macro-applied configuration on a switch only by entering the no version of each command in the macro.

Use the macro global apply macro-name command to apply the macro to an interface.

Use the macro global trace macro-name command to apply and then debug the macro to find any syntax or configuration errors.

If a command fails when you apply a macro because of a syntax error or a configuration error, the macro continues to apply the remaining commands to the switch.

When creating a macro that requires the assignment of unique values, use the parameter value keywords to designate values specific to the switch.

Keyword matching is case sensitive. All matching occurrences of the keyword are replaced with the corresponding value. Any full match of a keyword, even if it is part of a larger string, is considered a match and is replaced by the corresponding value.

Some macros might contain keywords that require a parameter value. You can use the macro global apply macro-name ? command to display a list of any required values in the macro. If you apply a macro without entering the keyword values, the commands are invalid and are not applied.

There are Cisco-default Smartports macros embedded in the switch software. You can display these macros and the commands they contain by using the show parser macro command in user EXEC mode.

Follow these guidelines when you apply a Cisco-default Smartports macro on a switch:

• Display all macros on the switch by using the show parser macro command. Display the contents of a specific macro by using the show parser macro name macro-name command.

• Keywords that begin with $ mean that a unique parameter value is required. Append the Cisco-default macro with the required values by using the parameter value keywords.

  The Cisco-default macros use the $ character to help identify required keywords. There is no restriction on using the $ character to define keywords when you create a macro.

When you apply a macro to a switch, the macro name is automatically added to the switch. You can display the applied commands and macro names by using the show running-config command.

Examples

After you have created a new macro by using the macro auto execute command, you can apply it to a switch. This example shows how to view the snmp macro, how to apply the macro, set the hostname to test-server, and set the IP precedence value to 7:

Device# show parser macro name snmpMacro name : snmpMacro type : customizable#enable port security, linkup, and linkdown trapssnmp-server enable traps port-securitysnmp-server enable traps linkupsnmp-server enable traps linkdown#set snmp-server hostsnmp-server host ADDRESS#set SNMP trap notifications precedencesnmp-server ip precedence VALUE--------------------------------------------------Device(config)# macro global apply snmp ADDRESS test-server VALUE 7

To debug a macro, use the macro global trace command to find any syntax or configuration errors in the macro when you apply it to a switch. In this example, the ADDRESS parameter value was not entered, the snmp-server host command failed, and the remainder of the macro is applied to the switch:

Device(config)# macro global trace snmp VALUE 7Applying command...‘snmp-server enable traps port-security’Applying command...‘snmp-server enable traps linkup’Applying command...‘snmp-server enable traps linkdown’Applying command...‘snmp-server host’%Error Unknown error.Applying command...‘snmp-server ip precedence 7’

To enter a description about the macros that are applied to a switch, use the macro global description command in global configuration mode. Use the no form of this command to remove the description.

macro global description text

no macro global description text

Command Default

This command has no default setting.

Command Modes

Global configuration (config)

Usage Guidelines

Use the description keyword to associate comment text or the macro name with a switch. When multiple macros are applied on a switch, the description text is from the last applied macro.

You can verify your settings by entering the show parser macro description command in privileged EXEC mode.

Examples

This example shows how to add a description to a switch:

Device(config)# macro global description udld aggressive mode enabled

To enable the automatic medium-dependent interface crossover (auto-MDIX) feature on the interface, use the mdix auto command in interface configuration mode. To disable auto-MDIX, use the no form of this command.

mdix auto

no mdix auto

Syntax Description

This command has no arguments or keywords.

Command Default

Auto-MDIX is enabled.

Command Modes

Interface configuration (config-if)

Usage Guidelines

When auto-MDIX is enabled, the interface automatically detects the required cable connection type (straight-through or crossover) and configures the connection appropriately.

When you enable auto-MDIX on an interface, you must also set the interface speed and duplex to auto so that the feature operates correctly.

When auto-MDIX (and autonegotiation of speed and duplex) is enabled on one or both of the connected interfaces, link up occurs, even if the cable type (straight-through or crossover) is incorrect.

Auto-MDIX is supported on all 10/100 and 10/100/1000 Mb/s interfaces and on 10/100/1000BASE-TX small form-factor pluggable (SFP) module interfaces. It is not supported on 1000BASE-SX or -LX SFP module interfaces.

You can verify the operational state of auto-MDIX on the interface by entering the show controllers ethernet-controller interface-id phy privileged EXEC command.

Examples

This example shows how to enable auto-MDIX on a port:

Device# configure terminalDevice(config)# interface gigabitethernet1/0/1Device(config-if)# speed autoDevice(config-if)# duplex autoDevice(config-if)# mdix autoDevice(config-if)# end

To configure power stack mode for the power stack, use the mode command in power-stack configuration mode. To return to the default settings, use the no form of the command.

mode {power-shared | redundant} [strict]

no mode

Command Default

The default modes are power-shared and nonstrict.

Command Modes

Power-stack configuration (config-stackpower)

Usage Guidelines

This command is available only on switch stacks running the IP Base or IP Services feature set.

To access power-stack configuration mode, enter the stack-power stack power stack name global configuration command.

Entering the no mode command sets the switch to the defaults of power-shared and non-strict mode.

Note	For stack power, available power is the total power available for PoE from all power supplies in the power stack, available power is the power allocated to all powered devices connected to PoE ports in the stack, and consumed power is the actual power consumed by the powered devices.

In power-shared mode, all of the input power can be used for loads, and the total available power appears as one large power supply. The power budget includes all power from all supplies. No power is set aside for power supply failures. If a power supply fails, load shedding (shutting down of powered devices or switches) might occur.

In redundant mode, the largest power supply is removed from the power pool to use as backup power in case one of the other power supplies fails. The available power budget is the total power minus the largest power supply. This reduces the available power in the pool for switches and powered devices, but in case of a failure or an extreme power load, there is less chance of having to shut down switches or powered devices.

In strict mode, when a power supply fails and the available power drops below the budgeted power, the system balances the budget through load shedding of powered devices, even if the actual power is less than the available power. In nonstrict mode, the power stack can run in an over-allocated state and is stable as long as the actual power does not exceed the available power. In this mode, a powered device drawing more than normal power could cause the power stack to start shedding loads. This is normally not a problem because most devices do not run at full power. The chances of multiple powered devices in the stack requiring maximum power at the same time is small.

In both strict and nonstrict modes, power is denied when there is no power available in the power budget.

Examples

This is an example of setting the power stack mode for the stack named power1 to power-shared with strict power budgeting. All power in the stack is shared, but when the total available power is allotted, no more devices are allowed power.

Device(config)# stack-power stack power1Device(config-stackpower)# mode power-shared strictDevice(config-stackpower)# exit

This is an example of setting the power stack mode for the stack named power2 to redundant. The largest power supply in the stack is removed from the power pool to provide redundancy in case one of the other supplies fails.

Device(config)# stack-power stack power2Device(config-stackpower)# mode redundantDevice(config-stackpower)# exit

To enable monitoring of all optical transceivers and to specify the time period for monitoring the transceivers, use the monitoring command in transceiver type configuration mode. To disable the monitoring, use the no form of this command.

monitoring [ interval seconds ]

no monitoring [interval]

Syntax Description

Command Default

The interval time is 600 seconds.

Command Modes

Transceiver type configuration (config-xcvr-type)

Command History

Usage Guidelines

You need digital optical monitoring (DOM) feature and transceiver module compatibility information to configure the monitoring command. Refer to the compatibility matrix to get the lists of Cisco platforms and minimum required software versions to support Gigabit Ethernet transceiver modules.

Gigabit Ethernet Transceivers transmit and receive Ethernet frames at a rate of a gigabit per second, as defined by the IEEE 802.3-2008 standard. Cisco's Gigabit Ethernet Transceiver modules support Ethernet applications across all Cisco switching and routing platforms. These pluggable transceivers offer a convenient and cost effective solution for the adoption in data center, campus, metropolitan area access and ring networks, and storage area networks.

The interval keyword enables you to change the default polling interval. For example, if you set the interval as 1500 seconds, polling happens at every 1500th second. During the polling period entSensorStatus of optical transceivers is set to Unavailable, and once the polling finishes entSensorStatus shows the actual status.

Examples

This example shows how to enable monitoring of optical transceivers and set the interval time for monitoring to 1500 seconds:

Device# configure terminalDevice(config)# transceiver type allDevice(config-xcvr-type)# monitoring interval 1500

This example shows how to disable monitoring for all transceiver types:

Device(config-xcvr-type)# no monitoring

Related Commands

To apply a network-policy profile to an interface, use the network-policy command in interface configuration mode. To remove the policy, use the no form of this command.

network-policy profile-number

no network-policy

Command Default

No network-policy profiles are applied.

Command Modes

Interface configuration (config-if)

Usage Guidelines

Use the network-policy profile number interface configuration command to apply a profile to an interface.

You cannot apply the switchport voice vlan command on an interface if you first configure a network-policy profile on it. However, if switchport voice vlan vlan-id is already configured on the interface, you can apply a network-policy profile on the interface. The interface then has the voice or voice-signaling VLAN network-policy profile applied.

Examples

This example shows how to apply network-policy profile 60 to an interface:

Device(config)# interface gigabitethernet1/0/1Device(config-if)# network-policy 60

To create a network-policy profile and to enter network-policy configuration mode, use the network-policy profile command in global configuration mode. To delete the policy and to return to global configuration mode, use the no form of this command.

network-policy profile profile-number

no network-policy profile profile-number

Command Default

No network-policy profiles are defined.

Command Modes

Global configuration (config)

Usage Guidelines

Use the network-policy profile global configuration command to create a profile and to enter network-policy profile configuration mode.

To return to privileged EXEC mode from the network-policy profile configuration mode, enter the exit command.

When you are in network-policy profile configuration mode, you can create the profile for voice and voice signaling by specifying the values for VLAN, class of service (CoS), differentiated services code point (DSCP), and tagging mode.

These profile attributes are contained in the Link Layer Discovery Protocol for Media Endpoint Devices (LLDP-MED) network-policy time-length-value (TLV).

Examples

This example shows how to create network-policy profile 60:

Device(config)# network-policy profile 60Device(config-network-policy)#

To disable all the USB ports on a device, use the platform usb disable command in global configuration mode. To reenable all the USB ports on the device, use the no platform usb disable command.

platform usb disable no platform usb disable

Command Default

All the USB ports are enabled by default.

Command Modes

Global configuration (config)

Usage Guidelines

The platform usb disable command disables all the USB ports on both stacked and standalone devices, but not Bluetooth dongles connected to USB ports.

Examples

The following example shows how to disable USB ports on a device:

Device> enableDevice# configure terminalDevice(config)# platform usb disableThis config cli may cause data corruption if there is some ongoing operation on usb device. Do you want to proceed [confirm]? yDevice(config)# end

Related Commands

To configure port settings for an interface, use the port-settings command in interface configuration mode. To disable the configuration, use the no form of this command.

port-settings { speed { 10 | 100 | 1000 | auto | auto-list } } { duplex { auto | full | half } } { autoneg { disable | enable } }

no port-settings port-settings { speed { 10 | 100 | 1000 | auto | auto-list } } { duplex { auto | full | half } } { autoneg { disable | enable } }

Command Default

Autonegotiation is enabled.

Command Modes

Interface configuration (config-if)

Usage Guidelines

Use the port-settings command to simultaneously or separately configure the speed, duplex, and auto negotiation for an interface. This command can configure port settings for an interface, an interface range, or a port-channel interface.

When using a single command to configure multiple parameters of the port-settings command, the order must be, speed , duplex , and autoneg . If you specify speed first, you can configure duplex and autoneg for the interface. If you specify duplex first, you can only configure autoneg . And, if you specify autoneg first, you cannot configure speed or duplex .

Use either the port-settings command or the speed , duplex , and negotiation auto commands available in the interface configuration mode to configure port settings for an interface.

The port-settings , speed , duplex , and negotiation auto commands coexist in the CLI. The port-settings commands are displayed only in the output of the show running-config yang command. However, the values set through the port-settings command are displayed in the output of both the show running-config and show running-config yang commands.

Because the parameters of an interface can be set through multiple commands, the last configured value will take effect. The last configured value is displayed in the output of both the show running-config and show running-config yang commands.

To use the autonegotiation capability, that is to automatically detect speed and duplex modes, set both speed and duplex to auto .

The port settings for an interface can also be configured through the Cisco-IOS-XE-ethernet.yang model.

Comparison of Commands

This table provides a one-to-one comparison of the existing and newly-added commands:

Examples

This example shows how to configure port settings for a Gigabit Ethernet interface.

Device> enableDevice# configure terminalDevice(config)# interface gigabitethernet 0/0Device(config-if)# port-settings speed 1000Device(config-if)# port-settings duplex fullDevice(config-if)# end 

This example shows how to configure all port-setting parameters in a single command.

Device> enableDevice# configure terminalDevice(config)# interface gigabitethernet 0/0Device(config-if)# port-settings speed 1000 duplex full autoneg enableDevice(config-if)# end 

Examples

Sending:#403<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:ad6aa921-3ff7-4753-a93b-0690ffb198d3"> <nc:get-config> <nc:source> <nc:running/> </nc:source> <nc:filter> <native xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-native"> <interface> <GigabitEthernet> <name>1/1/0/1</name> </GigabitEthernet> </interface> </native> </nc:filter> </nc:get-config></nc:rpc>

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:ad6aa921-3ff7-4753-a93b-0690ffb198d3"> <data> <native xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-native"> <interface> <GigabitEthernet> <name>1/1/0/1</name> <port-settings xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-ethernet"> <speed> <speed-value>1000</speed-value> </speed> <duplex>full</duplex> </port-settings> <speed xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-ethernet"> <value-1000/> </speed> <duplex xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-ethernet">full</duplex> </GigabitEthernet> </interface> </native> </data></rpc-reply>NETCONF get-config COMPLETE

Related Commands

To configure Cisco StackPower power-priority values for a switch in a power stack and for its high-priority and low-priority PoE ports, use the power-priority command in switch stack-power configuration mode. To return to the default setting, use the no form of the command.

power-priority {high value | low value | switch value}

no power-priority {high | low | switch}

Command Default

If no values are configured, the power stack randomly determines a default priority.

The default ranges are 1 to 9 for switches, 10 to 18 for high-priority ports, 19 to 27 for low-priority ports.

On non-PoE switches, the high and low values (for port priority) have no effect.

Command Modes

Switch stack-power configuration (config-stack)

Usage Guidelines

To access switch stack-power configuration mode, enter the stack-power switch switch-number global configuration command.

Cisco StackPower power-priority values determine the order for shutting down switches and ports when power is lost and load shedding must occur. Priority values are from 1 to 27; the highest numbers are shut down first.

We recommend that you configure different priority values for each switch and for its high priority ports and low priority ports to limit the number of devices shut down at one time during a loss of power. If you try to configure the same priority value on different switches in a power stack, the configuration is allowed, but you receive a warning message.

Note	This command is available only on switch stacks running the IP Base or IP Services feature set.

Examples

This is an example of setting the power priority for switch 1 in power stack a to 7, for the high-priority ports to 11, and for the low-priority ports to 20.

Device(config)# stack-power switch 1Device(config-switch-stackpower)# stack-id power_stack_aDevice(config-switch-stackpower)# power-priority high 11Device(config-switch-stackpower)# power-priority low 20 Device(config-switch-stackpower)# power-priority switch 7Device(config-switch-stackpower)# exit

To configure the power management mode on Power over Ethernet (PoE) ports, use the power inline command in interface configuration mode. To return to the default settings, use the no form of this command.

power inline {auto [max max-wattage] | never | port priority {high | low} | static [max max-wattage]}

no power inline {auto | never | port priority {high | low} | static [max max-wattage]}

Command Default

The default is auto (enabled).

The maximum wattage is 30,000 mW.

The default port priority is low.

Command Default

Interface configuration (config-if)

Usage Guidelines

This command is supported only on PoE-capable ports. If you enter this command on a port that does not support PoE, this error message appears:

Device(config)# interface gigabitethernet1/0/1Device(config-if)# power inline auto ^% Invalid input detected at '^' marker.

In a switch stack, this command is supported on all ports in the stack that support PoE.

Use the max max-wattage option to disallow higher-power powered devices. With this configuration, when the powered device sends Cisco Discovery Protocol (CDP) messages requesting more power than the maximum wattage, the switch removes power from the port. If the powered-device IEEE class maximum is greater than the maximum wattage, the switch does not power the device. The power is reclaimed into the global power budget.

Note	The switch never powers any class 0 or class 3 device if the power inline max max-wattage command is configured for less than 30 W.

If the switch denies power to a powered device (the powered device requests more power through CDP messages or if the IEEE class maximum is greater than the maximum wattage), the PoE port is in a power-deny state. The switch generates a system message, and the Oper column in the show power inline privileged EXEC command output shows power-deny.

Use the power inline static max max-wattage command to give a port high priority. The switch allocates PoE to a port configured in static mode before allocating power to a port configured in auto mode. The switch reserves power for the static port when it is configured rather than upon device discovery. The switch reserves the power on a static port even when there is no connected device and whether or not the port is in a shutdown or in a no shutdown state. The switch allocates the configured maximum wattage to the port, and the amount is never adjusted through the IEEE class or by CDP messages from the powered device. Because power is pre-allocated, any powered device that uses less than or equal to the maximum wattage is guaranteed power when it is connected to a static port. However, if the powered device IEEE class is greater than the maximum wattage, the switch does not supply power to it. If the switch learns through CDP messages that the powered device needs more than the maximum wattage, the powered device is shut down.

If the switch cannot pre-allocate power when a port is in static mode (for example, because the entire power budget is already allocated to other auto or static ports), this message appears: Command rejected: power inline static: pwr not available. The port configuration remains unchanged.

When you configure a port by using the power inline auto or the power inline static interface configuration command, the port autonegotiates by using the configured speed and duplex settings. This is necessary to determine the power requirements of the connected device (whether or not it is a powered device). After the power requirements have been determined, the switch hardcodes the interface by using the configured speed and duplex settings without resetting the interface.

When you configure a port by using the power inline never command, the port reverts to the configured speed and duplex settings.

If a port has a Cisco powered device connected to it, you should not use the power inline never command to configure the port. A false link-up can occur, placing the port in an error-disabled state.

Use the power inline port priority {high | low} command to configure the power priority of a PoE port. Powered devices connected to ports with low port priority are shut down first in case of a power shortage.

You can verify your settings by entering the show power inline EXEC command.

Examples

This example shows how to enable detection of a powered device and to automatically power a PoE port on a switch:

Device(config)# interface gigabitethernet1/0/2Device(config-if)# power inline auto

This example shows how to configure a PoE port on a switch to allow a class 1 or a class2 powered device:

Device(config)# interface gigabitethernet1/0/2Device(config-if)# power inline auto max 7000

This example shows how to disable powered-device detection and to not power a PoE port on a switch:

Device(config)# interface gigabitethernet1/0/2Device(config-if)# power inline never

This example shows how to set the priority of a port to high, so that it would be one of the last ports to be shut down in case of power supply failure:

Device(config)# interface gigabitethernet1/0/2Device(config-if)# power inline port priority high

To enable policing of real-time power consumption on a powered device, use the power inline police command in interface configuration mode. To disable this feature, use the no form of this command

power inline police [action {errdisable | log}]

no power inline police

Command Default

Policing of the real-time power consumption of the powered device is disabled.

Command Modes

Interface configuration (config-if)

Usage Guidelines

This command is supported only on Power over Ethernet (PoE)-capable ports. If you enter this command on a device or port that does not support PoE, an error message appears.

In a switch stack, this command is supported on all switches or ports in the stack that support PoE and real-time power-consumption monitoring.

When policing of the real-time power consumption is enabled, the device takes action when a powered device consumes more power than the allocated maximum amount.

When PoE is enabled, the device senses the real-time power consumption of the powered device. This feature is called power monitoring or power sensing. The device also polices the power usage with the power policing feature.

When power policing is enabled, the device uses one of the these values as the cutoff power on the PoE port in this order:

1. The user-defined power level that limits the power allowed on the port when you enter the power inline auto max max-wattage or the power inline static max max-wattage interface configuration command

2. The device automatically sets the power usage of the device by using CDP power negotiation or by the IEEE classification and LLPD power negotiation.

If you do not manually configure the cutoff-power value, the device automatically determines it by using CDP power negotiation or the device IEEE classification and LLDP power negotiation. If CDP or LLDP are not enabled, the default value of 30 W is applied. However without CDP or LLDP, the device does not allow devices to consume more than 15.4 W of power because values from 15400 to 30000 mW are only allocated based on CDP or LLDP requests. If a powered device consumes more than 15.4 W without CDP or LLDP negotiation, the device might be in violation of the maximum current Imax limitation and might experience an Icut fault for drawing more current than the maximum. The port remains in the fault state for a time before attempting to power on again. If the port continuously draws more than 15.4W, the cycle repeats.

When a powered device connected to a PoE+ port restarts and sends a CDP or LLDP packet with a power TLV, the device locks to the power-negotiation protocol of that first packet and does not respond to power requests from the other protocol. For example, if the device is locked to CDP, it does not provide power to devices that send LLDP requests. If CDP is disabled after the device has locked on it, the device does not respond to LLDP power requests and can no longer power on any accessories. In this case, you should restart the powered device.

If power policing is enabled, the device polices power usage by comparing the real-time power consumption to the maximum power allocated on the PoE port. If the device uses more than the maximum power allocation (or cutoff power) on the port, the device either turns power off to the port, or the device generates a syslog message and updates the LEDs (the port LEDs are blinking amber) while still providing power to the device.

• To configure the device to turn off power to the port and put the port in the error-disabled state, use the power inline police interface configuration command.

• To configure the device to generate a syslog message while still providing power to the device, use the power inline police action log command.

If you do not enter the action log keywords, the default action is to shut down the port, turn off power to it, and put the port in the PoE error-disabled state. To configure the PoE port to automatically recover from the error-disabled state, use the errdisable detect cause inline-power global configuration command to enable error-disabled detection for the PoE cause and the errdisable recovery cause inline-power interval interval global configuration command to enable the recovery timer for the PoE error-disabled cause.

Caution

If policing is disabled, no action occurs when the powered device consumes more than the maximum power allocation on the port, which could adversely affect the device.

You can verify your settings by entering the show power inline police privileged EXEC command.

Examples

This example shows how to enable policing of the power consumption and configuring the device to generate a syslog message on the PoE port on a device:

Device(config)# interface gigabitethernet1/0/2Device(config-if)# power inline police action log

To configure and manage the internal power supplies on a switch, use the power supply command in privileged EXEC mode.

power supply stack-member-number slot {A | B} {off | on}

Command Default

The switch power supply is on.

Command Modes

Privileged EXEC

Usage Guidelines

The power supply command applies to a switch or to a switch stack where all switches are the same platform.

In a switch stack with the same platform switches, you must specify the stack member before entering the slot {A | B} off or on keywords.

To return to the default setting, use the power supply stack-member-number on command.

You can verify your settings by entering the show env power privileged EXEC command.

Examples

This example shows how to set the power supply in slot A to off:

Device> power supply 2 slot A offDisabling Power supply A may result in a power loss to PoE devices and/or switches ...Continue? (yes/[no]): yesDeviceJun 10 04:52:54.389: %PLATFORM_ENV-6-FRU_PS_OIR: FRU Power Supply 1 powered offJun 10 04:52:56.717: %PLATFORM_ENV-1-FAN_NOT_PRESENT: Fan is not present

This example shows how to set the power supply in slot A to on:

Device> power supply 1 slot B onJun 10 04:54:39.600: %PLATFORM_ENV-6-FRU_PS_OIR: FRU Power Supply 1 powered on

This example shows the output of the show env power command:

Device> show env powerSW PID Serial# Status Sys Pwr PoE Pwr Watts-- ------------------ ---------- --------------- ------- ------- -----1A PWR-1RUC2-640WAC DCB1705B05B OK Good Good 250/3901B Not Present

To enable automatic shutdown control on linecards, use the power supply autoLC shutdown command in global configuration mode. This command is enabled by default and cannot be disabled. The AutoLC shutdown cannot be disabled message will be displayed if you try to disable it.

power supply autoLC shutdown

no power supply autoLC shutdown

Syntax Description

This command has no arguments or keywords.

Command Default

Automatic shutdown control on linecards is enabled.

Command Modes

Global configuration (config)

Examples

This example shows how to enable automatic shutdown on linecards:

Device> enableDevice# configure terminalDevice(config)# power supply autoLC shutdown

To generate an archive of tech-support data and system report files in a report, use the request tech-support command in privileged EXEC mode. This report can be generated on demand and is intended to help with troubleshooting issues.

request tech-support

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Privileged EXEC (#)

Usage Guidelines

The request tech-support command generates an archive that is a combination of the tech support file and the system report files. The command displays the generated file path from where you can access the archive file. The tech support file is the output of the show tech-support command. The system report contains information that helps Cisco technical support representatives debug issues. The information is stored in separate files which are then archived and compressed into the tar.gz bundle

Examples

The following example shows the output of the request tech-support command:

Switch# request tech-support21:34:45.856 UTC Mon Oct 23 2023 : Collecting 'show tech-support'...21:35:36.563 UTC Mon Oct 23 2023 : 'show tech-support' collected successfully!21:35:37.986 UTC Mon Oct 23 2023 : Collecting binary traces...21:35:38.188 UTC Mon Oct 23 2023 : Binary traces collected successfully!21:35:38.192 UTC Mon Oct 23 2023 : Collecting platform-dependent files...21:35:38.289 UTC Mon Oct 23 2023 : Platform-dependent files collected successfully!21:35:38.294 UTC Mon Oct 23 2023 : Generating tech-support bundle...21:35:45.655 UTC Mon Oct 23 2023 : Tech-support bundle file crashinfo:Switch_1_RP_0- debug-bundle_1_20230630-030839-UTC.tar.gz [size: 24529 KB]21:35:45.655 UTC Mon Oct 23 2023 : Tech-support bundle generated successfully!

Related Commands

To create an event trigger, use the shell trigger command in global configuration mode. Use the no form of this command to delete the trigger.

shell trigger identifier description

no shell trigger identifier description

Command Default

System-defined event triggers:

• CISCO_DMP_EVENT

• CISCO_IPVSC_AUTO_EVENT

• CISCO_PHONE_EVENT

• CISCO_SWITCH_EVENT

• CISCO_ROUTER_EVENT

• CISCO_WIRELESS_AP_EVENT

• CISCO_WIRELESS_LIGHTWEIGHT_AP_EVENT

Command Modes

Global configuration (config)

Usage Guidelines

Use this command to create user-defined event triggers for use with the macro auto device and the macro auto execute commands.

To support dynamic device discovery when using IEEE 802.1x authentication, you need to configure the RADIUS authentication server to support the Cisco attribute-value pair: auto-smart-port =event trigger .

Examples

This example shows how to create a user-defined event trigger called RADIUS_MAB_EVENT:

Device(config)# shell trigger RADIUS_MAB_EVENT MAC_AuthBypass Event Device(config)# end 

To display the status of beacon LED on the device, use the show beacon all command in privileged EXEC mode.

show beacon { rp { active | standby} | slot slot-number } | all}

Command Default

This command has no default settings.

Command Modes

Privileged EXEC (#)

Usage Guidelines

Use the command show beacon all to know the status of all beacon LEDs.

Examples

Device#show beacon allSwitch# Beacon Status-----------------------*1 OFF

Examples

Device#show beacon rp activeSwitch# Beacon Status-----------------------*1 OFF

Examples

Device#show beacon slot 1Switch# Beacon Status-----------------------*1 OFF

To display the devices connected to a switch and their associated properties, use the show device classifier attached command in user EXEC mode.

show device classifier attached [detail | interface interface_id | mac-address mac_address]

Command Modes

User EXEC (>)

Privileged EXEC (#)

Usage Guidelines

Use this command to display the devices connected to a switch. Use the show device classifier attached command in privileged EXEC mode to display the configurable parameters for a device.

Examples

This example shows how to use the show device classifier attached command with no optional keywords to view the devices connected to the switch:

Device# show device classifier attachedMAC_Address Port_Id Profile Name============== ======= ============================000a.b8c6.1e07 Gi1/0/2 Cisco-Device001f.9e90.1250 Gi1/0/4 Cisco-AP-Aironet-1130======================================================

This example shows how to use the show device classifier attached command in privileged EXEC mode with the optional mac-address keyword to view summary information about the connected device with the specified MAC address:

Device# show device classifier attached mac-address 001f.9e90.1250MAC_Address Port_Id Profile Name============== ======= ============================001f.9e90.1250 Gi1/0/4 Cisco-AP-Aironet-1130==========================================================

This example shows how to use the show device classifier attached command in privileged EXEC mode with the optional mac-address and detail keywords to view detailed information about the connected device with the specified MAC address:

Device# show device classifier attached mac-address 001f.9e90.1250 detailMAC_Address Port_Id Certainty Parent ProfileType Profile Name Device_Name============== ======= ========= ====== =========== ============================ ===========001f.9e90.1250 Gi1/0/4 40 2 Built-in Cisco-AP-Aironet-1130 cisco AIR-LAP1131AG-E-K9=================================================================================================

This example shows how to use the show device classifier attached command in privileged EXEC mode with the optional interface keyword to view summary information about the device connected to the specified interface:

Device# show device classifier attached interface gi 1/0/2MAC_Address Port_Id Profile Name============== ======= ============================000a.b8c6.1e07 Gi1/0/2 Cisco-Device=====================================================

This example shows how to use the show device classifier attached command in privileged EXEC mode with the optional interface and detail keywords to view detailed information about the device connected to the specified interface:

Device# show device classifier attached interface gi 1/0/2 detailMAC_Address Port_Id Certainty Parent ProfileType Profile Name Device_Name============== ======= ========= ====== =========== ============================ ===========000a.b8c6.1e07 Gi1/0/2 10 0 Default Cisco-Device cisco WS-C2960-48TT-L=================================================================================================

To display the clients using the device classifier facility on the switch, use the show device classifier clients command in user EXEC mode.

show device classifier clients

Command Default

This command has no arguments or keywords.

Command Modes

User EXEC (>)

Privileged EXEC (#)

Usage Guidelines

Device classifier (DC) is enabled by default when you enable a client application (for example, Auto SmartPorts) that uses its functionality. Use the show device classifier clients command to display the clients that are using the DC feature on the switch.

As long as any clients are using the DC, you cannot disable it by using the no device classifier command. If you attempt to disable the DC while a client is using it, an error message appears.

Examples

This example shows how to use the show device classifier clients command to view the clients using the DC on the switch:

Device# show device classifier clientsClient Name====================Auto Smart PortsThis example shows the error message that appears when you attempt to disable DC while a client is using it:Switch(config)# no device classifierThese subsystems should be disabled before disabling Device classifierAuto Smart Ports% Error - device classifier is not disabled

To display all the device types recognized by the device classifier, use the show device classifier profile type command in user EXEC mode.

show device classifier profile type [table [built-in | default] | string filter_string]