Cisco Nexus 7000 Series NX-OS System Management Configuration Guide, Release 5.x

Cisco-TAC

All critical alerts from the other alert groups destined for Smart Call Home.

Execute commands based on the alert group that originates the alert.

Configuration

Periodic events related to configuration.

show module
show running-configuration vdc-all all
show startup-configuration vdc-all
show vdc current
show vdc membership
show version

Diagnostic

Events generated by diagnostics.

show diagnostic result module all detail
show diagnostic result module number detail
show hardware
show logging last 200
show module
show sprom all
show tech-support gold
show tech-support ha
show tech-support platform
show vdc current
show vdc membership
show version

EEM

Events generated by EEM.

show diagnostic result module all detail
show diagnostic result module number detail
show module
show tech-support gold
show tech-support ha
show tech-support platform
show vdc current
show vdc membership

Environmental

Events related to power, fan, and environment-sensing elements such as temperature alarms.

show environment
show logging last 200
show module
show vdc current
show vdc membership
show version

Inventory

Inventory status that is provided whenever a unit is cold booted, or when FRUs are inserted or removed. This alert is considered a noncritical event, and the information is used for status and entitlement.

show inventory
show license usage
show module
show system uptime
show sprom all
show vdc current
show vdc membership
show version

License

Events related to licensing and license violations.

show license usage vdc all
show logging last 200
show vdc current
show vdc membership

Linemodule hardware

Events related to standard or intelligent switching modules.

show diagnostic result module all detail
show diagnostic result module number detail
show hardware
show logging last 200
show module
show sprom all|
show tech-support ethpm
show tech-support gold
show tech-support ha
show tech-support platform
show vdc current
show vdc membership
show version

Supervisor hardware

Events related to supervisor modules.

show diagnostic result module all detail
show hardware
show logging last 200
show module
show sprom all
show tech-support ethpm
show tech-support gold
show tech-support ha
show tech-support platform
show vdc current
show vdc membership
show version

Syslog port group

Events generated by the syslog PORT facility.

show license usage
show logging last 200
show vdc current
show vdc membership

System

Events generated by a failure of a software system that is critical to unit operation.

show diagnostic result module all detail
show hardware
show logging last 200
show module
show sprom all
show tech-support ethpm
show tech-support gold
show tech-support ha
show tech-support platform
show vdc current
show vdc membership

Test

User-generated test message.

show module
show vdc current
show vdc membership
show version

9

Catastrophic

N/A

Network-wide catastrophic failure.

8

Disaster

N/A

Significant network impact.

7

Fatal

Emergency (0)

System is unusable.

6

Critical

Alert (1)

Critical conditions that indicate that immediate attention is needed.

5

Major

Critical (2)

Major conditions.

4

Minor

Error (3)

Minor conditions.

3

Warning

Warning (4)

Warning conditions.

2

Notification

Notice (5)

Basic notification and informational messages. Possibly independently insignificant.

1

Normal

Information (6)

Normal event signifying return to normal state.

0

Debugging

Debug (7)

Debugging messages.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

snmp-server contact sys-contact

Example:

switch(config)# snmp-server contact personname@companyname.com

Configures the SNMP sysContact.

Step 3

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 4

email-contact email-address

Example:

switch(config-callhome)# email-contact admin@Mycompany.com

Configures the e-mail address for the person primarily responsible for the device. Up to 255 alphanumeric characters are accepted in an e-mail address format.

Note You can use any valid e-mail address. You cannot use spaces.

Step 5

phone-contact international-phone-number

Example:

switch(config-callhome)# phone-contact +1-800-123-4567

Configures the phone number in international phone number format for the primary person responsible for the device. Up to 17 alphanumeric characters are accepted in international format.

Note You cannot use spaces. Be sure to use the + prefix before the number.

Step 6

streetaddress address

Example:

switch(config-callhome)# streetaddress 123 Anystreet st. Anytown,AnyWhere

Configures the street address as an alphanumeric string with white spaces for the primary person responsible for the device. Up to 255 alphanumeric characters are accepted, including spaces.

Step 7

contract-id contract-number

Example:

switch(config-callhome)# contract-id Contract5678

(Optional) Configures the contract number for this device from the service agreement. The contract number can be up to 255 alphanumeric characters in free format.

Step 8

customer-id customer-number

Example:

switch(config-callhome)# customer-id Customer123456

(Optional) Configures the customer number for this device from the service agreement. The customer number can be up to 255 alphanumeric characters in free format.

Step 9

site-id site-number

Example:

switch(config-callhome)# site-id Site1

(Optional) Configures the site number for this device. The site number can be up to 255 alphanumeric characters in free format.

Step 10

switch-priority number

Example:

switch(config-callhome)# switch-priority 3

(Optional) Configures the switch priority for this device. The range is from 0 to 7, with 0 being the highest priority and 7 the lowest. The default is 7.

Step 11

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 12

show callhome

Example:

switch(config-callhome)# show callhome

(Optional) Displays a summary of the Smart Call Home configuration.

Step 13

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

destination-profile name

Example:

switch(config-callhome)# destination-profile Noc101

Creates a new destination profile. The name can be any alphanumeric string up to 31 characters.

Step 4

destination-profile name format { XML | full-txt | short-txt }

Example:

switch(config-callhome)# destination-profile Noc101 format full-txt

Sets the message format for the profile. The name can be any alphanumeric string up to 31 characters.

Step 5

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 6

show callhome destination-profile [ profile name ]

Example:

switch(config-callhome)# show callhome destination-profile profile Noc101

(Optional) Displays information about one or more destination profiles.

Step 7

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } email-addr address

Example:

switch(config-callhome)# destination-profile full-txt-destination email-addr person@place.com

Configures an e-mail address for a user-defined or predefined destination profile.

Step 4

destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } http address

Example:

switch(config-callhome)# destination-profile CiscoTAC-1 http http://site.com/service/callhome

Configures an HTTP or HTTPS URL for a user-defined or predefined destination profile. The URL can be up to 255 characters.

Note This command is not distributable with CFS. As a workaround, enter this command after the commit command.

Step 5

destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } transport-method { email | http }

Example:

switch(config-callhome)# destination-profile CiscoTAC-1 http http://site.com/service/callhome

Configures an e-mail or HTTP transport method for a user-defined or predefined destination profile. The type of transport method that you choose determines the configured destination addresses of that type.

Note This command is not distributable with CFS. As a workaround, enter this command after the commit command.

Step 6

destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } message-level number

Example:

switch(config-callhome)# destination-profile full-txt-destination message-level 5

Configures the Smart Call Home message severity level for this destination profile. Cisco NX-OS sends only alerts that have a matching or higher Smart Call Home severity level to destinations in this profile. The range is from 0 to 9, where 9 is the highest severity level.

Step 7

destination-profile { n ame | CiscoTAC-1 | full-txt-destination | short-txt-destination } message-size number

Example:

switch(config-callhome)# destination-profile full-txt-destination message-size 100000

Configures the maximum message size for this destination profile The range is from 0 to 5000000. The default is 2500000.

Step 8

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 9

show callhome destination-profile [ profile name ]

Example:

switch(config-callhome)# show callhome destination-profile profile full-text-destination

(Optional) Displays information about one or more destination profiles.

Step 10

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } alert-group { All | Cisco-TAC | Configuration | Diagnostic | EEM | Environmental | Inventory | License | Linecard-Hardware | Supervisor-Hardware | Syslog-group-port | System | Test }

Example:

switch(config-callhome)# destination-profile Noc101 alert-group All

Associates an alert group with this destination profile. Use the All keyword to associate all alert groups with the destination profile.

Step 4

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 5

show callhome destination-profile [ profile name ]

Example:

switch(config-callhome)# show callhome destination-profile profile Noc101

(Optional) Displays information about one or more destination profiles.

Step 6

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

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

Example:

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

Adds the show command output to any Smart Call Home messages sent for this alert group. Only valid show commands are accepted.

Step 4

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 5

show callhome user-def-cmds

Example:

switch(config-callhome)# show callhome user-def-cmds

(Optional) Displays information about all user-defined show commands added to alert groups.

Step 6

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

transport email mail-server ip-address [ port number] [ priority number] [ use-vrf vrf-name ]

Example:

switch(config-callhome)# transport email mail-server 192.0.2.1 use-vrf Red

Configures the SMTP server as the domain name server (DNS) name, IPv4 address, or IPv6 address. Optionally configures the port number. The port range is from 1 to 65535. The default port number is 25.

Also optionally configures the priority of the SMTP server. The priority range is from 1 to 100, with 1 being the highest priority and 100 the lowest. If you do not specify a priority, the default value of 50 is used.

Also optionally configures the VRF to use when communicating with this SMTP server. The VRF specified is not used to send messages using HTTP. To use HTTP, see the “Configuring VRFs To Send Messages Using HTTP” section.

Note To distribute the SMTP server configuration to devices that run Release 4.2 or earlier, you must use the transport email smtp-server command, which configures only one SMTP server.

Step 4

transport email from email-address

Example:

switch(config-callhome)# transport email from person@company.com

(Optional) Configures the e-mail from field for Smart Call Home messages.

Step 5

transport email reply-to email-address

Example:

switch(config-callhome)# transport email reply-to person@company.com

(Optional) Configures the e-mail reply-to field for Smart Call Home messages.

Step 6

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 7

show callhome transport

Example:

switch(config-callhome)# show callhome transport

(Optional) Displays the transport-related configuration for Smart Call Home.

Step 8

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

transport http use-vrf vrf-name

Example:

switch(config-callhome)# transport http use-vrf Blue

Configures the VRF used to send e-mail and other Smart Call Home messages over HTTP.

Step 4

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 5

show callhome

Example:

switch(config-callhome)# show callhome

(Optional) Displays information about Smart Call Home.

Step 6

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

transport http proxy server ip-address [ port number ]

Example:

switch(config-callhome)# transport http proxy server 192.0.2.1

Configures the HTTP proxy server domain name server (DNS) name, IPv4 address, or IPv6 address. Optionally configures the port number. The port range is from 1 to 65535. The default port number is 8080.

Step 4

transport http proxy enable

Example:

switch(config-callhome)# transport http proxy enable

Enables Smart Call Home to send all HTTP messages through the HTTP proxy server.

Note You can execute this command only after the proxy server address has been configured.

Note The VRF used for transporting messages through the proxy server is the same as that configured using the transport http use-vrf command.

Step 5

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 6

show callhome transport

Example:

switch(config-callhome)# show callhome transport

(Optional) Displays the transport-related configuration for Smart Call Home.

Step 7

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

config t

Example:

switch# config t

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

switch(config)#

Places you in global configuration mode.

Step 2

callhome

Example:

switch(config)# callhome

switch(config-callhome)#

Enters callhome configuration mode.

Step 3

periodic-inventory notification [ interval days ] [ timeofday time ]

Example:

switch(config-callhome)# periodic-inventory notification interval 20

Configures the periodic inventory messages. The interval range is from 1 to 30 days, and the default is 7. The time argument is in HH:MM format. It defines at what time of the day every X days an update is sent (where X is the update interval).

Step 4

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 5

show callhome

Example:

switch(config-callhome)# show callhome

(Optional) Displays information about Smart Call Home.

Step 6

copy running-config startup-config

Example:

switch(config)# copy running-config startup-config

(Optional) Saves this configuration change.

Step 1

no duplicate-message throttle

Example:

switch(config-callhome)# no duplicate-message throttle

Disables duplicate message throttling for Smart Call Home. Enabled by default.

Step 2

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

Step 1

enable

Example:

switch(config-callhome)# enable

Enables Smart Call Home. Disabled by default.

Note To disable Smart Call Home, use the no enable command in Smart Call Home configuration mode.

Step 2

commit

Example:

switch(config-callhome)# commit

Commits the callhome configuration commands.

callhome send [ configuration | diagnostic]

Example:

switch(config-callhome)# callhome send diagnostic

Sends the specified Smart Call Home test message to all configured destinations.

Note This command is available only in the default VDC.

callhome test

Example:

switch(config-callhome)# callhome test

Sends a test message to all configured destinations.

Configuration

PERIODIC_CONFIGURATION

Periodic configuration update message.

2

Diagnostic

DIAGNOSTIC_MAJOR_ALERT

GOLD generated a major alert.

7

DIAGNOSTIC_MINOR_ALERT

GOLD generated a minor alert.

4

DIAGNOSTIC_NORMAL_ALERT

Smart Call Home generated a normal diagnostic alert.

2

Environmental and CISCO_TAC

FAN_FAILURE

Cooling fan has failed.

5

POWER_SUPPLY_ALERT

Power supply warning has occurred.

6

POWER_SUPPLY_FAILURE

Power supply has failed.

6

POWER_SUPPLY_SHUTDOWN

Power supply has shut down.

6

TEMPERATURE_ALARM

Thermal sensor going bad.

6

TEMPERATURE_MAJOR_ALARM

Thermal sensor indicates temperature has reached operating major threshold.

6

TEMPERATURE_MINOR_ALARM

Thermal sensor indicates temperature has reached operating minor threshold.

4

Inventory and CISCO_TAC

COLD_BOOT

Switch is powered up and reset to a cold boot sequence.

2

HARDWARE_INSERTION

New piece of hardware has been inserted into the chassis.

2

HARDWARE_REMOVAL

Hardware has been removed from the chassis.

2

PERIODIC_INVENTORY

Periodic inventory message has been generated.

2

License

LICENSE_VIOLATION

Feature in use is not licensed and is turned off after grace period expiration.

6

Line module Hardware and CISCO_TAC

LINEmodule_FAILURE

Module operation has failed.

7

Supervisor Hardware and CISCO_TAC

CMP_FAILURE

CMP module operation has failed.

5

SUP_FAILURE

Supervisor module operation has failed.

7

Syslog-group-
port

PORT_FAILURE

syslog message that corresponds to the port facility has been generated.

6

SYSLOG_ALERT

syslog alert message has been generated.

5

System and CISCO_TAC

SW_CRASH

Software process has failed with a stateless restart, indicating an interruption of a service. Messages are sent for process crashes on supervisor modules and line cards.

5

SW_SYSTEM_INCONSISTENT

Inconsistency has been detected in software or file system.

5

Test and CISCO_TAC

TEST

User generated test has occurred.

2

Device identification

Configured device name

Date/time stamp

Time stamp of the triggering event

Error isolation message

Plain English description of triggering event

Alarm urgency level

Error level such as that applied to system message

Time stamp

Date and time stamp of event in ISO time notation:

YYYY-MM-DD HH:MM:SS GMT+HH:MM.

/aml/header/time

Message name

Name of message. Specific event names are listed in Table 9-4 .

/aml/header/name

Message type

Name of message type, such as reactive or proactive.

/aml/header/type

Message group

Name of alert group, such as syslog.

/aml/header/group

Severity level

Severity level of message (see the “Smart Call Home Message Urgency Levels” section).

/aml/header/level

Source ID

Product type for routing, such as the Catalyst 6500 series switch.

/aml/header/source

Device ID

Unique device identifier (UDI) for the end device that generated the message. This field should be empty if the message is nonspecific to a device. The format is type @ Sid @ seria l.

• type is the product model number from the backplane IDPROM.
• @ is a separator character.
• Sid is C, identifying the serial ID as a chassis serial number·
• serial is the number identified by the Sid field.

An example is WS-C6509@C@12345678

/aml/ header/deviceId

Customer ID

Optional user-configurable field used for contract information or other ID by any support service.

/aml/ header/customerID

Contract ID

Optional user-configurable field used for contract information or other ID by any support service.

/aml/ header /contractId

Site ID

Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service.

/aml/ header/siteId

Server ID

If the message is generated from the device, this is the unique device identifier (UDI) of the device.

The format is type @ Sid @ seria l.

• type is the product model number from the backplane IDPROM.
• @ is a separator character.
• Sid is C, identifying the serial ID as a chassis serial number.
• serial is the number identified by the Sid field.

An example is WS-C6509@C@12345678.

/aml/header/serverId

Message description

Short text that describes the error.

/aml/body/msgDesc

Device name

Node that experienced the event (hostname of the device).

/aml/body/sysName

Contact name

Name of person to contact for issues associated with the node that experienced the event.

/aml/body/sysContact

Contact e-mail

E-mail address of person identified as the contact for this unit.

/aml/body/sysContactEmail

Contact phone number

Phone number of the person identified as the contact for this unit.

/aml/body/sysContactPhoneNumber

Street address

Optional field that contains the street address for RMA part shipments associated with this unit.

/aml/body/sysStreetAddress

Model name

Model name of the device (the specific model as part of a product family name).

/aml/body/chassis/name

Serial number

Chassis serial number of the unit.

/aml/body/chassis/serialNo

Chassis part number

Top assembly number of the chassis.

/aml/body/chassis/partNo

Command output name

Exact name of the issued CLI command.

/aml/attachments/attachment/name

Attachment type

Specific command output.

/aml/attachments/attachment/type

MIME type

Either plain text or encoding type.

/aml/attachments/attachment/mime

Command output text

Output of command automatically executed (see the “Smart Call Home Alert Groups” section).

/aml/attachments/attachment/atdata

Chassis hardware version

Hardware version of chassis.

/aml/body/chassis/hwVersion

Supervisor module software version

Top-level software version.

/aml/body/chassis/swVersion

Affected FRU name

Name of the affected FRU that is generating the event message.

/aml/body/fru/name

Affected FRU serial number

Serial number of the affected FRU.

/aml/body/fru/serialNo

Affected FRU part number

Part number of the affected FRU.

/aml/body/fru/partNo

FRU slot

Slot number of the FRU that is generating the event message.

/aml/body/fru/slot

FRU hardware version

Hardware version of the affected FRU.

/aml/body/fru/hwVersion

FRU software version

Software version(s) that is running on the affected FRU.

/aml/body/fru/swVersion

Chassis hardware version

Hardware version of the chassis.

/aml/body/chassis/hwVersion

Supervisor module software version

Top-level software version.

/aml/body/chassis/swVersion

FRU name

Name of the affected FRU that is generating the event message.

/aml/body/fru/name

FRU s/n

Serial number of the FRU.

/aml/body/fru/serialNo

FRU part number

Part number of the FRU.

/aml/body/fru/partNo

FRU slot

Slot number of the FRU.

/aml/body/fru/slot

FRU hardware version

Hardware version of the FRU.

/aml/body/fru/hwVersion

FRU software version

Software version(s) that is running on the FRU.

/aml/body/fru/swVersion

Process ID

Unique process ID.

/aml/body/process/id

Process state

State of process (for example, running or halted).

/aml/body/process/processState

Process exception

Exception or reason code.

/aml/body/process/exception

Smart Call Home CLI commands

Cisco Nexus 7000 Series NX-OS System Management Command Reference

VDCs and VRFs

Cisco Nexus 7000 Series NX-OS Virtual Device Context Configuration Guide

No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.

—

• CISCO-CALLHOME-MIB

To locate and download MIBs, go to the following URL:

http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml