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

Configuring Router Guard IP Multicast VLAN

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "igmpsnoopEntity": {
          "children": [
            {
              "igmpsnoopInst": {
                "children": [
                  {
                    "igmpsnoopDom": {
                      "children": [
                        {
                          "igmpsnoopIntf": {
                            "attributes": {
                              "id": "eth1/2",
                              "rtrGrdEnable": "yes",
                              "rtrGrdVlanId": "247"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <igmpsnoop-items>
    <inst-items>
      <dom-items>
        <intf-items>
          <Intf-list>
            <id>eth1/2</id>
            <rtrGrdEnable>true</rtrGrdEnable>
            <rtrGrdVlanId>247</rtrGrdVlanId>
          </Intf-list>
        </intf-items>
      </dom-items>
    </inst-items>
  </igmpsnoop-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring an Ethernet Interface (Layer 2)

Configuring Router Guard IP Multicast VLAN

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.

interface ethernet 1/2
switchport
router-guard ip multicast vlan 247

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
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopIntf	sys/igmpsnoop/inst/dom/intf-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

igmpsnoopIntf Properties

The following table contains information about the igmpsnoopIntf 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
rtrGrdEnable	scalar:Bool	Indicates if Router-Guard is Enabled on the Interface	SELECTION: true or false
rtrGrdVlanId	ipmcsnoop:RtrGrdVlanIdT (scalar:Uint32)	Router-Guard Vlan Identifier	Range 1-3967 No default value

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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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 Router Guard IP Multicast VLAN

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

CLI Commands

interface ethernet 1/2
switchport
no router-guard ip multicast vlan 247

Verifying a DME Configuration

MO	DN
topSystem	sys
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopIntf	sys/igmpsnoop/inst/dom/intf-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

igmpsnoopIntf 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
rtrGrdEnable	scalar:Bool	Indicates if Router-Guard is Enabled on the Interface	SELECTION: true or false
rtrGrdVlanId	ipmcsnoop:RtrGrdVlanIdT (scalar:Uint32)	Router-Guard Vlan Identifier	Range 1-3967 No default

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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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 Router Guard IPv6 Multicast VLAN

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

CLI Commands

interface ethernet 1/2
switchport
router-guard ipv6 multicast vlan 3864

Verifying a DME Configuration

MO	DN
topSystem	sys
mldsnoopEntity	sys/mldsnoop
mldsnoopInst	sys/mldsnoop/inst
mldsnoopDom	sys/mldsnoop/inst/dom
mldsnoopIntf	sys/mldsnoop/inst/dom/intf-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

mldsnoopIntf Properties

The following table contains information about the mldsnoopIntf 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
rtrGrdEnable	scalar:Bool	Indicates if Router-Guard is Enabled on the Interface	SELECTION: true or false
rtrGrdVlanId	ipmcsnoop:RtrGrdVlanIdT (scalar:Uint32)	Router-Guard Vlan Identifier	RANGE: 1-3967 No default value

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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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

]