Configuring an ITD Service

Configuring an ITD Service

Configuring an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
        </Service-list>
      </service-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 Service_Name


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd: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 Service

Deleting an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list xc:operation="delete">
          <name>Service_Name</name>
        </Service-list>
      </service-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.

no itd Service_Name


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
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 Probe Source Interface

Configuring Probe Source Interface
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "sourceIntf": "lo123"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <sourceIntf>lo123</sourceIntf>
        </Service-list>
      </service-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 Service_Name
  source-interface loopback 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.

MODN
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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
sourceIntfnw:IfId
(base:IfIndex)
Source interface for probe generation.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

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

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

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

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

Deleting Probe Source Interface

Deleting Probe Source Interface
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "sourceIntf": "unspecified"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <sourceIntf>unspecified</sourceIntf>
        </Service-list>
      </service-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 Service_Name
  no source-interface loopback 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.

MODN
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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
sourceIntfnw:IfId
(base:IfIndex)
Source interface for probe generation.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

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

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

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

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

Configuring NAT Destination

Configuring NAT Destination
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "natDestination": "enable"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <natDestination>enable</natDestination>
        </Service-list>
      </service-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 Service_Name
  nat destination


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
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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
natDestinationitd:ctrlType
(scalar:Enum8)
SELECTION:
0 - disable
1 - enable
DEFAULT: disable


Related Documentation

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

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

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

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

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

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

Deleting NAT Destination

Deleting NAT Destination
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "natDestination": "disable"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <natDestination>disable</natDestination>
        </Service-list>
      </service-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 Service_Name
  no nat destination


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
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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
natDestinationitd:ctrlType
(scalar:Enum8)
SELECTION:
0 - disable
1 - enable
DEFAULT: disable


Related Documentation

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

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

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

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

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

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

Configuring an ITD Service VRF

Configuring an ITD Service VRF
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "vrf": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <vrf>SampleString_123</vrf>
        </Service-list>
      </service-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 Service_Name
 vrf 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.

MODN
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
vrfitd:vrfName
(string:Basic)
Identifies the VRF for the NTP providers
MAX SIZE: 32
DEFAULT: default


Related Documentation

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

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

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

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

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

Deleting an ITD Service VRF

Deleting an ITD Service VRF
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "vrf": "default"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <vrf>default</vrf>
        </Service-list>
      </service-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 Service_Name
 no vrf 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.

MODN
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
vrfitd:vrfName
(string:Basic)
Identifies the VRF for the NTP providers
MAX SIZE: 32
DEFAULT: default


Related Documentation

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

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

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

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

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

Configuring an ITD Include Access List for a Service

Configuring an ITD Include Access List for a Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdAccesslist": {
                "attributes": {
                  "deviceGroup": "SampleString_123",
                  "isIPv6": "no",
                  "name": "SampleString_123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <acl-items>
            <Accesslist-list>
              <name>SampleString_123</name>
              <deviceGroup>SampleString_123</deviceGroup>
              <isIPv6>false</isIPv6>
            </Accesslist-list>
          </acl-items>
        </Service-list>
      </service-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 Service_Name
 access-list SampleString_123 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.

MODN
itdAccesslistsys/itd/inst/service-Service_Name/acl-SampleString_123
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdAccesslist Properties

The following table contains information about the itdAccesslist 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
deviceGroupitd:DevGrpNameType
(string:Basic)
Optional
MAX SIZE: 31
isIPv6scalar:Bool
Must be true for ipv6 access-listSELECTION: true or fals
nameitd:AclNameType
(string:Basic)
The name of the object.
MAX SIZE: 50


Related Documentation

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

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

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 Include Access List for a Service

Deleting an ITD Include Access List for a Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdAccesslist": {
                "attributes": {
                  "name": "SampleString_123",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <acl-items>
            <Accesslist-list xc:operation="delete">
              <name>SampleString_123</name>
            </Accesslist-list>
          </acl-items>
        </Service-list>
      </service-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 Service_Name
 no access-list SampleString_123 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.

MODN
itdAccesslistsys/itd/inst/service-Service_Name/acl-SampleString_123
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdAccesslist Properties

The following table contains information about the itdAccesslist 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
nameitd:AclNameType
(string:Basic)
The name of the object.
MAX SIZE: 50
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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 IPv6 Include Access List for a Service

Configuring an IPv6 Include Access List for a Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdAccesslist": {
                "attributes": {
                  "deviceGroup": "SampleString_123",
                  "isIPv6": "yes",
                  "name": "SampleString_123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <acl-items>
            <Accesslist-list>
              <name>SampleString_123</name>
              <deviceGroup>SampleString_123</deviceGroup>
              <isIPv6>true</isIPv6>
            </Accesslist-list>
          </acl-items>
        </Service-list>
      </service-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 Service_Name
 access-list ipv6 SampleString_123 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.

MODN
itdAccesslistsys/itd/inst/service-Service_Name/acl-SampleString_123
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdAccesslist Properties

The following table contains information about the itdAccesslist 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
deviceGroupitd:DevGrpNameType
(string:Basic)
MAX SIZE: 31
isIPv6scalar:Bool
Must be true for ipv6 access-listSELECTION: true or fals
nameitd:AclNameType
(string:Basic)
The name of the object.
MAX SIZE: 50


Related Documentation

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

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

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 IPv6 Include Access List for a Service

Deleting an IPv6 Include Access List for a Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdAccesslist": {
                "attributes": {
                  "name": "SampleString_123",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <acl-items>
            <Accesslist-list xc:operation="delete">
              <name>SampleString_123</name>
            </Accesslist-list>
          </acl-items>
        </Service-list>
      </service-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 Service_Name
 no access-list ipv6 SampleString_123 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.

MODN
itdAccesslistsys/itd/inst/service-Service_Name/acl-SampleString_123
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdAccesslist Properties

The following table contains information about the itdAccesslist 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
nameitd:AclNameType
(string:Basic)
The name of the object.
MAX SIZE: 50
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

Specifying the Traffic to Exclude

Specifying the Traffic to Exclude
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "excludeACL": "SampleString_123",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <excludeACL>SampleString_123</excludeACL>
        </Service-list>
      </service-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 Service_Name
 exclude access-list 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.

MODN
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
excludeACLitd:AclNameType
(string:Basic)
MAX SIZE: 50
nameitd: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 the Configuration that Specifies the Traffic to Exclude

Deleting the Configuration that Specifies the Traffic to Exclude
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "excludeACL": "",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <excludeACL></excludeACL>
        </Service-list>
      </service-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 Service_Name
 no exclude access-list 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.

MODN
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
excludeACLitd:AclNameType
(string:Basic)
MAX SIZE: 50
nameitd: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 ITD Failaction as Bucket Distribute for a Service

Configuring ITD Failaction as Bucket Distribute for a Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "bucketDistribute",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>bucketDistribute</failactionMode>
        </Service-list>
      </service-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 Service_Name
 failaction bucket distribute


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 ITD Failaction as Bucket Distribute for a Service

Deleting ITD Failaction as Bucket Distribute for a Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "nofailaction",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>nofailaction</failactionMode>
        </Service-list>
      </service-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 Service_Name
 no failaction bucket distribute


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 ITD Failaction as Node Least-Bucket

Configuring ITD Failaction as Node Least-Bucket
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "nodeLeastBucket",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>nodeLeastBucket</failactionMode>
        </Service-list>
      </service-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 Service_Name
 failaction node least-bucket


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 ITD Failaction as Node Least-Bucket

Deleting ITD Failaction as Node Least-Bucket
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "nofailaction",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>nofailaction</failactionMode>
        </Service-list>
      </service-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 Service_Name
 no failaction node least-bucket


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 ITD Failaction as Node Per Bucket

Configuring ITD Failaction as Node Per Bucket
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "nodePerBucket",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>nodePerBucket</failactionMode>
        </Service-list>
      </service-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 Service_Name
 failaction node per-bucket


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 ITD Failaction as Node Per Bucket

Deleting ITD Failaction as Node Per Bucket
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "nofailaction",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>nofailaction</failactionMode>
        </Service-list>
      </service-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 Service_Name
 no failaction node per-bucket


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 ITD Failaction as Node Reassign

Configuring ITD Failaction as Node Reassign
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "nodeReassign",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>nodeReassign</failactionMode>
        </Service-list>
      </service-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 Service_Name
 failaction node reassign


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 ITD Failaction as Node Reassign

Deleting ITD Failaction as Node Reassign
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "failactionMode": "nofailaction",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <failactionMode>nofailaction</failactionMode>
        </Service-list>
      </service-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 Service_Name
 no failaction node reassign


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
failactionModeitd:failactionType
(scalar:Enum8)
SELECTION:
0 - nofailaction
1 - nodeReassign
2 - nodeLeastBucket
3 - nodePerBucket
4 - bucketDistribute
DEFAULT: nofailaction
nameitd: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 Ethernet Interface as Ingress Interface for an ITD Service

Configuring an Ethernet Interface as Ingress Interface for an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdIngressIf": {
                "attributes": {
                  "name": "eth1/2"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <if-items>
            <IngressIf-list>
              <name>eth1/2</name>
            </IngressIf-list>
          </if-items>
        </Service-list>
      </service-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 Service_Name
 ingress interface ethernet 1/2


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
itdIngressIfsys/itd/inst/service-Service_Name/if-[eth1/2]
itdIngressIfsys/itd/inst/service-Service_Name/if-[po123]
itdIngressIfsys/itd/inst/service-Service_Name/if-[vlan123]
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdIngressIf Properties

The following table contains information about the itdIngressIf 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
namenw:IfId
(base:IfIndex)
The name of the object.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Ethernet Interface as Ingress Interface for an ITD Service

Deleting an Ethernet Interface as Ingress Interface for an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdIngressIf": {
                "attributes": {
                  "name": "eth1/2",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <if-items>
            <IngressIf-list xc:operation="delete">
              <name>eth1/2</name>
            </IngressIf-list>
          </if-items>
        </Service-list>
      </service-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 Service_Name
 no ingress interface ethernet 1/2


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
itdIngressIfsys/itd/inst/service-Service_Name/if-[eth1/2]
itdIngressIfsys/itd/inst/service-Service_Name/if-[po123]
itdIngressIfsys/itd/inst/service-Service_Name/if-[vlan123]
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdIngressIf Properties

The following table contains information about the itdIngressIf 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
namenw:IfId
(base:IfIndex)
The name of the object.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
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 VLAN Interface as Ingress Interface for an ITD Service

Configuring a VLAN Interface as Ingress Interface for an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdIngressIf": {
                "attributes": {
                  "name": "vlan123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <if-items>
            <IngressIf-list>
              <name>vlan123</name>
            </IngressIf-list>
          </if-items>
        </Service-list>
      </service-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 Service_Name
 ingress interface vlan 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.

MODN
itdIngressIfsys/itd/inst/service-Service_Name/if-[eth1/2]
itdIngressIfsys/itd/inst/service-Service_Name/if-[po123]
itdIngressIfsys/itd/inst/service-Service_Name/if-[vlan123]
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdIngressIf Properties

The following table contains information about the itdIngressIf 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
namenw:IfId
(base:IfIndex)
The name of the object.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 VLAN Interface as Ingress Interface for an ITD Service

Deleting a VLAN Interface as Ingress Interface for an ITD ServiceN)
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdIngressIf": {
                "attributes": {
                  "name": "vlan123",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <if-items>
            <IngressIf-list xc:operation="delete">
              <name>vlan123</name>
            </IngressIf-list>
          </if-items>
        </Service-list>
      </service-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 Service_Name
 no ingress interface vlan 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.

MODN
itdIngressIfsys/itd/inst/service-Service_Name/if-[eth1/2]
itdIngressIfsys/itd/inst/service-Service_Name/if-[po123]
itdIngressIfsys/itd/inst/service-Service_Name/if-[vlan123]
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdIngressIf Properties

The following table contains information about the itdIngressIf 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
namenw:IfId
(base:IfIndex)
The name of the object.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
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 Port Channel Interface as Ingress Interface for an ITD Service

Configuring a Port Channel Interface as Ingress Interface for an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdIngressIf": {
                "attributes": {
                  "name": "po123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <if-items>
            <IngressIf-list>
              <name>po123</name>
            </IngressIf-list>
          </if-items>
        </Service-list>
      </service-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 Service_Name
 ingress interface port-channel 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.

MODN
itdIngressIfsys/itd/inst/service-Service_Name/if-[eth1/2]
itdIngressIfsys/itd/inst/service-Service_Name/if-[po123]
itdIngressIfsys/itd/inst/service-Service_Name/if-[vlan123]
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdIngressIf Properties

The following table contains information about the itdIngressIf 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
namenw:IfId
(base:IfIndex)
The name of the object.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Port Channel Interface as Ingress Interface for an ITD Service

Deleting a Port Channel Interface as Ingress Interface for an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdIngressIf": {
                "attributes": {
                  "name": "po123",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <if-items>
            <IngressIf-list xc:operation="delete">
              <name>po123</name>
            </IngressIf-list>
          </if-items>
        </Service-list>
      </service-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 Service_Name
 no ingress interface port-channel 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.

MODN
itdIngressIfsys/itd/inst/service-Service_Name/if-[eth1/2]
itdIngressIfsys/itd/inst/service-Service_Name/if-[po123]
itdIngressIfsys/itd/inst/service-Service_Name/if-[vlan123]
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31


itdIngressIf Properties

The following table contains information about the itdIngressIf 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
namenw:IfId
(base:IfIndex)
The name of the object.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
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 Destination-Based ITD Loadbalance Method

Configuring Destination-Based ITD Loadbalance Method
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "bucket": "32",
            "lbMethod": "dst",
            "lbProtocol": "IP",
            "maskPosition": "2",
            "name": "test",
            "rangeX": "0",
            "rangeY": "0"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>test</name>
          <bucket>32</bucket>
          <lbMethod>dst</lbMethod>
          <lbProtocol>IP</lbProtocol>
          <maskPosition>2</maskPosition>
          <rangeX>0</rangeX>
          <rangeY>0</rangeY>
        </Service-list>
      </service-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 test
  load-balance method dst ip mask-position 2 buckets 32


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
itdInst sys/itd/inst
itdService sys/itd/inst/service-test


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 NameData TypeDescriptionValues
bucketitd:BucketNumType
(scalar:Uint32)
RANGE: [0 , 256]
DEFAULT: 0
lbMethoditd:LBMethod
(scalar:Enum8)
SELECTION:
0 - noLBMethod
1 - src
2 - dst
DEFAULT: noLBMethod
lbProtocolitd:protocolType
(scalar:Enum8)
SELECTION:
TCP
UDP
IP
DEFAULT: noProtocol
maskPositionitd:MaskPosType
(scalar:Uint32)
RANGE: [0 , 127]
DEFAULT: 0
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
rangeXaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]
rangeYaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]


Related Documentation

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

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

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

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

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

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

Deleting Destination-Based ITD Loadbalance Method

Deleting Destination-Based ITD Loadbalance Method
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "bucket": "0",
            "lbMethod": "noLBMethod",
            "lbProtocol": "noProtocol",
            "maskPosition": "0",
            "name": "test",
            "rangeX": "0",
            "rangeY": "0"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>test</name>
          <bucket>0</bucket>
          <lbMethod>noLBMethod</lbMethod>
          <lbProtocol>noProtocol</lbProtocol>
          <maskPosition>0</maskPosition>
          <rangeX>0</rangeX>
          <rangeY>0</rangeY>
        </Service-list>
      </service-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 test
  no load-balance method dst ip mask-position 2 buckets 32


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
itdInst sys/itd/inst
itdService sys/itd/inst/service-test


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 NameData TypeDescriptionValues
bucketitd:BucketNumType
(scalar:Uint32)
RANGE: [0 , 256]
DEFAULT: 0
lbMethoditd:LBMethod
(scalar:Enum8)
SELECTION:
0 - noLBMethod
1 - src
2 - dst
DEFAULT: noLBMethod
lbProtocolitd:protocolType
(scalar:Enum8)
SELECTION:
TCP
UDP
IP
DEFAULT: noProtocol
maskPositionitd:MaskPosType
(scalar:Uint32)
RANGE: [0 , 127]
DEFAULT: 0
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
rangeXaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]
rangeYaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]


Related Documentation

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

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

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

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

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

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

Configuring Source-Based ITD Loadbalance Method (TCP)

Configuring Source-Based ITD Loadbalance Method (TCP)
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "bucket": "32",
            "lbMethod": "src",
            "lbProtocol": "TCP",
            "maskPosition": "123",
            "name": "SampleString_123",
            "rangeX": "123",
            "rangeY": "321"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>SampleString_123</name>
          <bucket>32</bucket>
          <lbMethod>src</lbMethod>
          <lbProtocol>TCP</lbProtocol>
          <maskPosition>123</maskPosition>
          <rangeX>123</rangeX>
          <rangeY>321</rangeY>
        </Service-list>
      </service-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 SampleString_123
 load-balance method src ip-l4port tcp range 123 321 mask-position 123 buckets 32


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
itdInstsys/itd/inst
itdServicesys/itd/inst/service-SampleString_123


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 NameData TypeDescriptionValues
bucketitd:BucketNumType
(scalar:Uint32)
RANGE: [0 , 256]
DEFAULT: 0
lbMethoditd:LBMethod
(scalar:Enum8)
SELECTION:
0 - noLBMethod
1 - src
2 - dst
DEFAULT: noLBMethod
lbProtocolitd:protocolType
(scalar:Enum8)
SELECTION:
TCP
UDP
IP
DEFAULT: noProtocol
maskPositionitd:MaskPosType
(scalar:Uint32)
RANGE: [0 , 127]
DEFAULT: 0
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
rangeXaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]
rangeYaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]


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 Source-Based ITD Loadbalance Method (TCP)

Deleting Source-Based ITD Loadbalance Method (TCP)
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "bucket": "0",
            "lbMethod": "noLBMethod",
            "lbProtocol": "noProtocol",
            "maskPosition": "0",
            "name": "SampleString_123",
            "rangeX": "0",
            "rangeY": "0"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>SampleString_123</name>
          <bucket>0</bucket>
          <lbMethod>noLBMethod</lbMethod>
          <lbProtocol>noProtocol</lbProtocol>
          <maskPosition>0</maskPosition>
          <rangeX>0</rangeX>
          <rangeY>0</rangeY>
        </Service-list>
      </service-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 SampleString_123
 no load-balance method src ip-l4port tcp range 123 321 mask-position 123 buckets 32


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
itdInstsys/itd/inst
itdServicesys/itd/inst/service-SampleString_123


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 NameData TypeDescriptionValues
bucketitd:BucketNumType
(scalar:Uint32)
RANGE: [0 , 256]
DEFAULT: 0
lbMethoditd:LBMethod
(scalar:Enum8)
SELECTION:
0 - noLBMethod
1 - src
2 - dst
DEFAULT: noLBMethod
lbProtocolitd:protocolType
(scalar:Enum8)
SELECTION:
TCP
UDP
IP
DEFAULT: noProtocol
maskPositionitd:MaskPosType
(scalar:Uint32)
RANGE: [0 , 127]
DEFAULT: 0
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
rangeXaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]
rangeYaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]


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 Source-Based ITD Loadbalance Method (UDP)

Configuring Source-Based ITD Loadbalance Method (UDP)
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "bucket": "32",
            "lbMethod": "src",
            "lbProtocol": "UDP",
            "maskPosition": "123",
            "name": "SampleString_123",
            "rangeX": "123",
            "rangeY": "321"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>SampleString_123</name>
          <bucket>32</bucket>
          <lbMethod>src</lbMethod>
          <lbProtocol>UDP</lbProtocol>
          <maskPosition>123</maskPosition>
          <rangeX>123</rangeX>
          <rangeY>321</rangeY>
        </Service-list>
      </service-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 SampleString_123
 load-balance method src ip-l4port udp range 123 321 mask-position 123 buckets 32


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
itdInstsys/itd/inst
itdServicesys/itd/inst/service-SampleString_123


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 NameData TypeDescriptionValues
bucketitd:BucketNumType
(scalar:Uint32)
RANGE: [0 , 256]
DEFAULT: 0
lbMethoditd:LBMethod
(scalar:Enum8)
SELECTION:
0 - noLBMethod
1 - src
2 - dst
DEFAULT: noLBMethod
lbProtocolitd:protocolType
(scalar:Enum8)
SELECTION:
0 - noProtocol
1 - DNS
2 - HTTP
3 - ICMP
4 - TCP
5 - UDP
6 - IP
DEFAULT: noProtocol
maskPositionitd:MaskPosType
(scalar:Uint32)
RANGE: [0 , 127]
DEFAULT: 0
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
rangeXaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]
rangeYaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]


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 Source-Based ITD Loadbalance Method (UDP)

Deleting Source-Based ITD Loadbalance Method (UDP)
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "bucket": "0",
            "lbMethod": "noLBMethod",
            "lbProtocol": "noProtocol",
            "maskPosition": "0",
            "name": "SampleString_123",
            "rangeX": "0",
            "rangeY": "0"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>SampleString_123</name>
          <bucket>0</bucket>
          <lbMethod>noLBMethod</lbMethod>
          <lbProtocol>noProtocol</lbProtocol>
          <maskPosition>0</maskPosition>
          <rangeX>0</rangeX>
          <rangeY>0</rangeY>
        </Service-list>
      </service-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 SampleString_123
 no load-balance method src ip-l4port udp range 123 321 mask-position 123 buckets 32


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
itdInstsys/itd/inst
itdServicesys/itd/inst/service-SampleString_123


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 NameData TypeDescriptionValues
bucketitd:BucketNumType
(scalar:Uint32)
RANGE: [0 , 256]
DEFAULT: 0
lbMethoditd:LBMethod
(scalar:Enum8)
SELECTION:
0 - noLBMethod
1 - src
2 - dst
DEFAULT: noLBMethod
lbProtocolitd:protocolType
(scalar:Enum8)
SELECTION:
TCP
UDP
IP
DEFAULT: noProtocol
maskPositionitd:MaskPosType
(scalar:Uint32)
RANGE: [0 , 127]
DEFAULT: 0
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
rangeXaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]
rangeYaddress:PortNumber
(scalar:Uint16)
RANGE: [0 , 65535]


Related Documentation

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

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

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

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

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

Configuring the Peer Service Involved in Sandwich Mode

Configuring the Peer Service Involved in Sandwich Mode
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "peerLocalServiceName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <peerLocalServiceName>SampleString_123</peerLocalServiceName>
        </Service-list>
      </service-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 Service_Name
 peer local service 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.

MODN
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
peerLocalServiceNameitd:SvcNameType
(string:Basic)
The name of the peer service
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 the Peer Service Involved in Sandwich Mode

Deleting the Peer Service Involved in Sandwich Mode
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "peerLocalServiceName": ""
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <peerLocalServiceName></peerLocalServiceName>
        </Service-list>
      </service-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 Service_Name
 no peer local service 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.

MODN
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
peerLocalServiceNameitd:SvcNameType
(string:Basic)
The name of the peer service
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

Disabling an ITD Service

Disabling an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "adminSt": "shut",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <adminSt>shut</adminSt>
        </Service-list>
      </service-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 Service_Name
 shutdown


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
adminStitd:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
0 - shut
1 - no shut
DEFAULT: shut
nameitd: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

Enabling an ITD Service

Enabling an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "adminSt": "no shut",
            "name": "Service_Name"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <adminSt>no shut</adminSt>
        </Service-list>
      </service-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 Service_Name
 no shutdown


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
itdInstsys/itd/inst
itdServicesys/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 NameData TypeDescriptionValues
adminStitd:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
0 - shut
1 - no shut
DEFAULT: shut
nameitd: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 a ITD Over VXLAN Probe Source-Interface

Configuring a ITD Over VXLAN Probe Source-Interface
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "sourceIntf": "lo123"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <sourceIntf>lo123</sourceIntf>
        </Service-list>
      </service-items>
    </inst-items>
  </itd-items>
</System>

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


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 Service_Name
  source-interface loopback 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.

MODN
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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
sourceIntfnw:IfId
(base:IfIndex)
Source interface for probe generation.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

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

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

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

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

Deleting a ITD Over VXLAN Probe Source-Interface

Deleting a ITD Over VXLAN Probe Source-Interface
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name",
            "sourceIntf": "unspecified"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <sourceIntf>unspecified</sourceIntf>
        </Service-list>
      </service-items>
    </inst-items>
  </itd-items>
</System>

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


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 Service_Name
  no source-interface loopback 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.

MODN
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 NameData TypeDescriptionValues
nameitd:SvcNameType
(string:Basic)
The name of the object.
MAX SIZE: 31
sourceIntfnw:IfId
(base:IfIndex)
Source interface for probe generation.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

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

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

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

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


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
itdInst sys/itd/inst
itdSessionDevGrp sys/itd/inst/sessiondevgrp-Session_Name


itdSessionDevGrp Properties

The following table contains information about the itdSessionDevGrp 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
devGroupNameitd:DevGrpNameType
(string:Basic)
MAX SIZE: 31
sessActionitd:sessActionType
(scalar:Enum8)
SELECTION:
0 - noAction
1 - commit
2 - abort
DEFAULT: noAction


Related Documentation

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

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

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

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

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

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