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 VLAN Additions to the Private VLAN List (SVI Secondary VLANs)

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanSvi": {
                "attributes": {
                  "if": "vlan1",
                  "secondaryVlans": "1919"
                }
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <pvlan-items>
    <svi-items>
      <Svi-list>
        <if>vlan1</if>
        <secondaryVlans>1919</secondaryVlans>
      </Svi-list>
    </svi-items>
  </pvlan-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan1</id>
      </If-list>
    </svi-items>
  </intf-items>
</System>

Configuring PVLAN on a VLAN Interface

Configuring VLAN Additions to the Private VLAN List (SVI Secondary VLANs)

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 vlan 1
private-vlan mapping add 1919

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
pvlanPrivateVlan	sys/pvlan
pvlanSvi	sys/pvlan/svi-[vlan1]
interfaceEntity	sys/intf
sviIf	sys/intf/svi-[vlan1]

pvlanSvi Properties

The following table contains information about the pvlanSvi 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
if	nw:IfId (base:IfIndex)	Interface id of port with PVLAN	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
secondaryVlans	l2:VlanBitmap (base:BitArray)	Secondary VLANS of the PVLAN domain	ARRAY SIZE: 4096

sviIf Properties

The following table contains information about the sviIf 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

Deleting VLAN Additions to the Private VLAN List (SVI Secondary VLANs)

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

CLI Commands

interface vlan 1
no private-vlan mapping add 1919

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanSvi	sys/pvlan/svi-[vlan1]
interfaceEntity	sys/intf
sviIf	sys/intf/svi-[vlan1]

pvlanSvi Properties

Property Name	Data Type	Description	Values
if	nw:IfId (base:IfIndex)	Interface id of port with PVLAN	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

sviIf 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 VLAN Removal From the Current List (SVI Secondary VLANs)

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

CLI Commands

interface vlan 1
private-vlan mapping remove 1919

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanSvi	sys/pvlan/svi-[vlan1]
interfaceEntity	sys/intf
sviIf	sys/intf/svi-[vlan1]

pvlanSvi Properties

Property Name	Data Type	Description	Values
if	nw:IfId (base:IfIndex)	Interface id of port with PVLAN	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
secondaryVlans	l2:VlanBitmap (base:BitArray)	Secondary VLANS of the PVLAN domain	ARRAY SIZE: 4096

sviIf 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

Deleting VLAN Removal From the Current List (SVI Secondary VLANs)

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

CLI Commands

interface vlan 1
no private-vlan mapping

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanSvi	sys/pvlan/svi-[vlan1]
interfaceEntity	sys/intf
sviIf	sys/intf/svi-[vlan1]

pvlanSvi Properties

Property Name	Data Type	Description	Values
if	nw:IfId (base:IfIndex)	Interface id of port with PVLAN	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

sviIf 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