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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Interface EIGRP Process

DME

YANG

Copy
POST http://<mgmt_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "eigrpEntity": {
          "children": [
            {
              "eigrpInst": {
                "attributes": {
                  "name": "1"
                },
                "children": [
                  {
                    "eigrpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "eigrpIf": {
                            "attributes": {
                              "id": "eth1/1"
                            },
                            "children": [
                              {
                                "eigrpIfAf": {
                                  "attributes": {
                                    "type": "ipv4-ucast"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}   
Response
{
    imdata:[]
}

Copy
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
        <eigrp-items>
          <inst-items>
            <Inst-list>
              <name>1</name>
              <dom-items>
                <Dom-list>
                  <name>default</name>
                  <if-items>
                    <If-list>
                      <id>eth1/1</id>
                      <af-items>
                        <IfAf-list>
                          <type>ipv4-ucast</type>
                        </IfAf-list>
                      </af-items>
                    </If-list>
                  </if-items>
                </Dom-list>
              </dom-items>
            </Inst-list>
          </inst-items>
        </eigrp-items>
      </System>
    </config>
  </edit-config>
</rpc>

Configuring EIGRP in Interface Configuration Mode

Configuring Interface EIGRP Process

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] {ip|ipv6} router eigrp <eigrp-ptag>

Note: The property information for this example was added in release 10.3(1)F.

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
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

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 EIGRP Hello Interval

CLI Commands

[no] {ip|ipv6} hello-interval eigrp <inst> <seconds>

Note: The property information for this example was added in release 10.3(1)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

The following table contains information about the eigrpIfAf 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	Values	Description
helloIntvl	scalar: Unit16	Range: [1,65535] Default: 5	Configure IP-EIGRP hello interval

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 EIGRP Hold Interval

CLI Commands

[no] {ip|ipv6} hold-time eigrp <inst> <seconds>

Note: The property information for this example was added in release 10.3(1)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
holdIntvl	scalar: Unit16	Range: [1,65535] Default: 15	Configure IP-EIGRP hold time

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 EIGRP Bandwidth Percent

CLI Commands

[no] {ip|ipv6} bandwidth-percent eigrp <inst> <bandwidth>

Note: The property information for this example was added in release 10.3(1)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
bwPercent	scalar: UByte	Range: [1,100] Default: 50	Set bandwidth percent for interface that EIGRP can use

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 EIGRP Interface Admin State

CLI Commands

[no] {ip|ipv6} eigrp <inst> shutdown

Note: The property information for this example was added in release 10.3(1)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
adminSt	fm: AdminState scalar: Enum8	Selection: 1: enabled 2: disabled Default: enabled(1)	Admin state of the EIGRP on If Af for EIGRP instance shut on the interface

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 EIGRP Delay

CLI Commands

[no] {ip|ipv6} delay eigrp <inst> <delay> [picoseconds]

Note: The property information for this example was added in release 10.3(1)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
delay	scalar: Unit32	Range: [1-0xFFFFFF]	Set delay for interface used in EIGRP metric calculation

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 EIGRP Bandwidth

CLI Commands

[no] {ip|ipv6} bandwidth eigrp <eigrp-ptag> <bw>

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
bw	Scalar: uint32	Range: [0- 2560000000] Default: 0	Set bandwidth for interface used in Eigrp metric calculation

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 EIGRP mtu(max packet size used by EIGRP)

CLI Commands

[no] {ip|ipv6} mtu eigrp <eigrp-ptag> <mtu>

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
mtu	Scalar: uint32	Range: [209 - 16384] Default: 209	Set Max Packet Size to be used by EIGRP

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 EIGRP BFD

CLI Commands

[no] {ip|ipv6} eigrp <eigrp-tag> bfd [disable]

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
bfd	Scalar: uint32	Selection: True: enabled False: disabled Default: False	Enable BFD

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 EIGRP passive-interface

CLI Commands

[no] {ip|ipv6} passive-interface eigrp <eigrp-ptag>

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
passive	Scalar: enum	Selection: 1: inherit 2: enabled 3. disabled Default: inherit (1)	Configures eigrp passive on interface

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 EIGRP next hop self on interface

CLI Commands

[no] {ip|ipv6} next-hop-self eigrp <eigrp-ptag>

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
nhself	Scalar: bool	Selection: True: enabled False: disabled Default: true	Configures eigrp next hop self on interface

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 EIGRP split horizon

CLI Commands

[no] {ip|ipv6} split-horizon eigrp <eigrp-ptag>

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpIfAf	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type

eigrpIfAf Properties

Property Name	Data Type	Values	Description
splitHorizon	Scalar: bool	Selection: True: enabled False: disabled Default: true	Configures eigrp split-horizon on interface

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 EIGRP Authentication Mode

CLI Commands

[no] {ip|ipv6} authentication eigrp <eigrp-ptag> mode md5

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpAuth	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type/auth

eigrpAuth Properties

The following table contains information about the eigrpAuth 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	Values	Description
mode	Scalar: Enum8	Selection: 0: none 1: md5 Default: none	Holds Authentication Mode

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 EIGRP Authentication Key Chain

CLI Commands

[no] {ip|ipv6} authentication eigrp <eigrp-ptag> key-chain <chain>

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpAuth	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type/auth

eigrpAuth Properties

Property Name	Data Type	Values	Description
keyChain	String: Basic	MAXSIZE: 63	Holds key chain name

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 EIGRP Route Control Policy(distribute-list)

CLI Commands

[no] {ip|ipv6} distribute-list eigrp <eigrp-ptag> {{route-map <map>} | {prefix-list <list>}} {in | out}

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpRtCtrl	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type/rtctrl

eigrpRtCtrl Properties

The following table contains information about the eigrpRtCtrl 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	Values	Description
direction	Scalar:enum	Selection: 1: in 2: out Default: in (1)	Direction
rtMap	String: Basic	Pattern: “.[!~]{0,63}."	Route map used in distribution of routes
pfxList	String: Basic	Pattern.[!~]{0,63}."	Prefix list to control route distribution

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 EIGRP Route metric Alteration Policy (offset-list)

CLI Commands

[no] {ip|ipv6} offset-list eigrp <eigrp-ptag> {{route-map <map>} | {prefix-list <list>}} {in | out} <offset>

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpRtMetricAlter	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type/rtmetricalter

eigrpRtMetricAlter Properties

The following table contains information about the eigrpRtMetricAlter 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	Values	Description
direction	Scalar:enum	Selection: 1: in 2: out Default: in (1)	Direction
rtMap	String: Basic	Pattern: “.[!~]{0,63}."	Route map used in distribution of routes
pfxList	String: Basic	Pattern.[!~]{0,63}."	Prefix list to control route distribution
offset	scalar: uint32	Range: [0 -2147483647 ] Default: 0	Offset value for metric alter

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 EIGRP Route Summarization Policy

CLI Commands

[no] {ip|ipv6} summary-address eigrp <eigrp-ptag> { {<address> <mask>} | {<prefix>} } [<distance>] [leak-map <leak-map>]

Note: The property information for this example was added in release 10.3(2)F.

MO	DN
eigrpRtSum	sys/eigrp/inst-eigrp-ptag/dom-vrf-name/if-[interface]/af-type/rtsum

eigrpRtSum Properties

The following table contains information about the eigrpRtSum 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	Values	Description
addr	scalar: union	Ip-address	Ip address
rtMap	String: Basic	Pattern: “.[!~]{0,63}."	Route map to allow dynamic prefixes
distance	Scalar: Unit8	Range: [1-255] Default: 5	Administrative distance for summary address

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