diff --git a/v2.0/ch_neutron_api_extensions.xml b/v2.0/ch_neutron_api_extensions.xml index 0b153ee..4e5400c 100644 --- a/v2.0/ch_neutron_api_extensions.xml +++ b/v2.0/ch_neutron_api_extensions.xml @@ -58,6 +58,7 @@ the source code tree. + diff --git a/v2.0/section_neutron-multi-provider-ext.xml b/v2.0/section_neutron-multi-provider-ext.xml new file mode 100644 index 0000000..37f7ff9 --- /dev/null +++ b/v2.0/section_neutron-multi-provider-ext.xml @@ -0,0 +1,22 @@ + + +
+ Network API operations with multiple provider + extension + Set and retrieve the multiple provider networks extension + attributes for network objects. + + + + + + + + +
diff --git a/v2.0/section_neutron-provider-ext.xml b/v2.0/section_neutron-provider-ext.xml index c96fd35..30d267b 100644 --- a/v2.0/section_neutron-provider-ext.xml +++ b/v2.0/section_neutron-provider-ext.xml @@ -1,39 +1,5 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - - - - '> - - - - - - - - - '> - +
provider prefix, which specify these attributes. -
Concepts The provider networks extension is an attribute extension which adds the following set of attributes to the network resource: - - - - - provider:network_type - - Specifies the nature of the physical network - mapped to this network resource. Examples are - flat, - vlan, or - gre. - - - - provider:physical_network - - Identifies the physical network on top of - which this network object is being - implemented. The OpenStack Networking API does - not expose any facility for retrieving the - list of available physical networks. As an - example, in the Open vSwitch plug-in this is a - symbolic name which is then mapped to specific - bridges on each compute host through the Open - vSwitch plug-in configuration file. - - - - provider:segmentation_id - - Identifies an isolated segment on the physical - network; the nature of the segment depends on - the segmentation model defined by - network_type. For - instance, if network_type - is vlan, then this is a - vlan identifier; - otherwise, if network_type - is gre, then this will be a - gre key. - - - + + + + provider:network_type - Specifies + the nature of the physical network mapped to this + network resource. Examples are + flat, + vlan, or + gre. + + + + provider:physical_network - + Identifies the physical network on top of which + this network object is being implemented. The + OpenStack Networking API does not expose any + facility for retrieving the list of available + physical networks. As an example, in the Open + vSwitch plug-in this is a symbolic name which is + then mapped to specific bridges on each compute + host through the Open vSwitch plug-in + configuration file. + + + + provider:segmentation_id - + Identifies an isolated segment on the physical + network; the nature of the segment depends on the + segmentation model defined by + network_type. For instance, + if network_type is + vlan, then this is a + vlan identifier; otherwise, + if network_type is + gre, then this will be a + gre key. + + The actual semantics of these attributes depend on the technology back end of the particular plug-in. See the plug-in documentation and the OpenStack Cloud @@ -117,212 +80,22 @@ implies the user submitting the request is not authorized to view or manipulate provider network attributes.
-
- Network API operations with provider network - extension - This section discusses operations for setting and - retrieving the provider networks extension attributes for + Network API operations with provider extension + Set and retrieve the provider extension attributes for network objects. - -
- List Networks - - - - - - - - Verb - URI - Description - - - - - &GET; - /networks - Returns a list of networks with their - provider networks attributes. - - - - - Normal Response Code: 200 OK - Error Response Codes: 401 Unauthorized - This operation returns, for each network, its - provider network attributes as well as all the - attributes normally returned by the list networks - operation. Provider networks - attribute are returned only if the user is authorized - to view them. - - List Networks with provider attributes: JSON - Response - - - - List Networks with provider attributes: XML - Response - - -
-
- Show Network - - - - - - - - Verb - URI - Description - - - - - &GET; - /networks/network_id - Returns details about a specific - network, including provider networks - attributes. - - - - - Normal Response Code: 200 OK - Error Response Code: 401 Unauthorized, 404 Not - Found - When the provider networks extension is enabled, and - the user submitting the request is authorized to see - provider networks mapping, this operation returns, for - the network specified in the request URI, its provider - network attributes, as well as all the attributes - normally retuned by the show networks - operation. - - Show network with provider attributes: JSON - Response - - - - Show network with provider attributes: XML - Response - - -
-
- Create Network - - - - - - - - Verb - URI - Description - - - - - &POST; - /networks - Creates a new network and explicitly - specify attributes with the underlying - infrastructure using the provider - network extension attributes. - - - - - Normal Response Code: 200 OK - Error Response Code: 400 Bad Request, 401 - Unauthorized, 403 Forbidden - When the provider networks extension is enabled, and - the user submitting the request is authorized to set - provider networks mapping, this operation allows for - specifying how a new network should be mapped on the - underlying network infrastructure. - If the user submitting the request is not allowed to - set provider networks attributes, a 403 Forbidden - response will be returned. - As stated earlier in this chapter, the semantics of - the various provider networks attribute vary with the - particular plug-in employed. The following example - shows how to create a network mapped to a specific - vlan tag (the example refers to an OpenStack - Networking deployment which uses the Open vSwitch - plug-in). - - Create Network with provider attributes: JSON - Request - - - - Create Network with provider attributes: XML - Request - - -
-
- Update Network - - - - - - - Verb - URI - Description - - - - - &PUT; - /networks/network_id - Updates a network, including its mapping - with the underlying infrastructure using - the provider network extension - attributes. - - - - Normal Response Code: 200 OK - Error Response Code: 400 Bad Request, 401 - Unauthorized, 404 Not Found, 403 Forbidden - When the provider networks extension is enabled, and - the user submitting the request is authorized to see - provider networks mapping, this operation allows for - specifying how an existing network should be mapped on - the underlying network infrastructure. - If the user submitting the request is not allowed to - set provider networks attributes, a 403 Forbidden - response will be returned. - As stated earlier in this chapter, the semantics of - the various provider networks attribute vary with the - particular plug-in employed. The following example - shows how to update a network in order to map it to a - flat network (such as, no vlan tag); the example - refers to an OpenStack Networking deployment that uses - the Open vSwitch plug-in. - - Update provider attributes for a network: JSON - Request - - - - Update provider attributes for a network: XML - Request - - -
+ + + + + + + + + + +