Configuring a User Defined Destination Profile

Configuring a Destination Profile with an Email Id Index

Configuring a Destination Profile with an Email Id Index
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123"
          },
          "children": [
            {
              "callhomeCustomEmail": {
                "attributes": {
                  "emailAddr": "name@abc.com",
                  "seqNum": "19"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <custemail-items>
              <CustomEmail-list>
                <seqNum>19</seqNum>
                <emailAddr>name@abc.com</emailAddr>
              </CustomEmail-list>
            </custemail-items>
          </CustomProfile-list>
        </custprof-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 SampleString_123 index 19 email-addr name@abc.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
callhomeCustomEmail sys/callhome/inst/destprof/custprof-SampleString_123/custemail-19
callhomeCustomProfile sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf sys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


callhomeCustomEmail Properties

The following table contains information about the callhomeCustomEmail 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 to send email notifications
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 with an Email Id Index

Deleting a Destination Profile with an Email Id Index
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123"
          },
          "children": [
            {
              "callhomeCustomEmail": {
                "attributes": {
                  "seqNum": "19",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <custemail-items>
              <CustomEmail-list nc:operation="delete">
                <seqNum>19</seqNum>
              </CustomEmail-list>
            </custemail-items>
          </CustomProfile-list>
        </custprof-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 SampleString_123 index 19 email-addr name@abc.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
callhomeCustomEmail sys/callhome/inst/destprof/custprof-SampleString_123/custemail-19
callhomeCustomProfile sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf sys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


callhomeCustomEmail Properties

The following table contains information about the callhomeCustomEmail 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 an Index for Email Id and Adding an HTTP or HTTPS URL

Configuring an Index for Email Id and Adding an HTTP or HTTPS URL
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123"
          },
          "children": [
            {
              "callhomeCustomHttp": {
                "attributes": {
                  "http": "http://somesite.com",
                  "seqNum": "12"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <custhttp-items>
              <CustomHttp-list>
                <seqNum>12</seqNum>
                <http>http://somesite.com</http>
              </CustomHttp-list>
            </custhttp-items>
          </CustomProfile-list>
        </custprof-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 SampleString_123 index 12 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
callhomeCustomHttp sys/callhome/inst/destprof/custprof-SampleString_123/custhttp-12
callhomeCustomProfile sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf sys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


callhomeCustomHttp Properties

The following table contains information about the callhomeCustomHttp 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 custom 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 an Index for Email Id and Adding an HTTP or HTTPS URL

Deleting an Index for Email Id and Adding an HTTP or HTTPS URL
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123"
          },
          "children": [
            {
              "callhomeCustomHttp": {
                "attributes": {
                  "seqNum": "12",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <custhttp-items>
              <CustomHttp-list nc:operation="delete">
                <seqNum>12</seqNum>
              </CustomHttp-list>
            </custhttp-items>
          </CustomProfile-list>
        </custprof-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 SampleString_123 index 12 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
callhomeCustomHttp sys/callhome/inst/destprof/custprof-SampleString_123/custhttp-12
callhomeCustomProfile sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf sys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


callhomeCustomHttp Properties

The following table contains information about the callhomeCustomHttp 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 a Destination Profile

Configuring a Destination Profile
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "Str_1"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>Str_1</profileName>
          </CustomProfile-list>
        </custprof-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 Str_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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-Str_1
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Deleting a Destination Profile

Deleting a Destination Profile
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "Str_1",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list xc:operation="delete">
            <profileName>Str_1</profileName>
          </CustomProfile-list>
        </custprof-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 Str_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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-Str_1
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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

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 Call Home Message Level

Configuring a Call Home Message Level
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "messageLevel": "1",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <messageLevel>1</messageLevel>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Maximum Message Size

Configuring the Maximum Message Size
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "messageSize": "1",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <messageSize>1</messageSize>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Email Transport Method for a Given Profile

Configuring the Email Transport Method for a Given Profile
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123",
            "transportMethodEmail": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <transportMethodEmail>enabled</transportMethodEmail>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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 Email Transport Method for a Given Profile

Configuring the Email Transport Method for a Given Profile
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123",
            "transportMethodEmail": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <transportMethodEmail>disabled</transportMethodEmail>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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 HTTP Transport Method

Configuring the HTTP Transport Method
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123",
            "transportMethodHttp": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <transportMethodHttp>enabled</transportMethodHttp>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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 HTTP Transport Method

Deleting the HTTP Transport Method
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123",
            "transportMethodHttp": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <transportMethodHttp>disabled</transportMethodHttp>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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

Configuring an Alert Group for All Call Home Messages

Configuring an Alert Group for All Call Home Messages
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpAll": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpAll>enabled</alertGrpAll>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the 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": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpCiscoTac1": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpCiscoTac1>enabled</alertGrpCiscoTac1>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Alert Group for Configuration Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpConfiguration": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpConfiguration>enabled</alertGrpConfiguration>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Alert Group for Diagnostic Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpDiagnostic": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpDiagnostic>enabled</alertGrpDiagnostic>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the 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": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpEEM": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpEEM>enabled</alertGrpEEM>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Alert Group for Power, Fan, and Temperature Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpEnvironmental": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpEnvironmental>enabled</alertGrpEnvironmental>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the 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": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpInventory": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpInventory>enabled</alertGrpInventory>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Alert Group for Licensing Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpLicense": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpLicense>enabled</alertGrpLicense>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Alert Group for Line Card Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpLinecard": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpLinecard>enabled</alertGrpLinecard>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Alert Group for Supervisor Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpSupervisor": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpSupervisor>enabled</alertGrpSupervisor>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the 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": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpSyslogPort": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpSyslogPort>enabled</alertGrpSyslogPort>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the Alert Group for Software Related Events
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpSystem": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpSystem>enabled</alertGrpSystem>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring the 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": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "alertGrpTest": "enabled",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <alertGrpTest>enabled</alertGrpTest>
          </CustomProfile-list>
        </custprof-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 SampleString_123 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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Configuring Plain Text Message Format

Configuring Plain Text Message Format
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "format": "full-txt",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <format>full-txt</format>
          </CustomProfile-list>
        </custprof-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 SampleString_123 format full-txt


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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
formatcallhome:Format
(scalar:Enum8)
Callhome message format to be sent to configured profileSELECTION:
1 - xml
2 - full-txt
3 - short-txt
DEFAULT: xml
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Deleting the Plain Text Message Format Configuration

Deleting the Plain Text Message Format Configuration
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list xc:operation="delete">
            <profileName>SampleString_123</profileName>
          </CustomProfile-list>
        </custprof-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 SampleString_123 format full-txt


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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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

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 Short Text Message Format

Configuring Short Text Message Format
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "format": "short-txt",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <format>short-txt</format>
          </CustomProfile-list>
        </custprof-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 SampleString_123 format short-txt


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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
formatcallhome:Format
(scalar:Enum8)
Callhome message format to be sent to configured profileSELECTION:
1 - xml
2 - full-txt
3 - short-txt
DEFAULT: xml
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Deleting the Short Text Message Format Configuration

Deleting the Short Text Message Format Configuration
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list xc:operation="delete">
            <profileName>SampleString_123</profileName>
          </CustomProfile-list>
        </custprof-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 SampleString_123 format short-txt


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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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

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 XML Text Message Format

Configuring XML Text Message Format
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "format": "xml",
            "profileName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list>
            <profileName>SampleString_123</profileName>
            <format>xml</format>
          </CustomProfile-list>
        </custprof-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 SampleString_123 format XML


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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
formatcallhome:Format
(scalar:Enum8)
Callhome message format to be sent to configured profileSELECTION:
1 - xml
2 - full-txt
3 - short-txt
DEFAULT: xml
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:


Related Documentation

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

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

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

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

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

Deleting the XML Text Message Format Configuration

Deleting the XML Text Message Format Configuration
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst/destprof.json
{
  "callhomeDestProf": {
    "children": [
      {
        "callhomeCustomProfile": {
          "attributes": {
            "profileName": "SampleString_123",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <callhome-items>
    <inst-items>
      <destprof-items>
        <custprof-items>
          <CustomProfile-list xc:operation="delete">
            <profileName>SampleString_123</profileName>
          </CustomProfile-list>
        </custprof-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 SampleString_123 format XML


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
callhomeCustomProfilesys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProfsys/callhome/inst/destprof


callhomeCustomProfile Properties

The following table contains information about the callhomeCustomProfile 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
profileNamestring:Basic
User defined destination profile name
RANGE: [0 , 31]
DEFAULT:
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

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