Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring a MAC Address Table

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "bdEntity": {
          "children": [
            {
              "l2VlanConfig": {
                "attributes": {
                  "accEncap": "vlan-1"
                }
              }
            }
          ]
        }
      },
      {
        "igmpsnoopEntity": {
          "children": [
            {
              "igmpsnoopInst": {
                "children": [
                  {
                    "igmpsnoopDom": {
                      "children": [
                        {
                          "igmpsnoopVlan": {
                            "attributes": {
                              "vlanid": "vlan1"
                            },
                            "children": [
                              {
                                "igmpsnoopIgmpsnBase": {
                                  "attributes": {
                                    "lookupMac": "yes"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <bd-items>
    <vlanconfig-items>
      <VlanConfig-list>
        <accEncap>vlan-1</accEncap>
      </VlanConfig-list>
    </vlanconfig-items>
  </bd-items>
  <igmpsnoop-items>
    <inst-items>
      <dom-items>
        <vlan-items>
          <Vlan-list>
            <vlanid>vlan1</vlanid>
            <igmpsnbase-items>
              <lookupMac>true</lookupMac>
            </igmpsnbase-items>
          </Vlan-list>
        </vlan-items>
      </dom-items>
    </inst-items>
  </igmpsnoop-items>
</System>

Configuring IGMP Under a VLAN Configuration

Configuring a MAC Address Table

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

vlan configuration 1
layer-2 multicast lookup mac

Note: The property information for this example was added in Release 9.3(3).

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
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-{[accEncap]}
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-{[vlanid]}
igmpsnoopIgmpsnBase	sys/igmpsnoop/inst/dom/gl/igmpsnbase

l2VlanConfig Properties

The following table contains information about the l2VlanConfig 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
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

igmpsnoopVlan Properties

The following table contains information about the igmpsnoopVlan 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
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

igmpsnoopIgmpsnBase Properties

The following table contains information about the igmpsnoopIgmpsnBase 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
lookupMac	scalar:Bool	Indicates if Layer-2 Multicast Lookup Mac is Enabled	SELECTION: true or false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting a MAC Address Table

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

CLI Commands

vlan configuration 1
no layer-2 multicast lookup mac

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-{[accEncap]}
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-{[vlanid]}
igmpsnoopIgmpsnBase	sys/igmpsnoop/inst/dom/gl/igmpsnbase

l2VlanConfig Properties

Property Name	Data Type	Description	Values
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

igmpsnoopVlan Properties

Property Name	Data Type	Description	Values
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

igmpsnoopIgmpsnBase Properties

Property Name	Data Type	Description	Values
lookupMac	scalar:Bool	Indicates if Layer-2 Multicast Lookup Mac is Enabled	SELECTION: true or false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting Router Guard IPv6 Multicast VLAN

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

CLI Commands

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

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

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

Configuring a Group Address for Proxy Leave

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

CLI Commands

vlan configuration 1
ip igmp snooping proxy-leave use-group-address

Verifying a DME Configuration

MO	DN
topSystem	sys
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-[vlan1]
igmpsnoopGTimers	sys/igmpsnoop/inst/dom/vlan-[vlan1]/gTimers
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-[vlan-1]

igmpsnoopVlan Properties

Property Name	Data Type	Description	Values
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

igmpsnoopGTimers Properties

The following table contains information about the igmpsnoopGTimers 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
useGrpAddr	scalar:Bool	Use Group IP Address for Proxy-Leave	SELECTION: true or false

l2VlanConfig Properties

Property Name	Data Type	Description	Values
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

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 Group Address for Proxy Leave

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

CLI Commands

vlan configuration 1
no ip igmp snooping proxy-leave use-group-address

Verifying a DME Configuration

MO	DN
topSystem	sys
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-[vlan1]
igmpsnoopGTimers	sys/igmpsnoop/inst/dom/vlan-[vlan1]/gTimers
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-[vlan-1]

igmpsnoopVlan Properties

Property Name	Data Type	Description	Values
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

igmpsnoopGTimers Properties

Property Name	Data Type	Description	Values
useGrpAddr	scalar:Bool	Use Group IP Address for Proxy-Leave	SELECTION: true or false

l2VlanConfig Properties

Property Name	Data Type	Description	Values
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

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 IP IGMP Snooping Report Flood All

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

CLI Commands

vlan configuration 1
ip igmp snooping report-flood all

Verifying a DME Configuration

MO	DN
topSystem	sys
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-[vlan1]
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-[vlan-1]

igmpsnoopVlan Properties

Property Name	Data Type	Description	Values
rprtFldAllIntf	scalar:Bool	Enable Report-Flood on all Active Interfaces of VLAN	SELECTION: true or false
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l2VlanConfig Properties

Property Name	Data Type	Description	Values
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

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 IP IGMP Snooping Report Flood All

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

CLI Commands

vlan configuration 1
no ip igmp snooping report-flood all

Verifying a DME Configuration

MO	DN
topSystem	sys
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-[vlan1]
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-[vlan-1]

igmpsnoopVlan Properties

Property Name	Data Type	Description	Values
rprtFldAllIntf	scalar:Bool	Enable Report-Flood on all Active Interfaces of VLAN	SELECTION: true or false
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l2VlanConfig Properties

Property Name	Data Type	Description	Values
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

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 IP IGMP Snooping Report Flood Ethernet Interface

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

CLI Commands

vlan configuration 1
ip igmp snooping report-flood interface ethernet 1/2

Verifying a DME Configuration

MO	DN
topSystem	sys
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-[vlan1]
igmpsnoopIntf	sys/igmpsnoop/inst/dom/vlan-[vlan1]/intf-[eth1/2]
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-[vlan-1]

igmpsnoopVlan Properties

Property Name	Data Type	Description	Values
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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
reportFlood	scalar:Bool	Indicates if Report Flood is Enabled on the Interface	SELECTION: true or false

l2VlanConfig Properties

Property Name	Data Type	Description	Values
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

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 IP IGMP Snooping Report Flood Ethernet Interface

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

CLI Commands

vlan configuration 1
no ip igmp snooping report-flood interface ethernet 1/2

Verifying a DME Configuration

MO	DN
topSystem	sys
igmpsnoopEntity	sys/igmpsnoop
igmpsnoopInst	sys/igmpsnoop/inst
igmpsnoopDom	sys/igmpsnoop/inst/dom
igmpsnoopVlan	sys/igmpsnoop/inst/dom/vlan-[vlan1]
igmpsnoopIntf	sys/igmpsnoop/inst/dom/vlan-[vlan1]/intf-[eth1/2]
bdEntity	sys/bd
l2VlanConfig	sys/bd/vlanconfig-[vlan-1]

igmpsnoopVlan Properties

Property Name	Data Type	Description	Values
vlanid	nw:IfId (base:IfIndex)	Vlan ID for IGMP Snooping Configuration	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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
reportFlood	scalar:Bool	Indicates if Report Flood is Enabled on the Interface	SELECTION: true or false

l2VlanConfig Properties

Property Name	Data Type	Description	Values
accEncap	base:Encap	Access Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

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