Cisco MDS 9000 Family Command Reference, Release 5.2(8)

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Cisco MDS 9000 Family Command Reference, Release 5.2(8)

Chapter Title

E Commands

PDF - Complete Book (12.17 MB) PDF - This Chapter (425.0 KB)
View with Adobe Reader on a variety of devices

Results

Updated:: January 31, 2018

Chapter: E Commands

E Commands

The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric switches. All commands are shown here in alphabetical order regardless of command mode. See “About the CLI Command Modes” section to determine the appropriate mode for each command.

egress-sa

To configure the Security Association (SA) to the egress hardware, use the engress-sa command. To delete the SA from the egress hardware, use the no form of the command.

engress-sa spi-number

no engress-sa spi-number

Syntax Description

spi-number

The range is from 256 to 4294967295.

Defaults

None.

Command Modes

Configuration submode.

Command History

Release	Modification
NX-OS 4.2(1)	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to configure the SA to the egress hardware:

switch# config terminal

Enter configuration commands, one per line. End with CNTL/Z.

switch(config)# interface fc 2/1 - 3

switch(config-if)# fcsp esp manual

switch(config-if-esp)# egress-sa 258

switch(config-if-esp)#

Related Commands

Command	Description
show fcsp interface	Displays FC-SP-related information for a specific interface.

email-contact

To configure an e-mail contact with the Call Home function, use the email-addr command in Call Home configuration submode. To disable this feature, use the no form of the command.

email-addr email-address

no email-addr email-address

Syntax Description

email-address

Configures an e-mail address. Uses a standard e-mail address that does not have any text size restrictions.

Defaults

None.

Command Modes

Call Home configuration submode.

Command History

Release	Modification
1.0(2)	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to configure e-mail contact in the Call Home configuration:

switch# config terminal

Enter configuration commands, one per line. End with CNTL/Z.

switch(config)# callhome

switch(config-callhome)# email-contact username@company.com

Related Commands

Command	Description
callhome	Configures the Call Home function.
callhome test	Sends a dummy test message to the configured destination(s).
show callhome	Displays configured Call Home information.

enable

To turn on the privileged commands, use the enable command. To disable this feature, use the disable command.

enable privilege-level

Syntax Description

privilege-level

Specifies privilege level. Default value is 15.

Defaults

Enabled.

Command Modes

EXEC mode.

Command History

Release	Modification
NX-OS 5.0(1a)	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to turn on the privileged commands:

switch# enable 15

switch#

Related Commands

Command	Description
enable secret	Displays the secret for privilege escalation.

enable (Call Home configuration submode)

To enable the Call Home function, use the enable command in Call Home configuration submode. To disable this feature, use the disable command.

enable

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

Call Home configuration submode.

Command History

Release	Modification
1.0(2)	This command was introduced.

Usage Guidelines

To disable the Call Home function, use the disable command:

Examples

The following example shows how to enable the Call Home function.

switch# config terminal

Enter configuration commands, one per line. End with CNTL/Z.

switch(config)# callhome

switch(config-callhome)# enable

Related Commands

Command	Description
callhome	Configures the Call Home function.
callhome test	Sends a dummy test message to the configured destination(s).
show callhome	Displays configured Call Home information.

enable user-server-group

To enable or disable group validation, use the enable user-server-group command. To disable this feature, use the no form of the command.

enable user-server-group

no enable user-server-group

Syntax Description-

This command has no arguments or keywords.

Defaults

None.

Command Modes

Configuration submode.

Command History

Release	Modification
NX-OS 5.0	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to enable group validation:

switch(config-ldap)# enable user-server-group

switch(config-ldap)#

Related Commands

Command	Description
show ldap-server groups	Displays the configured LDAP server groups.

enable secret

To create secret for privilege escalation, use the enable secret command. To disable this feature, use the no form of the command.

enable secret {0 | 5} [password priv-lvl privilege-level]

no enable secret {0 | 5} [password priv-lvl privilege-level]

Syntax Description

0	Specifies that the secret that follows should be in clear text.
5	Specifies that the secret that follows should be encrypted.
password	(Optional) Specifies that the secret for user privilege escalation.
priv-lvl	(Optional) Specifies the privilege level to which the secret belongs.
privilege-level	(Optional) Specifies the privilege level. Default value is 15.

Defaults

Enabled.

Command Modes

Configuration mode.

Command History

Release	Modification
NX-OS 5.0(1a)	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to specifiy the secret that follows should be in clear text:

switch(config)# enable secret 0 admin priv-lvl 4

switch(config)#

The following example shows how to specify the secret that follows should be encrypted:

switch(config)# enable secret 5 admin priv-lvl 4

switch(config)#

Related Commands

Command	Description
show fcip	Displays FCIP information.

enable cert-DN-match

To enable or disable cert DN matching, use the enable cert-DN-match command. To disable this feature, use the no form of the command.

enable cert-DN-match

no enable cert-DN-match

Syntax Description-

This command has no arguments or keywords.

Defaults

None.

Command Modes

Configuration submode.

Command History

Release	Modification
NX-OS 5.0(1a)	This command was introduced.

Usage Guidelines

If Cert-DN match is configured, user will be allowed to login only if the user profile lists the subject-DN of the usercertificate as authorized for logging in.

Examples

The following example shows how to enable cert DN match:

switch(config-ldap)# enable cert-dn-match

switch(config-ldap)#

Related Commands

Command	Description
show ldap-server groups	Displays the configured LDAP server groups.

encryption

To configure an encryption algorithm for an IKE protocol policy, use the encryption command. To revert to the default, use the no form of the command.

encryption { 3des | aes | des }

no encryption

Syntax Description

3des	Specifies 168-bit DES (3DES).
aes	Specifies 128-bit AES-CBC.
des	Specifies 56-bit DES-CBS.

Defaults

3des

Command Modes

IKE policy configuration submode.

Command History

Release	Modification
2.0(x)	This command was introduced.

Usage Guidelines

To use this command, the IKE protocol must be enabled using the crypto ike enable command.

Examples

The following example shows how to configure the encryption algorithm for the IKE protocol:

switch# config terminal

switch(config)# crypto ike domain ipsec

switch(config-ike-ipsec)# policy 1

switch(config-ike-ipsec-policy)# encryption 3des

Related Commands

Command	Description
crypto ike domain ipsec	Enters IKE configuration mode.
crypto ike enable	Enables the IKE protocol.
policy	Configures IKE policy parameters.
show crypto ike domain ipsec	Displays IKE information for the IPsec domain.

end

To exit any of the configuration modes and return to EXEC mode, use the end command in configuration mode.

end

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

Configuration mode.

Command History

Release	Modification
4.1(1b)	Modified the command output.
1.0(2)	This command was introduced.

Usage Guidelines

You can also press Ctrl-Z to exit configuration mode.

Examples

The following example shows how to exit from configure mode:

switch(config-port-monitor)# end

switch#

The following example changes the name to george. Entering the end command causes the system to exit configuration mode and return to EXEC mode.

switch(config)# hostname george

george(config)# end

switch#

Related Commands

Command	Description
exit	Exits configuration mode, or any of the configuration modes.

enrollment terminal

To enable manual cut-and-paste certificate enrollment through the switch console, use the enrollment terminal command in trust point configuration submode. To revert to the default certificate enrollment process, use the no form of the command.

enrollment terminal

no enrollment terminal

Syntax Description

This command has no arguments or keywords.

Defaults

The default enrollment method is manual cut-and-paste, which is the only enrollment method that the MDS switch currently supports.

Command Modes

Trust point configuration submode.

Command History

Release	Modification
3.0(1)	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to configure trust point enrollment through the switch console:

switch# config terminal

switch(config)# crypto ca trustpoint admin-ca

switch(config-trustpoint)# enrollment terminal

The following example shows how to discard a trust point enrollment through the switch console:

switch(config)# crypto ca trustpoint admin-ca

switch(config-trustpoint)# no enrollment terminal

Related Commands

Command	Description
crypto ca authenticate	Authenticates the certificate of the certificate authority.

errdisable detect cause link-down

To error-disable and bring down a port on a link failure, use the errdisable detect cause link-down command. To disable this feature, use the no form of the command.

errdisable detect cause link-down num-times {flaps number} duration{sec}

no errdisable detect cause link-down num-times {flaps number} duration{sec}

Syntax Description

num-times	Specifies the flap number.
flaps number	Specifies the number of flaps. The range is from 1 to 1023.
duration	Specifies the time in seconds.
sec	The range is from 1 to 2000000.

Defaults

None.

Command Modes

Interface Configuration mode.

Command History

Release	Modification
NX-OS 4.1(3)	This command was introduced.

Usage Guidelines

The port guard feature is used in the environments where the system and application does not adapt quickly and efficiently to a port going down and back up or to a port rapidly cycling up and down which can happen in some failure modes. For example, if the port is going up and down once a second, and the system takes five seconds to stabilize after the port goes down, this situation might cause a more severe failure in the fabric.

The port guard feature gives the SAN administrator the ability to prevent this issue from occuring in environments that are vulnerable to these problems. The port can be configured to stay down after the first failure, or after a specified number of failures in a specified time period. This allows the SAN administartaion to intervene and control the recovery and avoiding any problems caused by the cycling.

Examples

The following example shows how to configure the port as down when the link flaps once:

Switch# configure terminal

Switch (config)# interface fc1/1

Switch (config-if)# errdisable detect cause link-down

The following example shows how to configure the port as down when the link flaps 5 times in 30 seconds:

Switch# configure terminal

Switch (config)# interface fc1/1

Switch (config-if)# errdisable detect cause link-down num-times 5 duration 30

The following example shows how to remove the port guard feature on the interface:

Switch# config t

Switch (config)# interface fc1/1

Switch (config-if)# no errdisable detect cause link-down

switch(config)#

Related Commands

Command	Description
device-alias commit	Commits changes to the active device alias database.
device-alias database	Configures and activates the device alias database.
show device-alias	Displays device alias information.

errdisable detect cause bit-errors

To enable error-disable detection on bit errors, use the errdisable detect cause bit-errors command. To disable this feature, use the no form of the command.

errdisable detect cause bit-errors num-times {flaps number} duration {sec}

no errdisable detect cause bit-errors num-times {flaps number} duration {sec}

Syntax Description

num-times	Specifies the number of flaps.
flaps number	Specifies the number of flaps. The range is from 1 to 1023.
duration	Specifies the time in seconds.
sec	The range is from 1 to 2000000.

Defaults

None.

Command Modes

Interface Configuration mode.

Command History

Release	Modification
NX-OS 4.2(1)	This command was introduced.

Usage Guidelines

Examples

The following example shows how to enable error-disable detection on bit errors:

Switch# configure terminal

Switch (config)# interface fc1/1

Switch (config-if)# errdisable detect cause bit-errors num-times 5 duration 30

Switch (config-if)#

Related Commands

Command	Description
device-alias commit	Commits changes to the active device alias database.
device-alias database	Configures and activates the device alias database.
show device-alias	Displays device alias information.

errdisable detect cause credit-loss

To enable error-disable detection on a credit loss, use the errdisable detect cause credit-loss command. To disable this feature, use the no form of the command.

errdisable detect cause credit-loss num-times {flaps number} duration {sec}

no errdisable detect cause credit-loss num-times {flaps number} duration {sec}

Syntax Description

num-times	Specifies the flap number.
flaps number	Specifies the number of flaps. The range is from 1 to 1023.
duration	Specifies the time in seconds.
sec	The range is from 1 to 2000000.

Defaults

None.

Command Modes

Interface Configuration mode.

Command History

Release	Modification
NX-OS 4.2(1)	This command was introduced.

Usage Guidelines

Examples

The following example shows how to enable error-disable detection on a credit loss:

Switch# configure terminal

Switch (config)# interface fc1/1

Switch (config-if)# errdisable detect cause credit-loss num-times 5 duration 30

Switch (config-if)#

Related Commands

Command	Description
device-alias commit	Commits changes to the active device alias database.
device-alias database	Configures and activates the device alias database.
show device-alias	Displays device alias information.

errdisable detect cause link-reset

To enable error-disable detection on a link reset, use the errdisable detect cause link-reset command. To disable this feature, use the no form of the command.

errdisable detect cause link-reset num-times {number} duration {sec}

no errdisable detect cause link-reset num-times {number} duration {sec}

Syntax Description

num-times	Specifies the flap number.
flaps number	Specifies the number of flaps. The range is from 1 to 1023.
duration	Specifies the time in seconds.
sec	The range is from 1 to 2000000.

Defaults

None.

Command Modes

Interface Configuration mode.

Command History

Release	Modification
NX-OS 4.2(1)	This command was introduced.

Usage Guidelines

Examples

The following example shows how to enable error-disable detection on a link reset:

Switch# configure terminal

Switch (config)# interface fc1/1

Switch (config-if)# errdisable detect cause link-reset num-times 5 duration 30

Switch (config-if)#

Related Commands

Command	Description
device-alias commit	Commits changes to the active device alias database.
device-alias database	Configures and activates the device alias database.
show device-alias	Displays device alias information.

errdisable detect cause signal-loss

To enable error-disable detection on a signal loss, use the errdiable detect cause signal-loss command. To disable this feature, use the no form of the command.

errdisable detect cause signal-loss num-times {number} duration {sec}]

no errdisable detect cause signal-loss num-times {number} duration {sec}]

Syntax Description

num-times	Specifies the flap number.
flaps number	Specifies the number of flaps. The range is from 1 to 1023.
duration	Specifies the time in seconds.
sec	The range is from 1 to 2000000.

Defaults

None.

Command Modes

Interface Configuration mode.

Command History

Release	Modification
NX-OS 4.2(1)	This command was introduced.

Usage Guidelines

Examples

The following example shows how to enable error-disable on a signal loss:

Switch# configure terminal

Switch (config)# interface fc1/1

Switch (config-if)# errdisable detect cause signal-loss num-times 5 duration 30

Switch (config-if)#

Related Commands

Command	Description
device-alias commit	Commits changes to the active device alias database.
device-alias database	Configures and activates the device alias database.
show device-alias	Displays device alias information.

errdisable detect cause sync-loss

To enable error-disable detection on a sync loss, use the errdisable detect cause sync-loss command. To disable this feature, use the no form of the command.

errdisable detect cause sync-loss num-times {number} duration {sec}

no errdisable detect cause sync-loss num-times {number} duration {sec}

Syntax Description

num-times	Specifies the flap number.
flaps number	Specifies the number of flaps. The range is from 1 to 1023.
duration	Specifies the time in seconds.
sec	The range is from 1 to 2000000.

Defaults

None.

Command Modes

Interface Configuration mode.

Command History

Release	Modification
NX-OS 4.2(1)	This command was introduced.

Usage Guidelines

Examples

The following example shows how to enable error-disable detection on a syncronised loss:

Switch# configure terminal

Switch (config)# interface fc1/1

Switch (config-if)# errdisable detect cause sync-loss num-times 5 duration 30

Switch (config-if)#

Related Commands

Command	Description
device-alias commit	Commits changes to the active device alias database.
device-alias database	Configures and activates the device alias database.
show device-alias	Displays device alias information.

errdisable detect cause trustsec-violation

To enable error-disable detection on a trustsec violation, use the errdisable detect cause trustsec-violation command. To disable this feature, use the no form of the command.

errdisable detect cause trustsec-violation num-times {number} duration {sec}

no errdisable detect cause trustsec-violation num-times {number} duration {sec}

Syntax Description

num-times	Specifies the flap number.
flaps number	Specifies the number of flaps. The range is from 1 to 1023.
duration	Specifies the time in seconds.
sec	The range is from 1 to 2000000.

Defaults

None.

Command Modes

Configuration mode.

Command History

Release	Modification
NX-OS 4.2(1)	This command was introduced.

Usage Guidelines

Examples

The following example shows how to enable error-disable detection on a trustsec violation:

switch#(config-if)# errdisable detect cause trustsec-violation num-times 1 duration 1

switch#(config-if)#

Related Commands

Command	Description
device-alias commit	Commits changes to the active device alias database.
device-alias database	Configures and activates the device alias database.
show device-alias	Displays device alias information.

event cli

To configure a CLI command as an EEM applet trigger, use the event cli command. To delete the applet trigger, use the no form of the command.

event cli match expression [ count countnum [ time seconds ]]

no event cli match expression [ count countnum [ time seconds ]]

Syntax Description

match expression	Specifies the regular expression (regexp) used to match the CLI command. The command must have been successfully parsed before a match is attempted. The expression is compared to the fully expanded command and must match exactly, not just part of the command. When the expression contains embedded spaces enclose it in double quotes.
count countnum	(Optional) Specifies the number of matching occurrences before an Embedded Event Manager event is triggered. When a number is not specified, an Embedded Event Manager event is triggered after the first match. This number must be an integer greater than 0.
time seconds	(Optional) Specifies the time interval during which one or more occurrences must take place. When the keyword is not specified, no time period check is applied.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

A cli event trigger allows control over CLI commands. By default, the triggering command is not executed. This allows an applet to take action before or after a command runs, or even prevent it from running. To run the triggering command, configure an event-default action at the stage in the applet where the command should run.

Examples

The following example shows how to match the shutdown command as an applet trigger:

switch# configure terminal

switch(config)# event manager applet blockShutdownCmd

switch(config-applet)# event cli match “shutdown”

switch(config-applet)# end

The following example shows how to use spaces and regular expressions. Action 10 logs a syslog message and action 20 allows the matching command to complete normally.

switch# configure terminal

switch(config)# event manager applet fcanalyserCheck

switch(config-applet)# event cli match "fcanalyzer * mgmt*"

switch(config-applet)# action 10 syslog priority emergencies msg fcanalyser command used for mgmt interface

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

switch(config-applet)# end

Related Commands

Command	Description
action	Configure EEM applet actions.
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event counter

To configure a counter as an EEM applet trigger, use the event counter command. To delete the applet trigger, use the no form of the command.

event counter name name entry-val value entry-op operator [ exit-val value exit-op operator ]

no event counter name name entry-val value entry-op operator [ exit-val value exit-op operator ]

Syntax Description

name name	Configures the name of the counter to monitor. name can be any string value of 1 to 28 characters.
entry-val value	Configures a value to compare the named counter against.The event resets immediately unless an exit-val is specified. value is an integer in the range from 0 to 2147483647.
entry-op operator	Specifies how to compare the current value of the named counter with the specified value. The operator can be one of the following: eq — Equal to ge — Greater than or equal to gt — Greater than le — Less than or equal to lt — Less than ne — Not equal to
exit-val value	(Optional) Configures a value that the named counter must reach before resetting the event. value is an integer in the range from 0 to 2147483647.
exit-op operator	(Optional) Specifies how to compare the current value of the named counter with the specified value. The operator can be one of the following: eq — Equal to ge — Greater than or equal to gt — Greater than le — Less than or equal to lt — Less than ne — Not equal to

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to trigger an EEM applet when a counter named 'test' has a value of 0:

switch# configure terminal

switch#(config)# event manager applet testCtrIsZero

switch#(config-applet)# event counter name test entry-val 0 entry-op eq

switch#(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event fanabsent

To configure a fan absence as an EEM applet trigger, use the event fanabsent command. To delete the applet trigger, use the no form of the command.

fanabsent [ fan fannumber ] time seconds

no fanabsent [ fan fannumber ] time seconds

Syntax Description

fan fannumber	(Optional) Configures a chassis fan. fannumber range is platform specific.
time seconds	Configures a time period. seconds range is 10 to 64000.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

This event specification monitors if a fan is removed from the chassis for a particular period of time. Embedded Event Manager takes an action based on the actions configured on the applet.

Examples

This example shows how to configure a an EEM applet to trigger after a fan absence of 300 seconds (5 minutes):

switch# configure terminal

switch#(config)# event manager applet fanGoneForFiveMins

switch#(config-applet)# event fanabsent fan 300

switch(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event fanbad

To configure fanbad event specification, use the event fanbad command. To remove the fanbad event, use the no form of the command.

event fanbad [ fan fannumber ] time seconds

no event fanbad [ fan fannumber ] time seconds

Syntax Description

fan fannumber	(Optional) Configures a chassis fan. fannumber range is platform specific.
time seconds	Configures a time period. seconds range is 10 to 64000.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

This event specification monitors for the failure of any chassis cooling fan and Embedded Event Manager takes an action based on the actions configured on the applet.

Examples

This example shows how to configure an EEM applet to trigger after a fan failure of 10 seconds:

switch# configure terminal

switch#(config)# event manager applet applet1

switch#(config-applet)# event fanbad time 10

switch#(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event memory

To configure memory thresholds event specification, use the event memory command. To remove the memory threshold event, use the no form of the command.

event memory { minor | severe | critical }

no event memory { minor | severe | critical }

Syntax Description

minor	Specifies minor alert.
severe	Specifies severe alert.
critical	Specifies critical alert.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

The event specification monitors the memory threshold specified in the applet and Embedded Event Manager takes an action based on the actions configured on the applet.

Examples

This example shows how to configure memory threshold event specification:

switch# configure terminal

switch(config)# event manager applet bad-applet

switch(config-applet)# event memory critical

switch(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.
show system internal memory-alerts-log	Displays the log of memory alerts.

event module-failure

To create a module failure event specification, use the event module-failure command. To remove the module failure event, use the no form of the command.

event module-failure type failure-type module { all | slot } count count [ time seconds ]

no event module-failure type failure-type module { all | slot } count count [ time seconds ]

Syntax Description

type failure-type	Configures the failure type to monitor. failure-type specifies whether one or all modules must be monitored. failure-type specifies the type of failure conditions listed below: addon-sequence-failure Addon sequence failure any hitless-upgrade-diag-failure Runtime diag failure after hitless upgrade hitless-upgrade-failure Hitless upgrade failure hitless-upgrade-procmgr-notif LC software failure after hitless uprade hitless-upgrade-reg-failure Registration failure after hitless upgrade hitless-upgrade-seq-timeout Hitless upgrade sequence timeout image-download-failed Image download failure image-upgrade-failed Image upgrade failed insertion-seq-failure Insertion sequence failure lc-failed LC failed lc-not-responding LC not responding lc-ready-timeout LC ready timeout lc-sw-failure LC software failure registration-failure Registration failure registration-timeout Registration timeout runtime-diag-failure Runtime diag failure runtime-diag-timeout Runtime diag timeout sequence-timeout Sequence timeout srg-info-resp-timeout SRG info response timeout unexpected-registration Unexpected registration received upgrade-srg-not-compatible Upgrade SRG not compatible
module	Configures which modules to monitor.
all	Specifies all modules.
slot	Specifies a module number. The range is platform specific.
count count	Configures the number of matching occurrences before an Embedded Event Manager event is triggered. count specifies the number of repeated occurrences and this number must be an integer in the range 0 to 4294967295.
time seconds	(Optional) Configures a time period. seconds is the period of module in failure state in seconds and this number must be an integer in the range 0 to 10000000.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

None.

Examples

This example shows how to configure a module failure event specification:

switch# configure terminal

switch(config)# event manager applet modfailed

switch(config-applet)# event module-failure type lc-failed module all count 1

switch(config-applet)# action 1.0 syslog priority critical msg module failure detected

switch(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event oir

To configure an Online Insertion Removal event specification, use the event oir command. To remove the Online Insertion Removal event, use the no form of the command.

event oir { fan | module | powersupply } { insert | remove | anyoir } [ number ]

no event oir { fan | module | powersupply } { insert | remove | anyoir } [ number ]

Syntax Description

fan	Specifies the system fans. Optionally, specifies an individual fan.
module	Specifies the system modules. Optionally, specifies an individual module.
powersupply	Specifies the system power supplies. Optionally, specifies an individual power supply.
insert \| remove \| anyoir	Specify the OIR event that triggers the Embedded Event Manager applet. insert —OIR insert remove —OIR remove anyoir —Either OIR insert or OIR remove
number	(Optional) If you select fan, enter a fan number to monitor for an OIR event. The range is platform specific. If you select module, enter a module number to monitor an OIR event. The range is platform specific. If you select power supply, enter a power supply number to monitor an OIR event. The range is platform specific.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

This event specification monitors whenever there is insertion or removal of the following components: fan, module, and power supply. Embedded Event Manager takes an action based on the actions configured on the applet.

Examples

This example shows how to configure the Online Insertion Removal event specification:

switch# configure terminal

switch(config)# event manager applet moduleOir

switch(config-applet)# event oir module anyoir

switch(config-applet)# action 1.0 syslog priority informational msg a module was oir-ed

switch(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event policy-default

To configure the event specification when the system policy is overridden, use the event policy-default command. To remove the configuration, use the no form of the command.

event policy-default count count [ time seconds ]

no event policy-default count count [ time seconds ]

Syntax Description

count count	Configures the number of matching occurrences before an event is triggered. count specifies the number of repeated occurrences and this number must be an integer in the range 0 to 65000.
time seconds	(Optional) Configures the time interval during which one or more occurrences must take place. When this option is not specified no time limit is applied. seconds specifies the number of seconds and this number must be an integer in the range 0 to 4294967295.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

None.

ExamplesNone.

This example shows how to configure an event configuration when the system policy is overridden:

switch# configure terminal

switch(config)# event manager applet applet1

switch(config-applet)# event policy-default count 1

switch(config-applet)# end

Related Commands

Command	Description
show event manager history events detail	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event poweroverbudget

The power over-budget policy gets triggered when the available power capacity drops below zero and the device is no longer able to keep the previously powered-up modules in the powered-up state. The default action is to print a syslog to notify the user of the occurrence of power over budget. To change the power over budget behavior, use the event poweroverbudget command. You must override the default system policy __pfm_power_over_budget with a new policy to do this. To remove the power over-budget event specification, use the no form of the command.

event poweroverbudget

no event poweroverbudget

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

None.

Examples

This example shows how to shut down modules starting from module 1 when the available power drops below zero:

switch# configure terminal

switch(config)# event manager applet pobOverride override __pfm_power_over_budget

switch(config-applet)# event poweroverbudget

switch(config-applet)# action 4 overbudgetshut

switch(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event snmp

To configure an SNMP event, use the event snmp command. To remove the SNMP event, use the no form of the command.

event snmp oid oid get-type { exact | next } entry-op { gt | ge | eq | ne | lt | le } entry-val value [{ exit-comb { or | and } exit-op { gt | ge | eq | ne | lt | le } exit-val value exit-time time } | { exit-op { gt | ge | eq | ne | lt | le } exit-val value }] poll-interval time

no event snmp oid oid get-type { exact | next } entry-op { gt | ge | eq | ne | lt | le } entry-val value [{ exit-comb { or | and } exit-op { gt | ge | eq | ne | lt | le } exit-val value exit-time time } | { exit-op { gt | ge | eq | ne | lt | le } exit-val value }] poll-interval time

Syntax Description

oid oid	Configures the OID to monitor. oid in dot notation.
get-type	Configures the type of SNMP get operation to be applied to the named OID.
exact	Retrieve the OID exactly as specified.
next	Retrieve the OID that is the alphanumeric successor to the named OID.
entry-op	Configures how to compare the value of the current OID with the specified value.
Operator	A logical operator with the following meanings: eq — Equal to ge — Greater than or equal to gt — Greater than le — Less than or equal to lt — Less than ne — Not equal to
entry-val value	Configures a value to compare against the current OID. value specifies a value and this number is an integer in the range from 0 to 2147483647.
exit-comb	(Optional) Configures a combination of exit conditions that must be met before event monitor is re-enabled.
and	(Optional) Specifies that an exit OID value and an exit time value must be reached.
or	(Optional) Specifies that an exit OID value or an exit time value must be reached.
exit-op	Configures how to compare the value of the current OID with the exit value. If there is a match an event is triggered and event monitoring is reenabled.
exit-val value	Configures the value with which the contents of the current OID are compared to decide whether the exit criteria are met. value specifies a value and this number is an integer in the range from 0 to 2147483647.
exit-time time	(Optional) Configures the time period after which the event monitoring is reenabled. The timing starts after the event is triggered. time is an integer in the range from 1 to 2147483647.
poll-interval	Configures the time interval between consecutive polls.

Defaults

None

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(2)	This command was introduced.

Usage Guidelines

An Embedded Event Manager event is triggered when one of the fields specified by an SNMP object ID crosses a defined threshold. If multiple conditions exist, the SNMP event is triggered when all the conditions are met.

Exit criteria are optional. If exit criteria are not specified, event monitoring will be re-enabled immediately. If exit criteria are specified on the basis of values or time periods, the event monitoring is not re-enabled until the criteria are met.

When the entry-op keyword is used and there is a match, an event is triggered and event monitoring is disabled until the exit criteria are met.

When the exit-op keyword is used and there is a match, an event is triggered and event monitoring is re-enabled.

The entry-type keyword triggers one of the following actions:

If the value keyword is specified, the entry-value is an actual value and an SNMP event is raised whenever the absolute value occurs.
If the increment keyword is specified, the entry-value is an increment and an SNMP event is raised whenever the incremental value is reached.
If the rate keyword is specified, the entry-value is a rate of change and an SNMP event is raised whenever the rate of change value is reached.

When the optional exit-type keyword is used, the following conditions occur:

If the value keyword is specified, the exit value is an actual value and the event monitoring is re-enabled whenever the absolute value occurs. This is the default.
If the increment keyword is specified, the exit value is an increment and the event monitoring is re-enabled whenever the incremental value is reached.
If the rate keyword is specified, the exit value is a rate of change and the event monitoring is re-enabled whenever the rate of change value is reached.

Examples

The following example shows how to monitor the CPU free memory OID and log a corresponding syslog:

switch# configure terminal

switch(config)# event manager applet snmp-applet

switch(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.109.1.1.1.1.13.1 get-type exact entry-op lt entry-val 100000 poll-interval 60

switch(config-applet)# action 1.0 syslog priority warnings msg free memory fell below 100 Mb

switch#(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show running-config eem	Displays all EEM applets.

event syslog

To specify event criteria for an Embeded Event Manager applet that is run by matching syslog messages, use the event syslog command in the applet configuration mode. To remove the syslog message event criteria, use the no form of the command.

Syntax Description

occurs count	(Optional) Specifies the number of occurrences of the matched syslog messages to count before triggering the policy event. count range is platform specific.
period interval	(Optional) Specifies the maximum time within which the timestamps of the triggering messages must fall. interval range is platform specific.
priority	(Optional) Specifies the number or name of the desired priority level at which syslog messages are matched. Messages at or numerically lower than the specified level are matched. The parameter for priority must be one of the following: • 0 \| emergencies — Specifies syslog messages of emergency level (the system is unusable). • 1 \| alerts — Specifies syslog messages of alert level (immediate action is needed). • 2 \| critical — Specifies syslog messages of critical level (critical conditions). • 3 \| errors — Specifies syslog messages of error level (error conditions). • 4 \| warnings — Specifies syslog messages of warning level (warning conditions). • 5 \| notifications — Specifies syslog messages of notification level (normal but significant conditions). • 6 \| informational — Specifies syslog messages of informational level (informational messages). • 7 \| debugging — Specifies syslog messages of debugging level (debugging messages).
pattern expression	Specifies a regular expression to match against syslog messages. The pattern must be quoted with " " quotes. expression maximum size is 256 characters.

Defaults

If the occurs parameter is not specified, the default value of 1 is used.

If the period parameter is not specified, the default value of 0 is used.

If the priority parameter is not specified, the default value of informational is used.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
5.2(1)	This command was introduced.

Usage Guidelines

The syslog and Embedded Event Manager client processes run on each supervisor module in a system. Therefore, in dual supervisor systems, an event syslog command will be matched on both the active and standby supervisors. Both Embedded Event Manager clients will notify the Embedded Event Manager master process on the active supervisor causing the applet to be triggered twice. Be sure to take this potential double triggering in to account in the applet.

This command does not require a license.

Examples

This example shows how to configure an applet to trigger after 10 "authentication failed" syslog events:

switch# configure terminal

switch(config)# event manager applet auth-fails-applet

switch(config-applet)# event syslog occurs 10 pattern "authentication failed"

Configuration accepted successfully

This example shows how to configure an applet to tag module power up and standby online syslog events:

switch# configure terminal

switch(config)# event manager applet mod-event-applet

switch(config-applet)# event syslog tag moduleEvent pattern "(powered up|is standby)"

Configuration accepted successfully

Related Commands

Command	Description
action syslog	Configures a syslog message to generate when an EEM applet is triggered.
show event manager history events detail	Displays the history of EEM events.

event temperature

To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a temperature event, use the event temperature command in the applet configuration mode. To remove the temperature event criteria, use the no form of the command.

event temperature [ module slot ] [ sensor number ] threshold { major | minor | any }

no event temperature [ module slot ] [ sensor number ] threshold { major | minor | any }

Syntax Description

module slot	(Optional) Configures for particular modules. slot specifies a ‘-‘ and ‘,’ delimited range of modules. The values are platform specific.
sensor number	(Optional) Configures for particular sensors. number specifies a ‘-‘ and ‘,’ delimited range of sensors and the values are module specific.
threshold	Specifies the threshold event that triggers the Embedded Event Manager applet.
major	Specifies a major event.
minor	Specifies a minor event.
any	Specifies any event.

Defaults

None.

Command Modes

EEM applet configuration (config-applet).

Command History

Release	Modification
NX-OS 4.1(3)	This command was introduced.

Usage Guidelines

None.

Examples

This example shows the default system major temperature EEM policy and only performs the default action for a major temperature alert for sensor #8 only.

switch# show event manager system __pfm_tempev_major

Name : __pfm_tempev_major

Description : TempSensor Major Threshold. Action: Shutdown

Overridable : Yes

switch# configure terminal

switch(config)# event manager applet majortemp_override override __pfm_tempev_major

switch(config-applet)# event temperature module 1-3 sensor 8 threshold major

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

switch(config-applet)# end

Related Commands

Command	Description
show event manager event-types	Displays information about EEM event triggers.
show event manager history events	Displays the history of EEM events.
show event manager policy	Displays the register EEM applets.
show event manager system-policy	Displays the default system EEM applets.

event manager applet

To register an applet with the Embedded Event Manager (EEM) and to enter applet configuration mode, use the event manager applet command.

event manager applet applet-name

Syntax Description

applet-name

The applet name can be any case-sensitive alphanumeric string up to 29 characters.

Defaults

None.

Command Modes

Embedded Event Manager.

Command History

Release	Modification
NX-OS 4.1(3)	This command was introduced.

Usage Guidelines

None.

Examples

This example shows how to register an applet with EEM and to enter applet configuration mode:

switch# configure terminal

switch(config)# event manager applet eem-applet

switch(config-applet)#

Related Commands

Command	Description
show event manager policy	Displays the register Embedded Event manager policies.

event manager policy

To register and activate an Embeded Event Manager policy (EEM) script policy, use the event manager policy command.

event manager policy policy-script

no event manager policy policy-script

Syntax Description

policy-script

Specifies the EEM policy script. This name becomes the name of the EEM policy. The maximum size is 29 characters.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release	Modification
NX-OS 4.1(3)	This command was introduced.

Usage Guidelines

The EEM schedules and runs policies on the basis of an event specification that is contained within the policy itself. When the event manager policy command is invoked, the EEM examines the policy and registers it to be run when the specified event occurs.

Examples

The following example shows how to register a policy:

switch# configure terminal

switch(config)# event manager policy modulescript

switch(config)#

Related Commands

Command	Description
event manager applet	Displays an applet with the Emedded Event manager.

event manager environment

To configure an EEM environment variable, use the event manager environment command. To disable an EEM environment variable, use the no form of the command.

event manager environment variable-name variable-value

no event manager environment variable-name variable-value

Syntax Description

variable-name	Specifies the name of the EEM environment variable. The variable name can be any case-sensitive alphanumeric string up to 32 characters.
variable-value	Specifies the value of the EEM environment. The variable name can be any case-sensitive alphanumeric string up to 32 characters.

Defaults

None.

Command Modes

Embeded Event Manager.

Command History

Release	Modification
NX-OS 4.1(3)	This command was introduced.

Usage Guidelines

None.

Examples

The following example shows how to set an EEM environment variable:

switch# configure terminal

switch(config)# event manager environment emailto “admin@anyplace.com”

switch(config)#

Related Commands

Command	Description
show event manager environment	Displays the name and value of the Embedded Event manager.
show event manager policy	Displays the register Embedded Event manager policies.

exit

To exit any configuration mode or close an active terminal session and terminate the EXEC, use the exit command at the system prompt.

exit

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

EXEC and configuration modes.

Command History

Release	Modification
4.1(1b)	Modified the command output.
1.0(2)	This command was introduced.

Usage Guidelines

Use the exit command at the EXEC levels to exit the EXEC mode. Use the exit command at the configuration level to return to privileged EXEC mode. Use the exit command in interface configuration mode to return to configuration mode. You also can press Ctrl-Z, or use the end command, from any configuration mode to return to EXEC mode.

Note The exit command is associated with privilege level 0. If you configure AAA authorization for a privilege level greater than 0, this command will not be included in the command set for that privilege level.