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

Enabling RIP

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/acl/timerange.json
"topSystem": {
    "children": [
      {
        "fmEntity": {
          "children": [
            {
              "fmRip": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
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">
        <fm-items>
          <rip-items>
            <adminSt>enabled</adminSt>
          </rip-items>
        </fm-items>
      </System>
    </config>
  </edit-config>
</rpc>

Configuring RIP

RIP uses User Datagram Protocol (UDP) data packets to exchange routing information in small internetworks. RIPv2 supports IPv4. RIPv2 uses an optional authentication feature supported by the RIPv2 protocol. For more information, see Cisco Nexus 9000 Series NX-OS Unicast Routing Configuration Guide.

https://www.cisco.com/c/en/us/td/docs/dcn/nx-os/nexus9000/104x/unicast-routing-configuration/cisco-nexus-9000-series-nx-os-unicast-routing-configuration-guide/m-n9k-configuring-rip-93x.html

Enabling RIP

Note: This example was added in Release 10.5(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.

feature rip

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
fmRip	sys/fm/rip

Properties

The following table contains information about the timerangeSEQ 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
adminSt	fm: AdminState scalar: Enum8	Admin status of RIP feature.	Selection: 1: enabled 2: disabled Default: disabled (2)

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

Creating RIP Instance

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

CLI Commands

router rip rip_1

Verifying a DME Configuration

MO	DN
ripInst	sys/rip/inst-

Properties

Property Name	Data Type	Description	Values
Name	naming: Name	Router RIP instance name.	MAX SIZE: 20

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

Flushing RIP Routes

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

CLI Commands

router rip rip_1
flush-routes

Verifying a DME Configuration

MO	DN
ripInst	sys/rip/inst-

Properties

Property Name	Data Type	Description	Values
flushRoutes	Scalar:Bool	Flush routes in RIB during restart.	Selection: True or False Default: False

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 RIP Instance Isolate

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

CLI Commands

router rip rip_1
isolate

Verifying a DME Configuration

MO	DN
ripInst	sys/rip/inst-

Properties

Property Name	Data Type	Description	Values
isolate	scalar:Bool	Isolate this router from RIP.	Selection: True or False Default: False

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 RIP Metric Direct

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

CLI Commands

router rip rip_1
metric direct 0

Verifying a DME Configuration

MO	DN
ripInst	sys/rip/inst-

Properties

Property Name	Data Type	Description	Values
metricDirect	scalar:Bool	Direct route cost is zero to be compatible with IOS.	Selection: True or False Default: False

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 RIP VRF Instance

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

CLI Commands

router rip rip_1
metric direct 0

Verifying a DME Configuration

MO	DN
ripInst	sys/rip/inst-

Properties

Property Name	Data Type	Description	Values
metricDirect	scalar:Bool	Direct route cost is zero to be compatible with IOS.	Selection: True or False Default: False

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 VRF Address Family for RIP Instance

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

CLI Commands

router rip rip_1
vrf vrf_1
address-family ipv4 unicast

Verifying a DME Configuration

MO	DN
ripDomAf	sys/rip/inst-/dom-/af-type

Properties

Property Name	Data Type	Description	Values
type	Rip:AfT scalar: Enum8	configure address family.	Selection: 1: ipv4-ucast 2: ipv6-ucast

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 RIP Address-family Distance

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

CLI Commands

router rip rip_1
vrf vrf_1
address-family ipv6 unicast distance 200

Verifying a DME Configuration

MO	DN
ripDomAf	sys/rip/inst-//dom-/af-type/

Properties

Property Name	Data Type	Description	Values
distance	scalar:UByte	Holds admin distance for routes.	Range [1:255] Default: 120

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 RIP Address Family Max-path

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

CLI Commands

router rip rip_1
vrf vrf_1
address-family ipv6 unicast maximum-paths 50

Verifying a DME Configuration

MO	DN
ripDomAf	sys/rip/inst-//dom-/af-type/

Properties

Property Name	Data Type	Description	Values
maxPaths	scalar:UByte	Holds maximum ECMP paths.	Range [1:64] Default: 16

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

Disabling VRF

Enabling RIP

Note: This example was added in Release 10.5(2).

CLI Commands

shutdown

Verifying a DME Configuration

MO	DN
ripDom	sys/rip/inst-/dom-

Properties

Property Name	Data Type	Description	Values
adminSt	scalar:Bool	Shutdown RIP instance on the vrf	Selection: True or False Default: False

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

Generating a Default Route into RIP

Note: This example was added in Release 10.5(2).

CLI Commands

shutdown

Verifying a DME Configuration

MO	DN
ripDefRtLeakP	sys/rip/inst-/dom-/af-type/defrtleak

Properties

Property Name	Data Type	Description	Values
always	scalar:Bool	Always advertise default leak	Selection: True or False Default: False
rtMap	string: Basic	Policy to control distribution of default route	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

Redistributing IPv4

Note: This example was added in Release 10.5(2).

CLI Commands

redistribute ipv4

Verifying a DME Configuration

MO	DN
ripInterLeakP	sys/rip/inst-/dom-af-ipv4-ucast/interleak-proto-inst-asn

Properties

Property Name	Data Type	Description	Values
proto	Scalar: Enum8	-	Selection: 0: unspecified 1: static 2: direct 3: bgp 4: isis 5: ospf 7: eigrp 8: host 9: rip 10: amt 11: lisp
inst	string: Basic	Routing protocol instances	MAX SIZE: 20
Asn	string: Basic	ASN number	Range: [1, 65535] Default: none
rtMap	string: Basic	Policy to control distribution of default route perspective	MAX SIZE: 63 Default: false

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 Timers

Note: This example was added in Release 10.5(2).

CLI Commands

timers

Verifying a DME Configuration

MO	DN
ripDomAf	sys/rip/inst-/dom-/af-ipv4-ucast/

Properties

Property Name	Data Type	Description	Values
updateTimer	scalar:Uint32	Holds RIP update period config	Range:[5, 4294967295] Default: 30
timeout	scalar:Uint32	Holds RIP route timeout period config	Range:[1, 4294967295] Default: 180
garbageTimer	scalar:Uint32	Holds RIP route garbage period config	Range:[0, 4294967295] Default: 180
holdTimer	scalar:Uint32	Holds RIP route holddown period config	Range:[1, 4294967295] Default: 120

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 Maximum-paths

Note: This example was added in Release 10.5(2).

CLI Commands

maximum-paths

Verifying a DME Configuration

MO	DN
ripDomAf	sys/rip/inst-//dom-/af-type/

Properties

Property Name	Data Type	Description	Values
maxPaths	scalar:UByte	Holds maximum ECMP paths	Range [1:64] Default: 16

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 Default-metric

Note: This example was added in Release 10.5(2).

CLI Commands

default-metric 1

Verifying a DME Configuration

MO	DN
ripDomAf	sys/rip/inst-//dom-/af-type/ipv4-ucast

Properties

Property Name	Data Type	Description	Values
metric	scalar:UByte	Rip Metric Value	Range [1:15] Default: 1

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 interface with RIPing Instance

Note: This example was added in Release 10.5(2).

CLI Commands

[no] {ip|ipv6} router rip <tag>

Verifying a DME Configuration

MO	DN
ripIfAf	sys/rip/inst-/dom-/if-[]/af-

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 RIP Shutdown

Note: This example was added in Release 10.5(2).

CLI Commands

rip shutdown

Verifying a DME Configuration

MO	DN
ripIf	sys/rip/inst-/dom-/if-[]

Properties

Property Name	Data Type	Value	Description
adminSt	fm: AdminState scalar: Enum8	Selection: 1: enabled 2: disabled Default: enabled (1)	Admin state of the RIP on If Af for rip instance shut 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 Summary Address for IPv4 RIP

Note: This example was added in Release 10.5(2).

CLI Commands

rip shutdown

Verifying a DME Configuration

MO	DN
ripRtSum	sys/rip/inst-/dom-/if-[]/af-< ipv4-ucast >/rtsum-

Properties

Property Name	Data Type	Value	Description
addr	address:Ip	Prefix for summary address	Address to be used for summarization

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 Authentication Type for RIP

Note: This example was added in Release 10.5(2).

CLI Commands

ip rip authentication mode { text | md5 }

Verifying a DME Configuration

MO	DN
ripAuthP	sys/rip/inst-/dom-/if-[]/af-/auth

Properties

Property Name	Data Type	Value	Description
mode	scalar:Enum8	Selection: 0: none 1:text 2: 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 Authentication Key for RIP

Configuring Authentication Type for RIP

Note: This example was added in Release 10.5(2).

CLI Commands

ip rip authentication key-chain <keychain>

Verifying a DME Configuration

MO	DN
ripAuthP	sys/rip/inst-/dom-/if-[]/af-/auth

Properties

Property Name	Data Type	Value	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 Passive Interface

Note: This example was added in Release 10.5(2).

CLI Commands

ip rip passive-interface

Verifying a DME Configuration

MO	DN
ripIfAf	sys/rip/inst-/dom-/if-[]/af-< ipv4-ucast >

Properties

Property Name	Data Type	Value	Description
passiveIntf	Scalar:Bool	TRUE or FALSE Default: FALSE	Toggles RIP interface passive 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 Split Horizon with Poison Reverse

Note: This example was added in Release 10.5(2).

CLI Commands

ip/ipv6 rip poison-reverse

Verifying a DME Configuration

MO	DN
ripIfAf	sys/rip/inst-/dom-/if-[]/af-

Properties

Property Name	Data Type	Value	Description
poison	Scalar:Bool	TRUE or FALSE Default: FALSE	Toggles RIP poison reverse

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