Configuring PVLAN on an Ethernet Interface

Configuring a VLAN Addition to a PVLAN List

Configuring a VLAN Addition to a PVLAN List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanAccess": {
                      "children": [
                        {
                          "pvlanAccessPromiscuous": {
                            "attributes": {
                              "primaryVlan": "vlan-796",
                              "secondaryVlans": "3461"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer,admin_state"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <access-items>
          <promiscuous-items>
            <primaryVlan>vlan-796</primaryVlan>
            <secondaryVlans>3461</secondaryVlans>
          </promiscuous-items>
        </access-items>
      </If-list>
    </if-items>
  </pvlan-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer,admin_state</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-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.

interface ethernet 1/2
  switchport
   switchport private-vlan mapping 796 add 3461


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanAccess sys/pvlan/if-[eth1/2]/access
pvlanAccessPromiscuous sys/pvlan/if-[eth1/2]/access/promiscuous
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlansl2:VlanBitmap
(base:BitArray)
Secondary VLANS of the PVLAN domain
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Configuring a VLAN Removal from a PVLAN List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanAccess": {
                      "children": [
                        {
                          "pvlanAccessPromiscuous": {
                            "attributes": {
                              "primaryVlan": "vlan-796",
                              "secondaryVlans": ""
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer,admin_state"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <access-items>
          <promiscuous-items>
            <primaryVlan>vlan-796</primaryVlan>
            <secondaryVlans></secondaryVlans>
          </promiscuous-items>
        </access-items>
      </If-list>
    </if-items>
  </pvlan-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer,admin_state</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-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.

interface ethernet 1/2
  switchport
   switchport private-vlan mapping 796 remove 3461


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanAccess sys/pvlan/if-[eth1/2]/access
pvlanAccessPromiscuous sys/pvlan/if-[eth1/2]/access/promiscuous
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlansl2:VlanBitmap
(base:BitArray)
Secondary VLANS of the PVLAN domain
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Configuring a VLAN Addition to a PVLAN list 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "children": [
                        {
                          "pvlanTrunkPromiscuousTable": {
                            "children": [
                              {
                                "pvlanTrunkPromiscuousEntry": {
                                  "attributes": {
                                    "primaryVlan": "vlan-11",
                                    "secondaryVlans": "2993-2994"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer,admin_state"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <promiscuous-items>
            <primary-items>
              <TrunkPromiscuousEntry-list>
                <primaryVlan>vlan-11</primaryVlan>
                <secondaryVlans>2993-2994</secondaryVlans>
              </TrunkPromiscuousEntry-list>
            </primary-items>
          </promiscuous-items>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer,admin_state</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-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.

interface ethernet 1/2
  switchport
   switchport private-vlan mapping trunk 11 add 2994


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
pvlanTrunkPromiscuousTable sys/pvlan/if-[eth1/2]/trunk/promiscuous
pvlanTrunkPromiscuousEntry sys/pvlan/if-[eth1/2]/trunk/promiscuous/primary-[vlan-11]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlansl2:VlanBitmap
(base:BitArray)
Secondary VLANS of the PVLAN domain
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Deleting a VLAN Addition to a PVLAN list 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "children": [
                        {
                          "pvlanTrunkPromiscuousTable": {
                            "children": [
                              {
                                "pvlanTrunkPromiscuousEntry": {
                                  "attributes": {
                                    "primaryVlan": "vlan-11",
                                    "status": "deleted"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer,admin_state"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <promiscuous-items>
            <primary-items>
              <TrunkPromiscuousEntry-list nc:operation="delete">
                <primaryVlan>vlan-11</primaryVlan>
              </TrunkPromiscuousEntry-list>
            </primary-items>
          </promiscuous-items>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer,admin_state</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-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.

interface ethernet 1/2
  switchport
   no switchport private-vlan mapping trunk 11 add 2994


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
pvlanTrunkPromiscuousTable sys/pvlan/if-[eth1/2]/trunk/promiscuous
pvlanTrunkPromiscuousEntry sys/pvlan/if-[eth1/2]/trunk/promiscuous/primary-[vlan-11]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Configuring a VLAN Removal from a PVLAN List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "children": [
                        {
                          "pvlanTrunkPromiscuousTable": {
                            "children": [
                              {
                                "pvlanTrunkPromiscuousEntry": {
                                  "attributes": {
                                    "primaryVlan": "vlan-11",
                                    "secondaryVlans": "2993"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer,admin_state"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <promiscuous-items>
            <primary-items>
              <TrunkPromiscuousEntry-list>
                <primaryVlan>vlan-11</primaryVlan>
                <secondaryVlans>2993</secondaryVlans>
              </TrunkPromiscuousEntry-list>
            </primary-items>
          </promiscuous-items>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer,admin_state</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-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.

interface ethernet 1/2
  switchport
   switchport private-vlan mapping trunk 11 remove 2994


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
pvlanTrunkPromiscuousTable sys/pvlan/if-[eth1/2]/trunk/promiscuous
pvlanTrunkPromiscuousEntry sys/pvlan/if-[eth1/2]/trunk/promiscuous/primary-[vlan-11]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlansl2:VlanBitmap
(base:BitArray)
Secondary VLANS of the PVLAN domain
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Deleting a VLAN Removal from a PVLAN List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "children": [
                        {
                          "pvlanTrunkPromiscuousTable": {
                            "children": [
                              {
                                "pvlanTrunkPromiscuousEntry": {
                                  "attributes": {
                                    "primaryVlan": "vlan-11",
                                    "status": "deleted"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer,admin_state"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <promiscuous-items>
            <primary-items>
              <TrunkPromiscuousEntry-list nc:operation="delete">
                <primaryVlan>vlan-11</primaryVlan>
              </TrunkPromiscuousEntry-list>
            </primary-items>
          </promiscuous-items>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer,admin_state</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-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.

interface ethernet 1/2
  switchport
   no switchport private-vlan mapping trunk 11 remove 2994


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
pvlanTrunkPromiscuousTable sys/pvlan/if-[eth1/2]/trunk/promiscuous
pvlanTrunkPromiscuousEntry sys/pvlan/if-[eth1/2]/trunk/promiscuous/primary-[vlan-11]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 Private-VLAN Trunk Secondary

Configuring Private-VLAN Trunk Secondary 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "children": [
                        {
                          "pvlanTrunkSecondaryTable": {
                            "children": [
                              {
                                "pvlanTrunkSecondaryEntry": {
                                  "attributes": {
                                    "primaryVlan": "vlan-1772",
                                    "secondaryVlan": "vlan-1772"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <secondary-items>
            <primary-items>
              <TrunkSecondaryEntry-list>
                <primaryVlan>vlan-1772</primaryVlan>
                <secondaryVlan>vlan-1772</secondaryVlan>
              </TrunkSecondaryEntry-list>
            </primary-items>
          </secondary-items>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   switchport private-vlan association trunk 1772 1772


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
pvlanTrunkSecondaryTable sys/pvlan/if-[eth1/2]/trunk/secondary
pvlanTrunkSecondaryEntry sys/pvlan/if-[eth1/2]/trunk/secondary/primary-[vlan-1772]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlanbase:Encap
Secondary VLAN of the PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Deleting Private-VLAN Trunk Secondary 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "children": [
                        {
                          "pvlanTrunkSecondaryTable": {
                            "children": [
                              {
                                "pvlanTrunkSecondaryEntry": {
                                  "attributes": {
                                    "primaryVlan": "vlan-1772",
                                    "status": "deleted"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <secondary-items>
            <primary-items>
              <TrunkSecondaryEntry-list nc:operation="delete">
                <primaryVlan>vlan-1772</primaryVlan>
              </TrunkSecondaryEntry-list>
            </primary-items>
          </secondary-items>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   no switchport private-vlan association trunk 1772 1772


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
pvlanTrunkSecondaryTable sys/pvlan/if-[eth1/2]/trunk/secondary
pvlanTrunkSecondaryEntry sys/pvlan/if-[eth1/2]/trunk/secondary/primary-[vlan-1772]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Configuring the Private VLAN Host Association 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanAccess": {
                      "children": [
                        {
                          "pvlanAccessSecondary": {
                            "attributes": {
                              "primaryVlan": "vlan-3073",
                              "secondaryVlan": "vlan-3073"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <access-items>
          <secondary-items>
            <primaryVlan>vlan-3073</primaryVlan>
            <secondaryVlan>vlan-3073</secondaryVlan>
          </secondary-items>
        </access-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   switchport private-vlan host-association 3073 3073


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanAccess sys/pvlan/if-[eth1/2]/access
pvlanAccessSecondary sys/pvlan/if-[eth1/2]/access/secondary
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 NameData TypeDescriptionValues
primaryVlanbase:Encap
Primary VLAN of a PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d
secondaryVlanbase:Encap
Secondary VLAN of the PVLAN domainSELECTION: unknown, vlan-%d or vxlan-%d


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Deleting the Private VLAN Host Association 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanAccess": {
                      "children": [
                        {
                          "pvlanAccessSecondary": {
                            "attributes": {
                              "status": "deleted"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <access-items>
          <secondary-items nc:operation="delete">
          </secondary-items>
        </access-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   no switchport private-vlan host-association 3073 3073


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanAccess sys/pvlan/if-[eth1/2]/access
pvlanAccessSecondary sys/pvlan/if-[eth1/2]/access/secondary
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 the Private VLAN Trunking Native Configuration

Setting the Private VLAN Trunking Native Configuration 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "nativeVlan": "vlan-3667"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <nativeVlan>vlan-3667</nativeVlan>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   switchport private-vlan trunk native vlan 3667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
nativeVlanbase:Encap
Native VLAN on PVLAN trunkSELECTION: unknown, vlan-%d or vxlan-%d
DEFAULT: vlan-1


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 the Private VLAN Trunking Native Configuration

Unsetting the Private VLAN Trunking Native Configuration 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "nativeVlan": "vlan-1"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <nativeVlan>vlan-1</nativeVlan>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   no switchport private-vlan trunk native vlan 3667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
nativeVlanbase:Encap
Native VLAN on PVLAN trunkSELECTION: unknown, vlan-%d or vxlan-%d
DEFAULT: vlan-1


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 Additions to the Trunk-Allowed VLAN List

Configuring VLAN Additions to the Trunk-Allowed VLAN List
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": "2667"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans>2667</trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   switchport private-vlan trunk allowed vlan add 2667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 VLAN Additions to the Trunk-Allowed VLAN List

Deleting VLAN Additions to the Trunk-Allowed VLAN List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": ""
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans></trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   no switchport private-vlan trunk allowed vlan 2667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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)

Configuring VLAN Exceptions (Trunk-Allowed VLAN List) 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": "1-2666,2668-4094"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans>1-2666,2668-4094</trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   switchport private-vlan trunk allowed vlan except 2667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 VLAN Additions to the Current List

Deleting VLAN Additions to the Current List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": ""
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans></trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   no switchport private-vlan trunk allowed vlan 2667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 Setting Allowed VLANs when Interface is in Private-VLAN Trunking Mode (Trunk-Allowed VLAN List)

Configuring Setting Allowed VLANs when Interface is in Private-VLAN Trunking Mode (Trunk-Allowed VLAN List)
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": ""
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans></trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   switchport private-vlan trunk allowed vlan none


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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)

Deleting Allowed VLANs when Interface is in Private-VLAN Trunking Mode (Trunk-Allowed VLAN List)
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": ""
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans></trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   no switchport private-vlan trunk allowed vlan 123


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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

Configuring VLAN Removal From the Trunk-Allowed VLAN List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": ""
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans></trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   switchport private-vlan trunk allowed vlan remove 2667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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 VLAN Additions to the Trunk-Allowed VLAN List

Deleting VLAN Additions to the Trunk-Allowed VLAN List 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "pvlanPrivateVlan": {
          "children": [
            {
              "pvlanIf": {
                "attributes": {
                  "if": "eth1/2"
                },
                "children": [
                  {
                    "pvlanTrunk": {
                      "attributes": {
                        "trunkAllowedVlans": ""
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <pvlan-items>
    <if-items>
      <If-list>
        <if>eth1/2</if>
        <trunk-items>
          <trunkAllowedVlans></trunkAllowedVlans>
        </trunk-items>
      </If-list>
    </if-items>
  </pvlan-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>

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
   no switchport private-vlan trunk allowed vlan 2667


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
pvlanPrivateVlan sys/pvlan
pvlanIf sys/pvlan/if-[eth1/2]
pvlanTrunk sys/pvlan/if-[eth1/2]/trunk
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


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 NameData TypeDescriptionValues
ifnw:IfId
(base:IfIndex)
Interface id of port with PVLANMust 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 NameData TypeDescriptionValues
trunkAllowedVlansl2:VlanBitmap
(base:BitArray)
Trunk Allowed VLANs on PVLAN trunk
ARRAY SIZE: 4096


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
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