- Device Manager Help
- Configuring Cisco DCNM-SAN Server
- Configuring Authentication in Cisco DCNM-SAN
- Configuring Cisco DCNM-SAN Client
- Device Manager
- Configuring Performance Manager
- Configuring High Availability
- Configuring Trunking
- Configuring PortChannels
- Configuring N Port Virtualization
- Configuring Interfaces
- Configuration of Fibre Channel Interfaces
- Using the CFS Infrastructure
- Configuring SNMP
- Configuring Domain Parameters
- Configuring and Managing Zones
- Configuring FCoE
- Configuring Dense Wavelength Division Multiplexing
- Configuring and Managing VSANs
- Discovering SCSI Targets
- Configuring SAN Device Virtualization
- Configuring Fibre Channel Routing Services and Protocols
- Managing FLOGI, Name Server, FDMI, and RSCN Databases
- Configuring FICON
- Creating Dynamic VSANs
- Distributing Device Alias Services
- Configuring Advanced Fabric Features
- Configuring Users and Common Role
- Configuring Security Features on an External AAA Server
- Configuring Certificate Authorities and Digital Certificates
- Configuring FC-SP and DHCHAP
- Configuring Cisco TrustSec Fibre Channel Link Encryption
- Configuring FIPS
- Configuring IPv4 and IPv6 Access Control Lists
- Configuring IPsec Network Security
- Configuring Port Security
- Configuring Fabric Binding
- Configuring FCIP
- Configuring the SAN Extension Tuner
- Configuring iSCSI
- Configuring IP Services
- Configuring IP Storage
- Configuring IPv4 for Gigabit Ethernet Interfaces
- Configuring IPv6 for Gigabit Ethernet Interfaces
- Configuring SCSI Flow Services
- Configuring SCSI Flow Statistics
- Configuring Fibre Channel Write Acceleration
- Monitoring the Network
- Monitoring Performance
- Configuring Call Home
- Configuring System Message Logging
- Scheduling Maintenance Jobs
- Configuring RMON
- Configuring Fabric Configuration Server
- Monitoring Network Traffic Using SPAN
- Monitoring System Processes and Logs
- Configuring QoS
- Configuring Port Tracking
- Configuring FlexAttach Virtual pWWN
- Configuring Interface Buffers
- Verifying Ethernet Interfaces
- Information About Call Home
- Call Home Features
- About Smart Call Home
- Call Home Destination Profiles
- Call Home Alert Groups
- Call Home Message Level Feature
- Syslog-Based Alerts
- RMON-Based Alerts
- General E-Mail Options Using HTTPS Support
- Multiple SMTP Server Support
- Periodic Inventory Notification
- Duplicate Message Throttle
- Call Home Configuration Distribution
- Fabric Lock Override
- Clearing Call Home Name Server Database
- EMC E-mail Home Delayed Traps
- Event Triggers
- Call Home Message Levels
- Message Contents
- Guidelines and Limitations
- Default Settings
- Configuring Call Home
- Task Flow for Configuring Call Home
- Configuring Contact Information
- Enabling Call Home Function
- Configuring Destination Profiles
- Associating an Alert Group
- Customizing Alert Group Messages
- Configuring Event Trap Notifications
- Configuring General E-Mail Options
- Configuring HTTPS Support
- Enable or Disable Transport Method
- Configuring an HTTP Proxy Server
- Configuring Call Home Wizard
- Configuring SMTP Server and Ports
- Configuring Multiple SMTP Server Support
- Enabling Periodic Inventory Notifications
- Configuring Duplicate Message Throttle
- Enabling Call Home Fabric Distribution
- Fabric Lock Override
- Call Home Communications Test
- Configuring Delayed Traps
- Enabling Delayed Traps Using Cisco Device Manager
- Viewing Event Filter Notification
- Verifying Call Home Configuration
- Monitoring Call Home
- Field Descriptions for Call Home
- Call Home General
- Call Home Destinations
- Call Home SMTP Servers
- Call Home E-mail Setup
- Call Home Alerts
- Call Home User Defined Command
- Delayed Traps
- Call Home Profiles
- Event Destinations Addresses
- Event Destinations Security (Advanced)
- Event Filters General
- Event Filters Interfaces
- Event Filters Control
- Additional References
- Feature History for Call Home
Configuring Call Home
Call Home provides e-mail-based notification of critical system events. A versatile range of message formats are available for optimal compatibility with pager services, standard e-mail, or XML-based automated parsing applications.
Note Cisco Autonotify is upgraded to a new capability called Smart Call Home. Smart Call Home has significant functionality improvement over Autonotify and is available across the Cisco product range. For detailed information on Smart Call Home, see the Smart Call Home page at this location: http://www.cisco.com/go/smartcall/
Information About Call Home
The Call Home feature provides message throttling capabilities. Periodic inventory messages, port syslog messages, and RMON alert messages are added to the list of deliverable Call Home messages. If required you can also use the Cisco Fabric Services application to distribute the Call Home configuration to all other switches in the fabric.
The Call Home service provides e-mail-based notification of critical system events. A versatile range of message formats are available for optimal compatibility with pager services, standard e-mail, or XML-based automated parsing applications.
Common features may include the following:
- Paging the network support engineer
- E-mailing the Network Operations Center
- Raising a direct case with the Technical Assistance Center
The Call Home functionality is available directly through the Cisco MDS 9000 Family switches and the Cisco Nexus 5000 Series switches. It provides multiple Call Home messages, each with separate potential destinations. You can define your own destination profiles in addition to predefined profiles; you can configure up to 50 e-mail addresses for each destination profile. Flexible message delivery and format options make it easy to integrate specific support requirements.
The Call Home feature offers the following advantages:
- Fixed set of predefined alerts for trigger events on the switch.
- Automatic execution and attachment of relevant command output.
This section includes the following topics:
- Call Home Features
- About Smart Call Home
- Call Home Destination Profiles
- Call Home Alert Groups
- Call Home Message Level Feature
- Syslog-Based Alerts
- RMON-Based Alerts
- General E-Mail Options Using HTTPS Support
- Multiple SMTP Server Support
- Periodic Inventory Notification
- Duplicate Message Throttle
- Call Home Configuration Distribution
- Fabric Lock Override
- Clearing Call Home Name Server Database
- EMC E-mail Home Delayed Traps
- Event Triggers
- Call Home Message Levels
- Message Contents
Call Home Features
The Call Home functionality is available directly through the Cisco MDS 9000 Family switches and the Cisco Nexus 5000 Series switches. It provides multiple Call Home profiles (also referred to as Call Home destination profiles ), each with separate potential destinations. You can define your own destination profiles in addition to predefined profiles.
The Call Home function can even leverage support from Cisco Systems or another support partner. Flexible message delivery and format options make it easy to integrate specific support requirements.
The Call Home feature offers the following advantages:
- Fixed set of predefined alerts and trigger events on the switch.
- Automatic execution and attachment of relevant command output.
- Multiple message format options:
– Short Text—Suitable for pagers or printed reports.
– Plain Text—Full formatted message information suitable for human reading.
– XML—Matching readable format using Extensible Markup Language (XML) and document type definitions (DTDs) named Messaging Markup Language (MML). The MML DTD 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.
- Multiple message categories including system, environment, switching module hardware, supervisor module, hardware, inventory, syslog, RMON, and test.
- Secure messages 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 requires that your devices not be connected directly to the Internet.
About Smart Call Home
Smart Call Home is a component of Cisco SMARTnet Service that offers proactive diagnostics, real-time alerts, and personalized web-based reports on select Cisco devices.
Smart Call Home provides fast resolution of system problems by analyzing Call Home messages sent from your devices and providing a direct notification path to Cisco customer support.
Smart Call Home offers the following features:
- Continuous device health monitoring and real-time diagnostics alerts.
- Analysis of Call Home messages from your device and where appropriate, automatic service request generation, routed to the appropriate TAC team, including detailed diagnostic information to speed problem resolution.
- Web-based access to Call Home messages and recommendations, inventory and configuration information for all Call Home devices. Provides access to associated Field Notices, Security Advisories and End-of-Life Information.
Table 50-1 lists the benefits of Smart Call Home.
Obtaining Smart Call Home
If you have a service contract directly with Cisco Systems, you can receive automatic case generation from the Technical Assistance Center by registering with the Smart Call Home service.
You need the following items to register:
For detailed information on Smart Call Home, including quick start configuration and registration steps, see the Smart Call Home page at this location:
Call Home Destination Profiles
A destination profile contains the required delivery information for an alert notification. Destination profiles are typically configured by the network administrator.
Using alert groups you can select the set of Call Home alerts to be received by a destination profile (predefined or user defined). Alert groups are predefined subsets of Call Home alerts supported in all switches in the Cisco MDS 9000 Family and the Cisco Nexus 5000 Series. Different types of Call Home alerts are grouped into different alert groups depending on their type. You can associate one or more alert groups to each profile as required by your network.
Call Home Alert Groups
An alert group is a predefined subset of Call Home alerts supported in all switches in the Cisco MDS 9000 Family and Cisco Nexus 5000 Series. Alert groups allow you to select the set of Call Home alerts to be received by a destination profile (predefined or user-defined). A Call Home alert is sent to e-mail destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile.
Using the predefined Call Home alert groups you can generate notification messages when certain events occur on the switch. You can customize predefined alert groups to execute additional show commands when specific events occur and to notify you of output other than from the predefined show commands.
Customized Alert Group Messages
An alert group is a predefined subset of Call Home alerts supported in all switches in the Cisco MDS 9000 Family and Cisco Nexus 5000 Series switches. Alert groups allow you to select the set of Call Home alerts to be received by a destination profile (predefined or user-defined). The predefined Call Home alert groups generate notification messages when certain events occur on the switch. You can customize predefined alert groups to execute additional show commands when specific events occur.
The output from these additional show commands is included in the notification message along with the output of the predefined show commands.
Call Home Message Level Feature
The Call Home message level feature allows you to filter messages based on their level of urgency. Each destination profile (predefined and user-defined) is associated with a Call Home message level threshold. Any message with a value lower than the urgency threshold is not sent. Call Home severity levels are not the same as system message logging severity levels.
Syslog-Based Alerts
You can configure the switch to send certain syslog messages as Call Home messages. The messages are sent based on the mapping between the destination profile and the alert group mapping, and on the severity level of the generated syslog message.
To receive a syslog-based Call Home alert, you must associate a destination profile with the syslog alert groups (currently there is only one syslog alert group—syslog-group-port) and configure the appropriate message level.
The syslog-group-port alert group selects syslog messages for the port facility. The Call Home application maps the syslog severity level to the corresponding Call Home severity level (see the “Call Home Message Levels” section). For example, if you select level 5 for the Call Home message level, syslog messages at levels 0, 1, and 2 are included in the Call Home log.
Whenever a syslog message is generated, the Call Home application sends a Call Home message depending on the mapping between the destination profile and the alert group mapping and based on the severity level of the generated syslog message. To receive a syslog-based Call Home alert, you must associate a destination profile with the syslog alert groups (currently there is only one syslog alert group—syslog-group-port) and configure the appropriate message level (see the “Call Home Message Levels” section).
Note Call Home does not change the syslog message level in the message text. The syslog message texts in the Call Home log appear as they are described in the Cisco MDS 9000 Family and Nexus 7000 Series System Messages Reference.
RMON-Based Alerts
You can configure the switch to send Call Home notifications corresponding to RMON alert triggers. All RMON-based Call Home messages have their message level set to NOTIFY (2). The RMON alert group is defined for all RMON-based Call Home alerts. To receive an RMON-based Call Home alert, you must associate a destination profile with the RMON alert group.
General E-Mail Options Using HTTPS Support
The HTTPS support for Call Home provides a transport method called HTTP. HTTPS support is used for a secure communication, and HTTP is used for nonsecure communication. You can configure an HTTP URL for the Call Home destination profile as a destination. The URL link can be from a secure server or nonsecure server. For a destination profile configured with the HTTP URL, the Call Home message is posted to the HTTP URL link.
Note The Call Home HTTP configuration can be distributed over CFS on the switches running NX-OS Release 4.2(1) and later. The Call Home HTTP configuration cannot be distributed to switches that support the nondistributable HTTP configuration. Switches running lower versions than NX-OS Release 4.2(1) and later will ignore the HTTP configuration.
Multiple SMTP Server Support
Cisco MDS NX-OS and Cisco NX-OS 5000 Series switches support multiple SMTP servers for Call Home. Each SMTP server has a priority configured between 1 and 100, with 1 being the highest priority and 100 being the lowest. If the priority is not specified, a default value of 50 is used.
You can configure up to five SMTP servers for Call Home. The servers are contacted based on their priority. The highest priority server is contacted first. If the message fails to be sent, the next server in the list is contacted until the limit is exhausted. If two servers have equal priority, the one that was configured earlier is contacted.
If a high-priority SMTP server fails, the other servers will be contacted. A time delay may occur while sending a message. The delay is minimal if the attempt to send the message through the first SMTP server is successful. The delay may increase depending on the number of unsuccessful attempts with different SMTP servers.
Note The new configuration process is not related to the old configuration. However, if the SMTP servers are configured using both the old and new schemes, the older configuration is of the highest priority.
Multiple SMTP servers can be configured on any MDS 9000 Family switch, Cisco Nexus 5000 Series switches, and Cisco Nexus 7000 Series switches running Release 5.0(1a) or later.
The new configuration will only be distributed to switches that have multiple SMTP servers. The older switches in the fabric will ignore the new configuration received over CFS.
In a mixed fabric that has CFS enabled, the switches running NX-OS Release 5.0 can configure new functionalities and distribute the new configuration to other switches with Release 5.0 in the fabric over CFS. However, if an existing switch running NX-OS Release 4.x upgrades to Release 5.0, the new configurations will not be distributed to that switch as a CFS merge is not triggered on an upgrade. There are two options to upgrade:
Periodic Inventory Notification
You can configure the switch to periodically send a message with an inventory of all software services currently enabled and running on the switch along with hardware inventory information. The inventory is modified each time the switch is restarted nondisruptively.
Duplicate Message Throttle
You can configure a throttling mechanism to limit the number of Call Home messages received for the same event. If the same message is sent multiple times from the switch within a short period of time, you may be swamped with a large number of duplicate messages.
Call Home Configuration Distribution
You can enable fabric distribution for all Cisco MDS 9000 Family switches and Cisco Nexus 5000 Series switches in the fabric. When you perform Call Home configurations, and distribution is enabled, that configuration is distributed to all the switches in the fabric. However, the switch priority and the Syscontact names are not distributed.
You automatically acquire a fabric-wide lock when you enter the first configuration command operation after you enable distribution in a switch. The Call Home application uses the effective and pending database model to store or commit the configuration changes. When you commit the configuration changes, the effective database is overwritten by the configuration changes in the pending database and all the switches in the fabric receive the same configuration. After making the configuration changes, you can choose to discard the changes by aborting the changes instead of committing them. In either case, the lock is released. See Chapter 13, “Using the CFS Infrastructure” for more information on the CFS application.
Note The switch priority and the Syscontact name are not distributed.
Fabric Lock Override
If you have performed a Call Home task and have forgotten to release the lock by either committing or discarding the changes, an administrator can release the lock from any switch in the fabric. If the administrator performs this task, your changes to the pending database are discarded and the fabric lock is released.
Tip The changes are only available in the volatile directory and are subject to being discarded if the switch is restarted.
Clearing Call Home Name Server Database
When the Call Home name server database is full, a new entry cannot be added. The device is not allowed to come online. To clear the name server database, increase the database size or perform a cleanup by removing unused devices. A total of 20,000 name server entries are supported.
EMC E-mail Home Delayed Traps
DCNM-SAN can be configured to generate EMC E-mail Home XML e-mail messages. In SAN-OS Release 3.x or earlier, DCNM-SAN listens to interface traps and generates EMC E-mail Home e-mail messages. Link traps are generated when an interface goes to down from up or vice versa. For example, if there is a scheduled server reboot, the link goes down and DCNM-SAN generates an e-mail notification.
Cisco NX-OS Release 4.1(3) provides the ability to generate a delayed trap so that the number of generated e-mail messages is reduced. This method filters server reboots and avoids generating unnecessary EMC E-mail Home e-mail messages. In NX-OS Release 4.1(3), users have the ability to select the current existing feature or this new delayed trap feature.
Event Triggers
This section discusses Call Home trigger events. Trigger events are divided into categories, with each category assigned CLI commands to execute when the event occurs. The command output is included in the transmitted message. Table 50-2 lists the trigger events.
Call Home Message Levels
Call Home messages (sent for syslog alert groups) have the syslog severity level mapped to the Call Home message level (see the “Syslog-Based Alerts” section).
This section discusses the severity levels for a Call Home message when using one or more switches in the Cisco MDS 9000 Family and the Cisco Nexus 5000 Series. Call Home message levels are preassigned per event type.
Severity levels range from 0 to 9, with 9 having the highest urgency. Each syslog level has keywords and a corresponding syslog level.
Note Call Home does not change the syslog message level in the message text. The syslog message texts in the Call Home log appear as they are described in the Cisco MDS 9000 Family and Nexus 7000 Series System Messages Reference.
Note Call Home severity levels are not the same as system message logging severity levels (see the Cisco MDS 9000 Family and Nexus 7000 Series System Messages Reference).
Message Contents
The following contact information can be configured on the switch:
- Name of the contact person
- Phone number of the contact person
- E-mail address of the contact person
- Mailing address to which replacement parts must be shipped, if required
- Site ID of the network where the site is deployed
- Contract ID to identify the service contract of the customer with the service provider
Table 50-5 describes the short text formatting option for all message types.
Table 50-6 , Table 50-7 , and Table 50-8 display the information contained in plain text and XML messages.
Date and time stamp of event in ISO time notation: YYYY-MM-DD T HH:MM:SS . Note The time zone or daylight savings time (DST) offset from UTC has already been added or subtracted. T is the hardcoded limiter for the time. |
||
Name of message. Specific event names are listed in the “Event Triggers” section. |
||
Unique device identifier (UDI) for end device generating message. This field should empty if the message is non-specific to a fabric switch. Format is type @ Sid @ seria l, where: |
||
Optional user-configurable field used for contract info or other ID by any support service. |
||
Optional user-configurable field used for contract info or other ID by any support service. |
||
Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service. |
||
If the message is generated from the fabric switch, it is the unique device identifier (UDI) of the switch. Format is type @ Sid @ seria l, where: |
||
Node that experienced the event. This is the host name of the device. |
||
Name of person to contact for issues associated with the node experiencing the event. |
||
E-mail address of person identified as contact for this unit. |
||
Phone number of the person identified as the contact for this unit. |
/mml/body/sysContactPhoneNumber - ch:SystemInfo/ContactPhoneNumber |
|
Optional field containing street address for RMA part shipments associated with this unit. |
||
Model name of the switch. This is the specific model as part of a product family name. |
||
/mml/body/fru/slot - rme:chassis/Card/LocationWithinContainer |
||
/mml/attachments/attachment/name - aml-block:Attachment/Name |
||
/mml/attachments/attachment/type - aml-block:Attachment type |
||
/mml/attachments/attachment/mime - aml-block:Attachment/Data encoding |
||
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
Date and time stamp of event in ISO time notation: YYYY-MM-DD T HH:MM:SS . Note The time zone or daylight savings time (DST) offset from UTC has already been added or subtracted. T is the hardcoded limiter for the time. |
||
Name of message. Specifically “Inventory Update” Specific event names are listed in the “Event Triggers” section. |
||
Unique Device Identifier (UDI) for end device generating message. This field should empty if the message is non-specific to a fabric switch. Format is type @ Sid @ seria l, where: |
||
Optional user-configurable field used for contact info or other ID by any support service. |
||
Optional user-configurable field used for contact info or other ID by any support service. |
||
Optional user-configurable field, can be used for Cisco-supplied site ID or other data meaningful to alternate support service. |
||
If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch. Format is type @ Sid @ seria l, where: |
||
Name of person to contact for issues associated with the node experiencing the event. |
||
E-mail address of person identified as contact for this unit. |
/mml/body/sysContacte-mail - ch-inv:SystemInfo/Contacte-mail |
|
Phone number of the person identified as the contact for this unit. |
/mml/body/sysContactPhoneNumber - ch-inv:SystemInfo/ContactPhoneNumber |
|
Optional field containing street address for RMA part shipments associated with this unit. |
/mml/body/sysStreetAddress - ch-inv:SystemInfo/StreetAddress |
|
Model name of the unit. This is the specific model as part of a product family name. |
||
/mml/body/fru/slot - rme:chassis/Card/LocationWithinContainer |
||
/mml/attachments/attachment/name - aml-block:Attachment/Name |
||
/mml/attachments/attachment/type - aml-block:Attachment type |
||
/mml/attachments/attachment/mime - aml-block:Attachment/Data encoding |
||
Output of command automatically executed after event categories (see “Event Triggers” section). |
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
Date and time stamp of event in ISO time notation: YYYY-MM-DD T HH:MM:SS . Note The time zone or daylight savings time (DST) offset from UTC has already been added or subtracted. T is the hardcoded limiter for the time. |
||
Name of message. Specifically test message for test type message. Specific event names listed in the “Event Triggers” section). |
||
This field should be ignored by the receiving Call Home processing application, but may be populated with either “proactive” or “reactive.” |
||
Unique device identifier (UDI) for end device generating message. This field should empty if the message is nonspecific to a fabric switch. Format is type @ Sid @ seria l, where: |
||
Optional user-configurable field used for contract info or other ID by any support service. |
||
Optional user-configurable field used for contract info or other ID by any support service. |
||
Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service. |
||
If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch. Format is type @ Sid @ seria l, where: |
||
Name of person to contact for issues associated with the node experiencing the event. |
||
E-mail address of person identified as contact for this unit. |
||
Phone number of the person identified as the contact for this unit. |
/mml/body/sysContactPhoneNumber - ch:SystemInfo/ContactPhoneNumber |
|
Optional field containing street address for RMA part shipments associated with this unit. |
||
Model name of the switch. This is the specific model as part of a product family name. |
||
Top assembly number of the chassis. For example, 800-xxx-xxxx. |
||
Output of command automatically executed after event categories. |
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
|
/mml/attachments/attachment/mime - aml-block:Attachment/Data encoding |
||
/mml/attachments/attachment/type - aml-block:Attachment type |
||
/mml/attachments/attachment/name - aml-block:Attachment/Name |
Guidelines and Limitations
Call Home Database Merger Guidelines
When merging two Call Home databases, follow these guidelines:
– A superset of all the destination profiles from the dominant and subordinate switches that take part in the merge protocol.
– The e-mail addresses and alert groups for the destination profiles.
– Other configuration information (for example, message throttling, periodic inventory) from the switch that existed in the dominant switch before the merge.
- Verify that two destination profiles do not have the same name (even if they have different configuration information) on the subordinate and dominant switches. If they do contain the same name, the merge operation will fail. You must then modify or delete the conflicting destination profile on the required switch.
See the “CFS Merge Support” section for detailed concepts.
Call Home Configuration Guidelines
When configuring Call Home, follow these guidelines:
- An e-mail server and at least one destination profile (predefined or user-defined) must be configured. The destination profile(s) used depends on whether the receiving entity is a pager, e-mail, or automated service such as Cisco Smart Call Home.
- Switches can forward events (SNMP traps/informs) up to 10 destinations.
- The contact name (SNMP server contact), phone, and street address information must be configured before Call Home is enabled. This configuration is required to determine the origin of messages received.
- The Cisco MDS 9000 Family switch and the Cisco Nexus 5000 Series switch must have IP connectivity to an e-mail server.
- If Cisco Smart Call Home is used, an active service contract must cover the device being configured.
Default Settings
Table 50-9 lists the default Call Home settings.
Configuring Call Home
How you configure the Call Home process depends on how you intend to use the feature.
This section includes the following topics:
- Task Flow for Configuring Call Home
- Enabling Call Home Function
- Configuring Destination Profiles
- Associating an Alert Group
- Customizing Alert Group Messages
- Configuring Event Trap Notifications
- Configuring General E-Mail Options
- Configuring HTTPS Support
- Configuring an HTTP Proxy Server
- Task Flow for Configuring Call Home Wizard
- Launching Call Home Wizard
- Enable or Disable Transport Method
- Enabling Periodic Inventory Notifications
- Configuring Duplicate Message Throttle
- Enabling Call Home Fabric Distribution
- Fabric Lock Override
- Call Home Communications Test
- Configuring Delayed Traps
- Enabling Delayed Traps Using Cisco Device Manager
- Viewing Event Filter Notification
Task Flow for Configuring Call Home
Follow these steps to configure Call Home:
Step 1 Configure contact information.
Step 2 Enable or disable Call Home.
Step 3 Configure destination profiles.
Step 4 Associate one or more alert groups to each profile as required by your network. Customize the alert groups, if desired.
Step 5 Configure e-mail options.
Step 6 Test Call Home messages.
Configuring Contact Information
Switch priority is configured by a user for each switch in the fabric. This priority is used by the operations personnel or TAC support personnel to decide which Call Home message they should respond to first. You can prioritize Call Home alerts of the same severity from each switch.
Prerequisites
- Each switch must include e-mail, phone, and street address information. You can optionally include the contract ID, customer ID, site ID, and switch priority information.
To assign the contact information, follow these steps:
To assign the contact information, follow these steps:
Step 1 Expand Events and select Call Home from the Physical Attributes pane.
You see the Call Home tabs in the Information pane.
Step 2 In Device Manager, click Admin > Events > Call Home.
Step 3 Click the General tab, then assign contact information and enable the Call Home feature. Call Home is not enabled by default. You must enter an e-mail address that identifies the source of Call Home notifications.
Step 4 Click the Destination(s) tab to configure the destination e-mail addresses for Call Home notifications. You can identify one or more e-mail addresses that will receive Call Home notifications.
Note Switches can forward events (SNMP traps/informs) up to 10 destinations.
a. Click the Create tab to create a new destination. You will see the create destination window.
b. Enter the profile name, ID, and type of destination. You can select email or http in the Type field.
If you select email, you can enter the e-mail address in the EmailAddress field. The HttpUrl field is disabled.
If you select http, you can enter the HTTP URL in the HttpUrl field. The EmailAddress field is disabled.
c. Click Create to complete the destination profile creation.
Step 5 Click the e-mail Setup tab to identify the SMTP server. Identify a message server to which your switch has access. This message server will forward the Call Home notifications to the destinations.
Step 6 In DCNM-SAN, click the Apply Changes icon. In Device Manager, click Apply .
Enabling Call Home Function
Once you have configured the contact information, you must enable the Call Home function.
To enable the Call Home function, follow these steps:
Disables the Call Home function. When you disable the Call Home function, all input events are ignored. Note Even if Call Home is disabled, basic information for each Call Home event is sent. |
To enable the Call Home function, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
Step 4 Select a switch in the information pane.
Step 5 Check the Duplicate Message Throttle check box.
Step 6 Click the Apply Changes icon.
Configuring Destination Profiles
A destination profile contains the required delivery information for an alert notification. Destination profiles are typically configured by the network administrator.
You can configure the following attributes for a destination profile:
- Profile name—A string that uniquely identifies each user-defined destination profile and is limited to 32 alphanumeric characters. The format options for a user-defined destination profile are full-txt, short-txt, or XML (default).
- Destination address—The actual address, pertinent to the transport mechanism, to which the alert should be sent.
- Message formatting—The message format used for sending the alert (full text, short text, or XML).
Note If you use the Cisco Smart Call Home service, the XML destination profile is required (see http://www.cisco.com/en/US/partner/products/hw/ps4159/ps4358/products_configuration_example09186a0080108e72.shtml).
Prerequisites
- At least one destination profile is required. You can configure multiple destination profiles of one or more types. You can use one of the predefined destination profiles or define a desired profile. If you define a new profile, you must assign a profile name.
To configure predefined destination profile messaging options, follow these steps:
Note Steps 3, 4, and 5 in this procedure can be skipped or configured in any order.
To configure predefined destination profile messaging options, follow these steps:
Step 1 Expand Events and select Call Home in the Physical Attributes pane.
Note The Destination tab is disabled until you click the Profiles tab. The profiles have to be loaded for the destination tab to be populated.
Step 2 Click the Profiles tab in the Information pane.
You see the Call Home profiles for multiple switches.
Step 3 Set the profile name, message format, message size, and severity level.
Step 4 Click in the Alert Groups column and select or remove an alert group.
Step 5 Click the Apply Changes icon to create this profile on the selected switches.
To configure a new destination-profile (and related parameters), follow these steps:
Note Steps 4, 5, and 6 in this procedure can be skipped or configured in any order.
To configure a new destination-profile (and related parameters), follow these steps:
Step 1 Expand Events and select Call Home in the Physical Attributes pane.
Note The Destination tab is disabled until you click the Profiles tab. The profiles have to be loaded for the destination tab to be populated.
Step 2 Click the Profiles tab in the Information pane.
You see Call Home profiles for multiple switches.
Step 3 Click the Create Row icon to add a new profile.
Step 4 Set the profile name, message format, size, and severity level.
Step 5 Click an alert group and select each group that you want sent in this profile.
Step 6 Click a transport method. You can select email, http or emailandhttp.
Step 7 Click Create to create this profile on the selected switches.
Associating an Alert Group
Different types of Call Home alerts are grouped into different alert groups depending on their type. You can associate one or more alert groups to each profile as required by your network.
The alert group feature allows you to select the set of Call Home alerts to be received by a destination profile (either predefined or user-defined). You can associate multiple alert groups with a destination profile.
Restrictions
- A Call Home alert is sent to e-mail destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile.
To associate an alert group with a destination profile, follow these steps:
To associate an alert group with a destination profile, follow these steps:
Step 1 Expand Events and select Call Home in the Physical Attributes pane.
Step 2 Click the Profiles tab in the Information pane.
You see the Call Home profiles for multiple switches.
Step 3 Click the Alert Groups column in the row for the profile you want to associate.
You see the alert groups drop-down menu.
Step 4 Click an alert group to select it for association.
Step 5 You see a check next to that alert group. To deselect it and remove the check, click it again.
Step 6 Click the Apply Changes icon.
Customizing Alert Group Messages
To assign show commands to be executed when an alert is sent, you must associate the commands with the alert group. When an alert is sent, Call Home associates the alert group with an alert type and attaches the output of the show commands to the alert message.
Note Make sure the destination profiles for a non-Cisco-TAC alert group, with a predefined show command, and the Cisco-TAC alert group are not the same.
Restrictions
- You can assign a maximum of five user-defined show commands to an alert group. Only show commands can be assigned to an alert group.
- Customized show commands are only supported for full text and XML alert groups. Short text alert groups (short-txt-destination) do not support customized show commands because they only allow 128 bytes of text.
To customize Call Home alert group messages, follow these steps:
To customize Call Home alert group messages, follow these steps:
Step 1 Expand Events and select Call Home in the Physical Attributes pane.
Step 2 Click the User Defined Command tab in the Information pane.
You see the User Defined Command information.
Step 3 Click the Create Row icon.
Step 4 Check the check boxes in front of the switches from which you want to receive alerts.
Step 5 Select the alert grouptype from the Alert Group Type drop-down list.
Step 6 Select the ID (1-5) of the CLI command. The ID is used to keep track of the messages.
Step 7 Enter the CLI show command in the CLI Command field.
Step 9 Repeat Steps 3 through 7 for each command you want to associate with the profile.
Step 10 Click Close to close the dialog box.
Restrictions
- The urgency level ranges from 0 (lowest level of urgency) to 9 (highest level of urgency), and the default is 0 (all messages are sent).
To set the message level for each destination profile for Call Home, follow these steps:
To set the message level for each destination profile for Call Home, follow these steps:
Step 1 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
In Device Manager, choose Admin > Events > Call Home.
Step 2 Click the Profiles tab in the Information Pane.
You see the Call Home profiles.
Step 3 Set a message level for each switch using the drop-down menu in the MsgLevel column.
Step 4 Click the Apply Changes icon to save your changes.
Configuring the Syslog-Based Alerts
To configure the syslog-group-port alert group, follow these steps:
To configure the syslog-group-port alert group, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
Step 3 Click the Profiles tab.
You see the Call Home profiles.
Step 4 Click the Create Row icon.
You see the Create Call Home Profile dialog box.
Step 5 Select the switches for which you want to send alerts.
Step 6 Enter the name of the profile in the Name field.
Step 7 Choose the message format, message size, and message severity level.
Step 8 Check the syslogGroupPort check box in the AlertGroups section.
Step 9 Click Create to create the profile for the syslog-based alerts.
Configuring RMON Alerts
To configure RMON alert groups, follow these steps:
To configure RMON alert groups, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
Step 3 Click the Profiles tab.
You see the Call Home profiles.
Step 4 Select the Create Row icon.
You see the Create Call Home Profile dialog box.
Step 5 Select switches to send alerts.
Step 6 Enter the name of the profile.
Step 7 Select the message format, message size, and message severity level.
Step 8 Check the RMON check box in the AlertGroups section.
Step 9 Click Create to create the profile for the RMON-based alerts.
Configuring Event Trap Notifications
To configure a Call Home event notification trap (except Call Home periodic messages), follow these steps:
Configuring General E-Mail Options
You can configure the from, reply-to, and return-receipt e-mail addresses. While most e-mail address configurations are optional, you must configure the SMTP server address for the Call Home functionality to work.
To configure general e-mail options, follow these steps:
To configure general e-mail options, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
Step 3 Click the e-mail Setup tab.
Step 4 Select a switch in the Information pane.
Step 5 Enter the general e-mail information.
Step 6 Enter the SMTP server IP address type, IP address or name, and port.
Step 7 Click the Apply Changes icon to update the e-mail options.
Configuring HTTPS Support
Any predefined or user-defined destination profiles can be configured with the HTTPS URL address.
To configure the HTTPS URL address for any destination profile, follow these steps:
Enable or Disable Transport Method
Any predefined or user-defined destination profiles can be configured to enable or disable a particular transport method. The transport methods are HTTP and e-mail.
To enable or disable transport method for a destination profile, follow these steps:
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).
To configure an HTTP proxy server, follow these steps:
Note The default value for full text destination and for XML is 1 MB.
This example shows how to configure Smart Call Home to send HTTP messages through an HTTP proxy server:
To configure a Call Home HTTP proxy server, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events, select Call Home, and HTTP Proxy Server in the Physical Attributes pane.
You see the Call Home HTTP Proxy Server information in the Information pane.
Step 3 Click the Address Type tab.
The Address Type options are displayed.
Step 4 Click the Address tab and enter the address of the HTTP proxy server.
Step 5 Click the Port tab and enter a integer number to specify the port of the HTTP proxy server.
Step 6 Check the Enable check box to enable the HTTP proxy configured for Call Home.
Step 7 (Optional) Set an empty value in the Address tab to delete the HTTP proxy server from the MDS switch.
Step 8 Choose an address type. You can select ipv4, ipv6, or DNS.
Note If the address is empty, then no proxy server is configured.
Step 9 Click Apply to update HTTP Proxy Server options.
Configuring Call Home Wizard
Task Flow for Configuring Call Home Wizard
Follow these steps to configure the Call Home Wizard:
Step 1 Configure contact information.
Step 2 Configure SMTP information.
Step 3 Configure the email source and destination information.
Step 4 Use CFS to populate the configuration data.
Before You Begin
- Enable the global CFS on the switch from DCNM-SAN configuration table.
- Clear the CFS lock on the switch.
- Check the merger status of CFS on the switch. If a merger failure is found, the wizard clears up the merge failure in the backend process while running the wizard.
To configure Call Home wizard, follow these steps:
Step 1 Select a fabric in the logical domain tree.
Step 2 Select Tools, Events and Call Home.
The master switch pane is displayed.
Step 3 (Optional) You can also launch the Call Home wizard by clicking the CallHome Wizard icon in the Call Home Control tab.
Step 4 Select a Master Switch and click Next.
The contact information pane is displayed.
Step 5 Enter the Contact, Phone Number, Email Address and the Street Address information.
Note You must specify all of the four parameters before clicking Next.
The Email Setup pane is displayed.
Step 7 In the Email SMTP Servers tab, enter the Primary SNTP Server address.
You can specify up to two SMTP servers if the master switch is version 5.0 or above. However, you cannot specify a secondary SMTP server if the master switch version is below 5.0.
The wizard creates new rows in the SMTP server table.
Step 8 In the Destination tab, click Add to enter the Call Home destinations.
You can enter up to three Call Home destinations.
Step 9 (Optional) Click Remove to delete a Call Home destination entry.
Step 10 From the drop-down list, select Protocol and Profile.
The Profile drop-down lists three default profiles: xml, short_txt and full_txt.
Step 11 Click Finish to configure the wizard.
The Status Dialog window is displayed.
All major configuration steps and failures are displayed in the Status Dialog window.
Step 12 Click Run Test to perform the Call Home test.
Step 13 Click Yes to test the command on all switches in the selected fabric or click No to close the window.
Configuring SMTP Server and Ports
This section includes the following topic:
To configure the SMTP server and port, follow these steps:
Configuring Multiple SMTP Server Support
To distribute the SMTP server configuration to devices running software releases prior to NX-OS Release 5.0 and earlier, use the following command:
For multiple SMTP server capability, use the following command:
Example 4-1 shows how to configure multiple SMTP servers for Call Home messages:
Based on the configuration above, the SMTP servers would be contacted in this order:
172.21.34.193 (priority 50 - default)
The transport email mail-server command is distributed only to devices running NX-OS Release 5.0(1a) or later. The transport email smtp-server command is distributed only to devices running earlier software releases.
Enabling Periodic Inventory Notifications
When you enable this feature without configuring an interval value, the Call Home message is sent every 7 days. This value ranges from 1 to 30 days. By default, this feature is disabled in all switches in the Cisco MDS 9000 Family and Cisco Nexus 5000 Series switches.
To enable periodic inventory notification in a Cisco MDS 9000 Family switch or a Cisco Nexus 5000 Series switch, follow these steps:
To enable periodic inventory notification in a Cisco MDS 9000 Family switch or a Cisco Nexus 5000 Series switch, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
Step 3 Click the Periodic Inventory tab.
You see the Call Home periodic inventory information.
Step 4 Select a switch in the Information pane.
Step 5 Check the Enable check box.
Step 6 Enter the number of days for which you want the inventory checked.
Step 7 Click the Apply Changes icon.
Configuring Duplicate Message Throttle
You can configure a throttling mechanism to limit the number of Call Home messages received for the same event. If the same message is sent multiple times from the switch within a short period of time, you may be swamped with a large number of duplicate messages.
Restrictions
- By default, this feature is enabled in all switches in the Cisco MDS 9000 Family and the Cisco Nexus 5000 Series switches. When enabled, if the number of messages sent exceeds the maximum limit of 30 messages within the 2-hour time frame, then additional messages for that alert type are discarded within that time frame. You cannot modify the time frame or the message counter limit.
- If 2 hours have elapsed since the first such message was sent and a new message has to be sent, then the new message is sent and the time frame is reset to the time when the new message was sent and the count is reset to 1.
To enable message throttling in a Cisco MDS 9000 Family switch or a Cisco Nexus 5000 Series switch, follow these steps:
To enable message throttling in a Cisco MDS 9000 Family switch or a Cisco Nexus 5000 Series switch, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
Step 4 Select a switch in the Information pane.
Step 5 Check the Duplicate Msg Throttle check box.
Step 6 Click the Apply Changes icon.
Enabling Call Home Fabric Distribution
To enable Call Home fabric distribution, follow these steps:
To commit the Call Home configuration changes, follow these steps:
Distributes the configuration changes to all switches in the fabric and releases the lock. Overwrites the effective database with the changes made to the pending database. |
To discard the Call Home configuration changes, follow these steps:
To enable Call Home fabric distribution, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
You see the CFS information for Call Home.
Step 4 Select a switch in the Information pane.
Step 5 Select Enable from the drop-down list in the Admin column in the row for that switch.
Step 6 Click the Apply Changes icon to commit the changes.
Fabric Lock Override
To use administrative privileges and release a locked Call Home session, use the clear callhome session command.
To use administrative privileges and release a locked Call Home session, use the clear callhome session command.
Call Home Communications Test
You can test Call Home communications by sending a test message to the configured destination(s) or sending a test inventory message to the configured destination(s).
Use the test command to simulate a message generation.
To test the Call Home function, follow these steps:
switch# callhome test inventory |
Sends a test inventory message to the configured destination(s). |
To test the Call Home function and simulate a message generation, follow these steps:
Step 1 Select a switch in the Fabric pane.
Step 2 Expand Events and select Call Home in the Physical Attributes pane.
You see the Call Home information in the Information pane.
You see the configured tests for the switch and the status of the last testing.
Step 4 Select a switch in the Information pane.
Step 5 From the TestAction drop-down list in the row for that switch, select test or testWithInventory
Step 6 Click the Apply Changes icon to run the test.
Table 50-10 includes all the traps for EMC Call Home.
Configuring Delayed Traps
The server.callhome.delayedtrap.enable property is added to section 9 Call Home in the server.properties configuration file. The property file can enable the DCNM-SAN server to use delayed traps instead of regular linkDown traps for EMC E-mail Home messages.
Prerequisites
To enable this feature, you need to turn on delayed traps at switch level, and then set the server.callhome.delayedtrap.enable property in the server.properties configuration file to true. By default, the server.callhome.delayedtrap.enable option is disabled and regular linkDown traps are used.
To enable the delayed trap feature, perform this task:
Configures the system-delayed trap timeout value. If no value is entered, a default value of 4 minutes is used. You can choose any value between 1 to 60 minutes. |
To disable the delayed trap feature, perform this task:
To enable delayed traps on switches running NX-OS Release 4.1(3) and later, follow these steps:
Step 1 Expand Events and select SNMP Traps in the Physical Attributes pane.
In the table above the map layout in DCNM-SAN, click the Delayed Traps tab.
Step 2 Check the Enable check box for the switches on which you want to enable delayed traps.
Step 3 Enter the timer value in the Delay column.
Step 4 Click Apply to save your changes.
Note If no value is entered, the default value of 4 minutes is used.
To disable delayed traps, follow these steps:
Step 1 Uncheck the Enable check box.
Enabling Delayed Traps Using Cisco Device Manager
Step 1 In Device Manager, choose Admin > Events > Filters > Delayed Traps.
You can see the Events Filters information in the Information pane.
Step 2 Click the Delayed Traps tab.
Step 3 Check the Enable check box to enable delayed traps.
Delay interval will only be available when the feature is enabled.
Step 4 To disable Delayed Traps, uncheck the Enable check box and click Apply.
Viewing Event Filter Notification
To see the descriptive notification, follow these steps:
Step 1 In Device Manager, choose Admin > Events > Filters.
You can see the Event Filters information in the Information pane.
The Event Filters screen displays the descriptive information about the notification.
Verifying Call Home Configuration
To display the Call Home configuration information, perform one of the following tasks:
- Displaying Call Home Information
- Verifying Alert Group Customization
- Verifying Event Notification TrapVerifying Call Home Transport
- Verifying the Number of Name Server Database Entries
Displaying Call Home Information
Use the show callhome command to display the configured Call Home information (see Examples 50-1 to 50-7 ).
Example 50-1 Displays Configured Call Home Information
Example 50-2 Displays Information for All Destination Profiles (Predefined and User-Defined)
Example 50-3 Displays Information for a User-defined Destination Profile
Example 50-4 Displays the Full-Text Profile
Example 50-5 Displays the Short-Text Profile
Displaying Delayed Trap Information
Use the show running-config | in delay CLI command to display the system-delayed trap state as shown in Example 50-8 and Example 50-9. If no timer value is specified or if the timer value is set to 4 minutes, the following is displayed:
Example 50-8 Displays the Delayed Trap Information with No Timer Value (Set to the Default 4 Minutes)
If the timer value is set to any other value other than 4 minutes, Example 50-9 is displayed:
Example 50-9 Displays the Delayed Trap Information with a Timer Value Other Than 4 Minutes
Verifying Alert Group Customization
To verify the alert group customization, use the show callhome user-def-cmds command.
Verifying Event Notification Trap
To verify the SNMP event notification trap, use the show snmp trap | inc callhome command.
Verifying Call Home Transport
The show callhome transport command displays all of the transport-related configurations for Call Home.
The following example shows how to configure SMTP server port:
The following example shows how to configure SMTP server priority:
Monitoring Call Home
This section includes the following topics:
- Sample Syslog Alert Notification in Full-txt Format
- Sample Syslog Alert Notification in XML Format
- Sample RMON Notification in XML Format
Sample Syslog Alert Notification in Full-txt Format
Sample Syslog Alert Notification in XML Format
Sample RMON Notification in XML Format
Field Descriptions for Call Home
This section describes the field descriptions for Call Home.
Call Home General
Call Home Destinations
Call Home E-mail Setup
Call Home Alerts
Call Home Profiles
Event Destinations Addresses
Event Destinations Security (Advanced)
Event Filters General
Additional References
For additional information related to implementing Call Home, see the following section:
Feature History for Call Home
Table 50-11 lists the release history for this feature. Only features that were introduced or modified in Release 3.x or a later release appear in the table.
Table 50-11 Feature History for Call Home