Configuring an IPv4 Node Under an ITD Device Group

Configuring Hot-Standby Mode

Configuring Hot-Standby Mode

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"
}}}]}}]}}

{
    imdata:[]
}

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

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.

MODN
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress:IPv4
The IP address.Value must match ipv4 format
modeitd: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

Deleting Hot-Standby Mode

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": "primary"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <mode>primary</mode>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

itd device-group deviceGroup_Name
 node ip 1.2.3.4
  no 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.

MODN
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress:IPv4
The IP address.Value must match ipv4 format
modeitd: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

Configuring Traffic Distribution Weight  

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",
                  "weight": "148"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <weight>148</weight>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

itd device-group deviceGroup_Name
 node ip 1.2.3.4
  weight 148


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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress:IPv4
The IP address.Value must match ipv4 format
weightscalar: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

Deleting Traffic Distribution Weight 

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",
                  "weight": "0"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <weight>0</weight>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

itd device-group deviceGroup_Name
 node ip 1.2.3.4
  no weight 148


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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress:IPv4
The IP address.Value must match ipv4 format
weightscalar: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

Configuring a DNS Protocol Service Probe at the Node-Level

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "SampleString_123",
                        "frequency": "402909",
                        "httpGetStr": "",
                        "port": "0",
                        "probeIp": "1.2.3.4",
                        "protocol": "DNS",
                        "retryDownCount": "1",
                        "retryUpCount": "1",
                        "timeout": "1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost>SampleString_123</dnshost>
                <frequency>402909</frequency>
                <httpGetStr></httpGetStr>
                <port>0</port>
                <probeIp>1.2.3.4</probeIp>
                <protocol>DNS</protocol>
                <retryDownCount>1</retryDownCount>
                <retryUpCount>1</retryUpCount>
                <timeout>1</timeout>
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
ctrlStatusEnableitd:ctrlType
(scalar:Enum8)		SELECTION:
0 - disable
1 - enable
DEFAULT: disable
dnshostitd:DnsHostType
(string:Basic)
MAX SIZE: 99
frequencyscalar:Uint32
RANGE: [0 , 604800]
DEFAULT: 0
httpGetStritd:HttpStringType
(string:Basic)
MAX SIZE: 99
portaddress:PortNumber
(scalar:Uint16)		The service port number for the LDAP service.
RANGE: [0 , 65535]
DEFAULT: 0
probeIpaddress:IPv4
Value must match ipv4 format
protocolitd: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
retryDownCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
retryUpCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
timeoutscalar: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

Deleting a DNS Protocol Service Probe at the Node-Level

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items xc:operation="delete">
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
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 an HTTP Protocol Service Probe

Configuring an HTTP Protocol Service Probe

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "",
                        "frequency": "405757",
                        "httpGetStr": "SampleString_123",
                        "port": "0",
                        "probeIp": "1.2.3.4",
                        "protocol": "HTTP",
                        "retryDownCount": "1",
                        "retryUpCount": "1",
                        "timeout": "1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost></dnshost>
                <frequency>405757</frequency>
                <httpGetStr>SampleString_123</httpGetStr>
                <port>0</port>
                <probeIp>1.2.3.4</probeIp>
                <protocol>HTTP</protocol>
                <retryDownCount>1</retryDownCount>
                <retryUpCount>1</retryUpCount>
                <timeout>1</timeout>
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
ctrlStatusEnableitd:ctrlType
(scalar:Enum8)		SELECTION:
0 - disable
1 - enable
DEFAULT: disable
dnshostitd:DnsHostType
(string:Basic)
MAX SIZE: 99
frequencyscalar:Uint32
RANGE: [0 , 604800]
DEFAULT: 0
httpGetStritd:HttpStringType
(string:Basic)
MAX SIZE: 99
portaddress:PortNumber
(scalar:Uint16)		The service port number for the LDAP service.
RANGE: [0 , 65535]
DEFAULT: 0
probeIpaddress:IPv4
Value must match ipv4 format
protocolitd: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
retryDownCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
retryUpCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
timeoutscalar: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

Deleting an HTTP Protocol Service Probe

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items xc:operation="delete">
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
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 an ICMP Protocol Service Probe at the Node Level

Configuring an ICMP Protocol Service Probe at the Node Level

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "",
                        "frequency": "402909",
                        "httpGetStr": "",
                        "port": "0",
                        "probeIp": "1.2.3.4",
                        "protocol": "ICMP",
                        "retryDownCount": "1",
                        "retryUpCount": "1",
                        "timeout": "1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost></dnshost>
                <frequency>402909</frequency>
                <httpGetStr></httpGetStr>
                <port>0</port>
                <probeIp>1.2.3.4</probeIp>
                <protocol>ICMP</protocol>
                <retryDownCount>1</retryDownCount>
                <retryUpCount>1</retryUpCount>
                <timeout>1</timeout>
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
ctrlStatusEnableitd:ctrlType
(scalar:Enum8)		SELECTION:
0 - disable
1 - enable
DEFAULT: disable
dnshostitd:DnsHostType
(string:Basic)
MAX SIZE: 99
frequencyscalar:Uint32
RANGE: [0 , 604800]
DEFAULT: 0
httpGetStritd:HttpStringType
(string:Basic)
MAX SIZE: 99
portaddress:PortNumber
(scalar:Uint16)		The service port number for the LDAP service.
RANGE: [0 , 65535]
DEFAULT: 0
probeIpaddress:IPv4
Value must match ipv4 format
protocolitd: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
retryDownCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
retryUpCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
timeoutscalar: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

Deleting an ICMP Protocol Service Probe at the Node Level

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items xc:operation="delete">
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
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 UDP Protocol Service Probe at the Node Level

Configuring a UDP Protocol Service Probe at the Node Level

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "enable",
                        "dnshost": "",
                        "frequency": "402909",
                        "httpGetStr": "",
                        "port": "11890",
                        "probeIp": "1.2.3.4",
                        "protocol": "UDP",
                        "retryDownCount": "1",
                        "retryUpCount": "1",
                        "timeout": "1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items>
                <ctrlStatusEnable>enable</ctrlStatusEnable>
                <dnshost></dnshost>
                <frequency>402909</frequency>
                <httpGetStr></httpGetStr>
                <port>11890</port>
                <probeIp>1.2.3.4</probeIp>
                <protocol>UDP</protocol>
                <retryDownCount>1</retryDownCount>
                <retryUpCount>1</retryUpCount>
                <timeout>1</timeout>
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
ctrlStatusEnableitd:ctrlType
(scalar:Enum8)		SELECTION:
0 - disable
1 - enable
DEFAULT: disable
dnshostitd:DnsHostType
(string:Basic)
MAX SIZE: 99
frequencyscalar:Uint32
RANGE: [0 , 604800]
DEFAULT: 0
httpGetStritd:HttpStringType
(string:Basic)
MAX SIZE: 99
portaddress:PortNumber
(scalar:Uint16)		The service port number for the LDAP service.
RANGE: [0 , 65535]
DEFAULT: 0
probeIpaddress:IPv4
Value must match ipv4 format
protocolitd: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
retryDownCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
retryUpCountscalar:Uint32
RANGE: [0 , 5]
DEFAULT: 0
timeoutscalar: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

Deleting a UDP Protocol Service Probe at the Node Level

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"
                },
                "children": [
                  {
                    "itdProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev4-items>
            <Nodev4-list>
              <ip>1.2.3.4</ip>
              <probe-items xc:operation="delete">
              </probe-items>
            </Nodev4-list>
          </nodev4-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-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.

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

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
itdDeviceGroupsys/itd/inst/devgrp-deviceGroup_Name
itdInstsys/itd/inst
itdNodev4sys/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 NameData TypeDescriptionValues
dgNameitd: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 NameData TypeDescriptionValues
ipaddress: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 NameData TypeDescriptionValues
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