Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the MTU for Backbone Multicast Distribution Tree

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mvpnEntity": {
          "children": [
            {
              "mvpnInst": {
                "children": [
                  {
                    "mvpnDom": {
                      "attributes": {
                        "dataMtuValue": "5646",
                        "name": "VRF_1"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "l3Inst": {
          "attributes": {
            "name": "VRF_1"
          }
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <mvpn-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <dataMtuValue>5646</dataMtuValue>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mvpn-items>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
    </Inst-list>
  </inst-items>
</System>

MVPN Configuration for the Handoff Node

For more information, see the Cisco Nexus 9000 Series NX-OS VXLAN Configuration Guide.

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

Configuring the MTU for Backbone Multicast Distribution Tree

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

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.

vrf context VRF_1
mdt mtu 5646

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
topSystem	sys
mvpnEntity	sys/mvpn
mvpnInst	sys/mvpn/inst
mvpnDom	sys/mvpn/inst/dom-VRF_1
l3Inst	sys/inst-VRF_1

mvpnDom Properties

The following table contains information about the mvpnDom 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
dataMtuValue	mvpn:DataMtuVal (scalar:Uint16)	MTU Value configured for the mdt	RANGE: [576 , 9192] DEFAULT: 1376
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

l3Inst Properties

The following table contains information about the l3Inst 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
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128

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 the MTU for Backbone Multicast Distribution Tree

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

CLI Commands

vrf context VRF_1
no mdt mtu 5646

Verifying a DME Configuration

MO	DN
topSystem	sys
mvpnEntity	sys/mvpn
mvpnInst	sys/mvpn/inst
mvpnDom	sys/mvpn/inst/dom-VRF_1
l3Inst	sys/inst-VRF_1

mvpnDom Properties

Property Name	Data Type	Description	Values
dataMtuValue	mvpn:DataMtuVal (scalar:Uint16)	MTU Value configured for the mdt	RANGE: [576 , 9192] DEFAULT: 1376
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128

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 the Hardware Profile for Module for MVPN Statistics

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

CLI Commands

hardware profile mvpn-stats module all

Verifying a DME Configuration

MO	DN
lcmVxlanMplsAclEntity	sys/lcm/vxlanmplsacl
lcmVxlanMplsAclModule	sys/lcm/vxlanmplsacl/module-all

lcmVxlanMplsAclModule Properties

The following table contains information about the lcmVxlanMplsAclModule 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
id	lcm:ProfModAllId (scalar:Uint16)	Module identifier for vxlan\	mpls or acl-stats or acl-eg-ext property
profMvpnStats	lcm:ProfMvpnStats (scalar:Enum8)	mvpn-stats config status [no/yes\] for the module	SELECTION: 0 - no 1 - yes DEFAULT: no

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 the Hardware Profile for Module for MVPN Statistics

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

CLI Commands

no hardware profile mvpn-stats module all

Verifying a DME Configuration

MO	DN
lcmVxlanMplsAclEntity	sys/lcm/vxlanmplsacl
lcmVxlanMplsAclModule	sys/lcm/vxlanmplsacl/module-all

lcmVxlanMplsAclModule Properties

Property Name	Data Type	Description	Values
id	lcm:ProfModAllId (scalar:Uint16)	Module identifier for vxlan\	mpls or acl-stats or acl-eg-ext property
profMvpnStats	lcm:ProfMvpnStats (scalar:Enum8)	mvpn-stats config status [no/yes\] for the module	SELECTION: 0 - no 1 - yes DEFAULT: no

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