Configuring Call Home Alert Groups

An alert group is a predefined subset of Call Home alerts that are supported in all Cisco Nexus devices. Alert groups allow you to select the set of Call Home alerts that you want to send to a predefined or custom destination profile. The device sends Call Home alerts to email destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile and if the alert has a Call Home message severity at or above the message severity set in the destination profile.

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 a CLI Command for an Alert Group for Configuration Events

Example: <description>

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "configuration",
            "seqNum": "1",
            "userDefCmd": "show startup-config"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>configuration</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show startup-config</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </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
alert-group configuration index 1 user-def-cmd show startup-config

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
callhomeInst	sys/callhome/inst
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1

callhomeAlertGroup Properties

The following table contains information about the callhomeAlertGroup 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
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Configuration Events

Deleting a CLI Command for an Alert Group for Configuration Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "configuration",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>configuration</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Configuration index 1 user-def-cmd show startup-config

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Diagnostic Events

Configuring a CLI Command for an Alert Group for Diagnostic Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "diagnostic",
            "seqNum": "1",
            "userDefCmd": "show version"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>diagnostic</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show version</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group Diagnostic index 1 user-def-cmd show version

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Diagnostic Events

Deleting a CLI Command for an Alert Group for Diagnostic Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "diagnostic",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>diagnostic</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Diagnostic index 1 user-def-cmd show version

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Power, Fan, and Temperature Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "environmental",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>environmental</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group Environmental index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Power, Fan, and Temperature Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "environmental",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>environmental</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Environmental index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Inventory Status Events

Configuring a CLI Command for an Alert Group for Inventory Status Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "inventory",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>inventory</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group Inventory index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Inventory Status Events

Deleting a CLI Command for an Alert Group for Inventory Status Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "inventory",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>inventory</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Inventory index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Events Related to Licensing

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "license",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>license</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group License index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Events Related to Licensing

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "license",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>license</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group License index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Linecard Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "linecard",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>linecard</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group Linecard-Hardware index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Linecard Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "linecard",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>linecard</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Linecard-Hardware index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Supervisor Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "supervisor",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>supervisor</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group Supervisor-Hardware index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Supervisor Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "supervisor",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>supervisor</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Supervisor-Hardware index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Events Related to Syslog Messages Filled by Port Manager

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "syslogport",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>syslogport</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group Syslog-group-port index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Events Related to Syslog Messages Filled by Port Manager

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "syslogport",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>syslogport</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Syslog-group-port index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for Software Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "system",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>system</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group System index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for Software Related Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "system",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>system</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group System index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 a CLI Command for an Alert Group for User-Generated Test Events

Configuring a CLI Command for an Alert Group for User-Generated Test Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "test",
            "seqNum": "1",
            "userDefCmd": "show module"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list>
          <alertGroup>test</alertGroup>
          <seqNum>1</seqNum>
          <userDefCmd>show module</userDefCmd>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
alert-group Test index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
userDefCmd	string:Basic	User defined show commands for alert group action	RANGE: [1 , 600]

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

Deleting a CLI Command for an Alert Group for User-Generated Test Events

Deleting a CLI Command for an Alert Group for User-Generated Test Events

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeAlertGroup": {
          "attributes": {
            "alertGroup": "test",
            "seqNum": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <alertgroup-items>
        <AlertGroup-list nc:operation="delete">
          <alertGroup>test</alertGroup>
          <seqNum>1</seqNum>
        </AlertGroup-list>
      </alertgroup-items>
    </inst-items>
  </callhome-items>
</System>

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

CLI Commands

callhome
no alert-group Test index 1 user-def-cmd show module

Verifying a DME Configuration

MO	DN
callhomeAlertGroup	sys/callhome/inst/alertgroup-configuration-1
callhomeInst	sys/callhome/inst

callhomeAlertGroup Properties

Property Name	Data Type	Description	Values
alertGroup	callhome:AlertGroupName (scalar:Enum16)	Grouped callhome alerts	SELECTION: 0 - configuration 1 - diagnostic 2 - environmental 3 - inventory 4 - license 5 - linecard 6 - supervisor 7 - syslogport 8 - system 9 - test
seqNum	scalar:Uint32	Sequence number assosiated with user defined command	RANGE: [1 , 5]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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