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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring a VRF for Multicast RPF Static Route

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ipv4Entity": {
          "children": [
            {
              "ipv4Inst": {
                "children": [
                  {
                    "ipv4Dom": {
                      "attributes": {
                        "name": "VRF_1"
                      },
                      "children": [
                        {
                          "ipv4MulticastRoute": {
                            "attributes": {
                              "prefix": "1.0.0.0/8"
                            },
                            "children": [
                              {
                                "ipv4MulticastNexthop": {
                                  "attributes": {
                                    "nhAddr": "1.2.3.4/32",
                                    "nhIf": "unspecified",
                                    "nhVrf": "SampleString_123",
                                    "pref": "8"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "l3Inst": {
          "attributes": {
            "name": "VRF_1"
          }
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <multicastrt-items>
            <MulticastRoute-list>
              <prefix>1.0.0.0/8</prefix>
              <nh-items>
                <MulticastNexthop-list>
                  <nhIf>unspecified</nhIf>
                  <nhAddr>1.2.3.4/32</nhAddr>
                  <nhVrf>SampleString_123</nhVrf>
                  <pref>8</pref>
                </MulticastNexthop-list>
              </nh-items>
            </MulticastRoute-list>
          </multicastrt-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
    </Inst-list>
  </inst-items>
</System>

Configuring Multicast RPF Static Routes in VRF Mode

You can define reverse path forwarding (RPF) routes for multicast when you want multicast data to diverge from the unicast traffic path. You can define RPF routes for multicast on border routers to enable RPF to an external network. Multicast routes are used not to directly forward traffic but to make RPF checks. RPF routes for multicast cannot be redistributed.

For more information, see the Cisco Nexus 9000 NX-OS Multicast Routing Configuration Guide:

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

Configuring a VRF for Multicast RPF Static Route

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.

vrf context VRF_1
ip mroute 1.2.3.4 255.0.0.0 1.2.3.4 8 vrf SampleString_123

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
ipv4Entity	sys/ipv4
ipv4Inst	sys/ipv4/inst
ipv4Dom	sys/ipv4/inst/dom-VRF_1
ipv4MulticastRoute	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]
ipv4MulticastNexthop	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]/nh-[unspecified]-nhaddr-[1.2.3.4/32]-nhvrf-[SampleString_123]
l3Inst	sys/inst-VRF_1

ipv4Dom Properties

The following table contains information about the ipv4Dom 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.	RANGE: Min: "1" Max: "128"

ipv4MulticastRoute Properties

The following table contains information about the ipv4MulticastRoute 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
prefix	address:Ip	Prefix	Value must match ipv4 or ipv6 known format

ipv4MulticastNexthop Properties

The following table contains information about the ipv4MulticastNexthop 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
nhAddr	address:Ip	Nexthop Address	Value must match ipv4 or ipv6 known format
nhIf	nw:IfId (base:IfIndex)	Nexthop Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
nhVrf	l3:VrfName (string:Basic)	Nexthop VRF	A sequence of characters
pref	scalar:UByte	Route preference	RANGE: [0, 255]

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 Layer 3 instance name.	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 a VRF for Multicast RPF Static Route Configuration

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

CLI Commands

vrf context VRF_1
no ip mroute 1.2.3.4 255.0.0.0 1.2.3.4 8 vrf SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
ipv4Entity	sys/ipv4
ipv4Inst	sys/ipv4/inst
ipv4Dom	sys/ipv4/inst/dom-VRF_1
ipv4MulticastRoute	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]
ipv4MulticastNexthop	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]/nh-[unspecified]-nhaddr-[1.2.3.4/32]-nhvrf-[SampleString_123]
l3Inst	sys/inst-VRF_1

ipv4Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "1" Max: "128"

ipv4MulticastRoute Properties

Property Name	Data Type	Description	Values
prefix	address:Ip	Prefix	Value must match ipv4 or ipv6 known format

ipv4MulticastNexthop Properties

Property Name	Data Type	Description	Values
nhAddr	address:Ip	Nexthop Address	Value must match ipv4 or ipv6 known format
nhIf	nw:IfId (base:IfIndex)	Nexthop Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
nhVrf	l3:VrfName (string:Basic)	Nexthop VRF	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	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 a VRF for Multicast RPF Static Route (Null)

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

CLI Commands

vrf context VRF_1
ip mroute 1.2.3.4 255.0.0.0 null 0 63 vrf SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
ipv4Entity	sys/ipv4
ipv4Inst	sys/ipv4/inst
ipv4Dom	sys/ipv4/inst/dom-VRF_1
ipv4MulticastRoute	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]
ipv4MulticastNexthop	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]/nh-[null0]-nhaddr-[0.0.0.0/0]-nhvrf-[SampleString_123]
l3Inst	sys/inst-VRF_1

ipv4Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "1" Max: "128"

ipv4MulticastRoute Properties

Property Name	Data Type	Description	Values
prefix	address:Ip	Prefix	Value must match ipv4 or ipv6 known format

ipv4MulticastNexthop Properties

Property Name	Data Type	Description	Values
nhAddr	address:Ip	Nexthop Address	Value must match ipv4 or ipv6 known format
nhIf	nw:IfId (base:IfIndex)	Nexthop Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
nhVrf	l3:VrfName (string:Basic)	Nexthop VRF	A sequence of characters
pref	scalar:UByte	Route preference	RANGE: [0, 255]

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	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 a VRF for Multicast RPF Static Route (Null)

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

CLI Commands

vrf context VRF_1
no ip mroute 1.2.3.4 255.0.0.0 null 0 63 vrf SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
ipv4Entity	sys/ipv4
ipv4Inst	sys/ipv4/inst
ipv4Dom	sys/ipv4/inst/dom-VRF_1
ipv4MulticastRoute	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]
ipv4MulticastNexthop	sys/ipv4/inst/dom-VRF_1/multicastrt-[1.0.0.0/8]/nh-[null0]-nhaddr-[0.0.0.0/0]-nhvrf-[SampleString_123]
l3Inst	sys/inst-VRF_1

ipv4Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "1" Max: "128"

ipv4MulticastRoute Properties

Property Name	Data Type	Description	Values
prefix	address:Ip	Prefix	Value must match ipv4 or ipv6 known format

ipv4MulticastNexthop Properties

Property Name	Data Type	Description	Values
nhAddr	address:Ip	Nexthop Address	Value must match ipv4 or ipv6 known format
nhIf	nw:IfId (base:IfIndex)	Nexthop Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
nhVrf	l3:VrfName (string:Basic)	Nexthop VRF	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	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