Configuring a Destination Profile For Short Text Messages

Configuring the Alert Group for All Call Home Messages

Configuring the Alert Group for All Call Home Messages
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpAll": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpAll>enabled</alertGrpAll>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group All


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpAllcallhome:Boolean
(scalar:Enum8)
This alert group consists of all of the callhome messagesSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for All Call Home Messages

Deleting the Alert Group for All Call Home Messages
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpAll": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpAll>disabled</alertGrpAll>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group All


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpAllcallhome:Boolean
(scalar:Enum8)
This alert group consists of all of the callhome messagesSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Cisco TAC Only Events

Configuring the Alert Group for Cisco TAC Only Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpCiscoTac1": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpCiscoTac1>enabled</alertGrpCiscoTac1>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Cisco-TAC


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpCiscoTac1callhome:Boolean
(scalar:Enum8)
Events which are meant for Cisco TAC onlySELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Cisco TAC Only Events

Deleting the Alert Group for Cisco TAC Only Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpCiscoTac1": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpCiscoTac1>disabled</alertGrpCiscoTac1>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Cisco-TAC


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpCiscoTac1callhome:Boolean
(scalar:Enum8)
Events which are meant for Cisco TAC onlySELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Configuration Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpConfiguration": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpConfiguration>enabled</alertGrpConfiguration>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Configuration


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpConfigurationcallhome:Boolean
(scalar:Enum8)
Events related to ConfigurationSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Configuration Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpConfiguration": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpConfiguration>disabled</alertGrpConfiguration>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Configuration


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpConfigurationcallhome:Boolean
(scalar:Enum8)
Events related to ConfigurationSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Diagnostic Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpDiagnostic": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpDiagnostic>enabled</alertGrpDiagnostic>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Diagnostic


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpDiagnosticcallhome:Boolean
(scalar:Enum8)
Events related to DiagnosticSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Diagnostic Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpDiagnostic": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpDiagnostic>disabled</alertGrpDiagnostic>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Diagnostic


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpDiagnosticcallhome:Boolean
(scalar:Enum8)
Events related to DiagnosticSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for EEM Events

Configuring the Alert Group for EEM Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpEEM": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpEEM>enabled</alertGrpEEM>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group EEM


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpEEMcallhome:Boolean
(scalar:Enum8)
Events related to EEMSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for EEM Events

Deleting the Alert Group for EEM Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpEEM": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpEEM>disabled</alertGrpEEM>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group EEM


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpEEMcallhome:Boolean
(scalar:Enum8)
Events related to EEMSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Power, Fan, and Temperature Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpEnvironmental": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpEnvironmental>enabled</alertGrpEnvironmental>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Environmental


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpEnvironmentalcallhome:Boolean
(scalar:Enum8)
Power,Fan,Temperature related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Power, Fan, and Temperature Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpEnvironmental": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpEnvironmental>disabled</alertGrpEnvironmental>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Environmental


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpEnvironmentalcallhome:Boolean
(scalar:Enum8)
Power,Fan,Temperature related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Inventory Status Events

Configuring the Alert Group for Inventory Status Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpInventory": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpInventory>enabled</alertGrpInventory>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Inventory


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpInventorycallhome:Boolean
(scalar:Enum8)
Inventory Status EventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Inventory Status Events

Deleting the Alert Group for Inventory Status Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpInventory": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpInventory>disabled</alertGrpInventory>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Inventory


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpInventorycallhome:Boolean
(scalar:Enum8)
Inventory Status EventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Licensing Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpLicense": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpLicense>enabled</alertGrpLicense>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group License


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpLicensecallhome:Boolean
(scalar:Enum8)
Events related to licensingSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Licensing Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpLicense": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpLicense>disabled</alertGrpLicense>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group License


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpLicensecallhome:Boolean
(scalar:Enum8)
Events related to licensingSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Line Card Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpLinecard": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpLinecard>enabled</alertGrpLinecard>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Linecard-Hardware


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpLinecardcallhome:Boolean
(scalar:Enum8)
Linecard related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Line Card Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpLinecard": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpLinecard>disabled</alertGrpLinecard>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Linecard-Hardware


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpLinecardcallhome:Boolean
(scalar:Enum8)
Linecard related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Supervisor Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpSupervisor": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpSupervisor>enabled</alertGrpSupervisor>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Supervisor-Hardware


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpSupervisorcallhome:Boolean
(scalar:Enum8)
Supervisor related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Supervisor Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpSupervisor": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpSupervisor>disabled</alertGrpSupervisor>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Supervisor-Hardware


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpSupervisorcallhome:Boolean
(scalar:Enum8)
Supervisor related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Events Related to Syslog Messages Filed by Port Manager
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpSyslogPort": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpSyslogPort>enabled</alertGrpSyslogPort>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Syslog-group-port


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpSyslogPortcallhome:Boolean
(scalar:Enum8)
Events related to syslog messages filed by port managerSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Events Related to Syslog Messages Filed by Port Manager
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpSyslogPort": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpSyslogPort>disabled</alertGrpSyslogPort>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Syslog-group-port


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpSyslogPortcallhome:Boolean
(scalar:Enum8)
Events related to syslog messages filed by port managerSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Software Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpSystem": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpSystem>enabled</alertGrpSystem>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group System


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpSystemcallhome:Boolean
(scalar:Enum8)
Software related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for Software Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpSystem": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpSystem>disabled</alertGrpSystem>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group System


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpSystemcallhome:Boolean
(scalar:Enum8)
Software related eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for User Generated Test Events

Configuring the Alert Group for User Generated Test Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpTest": "enabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpTest>enabled</alertGrpTest>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination alert-group Test


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpTestcallhome:Boolean
(scalar:Enum8)
User generated test eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Alert Group for User Generated Test Events

Deleting the Alert Group for User Generated Test Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "alertGrpTest": "disabled",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <alertGrpTest>disabled</alertGrpTest>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination alert-group Test


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
alertGrpTestcallhome:Boolean
(scalar:Enum8)
User generated test eventsSELECTION:
0 - disabled
1 - enabled
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 a Destination Profile for Short Text Messages and an Index for an Email Id

Configuring a Destination Profile for Short Text Messages and an Index for an Email Id
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt"
          },
          "children": [
            {
              "callhomePredefProfEmail": {
                "attributes": {
                  "emailAddr": "name@address.com",
                  "seqNum": "23"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <pdprofemail-items>
              <PredefProfEmail-list>
                <seqNum>23</seqNum>
                <emailAddr>name@address.com</emailAddr>
              </PredefProfEmail-list>
            </pdprofemail-items>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination index 23 email-addr name@address.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
callhomeDestProf sys/callhome/inst/destprof
callhomePredefinedProfile sys/callhome/inst/destprof/predefprofile-short_txt
callhomePredefProfEmail sys/callhome/inst/destprof/predefprofile-short_txt/pdprofemail-23


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


callhomePredefProfEmail Properties

The following table contains information about the callhomePredefProfEmail 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
emailAddrcallhome:Email
(address:Email)
Email address for the profile
DEFAULT:
seqNumscalar:Uint32
Sequence number associated with email-id
RANGE: [1 , 50]


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 Destination Profile for Short Text Messages and an Index for an Email Id

Deleting a Destination Profile for Short Text Messages and an Index for an Email Id
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt"
          },
          "children": [
            {
              "callhomePredefProfEmail": {
                "attributes": {
                  "seqNum": "23",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <pdprofemail-items>
              <PredefProfEmail-list nc:operation="delete">
                <seqNum>23</seqNum>
              </PredefProfEmail-list>
            </pdprofemail-items>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination index 23 email-addr name@address.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
callhomeDestProf sys/callhome/inst/destprof
callhomePredefinedProfile sys/callhome/inst/destprof/predefprofile-short_txt
callhomePredefProfEmail sys/callhome/inst/destprof/predefprofile-short_txt/pdprofemail-23


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


callhomePredefProfEmail Properties

The following table contains information about the callhomePredefProfEmail 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
seqNumscalar:Uint32
Sequence number associated with email-id
RANGE: [1 , 50]
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
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 Destination Profile for Short Text Messages and Adding an HTTP or HTTPS URL

Configuring a Destination Profile for Short Text Messages and Adding an HTTP or HTTPS URL
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt"
          },
          "children": [
            {
              "callhomePredefProfHttp": {
                "attributes": {
                  "http": "http://somesite.com",
                  "seqNum": "31"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <pdprofhttp-items>
              <PredefProfHttp-list>
                <seqNum>31</seqNum>
                <http>http://somesite.com</http>
              </PredefProfHttp-list>
            </pdprofhttp-items>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination index 31 http http://somesite.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
callhomeDestProf sys/callhome/inst/destprof
callhomePredefinedProfile sys/callhome/inst/destprof/predefprofile-short_txt
callhomePredefProfHttp sys/callhome/inst/destprof/predefprofile-short_txt/pdprofhttp-31


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


callhomePredefProfHttp Properties

The following table contains information about the callhomePredefProfHttp 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
httpstring:Basic
HTTP URL configuration for the profile
RANGE: [11 , 255]
seqNumscalar:Uint32
Sequence number associated with HTTP URL
RANGE: [1 , 50]


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 Destination Profile for Short Text Messages and Adding an HTTP or HTTPS URL

Deleting a Destination Profile for Short Text Messages and Adding an HTTP or HTTPS URL
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt"
          },
          "children": [
            {
              "callhomePredefProfHttp": {
                "attributes": {
                  "seqNum": "31",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <pdprofhttp-items>
              <PredefProfHttp-list nc:operation="delete">
                <seqNum>31</seqNum>
              </PredefProfHttp-list>
            </pdprofhttp-items>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination index 31 http http://somesite.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
callhomeDestProf sys/callhome/inst/destprof
callhomePredefinedProfile sys/callhome/inst/destprof/predefprofile-short_txt
callhomePredefProfHttp sys/callhome/inst/destprof/predefprofile-short_txt/pdprofhttp-31


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


callhomePredefProfHttp Properties

The following table contains information about the callhomePredefProfHttp 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
seqNumscalar:Uint32
Sequence number associated with HTTP URL
RANGE: [1 , 50]
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
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 the Call Home Message Level

Configuring the Call Home Message Level
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "messageLevel": "1",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <messageLevel>1</messageLevel>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination message-level 1


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
messageLevelscalar:Uint32
Callhome message-level for the configured profile
RANGE: [0 , 9]
DEFAULT: 0
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Maximum Message Size

Configuring the Maximum Message Size
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "messageSize": "1",
            "predefProfile": "short_txt"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <messageSize>1</messageSize>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination message-size 1


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
messageSizescalar:Uint32
Callhome message-size for the configured profile
RANGE: [0 , 5000000]
DEFAULT: 2500000
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt


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 Transport Method for Email

Configuring the Transport Method for Email
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt",
            "transportMethodEmail": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <transportMethodEmail>enabled</transportMethodEmail>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination transport-method email


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt
transportMethodEmailcallhome:Boolean
(scalar:Enum8)
Trnasport method as email 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

Deleting the Transport Method for Email

Deleting the Transport Method for Email
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt",
            "transportMethodEmail": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <transportMethodEmail>disabled</transportMethodEmail>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination transport-method email


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt
transportMethodEmailcallhome:Boolean
(scalar:Enum8)
Trnasport method as email 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 Transport Method for HTTP URLs

Configuring the Transport Method for HTTP URLs
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt",
            "transportMethodHttp": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <transportMethodHttp>enabled</transportMethodHttp>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 destination-profile short-txt-destination transport-method http


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt
transportMethodHttpcallhome:Boolean
(scalar:Enum8)
Transport method as httpSELECTION:
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

Deleting the Transport Method for HTTP URLs

Deleting the Transport Method for HTTP URLs
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomePredefinedProfile": {
          "attributes": {
            "predefProfile": "short_txt",
            "transportMethodHttp": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <predefprofile-items>
          <PredefinedProfile-list>
            <predefProfile>short_txt</predefProfile>
            <transportMethodHttp>disabled</transportMethodHttp>
          </PredefinedProfile-list>
        </predefprofile-items>
      </destprof-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
 no destination-profile short-txt-destination transport-method http


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
callhomeDestProfsys/callhome/inst/destprof
callhomePredefinedProfilesys/callhome/inst/destprof/predefprofile-short_txt


callhomePredefinedProfile Properties

The following table contains information about the callhomePredefinedProfile 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
predefProfilecallhome:PredefProfileName
(scalar:Enum8)
Predefined destination profile namesSELECTION:
0 - predef_tac_prof
1 - full_txt
2 - short_txt
transportMethodHttpcallhome:Boolean
(scalar:Enum8)
Transport method as httpSELECTION:
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