List ports

 
MethodURIDescription
GET/v2.0/ports

Lists ports to which the tenant has access.

Default policy settings return only those subnets that are owned by the tenant who submits the request, unless the request is submitted by an user with administrative rights. Users can control which attributes are returned by using the fields query parameter. Additionally, you can filter results by using query string parameters. For information, see Filtering and Column Selection in the OpenStack Networking API v2.0 Reference.

Normal response codes: 200

Error response codes: unauthorized (401)

 Request

This operation does not require a request body.

 Response

 

Example 3.33. List ports: JSON response

{
   "ports":[
      {
         "status":"ACTIVE",
         "binding:host_id":"devstack-havana",
         "name":"vip-a54bc6e7-2e28-4c55-a676-6146a4c0f8b9",
         "allowed_address_pairs":[

         ],
         "admin_state_up":true,
         "network_id":"d32019d3-bc6e-4319-9c1d-6722fc136a22",
         "tenant_id":"4fd44f30292945e481c7b8a0c8908869",
         "extra_dhcp_opts":[

         ],
         "binding:vif_type":"ovs",
         "device_owner":"neutron:LOADBALANCER",
         "binding:capabilities":{
            "port_filter":true
         },
         "mac_address":"fa:16:3e:47:57:a0",
         "fixed_ips":[
            {
               "subnet_id":"54d6f61d-db07-451c-9ab3-b9609b6b6f0b",
               "ip_address":"192.0.0.3"
            }
         ],
         "id":"36242e87-0bae-49d7-bc59-a0867476c69a",
         "security_groups":[
            "d30c3c54-5dba-49cf-a323-48a86f078d2d"
         ],
         "device_id":"56016959-08ad-566c-8533-6240aff17dd5"
      },
      {
         "status":"DOWN",
         "binding:host_id":"",
         "name":"my_port",
         "allowed_address_pairs":[

         ],
         "admin_state_up":true,
         "network_id":"d32019d3-bc6e-4319-9c1d-6722fc136a22",
         "tenant_id":"4fd44f30292945e481c7b8a0c8908869",
         "extra_dhcp_opts":[

         ],
         "binding:vif_type":"unbound",
         "device_owner":"",
         "binding:capabilities":{
            "port_filter":false
         },
         "mac_address":"fa:16:3e:6c:e8:35",
         "fixed_ips":[

         ],
         "id":"41064069-24d6-46e8-9b5a-6da327e357b3",
         "security_groups":[
            "d30c3c54-5dba-49cf-a323-48a86f078d2d"
         ],
         "device_id":""
      },
      {
         "status":"DOWN",
         "binding:host_id":"",
         "name":"",
         "allowed_address_pairs":[

         ],
         "admin_state_up":true,
         "network_id":"ee2d3158-3e80-4fb3-ba87-c99f515d85e7",
         "tenant_id":"4fd44f30292945e481c7b8a0c8908869",
         "extra_dhcp_opts":[

         ],
         "binding:vif_type":"unbound",
         "device_owner":"",
         "binding:capabilities":{
            "port_filter":false
         },
         "mac_address":"fa:16:3e:80:14:5b",
         "fixed_ips":[

         ],
         "id":"6f9f6319-ce4b-4267-a5f8-558d6795632d",
         "security_groups":[
            "d30c3c54-5dba-49cf-a323-48a86f078d2d"
         ],
         "device_id":""
      },
      {
         "status":"ACTIVE",
         "binding:host_id":"devstack-havana",
         "name":"",
         "allowed_address_pairs":[

         ],
         "admin_state_up":true,
         "network_id":"d32019d3-bc6e-4319-9c1d-6722fc136a22",
         "tenant_id":"4fd44f30292945e481c7b8a0c8908869",
         "extra_dhcp_opts":[

         ],
         "binding:vif_type":"ovs",
         "device_owner":"network:dhcp",
         "binding:capabilities":{
            "port_filter":true
         },
         "mac_address":"fa:16:3e:3b:63:e8",
         "fixed_ips":[
            {
               "subnet_id":"54d6f61d-db07-451c-9ab3-b9609b6b6f0b",
               "ip_address":"192.0.0.2"
            }
         ],
         "id":"9842e9ab-7849-4bb5-8441-9fa223bfce45",
         "security_groups":[

         ],
         "device_id":"dhcp56016959-08ad-566c-8533-6240aff17dd5-d32019d3-bc6e-4319-9c1d-6722fc136a22"
      },
      {
         "status":"ACTIVE",
         "binding:host_id":"devstack-havana",
         "name":"",
         "allowed_address_pairs":[

         ],
         "admin_state_up":true,
         "network_id":"db193ab3-96e3-4cb3-8fc5-05f4296d0324",
         "tenant_id":"26a7980765d0414dbc1fc1f88cdb7e6e",
         "extra_dhcp_opts":[

         ],
         "binding:vif_type":"ovs",
         "device_owner":"network:dhcp",
         "binding:capabilities":{
            "port_filter":true
         },
         "mac_address":"fa:16:3e:f7:80:62",
         "fixed_ips":[
            {
               "subnet_id":"08eae331-0402-425a-923c-34f7cfe39c1b",
               "ip_address":"10.0.0.3"
            }
         ],
         "id":"d2159251-552f-47ae-9960-f80d2aa6864f",
         "security_groups":[

         ],
         "device_id":"dhcp56016959-08ad-566c-8533-6240aff17dd5-db193ab3-96e3-4cb3-8fc5-05f4296d0324"
      }
   ]
}

 

Example 3.34. List ports: XML response

<?xml version='1.0' encoding='UTF-8'?>
<ports xmlns="http://openstack.org/quantum/api/v2.0" xmlns:binding="http://docs.openstack.org/ext/binding/api/v1.0" xmlns:quantum="http://openstack.org/quantum/api/v2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <port>
        <status>ACTIVE</status>
        <name />
        <admin_state_up quantum:type="bool">True</admin_state_up>
        <network_id>ebda9658-093b-41ba-80ce-0cf8cb8365d4</network_id>
        <tenant_id>63878e4c5dd649d2a980e37aefddfa87</tenant_id>
        <binding:vif_type>ovs</binding:vif_type>
        <device_owner>compute:None</device_owner>
        <binding:capabilities>
            <port_filter quantum:type="bool">False</port_filter>
        </binding:capabilities>
        <mac_address>fa:16:3e:b9:ef:05</mac_address>
        <fixed_ips>
            <fixed_ip>
                <subnet_id>aca4d43c-c48c-4a2c-9bb6-ba374ef7e135</subnet_id>
                <ip_address>172.24.4.227</ip_address>
            </fixed_ip>
        </fixed_ips>
        <id>664ebd1a-facd-4c20-948c-07a784475ab0</id>
        <device_id>f288bb5f-920d-4276-8345-2c0319c16f58</device_id>
    </port>
    <port>
        <status>DOWN</status>
        <name />
        <admin_state_up quantum:type="bool">True</admin_state_up>
        <network_id>ebda9658-093b-41ba-80ce-0cf8cb8365d4</network_id>
        <tenant_id />
        <binding:vif_type>ovs</binding:vif_type>
        <device_owner>network:router_gateway</device_owner>
        <binding:capabilities>
            <port_filter quantum:type="bool">False</port_filter>
        </binding:capabilities>
        <mac_address>fa:16:3e:4a:3a:a2</mac_address>
        <fixed_ips>
            <fixed_ip>
                <subnet_id>aca4d43c-c48c-4a2c-9bb6-ba374ef7e135</subnet_id>
                <ip_address>172.24.4.226</ip_address>
            </fixed_ip>
        </fixed_ips>
        <id>c5ca7017-c390-4ccc-8cd7-333747e57fef</id>
        <device_id>0dc517bf-9169-4aa6-88b7-569219962881</device_id>
    </port>
    <port>
        <status>ACTIVE</status>
        <name />
        <admin_state_up quantum:type="bool">True</admin_state_up>
        <network_id>9d83c053-b0a4-4682-ae80-c00df269ce0a</network_id>
        <tenant_id>625887121e364204873d362b553ab171</tenant_id>
        <binding:vif_type>ovs</binding:vif_type>
        <device_owner>network:router_interface</device_owner>
        <binding:capabilities>
            <port_filter quantum:type="bool">False</port_filter>
        </binding:capabilities>
        <mac_address>fa:16:3e:2d:dc:7e</mac_address>
        <fixed_ips>
            <fixed_ip>
                <subnet_id>a318fcb4-9ff0-4485-b78c-9e6738c21b26</subnet_id>
                <ip_address>10.0.0.1</ip_address>
            </fixed_ip>
        </fixed_ips>
        <id>d7815f5b-a228-47bb-a5e5-f139c4e476f6</id>
        <device_id>0dc517bf-9169-4aa6-88b7-569219962881</device_id>
    </port>
    <port>
        <status>ACTIVE</status>
        <name />
        <admin_state_up quantum:type="bool">True</admin_state_up>
        <network_id>9d83c053-b0a4-4682-ae80-c00df269ce0a</network_id>
        <tenant_id>625887121e364204873d362b553ab171</tenant_id>
        <binding:vif_type>ovs</binding:vif_type>
        <device_owner>network:dhcp</device_owner>
        <binding:capabilities>
            <port_filter quantum:type="bool">False</port_filter>
        </binding:capabilities>
        <mac_address>fa:16:3e:73:6d:1c</mac_address>
        <fixed_ips>
            <fixed_ip>
                <subnet_id>a318fcb4-9ff0-4485-b78c-9e6738c21b26</subnet_id>
                <ip_address>10.0.0.2</ip_address>
            </fixed_ip>
        </fixed_ips>
        <id>f8639521-fab2-4879-94b2-83a47bee8a26</id>
        <device_id>dhcpe1b8334f-9be9-5e49-aeee-b31e6df6c847-9d83c053-b0a4-4682-ae80-c00df269ce0a</device_id>
    </port>
</ports>

This operation does not return a response body.

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page


loading table of contents...