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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Hot-Standby Mode

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdNodev4": {
                "attributes": {
                  "ip": "1.2.3.4",
                  "mode": "hot-standby"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <mode>hot-standby</mode>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

Configuring an IPv4 Node Under an ITD Device Group

Configuring Hot-Standby Mode

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.

itd device-group deviceGroup_Name
node ip 1.2.3.4
mode hot-standby

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
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

The following table contains information about the itdDeviceGroup 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
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

The following table contains information about the itdNodev4 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
ip	address:IPv4	The IP address.	Value must match ipv4 format
mode	itd:nodeModeType (scalar:Enum8)	ITD node mode.	SELECTION: 0 - primary 1 - hot-standby DEFAULT: primary

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 Hot-Standby Mode

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
no mode hot-standby

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format
mode	itd:nodeModeType (scalar:Enum8)	The BGP Domain mode.	SELECTION: 0 - primary 1 - hot-standby DEFAULT: primary

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 Traffic Distribution Weight

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
weight 148

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format
weight	scalar:Uint32	The weight of the fault in calculating the health score of an object. A higher weight causes a higher degradation of the health score of the affected object.	RANGE: [0, 4294967295]

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 Traffic Distribution Weight

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
no weight 148

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format
weight	scalar:Uint32	The weight of the fault in calculating the health score of an object. A higher weight causes a higher degradation of the health score of the affected object.	RANGE: [0, 4294967295]

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 DNS Protocol Service Probe at the Node-Level

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
probe dns host SampleString_123 timeout 1 retry-up-count 1 frequency 402909 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

The following table contains information about the itdProbe 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
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
probeIp	address:IPv4	Value must match ipv4 format
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0

Related Documentation

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

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

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 DNS Protocol Service Probe at the Node-Level

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
no probe dns host SampleString_123 timeout 1 retry-up-count 1 frequency 402909 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

Property Name	Data Type	Description	Values
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 an HTTP Protocol Service Probe

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
probe http get SampleString_123 timeout 1 retry-up-count 1 frequency 405757 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
probeIp	address:IPv4	Value must match ipv4 format
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0

Related Documentation

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

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

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 an HTTP Protocol Service Probe

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
no probe http get SampleString_123 timeout 1 retry-up-count 1 frequency 405757 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

Property Name	Data Type	Description	Values
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 an ICMP Protocol Service Probe at the Node Level

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
probe icmp timeout 1 retry-up-count 1 frequency 402909 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
probeIp	address:IPv4	Value must match ipv4 format
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0

Related Documentation

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

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

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 an ICMP Protocol Service Probe at the Node Level

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
no probe icmp timeout 1 retry-up-count 1 frequency 402909 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

Property Name	Data Type	Description	Values
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 UDP Protocol Service Probe at the Node Level

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
probe udp port 11890 control enable timeout 1 retry-up-count 1 frequency 402909 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
probeIp	address:IPv4	Value must match ipv4 format
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0

Related Documentation

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

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

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 UDP Protocol Service Probe at the Node Level

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

CLI Commands

itd device-group deviceGroup_Name
node ip 1.2.3.4
no probe udp port 11890 control enable timeout 1 retry-up-count 1 frequency 402909 retry-down-count 1 ip 1.2.3.4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev4	sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

itdNodev4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format

itdProbe Properties

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