Information About Smart Call Home
This section includes the following topics:
Smart Call Home Overview
Smart Call Home provides an e-mail-based notification for critical system policies. A range of message formats are available for compatibility with pager services, standard e-mail, or XML-based automated parsing applications. You can use this feature to page a network support engineer, e-mail a Network Operations Center, or use Cisco Smart Call Home services to automatically generate a case with the Technical Assistance Center.
Smart Call Home provides the following:
- Automatic execution and attachment of relevant CLI command output.
- Multiple message format options such as the following:
– Short Text—Suitable for pagers or printed reports.
– Full Text—Fully formatted message information suitable for human reading.
– XML—Machine-readable format that uses Extensible Markup Language (XML) and Adaptive Messaging Language (AML) XML schema definition (XSD). The AML XSD is published on the Cisco.com website at http://www.cisco.com/. The XML format enables communication with the Cisco Systems Technical Assistance Center.
- Multiple concurrent message destinations. You can configure up to 50 e-mail destination addresses for each destination profile.
Destination Profiles
A destination profile includes the following information:
- One or more alert groups—The group of alerts that trigger a specific Smart Call Home message if the alert occurs.
- One or more e-mail destinations—The list of recipients for the Smart Call Home messages generated by alert groups assigned to this destination profile.
- Message format—The format for the Smart Call Home message (short text, full text, or XML).
- Message severity level—The Smart Call Home severity level that the alert must meet before Cisco NX-OS generates a Smart Call Home message to all e-mail addresses in the destination profile. For more information about Smart Call Home severity levels, see the “Smart Call Home Message Urgency Levels” section. Cisco NX-OS does not generate an alert if the Smart Call Home severity level of the alert is lower than the message severity level set for the destination profile.
You can also configure a destination profile to allow periodic inventory update messages by using the inventory alert group that will send out periodic messages daily, weekly, or monthly.
Cisco NX-OS supports the following predefined destination profiles:
- CiscoTAC-1—Supports the Cisco-TAC alert group in XML message format. This profile is preconfigured with the callhome@cisco.com e-mail contact, maximum message size, and message severity level 0. You cannot change any of the default information for this profile.
- full-text-destination—Supports the full text message format.
- short-text-destination—Supports the short text message format.
See the “Message Formats” section for more information about the message formats.
Smart Call Home Alert Groups
An alert group is a predefined subset of Smart Call Home alerts that are supported in all Cisco NX-OS devices. Alert groups allow you to select the set of Smart Call Home alerts that you want to send to a predefined or custom destination profile. Cisco NX-OS sends Smart Call Home alerts to e-mail destinations in a destination profile only if that Smart Call Home alert belongs to one of the alert groups associated with that destination profile and if the alert has a Smart Call Home message severity at or above the message severity set in the destination profile (see the “Smart Call Home Message Urgency Levels” section).
Table 9-1 lists supported alert groups and the default CLI command output included in Smart Call Home messages generated for the alert group.
Table 9-1 Alert Groups and Executed Commands
|
|
|
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 |
Smart Call Home maps the syslog severity level to the corresponding Smart Call Home severity level for syslog port group messages (see the “Smart Call Home Message Urgency Levels” section).
You can customize predefined alert groups to execute additional CLI show commands when specific events occur and send that show output with the Smart Call Home message.
You can add show commands only to full text and XML destination profiles. Short text destination profiles do not support additional show commands because they only allow 128 bytes of text.
Smart Call Home Message Urgency Levels
Smart Call Home allows you to filter messages based on urgency. You can associate each predefined or user-defined destination profile with a Smart Call Home threshold from 0 (least urgent) to 9 (most urgent). The default is 0 (all messages are sent).
Syslog severity levels are mapped to the Smart Call Home message level.
Note Smart Call Home does not change the syslog message level in the message text. The syslog messages in the Smart Call Home log appear as they are described in the Cisco NX-OS System Messages Reference.
Table 9-2 lists each Smart Call Home message level keyword and the corresponding syslog level for the syslog port alert group.
Table 9-2 Severity and syslog Level Mapping
|
|
|
|
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. |
Obtaining Smart Call Home
If you have a service contract directly with Cisco, you can register for the Smart Call Home service. Smart Call Home analyzes Smart Call Home messages and provides background information and recommendations. For known issues, particularly online diagnostics failures, Automatic Service Requests are generated with the Cisco TAC.
Smart Call Home offers the following features:
- Continuous device health monitoring and real-time diagnostic alerts.
- Analysis of Smart Call Home messages and, if needed, Automatic Service Request generation, routed to the correct TAC team, including detailed diagnostic information to speed problem resolution.
- Secure message transport directly from your device or through an HTTP proxy server or a downloadable Transport Gateway (TG). You can use a TG aggregation point to support multiple devices or in cases where security dictates that your devices may not be connected directly to the Internet.
- Web-based access to Smart Call Home messages and recommendations, inventory, and configuration information for all Smart Call Home devices. Provides access to associated field notices, security advisories, and end-of-life information.
You need the following information to register:
- The SMARTnet contract number for your device
- Your e-mail address
- Your Cisco.com ID
For more information about Smart Call Home, see the following Smart Call Home page:
http://www.cisco.com/go/smartcall/
Distributing Smart Call Home Using CFS
You can use Cisco Fabric Services (CFS) to distribute a Smart Call Home configuration to all CFS-enabled devices in the network. The entire Smart Call Home configuration is distributed except the device priority and the sysContact names.
For more information about CFS, see the “Configuring CFS” section.
Database Merge Guidelines
When merging two Smart Call Home databases, the following guidelines apply:
- The merged database contains the following information:
– A superset of all the destination profiles from the merging devices.
– The destination profile e-mail addresses and alert groups.
– Other configuration information (for example, message throttling, or periodic inventory) present in the managing device.
- Destination profile names cannot be duplicated within the merging devices—even though the configurations are different, the names cannot be duplicated. If a profile name is duplicated, one of the duplicate profiles must first be deleted or the merger fails.
High Availability
Stateless restarts are supported for Smart Call Home. After a reboot or supervisor switchover, the running configuration is applied.
Virtualization Support
One instance of Smart Call Home is supported per virtual device context (VDC). Smart Call Home uses the contact information from the first registered VDC as the administrator contact for all VDCs on the physical device. For example, if you want the Smart Call Home to use the contact information from the default VDC, you should register using that VDC. You can update this information at the Smart Call Home web site at the following URL:
http://www.cisco.com/go/smartcall/
Smart Call Home registers the contacts for all other VDCs as users that can see all the Smart Call Home data for the physical device but cannot act as administrators. All registered users and the registered administrator receive all Smart Call Home notifications from all VDCs on the physical device.
By default, you are placed in the default VDC. In the default VDC, you can test Smart Call Home using the callhome send and callhome test commands. In a nondefault VDC, only the callhome test command is available. For more information on VDCs, see the Cisco Nexus 7000 Series NX-OS Virtual Device Context Configuration Guide.
Smart Call Home is virtual routing and forwarding (VRF) aware. You can configure Smart Call Home to use a particular VRF to reach the Smart Call Home SMTP server.
Configuring Smart Call Home
Note If you distribute the Smart Call Home configuration using CFS, see the “Configuring CFS” section.
This section includes the following topics:
Note Be aware that the Cisco NX-OS commands may differ from the Cisco IOS commands.
We recommend that you complete the Smart Call Home configuration procedures in the following sequence:
1. Configuring Contact Information
2. Creating a Destination Profile
3. Associating an Alert Group and a Destination Profile
4. (Optional) Adding show Commands to an Alert Group
5. (Optional) Creating and Distributing a CFS Configuration
6. Enabling or Disabling Smart Call Home
7. (Optional) Testing Smart Call Home Communications
Configuring Contact Information
You can configure the contact information for Smart Call Home.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. snmp-server contact sys-contact
3. callhome
4. email-contact email-address
5. phone-contact international-phone-number
6. streetaddress address
7. contract-id contract-number
8. customer-id customer-number
9. site-id site-number
10. switch-priority number
11. commit
12. show callhome
13. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to configure the contact information for Smart Call Home:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# snmp-server contact personname@companyname.com
switch(config)# callhome
switch(config-callhome)# email-contact admin@Mycompany.com
switch(config-callhome)# phone-contact +1-800-123-4567
switch(config-callhome)# streetaddress 123 Anystreet st. Anytown,AnyWhere
switch(config-callhome)# commit
Creating a Destination Profile
You can create a user-defined destination profile and configure its message format.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC (or use the switchto vdc command).
SUMMARY STEPS
1. config t
2. callhome
3. destination-profile name
4. destination-profile name format { XML | full-txt | short-txt }
5. commit
6. show callhome destination-profile [ profile name ]
7. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to create a destination profile for Smart Call Home:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# destination-profile Noc101
switch(config-callhome)# destination-profile Noc101 format full-text
switch(config-callhome)# commit
Modifying a Destination Profile
You can modify the following attributes for a predefined or user-defined destination profile:
- Destination e-mail address—E-mail address that defines where alerts should be sent.
- Destination URL—HTTP or HTTPS URL that defines where alerts should be sent.
- Transport method—E-mail or HTTP transport that determines which type of destination addresses are used.
- Message formatting—Message format used for sending the alert (full text, short text, or XML).
- Message level—Smart Call Home message severity level for this destination profile.
- Message size—Allowed length of a Smart Call Home message sent to destination addresses in this destination profile.
See the “Associating an Alert Group and a Destination Profile” section for information on configuring an alert group for a destination profile.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. callhome
3. destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } email-addr address
4. destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } http address
5. destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } transport-method { email | http }
6. destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } message-level number
7. destination-profile { name | CiscoTAC-1 | full-txt-destination | short-txt-destination } message-size number
8. commit
9. show callhome destination-profile [ profile name ]
10. copy running-config startup-config
DETAILED STEPS
|
|
|
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.
Tip You can configure up to 50 e-mail addresses in a 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. |
This example shows how to modify a destination profile for Smart Call Home:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# destination-profile full-text-destination email-addr person@place.com
switch(config-callhome)# destination-profile full-text-destination message-level 5
switch(config-callhome)# destination-profile full-text-destination message-size 10000
switch(config-callhome)# commit
Associating an Alert Group and a Destination Profile
You can associate one or more alert groups with a destination profile.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. callhome
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 }
4. commit
5. show callhome destination-profile [ profile name ]
6. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to associate all alert groups with the destination profile Noc101:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# destination-profile Noc101 alert-group All
switch(config-callhome)# commit
Adding show Commands to an Alert Group
You can assign a maximum of five user-defined CLI show commands to an alert group.
Note You cannot add user-defined CLI show commands to the CiscoTAC-1 destination profile.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. callhome
3. alert-group { Configuration | Diagnostic | EEM | Environmental | Inventory | License | Linecard-Hardware | Supervisor-Hardware | Syslog-group-port | System | Test } user-def-cmd show-cmd
4. commit
5. show call-home user-def-cmds
6. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to add the show ip route command to the Cisco-TAC alert group:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# alert-group Configuration user-def-cmd show ip route
switch(config-callhome)# commit
Configuring E-Mail
You must configure the SMTP server address for the Smart Call Home functionality to work. You can also configure the from and reply-to e-mail addresses.
You can configure up to five SMTP servers for Smart Call Home. The servers are tried based on their priority. The highest priority server is tried first. If the message fails to be sent, the next server in the list is tried until the limit is exhausted. If two servers have equal priority, the one that was configured earlier is tried first.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. callhome
3. transport email mail-server ip-address [ port number ] [ priority number ] [ use-vrf vrf-name ]
4. transport email from email-address
5. transport email reply-to email-address
6. commit
7. show callhome transport
8. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to configure the e-mail options for Smart Call Home messages:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# transport email mail-server 192.0.2.10 use-vrf Red
switch(config-callhome)# transport email from person@company.com
switch(config-callhome)# transport email reply-to person@company.com
switch(config-callhome)# commit
This example shows how to configure multiple SMTP servers for Smart Call Home messages:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# transport email mail-server 192.0.2.10 priority 4
switch(config-callhome)# transport email mail-server 172.21.34.193
switch(config-callhome)# transport email smtp-server 10.1.1.174
switch(config-callhome)# transport email mail-server 64.72.101.213 priority 60
switch(config-callhome)# transport email from person@company.com
switch(config-callhome)# transport email reply-to person@company.com
switch(config-callhome)# commit
Based on the configuration above, the SMTP servers would be tried in this order:
10.1.1.174 (priority 0)
192.0.2.10 (priority 4)
172.21.34.193 (priority 50, which is the default)
64.72.101.213 (priority 60)
When CFS distribution is enabled, devices that run Release 4.2 or earlier accept only the transport email smtp-server command configurations while devices that run Release 5.0(1) or later accept both the transport email smtp-server and transport email mail-server command configurations.
Note When a device accepts both the transport email smtp-server and transport email mail-server commands, the transport email smtp-server command has a priority of 0, which is the highest. The server specified by this command is tried first followed by the servers specified by the transport email mail-server commands in order of priority.
Configuring VRFs To Send Messages Using HTTP
You can use VRFs to send Smart Call Home messages over HTTP. If HTTP VRFs are not configured, the default VRF is used to transport messages over HTTP.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. callhome
3. transport http use-vrf vrf-name
4. commit
5. show callhome
6. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to configure a VRF to send Smart Call Home messages using HTTP:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# transport http use-vrf Blue
switch(config-callhome)# commit
Configuring an HTTP Proxy Server
Beginning with Cisco NX-OS Release 5.2, you can configure Smart Call Home to send HTTP messages through an HTTP proxy server. If you do not configure an HTTP proxy server, Smart Call Home sends HTTP messages directly to the Cisco Transport Gateway (TG).
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. callhome
3. transport http proxy server ip-address [ port number ]
4. transport http proxy enable
5. commit
6. show callhome transport
7. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to configure Smart Call Home to send HTTP messages through an HTTP proxy server:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# transport http proxy server 10.10.10.1 port 4
switch(config-callhome)# transport http proxy enable
switch(config-callhome)# commit
Configuring Periodic Inventory Notifications
You can configure your device to periodically send a message with an inventory of all software services currently enabled and running on the device along with hardware inventory information. Cisco NX-OS generates two Smart Call Home notifications, periodic configuration messages and periodic inventory messages.
BEFORE YOU BEGIN
Make sure that you are in the correct VDC. To change the VDC, use the switchto vdc command.
SUMMARY STEPS
1. config t
2. callhome
3. periodic-inventory notification [ interval days | timeofday time ]
4. commit
5. show callhome
6. copy running-config startup-config
DETAILED STEPS
|
|
|
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. |
This example shows how to configure the periodic inventory messages to generate every 20 days:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# periodic-inventory notification interval 20
switch(config-callhome)# commit
Disabling Duplicate Message Throttle
You can limit the number of duplicate messages received for the same event. By default, Cisco NX-OS limits the number of duplicate messages received for the same event. If the number of duplicate messages sent exceeds 30 messages within a 2-hour time frame, then Cisco NX-OS disables further messages for that alert type.
Use the following commands in Smart Call Home configuration mode to disable duplicate message throttling:
|
|
|
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. |
Enabling or Disabling Smart Call Home
Once you have configured the contact information, you can enable the Smart Call Home function.
Use the following commands in Smart Call Home configuration mode to enable Smart Call Home:
|
|
|
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. |
Testing Smart Call Home Communications
You can generate a test message to test your Smart Call Home communications.
Use the following commands in any mode to generate a test Smart Call Home message:
|
|
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. |