Get Switch Port to VLAN Port Mapping (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/port_vlan_members

Get switch port to VLAN port mapping information for an element.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items SwitchPortVlanPorts[]
Array [
admin_state string
The admin state of the switch ports.
id string
The ID of the switch port.
name string
The name of the switch port.
type string
The type of switch port.
vlans VlanPort[]
The details of the VLANs ports.
Array [
admin_state string
The admin state of the VLAN ports.
id string
The ID of the VLAN port.
name string
The name of the VLAN port.
vlan_id integer
The VLAN ID.
voice_enabled boolean
Value = True/False.
]
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "admin_state": "string",
      "id": "string",
      "name": "string",
      "type": "string",
      "vlans": [
        {
          "admin_state": "string",
          "id": "string",
          "name": "string",
          "vlan_id": 0,
          "voice_enabled": true
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "ELEMENT_NOT_FOUND"
      },
      {
        "code": "SWITCH_PORT_VLAN_MEMBERS_UNSUPPORTED_ELEMENT_MODEL"
      }
    ]
  }
}

Loading...