Configuring Periodic Inventory Notifications

You can configure the device to periodically send a message with an inventory of all software services currently enabled and running on the device along with hardware inventory information. The device generates two Smart Call Home notifications: periodic configuration messages and periodic inventory messages.

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/

Configuring the Periodic Software Inventory Message Dispatch

Configuring the Periodic Software Inventory Message Dispatch

POST http://<mgmt0_IP>/api/mo/sys/callhome.json

{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "periodicInvNotif": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <periodicInvNotif>enabled</periodicInvNotif>
    </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
periodic-inventory notification

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
periodicInvNotif	callhome:Boolean (scalar:Enum8)	Enable/Disable periodic inventory notification	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 Periodic Software Inventory Message Dispatch

Disabling Periodic Software Inventory Message Dispatch

POST http://<mgmt0_IP>/api/mo/sys/callhome.json

{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "periodicInvNotif": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <periodicInvNotif>disabled</periodicInvNotif>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no periodic-inventory notification

Verifying a DME Configuration

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

callhomeInst Properties

Property Name	Data Type	Description	Values
periodicInvNotif	callhome:Boolean (scalar:Enum8)	Enable/Disable periodic inventory notification	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 Time Period for Periodic Inventory

Configuring the Time Period for Periodic Inventory

POST http://<mgmt0_IP>/api/mo/sys/callhome.json

{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "periodInvNotifInterval": "11"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <periodInvNotifInterval>11</periodInvNotifInterval>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
periodic-inventory notification interval 11

Verifying a DME Configuration

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

callhomeInst Properties

Property Name	Data Type	Description	Values
periodInvNotifInterval	callhome:PeriodicSystemInventoryIntervalDays (scalar:Uint32)	The time period for periodic inventory	RANGE: [1 , 30] 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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

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 Periodic Inventory notification

Disabling the Periodic Inventory notification

POST http://<mgmt0_IP>/api/mo/sys/callhome.json

{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "periodicInvNotif": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <periodicInvNotif>disabled</periodicInvNotif>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no periodic-inventory notification

Verifying a DME Configuration

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

callhomeInst Properties

Property Name	Data Type	Description	Values
periodicInvNotif	callhome:Boolean (scalar:Enum8)	Enable/Disable periodic inventory notification	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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

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 Time-of-Day for Periodic Inventory

Configuring the Time-of-Day for Periodic Inventory

POST http://<mgmt0_IP>/api/mo/sys/callhome.json

{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "periodInvNotifTimeOfDayHour": "12",
            "periodInvNotifTimeOfDayMinute": "10"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <periodInvNotifTimeOfDayHour>12</periodInvNotifTimeOfDayHour>
      <periodInvNotifTimeOfDayMinute>10</periodInvNotifTimeOfDayMinute>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
periodic-inventory notification timeofday 12:10

Verifying a DME Configuration

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

callhomeInst Properties

Property Name	Data Type	Description	Values
periodInvNotifTimeOfDayHour	callhome:PeriodicSystemInventoryTimeOfDayHour (scalar:Uint32)	The hour part of time period	RANGE: [0 , 23] DEFAULT: 8
periodInvNotifTimeOfDayMinute	callhome:PeriodicSystemInventoryTimeOfDayMinute (scalar:Uint32)	The minute part of time period	RANGE: [0 , 59] DEFAULT: 0

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

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 Periodic Inventory Notification

Disabling the Periodic Inventory Notification

POST http://<mgmt0_IP>/api/mo/sys/callhome.json

{
  "callhomeCallhome": {
    "children": [
      {
        "callhomeInst": {
          "attributes": {
            "periodicInvNotif": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <periodicInvNotif>disabled</periodicInvNotif>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no periodic-inventory notification

Verifying a DME Configuration

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

callhomeInst Properties

Property Name	Data Type	Description	Values
periodicInvNotif	callhome:Boolean (scalar:Enum8)	Enable/Disable periodic inventory notification	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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

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