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 a VLAN Addition to a PVLAN List

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "po123"
                },
                "children": [
                  {
                    "pvlanAccess": {
                      "children": [
                        {
                          "pvlanAccessPromiscuous": {
                            "attributes": {
                              "primaryVlan": "vlan-264",
                              "secondaryVlans": "2352"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "pcAggrIf": {
                "attributes": {
                  "id": "po123",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>po123</if>
        <access-items>
          <promiscuous-items>
            <primaryVlan>vlan-264</primaryVlan>
            <secondaryVlans>2352</secondaryVlans>
          </promiscuous-items>
        </access-items>
      </If-list>
    </if-items>
  </pvlan-items>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

Configuring PVLAN on a Port Channel Interface

Configuring a VLAN Addition to a PVLAN List

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 port-channel 123
switchport
switchport private-vlan mapping 264 add 2352

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
pvlanIf	sys/pvlan/if-[po123]
pvlanAccess	sys/pvlan/if-[po123]/access
pvlanAccessPromiscuous	sys/pvlan/if-[po123]/access/promiscuous
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf Properties

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

pvlanAccessPromiscuous Properties

The following table contains information about the pvlanAccessPromiscuous 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
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlans	l2:VlanBitmap (base:BitArray)	Secondary VLANS of the PVLAN domain	ARRAY SIZE: 4096

pcAggrIf Properties

The following table contains information about the pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 VLAN Removal from a PVLAN List

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan mapping 264 remove 2352

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanAccess	sys/pvlan/if-[po123]/access
pvlanAccessPromiscuous	sys/pvlan/if-[po123]/access/promiscuous
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanAccessPromiscuous Properties

Property Name	Data Type	Description	Values
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlans	l2:VlanBitmap (base:BitArray)	Secondary VLANS of the PVLAN domain	ARRAY SIZE: 4096

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 VLAN Addition to a PVLAN List

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan mapping trunk 2643 add 3638

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
pvlanTrunkPromiscuousTable	sys/pvlan/if-[po123]/trunk/promiscuous
pvlanTrunkPromiscuousEntry	sys/pvlan/if-[po123]/trunk/promiscuous/primary-[vlan-2643]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunkPromiscuousEntry Properties

The following table contains information about the pvlanTrunkPromiscuousEntry 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
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlans	l2:VlanBitmap (base:BitArray)	Secondary VLANS of the PVLAN domain	ARRAY SIZE: 4096

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 a VLAN Addition to a PVLAN List

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

CLI Commands

interface port-channel 123
switchport
no switchport private-vlan mapping trunk 2643 add 3638

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
pvlanTrunkPromiscuousTable	sys/pvlan/if-[po123]/trunk/promiscuous
pvlanTrunkPromiscuousEntry	sys/pvlan/if-[po123]/trunk/promiscuous/primary-[vlan-2643]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunkPromiscuousEntry Properties

Property Name	Data Type	Description	Values
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 VLAN Removal from a PVLAN List

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan mapping trunk 2643 remove 3638

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
pvlanTrunkPromiscuousTable	sys/pvlan/if-[po123]/trunk/promiscuous
pvlanTrunkPromiscuousEntry	sys/pvlan/if-[po123]/trunk/promiscuous/primary-[vlan-2643]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunkPromiscuousEntry Properties

Property Name	Data Type	Description	Values
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlans	l2:VlanBitmap (base:BitArray)	Secondary VLANS of the PVLAN domain	ARRAY SIZE: 4096

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 a VLAN Removal from a PVLAN List

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

CLI Commands

interface port-channel 123
switchport
no switchport private-vlan mapping trunk 2643 remove 3638

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
pvlanTrunkPromiscuousTable	sys/pvlan/if-[po123]/trunk/promiscuous
pvlanTrunkPromiscuousEntry	sys/pvlan/if-[po123]/trunk/promiscuous/primary-[vlan-2643]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunkPromiscuousEntry Properties

Property Name	Data Type	Description	Values
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 PVLANs on FEX Trunk Ports

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

CLI Commands

system private-vlan fex trunk

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan

pvlanPrivateVlan Properties

The following table contains information about the pvlanPrivateVlan 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
fexTrunk	nw:AdminSt (scalar:Enum8)	Enable or disable PVLANs for FEX trunk	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 PVLANs on FEX Trunk Ports

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

CLI Commands

no system private-vlan fex trunk

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan

pvlanPrivateVlan Properties

Property Name	Data Type	Description	Values
fexTrunk	nw:AdminSt (scalar:Enum8)	Enable or disable PVLANs for FEX trunk	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 Private-VLAN Trunk Secondary

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan association trunk 500 600

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
pvlanTrunkSecondaryTable	sys/pvlan/if-[po123]/trunk/secondary
pvlanTrunkSecondaryEntry	sys/pvlan/if-[po123]/trunk/secondary/primary-[vlan-591]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunkSecondaryEntry Properties

The following table contains information about the pvlanTrunkSecondaryEntry 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
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlan	base:Encap	Secondary VLAN of the PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 Private-VLAN Trunk Secondary

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

CLI Commands

interface port-channel 123
switchport
no switchport private-vlan association trunk 500 600

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
pvlanTrunkSecondaryTable	sys/pvlan/if-[po123]/trunk/secondary
pvlanTrunkSecondaryEntry	sys/pvlan/if-[po123]/trunk/secondary/primary-[vlan-591]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunkSecondaryEntry Properties

Property Name	Data Type	Description	Values
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

pcAggrIf 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: pltfmDfltLayer
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 the Private VLAN Host Association

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan host-association 1200 1300

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanAccess	sys/pvlan/if-[po123]/access
pvlanAccessSecondary	sys/pvlan/if-[po123]/access/secondary
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanAccessSecondary Properties

The following table contains information about the pvlanAccessSecondary 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
primaryVlan	base:Encap	Primary VLAN of a PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlan	base:Encap	Secondary VLAN of the PVLAN domain	SELECTION: unknown, vlan-%d or vxlan-%d

pcAggrIf 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: pltfmDfltLayer
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 the Private VLAN Host Association

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

CLI Commands

interface port-channel 123
switchport
no switchport private-vlan host-association 1200 1300

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanAccess	sys/pvlan/if-[po123]/access
pvlanAccessSecondary	sys/pvlan/if-[po123]/access/secondary
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanAccessSecondary 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

pcAggrIf 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: pltfmDfltLayer
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

Setting Private VLAN Trunking Native Configuration

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan trunk native vlan 3238

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

The following table contains information about the pvlanTrunk 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
nativeVlan	base:Encap	Native VLAN on PVLAN trunk	SELECTION: unknown, vlan-%d or vxlan-%d DEFAULT: vlan-1

pcAggrIf 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: pltfmDfltLayer
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

Unsetting Private VLAN Trunking Native Configuration

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

CLI Commands

interface port-channel 123
switchport
no switchport private-vlan trunk native vlan 3238

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

Property Name	Data Type	Description	Values
nativeVlan	base:Encap	Native VLAN on PVLAN trunk	SELECTION: unknown, vlan-%d or vxlan-%d DEFAULT: vlan-1

pcAggrIf 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: pltfmDfltLayer
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 Trunk-Allowed VLAN List

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan trunk allowed vlan add 3404

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

Property Name	Data Type	Description	Values
trunkAllowedVlans	l2:VlanBitmap (base:BitArray)	Trunk Allowed VLANs on PVLAN trunk	ARRAY SIZE: 4096

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 a Trunk-Allowed VLAN List

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

CLI Commands

interface port-channel 123
switchport
no switchport private-vlan trunk allowed vlan 3404

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

Property Name	Data Type	Description	Values
trunkAllowedVlans	l2:VlanBitmap (base:BitArray)	Trunk Allowed VLANs on PVLAN trunk	ARRAY SIZE: 4096

pcAggrIf 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: pltfmDfltLayer
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 VLAN Exceptions (Trunk-Allowed VLAN List)

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan trunk allowed vlan except 3404

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

Property Name	Data Type	Description	Values
trunkAllowedVlans	l2:VlanBitmap (base:BitArray)	Trunk Allowed VLANs on PVLAN trunk	ARRAY SIZE: 4096

pcAggrIf 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: pltfmDfltLayer
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

Setting Allowed VLANs when Interface is in Private-VLAN Trunking Mode (Trunk-Allowed VLAN List)

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan trunk allowed vlan none

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

Property Name	Data Type	Description	Values
trunkAllowedVlans	l2:VlanBitmap (base:BitArray)	Trunk Allowed VLANs on PVLAN trunk	ARRAY SIZE: 4096

pcAggrIf 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: pltfmDfltLayer
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 Allowed VLANs when Interface is in Private-VLAN Trunking Mode (Trunk-Allowed VLAN List)

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

CLI Commands

interface port-channel 123
switchport
no switchport private-vlan trunk allowed vlan 123

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

Property Name	Data Type	Description	Values
trunkAllowedVlans	l2:VlanBitmap (base:BitArray)	Trunk Allowed VLANs on PVLAN trunk	ARRAY SIZE: 4096

pcAggrIf 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: pltfmDfltLayer
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 VLAN Removal From the Trunk-Allowed VLAN List

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

CLI Commands

interface port-channel 123
switchport
switchport private-vlan trunk allowed vlan remove 3404

Verifying a DME Configuration

MO	DN
topSystem	sys
pvlanPrivateVlan	sys/pvlan
pvlanIf	sys/pvlan/if-[po123]
pvlanTrunk	sys/pvlan/if-[po123]/trunk
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pvlanIf 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

pvlanTrunk Properties

Property Name	Data Type	Description	Values
trunkAllowedVlans	l2:VlanBitmap (base:BitArray)	Trunk Allowed VLANs on PVLAN trunk	ARRAY SIZE: 4096

pcAggrIf 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: pltfmDfltLayer
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