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 Interface to be a Boundary of a PIM-SM Domain

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pimEntity": {
          "children": [
            {
              "pimInst": {
                "children": [
                  {
                    "pimDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "pimIf": {
                            "attributes": {
                              "borderRouter": "yes",
                              "id": "eth1/2"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
Request:
 
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" messageid="
101">
    <edit-config>
        <target>
            <running/>
        </target>
        <config>
            <System xmlns="http://cisco.com/ns/yang/cisco-nx-osdevice">
                <pim-items>
                    <name/>
                    <inst-items>
                        <dom-items>
                            <Dom-list>
                                <name>default</name>
                                <if-items>
                                    <If-list>
                                        <id>eth1/20</id>
                                        <borderRouter>true</borderRouter>
                                    </If-list>
                                </if-items>
                            </Dom-list>
                        </dom-items>
                    </inst-items>
                </pim-items>
            </System>
        </config>
    </edit-config>
</rpc>

Response:

<rpc-reply message-id="urn:uuid:ad8d599f-d406-43d5-
bf95-622b380fa87e"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <ok/>
</rpc-reply>

Configuring Multicast Service Reflection

For information about this feature, see the Cisco Nexus 9000 Series 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 the Interface to be a Boundary of a PIM-SM Domain

Note:

This YANG example was explicitly tested in Release 9.3(5).
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.

interface ethernet 1/2
ip pim border-router

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
pimEntity	sys/pim
pimInst	sys/pim/inst
pimDom	sys/pim/inst/dom-default
pimIf	sys/pim/inst/dom-default/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

pimDom Properties

The following table contains information about the pimDom 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: 63

pimIf Properties

The following table contains information about the pimIf 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
borderRouter	scalar:Bool	Acts as a border router on configuration	SELECTION: true or false
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

The following table contains information about the l1PhysIf 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	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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

Querying the IP PIM Border Router Using YANG (Netconf)

Querrying the IP PIM Border Router (Netconf)

Note:

This YANG example was explicitly tested in Release 9.3(5).
This example was added in Release 9.3(5).

Unconfiguring an IP PIM Border Router

Note:

This YANG example was explicitly tested in Release 9.3(5).
This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
no ip pim border-router

Verifying a DME Configuration

MO	DN
topSystem	sys
pimEntity	sys/pim
pimInst	sys/pim/inst
pimDom	sys/pim/inst/dom-default
pimIf	sys/pim/inst/dom-default/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

pimDom Properties

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

pimIf Properties

Property Name	Data Type	Description	Values
borderRouter	scalar:Bool	Acts as a border router on configuration	SELECTION: true or false
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 UDP Source Port

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

CLI Commands

ip service-reflect destination 236.1.1.0 to 239.1.1.0 mask-len 24 source 10.1.1.1 to 5.5.5.10 mask-len 32 to-udp-src-port 25

Verifying a DME Configuration

MO	DN
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-default
mribServiceReflect	sys/mrib/inst/dom-default/sr
mribSrRule	sys/mrib/inst/dom-default/sr/rule
mribRule	sys/mrib/inst/dom-default/sr/rule/pregrp-[236.1.1.0]-postgrp-[239.1.1.0]-gm-24-presrc-[10.1.1.1]-postsrc-[5.5.5.10]-sm-32-srcudp-25-destudp-0-oif-[unspecified]

mribDom Properties

The following table contains information about the mribDom 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: 63

mribRule Properties

The following table contains information about the mribRule 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
grpMasklen	mrib:MaskLen (scalar:Uint32)	Group Mask Length - Applies to G1 and G2.	RANGE: [0 , 32]
postTransGrp	address:Ip	Group Address to be translated into.	Value must match ipv4 or ipv6 known format
postTransSrc	address:Ip	Source Address to be translated into	Value must match ipv4 or ipv6 known format
preTransGrp	address:Ip	Group Address that needs translation	Value must match ipv4 or ipv6 known format
preTransSrc	address:Ip	Source Address to be translated	Value must match ipv4 or ipv6 known format
srcMasklen	mrib:MaskLen (scalar:Uint32)	Source Mask Length - applies to S1 and S2	RANGE: [0 , 32]
staticOif	nw:IfId (base:IfIndex)	Static OIF can only be physical interfaces	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 Note: You must specify "unspecified" if you do not want to push a static-oif as default.
udpDestPort	mrib:PortId (scalar:Uint32)	to UDP Destination port for NATing	RANGE: [0 , 65535]
udpsrcPort	mrib:PortId (scalar:Uint32)	to UDP source port for NATing	RANGE: [0 , 65535]

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 UDP Source Port

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

CLI Commands

no ip service-reflect destination 236.1.1.0 to 239.1.1.0 mask-len 24 source 10.1.1.1 to 5.5.5.10 mask-len 32 to-udp-src-port 25

Verifying a DME Configuration

MO	DN
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-default
mribServiceReflect	sys/mrib/inst/dom-default/sr
mribSrRule	sys/mrib/inst/dom-default/sr/rule
mribRule	sys/mrib/inst/dom-default/sr/rule/pregrp-[236.1.1.0]-postgrp-[239.1.1.0]-gm-24-presrc-[10.1.1.1]-postsrc-[5.5.5.10]-sm-32-srcudp-25-destudp-0-oif-[unspecified]

mribDom Properties

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

mribRule Properties

Property Name	Data Type	Description	Values
grpMasklen	mrib:MaskLen (scalar:Uint32)	Group Mask Length - Applies to G1 and G2.	RANGE: [0 , 32]
postTransGrp	address:Ip	Group Address to be translated into.	Value must match ipv4 or ipv6 known format
postTransSrc	address:Ip	Source Address to be translated into	Value must match ipv4 or ipv6 known format
preTransGrp	address:Ip	Group Address that needs translation	Value must match ipv4 or ipv6 known format
preTransSrc	address:Ip	Source Address to be translated	Value must match ipv4 or ipv6 known format
srcMasklen	mrib:MaskLen (scalar:Uint32)	Source Mask Length - applies to S1 and S2	RANGE: [0 , 32]
staticOif	nw:IfId (base:IfIndex)	Static OIF can only be physical interfaces	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
udpDestPort	mrib:PortId (scalar:Uint32)	to UDP Destination port for NATing	RANGE: [0 , 65535]
udpsrcPort	mrib:PortId (scalar:Uint32)	to UDP source port for NATing	RANGE: [0 , 65535]

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 Source Interface (Loopback)

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

CLI Commands

ip service-reflect source-interface loopback0

Verifying a DME Configuration

MO	DN
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-default
mribServiceReflect	sys/mrib/inst/dom-default/sr
mribSrcIntf	sys/mrib/inst/dom-default/sr/sourceintf

mribDom Properties

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

mribSrcIntf Properties

The following table contains information about the mribSrcIntf 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
srcIntf	nw:IfId (base:IfIndex)	Source intf can only be loopback interfaces	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Source Interface (Loopback)

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

CLI Commands

no ip service-reflect source-interface loopback0

Verifying a DME Configuration

MO	DN
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-default
mribServiceReflect	sys/mrib/inst/dom-default/sr
mribSrcIntf	sys/mrib/inst/dom-default/sr/sourceintf

mribDom Properties

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

mribSrcIntf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 Map-to-Service Interface

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

CLI Commands

multicast service-reflect interface ethernet 1/40 map interface ethernet 1/42 max-replication 35

Verifying a DME Configuration

MO	DN
mcaMappings	sys/mca/config/natsr/mappings
mcaNatMapOifSif	sys/mca/config/natsr/mappings/oif-[eth1/40]

mcaNatMapOifSif Properties

The following table contains information about the mcaNatMapOifSif 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
domName	string:Basic	Domain Context name	A sequence of characters
maxEnatReplications	mca:mcaEnatMaxReplications (scalar:Uint16)	Max number of replications allowed on the service interface	RANGE: [0 , 40] DEFAULT: 40
oiIfName	nw:IfId (base:IfIndex)	Nat Oif Interface name	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
siIfName	nw:IfId (base:IfIndex)	Service Interface name	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Map-to-Service Interface

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

CLI Commands

no multicast service-reflect interface ethernet 1/40 map interface ethernet 1/42 max-replication 35

Verifying a DME Configuration

MO	DN
mcaMappings	sys/mca/config/natsr/mappings
mcaNatMapOifSif	sys/mca/config/natsr/mappings/oif-[eth1/40]

mcaNatMapOifSif Properties

Property Name	Data Type	Description	Values
oiIfName	nw:IfId (base:IfIndex)	Nat Oif Interface name	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 Static OIF

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

CLI Commands

ip service-reflect destination 235.1.1.2 to 239.1.1.2 mask-len 32 source 10.1.1.1 to 5.5.5.11 mask-len 32 to-udp-src-port 25 static-oif Ethernet1/1

Verifying a DME Configuration

MO	DN
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-default
mribServiceReflect	sys/mrib/inst/dom-default/sr
mribSrRule	sys/mrib/inst/dom-default/sr/rule
mribRule	sys/mrib/inst/dom-default/sr/rule/pregrp-[235.1.1.2]-postgrp-[239.1.1.2]-gm-32-presrc-[10.1.1.1]-postsrc-[5.5.5.11]-sm-32-srcudp-25-destudp-0-oif-[eth1/1]

mribDom Properties

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

mribRule Properties

Property Name	Data Type	Description	Values
grpMasklen	mrib:MaskLen (scalar:Uint32)	Group Mask Length - Applies to G1 and G2.	RANGE: [0 , 32]
postTransGrp	address:Ip	Group Address to be translated into.	Value must match ipv4 or ipv6 known format
postTransSrc	address:Ip	Source Address to be translated into	Value must match ipv4 or ipv6 known format
preTransGrp	address:Ip	Group Address that needs translation	Value must match ipv4 or ipv6 known format
preTransSrc	address:Ip	Source Address to be translated	Value must match ipv4 or ipv6 known format
srcMasklen	mrib:MaskLen (scalar:Uint32)	Source Mask Length - applies to S1 and S2	RANGE: [0 , 32]
staticOif	nw:IfId (base:IfIndex)	Static OIF can only be physical interfaces	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
udpDestPort	mrib:PortId (scalar:Uint32)	to UDP Destination port for NATing	RANGE: [0 , 65535]
udpsrcPort	mrib:PortId (scalar:Uint32)	to UDP source port for NATing	RANGE: [0 , 65535]

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 IP Service-Reflect Mode Egress

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

CLI Commands

ip service-reflect mode egress 235.1.1.0/24

Verifying a DME Configuration

MO	DN
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-default
mribServiceReflect	sys/mrib/inst/dom-default/sr
mribEgressMode	sys/mrib/inst/dom-default/sr/egress-[235.1.1.0/24]

mribDom Properties

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

mribEgressMode Properties

The following table contains information about the mribEgressMode 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
grpList	address:Ip	IP multicast group address	Value must match ipv4 or ipv6 known format

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 IP Service-Reflect Mode Ingress

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

CLI Commands

ip service-reflect mode ingress 236.1.1.0/24

Verifying a DME Configuration

MO	DN
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-default
mribServiceReflect	sys/mrib/inst/dom-default/sr
mribIngressMode	sys/mrib/inst/dom-default/sr/ingress-[236.1.1.0/24]

mribDom Properties

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

mribIngressMode Properties

The following table contains information about the mribIngressMode 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
grpList	address:Ip	IP multicast group address	Value must match ipv4 or ipv6 known format

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