Table Of Contents

A Commands

abort

action cli

action counter

action event-default

action exceptionlog

action forceshut

action overbudgetshut

action policy-default

action reload

action snmp-trap

action syslog

A Commands

---

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

abort

To delete the configuration session without applying the commands, 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 delete a session:

switch(config-s)# abort

switch#

Related Commands

Command	Description
show configuration session	Displays the information about the configuration sessions.

action cli

Use the action cli command to configure a VSH command string to be executed when an Embedded Event Manager (EEM) applet is triggered.

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 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	Specifies the VSH command string to be executed when the enclosing applet is triggered.

Defaults

None

Command Modes

Embedded Event Manager

Supported User Roles

Super user
VDC administrator
VDC user

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

action counter

Use the action counter command to specify setting or modifying a named counter when an Embedded Event Manager (EEM) applet is triggered. This command is used in applet configuration mode.

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 ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.
name name	The name of the counter. This identifier can be any string value.
value value	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 {dec | inc | nop | set}	The operation to perform upon the counter. •dec—decrement the counter by the specified value. •inc—increment the counter by the specified value. •nop—do nothing, just print the specified value. •set—set the counter to the specified value.

Defaults

None

Command Modes

Embedded Event Manager

Supported User Roles

Super user
VDC administrator
VDC user

Command History

Release	Modification
4.0(1)	This command was introduced.

Usage Guidelines

This command does not require a license.

Examples

This example shows setting 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

Use the action event-default command to specify that the default action for the event is to be performed when an Embedded Event Manager (EEM) applet is triggered.

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 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

Super user
VDC administrator
VDC user

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 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

Use the action exceptionlog command to log an exception if the specific conditions are encountered when an Embedded Event Manager (EEM) applet is triggered.

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 ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.
module module	Record an exception for the specified module. Enter a module word.
syserr error	Record an exception for the specified system error. Enter an error word.
devid id	Record an exception for the specified device ID. Enter an id word.
errtype type	Record an exception for the specified error type. Enter a type word.
errcode code	Record an exception for the specified error code. Enter a code word.
phylayer layer	Record an exception for the specified physical layer. Enter a layer word.
ports list	Record an exception for the specified ports. Enter a list word.
harderror error	Record an exception for the specified hard error. Enter an error word.
desc string	(Optional) A description of the exception logging condition.

Defaults

None

Command Modes

Embedded Event Manager

Supported User Roles

Super user
VDC administrator
VDC user

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

Use the action forceshut command to configure a forced shutdown of a module, a Crossbar ASIC, or the entire switch when an Embedded Event Manager (EEM) applet is triggered.

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 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) Force a shutdown of the specified module. Select a module between 1 and 10.
xbar xbar-number	(Optional) Force a shutdown of the specified Crossbar ASIC. Select an ASIC between 1 and 5.
reset-reason string	Provide string enclosed in double quotation marks to explain the reason for a forced shutdown.

Defaults

None

Command Modes

Embedded Event Manager

Supported User Roles

Super user
VDC administrator
VDC user

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

Use the action overbudgetshut command to configure the shutdown of a module or the entire switch due to over budget power condition when an Embedded Event Manager (EEM) applet is triggered.

action label overbudgetshut [module module]

Syntax Description

label	Unique identifier that can be any string value. Actions are sorted and run in 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) Force a shutdown of the specified module. Select a module between 1 and 10.

Defaults

None

Command Modes

Embedded Event Manager

Supported User Roles

Super user
VDC administrator
VDC user

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 over budget 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

Use the action policy-default command to enable the default action(s) of the policy being overridden.

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 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

Super user
VDC administrator
VDC user

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

Use the action reload command to specify the action of reloading the switch software when an Embedded Event Manager (EEM) applet is triggered.

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 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

Super user
VDC administrator
VDC user

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

Use the action snmp-trap command to specify the generation of a Simple Network Management Protocol (SNMP) trap when an Embedded Event Manager (EEM) applet is triggered.

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 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

Super user
VDC administrator
VDC user

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

Use the action syslog command to configure a syslog message to generate when an Embedded Event Manager (EEM) applet is triggered.

To disable the syslog message, use the no form of this command.

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

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

Syntax Description

label	Unique identifier that can be any string value. Actions are sorted and run in ascending alphanumeric sequence using the label as the sort key. If the string contains embedded blanks, enclose it in double quotation marks.
priority {prio | prio-num | prio-str}	(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. There are three ways of defining the priority level: 1. Enter the priority by selecting a number from 0 to 7: –0—System is unusable. –1—Immediate action is needed. –2—Critical conditions. –3—Error conditions. –4—Warning conditions. –5—Normal but significant conditions. –6—Informational messages. This is the default. –7—Debugging messages. 2. Enter the priority by selecting one of the priority keywords: –emergencies—System is unusable. –alerts—Immediate action is needed. –critical—Critical conditions. –errors—Error conditions. –warnings—Warning conditions. –notifications—Normal but significant conditions. –informational—Informational messages. This is the default. –debugging—Debugging messages. 3. Enter a priority string.
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. Note Messages written to syslog from an EEM applet are not screened for EEM syslog events, which may lead to recursive EEM syslog events. Messages sent from an EEM applet include the applet name for identification.

Defaults

None

Command Modes

Embedded Event Manager

Supported User Roles

Super user
VDC administrator
VDC user

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 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)#