Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling Call Home

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "callhomeEnable": "enabled"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <callhome-items>
    <inst-items>
      <callhomeEnable>enabled</callhomeEnable>
    </inst-items>
  </callhome-items>
</System>

Configuring Call Home

Call Home provides an email-based notification for critical system policies. A range of message formats are available for compatibility with pager services, standard email, or XML-based automated parsing applications. You can use this feature to page a network support engineer, email a Network Operations Center, or use Cisco Call Home services to automatically generate a case with the Technical Assistance Center.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Enabling Call Home

Note: This example was added in Release 9.3(1).

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

callhome
enable

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

The following table contains information about the callhomeInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
callhomeEnable	callhome:Boolean (scalar:Enum8)	Enable/Disable callhome	SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling Call Home

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no enable

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
callhomeEnable	callhome:Boolean (scalar:Enum8)	Enable/Disable callhome	SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Throttling of Duplicate Call Home Alert Messages

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
duplicate-message throttle

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
dupMsgThrottle	callhome:Boolean (scalar:Enum8)	Enable/Disable duplicate message throttling	SELECTION: 0 - disabled 1 - enabled DEFAULT: enabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling the Throttling of Duplicate Call Home Alert Messages

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no duplicate-message throttle

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
dupMsgThrottle	callhome:Boolean (scalar:Enum8)	Enable/Disable duplicate message throttling	SELECTION: 0 - disabled 1 - enabled DEFAULT: enabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Customer Service Contract Id

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
contract-id SampleString_123

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
contractId	callhome:StringRange (string:Basic)	Service contract id of the customer	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Customer Service Contract Id

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no contract-id SampleString_123

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
contractId	callhome:StringRange (string:Basic)	Service contract id of the customer	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Customer Id

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
customer-id Customer123456

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
customerId	callhome:StringRange (string:Basic)	Customer ID as specified in the service agreement	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Customer Id

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no customer-id Customer123456

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
customerId	callhome:StringRange (string:Basic)	Customer ID as specified in the service agreement	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Email Address of the Contact Person

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
email-contact admin@Mycompany.com

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
emailId	callhome:Email (address:Email)	Email address of the contact person	RANGE: [0 , 255] DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Email Address of the Contact Person

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no email-contact admin@Mycompany.com

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
emailId	callhome:Email (address:Email)	Email address of the contact person	RANGE: [0 , 255] DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Phone Number of the Contact Person

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
phone-contact +1-800-123-4567

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
phoneContact	callhome:Phone (address:Phone)	Contact person's phone number	RANGE: [0 , 17] DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Phone Number of the Contact Person

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no phone-contact +1-800-123-4567

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
phoneContact	callhome:Phone (address:Phone)	Contact person's phone number	RANGE: [0 , 17] DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Site Id of the Network Where the Switch is Deployed

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
site-id Site1

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
siteId	callhome:StringRange (string:Basic)	Site id of the network where switch is deployed	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Site Id of the Network Where the Switch is Deployed

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no site-id Site1

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
siteId	callhome:StringRange (string:Basic)	Site id of the network where switch is deployed	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Replacement Part Shipping Address

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
streetaddress 123 Anystreet st. Anytown,AnyWhere

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
streetAddress	callhome:StringRange (string:Basic)	Configure replacement part shipping address	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Replacement Part Shipping Address

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no streetaddress 123:12

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
streetAddress	callhome:StringRange (string:Basic)	Configure replacement part shipping address	MAX SIZE: 255 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Switch Priority

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
switch-priority

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
switchPri	scalar:Uint16	Priority of the switch	RANGE: [0 , 7] DEFAULT: 7

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Switch Priority

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no switch-priority

Verifying a DME Configuration

MO	DN
callhomeCallhome	sys/callhome
callhomeInst	sys/callhome/inst

callhomeInst Properties

Property Name	Data Type	Description	Values
switchPri	scalar:Uint16	Priority of the switch	RANGE: [0 , 7] DEFAULT: 7

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html