New and Changed Information
The following table provides an overview of the significant changes up to this current release. The table does not provide an exhaustive list of all changes or of the new features up to this release.
Cisco APIC Release Version |
Feature |
Description |
---|---|---|
Release 4.2(1i) |
Callhome email modified for clarity. |
The default behavior for the Callhome email received by a user is modified for clarity. |
Release 2.2(2x) |
This feature was introduced |
-- |
About Callhome
Callhome provides an email-based notification for critical system policies. A range of message formats are available for compatibility with pager services or XML- based automated parsing applications. You can use this feature to automatically page a network support engineer, email a Network Operations Center, or email the Cisco Technical Assistance Center (TAC).
-
The Callhome feature can deliver alert messages containing information about diagnostics and environmental faults and events.
-
The Callhome feature can deliver alerts to multiple recipients, referred to as Callhome destination profiles. Each profile includes configurable message formats and content categories. A predefined destination profile is provided for sending alerts to the Cisco TAC, but you also can define your own destination profiles.
Note
Starting with Cisco APIC Release 4.2(1), the default behavior of the Callhome email received by a user has been modified for clarity. The enhanced default message provides a snippet of the exact content related to the actual fault, event, audit log, or session log that triggers the Callhome alert. However, if a user wants the verbose Callhome email that was received prior to Cisco APIC Release 4.2(1), they can configure the query group to receive the verbose output. For example, they can choose to receive queries such as <topSystem>, <eqptCh>, and <firmwareCtrlRunning> by configuring the query group. In addition, whether the user receives a default Callhome email or a verbose Callhome email, the Subject of the Callhome message contains information that is relevant to the user such as the name of the appliance, the ID number of the appliance where the fault or event is raised, and the description of the fault or event that is raised.
With the Query Group, you can include a variety of system data to the Callhome notification. When an event triggers the sending of a report, the queries in the Query Group are executed and their results are included in the report. The syntax of the queries you configured in the Query Group is the same as the API query you perform against your APICs or switches such as class query, distinguished name (DN) query with the following filters:
-
query-target
—self, children, or subtree -
rsp-subtree
—no, children, or full -
rsp-subtree-include
—required, no-scoped, and so on.
See the Cisco APIC REST API Configuration Guide for details of these options.
![]() Note |
Be cognizant of what you query because some filters such as query-target=subtree, rsp-subtree=full may result in a huge number of objects that cannot be handled in one query. Such a query fails just as it does with a regular
API query.
|
When you configure Callhome to send messages, Cisco ACI fabric system delivers Callhome messages in the following formats:
-
Short text format which provides a one or two line description of the fault that is suitable for pagers or printed reports.
-
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.
-
Archie Markup Language (ArchieML or AML)
Trigger Schedulers
Creating a Scheduler Policy Using the GUI
Procedure
Step 1 |
On the menu bar, choose Admin > Schedulers. |
Step 2 |
Right-click Fabric and choose Create Trigger Scheduler. |
Step 3 |
In the Create Trigger Schedule wizard, perform the following actions:
|
Step 4 |
Create a One Time schedule.
|
Step 5 |
Create a Recurring schedule.
|
Step 6 |
Click Submit. |
Attaching a Scheduler Using the CLI
Before you begin
SUMMARY STEPS
- configure terminal
- callhome common
- periodic notification schedule scheduler
DETAILED STEPS
Command or Action | Purpose | |||
---|---|---|---|---|
Step 1 |
configure terminal Example:
|
Enters configuration mode. |
||
Step 2 |
callhome common Example:
|
Enters Callhome common policy configuration mode.
|
||
Step 3 |
periodic notification schedule scheduler Example:
|
Attaches the scheduler to Callhome common. |
Creating a Scheduler Policy Using the REST API
Procedure
Create a Scheduler Policy for the Callhome Feature. Example:
|
Callhome Destination Group
Creating a Callhome Destination Group Using the GUI
Callhome data can be collected and exported to a destination group for logging and evaluation. The Create Callhome Destination Group screen contains properties for specifying a Callhome destination group.
The Callhome Destination Group is used by the Cisco ACI Fabric for sending Callhome messages.
Procedure
Step 1 |
Choose Admin > External Data Collectors. |
Step 2 |
In the Navigation pane, right-click Monitoring Destinations and choose Create Callhome Destination Group. |
Step 3 |
In the Create Callhome Destination Group wizard, perform the following actions:
|
Step 4 |
In the Destinations dialog box, click the + icon. |
Step 5 |
In the Create Destinations wizard, perform the following actions: |
Step 6 |
Click FINISH. |
Creating a Callhome Destination Group Using the CLI
SUMMARY STEPS
- configure terminal
- callhome common
- destination-profile
- Enter destination information.
DETAILED STEPS
Command or Action | Purpose | |||
---|---|---|---|---|
Step 1 |
configure terminal Example:
|
Enters configuration mode. |
||
Step 2 |
callhome common Example:
|
Enters Callhome common policy configuration mode.
|
||
Step 3 |
destination-profile Example:
|
Configures destination profile parameters. Creates the destination group named "common".
|
||
Step 4 |
Enter destination information. Example:
|
The following are the valid entries:
|
Creating a Callhome Destination Group Using the REST API
Procedure
Create a Callhome Monitoring Destination Group. Example:
|
Callhome Query Group
Creating a Callhome Query Group Using the GUI
A Callhome query group is a set of Callhome query messages to be sent on returned objects. The Callhome Query Groups panel provides the options to create or delete a Callhome query group and displays a summary table that lists the existing query groups.
The Callhome Query Group is used by the Cisco ACI Fabric for sending Callhome messages.
Procedure
Step 1 |
Choose Admin > External Data Collectors. |
Step 2 |
In the Navigation pane, right-click Callhome Query Groups and choose Create Callhome Query Group. |
Step 3 |
In the Create Callhome Query Group dialog box, perform the following actions:
|
Step 4 |
In the Create Query wizard, perform the following actions:
|
Step 5 |
In the Create Callhome Query Group dialog box, click Submit. |
Creating a Callhome Query Group Using the REST API
Procedure
Create a Callhome query group. Example:
|
Callhome Inventory Policy
Creating a Callhome Inventory Policy Using the GUI
The Callhome inventory policy is used to send Callhome messages with system inventory information in relation to your designated Cisco ACI fabric.
Procedure
Step 1 |
On the menu bar, choose Fabric > Fabric Policies. |
Step 2 |
In the Navigation pane, expand Switch Policies. |
Step 3 |
Right-click Policies and choose Create Callhome Inventory Policy. |
Step 4 |
In the Create Callhome Inventory Policy wizard, perform the following actions:
|
Creating a Callhome Policy Using the CLI
SUMMARY STEPS
- configure terminal
- callhome common
- logging option
- logging severity severity_option
DETAILED STEPS
Command or Action | Purpose | |||
---|---|---|---|---|
Step 1 |
configure terminal Example:
|
Enters configuration mode. |
||
Step 2 |
callhome common Example:
|
Enters Callhome common policy configuration mode.
|
||
Step 3 |
logging option Example:
|
Configures policy parameters. Choose one of the following options:
|
||
Step 4 |
logging severity severity_option Example:
|
These are the valid options for severity:
|
Creating a Switch Policy for Callhome Inventory Policy Using the REST API
Procedure
Create a Switch Policy for Callhome Inventory Policy. Example:
|
Spine Switch Policy Group
Creating a Spine Switch Policy Group Using the GUI
Procedure
Step 1 |
On the menu bar, choose Fabric > Fabric Policies. |
Step 2 |
Expand Switch Policies. |
Step 3 |
Right-click Policy Groups and choose Create Spine Switch Policy Group. |
Step 4 |
In the Create Spine Switch Policy Group wizard, perform the following actions:
|
Creating a Spine Switch Policy Group Using the REST API
Procedure
Create a spine switch policy group. Example:
|
Leaf Switch Policy Group
Creating a Leaf Switch Policy Group Using the GUI
Procedure
Step 1 |
On the menu bar, choose Fabric > Fabric Policies. |
Step 2 |
Expand Switch Policies. |
Step 3 |
Right-click Policy Groups and choose Create Leaf Switch Policy Group. |
Step 4 |
In the Create Leaf Switch Policy Group wizard, perform the following actions:
|
Creating a Leaf Switch Policy Group Using the REST API
Procedure
Create a leaf switch policy group. Example:
|
Spine Switch Profiles
Creating Spine Switch Profiles Using the GUI
Procedure
Step 1 |
Choose Fabric > Fabric Policies. |
Step 2 |
In the Navigation pane, expand Switch Policies. |
Step 3 |
Right-click Profiles and choose Create Spine Switch Profile. |
Step 4 |
In the Create Spine Switch Profile dialog box, perform the following actions:
|
Step 5 |
Click SUBMIT. |
Creating Spine Switch Profiles Using the REST API
Procedure
Create a spine switch profile. Example:
|
Leaf Switch Profiles
Creating Leaf Switch Profiles Using the GUI
Procedure
Step 1 |
Choose Fabric > Fabric Policies. |
Step 2 |
In the Navigation pane, expand Switch Policies. |
Step 3 |
Right-click Profiles and choose Create Leaf Switch Profile. |
Step 4 |
In the Create Leaf Switch Profile wizard, perform the following actions:
|
Step 5 |
Click SUBMIT. |
Creating Leaf Switch Profiles Using the REST API
Procedure
Create leaf switch profiles. Example:
|
Callhome Source
Creating a Callhome Source Using the GUI
Fabric policies govern the operation of internal fabric interfaces. The system provides default fabric policies. Fabric policies enable configuring various functions or protocols. Administrators who have fabric administrator privileges can create new fabric policies according to their requirements. The APIC enables administrators to select the pods, leaf switches, and interfaces to which they will apply access policies.
Fabric policies configure interfaces that connect spine and leaf switches. Fabric policies can enable features such as monitoring (statistics collection and statistics export), troubleshooting (on-demand diagnostics and SPAN), or NTP.
The call home source profile, which determines the information to deliver and the urgency level for sending email-based alert notifications to a call home destination. A range of message formats are available for compatibility with pager services or XML- based automated parsing applications. You can use this feature to automatically page a network support engineer, email a Network Operations Center, or email the Cisco Technical Assistance Center (TAC).
Fabric Callhome Sources need to be configured in the DEFAULT and COMMON monitoring policies configured in the Fabric Policies configuration. Use the GUI to configure the DEFAULT and COMMON Callhome monitoring policies. Use the API Inspector to capture the API POST information from this configuration.
Procedure
Step 1 |
Choose Fabric > Fabric Policies. |
Step 2 |
In the Navigation pane, expand Policies, Monitoring, and default. |
Step 3 |
Click Callhome/Smart Callhome/SNMP/Syslog/TACACS. |
Step 4 |
In the Callhome/Smart Callhome/SNMP/Syslog/TACACS work pane, choose the Callhome option from the Source Type. |
Step 5 |
Click + to open the Create Callhome Source dialog box. |
Step 6 |
In the Create Callhome Source dialog box, perform the following actions: |
Creating a Callhome Source Using the REST API
Procedure
Create the Callhome source. Example:
|