Show port

Shows information for a specified port.

URI

/v2.0/ports/{port_id}

Description of the URI:

{port_id} UUID The UUID for the port.

HTTP method

GET

Response status

Status code Description
200 Normal response codes
unauthorized (401) Error response codes
itemNotFound (404) Error response codes

Response body (normal status)


{
    "port": {
        "status": "ACTIVE",
        "name": "",
        "allowed_address_pairs": [],
        "admin_state_up": true,
        "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7",
        "tenant_id": "7e02058126cc4950b75f9970368ba177",
        "extra_dhcp_opts": [],
        "device_owner": "network:router_interface",
        "mac_address": "fa:16:3e:23:fd:d7",
        "binding:vnic_type": "normal",
        "fixed_ips": [
            {
                "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2",
                "ip_address": "10.0.0.1"
            }
        ],
        "id": "46d4bfb9-b26e-41f3-bd2e-e6dcc1ccedb2",
        "security_groups": [],
        "device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e",
        "availability_zone": "AZ1"
    }
}

Description of response body (normal status)

Item Description
status The port status. Value is ACTIVE or DOWN.
name The port name.
allowed_address_pairs Allowed address pairs.
admin_state_up The administrative state of the port, which is up (true) or down (false).
network_id The ID of the attached network.
tenant_id The ID of the project who owns the network.
extra_dhcp_opts Extra DHCP options.
device_owner The ID of the entity that uses this port. For example, a dhcp agent.
mac_address The MAC address of the port.
fixed_ips IP addresses for the port. Includes the IP address and subnet ID.
id The ID of the port.
security_groups The IDs of any attached security groups.
device_id The ID of the device that uses this port. For example, a virtual server.
binding:vnic_type The vnic type that is bound to the port.

This value is one of the following:

  • normal(virtual nic)
  • direct(pci passthrough)
  • macvtap(virtual interface with a tap-like software interface)
availability_zone The Availability Zone name