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

Enabling Call Home
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "callhomeEnable": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <callhomeEnable>enabled</callhomeEnable>
    </inst-items>
  </callhome-items>
</System>

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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
callhomeEnablecallhome:Boolean
(scalar:Enum8)
Enable/Disable callhomeSELECTION:
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

Disabling Call Home
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "callhomeEnable": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <callhomeEnable>disabled</callhomeEnable>
    </inst-items>
  </callhome-items>
</System>

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
 no 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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
callhomeEnablecallhome:Boolean
(scalar:Enum8)
Enable/Disable callhomeSELECTION:
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

Configuring the Throttling of Duplicate Call Home Alert Messages
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "dupMsgThrottle": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <dupMsgThrottle>enabled</dupMsgThrottle>
    </inst-items>
  </callhome-items>
</System>

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
 duplicate-message throttle


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
dupMsgThrottlecallhome:Boolean
(scalar:Enum8)
Enable/Disable duplicate message throttlingSELECTION:
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

Disabling the Throttling of Duplicate Call Home Alert Messages
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "dupMsgThrottle": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <dupMsgThrottle>disabled</dupMsgThrottle>
    </inst-items>
  </callhome-items>
</System>

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
 no duplicate-message throttle


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
dupMsgThrottlecallhome:Boolean
(scalar:Enum8)
Enable/Disable duplicate message throttlingSELECTION:
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

Configuring the Customer Service Contract Id
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "contractId": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <contractId>SampleString_123</contractId>
    </inst-items>
  </callhome-items>
</System>

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
 contract-id SampleString_123


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
contractIdcallhome: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

Deleting the Customer Service Contract Id
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "contractId": ""
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <contractId></contractId>
    </inst-items>
  </callhome-items>
</System>

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
 no contract-id SampleString_123


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
contractIdcallhome: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

Configuring the Customer Id
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "customerId": "Customer123456"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <customerId>Customer123456</customerId>
    </inst-items>
  </callhome-items>
</System>

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
  customer-id Customer123456


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
customerIdcallhome: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

Deleting the Customer Id
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "customerId": ""
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <customerId></customerId>
    </inst-items>
  </callhome-items>
</System>

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
  no customer-id Customer123456


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
customerIdcallhome: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

Configuring the Email Address of the Contact Person
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "emailId": "admin@Mycompany.com"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <emailId>admin@Mycompany.com</emailId>
    </inst-items>
  </callhome-items>
</System>

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
 email-contact admin@Mycompany.com


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
emailIdcallhome: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

Deleting the Email Address of the Contact Person
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "emailId": ""
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <emailId></emailId>
    </inst-items>
  </callhome-items>
</System>

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
 no email-contact admin@Mycompany.com


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
emailIdcallhome: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

Configuring the Phone Number of the Contact Person
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "phoneContact": "+1-800-123-4567"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <phoneContact>+1-800-123-4567</phoneContact>
    </inst-items>
  </callhome-items>
</System>

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
 phone-contact +1-800-123-4567


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
phoneContactcallhome: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

Deleting the Phone Number of the Contact Person
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "phoneContact": ""
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <phoneContact></phoneContact>
    </inst-items>
  </callhome-items>
</System>

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
 no phone-contact +1-800-123-4567


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
phoneContactcallhome: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

Configuring the Site Id of the Network Where the Switch is Deployed
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "siteId": "Site1"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <siteId>Site1</siteId>
    </inst-items>
  </callhome-items>
</System>

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
 site-id Site1


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
siteIdcallhome: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

Deleting the Site Id of the Network Where the Switch is Deployed
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "siteId": ""
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <siteId></siteId>
    </inst-items>
  </callhome-items>
</System>

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
 no site-id Site1


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
siteIdcallhome: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

Configuring the Replacement Part Shipping Address
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "streetAddress": "123 Anystreet st. Anytown,AnyWhere"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <streetAddress>123 Anystreet st. Anytown,AnyWhere</streetAddress>
    </inst-items>
  </callhome-items>
</System>

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
 streetaddress 123 Anystreet st. Anytown,AnyWhere


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
streetAddresscallhome: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

Deleting the Replacement Part Shipping Address
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "streetAddress": ""
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <streetAddress></streetAddress>
    </inst-items>
  </callhome-items>
</System>

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
 no streetaddress 123:12


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
streetAddresscallhome: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

Configuring the Switch Priority
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
"callhomeCallhome": {
  "children": [
    {
      "callhomeInst": {
        "attributes": {
          "switchPri": "5"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <switchPri>5</switchPri>
    </inst-items>
  </callhome-items>
</System>

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
 switch-priority


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
switchPriscalar: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

Deleting the Switch Priority
POST http://<mgmt0_IP>/api/mo/sys/callhome.json
{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "switchPri": "7"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <switchPri>7</switchPri>
    </inst-items>
  </callhome-items>
</System>

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
 no switch-priority


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.

MODN
callhomeCallhomesys/callhome
callhomeInstsys/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 NameData TypeDescriptionValues
switchPriscalar: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