TIP OF THE DAY: Configuring Call Home and Query Groups

Transcription

1 TIP OF THE DAY: Configuring Call Home and Query Groups Today s Tip of the Day is to give you an example of how to configure Call Home and Query Groups in an ACI Fabric Solution. Please note that this steps and examples were presented using an earlier version of the APIC firmware release. As a result, you may see some changes in the screens but the general concepts of configuring has not changed. In the External Data Collectors menu, you can configure the sending of a variety of system data to Call Home, SNMP, or syslog destinations. When an event triggers the sending of a report, information from your selected queries is included in the report. You can configure a query based on a class name or a distinguished name, and you can further qualify the query based on subtrees and object properties. Call Home provides an -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 page a network support engineer, a Network Operations Center, or use Cisco Smart Call Home services to generate a case with the Technical Assistance Center. The Call Home feature can deliver alert messages containing information about diagnostics and environmental faults and events. The Call Home feature can deliver alerts to multiple recipients, referred to as Call Home 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. When you configure Call Home to send messages, Cisco ACI fabric system delivers Call Home 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 The XML format enables communication with the Cisco Systems Technical Assistance Center ACI Solutions Delivery Team Cisco Systems 2014 Page 1 of 27

2 The following Test Case involves configuring the Call Home feature in your Cisco ACI fabric system. This test case will show examples of configuring the Call Home feature utililizing the APIC Admin GUI and REST API (using POSTMAN). For this test case, the fabric topology consist of 8 nodes: 3 APIC controllers, 2 Spine switches, and 3 Leaf switches. In regards to the REST API examples listed in this test case, there is an assumption made that you have a REST CLIENT (like POSTMAN) installed on your workstation. This will be used for executing REST API requests to an APIC Controller. Also, while executing this test case, you may want to open the API inspector console from the APIC GUI. The API inspector displays the API POST requests used for the tasks performed. The Post Requests in the API inspector can be used for sending requests to APIC controllers. Note: For this testplan, the ACI Software for the Leaf/Spine switches did not support CALLHOME features. The configuration steps listed in the testplan are for the APIC controllers and the switches. When the support is added to the Leaf/Spine switches, the same configuration steps apply. Step 1: Create scheduler with schedule windows The CALLHOME feature will require a Scheduler Trigger for the Switch Policies. Use the GUI to a create scheduler with schedule windows. For this task, use the admin user "admin" and the password "ins3965!". Note: users, roles, and passwords may be different in your test topology. If so, just use your user credentials when "admin"\"ins3965!" are referenced in this test case. ACI Solutions Delivery Team Cisco Systems 2014 Page 2 of 27

3 After you have logged into the Admin GUI, select ADMIN-->SCHEDULERS tab. Use the Quick Start wizard to "Create a scheduler". Select "Create a scheduler. ACI Solutions Delivery Team Cisco Systems 2014 Page 3 of 27

4 --> ADD a NAME & DESCRIPTION --> Click "+" to CREATE SCHEDULE WINDOW. For this task, create a "One Time" and a "Recurring" window. ACI Solutions Delivery Team Cisco Systems 2014 Page 4 of 27

5 Create a "One Time" window. --> Click "+" to CREATE SCHEDULE WINDOW. --> Select WINDOW TYPE "One Time" --> Enter WINDOW NAME --> Select DATE --> Enter "5" for MAXIMUM CONCURRENT NODES --> Accept "unlimited" for MAXIMUM RUNNING TIME --> Click "OK" button to continue ACI Solutions Delivery Team Cisco Systems 2014 Page 5 of 27

6 Create a "Recurring" window. --> Click "+" to CREATE SCHEDULE WINDOW. --> Select WINDOW TYPE "Recurring" --> Enter WINDOW NAME --> Select "every-day" for DAY --> Enter "12" for HOUR --> Enter "0" for MINUTE --> Enter "5" for MAXIMUM CONCURRENT NODES --> Accept "unlimited" for MAXIMUM RUNNING TIME --> Click "OK" button to continue ACI Solutions Delivery Team Cisco Systems 2014 Page 6 of 27

7 --> Click "SUBMIT" to finish ACI Solutions Delivery Team Cisco Systems 2014 Page 7 of 27

8 Example of the API Source of Step 1 to be used with the POSTMAN REST API Client: method: POST payload {"trigschedp":{"attributes":{"dn":"uni/controller/schedpdeadbeef_scheduler","name":"deadbeef_scheduler","descr":"deadbeef_sc heduler added by tdeleon@cisco.com","rn":"schedpdeadbeef_scheduler","status":"created"},"children":[{"trigabswindowp": {"attributes":{"dn":"uni/controller/schedp-deadbeef_scheduler/abswinpdeadbeef_onetime","name":"deadbeef_onetime","date":" t13:57: Z","concurCap":"5","rn":"abswinpdeadbeef_onetime","status":"created"},"children":[]}}, {"trigrecurrwindowp":{"attributes":{"dn":"uni/controller/schedpdeadbeef_scheduler/recurrwinpdeadbeef_recur","name":"deadbeef_recur","hour":"12","concurcap":"5","r n":"recurrwinp-deadbeef_recur","status":"created"},"children":[]}}]}} response: {"imdata":[]} STEP 2: Create CALLHOME Query Group and CALLHOME Monitoring Destination After you have logged into the Admin GUI, select ADMIN-->EXTERNAL DATA COLLECTORS tab. TASK 2.1: Create a query group --> Use the "Quick Start" wizard to create a query group. Click "QUICK START" on the EXTERNAL DATA COLLECTORS panel on the left. ACI Solutions Delivery Team Cisco Systems 2014 Page 8 of 27

9 --> Select "Create a query group" from the "Quick Start" wizard On the CREATE QUERY wizard, Define Name and Queries. --> Add NAME --> Click "+" to ADD QUERIES --> Add NAME --> Select SUBTREE for TARGET --> Select FULL for RESPONSE SUBTREE --> Check ALL boxes for RESPONSE SUBTREE INCLUDE --> Click "OK" button to continue ACI Solutions Delivery Team Cisco Systems 2014 Page 9 of 27

10 ACI Solutions Delivery Team Cisco Systems 2014 Page 10 of 27

11 --> Click "SUBMIT" to finish ACI Solutions Delivery Team Cisco Systems 2014 Page 11 of 27

12 Example of the API Source of TASK 2.1 to be used with the POSTMAN REST API Client: method: POST payload {"callhomequerygroup":{"attributes":{"dn":"uni/fabric/chquerygroupdeadbeef_query","name":"deadbeef_query","rn":"chquerygroupdeadbeef_query","status":"created"},"children":[{"callhomequery": {"attributes":{"dn":"uni/fabric/chquerygroup-deadbeef_query/chquerydeadbeef_query","name":"deadbeef_query","target":"subtree","rspsubtree ":"full","rspsubtreeinclude":"event-logs,count,stats,state,portdeployment,tasks,relations-with-parent,health,fault-count,localprefix,config-only,record-subtree,no-scoped,relations,health-records,auditlogs,deployment,required,faults,fault-records","rn":"chquerydeadbeef_query","status":"created"},"children":[]}}]}} response: {"imdata":[]} TASK 2.2: Create a Callhome Destination Group --> Select "Monitoring Destinations" on the EXTERNAL DATA COLLECTORS panel on the left. --> Right CLICK and Select + CREATE CALLHOME DESTINATION GROUP ACI Solutions Delivery Team Cisco Systems 2014 Page 12 of 27

13 From the CREATE CALLHOME DESTINATION GROUP wizard, add values for the all the fields listed on the STEP 1 > PROFILE page. --> ADD requested values for CALLHOME DESTINATION GROUP PROFILE --> Click "NEXT" to continue ACI Solutions Delivery Team Cisco Systems 2014 Page 13 of 27

14 For STEP 2 > DESTINATIONS page, add a CALLHOME DESTINATION --> Click "+" to CREATE a DESTINATION --> Add requested values --> Click "FINISH" to finish ACI Solutions Delivery Team Cisco Systems 2014 Page 14 of 27

15 Example of the API Source of TASK 2.2 to be used with the POSTMAN REST API Client: method: POST payload {"callhomegroup":{"attributes":{"dn":"uni/fabric/chgroupdeadbeef_callhome_dg","name":"deadbeef_callhome_dg","descr":"deadbe ef_callhome_dg added by {"attributes":{"dn":"uni/fabric/chgroup-deadbeef_callhome_dg/destdeadbeef_callhome_dest","name":"deadbeef_callhome_dest"," ":"cisc {"callhomeprof":{"attributes":{"dn":"uni/fabric/chgroupdeadbeef_callhome_dg/ "Cisco Systems","addr":" Kit Creek Road","contract":" ","customer":"05002","site":" ","rn" :"prof","status":"created"},"children":[{"callhomesmtpserver":{"attributes": {"dn":"uni/fabric/chgroup-deadbeef_callhome_dg/prof/ smtp","host":" ","rn":"smtp","status":"created"},"children": [{"filersaremotehosttoepg":{"attributes":{"tdn":"uni/tn-mgmt/mgmtpdefault/oob-default","status":"created"},"children":[]}}]}}]}}]}} response: {"imdata":[]} STEP 3: Configure CALLHOME for Fabric -> Fabric Policies After you have logged into the Admin GUI, select FABRIC-->FABRIC POLICIES tab. ACI Solutions Delivery Team Cisco Systems 2014 Page 15 of 27

16 TASK 3.1: Create a Switch Policy for CALLHOME INVENTORY --> Select SWITCH POLICIES --> Click "+" to expand SWITCH POLICIES --> Click "+" to expand POLICIES --> Select CALLHOME INVENTORY POLICIES --> Right CLICK and Select + CREATE CALLHOME INVENTORY POLICY --> Add NAME --> Set Admin State to ENABLED --> Set MAXIMUM-RETRY COUNT to 3 --> Select DESTINATION GROUP that was created in STEP 2 --> Select SCHEDULER that was created in STEP 1 --> Click "SUBMIT" to finish ACI Solutions Delivery Team Cisco Systems 2014 Page 16 of 27

17 ACI Solutions Delivery Team Cisco Systems 2014 Page 17 of 27

18 Example of the API Source of TASK 3.1 to be used with the POSTMAN REST API Client: method: POST payload {"callhomeinvp":{"attributes":{"dn":"uni/fabric/chinvpdeadbeef_inventory","name":"deadbeef_inventory","maximumretrycount": "3","rn":"chinvp-deadbeef_inventory","status":"created"},"children": [{"callhomersdestgrouprel":{"attributes":{"tdn":"uni/fabric/chgroupdeadbeef_callhome_dg","status":"created"},"children":[]}}, {"callhomersinvscheduler":{"attributes": {"tntrigschedpname":"deadbeef_trigger","status":"created,modified"},"chil dren":[]}}]}} response: {"imdata":[]} TASK 3.2: Create a DEFAULT Monitoring Policy for CALLHOME/SNMP/ SYSLOG --> Select MONITORING POLICIES --> Click "+" to expand MONITORING POLICIES --> Click "+" to expand DEFAULT --> Select CALLHOME/SNMP/SYSLOG ACI Solutions Delivery Team Cisco Systems 2014 Page 18 of 27

19 --> Click "+" to CREATE CALLHOME SOURCE --> Add NAME --> Check ALL boxes for INCLUDE --> Accept ALERTS for LEVEL --> Select DESTINATION GROUP that was created in STEP 2 --> Select SCHEDULER that was created in STEP 1 --> Click "SUBMIT" to finish ACI Solutions Delivery Team Cisco Systems 2014 Page 19 of 27

20 ACI Solutions Delivery Team Cisco Systems 2014 Page 20 of 27

21 Example of the API Source of TASK 3.2 to be used with the POSTMAN REST API Client: method: POST payload {"callhomesrc":{"attributes":{"dn":"uni/fabric/monfab-default/chsrcdeadbeef_callhome_src","name":"deadbeef_callhome_src","incl":"events,a udit,faults","rn":"chsrcdeadbeef_callhome_src","status":"created"},"children": [{"callhomersdestgroup":{"attributes":{"tdn":"uni/fabric/chgroupdeadbeef_callhome_dg","status":"created"},"children":[]}}, {"callhomersquerygrouprel":{"attributes":{"tdn":"uni/fabric/ chquerygroup-deadbeef_query","status":"created"},"children":[]}}]}} response: {"imdata":[]} ACI Solutions Delivery Team Cisco Systems 2014 Page 21 of 27

22 TASK 3.3: Create a COMMON Monitoring Policy for CALLHOME/SNMP/ SYSLOG --> Select MONITORING POLICIES --> Click "+" to expand MONITORING POLICIES --> Click "+" to expand COMMON --> Select CALLHOME/SNMP/SYSLOG --> Right CLICK and Select + CREATE CALLHOME SOURCE --> Add NAME --> Check ALL boxes for INCLUDE --> Accept ALERTS for LEVEL --> Select DESTINATION GROUP that was created in STEP 2 --> Select SCHEDULER that was created in STEP 1 --> Click "SUBMIT" to finish ACI Solutions Delivery Team Cisco Systems 2014 Page 22 of 27

23 ACI Solutions Delivery Team Cisco Systems 2014 Page 23 of 27

24 Example of the API Source of TASK 3.3 to be used with the POSTMAN REST API Client: method: POST payload {"callhomesrc":{"attributes":{"dn":"uni/fabric/moncommon/chsrcdeadbeef_callhome_src","name":"deadbeef_callhome_src","incl":"events,a udit,faults","rn":"chsrcdeadbeef_callhome_src","status":"created"},"children": [{"callhomersdestgroup":{"attributes":{"tdn":"uni/fabric/chgroupdeadbeef_callhome_dg","status":"created"},"children":[]}}, {"callhomersquerygrouprel":{"attributes":{"tdn":"uni/fabric/ chquerygroup-deadbeef_query","status":"created"},"children":[]}}]}} response: {"imdata":[]} ACI Solutions Delivery Team Cisco Systems 2014 Page 24 of 27

25 STEP 4: Configure CALLHOME for Fabric -> Access Policies After you have logged into the Admin GUI, select FABRIC-->ACCESS POLICIES tab. --> Select MONITORING POLICIES --> Click "+" to expand MONITORING POLICIES --> Click "+" to expand DEFAULT --> Select CALLHOME/SNMP/SYSLOG --> Click "+" to CREATE CALLHOME SOURCE --> Add NAME --> Check ALL boxes for INCLUDE --> Accept ALERTS for LEVEL --> Select DESTINATION GROUP that was created in STEP 2 --> Select SCHEDULER that was created in STEP 1 ACI Solutions Delivery Team Cisco Systems 2014 Page 25 of 27

26 --> Click "SUBMIT" to finish ACI Solutions Delivery Team Cisco Systems 2014 Page 26 of 27

27 Example of the API Source of Step 4 to be used with the POSTMAN REST API Client: method: POST payload {"callhomesrc":{"attributes":{"dn":"uni/infra/moninfra-default/chsrcdeadbeef_callhome_src","name":"deadbeef_callhome_src","incl":"events,a udit,faults","rn":"chsrcdeadbeef_callhome_src","status":"created"},"children": [{"callhomersdestgroup":{"attributes":{"tdn":"uni/fabric/chgroupdeadbeef_callhome_dg","status":"created"},"children":[]}}, {"callhomersquerygrouprel":{"attributes":{"tdn":"uni/fabric/ chquerygroup-deadbeef_query","status":"created"},"children":[]}}]}} response: {"imdata":[]} STEP 5: Verify CALLHOME feature is working Check your Client for the DESTINATION GROUP that was created in STEP 2 to see if the account is receiving CALLHOME messages from the Cisco ACI fabric system. ACI Solutions Delivery Team Cisco Systems 2014 Page 27 of 27