diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 164abc03f..b4b0e9be2 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -145,17 +145,11 @@ pool_id-request: in: path required: truee type: string -port_id: +port_id-path: description: | - The UUID of the port. + The ID of the port. in: path - required: false - type: string -port_id_3: - description: | - The UUID of the port. - in: path - required: false + required: true type: string profile_id: description: | @@ -516,18 +510,30 @@ alias: type: string allowed_address_pairs: description: | - A set of zero or more allowed address pairs. An - address pair contains an IP address and MAC address. - in: body - required: false - type: array -allowed_address_pairs_1: - description: | - A set of zero or more allowed address pairs. An - address pair consists of an IP address and MAC address. + A set of zero or more allowed address pairs. + An address pair consists of an IP address range and MAC address + with the format of + ``{"ip_address": "", "mac_address": ""}``. + A server connected to the port can send a packet with source address + which matches one of the specified allowed address pairs. in: body required: true type: array +allowed_address_pairs-request: + description: | + A set of zero or more allowed address pairs. + An address pair consists of an IP address range and MAC address + with the format of + ``{"ip_address": "", "mac_address": ""}``. + A server connected to the port can send a packet with source address + which matches one of the specified allowed address pairs. + The default is an empty list. + For each address pair, ``ip_address`` is required and IP address or + CIDR can be specified. ``mac_address`` is optional and if unspecified + the MAC address of the port is used as default. + in: body + required: false + type: array audited: description: | Each time that the firewall policy or its @@ -1039,32 +1045,34 @@ destination_port_1: type: string device_id: description: | - The UUID of the device that uses this port. For - example, a virtual server. - in: body - required: false - type: string -device_id_1: - description: | - The UUID of the device that uses this port. For - example, a virtual server. + The ID of the device that uses this port. + For example, a server instance or a logical router. in: body required: true type: string +device_id-request: + description: | + The ID of the device that uses this port. + For example, a server instance or a logical router. + in: body + required: false + type: string device_owner: description: | - The UUID of the entity that uses this port. For - example, a DHCP agent. - in: body - required: false - type: string -device_owner_1: - description: | - The UUID of the entity that uses this port. For - example, a DHCP agent. + The entity type that uses this port. + For example, ``compute:nova`` (server instance), ``network:dhcp`` + (DHCP agent) or ``network:router_interface`` (router interface). in: body required: true type: string +device_owner-request: + description: | + The entity type that uses this port. + For example, ``compute:nova`` (server instance), ``network:dhcp`` + (DHCP agent) or ``network:router_interface`` (router interface). + in: body + required: false + type: string direction: description: | Ingress or egress, which is the direction in @@ -1376,6 +1384,13 @@ extra_dhcp_opts: in: body required: true type: array +extra_dhcp_opts-request: + description: | + A set of zero or more extra DHCP option pairs. An + option pair consists of an option value and name. + in: body + required: false + type: array firewall: description: | A ``firewall`` object. @@ -1910,20 +1925,31 @@ firewalls_1: type: array fixed_ips: description: | - If you specify only a subnet UUID, OpenStack - Networking allocates an available IP from that subnet to the port. - If you specify both a subnet UUID and an IP address, OpenStack - Networking tries to allocate the address to the port. - in: body - required: false - type: array -fixed_ips_1: - description: | - The IP addresses for the port. Includes the IP - address and UUID of the subnet. + The IP addresses for the port. If the port has multiple IP addresses, + this field has multiple entries. Each entry consists of IP address + (``ip_address``) and the subnet ID from which the IP address + is assigned (``subnet_id``). in: body required: true type: array +fixed_ips-request: + description: | + The IP addresses for the port. + If you would like to assign multiple IP addresses for the port, + specify multiple entries in this field. + Each entry consists of IP address (``ip_address``) and the subnet ID + from which the IP address is assigned (``subnet_id``). + + * If you specify both a subnet ID and an IP address, OpenStack Networking + tries to allocate the IP address on that subnet to the port. + * If you specify only a subnet ID, OpenStack Networking allocates + an available IP from that subnet to the port. + * If you specify only an IP address, OpenStack Networking + tries to allocate the IP address if the address is a valid IP + for any of the subnets on the specified network. + in: body + required: false + type: array flavor: description: | A ``flavor`` object. @@ -2183,7 +2209,7 @@ http_method-request: type: string id: description: | - The UUID of the network. + The ID of the resource. in: body required: true type: string @@ -2631,15 +2657,23 @@ location: type: string mac_address: description: | - The MAC address of an allowed address pair. + The MAC address of the port. + in: body + required: true + type: string +mac_address-request: + description: | + The MAC address of the port. + If unspecified, a MAC address is automatically generated. in: body required: false type: string -mac_address_1: +mac_address-request-put: description: | - The MAC address. + The MAC address of the port. + By default, only administrative users can change this value. in: body - required: true + required: false type: string max_burst_kbps: description: | @@ -3291,30 +3325,6 @@ operating_status: in: body required: true type: string -opt_name: - description: | - The extra DHCP option name. - in: body - required: false - type: string -opt_name_1: - description: | - The extra DHCP option name. - in: body - required: true - type: string -opt_value: - description: | - The extra DHCP option value. - in: body - required: false - type: string -opt_value_1: - description: | - The extra DHCP option value. - in: body - required: true - type: string peer_address: description: | The peer gateway public IPv4 or IPv6 address or @@ -3459,6 +3469,18 @@ port: in: body required: true type: object +port-security_groups: + description: | + The IDs of security groups applied to the port. + in: body + required: true + type: array +port-security_groups-request: + description: | + The IDs of security groups applied to the port. + in: body + required: false + type: array port-status: description: | The port status. Values are ``ACTIVE``, ``DOWN``, @@ -3466,9 +3488,15 @@ port-status: in: body required: true type: string -port_id_1: +port_id: description: | - The UUID of the port. + The ID of the port. + in: body + required: true + type: string +port_id-request: + description: | + The ID of the port. in: body required: false type: string @@ -3526,6 +3554,19 @@ port_security_enabled: description: | The port security status. A valid value is enabled (``true``) or disabled (``false``). + If port security is enabled for the port, + security group rules and anti-spoofing rules are applied to + the traffic on the port. If disabled, no such rules are applied. + in: body + required: true + type: boolean +port_security_enabled-request: + description: | + The port security status. A valid value is + enabled (``true``) or disabled (``false``). + If port security is enabled for the port, + security group rules and anti-spoofing rules are applied to + the traffic on the port. If disabled, no such rules are applied. in: body required: false type: boolean diff --git a/api-ref/source/v2/port-binding.inc b/api-ref/source/v2/port-binding.inc index 24b1fd3cd..e582a9dca 100644 --- a/api-ref/source/v2/port-binding.inc +++ b/api-ref/source/v2/port-binding.inc @@ -24,7 +24,7 @@ Request .. rest_parameters:: parameters.yaml - - port_id: port_id + - port_id: port_id-path Response Example ---------------- @@ -48,7 +48,7 @@ Request .. rest_parameters:: parameters.yaml - - port_id: port_id + - port_id: port_id-path Request Example --------------- @@ -76,7 +76,7 @@ Request .. rest_parameters:: parameters.yaml - - port_id: port_id + - port_id: port_id-path List ports (port binding) ========================= diff --git a/api-ref/source/v2/ports.inc b/api-ref/source/v2/ports.inc index 38284e5a5..6fc241831 100644 --- a/api-ref/source/v2/ports.inc +++ b/api-ref/source/v2/ports.inc @@ -1,8 +1,4 @@ .. -*- rst -*- -.. needs:method_verification -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification ===== Ports @@ -17,45 +13,48 @@ Show port details Shows details for a port. +Use the ``fields`` query parameter to control which fields are +returned in the response body. For information, see `Filtering and +Column Selection `__. + Normal response codes: 200 -Error response codes: 404,401 +Error response codes: 401, 404 Request ------- .. rest_parameters:: parameters.yaml - - port_id: port_id + - port_id: port_id-path + - fields: fields Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - status: port-status - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - ip_address: ip_address - - extra_dhcp_opts: extra_dhcp_opts - - opt_name: opt_name - - updated_at: updated_at - - id: id - port: port - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - port_security_enabled: port_security_enabled - - fixed_ips: fixed_ips + - admin_state_up: admin_state_up + - allowed_address_pairs: allowed_address_pairs - created_at: created_at - - security_groups: security_groups - - device_id: device_id - description: description + - device_id: device_id + - device_owner: device_owner + - extra_dhcp_opts: extra_dhcp_opts + - fixed_ips: fixed_ips + - id: id + - mac_address: mac_address + - name: name + - network_id: network_id + - port_security_enabled: port_security_enabled + - project_id: project_id + - security_groups: port-security_groups + - status: port-status + - tenant_id: project_id + - updated_at: updated_at Response Example ---------------- @@ -89,31 +88,26 @@ removed from the port. Normal response codes: 200 -Error response codes: 404,403,401,400,409 +Error response codes: 400, 401, 403, 404, 409 Request ------- .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - fixed_ips: fixed_ips - - opt_name: opt_name - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - ip_address: ip_address + - port_id: port_id-path - port: port - - security_groups: security_groups - - device_id: device_id - - port_id: port_id + - admin_state_up: admin_state_up-request + - allowed_address_pairs: allowed_address_pairs-request - description: description-request + - device_id: device_id-request + - device_owner: device_owner-request + - extra_dhcp_opts: extra_dhcp_opts-request + - fixed_ips: fixed_ips-request + - mac_address: mac_address-request-put + - name: name-request + - port_security_enabled: port_security_enabled-request + - security_groups: port-security_groups-request Request Example --------------- @@ -126,29 +120,25 @@ Response Parameters .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - status: port-status - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - ip_address: ip_address - - extra_dhcp_opts: extra_dhcp_opts - - opt_name: opt_name - - updated_at: updated_at - - id: id - port: port - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - port_security_enabled: port_security_enabled - - fixed_ips: fixed_ips + - admin_state_up: admin_state_up + - allowed_address_pairs: allowed_address_pairs - created_at: created_at - - security_groups: security_groups - - device_id: device_id - description: description + - device_id: device_id + - device_owner: device_owner + - extra_dhcp_opts: extra_dhcp_opts + - fixed_ips: fixed_ips + - id: id + - mac_address: mac_address + - name: name + - network_id: network_id + - port_security_enabled: port_security_enabled + - project_id: project_id + - security_groups: port-security_groups + - status: port-status + - tenant_id: project_id + - updated_at: updated_at Response Example ---------------- @@ -166,14 +156,21 @@ Deletes a port. Any IP addresses that are associated with the port are returned to the respective subnets allocation pools. -Error response codes: 404,403,204,401 +Normal response codes: 204 + +Error response codes: 401, 403, 404 Request ------- .. rest_parameters:: parameters.yaml - - port_id: port_id + - port_id: port_id-path + +Response +-------- + +There is no body content for the response of a successful DELETE request. List ports ========== @@ -184,11 +181,13 @@ Lists ports to which the user has access. Default policy settings return only those ports that are owned by the project of the user who submits the request, unless the request is submitted -by a user with administrative rights. Users can control which -attributes are returned by using the fields query parameter. You -can use query parameters to filter the response.For information, -see `Filtering and Column Selection `_. +by a user with administrative rights. + +Use the ``fields`` query parameter to control which fields are +returned in the response body. Additionally, you can filter results +by using query string parameters. For information, see `Filtering +and Column Selection `__. Normal response codes: 200 @@ -197,34 +196,34 @@ Error response codes: 401 Request ------- +.. rest_parameters:: parameters.yaml + + - fields: fields + Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - status: port-status - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - ip_address: ip_address - - extra_dhcp_opts: extra_dhcp_opts - - opt_name: opt_name - - updated_at: updated_at - - id: id - ports: ports - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - port_security_enabled: port_security_enabled - - fixed_ips: fixed_ips + - admin_state_up: admin_state_up + - allowed_address_pairs: allowed_address_pairs - created_at: created_at - - security_groups: security_groups - - device_id: device_id - description: description + - device_id: device_id + - device_owner: device_owner + - extra_dhcp_opts: extra_dhcp_opts + - fixed_ips: fixed_ips + - id: id + - mac_address: mac_address + - name: name + - network_id: network_id + - port_security_enabled: port_security_enabled + - project_id: project_id + - security_groups: port-security_groups + - status: port-status + - tenant_id: project_id + - updated_at: updated_at Response Example ---------------- @@ -242,30 +241,30 @@ Creates a port on a network. To define the network in which to create the port, specify the ``network_id`` attribute in the request body. -Error response codes: 201,404,403,401,400,503 +Normal response codes: 201 + +Error response codes: 400, 401, 403, 404 Request ------- .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - fixed_ips: fixed_ips - - opt_name: opt_name - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - ip_address: ip_address - port: port - - security_groups: security_groups - - device_id: device_id + - admin_state_up: admin_state_up-request + - allowed_address_pairs: allowed_address_pairs-request - description: description-request + - device_id: device_id-request + - device_owner: device_owner-request + - extra_dhcp_opts: extra_dhcp_opts-request + - fixed_ips: fixed_ips-request + - mac_address: mac_address-request + - name: name-request + - network_id: network_id + - port_security_enabled: port_security_enabled-request + - project_id: project_id-request + - security_groups: port-security_groups-request + - tenant_id: project_id-request Request Example --------------- @@ -278,29 +277,25 @@ Response Parameters .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - status: port-status - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - ip_address: ip_address - - extra_dhcp_opts: extra_dhcp_opts - - opt_name: opt_name - - updated_at: updated_at - - id: id - port: port - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - port_security_enabled: port_security_enabled - - fixed_ips: fixed_ips + - admin_state_up: admin_state_up + - allowed_address_pairs: allowed_address_pairs - created_at: created_at - - security_groups: security_groups - - device_id: device_id - description: description + - device_id: device_id + - device_owner: device_owner + - extra_dhcp_opts: extra_dhcp_opts + - fixed_ips: fixed_ips + - id: id + - mac_address: mac_address + - name: name + - network_id: network_id + - port_security_enabled: port_security_enabled + - project_id: project_id + - security_groups: port-security_groups + - status: port-status + - tenant_id: project_id + - updated_at: updated_at Response Example ---------------- @@ -317,30 +312,30 @@ Creates multiple ports in a single request. Specify a list of ports in the reque Guarantees the atomic completion of the bulk operation. -Error response codes: 201,404,403,401,400,503,409 +Normal response codes: 201 + +Error response codes: 400, 401, 403, 404, 409 Request ------- .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - fixed_ips: fixed_ips - - opt_name: opt_name - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - ip_address: ip_address - ports: ports - - security_groups: security_groups - - device_id: device_id + - admin_state_up: admin_state_up-request + - allowed_address_pairs: allowed_address_pairs-request - description: description-request + - device_id: device_id-request + - device_owner: device_owner-request + - extra_dhcp_opts: extra_dhcp_opts-request + - fixed_ips: fixed_ips-request + - mac_address: mac_address-request + - name: name-request + - network_id: network_id + - port_security_enabled: port_security_enabled-request + - project_id: project_id-request + - security_groups: port-security_groups-request + - tenant_id: project_id-request Request Example --------------- @@ -353,29 +348,25 @@ Response Parameters .. rest_parameters:: parameters.yaml - - opt_value: opt_value - - status: port-status - - name: name - - allowed_address_pairs: allowed_address_pairs - - admin_state_up: admin_state_up - - network_id: network_id - - ip_address: ip_address - - extra_dhcp_opts: extra_dhcp_opts - - opt_name: opt_name - - updated_at: updated_at - - id: id - ports: ports - - subnet_id: subnet_id - - device_owner: device_owner - - tenant_id: project_id - - project_id: project_id - - mac_address: mac_address - - port_security_enabled: port_security_enabled - - fixed_ips: fixed_ips + - admin_state_up: admin_state_up + - allowed_address_pairs: allowed_address_pairs - created_at: created_at - - security_groups: security_groups - - device_id: device_id - description: description + - device_id: device_id + - device_owner: device_owner + - extra_dhcp_opts: extra_dhcp_opts + - fixed_ips: fixed_ips + - id: id + - mac_address: mac_address + - name: name + - network_id: network_id + - port_security_enabled: port_security_enabled + - project_id: project_id + - security_groups: port-security_groups + - status: port-status + - tenant_id: project_id + - updated_at: updated_at Response Example ---------------- diff --git a/api-ref/source/v2/samples/ports/port-bind-create-update-response.json b/api-ref/source/v2/samples/ports/port-bind-create-update-response.json index 7f4a44495..47bcb053e 100644 --- a/api-ref/source/v2/samples/ports/port-bind-create-update-response.json +++ b/api-ref/source/v2/samples/ports/port-bind-create-update-response.json @@ -1,30 +1,30 @@ { "port": { - "status": "DOWN", - "binding:host_id": "", - "name": "private-port", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", - "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", - "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", - "binding:vif_details": {}, - "binding:vnic_type": "normal", - "binding:vif_type": "unbound", - "device_owner": "", - "mac_address": "fa:16:3e:c9:cb:f0", + "allowed_address_pairs": [], + "binding:host_id": "", "binding:profile": {}, + "binding:vif_details": {}, + "binding:vif_type": "unbound", + "binding:vnic_type": "normal", + "description": "", + "device_id": "", + "device_owner": "", "fixed_ips": [ { - "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2", - "ip_address": "10.0.0.2" + "ip_address": "10.0.0.2", + "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2" } ], "id": "65c0ee9f-d634-4522-8954-51021b570b0d", + "mac_address": "fa:16:3e:c9:cb:f0", + "name": "private-port", + "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", + "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", "security_groups": [ "f0ac4394-7e4a-4409-9701-ba8be283dbc3" ], - "device_id": "", - "description": "" + "status": "DOWN", + "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa" } } diff --git a/api-ref/source/v2/samples/ports/port-bind-show-response.json b/api-ref/source/v2/samples/ports/port-bind-show-response.json index 2c8d4ce0e..df7b58df9 100644 --- a/api-ref/source/v2/samples/ports/port-bind-show-response.json +++ b/api-ref/source/v2/samples/ports/port-bind-show-response.json @@ -1,33 +1,33 @@ { "port": { - "status": "ACTIVE", - "binding:host_id": "devstack", - "name": "", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", - "project_id": "7e02058126cc4950b75f9970368ba177", - "tenant_id": "7e02058126cc4950b75f9970368ba177", - "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:host_id": "devstack", + "binding:profile": {}, "binding:vif_details": { - "port_filter": true, - "ovs_hybrid_plug": true + "ovs_hybrid_plug": true, + "port_filter": true }, "binding:vif_type": "ovs", - "device_owner": "network:router_interface", - "port_security_enabled": false, - "mac_address": "fa:16:3e:23:fd:d7", - "binding:profile": {}, "binding:vnic_type": "normal", + "description": "", + "device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e", + "device_owner": "network:router_interface", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2", - "ip_address": "10.0.0.1" + "ip_address": "10.0.0.1", + "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2" } ], "id": "46d4bfb9-b26e-41f3-bd2e-e6dcc1ccedb2", + "mac_address": "fa:16:3e:23:fd:d7", + "name": "", + "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", + "port_security_enabled": false, + "project_id": "7e02058126cc4950b75f9970368ba177", "security_groups": [], - "device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e", - "description": "" + "status": "ACTIVE", + "tenant_id": "7e02058126cc4950b75f9970368ba177" } } diff --git a/api-ref/source/v2/samples/ports/port-create-request.json b/api-ref/source/v2/samples/ports/port-create-request.json index 2aabb12d0..7557c5624 100644 --- a/api-ref/source/v2/samples/ports/port-create-request.json +++ b/api-ref/source/v2/samples/ports/port-create-request.json @@ -1,7 +1,7 @@ { "port": { - "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", + "admin_state_up": true, "name": "private-port", - "admin_state_up": true + "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7" } } diff --git a/api-ref/source/v2/samples/ports/port-create-response.json b/api-ref/source/v2/samples/ports/port-create-response.json index c2c4d4a30..3076cfb29 100644 --- a/api-ref/source/v2/samples/ports/port-create-response.json +++ b/api-ref/source/v2/samples/ports/port-create-response.json @@ -1,25 +1,29 @@ { "port": { - "status": "DOWN", - "name": "private-port", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", - "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", - "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", + "allowed_address_pairs": [], + "created_at": "2016-03-08T20:19:41", + "description": "", + "device_id": "", "device_owner": "", - "mac_address": "fa:16:3e:c9:cb:f0", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2", - "ip_address": "10.0.0.2" + "ip_address": "10.0.0.2", + "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2" } ], "id": "65c0ee9f-d634-4522-8954-51021b570b0d", + "mac_address": "fa:16:3e:c9:cb:f0", + "name": "private-port", + "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", + "port_security_enabled": true, + "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", "security_groups": [ "f0ac4394-7e4a-4409-9701-ba8be283dbc3" ], - "device_id": "", - "description": "" + "status": "DOWN", + "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", + "updated_at": "2016-03-08T20:19:41" } } diff --git a/api-ref/source/v2/samples/ports/port-show-response.json b/api-ref/source/v2/samples/ports/port-show-response.json index b879427f5..f95996f00 100644 --- a/api-ref/source/v2/samples/ports/port-show-response.json +++ b/api-ref/source/v2/samples/ports/port-show-response.json @@ -1,26 +1,27 @@ { "port": { - "status": "ACTIVE", - "name": "", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", - "project_id": "7e02058126cc4950b75f9970368ba177", - "tenant_id": "7e02058126cc4950b75f9970368ba177", + "allowed_address_pairs": [], "created_at": "2016-03-08T20:19:41", - "extra_dhcp_opts": [], + "description": "", + "device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e", "device_owner": "network:router_interface", - "mac_address": "fa:16:3e:23:fd:d7", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2", - "ip_address": "10.0.0.1" + "ip_address": "10.0.0.1", + "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2" } ], "id": "46d4bfb9-b26e-41f3-bd2e-e6dcc1ccedb2", - "updated_at": "2016-03-08T20:19:41", + "mac_address": "fa:16:3e:23:fd:d7", + "name": "", + "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", + "port_security_enabled": false, + "project_id": "7e02058126cc4950b75f9970368ba177", "security_groups": [], - "device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e", - "description": "" + "status": "ACTIVE", + "tenant_id": "7e02058126cc4950b75f9970368ba177", + "updated_at": "2016-03-08T20:19:41" } } diff --git a/api-ref/source/v2/samples/ports/port-update-request.json b/api-ref/source/v2/samples/ports/port-update-request.json index f4397ae03..ea16fe28f 100644 --- a/api-ref/source/v2/samples/ports/port-update-request.json +++ b/api-ref/source/v2/samples/ports/port-update-request.json @@ -1,8 +1,9 @@ { "port": { - "name": "test-for-port-update", "admin_state_up": true, + "binding:host_id": "test_for_port_update_host", + "device_id": "d90a13da-be41-461f-9f99-1dbcf438fdf2", "device_owner": "compute:nova", - "binding:host_id": "test_for_port_update_host" + "name": "test-for-port-update" } } diff --git a/api-ref/source/v2/samples/ports/port-update-response.json b/api-ref/source/v2/samples/ports/port-update-response.json index 5cd31f592..61b98f96c 100644 --- a/api-ref/source/v2/samples/ports/port-update-response.json +++ b/api-ref/source/v2/samples/ports/port-update-response.json @@ -1,31 +1,31 @@ { "port": { - "status": "DOWN", - "binding:host_id": "test_for_port_update_host", + "admin_state_up": true, "allowed_address_pairs": [], - "extra_dhcp_opts": [], - "device_owner": "compute:nova", + "binding:host_id": "test_for_port_update_host", "binding:profile": {}, + "binding:vif_details": {}, + "binding:vif_type": "binding_failed", + "binding:vnic_type": "normal", + "description": "", + "device_id": "d90a13da-be41-461f-9f99-1dbcf438fdf2", + "device_owner": "compute:nova", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "898dec4a-74df-4193-985f-c76721bcc746", - "ip_address": "20.20.0.4" + "ip_address": "20.20.0.4", + "subnet_id": "898dec4a-74df-4193-985f-c76721bcc746" } ], "id": "43c831e0-19ce-4a76-9a49-57b57e69428b", + "mac_address": "fa:16:3e:11:11:5e", + "name": "test-for-port-update", + "network_id": "883fc383-5ea1-4c8b-8916-e1ddb0a9f365", + "project_id": "522eda8d23124b25bf03fe44f1986b74", "security_groups": [ "ce0179d6-8a94-4f7c-91c2-f3038e2acbd0" ], - "device_id": "", - "name": "test-for-port-update", - "admin_state_up": true, - "network_id": "883fc383-5ea1-4c8b-8916-e1ddb0a9f365", - "project_id": "522eda8d23124b25bf03fe44f1986b74", - "tenant_id": "522eda8d23124b25bf03fe44f1986b74", - "binding:vif_details": {}, - "binding:vnic_type": "normal", - "binding:vif_type": "binding_failed", - "mac_address": "fa:16:3e:11:11:5e", - "description": "" + "status": "DOWN", + "tenant_id": "522eda8d23124b25bf03fe44f1986b74" } } diff --git a/api-ref/source/v2/samples/ports/ports-bind-show-response.json b/api-ref/source/v2/samples/ports/ports-bind-show-response.json index b978c5c26..884350fde 100644 --- a/api-ref/source/v2/samples/ports/ports-bind-show-response.json +++ b/api-ref/source/v2/samples/ports/ports-bind-show-response.json @@ -1,66 +1,66 @@ { "ports": [ { - "status": "ACTIVE", - "binding:host_id": "devstack", - "name": "", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "70c1db1f-b701-45bd-96e0-a313ee3430b3", - "project_id": "", - "tenant_id": "", - "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:host_id": "devstack", + "binding:profile": {}, "binding:vif_details": { - "port_filter": true, - "ovs_hybrid_plug": true + "ovs_hybrid_plug": true, + "port_filter": true }, "binding:vif_type": "ovs", - "device_owner": "network:router_gateway", - "port_security_enabled": true, - "mac_address": "fa:16:3e:58:42:ed", - "binding:profile": {}, "binding:vnic_type": "normal", + "description": "", + "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", + "device_owner": "network:router_gateway", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "008ba151-0b8c-4a67-98b5-0d2b87666062", - "ip_address": "172.24.4.2" + "ip_address": "172.24.4.2", + "subnet_id": "008ba151-0b8c-4a67-98b5-0d2b87666062" } ], "id": "d80b1a3b-4fc1-49f3-952e-1e2ab7081d8b", + "mac_address": "fa:16:3e:58:42:ed", + "name": "", + "network_id": "70c1db1f-b701-45bd-96e0-a313ee3430b3", + "port_security_enabled": true, + "project_id": "", "security_groups": [], - "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", - "description": "" + "status": "ACTIVE", + "tenant_id": "" }, { - "status": "ACTIVE", - "binding:host_id": "devstack", - "name": "", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "f27aa545-cbdd-4907-b0c6-c9e8b039dcc2", - "project_id": "d397de8a63f341818f198abb0966f6f3", - "tenant_id": "d397de8a63f341818f198abb0966f6f3", - "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:host_id": "devstack", + "binding:profile": {}, "binding:vif_details": { - "port_filter": true, - "ovs_hybrid_plug": true + "ovs_hybrid_plug": true, + "port_filter": true }, "binding:vif_type": "ovs", - "device_owner": "network:router_interface", - "port_security_enabled": true, - "mac_address": "fa:16:3e:bb:3c:e4", - "binding:profile": {}, "binding:vnic_type": "normal", + "description": "", + "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", + "device_owner": "network:router_interface", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "288bf4a1-51ba-43b6-9d0a-520e9005db17", - "ip_address": "10.0.0.1" + "ip_address": "10.0.0.1", + "subnet_id": "288bf4a1-51ba-43b6-9d0a-520e9005db17" } ], "id": "f71a6703-d6de-4be1-a91a-a570ede1d159", + "mac_address": "fa:16:3e:bb:3c:e4", + "name": "", + "network_id": "f27aa545-cbdd-4907-b0c6-c9e8b039dcc2", + "port_security_enabled": true, + "project_id": "d397de8a63f341818f198abb0966f6f3", "security_groups": [], - "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", - "description": "" + "status": "ACTIVE", + "tenant_id": "d397de8a63f341818f198abb0966f6f3" } ] } diff --git a/api-ref/source/v2/samples/ports/ports-bulk-create-request.json b/api-ref/source/v2/samples/ports/ports-bulk-create-request.json index 1ded596cd..9e5e3411b 100644 --- a/api-ref/source/v2/samples/ports/ports-bulk-create-request.json +++ b/api-ref/source/v2/samples/ports/ports-bulk-create-request.json @@ -1,13 +1,13 @@ { "ports": [ { - "name": "sample_port_1", "admin_state_up": false, + "name": "sample_port_1", "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7" }, { - "name": "sample_port_2", "admin_state_up": false, + "name": "sample_port_2", "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7" } ] diff --git a/api-ref/source/v2/samples/ports/ports-bulk-create-response.json b/api-ref/source/v2/samples/ports/ports-bulk-create-response.json index 39d99783a..586a9ca67 100644 --- a/api-ref/source/v2/samples/ports/ports-bulk-create-response.json +++ b/api-ref/source/v2/samples/ports/ports-bulk-create-response.json @@ -1,50 +1,50 @@ { "ports": [ { - "status": "DOWN", - "name": "sample_port_1", - "allowed_address_pairs": [], "admin_state_up": false, - "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", - "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", - "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", + "allowed_address_pairs": [], + "description": "", + "device_id": "", "device_owner": "", - "mac_address": "fa:16:3e:48:b8:9f", "fixed_ips": [ { - "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2", - "ip_address": "10.0.0.5" + "ip_address": "10.0.0.5", + "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2" } ], "id": "94225baa-9d3f-4b93-bf12-b41e7ce49cdb", + "mac_address": "fa:16:3e:48:b8:9f", + "name": "sample_port_1", + "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", + "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", "security_groups": [ "f0ac4394-7e4a-4409-9701-ba8be283dbc3" ], - "device_id": "", - "description": "" + "status": "DOWN", + "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa" }, { - "status": "DOWN", - "name": "sample_port_2", - "allowed_address_pairs": [], "admin_state_up": false, - "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", - "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", - "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", + "allowed_address_pairs": [], + "description": "", + "device_id": "", "device_owner": "", - "mac_address": "fa:16:3e:f4:73:df", "fixed_ips": [ { - "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2", - "ip_address": "10.0.0.6" + "ip_address": "10.0.0.6", + "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2" } ], "id": "235b09e0-63c4-47f1-b221-66ba54c21760", + "mac_address": "fa:16:3e:f4:73:df", + "name": "sample_port_2", + "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7", + "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa", "security_groups": [ "f0ac4394-7e4a-4409-9701-ba8be283dbc3" ], - "device_id": "", - "description": "" + "status": "DOWN", + "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa" } ] } diff --git a/api-ref/source/v2/samples/ports/ports-list-response.json b/api-ref/source/v2/samples/ports/ports-list-response.json index ee10fe9f7..985c760d4 100644 --- a/api-ref/source/v2/samples/ports/ports-list-response.json +++ b/api-ref/source/v2/samples/ports/ports-list-response.json @@ -1,48 +1,48 @@ { "ports": [ { - "status": "ACTIVE", - "name": "", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "70c1db1f-b701-45bd-96e0-a313ee3430b3", - "project_id": "", - "tenant_id": "", - "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "description": "", + "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", "device_owner": "network:router_gateway", - "mac_address": "fa:16:3e:58:42:ed", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "008ba151-0b8c-4a67-98b5-0d2b87666062", - "ip_address": "172.24.4.2" + "ip_address": "172.24.4.2", + "subnet_id": "008ba151-0b8c-4a67-98b5-0d2b87666062" } ], "id": "d80b1a3b-4fc1-49f3-952e-1e2ab7081d8b", + "mac_address": "fa:16:3e:58:42:ed", + "name": "", + "network_id": "70c1db1f-b701-45bd-96e0-a313ee3430b3", + "project_id": "", "security_groups": [], - "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", - "description": "" + "status": "ACTIVE", + "tenant_id": "" }, { - "status": "ACTIVE", - "name": "", - "allowed_address_pairs": [], "admin_state_up": true, - "network_id": "f27aa545-cbdd-4907-b0c6-c9e8b039dcc2", - "project_id": "d397de8a63f341818f198abb0966f6f3", - "tenant_id": "d397de8a63f341818f198abb0966f6f3", - "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "description": "", + "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", "device_owner": "network:router_interface", - "mac_address": "fa:16:3e:bb:3c:e4", + "extra_dhcp_opts": [], "fixed_ips": [ { - "subnet_id": "288bf4a1-51ba-43b6-9d0a-520e9005db17", - "ip_address": "10.0.0.1" + "ip_address": "10.0.0.1", + "subnet_id": "288bf4a1-51ba-43b6-9d0a-520e9005db17" } ], "id": "f71a6703-d6de-4be1-a91a-a570ede1d159", + "mac_address": "fa:16:3e:bb:3c:e4", + "name": "", + "network_id": "f27aa545-cbdd-4907-b0c6-c9e8b039dcc2", + "project_id": "d397de8a63f341818f198abb0966f6f3", "security_groups": [], - "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824", - "description": "" + "status": "ACTIVE", + "tenant_id": "d397de8a63f341818f198abb0966f6f3" } ] } diff --git a/api-ref/source/v2/trunk-details.inc b/api-ref/source/v2/trunk-details.inc index 1a4439670..326b1a804 100644 --- a/api-ref/source/v2/trunk-details.inc +++ b/api-ref/source/v2/trunk-details.inc @@ -27,7 +27,7 @@ Request .. rest_parameters:: parameters.yaml - - port_id: port_id + - port_id: port_id-path Response Parameters -------------------