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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring an ITD Session for a Specified Device Group

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdSessionDevGrp": {
          "attributes": {
            "devGroupName": "SampleString_123"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <itd-items>
    <inst-items>
      <sessiondevgrp-items>
        <SessionDevGrp-list>
          <devGroupName>SampleString_123</devGroupName>
        </SessionDevGrp-list>
      </sessiondevgrp-items>
    </inst-items>
  </itd-items>
</System>

Configuring an ITD Session

Configuring an ITD Session for a Specified Device Group

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 session device-group SampleString_123

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-SampleString_123

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 Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31

Related Documentation

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

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

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

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

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

Deleting an ITD Session for a Specified Device Group

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

CLI Commands

no itd session device-group SampleString_123

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-SampleString_123

itdSessionDevGrp Properties

Property Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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

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

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

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

Configuring an IPv4-Address Node to an ITD Session for a Device Group

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

CLI Commands

itd session device-group Session_Name
node ip 1.2.3.4
commit

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-Session_Name
itdSessNodev4	sys/itd/inst/sessiondevgrp-Session_Name/nodev4-1.2.3.4

itdSessionDevGrp Properties

Property Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
sessAction	itd:sessActionType (scalar:Enum8)	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

itdSessNodev4 Properties

The following table contains information about the itdSessNodev4 properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
action	itd:sessNodeActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - add 1 - delete
ip	address:IPv4	The IP address.	Value must match ipv4 format

Related Documentation

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

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

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

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

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

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

Deleting an IPv4-Address Node to an ITD Session for a Device Group

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

CLI Commands

itd session device-group Session_Name
no node ip 1.2.3.4
commit

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-Session_Name
itdSessNodev4	sys/itd/inst/sessiondevgrp-Session_Name/nodev4-1.2.3.4

itdSessionDevGrp Properties

Property Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
sessAction	itd:sessActionType (scalar:Enum8)	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

itdSessNodev4 Properties

Property Name	Data Type	Description	Values
action	itd:sessNodeActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - add 1 - delete
ip	address:IPv4	The IP address.	Value must match ipv4 format

Related Documentation

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

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

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

Adding an IPv6-Address Node to an ITD Session for a Device Group

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

CLI Commands

itd session device-group Session_Name
node ipv6 1:2::3:4
commit

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-Session_Name
itdSessNodev6	sys/itd/inst/sessiondevgrp-Session_Name/nodev6-1:2::3:4

itdSessionDevGrp Properties

Property Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
sessAction	itd:sessActionType (scalar:Enum8)	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

itdSessNodev6 Properties

The following table contains information about the itdSessNodev6 properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
action	itd:sessNodeActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - add 1 - delete
ip	address:IPv6	The IP address.	Value must match ipv6 format

Related Documentation

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

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

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

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

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

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

Deleting an IPv6-Address Node to an ITD Session for a Device Group

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

CLI Commands

itd session device-group Session_Name
no node ipv6 1:2::3:4
commit

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-Session_Name
itdSessNodev6	sys/itd/inst/sessiondevgrp-Session_Name/nodev6-1:2::3:4

itdSessionDevGrp Properties

Property Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
sessAction	itd:sessActionType (scalar:Enum8)	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

itdSessNodev6 Properties

Property Name	Data Type	Description	Values
action	itd:sessNodeActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - add 1 - delete
ip	address:IPv6	The IP address.	Value must match ipv6 format

Related Documentation

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

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

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 Replace Operation Abort

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

CLI Commands

itd session device-group Session_Name
abort

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-Session_Name

itdSessionDevGrp Properties

Property Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
sessAction	itd: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

Configuring Commit

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

CLI Commands

itd session device-group Session_Name
commit

Note: The property information for this example was added in Release 9.3(3).

Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
itdInst	sys/itd/inst
itdSessionDevGrp	sys/itd/inst/sessiondevgrp-{devGroupName}

itdSessionDevGrp Properties

Property Name	Data Type	Description	Values
devGroupName	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
sessAction	itd: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