From 304305061ddb0c6377b4d3f348b821c4b0aa112e Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Sun, 29 Jun 2014 09:34:13 -0500 Subject: [PATCH] Add back vnic_type extended attribute Was accidentally removed at some point by me Change-Id: I70650c8675817059c472d17c0963c6498aeb383a Author: diane fleming --- v2.0/neutron-api-guide.xml | 13 +- v2.0/section_neutron-ext-binding-ports.xml | 489 ++++----------------- 2 files changed, 104 insertions(+), 398 deletions(-) diff --git a/v2.0/neutron-api-guide.xml b/v2.0/neutron-api-guide.xml index 05c10d9..39add92 100644 --- a/v2.0/neutron-api-guide.xml +++ b/v2.0/neutron-api-guide.xml @@ -49,12 +49,23 @@ + + 2014-06-29 + + + + Added + binding:vnic_type. + + + + 2014-04-29 - Updated + Changed binding:capabilities to binding:vif_details. diff --git a/v2.0/section_neutron-ext-binding-ports.xml b/v2.0/section_neutron-ext-binding-ports.xml index 32a6e89..da6fae8 100644 --- a/v2.0/section_neutron-ext-binding-ports.xml +++ b/v2.0/section_neutron-ext-binding-ports.xml @@ -1,54 +1,29 @@ - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - - - - '> - - - - - - - - - '> - + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + ]>
- The <literal>binding</literal> Extended Attributes for - Ports + Ports binding extended attributes (ports) Use the &APIv2; with the binding extended attributes to get information about, create, and update port objects. The binding-prefixed extended attributes for ports are: - + @@ -62,36 +37,60 @@ - - + + + + + + + + + + + @@ -101,366 +100,62 @@ + binding:vif_details + + + + + + + + + - - - - - - - + + + + + + - - - - - - - - - -
binding Extended Attributes - for PortsPorts binding extended attributes
Type Required CRUD - - - + + C. Use the attribute in create operations. - - - + + R. This attribute is returned in response to show and list operations. - - - + + U. You can update the value of this attribute. - - - + + D. You can delete the value of this attribute. - - + + Default ValueValidation ConstraintsDefault valueValidation constraints Notes
binding:vnic_typeStringN/ACRUnormal(normal, direct, macvtap)The vnic type to be bound on the neutron + port. + In &POST; and &PUT; operations, specify a + value of normal (virtual + nic), direct (pci + passthrough), or macvtap + (virtual interface with a tap-like software + interface). These values support SR-IOV PCI + passthrough networking. The ML2 plug-in + supports the + vnic_type. + In &GET; operations, the + binding:vnic_type + extended attribute is visible to only port + owners and administrative users. +
binding:vif_type StringN/A Read-only. The vif type for the specified port. + Visible to only administrative users.
- binding:host_idlist(dict)N/ARNoneN/ARead-only. A dictionary that enables the + application to pass information about + functions that &APIv2; provides. Specify the + following value: port_filter : + Boolean to define whether &APIv2; + provides port filtering features such as + security group and anti-MAC/IP + spoofing. + Visible to only administrative + users.
binding:host_id uuid-str N/A CRU None N/A The ID of the host where the port is - allocated. In some cases different + allocated. In some cases, different implementations can run on different hosts. + Visible to only administrative users.
- binding:profilelist(dict)N/ACRUNoneN/AA dictionary that enables the application - running on the specified host to pass and - receive vif port-specific information to the - plug-in. + binding:profilelist(dict)N/ACRUNoneN/AA dictionary that enables the application to + pass information about functions that the + Networking API provides. To enable or disable + port filtering features such as security group + and anti-MAC/IP spoofing, specify + port_filter: True or + port_filter: False. + Visible to only administrative users.
- binding:capabilitieslist(dict)N/ARNoneN/ARead-only. A dictionary that enables the - application to pass information about - functions that &APIv2; provides. Specify the - following value: port_filter : Boolean to - define whether &APIv2; provides port filtering - features such as security group and - anti-MAC/IP spoofing.
-
- List Ports - - - - - - - Verb - URI - Description - - - - - &GET; - /ports - Lists ports to which the tenant has access. - The binding extended - attributes are visible to only administrative - users. - - - - Normal Response Code: 200 - - Error Response Codes: Unauthorized - (401) - This operation lists ports to which the tenant has - access. - This operation does not require a request body. - This operation returns a response body. - In addition to any other fields returned in a list ports - response, the following - binding-prefixed fields are visible - to administrative users: - - - - Field - Description - - - - - binding:vif_type - - Read-only. The vif type for the - specified port. - - - - - binding:host_id - The ID of the host where the port is - allocated. In some cases different - implementations can run on different - hosts. - - - - - binding:profile - A dictionary that enables the - application running on the specified host - to pass and receive vif port-specific - information to the plug-in. - - - - - binding:capabilities - Read-only. A dictionary that enables the - application to pass information about - functions that &APIv2; provides. Specify - the following value: port_filter : Boolean - to define whether &APIv2; provides port - filtering features such as security group - and anti-MAC/IP spoofing. - - - - -
- -
- Show Port - - - - - - - Verb - URI - Description - - - - - &GET; - /ports/port-id - Shows information for a specified port. The - binding extended - attributes are visible to only administrative - users. - - - - Normal Response Code: 200 - - Error Response Codes: Unauthorized - (401), Not Found - (404) - This operation returns information for the port - specified in the request URI. - This operation does not require a request body. - This operation returns a response body. - In addition to any fields returned in a show port - details response, the following - binding-prefixed extended - attributes are visible to administrative users: - - - - Field - Description - - - - - binding:vif_type - - Read-only. The vif type for the - specified port. - - - - - binding:host_id - The ID of the host where the port is - allocated. In some cases different - implementations can run on different - hosts. - - - - - binding:profile - A dictionary that enables the - application running on the specified host - to pass and receive vif port-specific - information to the plug-in. - - - - - binding:capabilities - Read-only. A dictionary that enables the - application to pass information about - functions that &APIv2; provides. Specify - the following value: port_filter : Boolean - to define whether &APIv2; provides port - filtering features such as security group - and anti-MAC/IP spoofing. - - - - -
- -
- Create Port - - - - - - - Verb - URI - Description - - - - - &POST; - /ports - Creates a port on a specified network. Only - administrative users can add the - binding extended - attributes. - - - - Normal Response Code: 201 - - Error Response Codes: Bad Request - (400), Unauthorized - (401), Forbidden - (403), Not Found - (404), Conflict - (409), MAC generation failure - (503) - This operation creates an OpenStack Networking port. You - must specify the network where the port is to created on - the network_id attribute in the - request body. - This operation requires a request body. - This operation returns a response body. - In addition to any attributes that can be set in a - create port operation, administrative users can also set - the following binding-prefixed - extended attributes: - - - - Field - Description - - - - - - binding:host_id - The ID of the host where the port is - allocated. In some cases different - implementations can run on different - hosts. - - - - - binding:profile - A dictionary that enables the - application running on the specified host - to pass and receive vif port-specific - information to the plug-in. - - - - -
-
- Update Port - - - - - - - Verb - URI - Description - - - - - &PUT; - /ports/port-id - Updates a specified port. Only administrative - users can update the - binding extended - attributes. - - - - Normal Response Code: 200 - - Error Response Codes: Bad Request - (400), Unauthorized - (401), Forbidden - (403), Not Found - (404), Conflict - (409) - Use this operation to update information for a - port. - This operation requires a request body. - This operation returns a response body. - In addition to any attributes that can be updated in an - update port operation, administrative users can also - update the following - binding-prefixed extended - attributes: - - - - Field - Description - - - - - - binding:host_id - The ID of the host where the port is - allocated. In some cases different - implementations can run on different - hosts. - - - - - binding:profile - A dictionary that enables the - application running on the specified host - to pass and receive vif port-specific - information to the plug-in. - - - - -
+