A Commands
Download this chapter
A CommandsA Commands
 Feedback

Table Of Contents

A Commands

abort (Call home)

abort (Session Manager)

action cli

action counter

action event-default

action exceptionlog

action forceshut

action overbudgetshut

action policy-default

action reload

action snmp-trap

action syslog

alert-group


A Commands

This chapter describes the Cisco NX-OS system management commands that begin with the letter A.

abort (Call home)

To delete a Call home Cisco Fabric Services (CFS) configuration session without applying the configuration, use the abort command.

abort

Syntax Description

This command has no arguments or keywords.

Defaults

None

Command Modes

Call home configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.1(2)

This command was introduced.


Usage Guidelines

The abort command is supported only on the device where the CFS fabric lock is acquired.

This command does not require a license.

Examples

This example shows how to abort a Call home CFS configuration session: 

switch(config-callhome)# abort

switch(config-callhome)# show callhome session status

Last Action Time Stamp     : Mon Dec 22 17:34:37 2008

Last Action                : Abort

Last Action Result         : Success

Last Action Failure Reason : none

Related Commands

Command
Description

show session status

Displays the status of the current CFS configuration session, including the last action and its result.

callhome

Enters the Call home configuration mode.

callhome distribute

Enables CFS distribution of the Call home configuration.


abort (Session Manager)

To delete a Session Manager configuration session without applying the configuration, use the abort command.

abort

Syntax Description

This command has no arguments or keywords.

Defaults

None

Command Modes

Session configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to abort a Session Manager configuration session and show the aborted session: 

switch(config-s-acl)# abort

switch# show configuration session ACL_permit_tcp

ERROR: Session not found

switch# show configuration session summary

There are no active configuration sessions

Related Commands

Command
Description

show configuration session

Displays the status of the current CFS configuration session, including the last action and its result.

show configuration session summary

Displays a summary of the configuration session.


action cli

To configure a virtual shell (VSH) command string to be executed when an Embedded Event Manager (EEM) applet is triggered, use the action cli command. To disable the VSH command string, use the no form of this command.

action label cli [local] vsh_cmd

no action label cli

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.

local

(Optional) Specifies the action is to be executed in the same module on which the event occurs.

vsh_cmd

VSH command string to be executed when the applet is triggered.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to configure a VSH command string to be executed when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet cli-applet 

switch(config-applet)# action 1.1 cli callhome send eem subject "port down" body "acme 
port is down" 

switch(config-applet)#

Related Commands

Command
Description

event manager applet

Registers an applet with the Embedded Event Manager (EEM).


action counter

To set or modify a named counter when an Embedded Event Manager (EEM) applet is triggered, use the action counter command. To restore the default value to the counter, use the no form of this command.

action label counter name name value value op {dec | inc | nop | set}

no action label counter name name

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.

name name

Specifies the name of the counter. This identifier can be any string value.

value value

Specifies the value of the counter. This identifier must be an integer value in the range from -2147483648 to 2147483647 inclusive, or a $-prefixed name (for parameter substitution).

op

Specifies the operation to perform upon the counter.

dec

Decrements the counter by the specified value.

inc

Increments the counter by the specified value.

nop

Does nothing, using this keyword just displays the specified value.

set

Sets the counter to the specified value.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to set the counter count1 to the value in $variable when the EEM counter-applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet counter-applet 

switch(config-applet)# action 1.2 counter name count1 value $variable op dec 

switch(config-applet)#

action event-default

To specify that the default action for the event is to be performed when an Embedded Event Manager (EEM) applet is triggered, use the action event-default command. To disable the default action, use the no form of this command.

action label event-default

no action label event-default

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

If you want to allow the triggered event to process any default actions, you must configure the EEM policy to allow the default action. For example, if you match a CLI command in a match statement, you must add the event-default statement to the EEM policy or EEM does l not allow the CLI command to execute. You can use the terminal event-manager bypass command to allow all EEM policies with CLI matches to execute the CLI command.

This command does not require a license.

Examples

This example shows how to specify that the default action for the event is to be performed when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet default-applet 

switch(config-applet)# action 1.15 event-default 

switch(config-applet)#

action exceptionlog

To log an exception if the specific conditions are encountered when an Embedded Event Manager (EEM) applet is triggered, use the action exceptionlog command. To remove the exception log, use the no form of this command.

action label exceptionlog module module syserr error devid id errtype type errcode code phylayer layer ports list harderror error [desc string]

no action label exceptionlog module module syserr error devid id errtype type errcode code phylayer layer ports list harderror error [desc string]

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.

module module

Records an exception for the specified module number.

syserr error

Records an exception for the specified system error.

devid id

Records an exception for the specified device ID.

errtype type

Records an exception for the specified error type.

errcode code

Records an exception for the specified error code.

phylayer layer

Records an exception for the specified physical layer.

ports list

Records an exception for the specified ports.

harderror error

Records an exception for the specified hard error.

desc string

(Optional) Specifies a description of the exception logging condition.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to log an EEM applet exception: 

switch# configure terminal 

switch(config)# event manager applet exception-applet 

switch(config-applet)# action 1.2 exceptionlog module 1 syserr 0x41150010 devid 96 errtype 
2 errcode 354 phylayer 0 ports 1-24 harderror false desc "r2d2 general error" 

switch(config-applet)#

action forceshut

To configure a forced shutdown of a module, a crossbar ASIC, or the entire switch when an Embedded Event Manager (EEM) applet is triggered, use the action forceshut command. To remove the forced shutdown, use the no form of this command.

action label forceshut [{module module | xbar xbar-number}] reset-reason string

no action label forceshut [{module module | xbar xbar-number}] reset-reason string

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.

module module

(Optional) Forces a shutdown of the specified module. The module range is from 1 to 10.

xbar xbar-number

(Optional) Forces a shutdown of the specified crossbar ASIC. The ASIC range is from 1 to 5.

reset-reason string

Provides a string that is enclosed in double quotation marks to explain the reason for a forced shutdown.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to configure a forced shutdown of module 4 when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet forceshut-applet 

switch(config-applet)# action 1.3 forceshut module 4 reset-reason "module 4 failed" 

switch(config-applet)#

action overbudgetshut

To configure the shutdown of a module or the entire switch due to an overbudget power condition when an Embedded Event Manager (EEM) applet is triggered, use the action overbudgetshut command. To remove the shutdown configuration, use the no form of this command.

action label overbudgetshut [module module]

no action label overbudgetshut [module module]

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.

module module

(Optional) Forces a shutdown of the specified module. The module range is from 1 to 10.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to configure a power overbudget shutdown of module 4 when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet overbudget-applet 

switch(config-applet)# action 1.4 overbudgetshut module 4 

switch(config-applet)#

action policy-default

To enable the default action(s) of the policy being overridden, use the action policy-default command. To remove the default action, use the no form of this command.

action label policy-default

no action label policy-default

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to enable the default action of a policy being overridden when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet default-applet 

switch(config-applet)# action 1.65 policy-default 

switch(config-applet)#

action reload

To specify the action of reloading the switch software when an Embedded Event Manager (EEM) applet is triggered, use the action reload command. To remove the action of reloading the switch software, use the no form of this command.

action label reload

no action label reload

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to specify the action of reloading the switch software when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet reload-applet 

switch(config-applet)# action 1.5 reload 

switch(config-applet)#

action snmp-trap

To specify the generation of a Simple Network Management Protocol (SNMP) trap when an Embedded Event Manager (EEM) applet is triggered, use the action snmp-trap command. To disable the SNMP trap, use the no form of this command.

action label snmp-trap [intdata1 integer] [intdata2 integer] [strdata string]

no action label snmp-trap [intdata1 integer] [intdata2 integer] [strdata string]

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.

intdata1 integer

(Optional) Specifies an integer to be sent in the SNMP trap message to the SNMP agent.

intdata2 integer

(Optional) Specifies a second integer to be sent in the SNMP trap message to the SNMP agent.

strdata string

(Optional) Specifies a string to be sent in the SNMP trap message to the SNMP agent. If the string contains embedded blanks, enclose it in double quotation marks.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to specify an SNMP trap to generate when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet snmp-applet 

switch(config-applet)# action 1.7 snmp-trap strdata "EEM detected server failure" 

switch(config-applet)#

action syslog

To configure a syslog message to generate when an Embedded Event Manager (EEM) applet is triggered, use the action syslog command. To disable the syslog message, use the no form of this command.

action label syslog [priority {prio | prio-str}] msg msg-text

no action label syslog [priority {prio | prio-str}] msg msg-text

Syntax Description

label

Unique identifier that can be any string value. Actions are sorted and run in an ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.

priority

(Optional) Specifies the priority level of the syslog messages. If this keyword is not selected, all syslog messages are set at the informational priority level. If this keyword is selected, the priority level argument must be defined.

prio

Priority level:

•emergencies—Specifies the system is unusable.

•alerts—Specifies immediate action is needed.

•critical—Specifies critical conditions.

•errors—Specifies error conditions.

•warnings— Specifies warning conditions.

•notifications—Specifies normal but significant conditions.

•informational—Specifies informational messages. This is the default.

•debugging—Specifies debugging messages.

prio-str

A $-prefixed parameter that you previously set to a priority level.

msg msg-text

Specifies the message to be logged. The msg-text can contain character text, an environment variable, or a combination of the two. If the string contains embedded blanks, enclose it in double quotation marks.


Defaults

None

Command Modes

Embedded event manager

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

Messages written to syslog from an EEM applet are not screened for EEM syslog events, which may lead to recursive EEM syslog events. Messages that are sent from an EEM applet include the applet name for identification.

This command does not require a license.

Examples

This example shows how to configure a syslog message to save when an EEM applet is triggered: 

switch# configure terminal 

switch(config)# event manager applet syslog-applet 

switch(config-applet)# action 1.7 syslog priority critical msg "Syslog condition: $log" 

switch(config-applet)#

alert-group

To configure a Call home CLI command for an alert group, use the alert-group command. To remove the command from the alert group, use the no form of this command.

alert-group {All | Configuration | Diagnostic | EEM |Environmental | Inventory | License | Linecard-Hardware | Supervisor-Hardware | Syslog-group-port | System | Test} user-def-cmd cli_command

no alert-group {All | Configuration | Diagnostic | Environmental | Inventory | License | Linecard-Hardware | Supervisor-Hardware | Syslog-group-port | System | Test} user-def-cmd cli_command

Syntax Description

All

Specifies all alert groups—configuration, diagnostic, EEM, environmental, inventory, license, linecard-hardware, supervisor-hardware, syslog-group-port, system, and test.

Configuration

Specifies events related to configurations.

Diagnostic

Specifies events related to diagnostics.

EEM

Specifies events related to EEM.

Environmental

Specifies events related to power,fan,temperature related events.

Inventory

Specifies events related to the inventory status.

License

Specifies events related to license.

Linecard-
Hardware

Specifies events related to line card hardware.

Supervisor-
Hardware

Specifies events related to the supervisor module.

Syslog-group-port

Specifies events related to syslog messages filed by port manager.

System

Specifies events related to software.

Test

Specifies events related to tests.

user-def-cmd cli_command

Configures a valid CLI command for the alert group.


Defaults

None

Command Modes

Call home configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0(1)

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to add the show ip routing command to the configuration alert group:

switch# config t

switch(config)# callhome

switch(config-callhome)# alert-group Configuration user-def-cmd "show ip routing"


Related Commands

Command
Description

callhome

Enters the Call home configuration mode.

callhome distribute

Enables CFS distribution of the Call home configuration.

show callhome destination-profile name

Displays one or more Call home destination profiles.