List ports

Lists ports to which the project has access.

URI

/v2.0/ports

HTTP method

GET

Response status

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

Response body (normal status)


{
    "ports": [
        {
            "status": "ACTIVE",
            "name": "",
            "allowed_address_pairs": [],
            "admin_state_up": true,
            "network_id": "70c1db1f-b701-45bd-96e0-a313ee3430b3",
            "tenant_id": " d397de8a63f341818f198abb0966f6f3",
            "extra_dhcp_opts": [],
            "device_owner": " network:router_interface ",
            "mac_address": "fa:16:3e:58:42:ed",
            "binding:vnic_type": "normal",
            "fixed_ips": [
                {
                    "subnet_id": "008ba151-0b8c-4a67-98b5-0d2b87666062",
                    "ip_address": "172.24.4.2"
                }
            ],
            "id": "d80b1a3b-4fc1-49f3-952e-1e2ab7081d8b",
            "security_groups": [],
            "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
            "availability_zone": "AZ1"
        },
        {
            "status": "ACTIVE",
            "name": "",
            "allowed_address_pairs": [],
            "admin_state_up": true,
            "network_id": "f27aa545-cbdd-4907-b0c6-c9e8b039dcc2",
            "tenant_id": "d397de8a63f341818f198abb0966f6f3",
            "extra_dhcp_opts": [],
            "device_owner": "network:router_interface",
            "mac_address": "fa:16:3e:bb:3c:e4",
            "binding:vnic_type": "normal",
            "fixed_ips": [
                {
                    "subnet_id": "288bf4a1-51ba-43b6-9d0a-520e9005db17",
                    "ip_address": "10.0.0.1"
                }
            ],
            "id": "f71a6703-d6de-4be1-a91a-a570ede1d159",
            "security_groups": [],
            "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
            "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 (Optional) 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