Configuring an ITD Port Group

Configuring a Port Group

Configuring a Port Group
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdPortGroup": {
          "attributes": {
            "pgName": "Grp_1"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <prtgrp-items>
        <PortGroup-list>
          <pgName>Grp_1</pgName>
        </PortGroup-list>
      </prtgrp-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 port-group Grp_1


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
itdPortGroup sys/itd/inst/prtgrp-Grp_1


itdPortGroup Properties

The following table contains information about the itdPortGroup 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
pgNameitd:PortGrpNameType
(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

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

Deleting a Port Group
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdPortGroup": {
          "attributes": {
            "pgName": "Grp_1",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <prtgrp-items>
        <PortGroup-list nc:operation="delete">
          <pgName>Grp_1</pgName>
        </PortGroup-list>
      </prtgrp-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.

no Itd port-group Grp_1


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
itdPortGroup sys/itd/inst/prtgrp-Grp_1


itdPortGroup Properties

The following table contains information about the itdPortGroup 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
pgNameitd:PortGrpNameType
(string:Basic)
MAX SIZE: 31
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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

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 Egress Interface for a Port Group

Configuring an Egress Interface for a Port Group
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdPortGroup": {
          "attributes": {
            "pgName": "Grp_1"
          },
          "children": [
            {
              "itdL2If": {
                "attributes": {
                  "name": "eth1/2"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <prtgrp-items>
        <PortGroup-list>
          <pgName>Grp_1</pgName>
          <if-items>
            <L2If-list>
              <name>eth1/2</name>
            </L2If-list>
          </if-items>
        </PortGroup-list>
      </prtgrp-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 port-group Grp_1
  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
itdInst sys/itd/inst
itdPortGroup sys/itd/inst/prtgrp-Grp_1
itdL2If sys/itd/inst/prtgrp-Grp_1/if-[eth1/2]


itdPortGroup Properties

The following table contains information about the itdPortGroup 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
pgNameitd:PortGrpNameType
(string:Basic)
MAX SIZE: 31


itdL2If Properties

The following table contains information about the itdL2If 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

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 Egress Interface for a Port Group

Deleting an Egress Interface for a Port Group
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdPortGroup": {
          "attributes": {
            "pgName": "Grp_1"
          },
          "children": [
            {
              "itdL2If": {
                "attributes": {
                  "name": "eth1/2",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <prtgrp-items>
        <PortGroup-list>
          <pgName>Grp_1</pgName>
          <if-items>
            <L2If-list nc:operation="delete">
              <name>eth1/2</name>
            </L2If-list>
          </if-items>
        </PortGroup-list>
      </prtgrp-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 port-group Grp_1
  no 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
itdInst sys/itd/inst
itdPortGroup sys/itd/inst/prtgrp-Grp_1
itdL2If sys/itd/inst/prtgrp-Grp_1/if-[eth1/2]


itdPortGroup Properties

The following table contains information about the itdPortGroup 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
pgNameitd:PortGrpNameType
(string:Basic)
MAX SIZE: 31


itdL2If Properties

The following table contains information about the itdL2If 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)
The upgrade status. This property is for internal use only.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

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 a Port Group for an ITD Service

Configuring a Port Group for an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "defaultPortGroup": "Grp_1",
            "name": "ITD_1"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>ITD_1</name>
          <defaultPortGroup>Grp_1</defaultPortGroup>
        </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 ITD_1
  port-group Grp_1


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


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
defaultPortGroupitd:PortGrpNameType
(string:Basic)
MAX SIZE: 31
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

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 Port Group for an ITD Service

Deleting a Port Group for an ITD Service
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "defaultPortGroup": "",
            "name": "ITD_1"
}}}]}}
{
    imdata:[]
}
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>ITD_1</name>
          <defaultPortGroup></defaultPortGroup>
        </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 ITD_1
  no port-group Grp_1


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


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
defaultPortGroupitd:PortGrpNameType
(string:Basic)
MAX SIZE: 31
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

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