Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring a Destination Profile with an Email Id Index

DME

YANG

Copy
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"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<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>

Configuring a User Defined Destination Profile

Configuring a Destination Profile with an Email Id Index

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.

MO	DN
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 Name	Data Type	Description	Values
profileName	string: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 Name	Data Type	Description	Values
emailAddr	callhome:Email (address:Email)	Email address to send email notifications	DEFAULT:
seqNum	scalar: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

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

CLI Commands

callhome
no destination-profile SampleString_123 index 19 email-addr name@abc.com

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:

callhomeCustomEmail Properties

Property Name	Data Type	Description	Values
seqNum	scalar:Uint32	Sequence number associated with email-id	RANGE: [1 , 50]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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

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

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

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

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

Configuring an Index for Email Id and Adding an HTTP or HTTPS URL

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

CLI Commands

callhome
destination-profile SampleString_123 index 12 http http://somesite.com

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
profileName	string: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 Name	Data Type	Description	Values
http	string:Basic	HTTP URL configuration for custom profile	RANGE: [11 , 255]
seqNum	scalar: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

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

CLI Commands

callhome
no destination-profile SampleString_123 index 12 http http://somesite.com

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:

callhomeCustomHttp Properties

Property Name	Data Type	Description	Values
seqNum	scalar:Uint32	Sequence number associated with http url	RANGE: [1 , 50]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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

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

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

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

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

Configuring a Destination Profile

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

CLI Commands

callhome
destination-profile Str_1

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-Str_1
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string: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

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

CLI Commands

callhome
no destination-profile Str_1

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-Str_1
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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

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

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

CLI Commands

callhome
destination-profile SampleString_123 message-level 1

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
messageLevel	scalar:Uint32	Callhome message-level for the configured profile	RANGE: [0 , 9] DEFAULT: 0
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 message-size 1

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
messageSize	scalar:Uint32	Callhome message-size for the configured profile	RANGE: [0 , 5000000] DEFAULT: 2500000
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 transport-method email

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
transportMethodEmail	callhome: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

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

CLI Commands

callhome
no destination-profile SampleString_123 transport-method email

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
transportMethodEmail	callhome: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

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

CLI Commands

callhome
destination-profile SampleString_123 transport-method http

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
transportMethodHttp	callhome:Boolean (scalar:Enum8)	Transport method as http	SELECTION: 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

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

CLI Commands

callhome
no destination-profile SampleString_123 transport-method http

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
transportMethodHttp	callhome:Boolean (scalar:Enum8)	Transport method as http	SELECTION: 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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group All

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpAll	callhome:Boolean (scalar:Enum8)	This alert group consists of all of the callhome messages	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Cisco-TAC

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpCiscoTac1	callhome:Boolean (scalar:Enum8)	Events which are meant for Cisco TAC only	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Configuration

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpConfiguration	callhome:Boolean (scalar:Enum8)	Events related to Configuration	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Diagnostic

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpDiagnostic	callhome:Boolean (scalar:Enum8)	Events related to Diagnostic	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group EEM

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpEEM	callhome:Boolean (scalar:Enum8)	Events related to EEM	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Environmental

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpEnvironmental	callhome:Boolean (scalar:Enum8)	Power,Fan,Temperature related events	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Inventory

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpInventory	callhome:Boolean (scalar:Enum8)	Inventory Status Events	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group License

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpLicense	callhome:Boolean (scalar:Enum8)	Events related to licensing	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Linecard-Hardware

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpLinecard	callhome:Boolean (scalar:Enum8)	Linecard related events	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Supervisor-Hardware

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpSupervisor	callhome:Boolean (scalar:Enum8)	Supervisor related events	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Syslog-group-port

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpSyslogPort	callhome:Boolean (scalar:Enum8)	Events related to syslog messages filed by port manager	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group System

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpSystem	callhome:Boolean (scalar:Enum8)	Software related events	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 alert-group Test

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
alertGrpTest	callhome:Boolean (scalar:Enum8)	User generated test events	SELECTION: 0 - disabled 1 - enabled
profileName	string: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

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

CLI Commands

callhome
destination-profile SampleString_123 format full-txt

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
format	callhome:Format (scalar:Enum8)	Callhome message format to be sent to configured profile	SELECTION: 1 - xml 2 - full-txt 3 - short-txt DEFAULT: xml
profileName	string: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

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

CLI Commands

callhome
no destination-profile SampleString_123 format full-txt

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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

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

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

CLI Commands

callhome
destination-profile SampleString_123 format short-txt

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
format	callhome:Format (scalar:Enum8)	Callhome message format to be sent to configured profile	SELECTION: 1 - xml 2 - full-txt 3 - short-txt DEFAULT: xml
profileName	string: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

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

CLI Commands

callhome
no destination-profile SampleString_123 format short-txt

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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

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

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

CLI Commands

callhome
destination-profile SampleString_123 format XML

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
format	callhome:Format (scalar:Enum8)	Callhome message format to be sent to configured profile	SELECTION: 1 - xml 2 - full-txt 3 - short-txt DEFAULT: xml
profileName	string: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

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

CLI Commands

callhome
no destination-profile SampleString_123 format XML

Verifying a DME Configuration

MO	DN
callhomeCustomProfile	sys/callhome/inst/destprof/custprof-SampleString_123
callhomeDestProf	sys/callhome/inst/destprof

callhomeCustomProfile Properties

Property Name	Data Type	Description	Values
profileName	string:Basic	User defined destination profile name	RANGE: [0 , 31] DEFAULT:
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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

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

Response

Configuring a User Defined Destination Profile

Configuring a Destination Profile with an Email Id Index

Deleting a Destination Profile with an Email Id Index

Configuring 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

Configuring a Destination Profile

Deleting a Destination Profile

Configuring a Call Home Message Level

Configuring the Maximum Message Size

Configuring the Email Transport Method for a Given Profile

Configuring the Email Transport Method for a Given Profile

Configuring the HTTP Transport Method

Deleting the HTTP Transport Method

Configuring an Alert Group for All Call Home Messages

Configuring the Alert Group for Cisco TAC Only Events

Configuring the Alert Group for Configuration Related Events

Configuring the Alert Group for Diagnostic Related Events

Configuring the Alert Group for EEM Events

Configuring the Alert Group for Power, Fan, and Temperature Related Events

Configuring the Alert Group for Inventory Status Events

Configuring the Alert Group for Licensing Related Events

Configuring the Alert Group for Line Card Related Events

Configuring the Alert Group for Supervisor Related Events

Configuring the Alert Group for Events Related to Syslog Messages Filed by Port Manager

Configuring the Alert Group for Software Related Events

Configuring the Alert Group for User Generated Test Events

Configuring Plain Text Message Format

Deleting the Plain Text Message Format Configuration

Configuring Short Text Message Format

Deleting the Short Text Message Format Configuration

Configuring XML Text Message Format

Deleting the XML Text Message Format Configuration