- New and Changed Information
- Preface
- A Commands
- Advanced Services Modules Commands
- B Commands
- C Commands
- Caching Services Module Commands
- CLI Overview
- D Commands
- Debug Commands
- E Commands
- F Commands
- G Commands
- H Commands
- I Commands
- J Commands
- K Commands
- L Commands
- M Commands
- N Commands
- O Commands
- P Commands
- Q Commands
- R Commands
- S Commands
- Show Commands
- T Commands
- U Commands
- V Commands
- W Commands
- Z Commands
Cisco MDS 9000 Family Command Reference
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- July 13, 2014
Chapter: E Commands
- egress-sa
- email-contact
- empty
- enable
- enable (Call Home configuration submode)
- enable user-server-group
- enable secret
- enable cert-DN-match
- encryption
- end
- enrollment terminal
- errdisable detect cause link-down
- errdisable detect cause bit-errors
- errdisable detect cause credit-loss
- errdisable detect cause link-reset
- errdisable detect cause signal-loss
- errdisable detect cause sync-loss
- errdisable detect cause trustsec-violation
- event cli
- event counter
- event fanabsent
- event fanbad
- event fcns
- event flogi
- event gold
- event memory
- event module
- event module-failure
- event oir
- event policy-default
- event poweroverbudget
- event snmp
- event storm-control
- event syslog
- event sysmgr
- event temperature
- event zone
- event manager applet
- event manager environment
- event manager policy
- exit
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.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to configure the SA to the egress hardware:
Related Commands
|
|
|
|---|---|
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.
Syntax Description
Configures an e-mail address. Uses a standard e-mail address that does not have any text size restrictions. |
Defaults
Command Modes
Call Home configuration submode.
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to configure e-mail contact in the Call Home configuration:
Related Commands
|
|
|
|---|---|
Sends a dummy test message to the configured destination(s). |
|
empty
To remove all steps of the user-configured algorithm, use the empty command in configuration mode.
Syntax Description
Defaults
Command Modes
Configuration Secure Erase algorithm submode
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to remove all steps of the user-configured algorithm:
Related Commands
|
|
|
|---|---|
enable
To turn on the privileged commands, use the enable command. To disable this feature, use the disable command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to turn on the privileged commands:
Related Commands
|
|
|
|---|---|
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.
Syntax Description
Defaults
Command Modes
Call Home configuration submode.
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to enable the Call Home function.
Related Commands
|
|
|
|---|---|
Sends a dummy test message to the configured destination(s). |
|
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.
Syntax Description-
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
Related Commands
|
|
|
|---|---|
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
Specifies that the secret that follows should be in clear text. |
|
(Optional) Specifies the privilege level to which the secret belongs. |
|
(Optional) Specifies the privilege level. Default value is 15. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to specifiy the secret that follows should be in clear text:
The following example shows how to specify the secret that follows should be encrypted:
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.
Syntax Description-
Defaults
Command Modes
Command History
|
|
|
|---|---|
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 user certificate as authorized for logging in.
Examples
Related Commands
|
|
|
|---|---|
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 }
Syntax Description
Defaults
Command Modes
IKE policy configuration submode.
Command History
|
|
|
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:
Related Commands
|
|
|
|---|---|
end
To exit any of the configuration modes and return to EXEC mode, use the end command in configuration mode.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
The following example shows how to exit from configure mode:
The following example changes the name to george. Entering the end command causes the system to exit configuration mode and return to EXEC mode.
Related Commands
|
|
|
|---|---|
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.
Syntax Description
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
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to configure trust point enrollment through the switch console:
The following example shows how to discard a trust point enrollment through the switch console:
Related Commands
|
|
|
|---|---|
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 in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause link-down num-times count duration sec
no errdisable detect cause link-down num-times count duration sec
Syntax Description
Defaults
Command Modes
Interface Configuration submode.
Command History
|
|
|
|---|---|
Usage Guidelines
The port guard feature is used in 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 occurring 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 administration 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:
The following example shows how to configure the port as down when the link flaps 5 times in 30 seconds:
The following example shows how to remove the port guard feature on the interface:
Related Commands
|
|
|
|---|---|
errdisable detect cause bit-errors
To enable error-disable detection on bit errors, use the errdisable detect cause bit-errors command in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause bit-errors num-times count duration sec
no errdisable detect cause bit-errors num-times count duration sec
Syntax Description
Defaults
Command Modes
Interface Configuration submode.
Command History
|
|
|
|---|---|
Usage Guidelines
The port guard feature is used in 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 occurring 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 administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on bit errors:
Related Commands
|
|
|
|---|---|
errdisable detect cause credit-loss
To enable error-disable detection on a credit loss, use the errdisable detect cause credit-loss command in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause credit-loss num-times count duration sec
no errdisable detect cause credit-loss num-times count duration sec
Syntax Description
Defaults
Command Modes
Interface Configuration submode.
Command History
|
|
|
|---|---|
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 occurring 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 administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a credit loss:
Related Commands
|
|
|
|---|---|
errdisable detect cause link-reset
To enable error-disable detection on a link reset, use the errdisable detect cause link-reset command in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause link-reset num-times count duration sec
no errdisable detect cause link-reset num-times count duration sec
Syntax Description
Defaults
Command Modes
Interface Configuration submode.
Command History
|
|
|
|---|---|
Usage Guidelines
The port guard feature is used in 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 occurring 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 administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a link reset:
Related Commands
|
|
|
|---|---|
errdisable detect cause signal-loss
To enable error-disable detection on a signal loss, use the errdiable detect cause signal-loss command in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause signal-loss num-times count duration sec
no errdisable detect cause signal-loss num-times count duration sec
Syntax Description
Defaults
Command Modes
Interface Configuration submode.
Command History
|
|
|
|---|---|
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 occurring 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 administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable on a signal loss:
Related Commands
|
|
|
|---|---|
errdisable detect cause sync-loss
To enable error-disable detection on a sync loss, use the errdisable detect cause sync-loss command in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause sync-loss num-times count duration sec
no errdisable detect cause sync-loss num-times count duration sec
Syntax Description
Defaults
Command Modes
Interface Configuration submode.
Command History
|
|
|
|---|---|
Usage Guidelines
The port guard feature is used in 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 occurring 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 administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a synchronized loss:
Related Commands
|
|
|
|---|---|
errdisable detect cause trustsec-violation
To enable error-disable detection on a trustsec violation, use the errdisable detect cause trustsec-violation command in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause trustsec-violation num-times count duration sec
no errdisable detect cause trustsec-violation num-times count duration sec
Syntax Description
Defaults
Command Modes
Interface Configuration submode.
Command History
|
|
|
|---|---|
Usage Guidelines
The port guard feature is used in 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 occurring 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 administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a trustsec violation:
Related Commands
|
|
|
|---|---|
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 [ tag tagname ] match expression [ count countnum [ time seconds ]]
no event cli [ tag tagname ] match expression [ count countnum [ time seconds ]]
Syntax Description
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
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:
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.
Related Commands
|
|
|
|---|---|
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 [ tag tagname ] name name entry-val value entry-op operator [ exit-val value exit-op operator ]
no event counter [ tag tagname ] name name entry-val value entry-op operator [ exit-val value exit-op operator ]
Syntax Description
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to trigger an EEM applet when a counter named 'test' has a value of 0:
Related Commands
|
|
|
|---|---|
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
(Optional) Configures a chassis fan. |
|
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
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):
Related Commands
|
|
|
|---|---|
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
(Optional) Configures a chassis fan. |
|
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
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:
Related Commands
|
|
|
|---|---|
event fcns
To change the maximum number of FC Name Server (FCNS) entries allowed on a switch, use the event fcns command. You must override the default system policy __fcns_entries_max_per_switch with a new policy to do this. To remove the FCNS event, use the no form of the command.
event fcns entries max-per-switch count
no event fcns entries max-per-switch count
Syntax Description
Specifies an event to configure maximum FCNS database count per switch. count specifies the maximum number of FCNS entries the switch will register. count range is platform specific. |
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
The maximum number of name server entries that a switch can support is dependent on the platform. Refer to the Cisco MDS NX-OS Release 6.2(13) Configuration Limits document for platform specific limits.
Examples
This example shows how to configure an Embedded Event Manager event when the FCNS database count per switch reaches a maximum:
Related Commands
|
|
|
|---|---|
event flogi
To trigger an Embedded Event Manager (EEM) policy when certain fabric login (FLOGI) thresholds are exceeded, use the event flogi command. To remove the FLOGI event detection from the EEM policy, use the no form of the command.
event flogi { intf-max | module-max | switch-max } count
no event flogi { intf-max | module-max | switch-max } count
Syntax Description
Triggers an event when the number of successful and pending FLOGIs for any Fibre Channel interface exceeds the specified threshold. |
|
Triggers an event when the number of successful and pending FLOGIs for any module exceeds the specified threshold. |
|
Triggers an event when the number of successful and pending FLOGIs for the switch exceeds the specified threshold. |
|
Specifies the threshold value. The threshold value must be a positive integer. The FLOGI limit range per interface, module, and switch is platform specific. For more information on FLOGI limits for different platforms, see the Cisco MDS NX-OS Configuration Limits document. |
Defaults
Command Modes
EEM applet configuration (config-applet)
Command History
|
|
|
|---|---|
Usage Guidelines
To use these FLOGI event triggers you must override the corresponding default system policies with a new policy. The default system policies are:
|
|
|
|---|---|
Examples
This example shows an event trigger that occurs when the number of FLOGIs per interface exceeds the threshold value of 156:
This example shows an event trigger that occurs when the number of FLOGIs per module exceeds the threshold value of 1024:
This example shows an event trigger that occurs when the number of FLOGIs per switch exceeds the threshold value of 2000:
Related Commands
|
|
|
|---|---|
event gold
To create an online diagnostic test failure related event, use the event gold command. To remove the online diagnostic test failure related event, use the no form of the command.
event gold module { number | all } test name [ severity { minor | moderate | major }] testing-type { scheduled | monitoring } consecutive-failure count
no event gold module { number | all } test name
Syntax Description
DefaultsNone
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to configure an EEM event when the GOLD ASICRegisterCheck test fails on all modules 10 consecutive times.
This example shows how to configure an EEM event when the GOLD PwrMgmtBus test fails on module 5 only 20 consecutive times.
Related Commands
|
|
|
|---|---|
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
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
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:
Related Commands
|
|
|
|---|---|
event module
To configure the module event specification, use the event module command. To remove the module event specification, use the no form of the command.
event module [ tag tagname ] status { online | offline | any } module { all | slot }
no event module [ tag tagname ] status { online | offline | any } module { all | slot }
Syntax Description
(Optional) Configures an event tag identifier. |
|
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
This event specification monitors the module status change. Embedded Event Manager takes an action based on the actions configured on the applet.
Examples
This example shows how to configure the module event specification in the device:
Related Commands
|
|
|
|---|---|
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 [ tag tagname ] type failure-type module { all | slot } count count [ time seconds ]
no event module-failure [ tag tagname ] type failure-type module { all | slot } count count [ time seconds ]
Syntax Description
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to configure a module failure event specification:
Related Commands
|
|
|
|---|---|
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 [ tag tagname ] { fan | module | powersupply } { insert | remove | anyoir } [ number ]
no event oir [ tag tagname ] { fan | module | powersupply } { insert | remove | anyoir } [ number ]
Syntax Description
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
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:
Related Commands
|
|
|
|---|---|
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
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
ExamplesNone.
This example shows how to configure an event configuration when the system policy is overridden:
Related Commands
|
|
|
|---|---|
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.
Syntax Description
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to shut down modules starting from module 1 when the available power drops below zero:
Related Commands
|
|
|
|---|---|
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 [ tag tagname ] 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 [tag tagname ] 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
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
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:
Related Commands
|
|
|
|---|---|
event storm-control
By default, the packet storm feature takes limited action. The packet storm feature can be augmented with further actions, such as disabling the affected interface or sending SNMP traps, by using an EEM applet. To configure a packet storm event as an EEM applet trigger, use the event storm-control command. To delete the applet trigger, use the no form of the command.
Syntax Description
Command Default
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
This command is only available on platforms that support the packet storm feature.
Examples
The following example show how to shutdown an interface that exceeds the packet storm feature thresholds:
Related Commands
|
|
|
|---|---|
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.
event syslog [ tag tagname ] [ occurs count ] [ period interval ] [ priority [ 0-7 | alerts | critical | debugging | emergencies | errors | informational | notifications | warnings ]] pattern expression
no event syslog [ tag tagname ] [ occurs count ] [ period interval ] [ priority [ 0-7 | alerts | critical | debugging | emergencies | errors | informational | notifications | warnings ]] pattern expression
Syntax Description
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
|
|
|
|---|---|
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.
Examples
This example shows how to configure an applet to trigger after 10 "authentication failed" syslog events:
This example shows how to configure an applet to tag module power up and standby online syslog events:
Related Commands
|
|
|
|---|---|
Configures a syslog message to generate when an EEM applet is triggered. |
|
event sysmgr
To override default system EEM policies, use the event sysmgr command. To remove the system manager-related event specification, use the no form of the command.
event sysmgr { memory [ module mod-number ] major value minor value clear value | switchover count count time seconds }
no event sysmgr { memory [ module mod-number ] major value minor value clear value | switchover count count time seconds }
Syntax Description
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following examples show the default system switchover EEM policy and override the default triggering values with user defined values. The default action is retained.
Related Commands
|
|
|
|---|---|
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
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
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.
Related Commands
|
|
|
|---|---|
event zone
To change the maximum number of zone elements allowed on a switch, use the event zone command. You must override the relevant default system policy with a new policy to do this. To remove the zone event criteria, use the no form of the command.
event zone { zones max-per-switch | zonesets max-per-switch | zonemembers max-per-switch | dbsize max-per-vsan } count
no event zone { zones max-per-switch | zonesets max-per-switch | zonemembers max-per-switch | dbsize max-per-vsan } count
Syntax Description
Defaults
Command Modes
EEM applet configuration (config-applet).
Command History
|
|
|
|---|---|
Usage Guidelines
By default, the threshold controlled by the ‘zone’ events are set by the following system policies:
- __zone_dbsize_max_per_vsan
- __zone_members_max_per_sw
- __zone_zones_max_per_sw
- __zone_zonesets_max_per_sw
These policies log syslog messages when preconfigured thresholds are reached to alert the user of high resource usage by the zone service. The thresholds and actions may be over ridden by the user or the actions augmented by further actions (such as sending an SNMP trap).
Examples
This example shows the default system per VSAN maximum zone database size EEM policy and overrides the database size. The default action is retained.
This example shows how to configure an EEM applet to override the maximum zone count on a system:
This example shows how to configure an EEM applet to override the maximum zoneset count on a system:
Related Commands
|
|
|
|---|---|
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. To unregister the applet, use the no form of the command.
event manager applet applet-name [ override system-policy ]
no event manager applet applet-name
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
This example shows how to register an applet with Embedded Event Manager and to enter applet configuration mode:
Related Commands
|
|
|
|---|---|
event manager environment
To configure an Embedded Event Manager (EEM) environment variable, use the event manager environment command. To disable an Embedded Event Manager environment variable, use the no form of the command.
event manager environment environment-name environment-value
no event manager environment environment-name
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example shows how to set an Embedded Event Manager environment variable:
Related Commands
|
|
|
|---|---|
event manager policy
To register and activate an Embedded Event Manager (EEM) script policy, use the event manager policy command in the global configuration mode. To deactivate the script policy, use the no form of the command.
event manager policy policy-script
no event manager policy policy-script
Syntax Description
Specifies the Embedded Event Manager policy script. This name becomes the name of the Embedded Event Manager policy. The maximum size of the name is 29 characters. |
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
User policy scripts must be installed in the bootflash://eem/user_script_policies directory before they can be used. If this directory does not exist, create this directory before the first use of this command and install the policy scripts in it.
The Embedded Event Manager 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 Embedded Event Manager examines the policy and registers it to be run when the specified event occurs.
Examples
The following example shows how to register a policy:
Related Commands
|
|
|
|---|---|
exit
To exit any configuration mode or close an active terminal session and terminate the EXEC, use the exit command at the system prompt.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
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.
Examples
The following example displays an exit from the submode:
The following example displays an exit from the interface configuration mode for VRRP to return to the interface configuration mode:
The following example displays an exit from the interface configuration mode to return to the configuration mode:
The following example shows how to exit an active session (log-out):
Related Commands
|
|
|
|---|---|
Feedback