diff --git a/v2.0/ch_neutron_api_extensions.xml b/v2.0/ch_neutron_api_extensions.xml index 4e5400c..119540b 100644 --- a/v2.0/ch_neutron_api_extensions.xml +++ b/v2.0/ch_neutron_api_extensions.xml @@ -34,28 +34,27 @@ xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="API_extensions"> API Extensions - The API extensions augment the core API. An API extension - extends one or more of the following components of the core - API: + An API extension extends one or more of the following + components of the core API: - Resources. An extension defines new object + Resources. An extension creates object classes. - Attributes. An extended attribute defines a new + Attributes. An extended attribute creates an attribute on existing resources. Prefixed by the extension name. - Actions. An extended action defines a new operation - on an existing resource. + Actions. An extended action creates an operation on + an existing resource. Generic API extensions are not plug-in-specific. For - information about plug-in-specific extensions that are shipped - with OpenStack Networking, see the extension documentation in - the source code tree. + information about plug-in-specific extensions that ship with + OpenStack Networking, see the extension documentation in the + source code tree. diff --git a/v2.0/neutron-api-guide.xml b/v2.0/neutron-api-guide.xml index 2d3b799..633bb8b 100644 --- a/v2.0/neutron-api-guide.xml +++ b/v2.0/neutron-api-guide.xml @@ -43,13 +43,12 @@ - 2011 - 2012 - 2013 + 2011-2014 OpenStack Foundation API v2.0 - OpenStack Networking (neutron) API v2.0 + OpenStack Networking (neutron) API + v2.0 @@ -63,6 +62,19 @@ + + 2014-04-29 + + + + Updated + binding:capabilities + to + binding:vif_details. + + + + 2013-12-20 @@ -98,8 +110,7 @@ Updated the title of the book to Reference from Developer - Guide for consistency. - + Guide for consistency. @@ -143,5 +154,5 @@ - + diff --git a/v2.0/section_neutron_binding_ext_ports.xml b/v2.0/section_neutron_binding_ext_ports.xml index 91f4939..23fe99e 100644 --- a/v2.0/section_neutron_binding_ext_ports.xml +++ b/v2.0/section_neutron_binding_ext_ports.xml @@ -132,21 +132,22 @@ - - binding:capabilities + binding:vif_details list(dict) - N/A R None - N/A - Read-only. A dictionary that enables the + None + + 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. + functions that Networking API v2.0 provides. + Specify the following value: + port_filter : Boolean + to define whether Networking API v2.0 provides + port filtering features, such as security + group and anti-MAC/IP spoofing. + binding:vnic_type @@ -154,358 +155,28 @@ N/A CRU normal - (normal, - direct, - macvtap) - The vnic type to be bound on the neutron port. - To support SR-IOV PCI passthrough networking, you can request that the neutron port - be realized as normal (virtual nic), direct (pci passthrough), or - macvtap (virtual interface with a tap-like software interface). - The ML2 plug-in supports the vnic_type. + (normal, direct, macvtap) + The VNIC type to be bound on the neutron + port. To support SR-IOV PCI passthrough + networking, you can request that the neutron + port be realized as normal (virtual NIC), + direct (pci passthrough), or macvtap (virtual + interface with a tap-like software interface). + The ML2 plug-in supports the + vnic_type. - -
- 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. The binding:vnic_type extended attribute - is visible to only port owners and 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 the list - port 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. - - - - binding:vnic_type - The vnic type to be bound on the neutron port. - Valid values are normal, direct, or macvtap. - - - - -
- -
- 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. The binding:vnic_type extended attribute - is visible to only port owners or 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 the show port - 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. - - - - - binding:vnic_type - The requested vnic type to be bound on neutron - port (can be either normal, direct or macvtap). - - - - -
- -
- 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. - - - - - binding:vnic_type - The vnic type to be bound on the neutron port. - Valid values are normal, direct, or macvtap. - - - - -
-
- Update Port - - - - - - - Verb - URI - Description - - - - - &PUT; - /ports/port-id - Updates a specified port. Only administrative users can update the - binding extended attributes. The - binding:vnic_type extended attribute is visible to only port owners or - administrative users. - - - - 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 the - 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. - - - - - binding:vnic_type - The vnic type to be bound on the neutron port. - Valid values are normal, direct, or macvtap. - - - - -
+ + + + + + + + + + diff --git a/v2.0/section_neutron_list-extensions.xml b/v2.0/section_neutron_list-extensions.xml index c0390c6..3ceb8f9 100644 --- a/v2.0/section_neutron_list-extensions.xml +++ b/v2.0/section_neutron_list-extensions.xml @@ -33,7 +33,7 @@ xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="retrieve_extensions"> - List Available Extensions + List available extensions You can list available extensions through the /v2.0/extensions URI.