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

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

Get VLAN port to switch 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 VlanPortSwitchPorts[]
Array [
admin_state string
The admin state of the VLAN ports.
id string
The ID of the VLAN port.
ports SwitchPort[]
The details of the switch ports.
Array [
admin_state string
The admin state of the switch port.
id string
The ID of the switch port.
name string
The name of the switch port.
type string
The type of switch port.
]
vlan_id integer
The VLAN ID.
vlan_name string
The name of the VLAN port.
voice_enabled boolean
Value = True/False.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "admin_state": "string",
      "id": "string",
      "ports": [
        {
          "admin_state": "string",
          "id": "string",
          "name": "string",
          "type": "string"
        }
      ],
      "vlan_id": 0,
      "vlan_name": "string",
      "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...