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

Configuring the Interface to be a Boundary of a PIM-SM Domain
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"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
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>

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.

MODN
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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
borderRouterscalar:Bool
Acts as a border router on configurationSELECTION: true or false
idnw: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 NameData TypeDescriptionValues
idnw: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)
Request:
 
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
    <get-config>
        <source>
            <running/>
        </source>
        <filter>
            <System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
                <pim-items>
                    <name/>
                    <inst-items>
                        <dom-items>
                            <Dom-list>
                                <name>default</name>
                                <if-items>
                                    <If-list>
                                        <id>eth1/20</id>
                                    </If-list>
                                </if-items>
                            </Dom-list>
                        </dom-items>
                    </inst-items>
                </pim-items>
            </System>
        </filter>
    </get-config>
</rpc>

Response:

<rpc-reply message-id="urn:uuid:d5f3dc5c-95eb-4cad-af2bbc9b817c7bb6"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <data>
        <System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
            <pim-items>
                <inst-items>
                    <dom-items>
                        <Dom-list>
                            <name>default</name>
                            <if-items>
                                <If-list>
                                    <id>eth1/20</id>
                                    <adminSt>enabled</adminSt>
                                    <bfdInst>none</bfdInst>
                                    <border>false</border>
                                    <borderRouter>false</borderRouter>
                                    <ctrl>border</ctrl>
                                    <drDelay>3</drDelay>
                                    <drPrio>1</drPrio>
                                    <passive>false</passive>
                                    <pimSparseMode>true</pimSparseMode>
                                    <rfcStrict>false</rfcStrict>
                                </If-list>
                            </if-items>
                        </Dom-list>
                    </dom-items>
                </inst-items>
            </pim-items>
        </System>
    </data>
</rpc-reply>

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

Unconfiguring an IP PIM Border Router
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pimEntity": {
          "children": [
            {
              "pimInst": {
                "children": [
                  {
                    "pimDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "pimIf": {
                            "attributes": {
                              "borderRouter": "no",
                              "id": "eth1/2"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
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>false</borderRouter>
                                    </If-list>
                                </if-items>
                            </Dom-list>
                        </dom-items>
                    </inst-items>
                </pim-items>
            </System>
        </config>
    </edit-config>
</rpc>

Response:

<?xml version="1.0" ?>
<rpc-reply message-id="urn:uuid:c4f130d9-4b53-48df-8075-
c9bbd0664c30" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <ok/>
</rpc-reply>

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
  no 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.

MODN
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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
borderRouterscalar:Bool
Acts as a border router on configurationSELECTION: true or false
idnw: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 NameData TypeDescriptionValues
idnw: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

Configuring the UDP Source Port
POST http://<mgmt0_IP>/api/mo/sys/mrib/inst.json
{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribServiceReflect": {
                "children": [
                  {
                    "mribSrRule": {
                      "children": [
                        {
                          "mribRule": {
                            "attributes": {
                              "grpMasklen": "24",
                              "postTransGrp": "239.1.1.0",
                              "postTransSrc": "5.5.5.10",
                              "preTransGrp": "236.1.1.0",
                              "preTransSrc": "10.1.1.1",
                              "srcMasklen": "32",
                              "staticOif": "unspecified",
                              "udpDestPort": "0",
                              "udpsrcPort": "25"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <sr-items>
            <rule-items>
              <pregrp-items>
                <Rule-list>
                  <preTransGrp>236.1.1.0</preTransGrp>
                  <postTransGrp>239.1.1.0</postTransGrp>
                  <grpMasklen>24</grpMasklen>
                  <preTransSrc>10.1.1.1</preTransSrc>
                  <postTransSrc>5.5.5.10</postTransSrc>
                  <srcMasklen>32</srcMasklen>
                  <udpsrcPort>25</udpsrcPort>
                  <udpDestPort>0</udpDestPort>
                  <staticOif>unspecified</staticOif>
                </Rule-list>
              </pregrp-items>
            </rule-items>
          </sr-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: 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.

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

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.

MODN
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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
grpMasklenmrib:MaskLen
(scalar:Uint32)
Group Mask Length - Applies to G1 and G2.
RANGE: [0 , 32]
postTransGrpaddress:Ip
Group Address to be translated into.Value must match ipv4 or ipv6 known format
postTransSrcaddress:Ip
Source Address to be translated intoValue must match ipv4 or ipv6 known format
preTransGrpaddress:Ip
Group Address that needs translationValue must match ipv4 or ipv6 known format
preTransSrcaddress:Ip
Source Address to be translatedValue must match ipv4 or ipv6 known format
srcMasklenmrib:MaskLen
(scalar:Uint32)
Source Mask Length - applies to S1 and S2
RANGE: [0 , 32]
staticOifnw:IfId
(base:IfIndex)
Static OIF can only be physical interfacesMust 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.
udpDestPortmrib:PortId
(scalar:Uint32)
to UDP Destination port for NATing
RANGE: [0 , 65535]
udpsrcPortmrib: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

Deleting the UDP Source Port
POST http://<mgmt0_IP>/api/mo/sys/mrib/inst.json
{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribServiceReflect": {
                "children": [
                  {
                    "mribSrRule": {
                      "children": [
                        {
                          "mribRule": {
                            "attributes": {
                              "grpMasklen": "24",
                              "postTransGrp": "239.1.1.0",
                              "postTransSrc": "5.5.5.10",
                              "preTransGrp": "236.1.1.0",
                              "preTransSrc": "10.1.1.1",
                              "srcMasklen": "32",
                              "staticOif": "unspecified",
                              "status": "deleted",
                              "udpDestPort": "0",
                              "udpsrcPort": "25"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <sr-items>
            <rule-items>
              <pregrp-items>
                <Rule-list nc:operation="delete">
                  <preTransGrp>236.1.1.0</preTransGrp>
                  <postTransGrp>239.1.1.0</postTransGrp>
                  <grpMasklen>24</grpMasklen>
                  <preTransSrc>10.1.1.1</preTransSrc>
                  <postTransSrc>5.5.5.10</postTransSrc>
                  <srcMasklen>32</srcMasklen>
                  <udpsrcPort>25</udpsrcPort>
                  <udpDestPort>0</udpDestPort>
                  <staticOif>unspecified</staticOif>
                </Rule-list>
              </pregrp-items>
            </rule-items>
          </sr-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: 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.

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

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.

MODN
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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
grpMasklenmrib:MaskLen
(scalar:Uint32)
Group Mask Length - Applies to G1 and G2.
RANGE: [0 , 32]
postTransGrpaddress:Ip
Group Address to be translated into.Value must match ipv4 or ipv6 known format
postTransSrcaddress:Ip
Source Address to be translated intoValue must match ipv4 or ipv6 known format
preTransGrpaddress:Ip
Group Address that needs translationValue must match ipv4 or ipv6 known format
preTransSrcaddress:Ip
Source Address to be translatedValue must match ipv4 or ipv6 known format
srcMasklenmrib:MaskLen
(scalar:Uint32)
Source Mask Length - applies to S1 and S2
RANGE: [0 , 32]
staticOifnw:IfId
(base:IfIndex)
Static OIF can only be physical interfacesMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced
udpDestPortmrib:PortId
(scalar:Uint32)
to UDP Destination port for NATing
RANGE: [0 , 65535]
udpsrcPortmrib: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)

Configuring a Source Interface (Loopback)
POST http://<mgmt0_IP>/api/mo/sys/mrib/inst.json
{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribServiceReflect": {
                "children": [
                  {
                    "mribSrcIntf": {
                      "attributes": {
                        "srcIntf": "lo0"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <sr-items>
            <sourceintf-items>
              <srcIntf>lo0</srcIntf>
            </sourceintf-items>
          </sr-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: 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.

ip service-reflect source-interface loopback0


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.

MODN
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

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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
srcIntfnw:IfId
(base:IfIndex)
Source intf can only be loopback interfacesMust 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)

Deleting a Source Interface (Loopback)
POST http://<mgmt0_IP>/api/mo/sys/mrib/inst.json
{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribServiceReflect": {
                "children": [
                  {
                    "mribSrcIntf": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <sr-items>
            <sourceintf-items nc:operation="delete">
            </sourceintf-items>
          </sr-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: 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.

no ip service-reflect source-interface loopback0


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.

MODN
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

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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
statusmo: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

Configuring the Map-to-Service Interface
POST http://<mgmt0_IP>/api/mo/sys/mca/config/natsr/mappings.json
{
  "mcaMappings": {
    "children": [
      {
        "mcaNatMapOifSif": {
          "attributes": {
            "domName": "default",
            "maxEnatReplications": "35",
            "oiIfName": "eth1/40",
            "siIfName": "eth1/42"
}}}]}}
{
    imdata:[]
}
<System>
  <mca-items>
    <config-items>
      <natsr-items>
        <mappings-items>
          <oif-items>
            <NatMapOifSif-list>
              <oiIfName>eth1/40</oiIfName>
              <domName>default</domName>
              <maxEnatReplications>35</maxEnatReplications>
              <siIfName>eth1/42</siIfName>
            </NatMapOifSif-list>
          </oif-items>
        </mappings-items>
      </natsr-items>
    </config-items>
  </mca-items>
</System>

Note: 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.

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


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.

MODN
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 NameData TypeDescriptionValues
domNamestring:Basic
Domain Context nameA sequence of characters
maxEnatReplicationsmca:mcaEnatMaxReplications
(scalar:Uint16)
Max number of replications allowed on the service interface
RANGE: [0 , 40]
DEFAULT: 40
oiIfNamenw:IfId
(base:IfIndex)
Nat Oif Interface nameMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
siIfNamenw:IfId
(base:IfIndex)
Service Interface nameMust 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

Deleting the Map-to-Service Interface
POST http://<mgmt0_IP>/api/mo/sys/mca/config/natsr/mappings.json
{
  "mcaMappings": {
    "children": [
      {
        "mcaNatMapOifSif": {
          "attributes": {
            "oiIfName": "eth1/40",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <mca-items>
    <config-items>
      <natsr-items>
        <mappings-items>
          <oif-items>
            <NatMapOifSif-list nc:operation="delete">
              <oiIfName>eth1/40</oiIfName>
            </NatMapOifSif-list>
          </oif-items>
        </mappings-items>
      </natsr-items>
    </config-items>
  </mca-items>
</System>

Note: 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.

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


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.

MODN
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 NameData TypeDescriptionValues
oiIfNamenw:IfId
(base:IfIndex)
Nat Oif Interface nameMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
statusmo: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

Configuring a Static OIF
POST http://<mgmt0_IP>/api/mo/sys/mrib/inst.json
{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribServiceReflect": {
                "children": [
                  {
                    "mribSrRule": {
                      "children": [
                        {
                          "mribRule": {
                            "attributes": {
                              "grpMasklen": "32",
                              "postTransGrp": "239.1.1.2",
                              "postTransSrc": "5.5.5.11",
                              "preTransGrp": "235.1.1.2",
                              "preTransSrc": "10.1.1.1",
                              "srcMasklen": "32",
                              "staticOif": "eth1/1",
                              "udpDestPort": "0",
                              "udpsrcPort": "25"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <sr-items>
            <rule-items>
              <pregrp-items>
                <Rule-list>
                  <preTransGrp>235.1.1.2</preTransGrp>
                  <postTransGrp>239.1.1.2</postTransGrp>
                  <grpMasklen>32</grpMasklen>
                  <preTransSrc>10.1.1.1</preTransSrc>
                  <postTransSrc>5.5.5.11</postTransSrc>
                  <srcMasklen>32</srcMasklen>
                  <udpsrcPort>25</udpsrcPort>
                  <udpDestPort>0</udpDestPort>
                  <staticOif>eth1/1</staticOif>
                </Rule-list>
              </pregrp-items>
            </rule-items>
          </sr-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: 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.

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

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.

MODN
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

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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
grpMasklenmrib:MaskLen
(scalar:Uint32)
Group Mask Length - Applies to G1 and G2.
RANGE: [0 , 32]
postTransGrpaddress:Ip
Group Address to be translated into.Value must match ipv4 or ipv6 known format
postTransSrcaddress:Ip
Source Address to be translated intoValue must match ipv4 or ipv6 known format
preTransGrpaddress:Ip
Group Address that needs translationValue must match ipv4 or ipv6 known format
preTransSrcaddress:Ip
Source Address to be translatedValue must match ipv4 or ipv6 known format
srcMasklenmrib:MaskLen
(scalar:Uint32)
Source Mask Length - applies to S1 and S2
RANGE: [0 , 32]
staticOifnw:IfId
(base:IfIndex)
Static OIF can only be physical interfacesMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
udpDestPortmrib:PortId
(scalar:Uint32)
to UDP Destination port for NATing
RANGE: [0 , 65535]
udpsrcPortmrib: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

Configuring an IP Service-Reflect Mode Egress
POST http://<mgmt0_IP>/api/mo/sys/mrib/inst.json
{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribServiceReflect": {
                "children": [
                  {
                    "mribEgressMode": {
                      "attributes": {
                        "grpList": "235.1.1.0/24"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <sr-items>
            <egress-items>
              <EgressMode-list>
                <grpList>235.1.1.0/24</grpList>
              </EgressMode-list>
            </egress-items>
          </sr-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: 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.

ip service-reflect mode egress 235.1.1.0/24


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.

MODN
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

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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
grpListaddress:Ip
IP multicast group addressValue 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

Configuring an IP Service-Reflect Mode Ingress
POST http://<mgmt0_IP>/api/mo/sys/mrib/inst.json
{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribServiceReflect": {
                "children": [
                  {
                    "mribIngressMode": {
                      "attributes": {
                        "grpList": "236.1.1.0/24"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <sr-items>
            <ingress-items>
              <IngressMode-list>
                <grpList>236.1.1.0/24</grpList>
              </IngressMode-list>
            </ingress-items>
          </sr-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: 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.

ip service-reflect mode ingress 236.1.1.0/24


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.

MODN
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

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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
grpListaddress:Ip
IP multicast group addressValue 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