Physical Port¶

This page describes operations you can perform on physical_ports. List, and get details for.

List Physical Port¶

List all visible physical_ports.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/physical_ports

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Physical port description.	no
id	query	string	hyph-uuid	-	Physical port unique id.	no
name	query	string	-	-	Physical port name.	no
plane	query	string	-	['storage', 'data']	The type of traffic that port will be used.	no
service_id	query	string	-	-	The ID of service that owns the physical port.	no
service_owner	query	string	-	['server', 'storage', 'l2_gateway', 'colo_device', None]	The type of physical port service owner.	no
status	query	string	-	-	The Physical Port status.	no
tenant_id	query	string	non-hyph-uuid	-	The owner name of physical port.	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
physical_ports	array<object>	Physical Port	-
description	string	-	Physical port description.
id	string	hyph-uuid	Physical port unique id.
name	string	-	Physical port name.
plane	string	-	The type of traffic that port will be used.
segmentation_ranges	array<object>	-	Ranges of allowed VLAN tags
end	integer	-	-
start	integer	-	-
service_id	string	-	The ID of service that owns the physical port.
service_owner	string	-	The type of physical port service owner.
status	string	-	The Physical Port status.
tags	object	-	Port tags.
tenant_id	string	non-hyph-uuid	The owner name of physical port.

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "physical_ports": [
    {
      "description": "Example physical_port 1 description.",
      "id": "1ce557a3-142b-413a-83dc-76680b0ca7b3",
      "name": "Example physical_port 1",
      "plane": "data",
      "segmentation_ranges": [
        {
          "end": 2048,
          "start": 3
        },
        {
          "end": 4093,
          "start": 2050
        }
      ],
      "service_id": "570bc4a1-2e49-4993-a476-2d503055b86c",
      "service_owner": "server",
      "status": "ACTIVE",
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "description": "Example physical_port 2 description.",
      "id": "de7c4ac0-9617-4133-bc75-a692a0bd6f14",
      "name": "Example physical_port 2",
      "plane": "storage",
      "segmentation_ranges": [
        {
          "end": 2048,
          "start": 3
        },
        {
          "end": 4093,
          "start": 2050
        }
      ],
      "service_id": "570bc4a1-2e49-4993-a476-2d503055b86c",
      "service_owner": "server",
      "status": "ACTIVE",
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Show Physical Port¶

Show details for physical_port.