Configuring an ITD Device Group

Configuring an ITD Device Group

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>SampleString_123</dgName>
        </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 SampleString_123

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-SampleString_123
itdInst	sys/itd/inst

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

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 ITD Device Group

Deleting an ITD Device Group

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "SampleString_123",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list xc:operation="delete">
          <dgName>SampleString_123</dgName>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

no itd device-group SampleString_123

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-SampleString_123
itdInst	sys/itd/inst

itdDeviceGroup Properties

Property Name	Data Type	Description	Values
dgName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
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 ITD Device Group Under a Service

Configuring an ITD Device Group Under a Service

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "defaultDevGroup": "SampleString_123",
            "name": "Service_Name"
}}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <defaultDevGroup>SampleString_123</defaultDevGroup>
        </Service-list>
      </service-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd Service_Name
device-group SampleString_123

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name

itdService Properties

The following table contains information about the itdService 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
defaultDevGroup	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

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 ITD Device Group under a Service

Deleting an ITD Device Group under a Service

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "defaultDevGroup": "",
            "name": "Service_Name"
}}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <defaultDevGroup></defaultDevGroup>
        </Service-list>
      </service-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd Service_Name
no device-group SampleString_123

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name

itdService Properties

Property Name	Data Type	Description	Values
defaultDevGroup	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

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 ITD Node IPv4 Address

Configuring an ITD Node IPv4 Address

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

{
    imdata:[]
}

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

itd device-group deviceGroup_Name
node 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

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

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 ITD Node IPv4 Address

Deleting an ITD Node IPv4 Address

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",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

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

itd device-group deviceGroup_Name
no node 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
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 ITD Node IPv6 Address

Configuring an ITD Node IPv6 Address

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdNodev6": {
                "attributes": {
                  "ip": "1:2::3:4"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev6-items>
            <Nodev6-list>
              <ip>1:2::3:4</ip>
            </Nodev6-list>
          </nodev6-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
node IPv6 1:2::3:4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev6	sys/itd/inst/devgrp-deviceGroup_Name/nodev6-1:2::3:4

itdDeviceGroup Properties

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

itdNodev6 Properties

The following table contains information about the itdNodev6 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:IPv6	The IP address.	Value must match ipv6 format

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 ITD Node IPv6 Address

Deleting an ITD Node IPv6 Address

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdNodev6": {
                "attributes": {
                  "ip": "1:2::3:4",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <nodev6-items>
            <Nodev6-list xc:operation="delete">
              <ip>1:2::3:4</ip>
            </Nodev6-list>
          </nodev6-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
no node IPv6 1:2::3:4

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst
itdNodev6	sys/itd/inst/devgrp-deviceGroup_Name/nodev6-1:2::3:4

itdDeviceGroup Properties

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

itdNodev6 Properties

Property Name	Data Type	Description	Values
ip	address:IPv6	The IP address.	Value must match ipv6 format
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 Probe at the Device-Group Level

Configuring an ICMP Protocol Probe at the Device-Group Level

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "ctrlStatusEnable": "disable",
                  "dnshost": "",
                  "frequency": "527192",
                  "httpGetStr": "",
                  "port": "0",
                  "probeIp": "0.0.0.0",
                  "protocol": "ICMP",
                  "retryDownCount": "3",
                  "retryUpCount": "3",
                  "timeout": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items>
            <ctrlStatusEnable>disable</ctrlStatusEnable>
            <dnshost></dnshost>
            <frequency>527192</frequency>
            <httpGetStr></httpGetStr>
            <port>0</port>
            <probeIp>0.0.0.0</probeIp>
            <protocol>ICMP</protocol>
            <retryDownCount>3</retryDownCount>
            <retryUpCount>3</retryUpCount>
            <timeout>1</timeout>
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
probe icmp timeout 1 retry-up-count 3 frequency 527192 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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 an ICMP Protocol Probe at the Device-Group Level

Deleting an ICMP Protocol Probe at the Device-Group Level

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items xc:operation="delete">
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
no probe icmp timeout 1 retry-up-count 3 frequency 527192 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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

Configuring a UDP Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "ctrlStatusEnable": "enable",
                  "dnshost": "",
                  "frequency": "527192",
                  "httpGetStr": "",
                  "port": "2981",
                  "probeIp": "0.0.0.0",
                  "protocol": "UDP",
                  "retryDownCount": "3",
                  "retryUpCount": "3",
                  "timeout": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items>
            <ctrlStatusEnable>enable</ctrlStatusEnable>
            <dnshost></dnshost>
            <frequency>527192</frequency>
            <httpGetStr></httpGetStr>
            <port>2981</port>
            <probeIp>0.0.0.0</probeIp>
            <protocol>UDP</protocol>
            <retryDownCount>3</retryDownCount>
            <retryUpCount>3</retryUpCount>
            <timeout>1</timeout>
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
probe udp port 2981 control enable timeout 1 retry-up-count 3 frequency 527192 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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

Deleting a UDP Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items xc:operation="delete">
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
no probe udp port 2981 control enable timeout 1 retry-up-count 3 frequency 527192 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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 TCP Protocol Service Probe

Configuring a TCP Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "ctrlStatusEnable": "enable",
                  "dnshost": "",
                  "frequency": "527192",
                  "httpGetStr": "",
                  "port": "2981",
                  "probeIp": "0.0.0.0",
                  "protocol": "TCP",
                  "retryDownCount": "3",
                  "retryUpCount": "3",
                  "timeout": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items>
            <ctrlStatusEnable>enable</ctrlStatusEnable>
            <dnshost></dnshost>
            <frequency>527192</frequency>
            <httpGetStr></httpGetStr>
            <port>2981</port>
            <probeIp>0.0.0.0</probeIp>
            <protocol>TCP</protocol>
            <retryDownCount>3</retryDownCount>
            <retryUpCount>3</retryUpCount>
            <timeout>1</timeout>
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
probe tcp port 2981 control enable timeout 1 retry-up-count 3 frequency 527192 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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 TCP Protocol Service Probe

Deleting a TCP Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items xc:operation="delete">
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
no probe tcp port 2981 control enable timeout 1 retry-up-count 3 frequency 527192 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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 DNS Protocol Service Probe

Configuring a DNS Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "ctrlStatusEnable": "disable",
                  "dnshost": "SampleString_123",
                  "frequency": "216869",
                  "httpGetStr": "",
                  "port": "0",
                  "probeIp": "0.0.0.0",
                  "protocol": "DNS",
                  "retryDownCount": "5",
                  "retryUpCount": "5",
                  "timeout": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items>
            <ctrlStatusEnable>disable</ctrlStatusEnable>
            <dnshost>SampleString_123</dnshost>
            <frequency>216869</frequency>
            <httpGetStr></httpGetStr>
            <port>0</port>
            <probeIp>0.0.0.0</probeIp>
            <protocol>DNS</protocol>
            <retryDownCount>5</retryDownCount>
            <retryUpCount>5</retryUpCount>
            <timeout>1</timeout>
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
probe dns host SampleString_123 timeout 1 retry-up-count 5 frequency 216869 retry-down-count 5

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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 DNS Protocol Service Probe

Deleting a DNS Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items xc:operation="delete">
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
no probe dns host SampleString_123 timeout 1 retry-up-count 5 frequency 216869 retry-down-count 5

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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

Configuring an HTTP Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "ctrlStatusEnable": "disable",
                  "dnshost": "",
                  "frequency": "467754",
                  "httpGetStr": "SampleString_123",
                  "port": "0",
                  "probeIp": "0.0.0.0",
                  "protocol": "HTTP",
                  "retryDownCount": "3",
                  "retryUpCount": "3",
                  "timeout": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items>
            <ctrlStatusEnable>disable</ctrlStatusEnable>
            <dnshost></dnshost>
            <frequency>467754</frequency>
            <httpGetStr>SampleString_123</httpGetStr>
            <port>0</port>
            <probeIp>0.0.0.0</probeIp>
            <protocol>HTTP</protocol>
            <retryDownCount>3</retryDownCount>
            <retryUpCount>3</retryUpCount>
            <timeout>1</timeout>
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
probe http get SampleString_123 timeout 1 retry-up-count 3 frequency 467754 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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

Deleting an HTTP Protocol Service Probe

POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json

{
  "itdInst": {
    "children": [
      {
        "itdDeviceGroup": {
          "attributes": {
            "dgName": "deviceGroup_Name"
          },
          "children": [
            {
              "itdProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <itd-items>
    <inst-items>
      <devgrp-items>
        <DeviceGroup-list>
          <dgName>deviceGroup_Name</dgName>
          <probe-items xc:operation="delete">
          </probe-items>
        </DeviceGroup-list>
      </devgrp-items>
    </inst-items>
  </itd-items>
</System>

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

CLI Commands

itd device-group deviceGroup_Name
no probe http get SampleString_123 timeout 1 retry-up-count 3 frequency 467754 retry-down-count 3

Verifying a DME Configuration

MO	DN
itdDeviceGroup	sys/itd/inst/devgrp-deviceGroup_Name
itdInst	sys/itd/inst

itdDeviceGroup Properties

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

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