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 the Maximum Paths per Destination for a VRF

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "isisEntity": {
          "children": [
            {
              "isisInst": {
                "attributes": {
                  "name": "TAG_1"
                },
                "children": [
                  {
                    "isisDom": {
                      "attributes": {
                        "name": "VRF_1"
                      },
                      "children": [
                        {
                          "isisDomAf": {
                            "attributes": {
                              "maxEcmp": "28",
                              "type": "v4"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "isisDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <isis-items>
    <inst-items>
      <Inst-list>
        <name>TAG_1</name>
        <dom-items>
          <Dom-list>
            <name>VRF_1</name>
            <af-items>
              <DomAf-list>
                <type>v4</type>
                <maxEcmp>28</maxEcmp>
              </DomAf-list>
            </af-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </isis-items>
</System>

Configuring IS-IS in Router VRF Configuration Mode

Configuring the Maximum Paths per Destination for a VRF

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.

router isis TAG_1
vrf VRF_1
maximum-paths 28

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
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDomAf	sys/isis/inst-TAG_1/dom-VRF_1/af-v4
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

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

isisDom Properties

The following table contains information about the isisDom 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 IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDomAf Properties

The following table contains information about the isisDomAf 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
maxEcmp	isis:Ecmp (scalar:UByte)	Holds IS-IS Domain address family Max ECMP value	RANGE: [1 , 64] DEFAULT: 8
type	isis:AfT (scalar:Enum8)	Type	SELECTION: 1 - v4 2 - v6 DEFAULT: v4

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 Maximum Paths per Destination for a VRF

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

CLI Commands

router isis TAG_1
vrf VRF_1
no maximum-paths 28

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDomAf	sys/isis/inst-TAG_1/dom-VRF_1/af-v4
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	null

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDomAf Properties

Property Name	Data Type	Description	Values
maxEcmp	isis:Ecmp (scalar:UByte)	Holds IS-IS Domain address family Max ECMP value	RANGE: [1 , 64] DEFAULT: 8
type	isis:AfT (scalar:Enum8)	Type	SELECTION: 1 - v4 2 - v6 DEFAULT: v4

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 an IPv4 Unicast Address Family for a VRF

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

CLI Commands

router isis TAG_1
vrf VRF_1
address-family ipv4 unicast

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDomAf	sys/isis/inst-TAG_1/dom-VRF_1/af-v4
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	null

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDomAf Properties

Property Name	Data Type	Description	Values
type	isis:AfT (scalar:Enum8)	Type	SELECTION: 1 - v4 2 - v6 DEFAULT: v4

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 an IPv4 Unicast Address Family for a VRF

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

CLI Commands

router isis TAG_1
vrf VRF_1
no address-family ipv4 unicast

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDomAf	sys/isis/inst-TAG_1/dom-VRF_1/af-v4
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	null

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDomAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	isis:AfT (scalar:Enum8)	Type	SELECTION: 1 - v4 2 - v6 DEFAULT: v4

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 an IPv6 Unicast Address Family for a VRF

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

CLI Commands

router isis TAG_1
vrf VRF_1
address-family ipv6 unicast

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDomAf	sys/isis/inst-TAG_1/dom-VRF_1/af-v6
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	null

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDomAf Properties

Property Name	Data Type	Description	Values
type	isis:AfT (scalar:Enum8)	Type	SELECTION: 1 - v4 2 - v6 DEFAULT: v4

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 an IPv6 Unicast Address Family for a VRF

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

CLI Commands

router isis TAG_1
vrf VRF_1
no address-family ipv6 unicast

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDomAf	sys/isis/inst-TAG_1/dom-VRF_1/af-v6
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	null

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDomAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	isis:AfT (scalar:Enum8)	Type	SELECTION: 1 - v4 2 - v6 DEFAULT: v4

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 OSPF Administrative Distance

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

CLI Commands

router isis TAG_1
vrf VRF_1
distance 123

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDomAf	sys/isis/inst-TAG_1/dom-VRF_1/af-v4
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	null

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDomAf Properties

Property Name	Data Type	Description	Values
dist	isis:Dist (scalar:UByte)	Holds IS-IS Domain address family Administrative Distance	RANGE: [1 , 255] DEFAULT: 115
type	isis:AfT (scalar:Enum8)	Type	SELECTION: 1 - v4 2 - v6 DEFAULT: v4

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 OSPF Administrative Distance

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

CLI Commands

router isis TAG_1
  vrf VRF_1
   no distance 123
    distance command has not been configured previously

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	null

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "128"

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The IS-IS domain name. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.	RANGE: Min: "1" Max: "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 Maximum Size of the Retransmit Queue

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

CLI Commands

router isis TAG_1
vrf VRF_1
queue-limit retransmit 63760

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

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

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
queueLimit	isis:QueueLimitType (scalar:Uint32)	Holds the ISIS queue limit retransmit value	RANGE: [200 , 65535] DEFAULT: 2000

isisDom Properties

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

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 Maximum Size of the Retransmit Queue

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

CLI Commands

router isis TAG_1
vrf VRF_1
no queue-limit retransmit 63760

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

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

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
queueLimit	isis:QueueLimitType (scalar:Uint32)	Holds the ISIS queue limit retransmit value	RANGE: [200 , 65535] DEFAULT: 2000

isisDom Properties

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

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 Unlimited Retransmit Queue

Note:

This command can accept a particular range for the queue limit or the string unlimited. However, when using agents such as restconf and netconf to configure unlimited for the queue-limit retransmit unlimited command, you must pass the value 1.
This example was added in Release 9.3(5).

CLI Commands

router isis TAG_1
vrf VRF_1
queue-limit retransmit unlimited

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

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

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
queueLimit	isis:QueueLimitType (scalar:Uint32)	Holds the ISIS queue limit retransmit value	RANGE: [200 , 65535] DEFAULT: 2000

isisDom Properties

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

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 Unlimited Retransmit Queue

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

CLI Commands

router isis TAG_1
vrf VRF_1
no queue-limit retransmit unlimited

Verifying a DME Configuration

MO	DN
topSystem	sys
isisEntity	sys/isis
isisInst	sys/isis/inst-TAG_1
isisDom	sys/isis/inst-TAG_1/dom-VRF_1
isisDom	sys/isis/inst-TAG_1/dom-default

isisInst Properties

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

isisDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
queueLimit	isis:QueueLimitType (scalar:Uint32)	Holds the ISIS queue limit retransmit value	RANGE: [200 , 65535] DEFAULT: 2000

isisDom Properties

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

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