diff --git a/v2.0/ch_neutron_api_extensions.xml b/v2.0/ch_neutron_api_extensions.xml index 119540b..15c9c3d 100644 --- a/v2.0/ch_neutron_api_extensions.xml +++ b/v2.0/ch_neutron_api_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="API_extensions"> - API Extensions + API extensions An API extension extends one or more of the following components of the core API: @@ -55,21 +55,22 @@ 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/ch_neutron_api_operations.xml b/v2.0/ch_neutron_api_operations.xml index b5c7d1d..d922021 100644 --- a/v2.0/ch_neutron_api_operations.xml +++ b/v2.0/ch_neutron_api_operations.xml @@ -8,7 +8,7 @@ xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="API_Operations" role="api-reference"> - API Operations + API operations Provides virtual networking services among devices that are managed by the OpenStack Compute service. The Networking API v2.0 combines the API v1.1 functionality with some essential @@ -22,25 +22,36 @@ Networks List, show information for, create, update, and delete networks. - + />
Subnets List, show information for, create, update, and delete subnet resources. - + + + + + + + + + + + +
Ports List, show information for, create, update, and delete ports. - + />
diff --git a/v2.0/ch_neutron_general_info.xml b/v2.0/ch_neutron_general_info.xml index ce9fc27..4df005b 100644 --- a/v2.0/ch_neutron_general_info.xml +++ b/v2.0/ch_neutron_general_info.xml @@ -34,7 +34,7 @@ xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="General_API_Information-d1e436"> - General API Information + General API information The &APIv2; is a ReSTful HTTP service that uses all aspects of the HTTP protocol including methods, URIs, media types, response codes, and so on. Providers can use existing features @@ -48,7 +48,7 @@ Create clients so that these differences are accounted for.
- Authentication and Authorization + Authentication and authorization The &APIv2; uses the Keystone Identity Service as the default authentication @@ -70,31 +70,32 @@ different tenant. OpenStack Networking uses information received from Keystone to authorize user requests. OpenStack Networking - handles the following types of authorization policies: - - Operation-based - policies specify access - criteria for specific operations, possibly - with fine-grained control over specific - attributes. - - - Resource-based - policies access a specific - resource. Permissions might or might not be - granted depending on the permissions - configured for the resource. Currently - available for only the network - resource. - - + handles the following types of authorization + policies: + + + Operation-based + policies specify access criteria + for specific operations, possibly with + fine-grained control over specific + attributes. + + + Resource-based + policies access a specific + resource. Permissions might or might not be + granted depending on the permissions configured + for the resource. Currently available for only the + network resource. + + The actual authorization policies enforced in OpenStack Networking might vary from deployment to deployment.
-
- Request/Response Types +
+ Request and response types The &APIv2; supports the JSON data serialization format. The format for both the request and the response can be @@ -103,30 +104,30 @@ .json extension to the request URI. - JSON Request with Headers + JSON request with headers POST /v1.0/tenants/tenantX/networks HTTP/1.1 Host 127.0.0.1:9696 Content-Type application/json Accept application/json Content-Length 57 - + - JSON Response with Headers + JSON response with headers HTTP/1.1 201 Created Content-Type application/json Content-Length 204 - +
- Filtering and Column Selection + Filtering and column selection The &APIv2; supports filtering based on all top level attributes of a resource. Filters are applicable to all list requests. For example, the following request returns all networks named foobar: - GET /v2.0/networks?name=foobar + GET /v2.0/networks?name=foobar When you specify multiple filters, the &APIv2; returns only objects that meet all filtering criteria. The operation applies an AND condition among the @@ -148,11 +149,11 @@ Content-Length 204 For example, the following request returns only id and name for each network: - GET /v2.0/networks.json?fields=id&fields=name + GET /v2.0/networks.json?fields=id&fields=name
- Synchronous versus Asynchronous Plug-in - Behavior + Synchronous versus asynchronous plug-in + behavior The &APIv2; presents a logical model of network connectivity consisting of networks, ports, and subnets. It is up to the OpenStack Networking plug-in to @@ -179,7 +180,7 @@ Content-Length 204 the configuration of the resource.
- Bulk Create Operations + Bulk-create The &APIv2; enables you to create several objects of the same type in the same API request. Bulk create operations use exactly the same API syntax as single create @@ -195,9 +196,9 @@ Content-Length 204 OpenStack Networking might be deployed without support for bulk operations and when the client attempts a bulk create operation, a 400 - Bad Request error is + Bad request error is returned. - @@ -238,8 +239,8 @@ Content-Length 204 mechanism to tell user if pagination is supported by particular plug-in or enabled. - Network Collection, First Page: JSON - Request + Network collection, first page: JSON + request GET /v2.0/networks.json?limit=2 HTTP/1.1 Host: 127.0.0.1:9696 @@ -247,12 +248,12 @@ Content-Type: application/json Accept: application/json - Network Collection, First Page: JSON - Response - + Network collection, first page: JSON + response + - Network Collection, First Page: XML Request + Network collection, first page: XML request GET /v2.0/networks.xml?limit=2 HTTP/1.1 Host: 127.0.0.1:9696 @@ -261,13 +262,13 @@ Accept: application/xml - Network Collection, First Page: XML - Response - + Network collection, first page: XML + response + The last page won't show the "next" links - Network Collection, Last Page: JSON Request + Network collection, last page: JSON request GET /v2.0/networks.json?limit=2&marker=71c1e68c-171a-4aa2-aca5-50ea153a3718 HTTP/1.1 Host: 127.0.0.1:9696 @@ -276,12 +277,12 @@ Accept: application/json - Network Collection, Last Page: JSON - Response - + Network collection, last page: JSON + response + - Network Collection, Last Page: XML Request + Network collection, last page: XML request GET /v2.0/networks.xml?limit=2&marker=71c1e68c-171a-4aa2-aca5-50ea153a3718 HTTP/1.1 Host: 127.0.0.1:9696 @@ -290,27 +291,31 @@ Accept: application/xml - Network Collection, Last Page: XML Response - + Network collection, last page: XML response +
Sorting - The results of list operations can be ordered using the - 'sort_key' and 'sort_dir' parameters. Currently sorting - doesn't work with extended attributes of resource. The - 'sort_key' and 'sort_dir' can be repeated, and the number - of 'sort_key' and 'sort_dir' provided must be same. The - sort_dir parameter indicates in which direction to sort. - Acceptable values are 'asc' (ascending) and 'desc' - (descending). + You can use the sort_key and + sort_dir parameters to sort the + results of list operations. Currently sorting does not + work with extended attributes of resource. The + sort_key and + sort_dir can be repeated, and + the number of sort_key and + sort_dir provided must be same. + The sort_dir parameter indicates in + which direction to sort. Acceptable values are + asc (ascending) and + desc (descending). Sorting is optional feature of OpenStack Networking API, and it might be disabled. If sorting is disabled, the - sorting parameters will be ignored. + sorting parameters are ignored. If a particular plug-in does not support sorting - operations, and sorting is enabled, the &APIv2; will - emulate the sorting behavior so that users can expect the - same behavior regardless of the particular plug-in running + operations and sorting is enabled, the &APIv2; + emulates the sorting behavior so that users can expect the + same behavior regardless of the particular plug-in that runs in the background. Unfortunately OpenStack Networking does provide a mechanism to tell users if specific plug-ins support or @@ -356,7 +361,7 @@ Accept: application/xml extension varies with deployments and the specific plug-in in use. For more information regarding specific extensions, see - +
@@ -364,7 +369,7 @@ Accept: application/xml The &APIv2; returns an error response if a failure occurs while processing a request. OpenStack Networking uses only standard HTTP error codes. - 4xx errors indicate problems in the + 4nn errors indicate problems in the particular request being sent from the client. @@ -379,11 +384,11 @@ Accept: application/xml 400 - Bad Request + Bad request Malformed request URI or body - Requested admin state invalid + requested admin state invalid Invalid values entered diff --git a/v2.0/ch_neutron_overview.xml b/v2.0/ch_neutron_overview.xml index 25309c3..547d45f 100644 --- a/v2.0/ch_neutron_overview.xml +++ b/v2.0/ch_neutron_overview.xml @@ -1,28 +1,7 @@ - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - '> - - - - - '> - + ]> port - A virtual switch port on a logical network - switch. Virtual instances attach their interfaces into - ports. The logical port also defines the MAC address and - the IP addresses to be assigned to the interfaces - plugged into them. When creating a port, any unallocated - IP in the subnet can be stated specifically, even if the - IP address is not in the allocation pool. Enabling users - to specify the IP explicitly allows them to retain a - particular subset of the subnet IPs for static + A virtual switch port on a logical + network switch. Virtual instances attach their + interfaces into ports. The logical port also + defines the MAC address and the IP addresses + to be assigned to the interfaces plugged into + them. When creating a port, any unallocated IP + in the subnet can be stated specifically, even + if the IP address is not in the allocation + pool. Enabling users to specify the IP + explicitly allows them to retain a particular + subset of the subnet IPs for static allocation. @@ -168,9 +149,9 @@
- +
- High-Level Task Flow + High-level task flow The high-level task flow for OpenStack Networking involves creating a network, associating a subnet with that network, and booting a VM that is attached to the diff --git a/v2.0/ch_neutron_preface.xml b/v2.0/ch_neutron_preface.xml index 92eaf1d..b5e9172 100644 --- a/v2.0/ch_neutron_preface.xml +++ b/v2.0/ch_neutron_preface.xml @@ -42,7 +42,7 @@ format="SVG" scale="60"/> xlink:href="http://bugs.launchpad.net/Neutron" >bugs.launchpad.net/Neutron.
- Intended Audience + Intended audience
- Document Change History + Document change history This version of the document replaces and obsoletes all previous versions. The following table describes the most recent changes: diff --git a/v2.0/neutron-api-guide.xml b/v2.0/neutron-api-guide.xml index 633bb8b..05c10d9 100644 --- a/v2.0/neutron-api-guide.xml +++ b/v2.0/neutron-api-guide.xml @@ -10,19 +10,7 @@ PUT'> POST'> DELETE'> - - - - - '> - - - - - '> - + ]> 2011-2014 OpenStack Foundation - API v2.0 - OpenStack Networking (neutron) API - v2.0 + API v2.0 and extensions + OpenStack Networking (neutron) @@ -110,7 +97,8 @@ Updated the title of the book to Reference from Developer - Guide for consistency. + Guide for + consistency. diff --git a/v2.0/neutron-external-net.xml b/v2.0/neutron-external-net.xml deleted file mode 100644 index 361d32d..0000000 --- a/v2.0/neutron-external-net.xml +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - - '> - - - - - - '> - -]> -
- External Network Extension (<literal>external-net</literal>) - - The external network extension is used to specify whether - the network is external or not. This information is used - by Layer-3 network (router) extension. - External networks are connected to a router's external - gateway and host floating IPs. - -
- Concepts - - The External Network extension adds the - router:external - attribute to the network resource. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Network Attributes
AttributeTypeRequiredCRUD - - - - 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 ConstraintsNotes
router:externalBoolNoCRUFalse{ True | False }Specifies whether the network is an external network or not.
-
-
- Network API operations with external network extension -
- List Networks - - - - - - - - Verb - URI - Description - - - - - &GET; - /networks - Returns a list of networks with their router:external - attributes. - - - - - - Response codes are same as the normal operation of listing networks. - router:external attribute is visible - to all users by default policy setting. - - - Regular users are not authorized to create ports on external networks, - however they will be able to see this attribute in their network list. - This is because external networks can be used by any tenant to - set an external gateway for Neutron routers or create floating - IPs and associate them with ports on internal tenant networks. - - - List Networks with router:external attribute: JSON Response - - -
-
- Show Network - - - - - - - - Verb - URI - Description - - - - - &GET; - /networks/network_id - Returns details about a specific network, including external - networks attributes. - - - - - Response codes are same as the normal operation of listing networks. - router:external attribute is visible - to all users including non-admin by default policy setting. - - - Show network with external attributes: JSON Response - - -
-
- Create Network - - - - - - - - Verb - URI - Description - - - - - &POST; - /networks - Creates a new network using the external network extension - attribute. - - - - - - If the user submitting the request is not allowed to set this - attribute, a 403 Forbidden response will be returned. - Usage of this attribute might be restricted through authorization policies. - By the default policy only admin users can set this attribute. - - - Create Network with external attributes: JSON Request - - -
-
- Update Network - - - - - - - - Verb - URI - Description - - - - - &PUT; - /networks/network_id - Updates a network, including the external - network extension attribute. - - - - - - If the user submitting the request is not allowed to set this - attribute, a 403 Forbidden response will be returned. - Usage of this attribute might be restricted through authorization policies. - By the default policy only admin users can set this attribute. - - - Update external attributes for a network: JSON Request - - -
-
-
- diff --git a/v2.0/samples/ports-get-res-addr-pairs.json b/v2.0/samples/address-pairs/ports-get-res-addr-pairs.json similarity index 100% rename from v2.0/samples/ports-get-res-addr-pairs.json rename to v2.0/samples/address-pairs/ports-get-res-addr-pairs.json diff --git a/v2.0/samples/ports-get-res-addr-pairs.xml b/v2.0/samples/address-pairs/ports-get-res-addr-pairs.xml similarity index 83% rename from v2.0/samples/ports-get-res-addr-pairs.xml rename to v2.0/samples/address-pairs/ports-get-res-addr-pairs.xml index fb79b13..032b6ce 100644 --- a/v2.0/samples/ports-get-res-addr-pairs.xml +++ b/v2.0/samples/address-pairs/ports-get-res-addr-pairs.xml @@ -1,10 +1,10 @@ + xmlns:quantum="http://openstack.org/quantum/api/v2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> ACTIVE - + 23.23.23.1 @@ -14,7 +14,7 @@ True 3537e809-8bec-4ae4-a5ab-2c6477760195 8462a4d167f84256b7035f4c408c1185 - + fa:16:3e:21:4c:2e @@ -23,16 +23,16 @@ 191f5290-3a5a-40ff-b0cb-cd4b115b400e - + ACTIVE - - + + True 327f2a2f-9d70-417f-ac3a-d3155e25cf25 8462a4d167f84256b7035f4c408c1185 - + fa:16:3e:a9:3e:1a @@ -41,6 +41,6 @@ ec2fb9f9-a11b-4791-852d-eb1ab9b27a0e - + diff --git a/v2.0/samples/ports-post-req-addr-pairs.json b/v2.0/samples/address-pairs/ports-post-req-addr-pairs.json similarity index 97% rename from v2.0/samples/ports-post-req-addr-pairs.json rename to v2.0/samples/address-pairs/ports-post-req-addr-pairs.json index e4f976a..c128cf0 100644 --- a/v2.0/samples/ports-post-req-addr-pairs.json +++ b/v2.0/samples/address-pairs/ports-post-req-addr-pairs.json @@ -4,5 +4,4 @@ "network_id": "3537e809-8bec-4ae4-a5ab-2c6477760195", "allowed_address_pairs": [{"ip_address": "10.3.3.3"}] } -} - +} \ No newline at end of file diff --git a/v2.0/samples/ports-put-req-addr-pair.json b/v2.0/samples/address-pairs/ports-put-req-addr-pair.json similarity index 97% rename from v2.0/samples/ports-put-req-addr-pair.json rename to v2.0/samples/address-pairs/ports-put-req-addr-pair.json index 5da2aaf..a8240f3 100644 --- a/v2.0/samples/ports-put-req-addr-pair.json +++ b/v2.0/samples/address-pairs/ports-put-req-addr-pair.json @@ -5,5 +5,4 @@ {"ip_address": "10.0.0.1"} ] } -} - +} \ No newline at end of file diff --git a/v2.0/samples/ports-show-addr-pair.json b/v2.0/samples/address-pairs/ports-show-addr-pair.json similarity index 100% rename from v2.0/samples/ports-show-addr-pair.json rename to v2.0/samples/address-pairs/ports-show-addr-pair.json diff --git a/v2.0/samples/ports-show-addr-pair.xml b/v2.0/samples/address-pairs/ports-show-addr-pair.xml similarity index 100% rename from v2.0/samples/ports-show-addr-pair.xml rename to v2.0/samples/address-pairs/ports-show-addr-pair.xml diff --git a/v2.0/samples/agents-delete-res-json-http.txt b/v2.0/samples/agents/agents-delete-res-json-http.txt similarity index 53% rename from v2.0/samples/agents-delete-res-json-http.txt rename to v2.0/samples/agents/agents-delete-res-json-http.txt index d747e7e..bf5b00b 100644 --- a/v2.0/samples/agents-delete-res-json-http.txt +++ b/v2.0/samples/agents/agents-delete-res-json-http.txt @@ -1,3 +1,3 @@ HTTP/1.1 204 No Content Content-Length: 0 -Date: Tue, 26 Mar 2013 12:12:35 GMT +Date: Tue, 26 Mar 2013 12:12:35 GMT \ No newline at end of file diff --git a/v2.0/samples/agents-list-res.json b/v2.0/samples/agents/agents-list-res.json similarity index 100% rename from v2.0/samples/agents-list-res.json rename to v2.0/samples/agents/agents-list-res.json diff --git a/v2.0/samples/agents-put-req.json b/v2.0/samples/agents/agents-put-req.json similarity index 100% rename from v2.0/samples/agents-put-req.json rename to v2.0/samples/agents/agents-put-req.json diff --git a/v2.0/samples/agents-put-res.json b/v2.0/samples/agents/agents-put-res.json similarity index 100% rename from v2.0/samples/agents-put-res.json rename to v2.0/samples/agents/agents-put-res.json diff --git a/v2.0/samples/agents-show-res.json b/v2.0/samples/agents/agents-show-res.json similarity index 100% rename from v2.0/samples/agents-show-res.json rename to v2.0/samples/agents/agents-show-res.json diff --git a/v2.0/samples/att-get-res-none.json b/v2.0/samples/att-get-res-none.json deleted file mode 100644 index f97bf13..0000000 --- a/v2.0/samples/att-get-res-none.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "attachment": {} -} diff --git a/v2.0/samples/att-get-res-none.xml b/v2.0/samples/att-get-res-none.xml deleted file mode 100644 index b1d0ee2..0000000 --- a/v2.0/samples/att-get-res-none.xml +++ /dev/null @@ -1 +0,0 @@ - diff --git a/v2.0/samples/att-get-res.json b/v2.0/samples/att-get-res.json deleted file mode 100644 index 2680f8d..0000000 --- a/v2.0/samples/att-get-res.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "attachment": - { - "id": "test_interface_identifier" - } -} \ No newline at end of file diff --git a/v2.0/samples/att-get-res.xml b/v2.0/samples/att-get-res.xml deleted file mode 100644 index 0d2e266..0000000 --- a/v2.0/samples/att-get-res.xml +++ /dev/null @@ -1 +0,0 @@ - diff --git a/v2.0/samples/att-put-req.json b/v2.0/samples/att-put-req.json deleted file mode 100644 index 2680f8d..0000000 --- a/v2.0/samples/att-put-req.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "attachment": - { - "id": "test_interface_identifier" - } -} \ No newline at end of file diff --git a/v2.0/samples/att-put-req.xml b/v2.0/samples/att-put-req.xml deleted file mode 100644 index a6459bf..0000000 --- a/v2.0/samples/att-put-req.xml +++ /dev/null @@ -1,2 +0,0 @@ - diff --git a/v2.0/samples/port-create-req-edo.json b/v2.0/samples/dhcp/port-create-req-edo.json similarity index 100% rename from v2.0/samples/port-create-req-edo.json rename to v2.0/samples/dhcp/port-create-req-edo.json diff --git a/v2.0/samples/port-create-res-edo.json b/v2.0/samples/dhcp/port-create-res-edo.json similarity index 100% rename from v2.0/samples/port-create-res-edo.json rename to v2.0/samples/dhcp/port-create-res-edo.json diff --git a/v2.0/samples/port-get-res-edo.json b/v2.0/samples/dhcp/port-get-res-edo.json similarity index 100% rename from v2.0/samples/port-get-res-edo.json rename to v2.0/samples/dhcp/port-get-res-edo.json diff --git a/v2.0/samples/port-show-res-edo.json b/v2.0/samples/dhcp/port-show-res-edo.json similarity index 100% rename from v2.0/samples/port-show-res-edo.json rename to v2.0/samples/dhcp/port-show-res-edo.json diff --git a/v2.0/samples/port-update-req-edo.json b/v2.0/samples/dhcp/port-update-req-edo.json similarity index 100% rename from v2.0/samples/port-update-req-edo.json rename to v2.0/samples/dhcp/port-update-req-edo.json diff --git a/v2.0/samples/port-update-res-edo.json b/v2.0/samples/dhcp/port-update-res-edo.json similarity index 100% rename from v2.0/samples/port-update-res-edo.json rename to v2.0/samples/dhcp/port-update-res-edo.json diff --git a/v2.0/samples/extension.xml b/v2.0/samples/extension.xml deleted file mode 100644 index a392c03..0000000 --- a/v2.0/samples/extension.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - 2012-07-20T10:00:00-00:00 - Neutron L3 Router - - http://docs.openstack.org/ext/neutron/router/api/v1.0 - router - Router abstraction for basic L3 forwarding between L2 Neutron networks and access to external networks via a NAT gateway. - diff --git a/v2.0/samples/extensions.json b/v2.0/samples/extensions.json deleted file mode 100644 index 6fecf0e..0000000 --- a/v2.0/samples/extensions.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "extensions": [ - { - "name": "Cisco Port Profile", - "namespace": "http://docs.ciscocloud.com/api/ext/portprofile/v1.0", - "alias": "Cisco Port Profile", - "updated": "2011-07-23T13:25:27-06:00", - "description": "Portprofile include QoS information" - }, - { - "name": "Cisco qos", - "namespace": "http://docs.ciscocloud.com/api/ext/qos/v1.0", - "alias": "Cisco qos", - "updated": "2011-07-25T13:25:27-06:00", - "description": "qos include qos_name and qos_desc" - } - - ] -} diff --git a/v2.0/samples/extensions.xml b/v2.0/samples/extensions.xml deleted file mode 100644 index 5939246..0000000 --- a/v2.0/samples/extensions.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - Portprofile include QoS information - - - - qos include qos_name and qos_desc - - - diff --git a/v2.0/samples/extensionsv2.xml b/v2.0/samples/extensionsv2.xml deleted file mode 100644 index eb3c77f..0000000 --- a/v2.0/samples/extensionsv2.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - 2012-07-20T10:00:00-00:00 - Neutron L3 Router - - http://docs.openstack.org/ext/neutron/router/api/v1.0 - router - Router abstraction for basic L3 forwarding between L2 Neutron networks and access to external networks via a NAT gateway. - - - 2012-09-07T10:00:00-00:00 - Provider Network - - http://docs.openstack.org/ext/provider/api/v1.0 - provider - Expose mapping of virtual networks to physical networks - - diff --git a/v2.0/samples/router-create-enablesnat-json-http.txt b/v2.0/samples/external-gateway/router-create-enablesnat-json-http.txt similarity index 100% rename from v2.0/samples/router-create-enablesnat-json-http.txt rename to v2.0/samples/external-gateway/router-create-enablesnat-json-http.txt diff --git a/v2.0/samples/router-update-enablesnat-1.json b/v2.0/samples/external-gateway/router-update-enablesnat-1.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-1.json rename to v2.0/samples/external-gateway/router-update-enablesnat-1.json diff --git a/v2.0/samples/router-update-enablesnat-1b.json b/v2.0/samples/external-gateway/router-update-enablesnat-1b.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-1b.json rename to v2.0/samples/external-gateway/router-update-enablesnat-1b.json diff --git a/v2.0/samples/router-update-enablesnat-1c.json b/v2.0/samples/external-gateway/router-update-enablesnat-1c.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-1c.json rename to v2.0/samples/external-gateway/router-update-enablesnat-1c.json diff --git a/v2.0/samples/router-update-enablesnat-1d.json b/v2.0/samples/external-gateway/router-update-enablesnat-1d.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-1d.json rename to v2.0/samples/external-gateway/router-update-enablesnat-1d.json diff --git a/v2.0/samples/router-update-enablesnat-2.json b/v2.0/samples/external-gateway/router-update-enablesnat-2.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-2.json rename to v2.0/samples/external-gateway/router-update-enablesnat-2.json diff --git a/v2.0/samples/router-update-enablesnat-2b.json b/v2.0/samples/external-gateway/router-update-enablesnat-2b.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-2b.json rename to v2.0/samples/external-gateway/router-update-enablesnat-2b.json diff --git a/v2.0/samples/router-update-enablesnat-2c.json b/v2.0/samples/external-gateway/router-update-enablesnat-2c.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-2c.json rename to v2.0/samples/external-gateway/router-update-enablesnat-2c.json diff --git a/v2.0/samples/router-update-enablesnat-2d.json b/v2.0/samples/external-gateway/router-update-enablesnat-2d.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-2d.json rename to v2.0/samples/external-gateway/router-update-enablesnat-2d.json diff --git a/v2.0/samples/router-update-enablesnat-3.json b/v2.0/samples/external-gateway/router-update-enablesnat-3.json similarity index 97% rename from v2.0/samples/router-update-enablesnat-3.json rename to v2.0/samples/external-gateway/router-update-enablesnat-3.json index c4f345f..16b079e 100644 --- a/v2.0/samples/router-update-enablesnat-3.json +++ b/v2.0/samples/external-gateway/router-update-enablesnat-3.json @@ -7,8 +7,4 @@ "network_id": "3c5bcddd-6af9-4e6b-9c3e-c153e521cab8", "enable_snat": false} } -} - - - - +} \ No newline at end of file diff --git a/v2.0/samples/router-update-enablesnat-3b.json b/v2.0/samples/external-gateway/router-update-enablesnat-3b.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-3b.json rename to v2.0/samples/external-gateway/router-update-enablesnat-3b.json diff --git a/v2.0/samples/router-update-enablesnat-3c.json b/v2.0/samples/external-gateway/router-update-enablesnat-3c.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-3c.json rename to v2.0/samples/external-gateway/router-update-enablesnat-3c.json diff --git a/v2.0/samples/router-update-enablesnat-3d.json b/v2.0/samples/external-gateway/router-update-enablesnat-3d.json similarity index 100% rename from v2.0/samples/router-update-enablesnat-3d.json rename to v2.0/samples/external-gateway/router-update-enablesnat-3d.json diff --git a/v2.0/samples/routers-get-enablesnat-res.json b/v2.0/samples/external-gateway/routers-get-enablesnat-res.json similarity index 100% rename from v2.0/samples/routers-get-enablesnat-res.json rename to v2.0/samples/external-gateway/routers-get-enablesnat-res.json diff --git a/v2.0/samples/networks-get-res-extnet.json b/v2.0/samples/extnet/networks-get-res-extnet.json similarity index 100% rename from v2.0/samples/networks-get-res-extnet.json rename to v2.0/samples/extnet/networks-get-res-extnet.json diff --git a/v2.0/samples/networks-post-req-extnet.json b/v2.0/samples/extnet/networks-post-req-extnet.json similarity index 100% rename from v2.0/samples/networks-post-req-extnet.json rename to v2.0/samples/extnet/networks-post-req-extnet.json diff --git a/v2.0/samples/networks-put-req-extnet.json b/v2.0/samples/extnet/networks-put-req-extnet.json similarity index 100% rename from v2.0/samples/networks-put-req-extnet.json rename to v2.0/samples/extnet/networks-put-req-extnet.json diff --git a/v2.0/samples/networks-show-res-extnet.json b/v2.0/samples/extnet/networks-show-res-extnet.json similarity index 100% rename from v2.0/samples/networks-show-res-extnet.json rename to v2.0/samples/extnet/networks-show-res-extnet.json diff --git a/v2.0/samples/extraroute-put-req.json b/v2.0/samples/extraroute/extraroute-put-req.json similarity index 100% rename from v2.0/samples/extraroute-put-req.json rename to v2.0/samples/extraroute/extraroute-put-req.json diff --git a/v2.0/samples/extraroute-put-res.json b/v2.0/samples/extraroute/extraroute-put-res.json similarity index 99% rename from v2.0/samples/extraroute-put-res.json rename to v2.0/samples/extraroute/extraroute-put-res.json index 68932ca..b3aeb23 100644 --- a/v2.0/samples/extraroute-put-res.json +++ b/v2.0/samples/extraroute/extraroute-put-res.json @@ -6,4 +6,4 @@ "tenant_id": "936fa220b2c24a87af51026439af7a3e", "routes": [{"nexthop": "10.1.0.10", "destination": "40.0.1.0/24"}], "id": "babc8173-46f6-4b6f-8b95-38c1683a4e22"} -} +} \ No newline at end of file diff --git a/v2.0/samples/fault.json b/v2.0/samples/fault.json deleted file mode 100644 index 70ef636..0000000 --- a/v2.0/samples/fault.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "networkNotFound": { - "message": "Unable to find a network with the specified identifier.", - "code": 420, - "detail": "Network 8de6af7c-ef95-4ac1-9d37-172f8df33a1f could not be found" - } -} diff --git a/v2.0/samples/fault.xml b/v2.0/samples/fault.xml deleted file mode 100644 index 85730ff..0000000 --- a/v2.0/samples/fault.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - Unable to find a network with the specified identifier. - - - Network 8de6af7c-ef95-4ac1-9d37-172f8df33a1f could not be found - - diff --git a/v2.0/samples/floatingips-get-res.json b/v2.0/samples/floatingips-get-res.json deleted file mode 100644 index 9ac149c..0000000 --- a/v2.0/samples/floatingips-get-res.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "floatingips": - [ - { - "router_id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f", - "tenant_id": "4969c491a3c74ee4af974e6d800c62de", - "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", - "fixed_ip_address": "10.0.0.3", - "floating_ip_address": "172.24.4.228", - "port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab", - "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7" - }, - { - "router_id": null, - "tenant_id": "4969c491a3c74ee4af974e6d800c62de", - "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", - "fixed_ip_address": null, - "floating_ip_address": "172.24.4.227", - "port_id": null, - "id": "61cea855-49cb-4846-997d-801b70c71bdd" - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/floatingips-post-req-json-http.txt b/v2.0/samples/floatingips-post-req-json-http.txt deleted file mode 100644 index a90dc61..0000000 --- a/v2.0/samples/floatingips-post-req-json-http.txt +++ /dev/null @@ -1,10 +0,0 @@ -POST /v2.0/floatingips -Accept: application/json - -{ - "floatingip": - { - "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", - "port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab" - } -} diff --git a/v2.0/samples/floatingips-post-res.json b/v2.0/samples/floatingips-post-res.json deleted file mode 100644 index daf640c..0000000 --- a/v2.0/samples/floatingips-post-res.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "floatingip": - { - "router_id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f", - "tenant_id": "4969c491a3c74ee4af974e6d800c62de", - "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", - "fixed_ip_address": "10.0.0.3", - "floating_ip_address": "172.24.4.228", - "port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab", - "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7" - } -} diff --git a/v2.0/samples/floatingips-put-ass-req.json b/v2.0/samples/floatingips-put-ass-req.json deleted file mode 100644 index 864a099..0000000 --- a/v2.0/samples/floatingips-put-ass-req.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "floatingip":{ - "port_id":"fc861431-0e6c-4842-a0ed-e2363f9bc3a8" - } -} \ No newline at end of file diff --git a/v2.0/samples/floatingips-put-ass-res.json b/v2.0/samples/floatingips-put-ass-res.json deleted file mode 100644 index 48da95a..0000000 --- a/v2.0/samples/floatingips-put-ass-res.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "floatingip": - { - "router_id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f", - "tenant_id": "4969c491a3c74ee4af974e6d800c62de", - "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", - "fixed_ip_address": "10.0.0.4", - "floating_ip_address": "172.24.4.228", - "port_id": "fc861431-0e6c-4842-a0ed-e2363f9bc3a8", - "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7" - } - } diff --git a/v2.0/samples/floatingips-put-disass-req.json b/v2.0/samples/floatingips-put-disass-req.json deleted file mode 100644 index da4557f..0000000 --- a/v2.0/samples/floatingips-put-disass-req.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "floatingip":{ - "port_id":null - } -} \ No newline at end of file diff --git a/v2.0/samples/floatingips-put-disass-res.json b/v2.0/samples/floatingips-put-disass-res.json deleted file mode 100644 index a9e56dc..0000000 --- a/v2.0/samples/floatingips-put-disass-res.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "floatingip": - { - "router_id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f", - "tenant_id": "4969c491a3c74ee4af974e6d800c62de", - "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", - "fixed_ip_address": null, - "floating_ip_address": "172.24.4.228", - "port_id": null, - "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7" - } - } diff --git a/v2.0/samples/floatingips-show-res.json b/v2.0/samples/floatingips-show-res.json deleted file mode 100644 index 315dcf9..0000000 --- a/v2.0/samples/floatingips-show-res.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "floatingip": - { - "fixed_ip_address": "10.0.0.3", - "floating_ip_address": "172.24.4.228" - } -} \ No newline at end of file diff --git a/v2.0/samples/networks-get-first-page-res.json b/v2.0/samples/general/networks-get-first-page-res.json similarity index 100% rename from v2.0/samples/networks-get-first-page-res.json rename to v2.0/samples/general/networks-get-first-page-res.json diff --git a/v2.0/samples/networks-get-first-page-res.xml b/v2.0/samples/general/networks-get-first-page-res.xml similarity index 100% rename from v2.0/samples/networks-get-first-page-res.xml rename to v2.0/samples/general/networks-get-first-page-res.xml diff --git a/v2.0/samples/networks-get-last-page-res.json b/v2.0/samples/general/networks-get-last-page-res.json similarity index 100% rename from v2.0/samples/networks-get-last-page-res.json rename to v2.0/samples/general/networks-get-last-page-res.json diff --git a/v2.0/samples/networks-get-last-page-res.xml b/v2.0/samples/general/networks-get-last-page-res.xml similarity index 100% rename from v2.0/samples/networks-get-last-page-res.xml rename to v2.0/samples/general/networks-get-last-page-res.xml diff --git a/v2.0/samples/network-get-detail-res.json b/v2.0/samples/network-get-detail-res.json deleted file mode 100644 index 15302f5..0000000 --- a/v2.0/samples/network-get-detail-res.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "network": - { - "id": "8bec1293-16bd-4568-ba75-1f58bec0b4c3", - "name": "test_network", - "ports": - [ - { - "id": "98017ddc-efc8-4c25-a915-774b2a633855", - "state": "DOWN" - }, - { - "id": "b832be00-6553-4f69-af33-acd554e36d08", - "state": "ACTIVE", - "attachment": - { - "id": "test_interface_identifier" - } - } - ] - } -} \ No newline at end of file diff --git a/v2.0/samples/network-get-detail-res.xml b/v2.0/samples/network-get-detail-res.xml deleted file mode 100644 index 1f94640..0000000 --- a/v2.0/samples/network-get-detail-res.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - diff --git a/v2.0/samples/network-get-res.json b/v2.0/samples/network-get-res.json deleted file mode 100644 index 8ccffa1..0000000 --- a/v2.0/samples/network-get-res.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "network": - { - "id": "8bec1293-16bd-4568-ba75-1f58bec0b4c3", - "name": "test_network" - } -} \ No newline at end of file diff --git a/v2.0/samples/network-get-res.xml b/v2.0/samples/network-get-res.xml deleted file mode 100644 index 94b35bc..0000000 --- a/v2.0/samples/network-get-res.xml +++ /dev/null @@ -1,3 +0,0 @@ - \ No newline at end of file diff --git a/v2.0/samples/network-post-req-bulk.json b/v2.0/samples/network-post-req-bulk.json deleted file mode 100644 index b948dd1..0000000 --- a/v2.0/samples/network-post-req-bulk.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "networks": [ - { - "admin_state_up": true, - "name": "sample_network_1" - }, - { - "admin_state_up": false, - "name": "sample_network_2" - } - ] -} diff --git a/v2.0/samples/network-post-req.json b/v2.0/samples/network-post-req.json deleted file mode 100644 index 77402e6..0000000 --- a/v2.0/samples/network-post-req.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "network": - { - "name": "sample_network", - "admin_state_up": true - } -} diff --git a/v2.0/samples/network-post-req.xml b/v2.0/samples/network-post-req.xml deleted file mode 100644 index e39bc94..0000000 --- a/v2.0/samples/network-post-req.xml +++ /dev/null @@ -1,3 +0,0 @@ - - sample_network - diff --git a/v2.0/samples/network-post-res-bulk.json b/v2.0/samples/network-post-res-bulk.json deleted file mode 100644 index 5397dc4..0000000 --- a/v2.0/samples/network-post-res-bulk.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "networks": [ - { - "admin_state_up": true, - "id": "e6031bc2-901a-4c66-82da-f4c32ed89406", - "name": "sample_network_1", - "shared": false, - "status": "ACTIVE", - "subnets": [], - "tenant_id": "d19231fc08ec4bc4829b668040d34512" - }, - { - "admin_state_up": false, - "id": "64239a54-dcc4-4b39-920b-b37c2144effa", - "name": "sample_network_2", - "shared": false, - "status": "ACTIVE", - "subnets": [], - "tenant_id": "d19231fc08ec4bc4829b668040d34512" - } - ] -} diff --git a/v2.0/samples/network-post-res.json b/v2.0/samples/network-post-res.json deleted file mode 100644 index 83d5ae2..0000000 --- a/v2.0/samples/network-post-res.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "network":{ - "admin_state_up":true, - "id":"850d3f2c-f0a5-4f8b-b1cf-5836fc0be940", - "name":"sample_network", - "shared":false, - "status":"ACTIVE", - "subnets":[ - - ], - "tenant_id":"f667b69e4d6749749ef3bcba7251d9ce" - } -} diff --git a/v2.0/samples/network-post-res.xml b/v2.0/samples/network-post-res.xml deleted file mode 100644 index 03cfe12..0000000 --- a/v2.0/samples/network-post-res.xml +++ /dev/null @@ -1,2 +0,0 @@ - diff --git a/v2.0/samples/network-post-resp.json b/v2.0/samples/network-post-resp.json deleted file mode 100644 index 721268a..0000000 --- a/v2.0/samples/network-post-resp.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "network":{ - "admin_state_up":true, - "id":"850d3f2c-f0a5-4f8b-b1cf-5836fc0be940", - "name":"sample_network", - "shared":false, - "status":"ACTIVE", - "subnets":[ - - ], - "tenant_id":"f667b69e4d6749749ef3bcba7251d9ce" - } -} \ No newline at end of file diff --git a/v2.0/samples/network-post-resp.xml b/v2.0/samples/network-post-resp.xml deleted file mode 100644 index 4101965..0000000 --- a/v2.0/samples/network-post-resp.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - ACTIVE - - sample_network - 4be6b806faa0491eb358018bbe9f0d4e - True - False - 0657ef52-d3f6-4320-9c26-015a3e9badea - diff --git a/v2.0/samples/network-put-update-resp.json b/v2.0/samples/network-put-update-resp.json deleted file mode 100644 index f9b1f94..0000000 --- a/v2.0/samples/network-put-update-resp.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "network": - { - "status": "ACTIVE", - "subnets": ["e12f0c45-46e3-446a-b207-9474b27687a6"], - "name": "private", - "admin_state_up": true, - "tenant_id": "625887121e364204873d362b553ab171", - "id": "9d83c053-b0a4-4682-ae80-c00df269ce0a", - "shared": false - } -} diff --git a/v2.0/samples/network-put-update-resp.xml b/v2.0/samples/network-put-update-resp.xml deleted file mode 100644 index 3e90de6..0000000 --- a/v2.0/samples/network-put-update-resp.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - ACTIVE - - e12f0c45-46e3-446a-b207-9474b27687a6 - - private - - True - 625887121e364204873d362b553ab171 - local - False - False - 9d83c053-b0a4-4682-ae80-c00df269ce0a - - diff --git a/v2.0/samples/network-put-update.req.json b/v2.0/samples/network-put-update.req.json deleted file mode 100644 index 37fe569..0000000 --- a/v2.0/samples/network-put-update.req.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "network": - { - "name": "updated_name" - } -} diff --git a/v2.0/samples/network-put-update.req.xml b/v2.0/samples/network-put-update.req.xml deleted file mode 100644 index d43bdde..0000000 --- a/v2.0/samples/network-put-update.req.xml +++ /dev/null @@ -1,3 +0,0 @@ - - nova2 - diff --git a/v2.0/samples/networks-create-bulk-resp.json b/v2.0/samples/networks-create-bulk-resp.json deleted file mode 100644 index 7c10808..0000000 --- a/v2.0/samples/networks-create-bulk-resp.json +++ /dev/null @@ -1,28 +0,0 @@ -{ -"networks": [ -{ -"status": "ACTIVE", -"subnets": [], -"name": "sample_network_1", -"provider:physical_network": null, -"admin_state_up": false, -"tenant_id": "60cd4f6dbc2f491982a284e7b83b5be3", -"provider:network_type": "local", -"router:external": false, -"shared": false, -"id": "e9330b1f-a2ef-4160-a951-169ee6ab17f5", -"provider:segmentation_id": null -}, -{ -"status": "ACTIVE", -"subnets": [], -"name": "sample_network_2", -"provider:physical_network": null, -"admin_state_up": false, -"tenant_id": "60cd4f6dbc2f491982a284e7b83b5be3", -"provider:network_type": "local", -"router:external": false, -"shared": false, -"id": "cfb5f52c-dfe2-4357-a10d-a225693e2b84", -"provider:segmentation_id": null}] -} diff --git a/v2.0/samples/networks-create-bulk-resp.xml b/v2.0/samples/networks-create-bulk-resp.xml deleted file mode 100644 index 93eff7f..0000000 --- a/v2.0/samples/networks-create-bulk-resp.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - ACTIVE - - sample_network_1 - - True - 60cd4f6dbc2f491982a284e7b83b5be3 - local - False - False - 9eb3ce34-183b-4a75-b08f-d6a3d241e68b - - - - ACTIVE - - sample_network_2 - - True - 60cd4f6dbc2f491982a284e7b83b5be3 - local - False - False - df679a25-915d-41ed-b5ec-721481ddfd56 - - - diff --git a/v2.0/samples/networks-get-detail-res.json b/v2.0/samples/networks-get-detail-res.json deleted file mode 100644 index 8898df7..0000000 --- a/v2.0/samples/networks-get-detail-res.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "network": - { - "status": "ACTIVE", - "subnets": ["e12f0c45-46e3-446a-b207-9474b27687a6"], - "name": "network_3", - "admin_state_up": true, - "tenant_id": "ed680f49ff714162ab3612d7876ffce5", - "id": "afc75773-640e-403c-9fff-62ba98db1f19" - } -} diff --git a/v2.0/samples/networks-get-detail-res.xml b/v2.0/samples/networks-get-detail-res.xml deleted file mode 100644 index c8df9d5..0000000 --- a/v2.0/samples/networks-get-detail-res.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - diff --git a/v2.0/samples/networks-get-detail-resp.json b/v2.0/samples/networks-get-detail-resp.json deleted file mode 100644 index f9b1f94..0000000 --- a/v2.0/samples/networks-get-detail-resp.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "network": - { - "status": "ACTIVE", - "subnets": ["e12f0c45-46e3-446a-b207-9474b27687a6"], - "name": "private", - "admin_state_up": true, - "tenant_id": "625887121e364204873d362b553ab171", - "id": "9d83c053-b0a4-4682-ae80-c00df269ce0a", - "shared": false - } -} diff --git a/v2.0/samples/networks-get-detail-resp.xml b/v2.0/samples/networks-get-detail-resp.xml deleted file mode 100644 index 3e90de6..0000000 --- a/v2.0/samples/networks-get-detail-resp.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - ACTIVE - - e12f0c45-46e3-446a-b207-9474b27687a6 - - private - - True - 625887121e364204873d362b553ab171 - local - False - False - 9d83c053-b0a4-4682-ae80-c00df269ce0a - - diff --git a/v2.0/samples/networks-get-res.json b/v2.0/samples/networks-get-res.json deleted file mode 100644 index 5fa68ff..0000000 --- a/v2.0/samples/networks-get-res.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "networks": [ - { - "status": "ACTIVE", - "subnets": [], - "name": "network_1", - "admin_state_up": true, - "tenant_id": "c1210485b2424d48804aad5d39c61b8f", - "id": "3a06dfc7-d239-4aad-9a57-21cd171c72e5", - "shared": false - }, - { - "status": "ACTIVE", - "subnets": [], - "name": "network-2", - "admin_state_up": true, - "tenant_id": "c1210485b2424d48804aad5d39c61b8f", - "id": "7db8c5a4-6eb0-478d-856b-7cfda2b25e13", - "shared": false - }, - { - "status": "ACTIVE", - "subnets": ["e12f0c45-46e3-446a-b207-9474b27687a6"], - "name": "network_3", - "admin_state_up": true, - "tenant_id": "ed680f49ff714162ab3612d7876ffce5", - "id": "afc75773-640e-403c-9fff-62ba98db1f19", - "shared": true - } - ] -} diff --git a/v2.0/samples/networks-get-res.xml b/v2.0/samples/networks-get-res.xml deleted file mode 100644 index e981f38..0000000 --- a/v2.0/samples/networks-get-res.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file diff --git a/v2.0/samples/networks-get-resp.json b/v2.0/samples/networks-get-resp.json deleted file mode 100644 index 0a6582a..0000000 --- a/v2.0/samples/networks-get-resp.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "networks":[ - { - "status":"ACTIVE", - "subnets":[ - "a318fcb4-9ff0-4485-b78c-9e6738c21b26" - ], - "name":"private", - "admin_state_up":true, - "tenant_id":"625887121e364204873d362b553ab171", - "id":"9d83c053-b0a4-4682-ae80-c00df269ce0a", - "shared":false - }, - { - "status":"ACTIVE", - "subnets":[ - "aca4d43c-c48c-4a2c-9bb6-ba374ef7e135" - ], - "name":"nova", - "admin_state_up":true, - "tenant_id":"63878e4c5dd649d2a980e37aefddfa87", - "id":"ebda9658-093b-41ba-80ce-0cf8cb8365d4", - "shared":false - }, - { - "status":"ACTIVE", - "subnets":[ - "e12f0c45-46e3-446a-b207-9474b27687a6" - ], - "name":"network_3", - "admin_state_up":true, - "tenant_id":"ed680f49ff714162ab3612d7876ffce5", - "id":"afc75773-640e-403c-9fff-62ba98db1f19", - "shared":true - } - ] -} diff --git a/v2.0/samples/networks-get-resp.xml b/v2.0/samples/networks-get-resp.xml deleted file mode 100644 index 6c4f7ae..0000000 --- a/v2.0/samples/networks-get-resp.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - ACTIVE - - a318fcb4-9ff0-4485-b78c-9e6738c21b26 - - private - - True - 625887121e364204873d362b553ab171 - local - False - False - 9d83c053-b0a4-4682-ae80-c00df269ce0a - - - - ACTIVE - - aca4d43c-c48c-4a2c-9bb6-ba374ef7e135 - - nova - - True - 63878e4c5dd649d2a980e37aefddfa87 - local - True - False - ebda9658-093b-41ba-80ce-0cf8cb8365d4 - - - diff --git a/v2.0/samples/networks-post-create-bulk-req.json b/v2.0/samples/networks-post-create-bulk-req.json deleted file mode 100644 index 8527240..0000000 --- a/v2.0/samples/networks-post-create-bulk-req.json +++ /dev/null @@ -1,11 +0,0 @@ -{ -"networks": [ -{ -"name": "sample_network_1", -"admin_state_up": false -}, -{ -"name": "sample_network_2", -"admin_state_up": false -}] -} diff --git a/v2.0/samples/networks-post-create-bulk-req.xml b/v2.0/samples/networks-post-create-bulk-req.xml deleted file mode 100644 index cfc344f..0000000 --- a/v2.0/samples/networks-post-create-bulk-req.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - sample_network_1 - - - sample_network_2 - - diff --git a/v2.0/samples/networks-post-req.json b/v2.0/samples/networks-post-req.json deleted file mode 100644 index 7758cf4..0000000 --- a/v2.0/samples/networks-post-req.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "network": - { - "name": "net-name", - "admin_state_up": true - } -} diff --git a/v2.0/samples/networks-post-req.xml b/v2.0/samples/networks-post-req.xml deleted file mode 100644 index 4476b24..0000000 --- a/v2.0/samples/networks-post-req.xml +++ /dev/null @@ -1,2 +0,0 @@ - - \ No newline at end of file diff --git a/v2.0/samples/networks-post-res.json b/v2.0/samples/networks-post-res.json deleted file mode 100644 index a42bdd4..0000000 --- a/v2.0/samples/networks-post-res.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "network": - { - "status": "ACTIVE", - "subnets": [], - "name": "net-name", - "admin_state_up": true, - "tenant_id": "388a70781bae4ca895f17b7f6293eb70", - "shared": false, "id": "2a4017ef-31ff-496a-9294-e96ecc3bc9c9" - } -} diff --git a/v2.0/samples/networks-post-res.xml b/v2.0/samples/networks-post-res.xml deleted file mode 100644 index f32405f..0000000 --- a/v2.0/samples/networks-post-res.xml +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/v2.0/samples/networks-provider-get-resp.xml b/v2.0/samples/networks-provider-get-resp.xml deleted file mode 100644 index 6c4f7ae..0000000 --- a/v2.0/samples/networks-provider-get-resp.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - ACTIVE - - a318fcb4-9ff0-4485-b78c-9e6738c21b26 - - private - - True - 625887121e364204873d362b553ab171 - local - False - False - 9d83c053-b0a4-4682-ae80-c00df269ce0a - - - - ACTIVE - - aca4d43c-c48c-4a2c-9bb6-ba374ef7e135 - - nova - - True - 63878e4c5dd649d2a980e37aefddfa87 - local - True - False - ebda9658-093b-41ba-80ce-0cf8cb8365d4 - - - diff --git a/v2.0/samples/notfound.json b/v2.0/samples/notfound.json deleted file mode 100644 index 8c99856..0000000 --- a/v2.0/samples/notfound.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "itemNotFound" : { - "code" : 404, - "message" : "Not Found", - "details" : "Error Details..." - } -} diff --git a/v2.0/samples/notfound.xml b/v2.0/samples/notfound.xml deleted file mode 100644 index ecfe242..0000000 --- a/v2.0/samples/notfound.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - Not Found -
Error Details...
- diff --git a/v2.0/samples/notimplemented.json b/v2.0/samples/notimplemented.json deleted file mode 100644 index fa7a16c..0000000 --- a/v2.0/samples/notimplemented.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "notImplemented" : { - "code" : 501, - "message" : "Not Implemented", - "details" : "Error Details..." - } -} diff --git a/v2.0/samples/notimplemented.xml b/v2.0/samples/notimplemented.xml deleted file mode 100644 index 89027f3..0000000 --- a/v2.0/samples/notimplemented.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - Not Implemented -
Error Details...
- diff --git a/v2.0/samples/port-get-detail-res.json b/v2.0/samples/port-get-detail-res.json deleted file mode 100644 index 2a4916b..0000000 --- a/v2.0/samples/port-get-detail-res.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "port": - { - "state": "DOWN", - "id": "98017ddc-efc8-4c25-a915-774b2a633855", - "attachment": - { - "id": "test_interface_identifier" - } - } -} - diff --git a/v2.0/samples/port-get-detail-res.xml b/v2.0/samples/port-get-detail-res.xml deleted file mode 100644 index d0dbce8..0000000 --- a/v2.0/samples/port-get-detail-res.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - diff --git a/v2.0/samples/port-get-res.json b/v2.0/samples/port-get-res.json deleted file mode 100644 index 7c6508a..0000000 --- a/v2.0/samples/port-get-res.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "port":{ - "admin_state_up":true, - "device_id":"dhcpacb6d6f0-2d56-5c7a-9905-4c3a3d168f49-abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "device_owner":"network:dhcp", - "fixed_ips":[ - { - "ip_address":"10.0.0.2", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"ebe69f1e-bc26-4db5-bed0-c0afb4afe3db", - "mac_address":"fa:16:3e:a9:34:c3", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "49258a30-81f9-44d7-9440-c60dba50e29e" - ], - "status":"ACTIVE", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} \ No newline at end of file diff --git a/v2.0/samples/port-get-res.xml b/v2.0/samples/port-get-res.xml deleted file mode 100644 index 622f397..0000000 --- a/v2.0/samples/port-get-res.xml +++ /dev/null @@ -1,3 +0,0 @@ - \ No newline at end of file diff --git a/v2.0/samples/port-post-create-req.json b/v2.0/samples/port-post-create-req.json deleted file mode 100644 index 26c40f2..0000000 --- a/v2.0/samples/port-post-create-req.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "port": { - "admin_state_up": true, - "device_id": "d6b4d3a5-c700-476f-b609-1493dd9dadc0", - "name": "port1", - "network_id": "6aeaf34a-c482-4bd3-9dc3-7faf36412f12" - } -} \ No newline at end of file diff --git a/v2.0/samples/port-post-req-bulk.json b/v2.0/samples/port-post-req-bulk.json deleted file mode 100644 index c0567c6..0000000 --- a/v2.0/samples/port-post-req-bulk.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "ports": [ - { - "admin_state_up": true, - "device_id": "24df1d04-d5cb-41e1-8de5-61ed77c558df", - "name": "port1", - "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa", - "security_groups": [ - "dbc107f4-afcd-4d5a-9352-f68f82241d5b" - ] - }, - { - "admin_state_up": false, - "name": "port2", - "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406", - "security_groups": [ - "8bf3f7cc-8471-40b1-815f-9da47e79775b", - "dbc107f4-afcd-4d5a-9352-f68f82241d5b" - ] - } - ] -} diff --git a/v2.0/samples/port-post-req.json b/v2.0/samples/port-post-req.json deleted file mode 100644 index 7a409fb..0000000 --- a/v2.0/samples/port-post-req.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "port":{ - "admin_state_up":true, - "device_id":"24df1d04-d5cb-41e1-8de5-61ed77c558df", - "name":"port1", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "85cc3048-abc3-43cc-89b3-377341426ac5" - ] - } -} diff --git a/v2.0/samples/port-post-req.xml b/v2.0/samples/port-post-req.xml deleted file mode 100644 index 4f8c1f6..0000000 --- a/v2.0/samples/port-post-req.xml +++ /dev/null @@ -1,2 +0,0 @@ - diff --git a/v2.0/samples/port-post-res-bulk.json b/v2.0/samples/port-post-res-bulk.json deleted file mode 100644 index 3ecfb52..0000000 --- a/v2.0/samples/port-post-res-bulk.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "ports": [ - { - "admin_state_up": true, - "allowed_address_pairs": [], - "device_id": "24df1d04-d5cb-41e1-8de5-61ed77c558df", - "device_owner": "", - "fixed_ips": [ - { - "ip_address": "10.56.4.2", - "subnet_id": "b0e7435c-1512-45fb-aa9e-9a7c5932fb30" - } - ], - "id": "4fa2a5b2-d758-449d-80d6-dff31df9e91e", - "mac_address": "fa:16:3e:63:b0:82", - "name": "port1", - "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa", - "security_groups": [ - "dbc107f4-afcd-4d5a-9352-f68f82241d5b" - ], - "status": "DOWN", - "tenant_id": "d19231fc08ec4bc4829b668040d34512" - }, - { - "admin_state_up": false, - "allowed_address_pairs": [], - "device_id": "", - "device_owner": "", - "fixed_ips": [ - { - "ip_address": "192.168.199.2", - "subnet_id": "0468a7a7-290d-4127-aedd-6c9449775a24" - } - ], - "id": "d3c059b8-40fd-489a-8d17-97bde9370987", - "mac_address": "fa:16:3e:86:09:06", - "name": "port2", - "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406", - "security_groups": [ - "8bf3f7cc-8471-40b1-815f-9da47e79775b", - "dbc107f4-afcd-4d5a-9352-f68f82241d5b" - ], - "status": "DOWN", - "tenant_id": "d19231fc08ec4bc4829b668040d34512" - } - ] -} diff --git a/v2.0/samples/port-post-res.json b/v2.0/samples/port-post-res.json deleted file mode 100644 index 83acde6..0000000 --- a/v2.0/samples/port-post-res.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "port":{ - "admin_state_up":true, - "device_id":"24df1d04-d5cb-41e1-8de5-61ed77c558df", - "device_owner":"", - "fixed_ips":[ - { - "ip_address":"10.0.0.4", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"358c03ee-20f8-40d2-b74b-9b21a9df10a7", - "mac_address":"fa:16:3e:ac:95:a9", - "name":"port1", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "85cc3048-abc3-43cc-89b3-377341426ac5" - ], - "status":"DOWN", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} diff --git a/v2.0/samples/port-post-res.xml b/v2.0/samples/port-post-res.xml deleted file mode 100644 index f1564b8..0000000 --- a/v2.0/samples/port-post-res.xml +++ /dev/null @@ -1,2 +0,0 @@ - diff --git a/v2.0/samples/port-put-req.json b/v2.0/samples/port-put-req.json deleted file mode 100644 index c77b50b..0000000 --- a/v2.0/samples/port-put-req.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "port":{ - "security_groups":[ - "85cc3048-abc3-43cc-89b3-377341426ac5", - "c5ab5c29-2c99-44cb-a4b8-e70a88b77799" - ] - } -} \ No newline at end of file diff --git a/v2.0/samples/port-put-res.json b/v2.0/samples/port-put-res.json deleted file mode 100644 index e6e0c33..0000000 --- a/v2.0/samples/port-put-res.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "port":{ - "admin_state_up":true, - "device_id":"24df1d04-d5cb-41e1-8de5-61ed77c558df", - "device_owner":"compute:None", - "fixed_ips":[ - { - "ip_address":"10.0.0.3", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"1d8591f4-7b62-428e-857d-e82a15e5a7f1", - "mac_address":"fa:16:3e:b6:da:54", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "85cc3048-abc3-43cc-89b3-377341426ac5", - "c5ab5c29-2c99-44cb-a4b8-e70a88b77799" - ], - "status":"ACTIVE", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} \ No newline at end of file diff --git a/v2.0/samples/ports-create-bulk-resp.json b/v2.0/samples/ports-create-bulk-resp.json deleted file mode 100644 index 883d029..0000000 --- a/v2.0/samples/ports-create-bulk-resp.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "ports":[ - { - "status":"DOWN", - "binding:host_id":null, - "name":"sample_port_1", - "admin_state_up":true, - "network_id":"a3775a7d-9f8b-4148-be81-c84bbd0837ce", - "tenant_id":"60cd4f6dbc2f491982a284e7b83b5be3", - "binding:vif_type":"ovs", - "device_owner":"", - "binding:capabilities":{ - "port_filter":true - }, - "mac_address":"fa:16:3e:2e:7c:8a", - "fixed_ips":[ - - ], - "id":"8fb361d8-bab0-418d-b1b8-7204a230fb06", - "security_groups":[ - "99f465bc-0d7c-4142-8829-7ae0179f2fa8" - ], - "device_id":"" - }, - { - "status":"DOWN", - "binding:host_id":null, - "name":"sample_port_2", - "admin_state_up":false, - "network_id":"a3775a7d-9f8b-4148-be81-c84bbd0837ce", - "tenant_id":"60cd4f6dbc2f491982a284e7b83b5be3", - "binding:vif_type":"ovs", - "device_owner":"", - "binding:capabilities":{ - "port_filter":true - }, - "mac_address":"fa:16:3e:0a:4e:13", - "fixed_ips":[ - - ], - "id":"d4c93b0b-f593-424e-a199-d648478a5a3c", - "security_groups":[ - "99f465bc-0d7c-4142-8829-7ae0179f2fa8" - ], - "device_id":"" - } - ] -} - diff --git a/v2.0/samples/ports-create-bulk-resp.xml b/v2.0/samples/ports-create-bulk-resp.xml deleted file mode 100644 index 0b806ce..0000000 --- a/v2.0/samples/ports-create-bulk-resp.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - DOWN - - test_port_1 - True - a3775a7d-9f8b-4148-be81-c84bbd0837ce - 60cd4f6dbc2f491982a284e7b83b5be3 - ovs - - - True - - fa:16:3e:c9:8d:cf - - 7f0aa3f1-883a-43b2-8d1b-e85fac52b417 - - 99f465bc-0d7c-4142-8829-7ae0179f2fa8 - - - - - DOWN - - test_port_2 - True - a3775a7d-9f8b-4148-be81-c84bbd0837ce - 60cd4f6dbc2f491982a284e7b83b5be3 - ovs - - - True - - fa:16:3e:79:90:81 - - a4a81484-c1c4-4b2b-95bc-f8c4484241d0 - - 99f465bc-0d7c-4142-8829-7ae0179f2fa8 - - - - diff --git a/v2.0/samples/ports-get-detail-res.json b/v2.0/samples/ports-get-detail-res.json deleted file mode 100644 index c2377de..0000000 --- a/v2.0/samples/ports-get-detail-res.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "ports": [ - { - "id": "98017ddc-efc8-4c25-a915-774b2a633855", - "state": "ACTIVE" - }, - { - "id": "b832be00-6553-4f69-af33-acd554e36d08", - "state": "ACTIVE" - } - ] -} diff --git a/v2.0/samples/ports-get-detail-res.xml b/v2.0/samples/ports-get-detail-res.xml deleted file mode 100644 index 605b98d..0000000 --- a/v2.0/samples/ports-get-detail-res.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - diff --git a/v2.0/samples/ports-get-res-prov.json b/v2.0/samples/ports-get-res-prov.json deleted file mode 100644 index 4ae31f2..0000000 --- a/v2.0/samples/ports-get-res-prov.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "networks": [ - { - "status": "ACTIVE", - "subnets": [], - "name": "network-1", - "admin_state_up": true, - "tenant_id": "c1210485b2424d48804aad5d39c61b8f", - "id": "3a06dfc7-d239-4aad-9a57-21cd171c72e5", - "shared": false, - "provider:network_type": "vlan", - "provider:physical_network": "physnet_1", - "provider:segmentation_id": 101 - }, - { - "status": "ACTIVE", - "subnets": [], - "name": "network-2", - "admin_state_up": true, - "tenant_id": "c1210485b2424d48804aad5d39c61b8f", - "id": "7db8c5a4-6eb0-478d-856b-7cfda2b25e13", - "shared": false, - "provider:network_type": "local", - "provider:physical_network": null, - "provider:segmentation_id": null - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/ports-get-res-prov.xml b/v2.0/samples/ports-get-res-prov.xml deleted file mode 100644 index a27d98e..0000000 --- a/v2.0/samples/ports-get-res-prov.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - ACTIVE - network-1 - True - c1210485b2424d48804aad5d39c61b8f - False - 3a06dfc7-d239-4aad-9a57-21cd171c72e5 - vlan - physnet_1 - 101 - - - ACTIVE - network-2 - True - c1210485b2424d48804aad5d39c61b8f - False - 7db8c5a4-6eb0-478d-856b-7cfda2b25e13 - local - - - - - diff --git a/v2.0/samples/ports-get-res.json b/v2.0/samples/ports-get-res.json deleted file mode 100644 index 71e7108..0000000 --- a/v2.0/samples/ports-get-res.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "ports":[ - { - "admin_state_up":true, - "device_id":"", - "device_owner":"", - "fixed_ips":[ - { - "ip_address":"10.0.0.4", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"358c03ee-20f8-40d2-b74b-9b21a9df10a7", - "mac_address":"fa:16:3e:ac:95:a9", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "85cc3048-abc3-43cc-89b3-377341426ac5" - ], - "status":"DOWN", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "admin_state_up":true, - "device_id":"", - "device_owner":"", - "fixed_ips":[ - { - "ip_address":"10.0.0.6", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"74ec4d1d-27e8-4461-9257-8fc153288b19", - "mac_address":"fa:16:3e:a8:94:2a", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "85cc3048-abc3-43cc-89b3-377341426ac5" - ], - "status":"DOWN", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "admin_state_up":true, - "device_id":"d6f00d75-c6ef-45a6-bf26-94b9844f8a64", - "device_owner":"network:router_interface", - "fixed_ips":[ - { - "ip_address":"10.0.0.1", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"88a5b3ee-4625-4b16-b513-62581294f281", - "mac_address":"fa:16:3e:33:4c:d2", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - - ], - "status":"ACTIVE", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "admin_state_up":true, - "device_id":"24df1d04-d5cb-41e1-8de5-61ed77c558df", - "device_owner":"compute:None", - "fixed_ips":[ - { - "ip_address":"10.0.0.3", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"a5d9a8e4-a4f3-41f0-b5dc-f0ec0562cbe9", - "mac_address":"fa:16:3e:b6:da:54", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - - ], - "status":"ACTIVE", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "admin_state_up":true, - "device_id":"dhcpacb6d6f0-2d56-5c7a-9905-4c3a3d168f49-abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "device_owner":"network:dhcp", - "fixed_ips":[ - { - "ip_address":"10.0.0.2", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"adf92676-97a8-4ada-b6e8-4fa7195b5eb3", - "mac_address":"fa:16:3e:a9:34:c3", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "49258a30-81f9-44d7-9440-c60dba50e29e" - ], - "status":"ACTIVE", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "admin_state_up":true, - "device_id":"", - "device_owner":"", - "fixed_ips":[ - { - "ip_address":"10.0.0.5", - "subnet_id":"3b498f11-0a20-43ed-b992-0e4202d5f930" - } - ], - "id":"c81cf7ff-1ba1-403a-bddb-58aa0aecd92c", - "mac_address":"fa:16:3e:9c:11:3c", - "name":"", - "network_id":"abaf2e70-4305-4e8d-ac70-3e4cc5f66a07", - "security_groups":[ - "85cc3048-abc3-43cc-89b3-377341426ac5" - ], - "status":"DOWN", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/ports-get-res.xml b/v2.0/samples/ports-get-res.xml deleted file mode 100644 index 73ac5a3..0000000 --- a/v2.0/samples/ports-get-res.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - diff --git a/v2.0/samples/ports-get-resp.json b/v2.0/samples/ports-get-resp.json deleted file mode 100644 index dc2dde2..0000000 --- a/v2.0/samples/ports-get-resp.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "ports":[ - { - "status":"ACTIVE", - "name":"", - "admin_state_up":true, - "network_id":"ebda9658-093b-41ba-80ce-0cf8cb8365d4", - "tenant_id":"63878e4c5dd649d2a980e37aefddfa87", - "binding:vif_type":"ovs", - "device_owner":"compute:None", - "binding:capabilities":{ - "port_filter":false - }, - "mac_address":"fa:16:3e:b9:ef:05", - "fixed_ips":[ - { - "subnet_id":"aca4d43c-c48c-4a2c-9bb6-ba374ef7e135", - "ip_address":"172.24.4.227" - } - ], - "id":"664ebd1a-facd-4c20-948c-07a784475ab0", - "device_id":"f288bb5f-920d-4276-8345-2c0319c16f58" - }, - { - "status":"DOWN", - "name":"", - "admin_state_up":true, - "network_id":"ebda9658-093b-41ba-80ce-0cf8cb8365d4", - "tenant_id":"", - "binding:vif_type":"ovs", - "device_owner":"network:router_gateway", - "binding:capabilities":{ - "port_filter":false - }, - "mac_address":"fa:16:3e:4a:3a:a2", - "fixed_ips":[ - { - "subnet_id":"aca4d43c-c48c-4a2c-9bb6-ba374ef7e135", - "ip_address":"172.24.4.226" - } - ], - "id":"c5ca7017-c390-4ccc-8cd7-333747e57fef", - "device_id":"0dc517bf-9169-4aa6-88b7-569219962881" - }, - { - "status":"ACTIVE", - "name":"", - "admin_state_up":true, - "network_id":"9d83c053-b0a4-4682-ae80-c00df269ce0a", - "tenant_id":"625887121e364204873d362b553ab171", - "binding:vif_type":"ovs", - "device_owner":"network:router_interface", - "binding:capabilities":{ - "port_filter":false - }, - "mac_address":"fa:16:3e:2d:dc:7e", - "fixed_ips":[ - { - "subnet_id":"a318fcb4-9ff0-4485-b78c-9e6738c21b26", - "ip_address":"10.0.0.1" - } - ], - "id":"d7815f5b-a228-47bb-a5e5-f139c4e476f6", - "device_id":"0dc517bf-9169-4aa6-88b7-569219962881" - }, - { - "status":"ACTIVE", - "name":"", - "admin_state_up":true, - "network_id":"9d83c053-b0a4-4682-ae80-c00df269ce0a", - "tenant_id":"625887121e364204873d362b553ab171", - "binding:vif_type":"ovs", - "device_owner":"network:dhcp", - "binding:capabilities":{ - "port_filter":false - }, - "mac_address":"fa:16:3e:73:6d:1c", - "fixed_ips":[ - { - "subnet_id":"a318fcb4-9ff0-4485-b78c-9e6738c21b26", - "ip_address":"10.0.0.2" - } - ], - "id":"f8639521-fab2-4879-94b2-83a47bee8a26", - "device_id":"dhcpe1b8334f-9be9-5e49-aeee-b31e6df6c847-9d83c053-b0a4-4682-ae80-c00df269ce0a" - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/ports-get-resp.xml b/v2.0/samples/ports-get-resp.xml deleted file mode 100644 index faa9cbf..0000000 --- a/v2.0/samples/ports-get-resp.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - ACTIVE - - True - ebda9658-093b-41ba-80ce-0cf8cb8365d4 - 63878e4c5dd649d2a980e37aefddfa87 - ovs - compute:None - - False - - fa:16:3e:b9:ef:05 - - - aca4d43c-c48c-4a2c-9bb6-ba374ef7e135 - 172.24.4.227 - - - 664ebd1a-facd-4c20-948c-07a784475ab0 - f288bb5f-920d-4276-8345-2c0319c16f58 - - - DOWN - - True - ebda9658-093b-41ba-80ce-0cf8cb8365d4 - - ovs - network:router_gateway - - False - - fa:16:3e:4a:3a:a2 - - - aca4d43c-c48c-4a2c-9bb6-ba374ef7e135 - 172.24.4.226 - - - c5ca7017-c390-4ccc-8cd7-333747e57fef - 0dc517bf-9169-4aa6-88b7-569219962881 - - - ACTIVE - - True - 9d83c053-b0a4-4682-ae80-c00df269ce0a - 625887121e364204873d362b553ab171 - ovs - network:router_interface - - False - - fa:16:3e:2d:dc:7e - - - a318fcb4-9ff0-4485-b78c-9e6738c21b26 - 10.0.0.1 - - - d7815f5b-a228-47bb-a5e5-f139c4e476f6 - 0dc517bf-9169-4aa6-88b7-569219962881 - - - ACTIVE - - True - 9d83c053-b0a4-4682-ae80-c00df269ce0a - 625887121e364204873d362b553ab171 - ovs - network:dhcp - - False - - fa:16:3e:73:6d:1c - - - a318fcb4-9ff0-4485-b78c-9e6738c21b26 - 10.0.0.2 - - - f8639521-fab2-4879-94b2-83a47bee8a26 - dhcpe1b8334f-9be9-5e49-aeee-b31e6df6c847-9d83c053-b0a4-4682-ae80-c00df269ce0a - - diff --git a/v2.0/samples/ports-post-create-bulk-req.json b/v2.0/samples/ports-post-create-bulk-req.json deleted file mode 100644 index 0be6798..0000000 --- a/v2.0/samples/ports-post-create-bulk-req.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "ports":[ - { - "name":"sample_port_1", - "admin_state_up":false, - "network_id":"a3775a7d-9f8b-4148-be81-c84bbd0837ce" - }, - { - "name":"sample_port_2", - "admin_state_up":false, - "network_id":"a3775a7d-9f8b-4148-be81-c84bbd0837ce" - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/ports-post-create-bulk-req.xml b/v2.0/samples/ports-post-create-bulk-req.xml deleted file mode 100644 index 7b93e74..0000000 --- a/v2.0/samples/ports-post-create-bulk-req.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - test_port_1 - a3775a7d-9f8b-4148-be81-c84bbd0837ce - - - test_port_2 - a3775a7d-9f8b-4148-be81-c84bbd0837ce - - diff --git a/v2.0/samples/ports-post-req-prov.json b/v2.0/samples/ports-post-req-prov.json deleted file mode 100644 index 373a9e5..0000000 --- a/v2.0/samples/ports-post-req-prov.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "network": - { - "name": "net-name", - "admin_state_up": true, - "provider:network_type": "vlan", - "provider:physical_network": "physnet_1", - "provider:segmentation_id": 201 - } -} - diff --git a/v2.0/samples/ports-post-req-prov.xml b/v2.0/samples/ports-post-req-prov.xml deleted file mode 100644 index 7b4aa88..0000000 --- a/v2.0/samples/ports-post-req-prov.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - net-name - True - vlan - physnet_1 - 201 - - diff --git a/v2.0/samples/ports-put-req-prov.json b/v2.0/samples/ports-put-req-prov.json deleted file mode 100644 index c515329..0000000 --- a/v2.0/samples/ports-put-req-prov.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "network":{ - "provider:network_type":"flat", - "provider:physical_network":"physnet_1", - "provider:segmentation_id":null - } -} \ No newline at end of file diff --git a/v2.0/samples/ports-put-req-prov.xml b/v2.0/samples/ports-put-req-prov.xml deleted file mode 100644 index 25f3fd4..0000000 --- a/v2.0/samples/ports-put-req-prov.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - flat - physnet_1 - - diff --git a/v2.0/samples/ports-show-res-prov.json b/v2.0/samples/ports-show-res-prov.json deleted file mode 100644 index b8b45f1..0000000 --- a/v2.0/samples/ports-show-res-prov.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "network": - { - "status": "ACTIVE", - "subnets": [], - "name": "network-1", - "admin_state_up": true, - "tenant_id": "c1210485b2424d48804aad5d39c61b8f", - "id": "3a06dfc7-d239-4aad-9a57-21cd171c72e5", - "shared": false, - "provider:network_type": "vlan", - "provider:physical_network": "physnet_1", - "provider:segmentation_id": 101 - } -} \ No newline at end of file diff --git a/v2.0/samples/ports-show-res-prov.xml b/v2.0/samples/ports-show-res-prov.xml deleted file mode 100644 index 91560bb..0000000 --- a/v2.0/samples/ports-show-res-prov.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - ACTIVE - network-1 - True - c1210485b2424d48804aad5d39c61b8f - False - 3a06dfc7-d239-4aad-9a57-21cd171c72e5 - vlan - physnet_1 - 101 - - diff --git a/v2.0/samples/private.json b/v2.0/samples/private.json deleted file mode 100644 index 6719176..0000000 --- a/v2.0/samples/private.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "network": { - "id" : "private", - "ip" : [ - {"version" : 4, "addr" : "10.176.42.16"}, - {"version" : 6, "addr" : "::babe:10.176.42.16"} - ] - } -} diff --git a/v2.0/samples/private.xml b/v2.0/samples/private.xml deleted file mode 100644 index 7c457b5..0000000 --- a/v2.0/samples/private.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - diff --git a/v2.0/samples/networks-get-res-prov.json b/v2.0/samples/provider/networks-get-res-prov.json similarity index 100% rename from v2.0/samples/networks-get-res-prov.json rename to v2.0/samples/provider/networks-get-res-prov.json diff --git a/v2.0/samples/networks-get-res-prov.xml b/v2.0/samples/provider/networks-get-res-prov.xml similarity index 100% rename from v2.0/samples/networks-get-res-prov.xml rename to v2.0/samples/provider/networks-get-res-prov.xml diff --git a/v2.0/samples/networks-post-req-prov.json b/v2.0/samples/provider/networks-post-req-prov.json similarity index 100% rename from v2.0/samples/networks-post-req-prov.json rename to v2.0/samples/provider/networks-post-req-prov.json diff --git a/v2.0/samples/networks-post-req-prov.xml b/v2.0/samples/provider/networks-post-req-prov.xml similarity index 100% rename from v2.0/samples/networks-post-req-prov.xml rename to v2.0/samples/provider/networks-post-req-prov.xml diff --git a/v2.0/samples/networks-put-req-prov.json b/v2.0/samples/provider/networks-put-req-prov.json similarity index 100% rename from v2.0/samples/networks-put-req-prov.json rename to v2.0/samples/provider/networks-put-req-prov.json diff --git a/v2.0/samples/networks-put-req-prov.xml b/v2.0/samples/provider/networks-put-req-prov.xml similarity index 100% rename from v2.0/samples/networks-put-req-prov.xml rename to v2.0/samples/provider/networks-put-req-prov.xml diff --git a/v2.0/samples/networks-show-res-prov.json b/v2.0/samples/provider/networks-show-res-prov.json similarity index 100% rename from v2.0/samples/networks-show-res-prov.json rename to v2.0/samples/provider/networks-show-res-prov.json diff --git a/v2.0/samples/networks-show-res-prov.xml b/v2.0/samples/provider/networks-show-res-prov.xml similarity index 100% rename from v2.0/samples/networks-show-res-prov.xml rename to v2.0/samples/provider/networks-show-res-prov.xml diff --git a/v2.0/samples/public.json b/v2.0/samples/public.json deleted file mode 100644 index 0509ba7..0000000 --- a/v2.0/samples/public.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "network": { - "id" : "public", - "ip" : [ - {"version" : 4, "addr" : "67.23.10.132"}, - {"version" : 6, "addr" : "::babe:67.23.10.132"}, - {"version" : 4, "addr" : "67.23.10.131"}, - {"version" : 6, "addr" : "::babe:4317:0A83"} - ] - } -} diff --git a/v2.0/samples/public.xml b/v2.0/samples/public.xml deleted file mode 100644 index e56d8d7..0000000 --- a/v2.0/samples/public.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - diff --git a/v2.0/samples/quotas-list-res.json b/v2.0/samples/quotas-list-res.json deleted file mode 100644 index 4e4f15f..0000000 --- a/v2.0/samples/quotas-list-res.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "quotas": [{ - "subnet": 10, - "network": 10, - "floatingip": 50, - "tenant_id": "b7445f221cda4f4a8ac7db6b218b1339", - "router": 10, - "port": 30 - }] -} \ No newline at end of file diff --git a/v2.0/samples/quotas-put-req.json b/v2.0/samples/quotas-put-req.json deleted file mode 100644 index c7e298e..0000000 --- a/v2.0/samples/quotas-put-req.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "quota": { - "subnet": 40, - "router": 50, - "network": 10, - "floatingip": 30, - "port": 30 - } -} \ No newline at end of file diff --git a/v2.0/samples/quotas-put-res.json b/v2.0/samples/quotas-put-res.json deleted file mode 100644 index 38d6b35..0000000 --- a/v2.0/samples/quotas-put-res.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "quota": { - "subnet": 40, - "router": 50, - "port": 30, - "network": 10, - "floatingip": 30 - } -} \ No newline at end of file diff --git a/v2.0/samples/quotas-show-res.json b/v2.0/samples/quotas-show-res.json deleted file mode 100644 index 7579982..0000000 --- a/v2.0/samples/quotas-show-res.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "quota": { - "subnet": 10, - "router": 10, - "port": 50, - "network": 10, - "floatingip": 50 - } -} \ No newline at end of file diff --git a/v2.0/samples/router-port-res.json b/v2.0/samples/router-port-res.json deleted file mode 100644 index 8cce98c..0000000 --- a/v2.0/samples/router-port-res.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "port": - { - "status": "ACTIVE", - "name": "", - "admin_state_up": true, - "network_id": "5307648b-e836-4658-8f1a-ff7536870c64", - "tenant_id": "6b96ff0cb17a4b859e1e575d221683d3", - "device_owner": "network:router_interface", - "mac_address": "fa:16:3e:f7:d1:9c", - "fixed_ips": - [{ - "subnet_id": "a2f1f29d-571b-4533-907f-5803ab96ead1", - "ip_address": "10.1.1.1" - }], - "id": "3a44f4e5-1694-493a-a1fb-393881c673a4", - "device_id": "7177abc4-5ae9-4bb7-b0d4-89e94a4abf3b" - } -} diff --git a/v2.0/samples/routers-get-res.json b/v2.0/samples/routers-get-res.json deleted file mode 100644 index b1f12a1..0000000 --- a/v2.0/samples/routers-get-res.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "routers": - [{ - "status": "ACTIVE", - "external_gateway_info": null, - "name": "second_routers", - "admin_state_up": true, - "tenant_id": "6b96ff0cb17a4b859e1e575d221683d3", - "id": "7177abc4-5ae9-4bb7-b0d4-89e94a4abf3b" - }, - { - "status": "ACTIVE", - "external_gateway_info": - {"network_id": "3c5bcddd-6af9-4e6b-9c3e-c153e521cab8"}, - "name": "router1", - "admin_state_up": true, - "tenant_id": "33a40233088643acb66ff6eb0ebea679", - "id": "a9254bdb-2613-4a13-ac4c-adc581fba50d" - }] -} \ No newline at end of file diff --git a/v2.0/samples/routers-post-req.json b/v2.0/samples/routers-post-req.json deleted file mode 100644 index 2a15827..0000000 --- a/v2.0/samples/routers-post-req.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "router":{ - "name":"another_router", - "admin_state_up":true - } -} \ No newline at end of file diff --git a/v2.0/samples/routers-post-res.json b/v2.0/samples/routers-post-res.json deleted file mode 100644 index e796765..0000000 --- a/v2.0/samples/routers-post-res.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "router": - { - "status": "ACTIVE", - "external_gateway_info": null, - "name": "another_router", - "admin_state_up": true, - "tenant_id": "6b96ff0cb17a4b859e1e575d221683d3", - "id": "8604a0de-7f6b-409a-a47c-a1cc7bc77b2e" - } -} \ No newline at end of file diff --git a/v2.0/samples/routers-put-req.json b/v2.0/samples/routers-put-req.json deleted file mode 100644 index 54796c6..0000000 --- a/v2.0/samples/routers-put-req.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "router":{ - "external_gateway_info":{ - "network_id":"8ca37218-28ff-41cb-9b10-039601ea7e6b" - } - } -} \ No newline at end of file diff --git a/v2.0/samples/routers-put-res.json b/v2.0/samples/routers-put-res.json deleted file mode 100644 index 201cccc..0000000 --- a/v2.0/samples/routers-put-res.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "router": - { - "status": "ACTIVE", - "external_gateway_info": - { - "network_id": "8ca37218-28ff-41cb-9b10-039601ea7e6b" - }, - "name": "another_router", - "admin_state_up": true, - "tenant_id": "6b96ff0cb17a4b859e1e575d221683d3", - "id": "8604a0de-7f6b-409a-a47c-a1cc7bc77b2e" - } -} diff --git a/v2.0/samples/routers-show-res.json b/v2.0/samples/routers-show-res.json deleted file mode 100644 index a3a676b..0000000 --- a/v2.0/samples/routers-show-res.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "router": - { - "status": "ACTIVE", - "external_gateway_info": - { - "network_id": "3c5bcddd-6af9-4e6b-9c3e-c153e521cab8" - }, - "name": "router1", - "admin_state_up": true, - "tenant_id": "33a40233088643acb66ff6eb0ebea679", - "id": "a9254bdb-2613-4a13-ac4c-adc581fba50d" - } -} \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-create-req-json-http.txt b/v2.0/samples/rules-security-groups-create-req-json-http.txt deleted file mode 100644 index 5519eb7..0000000 --- a/v2.0/samples/rules-security-groups-create-req-json-http.txt +++ /dev/null @@ -1,13 +0,0 @@ -POST /v2.0/security-group-rules.json -Accept: application/json -{ - "security_group_rule":{ - "direction":"ingress", - "port_range_min":"80", - "ethertype":"IPv4", - "port_range_max":"80", - "protocol":"tcp", - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "security_group_id":"a7734e61-b545-452d-a3cd-0189cbd9747a" - } -} \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-create-resp.json b/v2.0/samples/rules-security-groups-create-resp.json deleted file mode 100644 index df5d578..0000000 --- a/v2.0/samples/rules-security-groups-create-resp.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "security_group_rule":{ - "direction":"ingress", - "ethertype":"IPv4", - "id":"2bc0accf-312e-429a-956e-e4407625eb62", - "port_range_max":80, - "port_range_min":80, - "protocol":"tcp", - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"a7734e61-b545-452d-a3cd-0189cbd9747a", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-delete-req-json-http.txt b/v2.0/samples/rules-security-groups-delete-req-json-http.txt deleted file mode 100644 index 920073a..0000000 --- a/v2.0/samples/rules-security-groups-delete-req-json-http.txt +++ /dev/null @@ -1,3 +0,0 @@ -DELETE /v2.0/security-group-rules/fc3c327a-b5b5-4cd3-9577-52893289ce08 -Content-Type: application/json -Accept: application/json \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-delete-resp-json-http.txt b/v2.0/samples/rules-security-groups-delete-resp-json-http.txt deleted file mode 100644 index f81fef7..0000000 --- a/v2.0/samples/rules-security-groups-delete-resp-json-http.txt +++ /dev/null @@ -1 +0,0 @@ -status: 204 \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-get-req-json-http.txt b/v2.0/samples/rules-security-groups-get-req-json-http.txt deleted file mode 100644 index fb321ba..0000000 --- a/v2.0/samples/rules-security-groups-get-req-json-http.txt +++ /dev/null @@ -1,2 +0,0 @@ -GET /v2.0/security-group-rules/ 3c0e45ff-adaf-4124-b083-bf390e5482ff -Accept: application/json \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-get-resp.json b/v2.0/samples/rules-security-groups-get-resp.json deleted file mode 100644 index c02ab83..0000000 --- a/v2.0/samples/rules-security-groups-get-resp.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "security_group_rule":{ - "direction":"egress", - "ethertype":"IPv6", - "id":"3c0e45ff-adaf-4124-b083-bf390e5482ff", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-list-get-req-json-http.txt b/v2.0/samples/rules-security-groups-list-get-req-json-http.txt deleted file mode 100644 index a0a7038..0000000 --- a/v2.0/samples/rules-security-groups-list-get-req-json-http.txt +++ /dev/null @@ -1,2 +0,0 @@ -GET /v2.0/security-group-rules/ -Accept: application/json \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-list-get-resp.json b/v2.0/samples/rules-security-groups-list-get-resp.json deleted file mode 100644 index 9255e46..0000000 --- a/v2.0/samples/rules-security-groups-list-get-resp.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "security_group_rules":[ - { - "direction":"egress", - "ethertype":"IPv6", - "id":"3c0e45ff-adaf-4124-b083-bf390e5482ff", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"egress", - "ethertype":"IPv4", - "id":"93aa42e5-80db-4581-9391-3a608bd0e448", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"ingress", - "ethertype":"IPv6", - "id":"c0b09f00-1d49-4e64-a0a7-8a186d928138", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"ingress", - "ethertype":"IPv4", - "id":"f7d45c89-008e-4bab-88ad-d6811724c51c", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-post-req-json-http.txt b/v2.0/samples/rules-security-groups-post-req-json-http.txt deleted file mode 100644 index 5519eb7..0000000 --- a/v2.0/samples/rules-security-groups-post-req-json-http.txt +++ /dev/null @@ -1,13 +0,0 @@ -POST /v2.0/security-group-rules.json -Accept: application/json -{ - "security_group_rule":{ - "direction":"ingress", - "port_range_min":"80", - "ethertype":"IPv4", - "port_range_max":"80", - "protocol":"tcp", - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "security_group_id":"a7734e61-b545-452d-a3cd-0189cbd9747a" - } -} \ No newline at end of file diff --git a/v2.0/samples/rules-security-groups-post-resp.json b/v2.0/samples/rules-security-groups-post-resp.json deleted file mode 100644 index df5d578..0000000 --- a/v2.0/samples/rules-security-groups-post-resp.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "security_group_rule":{ - "direction":"ingress", - "ethertype":"IPv4", - "id":"2bc0accf-312e-429a-956e-e4407625eb62", - "port_range_max":80, - "port_range_min":80, - "protocol":"tcp", - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"a7734e61-b545-452d-a3cd-0189cbd9747a", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} \ No newline at end of file diff --git a/v2.0/samples/sche-dhcp-list-res.json b/v2.0/samples/scheduler/sche-dhcp-list-res.json similarity index 100% rename from v2.0/samples/sche-dhcp-list-res.json rename to v2.0/samples/scheduler/sche-dhcp-list-res.json diff --git a/v2.0/samples/sche-l3-list-res.json b/v2.0/samples/scheduler/sche-l3-list-res.json similarity index 100% rename from v2.0/samples/sche-l3-list-res.json rename to v2.0/samples/scheduler/sche-l3-list-res.json diff --git a/v2.0/samples/sche-lbaas-agent-list-res.json b/v2.0/samples/scheduler/sche-lbaas-agent-list-res.json similarity index 100% rename from v2.0/samples/sche-lbaas-agent-list-res.json rename to v2.0/samples/scheduler/sche-lbaas-agent-list-res.json diff --git a/v2.0/samples/sche-network-dhcp-req.json b/v2.0/samples/scheduler/sche-network-dhcp-req.json similarity index 100% rename from v2.0/samples/sche-network-dhcp-req.json rename to v2.0/samples/scheduler/sche-network-dhcp-req.json diff --git a/v2.0/samples/sche-network-dhcp-res-json-http.txt b/v2.0/samples/scheduler/sche-network-dhcp-res-json-http.txt similarity index 100% rename from v2.0/samples/sche-network-dhcp-res-json-http.txt rename to v2.0/samples/scheduler/sche-network-dhcp-res-json-http.txt diff --git a/v2.0/samples/sche-network-list-res.json b/v2.0/samples/scheduler/sche-network-list-res.json similarity index 100% rename from v2.0/samples/sche-network-list-res.json rename to v2.0/samples/scheduler/sche-network-list-res.json diff --git a/v2.0/samples/sche-pool-list-res.json b/v2.0/samples/scheduler/sche-pool-list-res.json similarity index 100% rename from v2.0/samples/sche-pool-list-res.json rename to v2.0/samples/scheduler/sche-pool-list-res.json diff --git a/v2.0/samples/sche-router-l3-req.json b/v2.0/samples/scheduler/sche-router-l3-req.json similarity index 100% rename from v2.0/samples/sche-router-l3-req.json rename to v2.0/samples/scheduler/sche-router-l3-req.json diff --git a/v2.0/samples/sche-router-l3-res-json-http.txt b/v2.0/samples/scheduler/sche-router-l3-res-json-http.txt similarity index 100% rename from v2.0/samples/sche-router-l3-res-json-http.txt rename to v2.0/samples/scheduler/sche-router-l3-res-json-http.txt diff --git a/v2.0/samples/sche-router-list-res.json b/v2.0/samples/scheduler/sche-router-list-res.json similarity index 100% rename from v2.0/samples/sche-router-list-res.json rename to v2.0/samples/scheduler/sche-router-list-res.json diff --git a/v2.0/samples/security-group-post-req-json-http.txt b/v2.0/samples/security-group-post-req-json-http.txt deleted file mode 100644 index 1772e92..0000000 --- a/v2.0/samples/security-group-post-req-json-http.txt +++ /dev/null @@ -1,8 +0,0 @@ -POST /v2.0/security-groups.json -Accept: application/json -{ - "security_group":{ - "name":"new-webservers", - "description":"security group for webservers" - } -} \ No newline at end of file diff --git a/v2.0/samples/security-groups-create-req.json b/v2.0/samples/security-groups-create-req.json deleted file mode 100644 index f91c13a..0000000 --- a/v2.0/samples/security-groups-create-req.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "security_group":{ - "name":"new-webservers", - "description":"security group for webservers" - } -} \ No newline at end of file diff --git a/v2.0/samples/security-groups-create-resp.json b/v2.0/samples/security-groups-create-resp.json deleted file mode 100644 index 44ba661..0000000 --- a/v2.0/samples/security-groups-create-resp.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "security_group":{ - "description":"security group for webservers", - "id":"2076db17-a522-4506-91de-c6dd8e837028", - "name":"new-webservers", - "security_group_rules":[ - { - "direction":"egress", - "ethertype":"IPv4", - "id":"38ce2d8e-e8f1-48bd-83c2-d33cb9f50c3d", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"2076db17-a522-4506-91de-c6dd8e837028", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"egress", - "ethertype":"IPv6", - "id":"565b9502-12de-4ffd-91e9-68885cff6ae1", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"2076db17-a522-4506-91de-c6dd8e837028", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } - ], - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} \ No newline at end of file diff --git a/v2.0/samples/security-groups-delete-req-json-http.txt b/v2.0/samples/security-groups-delete-req-json-http.txt deleted file mode 100644 index fa14410..0000000 --- a/v2.0/samples/security-groups-delete-req-json-http.txt +++ /dev/null @@ -1,3 +0,0 @@ -DELETE /v2.0/security-groups/e470bdfc-4869-459b-a561-cb3377efae59 -Content-Type: application/json -Accept: application/json \ No newline at end of file diff --git a/v2.0/samples/security-groups-delete-resp-json-http.txt b/v2.0/samples/security-groups-delete-resp-json-http.txt deleted file mode 100644 index f81fef7..0000000 --- a/v2.0/samples/security-groups-delete-resp-json-http.txt +++ /dev/null @@ -1 +0,0 @@ -status: 204 \ No newline at end of file diff --git a/v2.0/samples/security-groups-get-req-json-http.txt b/v2.0/samples/security-groups-get-req-json-http.txt deleted file mode 100644 index 56592f3..0000000 --- a/v2.0/samples/security-groups-get-req-json-http.txt +++ /dev/null @@ -1,2 +0,0 @@ -GET /v2.0/security-groups/85cc3048-abc3-43cc-89b3-377341426ac5 -Accept: application/json \ No newline at end of file diff --git a/v2.0/samples/security-groups-get-resp.json b/v2.0/samples/security-groups-get-resp.json deleted file mode 100644 index a2156d8..0000000 --- a/v2.0/samples/security-groups-get-resp.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "security_group":{ - "description":"default", - "id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "name":"default", - "security_group_rules":[ - { - "direction":"egress", - "ethertype":"IPv6", - "id":"3c0e45ff-adaf-4124-b083-bf390e5482ff", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"egress", - "ethertype":"IPv4", - "id":"93aa42e5-80db-4581-9391-3a608bd0e448", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"ingress", - "ethertype":"IPv6", - "id":"c0b09f00-1d49-4e64-a0a7-8a186d928138", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"ingress", - "ethertype":"IPv4", - "id":"f7d45c89-008e-4bab-88ad-d6811724c51c", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } - ], - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } -} \ No newline at end of file diff --git a/v2.0/samples/security-groups-list-get-req-json-http.txt b/v2.0/samples/security-groups-list-get-req-json-http.txt deleted file mode 100644 index aa84978..0000000 --- a/v2.0/samples/security-groups-list-get-req-json-http.txt +++ /dev/null @@ -1,2 +0,0 @@ -GET /v2.0/security-groups -Accept: application/json \ No newline at end of file diff --git a/v2.0/samples/security-groups-list-get-resp.json b/v2.0/samples/security-groups-list-get-resp.json deleted file mode 100644 index 942ea4b..0000000 --- a/v2.0/samples/security-groups-list-get-resp.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "security_groups":[ - { - "description":"default", - "id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "name":"default", - "security_group_rules":[ - { - "direction":"egress", - "ethertype":"IPv6", - "id":"3c0e45ff-adaf-4124-b083-bf390e5482ff", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"egress", - "ethertype":"IPv4", - "id":"93aa42e5-80db-4581-9391-3a608bd0e448", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":null, - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"ingress", - "ethertype":"IPv6", - "id":"c0b09f00-1d49-4e64-a0a7-8a186d928138", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - }, - { - "direction":"ingress", - "ethertype":"IPv4", - "id":"f7d45c89-008e-4bab-88ad-d6811724c51c", - "port_range_max":null, - "port_range_min":null, - "protocol":null, - "remote_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix":null, - "security_group_id":"85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } - ], - "tenant_id":"e4f50856753b4dc6afee5fa6b9b6c550" - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/subnet-get-detail-res.json b/v2.0/samples/subnet-get-detail-res.json deleted file mode 100644 index 7c26f13..0000000 --- a/v2.0/samples/subnet-get-detail-res.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "port":{ - "state":"DOWN", - "id":"98017ddc-efc8-4c25-a915-774b2a633855", - "attachment":{ - "id":"test_interface_identifier" - } - } -} diff --git a/v2.0/samples/subnet-get-detail-res.xml b/v2.0/samples/subnet-get-detail-res.xml deleted file mode 100644 index d0dbce8..0000000 --- a/v2.0/samples/subnet-get-detail-res.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - diff --git a/v2.0/samples/subnet-get-res.json b/v2.0/samples/subnet-get-res.json deleted file mode 100644 index 8ded3d2..0000000 --- a/v2.0/samples/subnet-get-res.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "port": - { - "state": "DOWN", - "id": "98017ddc-efc8-4c25-a915-774b2a633855" - } -} - diff --git a/v2.0/samples/subnet-get-res.xml b/v2.0/samples/subnet-get-res.xml deleted file mode 100644 index 622f397..0000000 --- a/v2.0/samples/subnet-get-res.xml +++ /dev/null @@ -1,3 +0,0 @@ - \ No newline at end of file diff --git a/v2.0/samples/subnet-post-req-bulk.json b/v2.0/samples/subnet-post-req-bulk.json deleted file mode 100644 index 0bb8460..0000000 --- a/v2.0/samples/subnet-post-req-bulk.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "subnets": [ - { - "cidr": "192.168.199.0/24", - "ip_version": 4, - "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406" - }, - { - "cidr": "10.56.4.0/22", - "ip_version": 4, - "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa" - } - ] -} diff --git a/v2.0/samples/subnet-post-req.json b/v2.0/samples/subnet-post-req.json deleted file mode 100644 index 29e88fa..0000000 --- a/v2.0/samples/subnet-post-req.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "subnet":{ - "name":"", - "network_id":"ed2e3c10-2e43-4297-9006-2863a2d1abbc", - "tenant_id":"c1210485b2424d48804aad5d39c61b8f", - "allocation_pools":[ - { - "start":"10.0.3.20", - "end":"10.0.3.150" - } - ], - "gateway_ip":"10.0.3.1", - "ip_version":4, - "cidr":"10.0.3.0/24", - "id":"9436e561-47bf-436a-b1f1-fe23a926e031", - "enable_dhcp":true - } -} \ No newline at end of file diff --git a/v2.0/samples/subnet-post-req.xml b/v2.0/samples/subnet-post-req.xml deleted file mode 100644 index 4f8c1f6..0000000 --- a/v2.0/samples/subnet-post-req.xml +++ /dev/null @@ -1,2 +0,0 @@ - diff --git a/v2.0/samples/subnet-post-res-bulk.json b/v2.0/samples/subnet-post-res-bulk.json deleted file mode 100644 index f9f7ea9..0000000 --- a/v2.0/samples/subnet-post-res-bulk.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "subnets": [ - { - "allocation_pools": [ - { - "end": "192.168.199.254", - "start": "192.168.199.2" - } - ], - "cidr": "192.168.199.0/24", - "dns_nameservers": [], - "enable_dhcp": true, - "gateway_ip": "192.168.199.1", - "host_routes": [], - "id": "0468a7a7-290d-4127-aedd-6c9449775a24", - "ip_version": 4, - "name": "", - "network_id": "e6031bc2-901a-4c66-82da-f4c32ed89406", - "tenant_id": "d19231fc08ec4bc4829b668040d34512" - }, - { - "allocation_pools": [ - { - "end": "10.56.7.254", - "start": "10.56.4.2" - } - ], - "cidr": "10.56.4.0/22", - "dns_nameservers": [], - "enable_dhcp": true, - "gateway_ip": "10.56.4.1", - "host_routes": [], - "id": "b0e7435c-1512-45fb-aa9e-9a7c5932fb30", - "ip_version": 4, - "name": "", - "network_id": "64239a54-dcc4-4b39-920b-b37c2144effa", - "tenant_id": "d19231fc08ec4bc4829b668040d34512" - } - ] -} diff --git a/v2.0/samples/subnet-post-res.json b/v2.0/samples/subnet-post-res.json deleted file mode 100644 index 512b96c..0000000 --- a/v2.0/samples/subnet-post-res.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "subnet":{ - "allocation_pools":[ - { - "end":"10.0.3.254", - "start":"10.0.3.2" - } - ], - "cidr":"10.0.3.0/24", - "dns_nameservers":[ - - ], - "enable_dhcp":true, - "gateway_ip":"10.0.3.1", - "host_routes":[ - - ], - "id":"91e47a57-7508-46fe-afc9-fc454e8580e1", - "ip_version":4, - "name":"sample_subnet", - "network_id":"1a6f6006-9e0b-4f99-984c-96787ae66363", - "tenant_id":"f667b69e4d6749749ef3bcba7251d9ce" - } -} diff --git a/v2.0/samples/subnet-post-res.xml b/v2.0/samples/subnet-post-res.xml deleted file mode 100644 index f1564b8..0000000 --- a/v2.0/samples/subnet-post-res.xml +++ /dev/null @@ -1,2 +0,0 @@ - diff --git a/v2.0/samples/subnets-create-bulk-resp.json b/v2.0/samples/subnets-create-bulk-resp.json deleted file mode 100644 index 70086c8..0000000 --- a/v2.0/samples/subnets-create-bulk-resp.json +++ /dev/null @@ -1,28 +0,0 @@ -{ -"subnets": [ -{ -"name": "sample_subnet_1", -"enable_dhcp": true, -"network_id": "a3775a7d-9f8b-4148-be81-c84bbd0837ce", -"tenant_id": "60cd4f6dbc2f491982a284e7b83b5be3", -"dns_nameservers": [], -"allocation_pools":[{"start": "10.100.0.2", "end": "10.100.255.254"}], -"host_routes": [], -"ip_version": 4, -"gateway_ip": "10.100.0.1", -"cidr": "10.100.0.0/16", -"id": "70ffbaeb-4b43-4605-abe6-4c5bdbb8236b" -}, -{ -"name": "sample_subnet_2", -"enable_dhcp": true, -"network_id": "a3775a7d-9f8b-4148-be81-c84bbd0837ce", -"tenant_id": "60cd4f6dbc2f491982a284e7b83b5be3", -"dns_nameservers": [], -"allocation_pools": [{"start": "172.16.0.2", "end": "172.31.255.254"}], -"host_routes": [], -"ip_version": 4, -"gateway_ip": "172.16.0.1", -"cidr": "172.16.0.0/12", -"id": "d849e3fc-557d-4b27-8f1c-aceca1daa410"}] -} diff --git a/v2.0/samples/subnets-create-bulk-resp.xml b/v2.0/samples/subnets-create-bulk-resp.xml deleted file mode 100644 index fec5e87..0000000 --- a/v2.0/samples/subnets-create-bulk-resp.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - test_subnet_1 - True - a3775a7d-9f8b-4148-be81-c84bbd0837ce - 60cd4f6dbc2f491982a284e7b83b5be3 - - - - 10.0.0.2 - 10.255.255.254 - - - - 4 - 10.0.0.1 - 10.0.0.0/8 - bd3fd365-fe19-431a-be63-07017a09316c - - - test_subnet_2 - True - a3775a7d-9f8b-4148-be81-c84bbd0837ce - 60cd4f6dbc2f491982a284e7b83b5be3 - - - - 192.168.0.2 - 192.168.255.254 - - - - 4 - 192.168.0.1 - 192.168.0.0/16 - 86e7c838-fb75-402b-9dbf-d68166e3f5fe - - diff --git a/v2.0/samples/subnets-get-detail-res.json b/v2.0/samples/subnets-get-detail-res.json deleted file mode 100644 index e867c95..0000000 --- a/v2.0/samples/subnets-get-detail-res.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "subnet":{ - "name":"", - "network_id":"ed2e3c10-2e43-4297-9006-2863a2d1abbc", - "tenant_id":"c1210485b2424d48804aad5d39c61b8f", - "allocation_pools":[ - { - "start":"10.10.0.2", - "end":"10.10.0.254" - } - ], - "gateway_ip":"10.10.0.1", - "ip_version":4, - "cidr":"10.10.0.0/24", - "id":"4156c7a5-e8c4-4aff-a6e1-8f3c7bc83861", - "enable_dhcp":false - } -} \ No newline at end of file diff --git a/v2.0/samples/subnets-get-detail-res.xml b/v2.0/samples/subnets-get-detail-res.xml deleted file mode 100644 index 605b98d..0000000 --- a/v2.0/samples/subnets-get-detail-res.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - diff --git a/v2.0/samples/subnets-get-res.json b/v2.0/samples/subnets-get-res.json deleted file mode 100644 index 02afcea..0000000 --- a/v2.0/samples/subnets-get-res.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "subnets": [ - { - "allocation_pools": [ - { - "end": "10.0.3.254", - "start": "10.0.3.2" - } - ], - "cidr": "10.0.3.0/24", - "dns_nameservers": [], - "enable_dhcp": true, - "gateway_ip": "10.0.3.1", - "host_routes": [], - "id": "91e47a57-7508-46fe-afc9-fc454e8580e1", - "ip_version": 4, - "name": "", - "network_id": "1a6f6006-9e0b-4f99-984c-96787ae66363", - "tenant_id": "f667b69e4d6749749ef3bcba7251d9ce" - }, - { - "allocation_pools": [ - { - "end": "10.0.2.254", - "start": "10.0.2.2" - } - ], - "cidr": "10.0.2.0/24", - "dns_nameservers": [], - "enable_dhcp": true, - "gateway_ip": "10.0.2.1", - "host_routes": [], - "id": "e3c3620c-9d24-4470-b226-739da2f617c0", - "ip_version": 4, - "name": "", - "network_id": "1a6f6006-9e0b-4f99-984c-96787ae66363", - "tenant_id": "f667b69e4d6749749ef3bcba7251d9ce" - } - ] -} diff --git a/v2.0/samples/subnets-get-res.xml b/v2.0/samples/subnets-get-res.xml deleted file mode 100644 index 73ac5a3..0000000 --- a/v2.0/samples/subnets-get-res.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - diff --git a/v2.0/samples/subnets-get-resp.json b/v2.0/samples/subnets-get-resp.json deleted file mode 100644 index 02afcea..0000000 --- a/v2.0/samples/subnets-get-resp.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "subnets": [ - { - "allocation_pools": [ - { - "end": "10.0.3.254", - "start": "10.0.3.2" - } - ], - "cidr": "10.0.3.0/24", - "dns_nameservers": [], - "enable_dhcp": true, - "gateway_ip": "10.0.3.1", - "host_routes": [], - "id": "91e47a57-7508-46fe-afc9-fc454e8580e1", - "ip_version": 4, - "name": "", - "network_id": "1a6f6006-9e0b-4f99-984c-96787ae66363", - "tenant_id": "f667b69e4d6749749ef3bcba7251d9ce" - }, - { - "allocation_pools": [ - { - "end": "10.0.2.254", - "start": "10.0.2.2" - } - ], - "cidr": "10.0.2.0/24", - "dns_nameservers": [], - "enable_dhcp": true, - "gateway_ip": "10.0.2.1", - "host_routes": [], - "id": "e3c3620c-9d24-4470-b226-739da2f617c0", - "ip_version": 4, - "name": "", - "network_id": "1a6f6006-9e0b-4f99-984c-96787ae66363", - "tenant_id": "f667b69e4d6749749ef3bcba7251d9ce" - } - ] -} diff --git a/v2.0/samples/subnets-post-create-bulk-req.json b/v2.0/samples/subnets-post-create-bulk-req.json deleted file mode 100644 index 5b3165e..0000000 --- a/v2.0/samples/subnets-post-create-bulk-req.json +++ /dev/null @@ -1,14 +0,0 @@ -{ -"subnets": [ -{"name": "sample_subnet_1", -"network_id": "a3775a7d-9f8b-4148-be81-c84bbd0837ce", -"cidr": "10.100.0.0/16", -"ip_version": 4 -}, -{ -"name": "sample_subnet_2", -"network_id": "a3775a7d-9f8b-4148-be81-c84bbd0837ce", -"cidr": "172.16.0.0/12", -"ip_version": 4 -}] -} diff --git a/v2.0/samples/subnets-post-create-bulk-req.xml b/v2.0/samples/subnets-post-create-bulk-req.xml deleted file mode 100644 index fb754c0..0000000 --- a/v2.0/samples/subnets-post-create-bulk-req.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - test_subnet_1 - a3775a7d-9f8b-4148-be81-c84bbd0837ce - 10.0.0.0/8 - 4 - - - test_subnet_2 - a3775a7d-9f8b-4148-be81-c84bbd0837ce - 192.168.0.0/16 - 4 - - diff --git a/v2.0/samples/subnets_get_resp.json b/v2.0/samples/subnets_get_resp.json deleted file mode 100644 index e5aebe8..0000000 --- a/v2.0/samples/subnets_get_resp.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "subnets":[ - { - "name":"", - "network_id":"ed2e3c10-2e43-4297-9006-2863a2d1abbc", - "tenant_id":"c1210485b2424d48804aad5d39c61b8f", - "allocation_pools":[ - { - "start":"10.10.0.2", - "end":"10.10.0.254" - } - ], - "gateway_ip":"10.10.0.1", - "ip_version":4, - "cidr":"10.10.0.0/24", - "id":"4156c7a5-e8c4-4aff-a6e1-8f3c7bc83861", - "enable_dhcp":true - }, - { - "name":"", - "network_id":"afc75773-640e-403c-9fff-62ba98db1f19", - "tenant_id":"ed680f49ff714162ab3612d7876ffce5", - "allocation_pools":[ - { - "start":"10.0.0.2", - "end":"10.0.0.254" - } - ], - "gateway_ip":"10.0.0.1", - "ip_version":4, - "cidr":"10.0.0.0/24", - "id":"e12f0c45-46e3-446a-b207-9474b27687a6", - "enable_dhcp":true - } - ] -} \ No newline at end of file diff --git a/v2.0/samples/versions-atom.xml b/v2.0/samples/versions-atom.xml deleted file mode 100644 index b3f23b0..0000000 --- a/v2.0/samples/versions-atom.xml +++ /dev/null @@ -1,22 +0,0 @@ - - - Available API Versions - 2010-12-12T18:30:02.25Z - http://servers.api.openstack.org/ - Rackspacehttp://www.rackspace.com/ - - - http://servers.api.openstack.org/v1.1/ - Version v1.1 - 2010-12-12T18:30:02.25Z - - Version v1.1 CURRENT (2010-12-12T18:30:02.25Z) - - - http://servers.api.openstack.org/v1.0/ - Version v1.0 - 2009-10-09T11:30:00Z - - Version v1.0 DEPRECATED (2009-10-09T11:30:00Z) - - diff --git a/v2.0/samples/versions.json b/v2.0/samples/versions.json deleted file mode 100644 index 6369642..0000000 --- a/v2.0/samples/versions.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "versions": [ - { - "status": "CURRENT", - "id": "v1.0", - "links": [ - { - "href": "http://127.0.0.1:9696/v1.0", - "rel": "self" - } - ] - }, - { - "status": "FUTURE", - "id": "v1.1", - "links": [ - { - "href": "http://127.0.0.1:9696/v1.1", - "rel": "self" - } - ] - } - ] -} diff --git a/v2.0/samples/versions.xml b/v2.0/samples/versions.xml deleted file mode 100644 index 4785ad4..0000000 --- a/v2.0/samples/versions.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/v2.0/section_neutron-agent-ext.xml b/v2.0/section_neutron-agent-ext.xml deleted file mode 100644 index d6e8406..0000000 --- a/v2.0/section_neutron-agent-ext.xml +++ /dev/null @@ -1,276 +0,0 @@ - - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - '> - -]> -
- The Agent Management Extension - In a typical OpenStack Networking deployment, some agents run on network or compute - nodes, such as neutron-dhcp-agent, neutron-ovs-agent, - and neutron-l3-agent. This extension provides a way for - administrators(enforced by the policy engine) to view their status and update their - attributes. Updating agent management API attributes will affect operations of other - components such as OpenStack Networking schedulers. For instance administrators can disable - a certain agent, and OpenStack Networking schedulers will not schedule resources to - it. - For how to use agent management extension and OpenStack Networking schedulers feature, - see the OpenStack Cloud Administrator Guide. - - - - - - - Verb - URI - Description - - - - - &GET; - /agents - List agents which report their status to OpenStack Networking server. - - - &GET; - /agents/agent_id - Show information of the given agent. - - - &PUT; - /agents/agent_id - Update the agent's admin status and description. - - - &DELETE; - /agents/agent_id - Delete the given agent. - - - - -
- List Agents - - - - - - - Verb - URI - Description - - - - - &GET; - /agents - List agents which report their status to OpenStack Networking server. - - - - Normal Response Code: - 200 - - This operation does not require a request body. - This operation returns a response body. - The default policy behavior is that non-admin user - won't be able to see any agent in the response when this call is invoked - - List Agents: JSON Request - - -GET /v2.0/agents HTTP/1.1 -Host: controlnode:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2 - - - List Agents: JSON Response - - -
- - -
- Show Agent - - - - - - - Verb - URI - Description - - - - - &GET; - /agents/agent_id - Show information of the given agent. - - - - Normal Response Code: - 200 - - Error Response Codes:NotFound - (404) if not authorized or the agent does not exist - This operation returns information for the given agent. - This operation does not require a request - body. - This operation returns a response body. The body contents depend on the agent's type. - - Show Agent: JSON Request - - -GET /v2.0/agents/af4567ad-c2e6-4311-944d-22efc12f89af HTTP/1.1 -Host: controlnode:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: a54d6fdda41341f892150e2aaf648f0d - - - - - Show Agent: JSON Response - - -
- - -
- Update Agent - - - - - - - Verb - URI - Description - - - - - &PUT; - /agents/agent_id - Update the agent's admin status and description. - - - - Normal Response Code: - 200 - - Error Response Codes: BadRequest (400) - if something other than description or admin status is changed, - NotFound (404) if not authorized or the agent does not exist - This operation updates the agent's admin status and description. - This operation requires a request body. - - This operation returns a response body. - - Update Agent: JSON Request - -PUT /v2.0/agents/af4567ad-c2e6-4311-944d-22efc12f89af HTTP/1.1 -Host: controlnode:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: 4cbb09e780434b249ff596d6979fd8fc -Content-Length: 38 - - - - - Update Agents: JSON Response - - -
- -
- Delete Agent - - - - - - - Verb - URI - Description - - - - - &DELETE; - /agents/agent_id - Delete the given agent. - - - - Normal Response Code: - 204 - - Error Response Codes: NotFound - (404) if not authorized or the agent does not exist - This operation deletes the agent. - This operation does not require a request body. - - This operation does not return a response body. - - Delete Agent: JSON Request - -DELETE /v2.0/agents/44002aeb-2817-4cb8-9306-34308b4b40d9 HTTP/1.1 -Host: controlnode:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: 4cbb09e780434b249ff596d6979fd8fc - - - - Delete Agent: JSON Response - - -
-
diff --git a/v2.0/section_neutron-allowed-address-pair-ext.xml b/v2.0/section_neutron-allowed-address-pair-ext.xml deleted file mode 100644 index 7b3734a..0000000 --- a/v2.0/section_neutron-allowed-address-pair-ext.xml +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - - - - '> - - - - - - - - - '> - -]> -
- The Allowed Address Pair Extension - The Allowed Address Pair extension extends the port - attribute to allow one to specify arbitrary - mac_address/ip_address(cidr) pairs that are allowed to pass - through a port regardness of the subnet associated with the - network. - -
- Port API operations with allowed address pair - extension - This section discusses operations for setting and - retrieving the allowed address pair extension attributes - for port objects. -
- List Ports - - - - - - - - Verb - URI - Description - - - - - &GET; - /ports - Returns a list of ports with their - allowed address pair attributes. - - - - - Normal Response Code: 200 OK - Error Response Codes: 401 Unauthorized - This operation returns, for each port, its allowed - address pair attributes as well as all the attributes - normally returned by the list port operation. - - List Ports with allowed address pair - attributes: JSON Response - - - - List Ports with allowed address pair - attributes: XML Response - - -
-
- Show Port - - - - - - - - Verb - URI - Description - - - - - &GET; - /ports/port_id - Returns details about a specific port, - including allowed address pair - attributes. - - - - - Normal Response Code: 200 OK - Error Response Code: 401 Unauthorized, 404 Not - Found - - Show port with allowed address pair attributes: - JSON Response - - - - Show port with allowed address pair attributes: - XML Response - - -
-
- Create Port - - - - - - - - Verb - URI - Description - - - - - &POST; - /ports - Creates a new port and explicitly - specify the allowed address pair - attributes. - - - - - Normal Response Code: 201 - Error Response Code: 400 Bad Request, 401 - Unauthorized, 403 Forbidden - Bad request is returned if an allowed address pair - matches the mac_address and ip_address on port. - Note: If the mac_address field is left out of the - body of the request the mac_address assigned to the - port will be used. - - Create Port with allowed address pair - attributes: JSON Request - - -
-
- Update Port - - - - - - - - Verb - URI - Description - - - - - &PUT; - /ports/port_id - Updates a port, with new allowed - address pair values. - - - - - Normal Response Code: 200 OK - Error Response Code: 400 Bad Request, 401 - Unauthorized, 404 Not Found, 403 Forbidden - - Update allowed address pair attributes for a - port: JSON Request - - -
-
-
diff --git a/v2.0/section_neutron_concepts.xml b/v2.0/section_neutron-concepts.xml similarity index 85% rename from v2.0/section_neutron_concepts.xml rename to v2.0/section_neutron-concepts.xml index 1debc1d..b8e36a1 100644 --- a/v2.0/section_neutron_concepts.xml +++ b/v2.0/section_neutron-concepts.xml @@ -10,19 +10,7 @@ PUT'> POST'> DELETE'> - - - - - '> - - - - - '> - + ]>
Concepts - Use the &APIv2; to manage the following entities: - - Network. An - isolated virtual layer-2 domain. A network can - also be a virtual, or logical, switch. See . - - - Subnet. An IP - version 4 or version 6 address block from which IP - addresses that are assigned to VMs on a specified - network are selected. See . - - - Port. A - virtual, or logical, switch port on a specified - network. See . - - + Use the &APIv2; to manage the following entities: + + + Network. An + isolated virtual layer-2 domain. A network can also be + a virtual, or logical, switch. See . + + + Subnet. An IP + version 4 or version 6 address block from which IP + addresses that are assigned to VMs on a specified + network are selected. See . + + + Port. A virtual, or + logical, switch port on a specified network. See . + + These entities have auto-generated unique identifiers and support basic create, read, update, and delete (CRUD) functions with the &POST;, &GET;, &PUT;, and &DELETE; @@ -73,7 +62,7 @@ The following table describes the attributes for network objects: - + @@ -87,29 +76,29 @@ @@ -155,21 +144,23 @@ @@ -240,29 +231,29 @@ @@ -424,29 +415,29 @@ @@ -502,21 +493,23 @@ diff --git a/v2.0/section_neutron-ext-agent-management.xml b/v2.0/section_neutron-ext-agent-management.xml new file mode 100644 index 0000000..6d5dc56 --- /dev/null +++ b/v2.0/section_neutron-ext-agent-management.xml @@ -0,0 +1,249 @@ + + +GET'> +PUT'> +POST'> +DELETE'> +]> +
+ Agent management + In a typical OpenStack Networking deployment, some agents + run on network or compute nodes, such as + neutron-dhcp-agent, + neutron-ovs-agent, and + neutron-l3-agent. This extension + enables administrators (enforced by the policy engine) to view + status and update attributes for agents. Updating agent + management API attributes affects operations of other + components, such as OpenStack Networking schedulers. For + example, administrators can disable a specified agent so that + OpenStack Networking schedulers do not schedule resources to + it. + For how to use agent management extension and OpenStack + Networking schedulers feature, see the OpenStack + Cloud Administrator Guide. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ List agents + +
+ + + + + + + + + + + + + + + + + + Normal Response Code: 200 + + This operation does not require a request body. + This operation returns a response body. The default + policy behavior is that non-admin user won't be able to + see any agent in the response when this call is + invoked + + List agents: JSON request + GET /v2.0/agents HTTP/1.1 +Host: controlnode:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2 + + + List agents: JSON response + + + +
+ Show agent details + +
+ + + + + + + + + + + + + + + + + + Normal Response Code: 200 + + Error Response Codes:NotFound + (404) if not authorized or the + agent does not exist + This operation returns information for the given + agent. + This operation does not require a request body. + This operation returns a response body. The body + contents depend on the agent's type. + + Show agent details: JSON request + GET /v2.0/agents/af4567ad-c2e6-4311-944d-22efc12f89af HTTP/1.1 +Host: controlnode:9696 +User-agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: a54d6fdda41341f892150e2aaf648f0d + + + Show agent details: JSON response + + + +
+ Update agent + +
+ + + + + + + + + + + + + + + + + + Normal Response Code: 200 + + Error Response Codes: BadRequest + (400) if something other than + description or admin status is changed, NotFound + (404) if not authorized or the + agent does not exist + This operation updates the agent's admin status and + description. + This operation requires a request body. + This operation returns a response body. + + Update agent: JSON request + PUT /v2.0/agents/af4567ad-c2e6-4311-944d-22efc12f89af HTTP/1.1 +Host: controlnode:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: 4cbb09e780434b249ff596d6979fd8fc +Content-Length: 38 + + + Update agents: JSON response + + + + +
+ Delete agent + +
+ + + + + + + + + + + + + + + + + + Normal Response Code: 204 + + Error Response Codes: NotFound + (404) if not authorized or the + agent does not exist + This operation deletes the agent. + This operation does not require a request body. + This operation does not return a response body. + + Delete agent: JSON request + DELETE /v2.0/agents/44002aeb-2817-4cb8-9306-34308b4b40d9 HTTP/1.1 +Host: controlnode:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: 4cbb09e780434b249ff596d6979fd8fc + + + Delete agent: JSON response + + + + diff --git a/v2.0/section_neutron-ext-agent-schedulers.xml b/v2.0/section_neutron-ext-agent-schedulers.xml new file mode 100644 index 0000000..3c8d79d --- /dev/null +++ b/v2.0/section_neutron-ext-agent-schedulers.xml @@ -0,0 +1,662 @@ + + +GET'> +PUT'> +POST'> +DELETE'> +]> + +
+ Agent schedulers + The agent scheduler extensions schedule resources among + agents on top of the . + The agent scheduler feature consist of several agent + scheduler extensions. In Havana, the following extensions are + available. + + + DHCP agent scheduler + (dhcp_agent_scheduler) + + + L3 agent scheduler + (l3_agent_scheduler) + + + load balancer agent scheduler + (lbaas_agent_scheduler) + + + In Grizzly, the DHCP agent scheduler and the L3 agent + scheduler features are provided by a single extension named + the agent scheduler (agent_scheduler). In + Havana, this extension is split into the DHCP agent scheduler + and the L3 agent scheduler extensions. The load balancer agent + scheduler extension was introduced in Havana. +
+ DHCP agent scheduler + (<literal>dhcp_agent_scheduler</literal>) + The DHCP agent scheduler extension enables + administrators to assign DHCP servers for Neutron networks + to given Neutron DHCP agents, and retrieve mappings + between Neutron networks and DHCP agents. This feature is + implemented on top of Agent Management extension. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ List networks hosted by a DHCP agent + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 200 + + Error response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List networks hosted by on DHCP agent: JSON + request + GET /v2.0/agents/d5724d7e-389d-4ba0-8d00-fc673a147bfa/dhcp-networks HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: 797f94caf0a8481c893a232cc0c1dfca + + + List networks hosted by DHCP agent: JSON + response + + + +
+ List DHCP agents hosted by network + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 200 + + Error response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List DHCP agents hosted by network: JSON + request + + GET /v2.0/networks/2d627131-c841-4e3a-ace6-f2dd75773b6d/dhcp-agents HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: cc0f378bdf1545fb8dea2120c89eb532 + + + + + + List DHCP agents hosted by network: JSON + response + + + + +
+ Schedule network to DHCP agent + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 201 + + Error response Codes: Unauthorized + (401), Forbidden + (403), Conflict + (409) if the network is + already hosted by that the specified DHCP agent, + NotFound(404) when the + specified agent is not a valid DHCP agent. + This operation requires a request body. + This operation returns a null + body. + + Schedule network: JSON request + POST /v2.0/agents/d5724d7e-389d-4ba0-8d00-fc673a147bfa/dhcp-networks.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: d88f7af21ee34f6c87e23e46cf3f986d +Content-Length: 54 + + + + + Schedule network: JSON response + + + +
+ Remove network from DHCP agent + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 204 + + Error response Codes: Unauthorized + (401), Forbidden + (403), NotFound + (404), Conflict + (409) if the network is not + hosted by that the specified DHCP agent. + This operation does not require a request + body. + This operation does not return a response + body. + + Remove network from DHCP agent: JSON + request + DELETE /v2.0/agents/d5724d7e-389d-4ba0-8d00-fc673a147bfa/dhcp-networks/1ae075ca-708b-4e66-b4a7-b7698632f05f.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: 7ae91cde8f504031be5a2cd5b99d4fe9 + + + +
+ L3 agent scheduler + (<literal>l3_agent_scheduler</literal>) + The L3 agent scheduler extension allows administrators + to assign Neutron routers to Neutron L3 agents, and + retrieve mappings between Neutron routers and L3 agents. + This feature is implemented on top of Agent Management + extension. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ List routers hosted by an L3 agent + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 200 + + Error response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List routers hosted by L3 agent: JSON + request + GET /v2.0/agents/fa24e88e-3d2f-4fc2-b038-5fb5be294c03/l3-routers.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: 6eeea6e73b68415f85d8368902a32c11 + + + + + List routers hosted by L3 agent: JSON + response + + + + +
+ List L3 agents hosted by router + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 200 + + Error response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List L3 agents hosted by router: JSON + request + GET /v2.0/routers/8eef2388-f27d-4a17-986e-9319a77ccd9d/l3-agents.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: bce63afb1e794c70972a19a7c2d6dcab + + + List L3 agents hosted by router: JSON + response + + + + +
+ Schedule router to L3 agent + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 201 + + Error response Codes: Unauthorized + (401), Forbidden + (403), Conflict + (409) if the router is + already hosted, NotFound (404) + if the specified agent is not a valid L3 + agent. + This operation requires a request body. + This operation returns a null + body. + + Schedule router: JSON request + GET /v2.0/agents/fa24e88e-3d2f-4fc2-b038-5fb5be294c03/l3-routers.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: d88f7af21ee34f6c87e23e46cf3f986d +Content-Length: 54 + + + + + Schedule router: JSON response + + + +
+ Remove router from L3 agent + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 204 + + Error response Codes: Unauthorized + (401), Forbidden + (403), Conflict + (409) if the router is not + hosted by that the specified L3 agent. + This operation does not require a request + body. + This operation does not return a response + body. + + Remove router from L3 agent: JSON + request + DELETE /v2.0/agents/b7d7ba43-1a05-4b09-ba07-67242d4a98f4/l3-routers/8eef2388-f27d-4a17-986e-9319a77ccd9d.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: 2147ef6fe4444f0299b1c0b6b529ff47 + + + +
+ Load balancer agent scheduler + (<literal>lbaas_agent_scheduler</literal>) + The LBaaS agent scheduler extension allows + administrators to retrieve mappings between load balancer + pools to LBaaS agents. In Havana, this extension does not + provide an ability to assign load balancer pool to + specific LBaaS agent. Pools are scheduled automatically + when created. This feature is implemented on top of Agent + Management extension. The load balancer agent scheduler + extension was introduced in Havana. + +
+ + + + + + + + + + + + + + + + + + + + + + +
+ List pools hosted by an LBaaS agent + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 200 + + Error response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List pools hosted by LBaaS agent: JSON + request + GET /v2.0/agents/6ee1df7f-bae4-4ee9-910a-d33b000773b0/loadbalancer-pools.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: 6eeea6e73b68415f85d8368902a32c11 + + + List pools hosted by LBaaS agent: JSON + response + + + +
+ Show LBaaS agent that hosts pool + +
+ + + + + + + + + + + + + + + + + + Normal response Code: + 200 + + Error response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + Show LBaaS agent that hosts pool: JSON + request + GET /v2.0/lb/pools/28296abb-e675-4288-9cd0-6c112c720db0/loadbalancer-agent.json HTTP/1.1 +Host: localhost:9696 +User-Agent: python-neutronclient +Content-Type: application/json +Accept: application/json +X-Auth-Token: bce63afb1e794c70972a19a7c2d6dcab + + + Show LBaaS agent that hosts pool: JSON + response + + + + + diff --git a/v2.0/section_neutron-ext-allowed-address-pairs.xml b/v2.0/section_neutron-ext-allowed-address-pairs.xml new file mode 100644 index 0000000..88eedf0 --- /dev/null +++ b/v2.0/section_neutron-ext-allowed-address-pairs.xml @@ -0,0 +1,169 @@ + + +GET'> +PUT'> +POST'> +DELETE'> +]> +
+ Allowed address pairs + The allowed address pair extension extends the port + attribute to enable you to specify arbitrary + mac_address/ip_address(cidr) pairs that are allowed to pass + through a port regardless of the subnet associated with the + network. +
+ List ports + + +
+ + + + + + + + + + + + + + + + + + + Normal Response Code: 200 OK + Error Response Codes: 401 Unauthorized + This operation returns, for each port, its allowed + address pair attributes as well as all the attributes + normally returned by the list port operation. + + List ports with allowed address pair attributes: + JSON response + + + + List ports with allowed address pair attributes: + XML response + + + +
+ Show port details + + +
+ + + + + + + + + + + + + + + + + + + Normal Response Code: 200 OK + Error Response Code: 401 Unauthorized, 404 Not + Found + + Show port with allowed address pair attributes: + JSON response + + + + Show port with allowed address pair attributes: XML + response + + + +
+ Create port + + +
+ + + + + + + + + + + + + + + + + + + Normal Response Code: 201 + Error Response Code: 400 Bad Request, 401 Unauthorized, + 403 Forbidden + Bad request is returned if an allowed address pair + matches the mac_address and ip_address on port. + Note: If the mac_address field is left out of the body + of the request the mac_address assigned to the port will + be used. + + Create port with allowed address pair attributes: + JSON request + + + +
+ Update port + + +
+ + + + + + + + + + + + + + + + + + + Normal Response Code: 200 OK + Error Response Code: 400 Bad Request, 401 Unauthorized, + 404 Not Found, 403 Forbidden + + Update allowed address pair attributes for a port: + JSON request + + + + diff --git a/v2.0/section_binding_ext_ports.xml b/v2.0/section_neutron-ext-binding-ports.xml similarity index 96% rename from v2.0/section_binding_ext_ports.xml rename to v2.0/section_neutron-ext-binding-ports.xml index f23d70b..32a6e89 100644 --- a/v2.0/section_binding_ext_ports.xml +++ b/v2.0/section_neutron-ext-binding-ports.xml @@ -182,10 +182,10 @@ access.This operation does not require a request body.This operation returns a response body. - In addition to any other fields returned in response, the following - binding-prefixed fields are - visible to administrative users: + In addition to any other fields returned in a list ports + response, the following + binding-prefixed fields are visible + to administrative users: @@ -268,8 +268,8 @@ 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 response, the following + In addition to any fields returned in a show port + details response, the following binding-prefixed extended attributes are visible to administrative users: @@ -360,11 +360,10 @@ 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 operation, administrative - users can also set the following - binding-prefixed extended - attributes: + 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: @@ -430,10 +429,10 @@ port.This operation requires a request body.This operation returns a response body. - In addition to any attributes that can be updated in - operation, - administrative users can also update the following - binding-prefixed extended + 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: diff --git a/v2.0/section_neutron-extgwmodes-ext.xml b/v2.0/section_neutron-ext-external-gateways-modes.xml similarity index 73% rename from v2.0/section_neutron-extgwmodes-ext.xml rename to v2.0/section_neutron-ext-external-gateways-modes.xml index 790c4b3..323ab4e 100644 --- a/v2.0/section_neutron-extgwmodes-ext.xml +++ b/v2.0/section_neutron-ext-external-gateways-modes.xml @@ -1,30 +1,10 @@ - - - - - GET'> PUT'> POST'> DELETE'> - - - - - - '> - - - - - - '> ]>
- Configurable external gateway modes extension + Configurable external gateway modes By default, when a gateway is attached to a router using the Neutron L3 extension, Network Address Translation (NAT) is enabled for traffic generated by subnets attached to the @@ -45,8 +25,8 @@ enable_snat, in the external_gateway_info attribute of the router resource. - This extension redefines the external_gateway_info attribute - as depicted in the following table. + This extension redefines the external_gateway_info + attribute:
Network AttributesNetwork 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 Value Validation ConstraintsN/A N/A Indicates whether network is currently - operational. Possible values include: - - ACTIVE - - - DOWN - - - BUILD - - - ERROR - - - Plug-ins might define additional + operational. Possible values + include: + + + ACTIVE + + + DOWN + + + BUILD + + + ERROR + + + Plug-ins might define additional values.
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 ValueType 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 ValueN/A N/A Indicates whether network is currently - operational. Possible values include: - - ACTIVE - - - DOWN - - - BUILD - - - ERROR - - - Plug-ins might define additional + operational. Possible values + include: + + + ACTIVE + + + DOWN + + + BUILD + + + ERROR + + + Plug-ins might define additional values.
VerbURIDescription
&GET;/agentsLists agents that report their status to OpenStack + Networking server.
&GET;/agents/agent_idShows details for a specified agent.
&PUT;/agents/agent_idUpdates the admin status and description for a + specified agent.
&DELETE;/agents/agent_idDeletes a specified agent.
VerbURIDescription
&GET;/agentsLists agents that report their status to + OpenStack Networking server.
VerbURIDescription
&GET;/agents/agent_idShows details for a specified agent.
VerbURIDescription
&PUT;/agents/agent_idUpdates the admin status and description for a + specified agent.
VerbURIDescription
&DELETE;/agents/agent_idDeletes a specified agent.
VerbURIDescription
&GET;/agents/agent_id/dhcp-networksLists networks that the specified DHCP agent + hosts.
&GET;/networks/network_id/dhcp-agentsLists DHCP agents that host a specified + network.
&POST;/agents/agent_id/dhcp-networksSchedules the network to that the specified + DHCP agent.
&DELETE;/agents/agent_id/dhcp-networks/network_idRemoves the network from that the specified + DHCP agent.
VerbURIDescription
&GET;/agents/agent_id/dhcp-networksLists networks that the specified DHCP + agenthosts.
VerbURIDescription
&GET;/networks/network_id/dhcp-agentsLists DHCP agents that hosts a specified + network.
VerbURIDescription
&POST;/agents/agent_id/dhcp-networksSchedules the network to that the + specified DHCP agent.
VerbURIDescription
&DELETE;/agents/agent_id/dhcp-networks/network_idRemoves the network from that the + specified DHCP agent.
VerbURIDescription
&GET;/agents/agent_id/l3-routersLists routers that the specified L3 agent + hosts.
&GET;/routers/router_id/l3-agentsLists L3 agents that hosts a specified + router.
&POST;/agents/agent_id/l3-routersSchedules the router to that the specified L3 + agent.
&DELETE;/agents/agent_id/l3-routers/router_idRemoves the router from that the specified L3 + agent.
VerbURIDescription
&GET;/agents/agent_id/l3-routersLists routers that the specified L3 agent + hosts.
VerbURIDescription
&GET;/routers/router_id/l3-agentsLists L3 agents that hosts a specified + router.
VerbURIDescription
&POST;/agents/agent_id/l3-routersSchedules one router to that the specified + L3 agent.
VerbURIDescription
&DELETE;/agents/agent_id/l3-routers/network_idRemoves the router from that the specified + L3 agent.
VerbURIDescription
&GET;/agents/agent_id/loadbalancer-poolsLists pools that the specified LBaaS agent + hosts.
&GET;/lb/pools/pool_id/loadbalancer-agentShows an LBaaS agent that hosts a specified + pool.
VerbURIDescription
&GET;/agents/agent_id/loadbalancer-poolsLists pools that the specified LBaaS agent + hosts.
VerbURIDescription
&GET;/lb/pools/pool_id/loadbalancer-agentShows an LBaaS agent that hosts a + specified pool.
VerbURIDescription
&GET;/portsLists ports with their allowed address + pair attributes.
VerbURIDescription
&GET;/ports/port_idShows details about a specified port, + including allowed address pair + attributes.
VerbURIDescription
&POST;/portsCreates a port and explicitly specifies + the allowed address pair attributes.
VerbURIDescription
&PUT;/ports/port_idUpdates a port, with new allowed address + pair values.
@@ -92,7 +72,7 @@ Floating IPs will continue working even when SNAT is disabled.
- List Routers + List routers
@@ -109,7 +89,7 @@ - + @@ -117,20 +97,20 @@ Success and error response codes are not changed with regards to the operation as introduced by the L3 API extension. - When this extension is enabled, this operation will - also return the current Source NAT status for configured - routers, as shown in the sample below. + When this extension is enabled, this operation also + returns the current Source NAT status for configured + routers, as follows.The response for the show router operation is the same, with the obvious exception that a single router is returned. Router list with configurable external gateway modes enabled - +
- Create Router with external gateway + Create router with external gateway
@@ -163,11 +143,11 @@ the default value is True. Create router with SNAT disabled - +
- Update Router's external gateway info + Update external gateway information for router
@@ -184,7 +164,7 @@ - + @@ -217,28 +197,26 @@ Disable SNAT for the current external network - - - - + + + + Change external network and enable SNAT - - - - + + + + - Change external network and keep SNAT + <title>Change external network and external-gateway SNAT disabled - - - - + + + + - - diff --git a/v2.0/section_neutron-ext-external-networks.xml b/v2.0/section_neutron-ext-external-networks.xml new file mode 100644 index 0000000..0f84b43 --- /dev/null +++ b/v2.0/section_neutron-ext-external-networks.xml @@ -0,0 +1,217 @@ + + +GET'> +PUT'> +POST'> +DELETE'> + +]> +
+ External networks (<literal>external-net</literal>) + The external network extension is used to specify whether + the network is external or not. This information is used by + Layer-3 network (router) extension. + External networks are connected to a router's external gateway + and host floating IPs. + The external network extension adds the router:external attribute to the + network resource. +
external_gateway_info attributes
&GET; /routersRetrieve Neutron routersLists neutron routers.
&PUT; /routers/router_idCreate a new Neutron routerCreates a neutron router.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Network Attributes
AttributeTypeRequiredCRUD + + + 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 ConstraintsNotes
router:externalBoolNoCRUFalse{ True | False }Specifies whether the network is an external + network or not.
+
+ List networks + + + + + + + Verb + URI + Description + + + + + &GET; + /networks + Returns a list of networks with their + router:external attributes. + + + + Response codes are same as the normal operation of + listing networks. router:external attribute is visible to + all users by default policy setting. + Regular users are not authorized to create ports on + external networks, however they will be able to see this + attribute in their network list. This is because external + networks can be used by any tenant to set an external + gateway for Neutron routers or create floating IPs and + associate them with ports on internal tenant + networks. + + List networks with router:external attribute: JSON + response + + +
+
+ Show network details + + + + + + + Verb + URI + Description + + + + + &GET; + /networks/network_id + Returns details about a specific network, + including external networks attributes. + + + + Response codes are same as the normal operation of + listing networks. router:external attribute is visible to + all users including non-admin by default policy + setting. + + Show network with external attributes: JSON + response + + +
+
+ Create network + + + + + + + Verb + URI + Description + + + + + &POST; + /networks + Creates a new network using the external + network extension attribute. + + + + If the user submitting the request is not allowed to set + this attribute, a 403 Forbidden response will be returned. + Usage of this attribute might be restricted through + authorization policies. By the default policy only admin + users can set this attribute. + + Create network with external attributes: JSON + request + + +
+
+ Update network + + + + + + + Verb + URI + Description + + + + + &PUT; + /networks/network_id + Updates a network, including the external + network extension attribute. + + + + If the user submitting the request is not allowed to set + this attribute, a 403 Forbidden response will be returned. + Usage of this attribute might be restricted through + authorization policies. By the default policy only admin + users can set this attribute. + + Update external attributes for a network: JSON + request + + +
+
diff --git a/v2.0/section_neutron-ext-extra-dhcp-options.xml b/v2.0/section_neutron-ext-extra-dhcp-options.xml new file mode 100755 index 0000000..c8c6c7f --- /dev/null +++ b/v2.0/section_neutron-ext-extra-dhcp-options.xml @@ -0,0 +1,215 @@ + + +GET'> +PUT'> +POST'> +DELETE'> +]> +
+ Extra DHCP options + (<literal>extra-dhcp-opt</literal>) + The DHCP options extension allows adding DHCP options that + are associated to a Neutron port. They are tagged such that + they can be associated from the hosts file to designate a + specific network interface and port. The DHCP tag scheme used + to associate options to the host files is the port_id (UUID - + in the form of 8-4-4-4-12 for a total of 36 + characters), these associate options to a Neutron port and its + network. The Dynamic Host Configuration Protocol (DHCP) + provides a framework for passing configuration information to + hosts on a TCP/IP network. Configuration parameters and other + information are carried in tagged data items that are stored + in the 'options' field of the DHCP message. + You can specify a DHCP options when defining or updating a + port by specifying the extra_dhcp_opts tag and providing its + options as name value pairs, such as, + opt_name='bootfile-name', opt_value='pxelinux.0'. +
+ Concepts + The extra-dhcp-opt extension is an + attribute extension which adds the following set of + attributes to the port + resource: + + + + extra-dhcp-opt:opt_name - Specified + the DHCP option that this is defined as mapped to + this port resource. Examples are + bootfile-name, + server-ip-address, + tftp-server, etc.. + + + + extra-dhcp-opt:opt_value - + Identifies the value associated with the opt_name. + These are handled in opt_name, opt_value pairs + only. value_opt can be any text string depending + upon the name. + + + The actual semantics of + extra-dhcp-opt attributes depend on + the name of the dhcp option being used that defines the + vendor extension to DHCP. For example reference RFC: + http://tools.ietf.org/html/rfc2132, contains specific + detail on BOOTP Vendor Extensions. +
+
+ List ports + + + + + + + Verb + URI + Description + + + + + &GET; + /ports + Lists ports with attributes. + + + + Normal response Code: 200 OK + Error response Codes: 401 Unauthorized + This operation returns all the ports defined in Neutron + that to which this user has access. + + List ports with extra_dhcp_opts: JSON + response + + +
+
+ Show port details + + + + + + + Verb + URI + Description + + + + + &GET; + /ports/port_id + Shows details about a specified port, + including extra-dhcp-opt + attributes. + + + + Normal response Code: 200 OK + Error response Code: 401 Unauthorized, 404 Not + Found + This operation returns, for the port specified in the + request URI, its port attributes, including the + extra_dhcp_opts attributes. + + Show port details with extra-dhcp-opt attributes: + JSON response + + +
+
+ Create port + + + + + + + + Verb + URI + Description + + + + + &POST; + /ports + Creates a port and explicitly specifies + attributes with the + extra-dhcp-opt + extension attributes. + + + + + Normal response Code: 200 OK + Error response Code: 401 Unauthorized. + This operation returns, for the port specified in the + request URI, its port attributes, including the + extra_dhcp_opts attributes. + + Create port with extra-dhcp-opt attributes: JSON + request + + + + Create port with extra-dhcp-opt attributes: JSON + response + + +
+
+ Update port + + + + + + + Verb + URI + Description + + + + + &PUT; + /ports/port_id + Updates attributes for a port, including + extra_dhcp_opts extension attributes. + + + + + Normal response Code: 200 OK + Error response Code: 401 Unauthorized. + This operation allow for the updating of attributes for + the port specified in the request URI, its port + attributes, including the extra_dhcp_opts + attributes. + + Update port with extra-dhcp-opt attributes: JSON + request + + + + Update port with extra-dhcp-opt attributes: JSON + response + + +
+
diff --git a/v2.0/section_neutron-extraroute-ext.xml b/v2.0/section_neutron-ext-extra-routes.xml similarity index 58% rename from v2.0/section_neutron-extraroute-ext.xml rename to v2.0/section_neutron-ext-extra-routes.xml index 4c87fa0..d6977c2 100644 --- a/v2.0/section_neutron-extraroute-ext.xml +++ b/v2.0/section_neutron-ext-extra-routes.xml @@ -1,30 +1,10 @@ - - - - - GET'> PUT'> POST'> DELETE'> - - - - - - '> - - - - - - '> ]>
- The ExtraRoute Extension - You can set up route configuration on the Router using this - extension. This extension augments the 'Router' resource by - adding a new 'routes' attribute. - You can specify a set of nexthop IPs and destination CIDRs. - Note the nexthop IP must be a part of one of the subnets - router interfaces are connected to. This is why configuration - of route property is allowed only update operation on REST. + Extra routes + This extension adds extra routes to the + router resource. + You can specify a set of nexthop IPs and destination + CIDRs. + + The nexthop IP must be a part of one of the subnets to + which the router interfaces are connected. You can + configure the routes attribute on only + update operations. + - + @@ -57,31 +40,29 @@ @@ -102,7 +83,7 @@
Router AttributesRouter 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 Value Validation Constraints
- Update Extra route + Update extra route @@ -119,7 +100,8 @@ &PUT; /routers/router_id - Update logical router with routes + Updates logical router with + routes attribute. @@ -133,24 +115,22 @@ (404), Conflict (409) This operation configures extra routes on the router. - The nexthop IP must be a part of one of the subnets - to which the router interfaces are connected. Otherwise, the server - responds with 400 Bad Request. When - a validation error is detected, such as a format error of IP - address or CIDR, the server responds with - 400 Bad Request. When Networking + The nexthop IP must be a part of one of the subnets to + which the router interfaces are connected. Otherwise, the + server responds with 400 Bad Request + error code. When a validation error is detected, such as a + format error of IP address or CIDR, the server responds + with 400 Bad Request. When Networking receives a request to delete the router interface for - subnets that are used by one or more routes, it - responds with 409 Conflict. - + subnets that are used by one or more routes, it responds + with 409 Conflict. - Update the routes attribute for a given - router - + Update routes: XML response + - Update routes: Response - + Update routes: JSON response +
diff --git a/v2.0/section_neutron-firewall-ext.xml b/v2.0/section_neutron-ext-fwaas.xml similarity index 52% rename from v2.0/section_neutron-firewall-ext.xml rename to v2.0/section_neutron-ext-fwaas.xml index a47fe8d..7878eb4 100644 --- a/v2.0/section_neutron-firewall-ext.xml +++ b/v2.0/section_neutron-ext-fwaas.xml @@ -1,30 +1,10 @@ - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - '> + +GET'> +PUT'> +POST'> +DELETE'> ]>
- - Firewall as a Service (FWaaS) Extension - The FWaaS extension provides OpenStack users - with the ability to deploy firewalls to protect - their networks. - - The current features provided by the FWaaS extension are: - - - Apply firewall rules on traffic entering and leaving - tenant networks. - - - - Support for applying tcp, udp, icmp, or protocol agnostic - rules. - - - Creation and sharing of firewall policies which hold an - ordered collection of the firewall rules. - - - Ability to audit firewall rules and policies. - - - - - This extension introduces new resources: - - - firewall: represents - a logical firewall resource that a tenant can instantiate - and manage. A firewall is associated with one firewall_policy. - - - - firewall_policy: is an - ordered collection of firewall_rules. A firewall_policy can - be shared across tenants. Thus it can also be made part of - an audit workflow wherein the firewall_policy can be audited - by the relevant entity that is authorized (and can be - different from the tenants which create or use the - firewall_policy). - - - - firewall_rule: represents - a collection of attributes like ports, ip addresses which - define match criteria and action (allow, or deny) that needs - to be taken on the matched data traffic. - - - - - - - + Firewall as a Service (FWaaS) + The FWaaS extension provides OpenStack users with the + ability to deploy firewalls to protect their networks. The + FWaaS extension enables you to: + + + Apply firewall rules on traffic entering and leaving + tenant networks. + + + Support for applying tcp, udp, icmp, or protocol + agnostic rules. + + + Creation and sharing of firewall policies which hold + an ordered collection of the firewall rules. + + + Audit firewall rules and policies. + + + This extension introduces these resources: + + + firewall: + represents a logical firewall resource that a tenant + can instantiate and manage. A firewall is associated + with one firewall_policy. + + + firewall_policy: is + an ordered collection of firewall_rules. A + firewall_policy can be shared across tenants. Thus it + can also be made part of an audit workflow wherein the + firewall_policy can be audited by the relevant entity + that is authorized (and can be different from the + tenants which create or use the + firewall_policy). + + + firewall_rule: + represents a collection of attributes like ports, ip + addresses which define match criteria and action + (allow, or deny) that needs to be taken on the matched + data traffic. + +
- Firewall Rule Operations - This section discusses operations for managing a Firewall Rule - through this extension. - - + Firewall rules + Manage firewall rules. - + @@ -111,28 +78,34 @@ - - - + + @@ -144,7 +117,8 @@ - + @@ -153,8 +127,9 @@ - + @@ -163,8 +138,9 @@ - + @@ -173,8 +149,8 @@ - + @@ -183,15 +159,15 @@ - + @@ -200,9 +176,10 @@ - + @@ -246,9 +223,10 @@ - + @@ -257,9 +235,10 @@ - + @@ -269,12 +248,13 @@ - @@ -294,18 +274,16 @@ - +
Firewall Rule AttributesFirewall rule attributes
Attribute Type RequiredCRUD - - - - - 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. - - - + 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
R generated N/AUnique identifier for the Firewall Rule object.Unique identifier for the firewall rule + object.
tenant_idCR Derived from Authentication token N/AOwner of the Firewall Rule. Only admin users can - specify a tenant identifier other than their own.Owner of the firewall rule. Only admin users + can specify a tenant identifier other than + their own.
nameCRU None N/AHuman readable name for the Firewall Rule (255 - characters limit). Does not have to be unique.Human readable name for the firewall rule (255 + characters limit). Does not have to be + unique.
descriptionCRU None N/AHuman readable description for the Firewall Rule (1024 - characters limit).Human readable description for the firewall + Rule (1024 characters limit).
firewall_policy_idR None N/AThis is a readonly attribute which gets populated - with the uuid of the Firewall Policy when this - Firewall Rule is associated with a Firewall - Policy. A Firewall Rule can be associated - with one Firewall Policy at a time. The association - can however be updated to a different Firewall Policy. - This attribute can be "null" if the rule is not - associated with any firewall policy. - This is a read-only attribute which gets + populated with the uuid of the firewall policy + when this firewall rule is associated with a + firewall policy. A firewall rule can be + associated with one firewall policy at a time. + The association can however be updated to a + different firewall policy. This attribute can + be "null" if the rule is not associated with + any firewall policy.
sharedCRU false {true | false}When set to True makes this Firewall Rule visible - to tenants other than its owner, and can be used - in Firewall Policies not owned by its tenant.When set to True makes this firewall rule + visible to tenants other than its owner, and + can be used in firewall policies not owned by + its tenant.
protocolNo CRU NoneValid port number (integer or string), or port range - in the format of a ':' separated range). In the case - of port range, both ends of the range are included.Valid port number (integer or string), or port + range in the format of a ':' separated range). + In the case of port range, both ends of the + range are included. Source port number or a range
No CRU NoneValid port number (integer or string), or port range - in the format of a ':' separated range. In the case - of port range, both ends of the range are included.Valid port number (integer or string), or port + range in the format of a ':' separated range. + In the case of port range, both ends of the + range are included. Destination port number or a range
R None N/AThis is a readonly attribute that gets assigned - to this rule when the rule is associated with - a Firewall Policy. It indicates the position of - this rule in that Firewall Policy. This position - number starts at 1. The position can be "null" - if the firewall rule is not associated with any + This is a read-only attribute that gets + assigned to this rule when the rule is + associated with a firewall policy. It + indicates the position of this rule in that + firewall policy. This position number starts + at 1. The position can be "null" if the + firewall rule is not associated with any policy.
CRU true {true | false}When set to False will disable this rule in the - Firewall Policy. Facilitates selectively turning - off rules without having to disassociate the rule - from the Firewall PolicyWhen set to False will disable this rule in + the firewall policy. Facilitates selectively + turning off rules without having to + disassociate the rule from the firewall + policy
- - -
- List Firewall Rules + List firewall rules @@ -319,37 +297,33 @@ - &GET; - + &GET; /fw/firewall_rules - List Firewall Rules. + Lists firewall rules. Normal Response Code: - 200 + 200 - Error Response Codes: Unauthorized (401). - This operation does not require a request body. + Error Response Codes: Unauthorized + (401). + This operation does not require a request + body. This operation returns a response body. - List Firewall Rules: Request - -GET /v2.0/fw/firewall_rules.json + List firewall rules: JSON request + GET /v2.0/fw/firewall_rules.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - List Firewall Rules: Response + List firewall rules: JSON response
- - -
- Show Firewall Rule + Show firewall rule details @@ -363,40 +337,35 @@ Accept: application/json - &GET; - + &GET; /fw/firewall_rules/firewall_rule-id - Returns details about a specific Firewall Rule. + Shows firewall rule details. Normal Response Code: - 200 + 200 - Error Response Codes: Unauthorized (401), - Forbidden (403), Not Found (404) - - This operation does not require a request body. + Error Response Codes: Unauthorized + (401), Forbidden + (403), Not Found + (404) + This operation does not require a request + body. This operation returns a response body. - Show Firewall Rule: Request - - -GET /v2.0/fw/firewall_rules/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json + Show firewall rule: JSON request + GET /v2.0/fw/firewall_rules/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Show Firewall Rule: Response + Show firewall rule: JSON response
- - -
- Create Firewall Rule + Create firewall rule @@ -412,39 +381,33 @@ Accept: application/json &POST; /fw/firewall_rules - Creates a new Firewall Rule. + Creates a firewall rule. Normal Response Code: 201 - Error Response Codes: Unauthorized (401), - Bad Request (400) + Error Response Codes: Unauthorized + (401), Bad Request + (400) This operation requires a request body. This operation returns a response body. - Create Firewall Rule: Request - -POST /v2.0/fw/firewall_rules.json + Create firewall rule: JSON request + POST /v2.0/fw/firewall_rules.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Create Firewall Rule: Response - -HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - + Create firewall rule: JSON response + HTTP/1.1 201 Created +Content-Type: application/json; charset=UTF-8
- - -
- Update Firewall Rule + Update firewall rule @@ -460,36 +423,32 @@ Content-Type: application/json; charset=UTF-8 &PUT; /fw/firewall_rules/firewall_rule-id - Updates a Firewall Rule. + Updates a firewall rule. - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404) + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404) - Update Firewall Rule: Request - -PUT /v2.0/fw/firewall_rules/41bfef97-af4e-4f6b-a5d3-4678859d2485.json + Update firewall rule: JSON request + PUT /v2.0/fw/firewall_rules/41bfef97-af4e-4f6b-a5d3-4678859d2485.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Update Firewall Rule: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - + Update firewall rule: JSON response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8
- - -
- Delete Firewall Rule + Delete firewall rule @@ -505,48 +464,45 @@ Content-Type: application/json; charset=UTF-8 &DELETE; /fw/firewall_rules/firewall_rule-id - Removes a Firewall Rule. + Deletes a firewall rule. Normal Response Code: 204 - Error Response Codes: Unauthorized (401), - Not Found (404), Conflict - (409). The Conflict error response is - returned when an operation is performed while the firewall - is in a PENDING state. - This operation does not require a request body. - This operation does not return a response body. + Error Response Codes: Unauthorized + (401), Not Found + (404), Conflict + (409). The Conflict error + response is returned when an operation is performed + while the firewall is in a PENDING state. + This operation does not require a request + body. + This operation does not return a response + body. - Delete Firewall Rule: Request - -DELETE /v2.0/fw/firewall_rules/1be5e5f7-c45e-49ba-85da-156575b60d50.json + Delete firewall rule: JSON request + DELETE /v2.0/fw/firewall_rules/1be5e5f7-c45e-49ba-85da-156575b60d50.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Delete Firewall Rule: Response - -HTTP/1.1 204 No Content -Content-Length: 0 - + Delete firewall rule: JSON response + HTTP/1.1 204 No Content +Content-Length: 0
-
+
+
- Firewall Policy Operations - This section discusses operations for managing a Firewall Policy - through this extension. - - + Firewall policies + Manage firewall policies. - + @@ -559,28 +515,34 @@ Content-Length: 0 - - - + + @@ -592,7 +554,8 @@ Content-Length: 0 - + @@ -601,8 +564,9 @@ Content-Length: 0 - + @@ -611,8 +575,9 @@ Content-Length: 0 - + @@ -621,8 +586,8 @@ Content-Length: 0 - + @@ -631,8 +596,8 @@ Content-Length: 0 - + @@ -640,10 +605,10 @@ Content-Length: 0 - - + + @@ -653,21 +618,19 @@ Content-Length: 0 + that the firewall policy has been audited. + This attribute is meant to aid in the firewall + policy audit workflows. Each time the firewall + policy or the associated firewall rules are + changed, this attribute will be set to False + and will have to be explicitly set to True + through an update operation.
Firewall Policy AttributesFirewall policy attributes
Attribute Type RequiredCRUD - - - - - 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. - - - + 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
R generated N/AUnique identifier for the Firewall Policy object.Unique identifier for the firewall policy + object.
tenant_idCR Derived from Authentication token N/AOwner of the Firewall Policy. Only admin users can - specify a tenant identifier other than their own.Owner of the firewall policy. Only admin users + can specify a tenant identifier other than + their own.
nameCRU None N/AHuman readable name for the Firewall Policy (255 - characters limit). Does not have to be unique.Human readable name for the firewall policy + (255 characters limit). Does not have to be + unique.
descriptionCRU None N/AHuman readable description for the Firewall Policy (1024 - characters limit)Human readable description for the firewall + policy (1024 characters limit)
sharedCRU false {true | false}When set to True makes this Firewall Policy visible - to tenants other than its owner.When set to True makes this firewall policy + visible to tenants other than its owner.
firewall_rulesNo CRU Empty listJSON list of Firewall Rule uuidsThis is an ordered list of Firewall Rule uuids. - The Firewall applies the rules in the order in - which they appear in this list.JSON list of firewall rule uuidsThis is an ordered list of firewall rule + uuids. The firewall applies the rules in the + order in which they appear in this list.
auditedfalse {true | false} When set to True by the policy owner indicates - that the Firewall Policy has been audited. This - attribute is meant to aid in the firewall - policy audit workflows. Each time the Firewall - Policy or the associated Firewall Rules are - changed, this attribute will be set to False and - will have to be explicitly set to True through an - update operation.
- -
- List Firewall Policies + List firewall policies @@ -681,39 +644,34 @@ Content-Length: 0 - &GET; - + &GET; /fw/firewall_policies - List Firewall Policies. + Lists firewall policies. Normal Response Code: - 200 + 200 - Error Response Codes: Unauthorized (401), - Forbidden (403) - - This operation does not require a request body. + Error Response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. This operation returns a response body. - List Firewall Policies: Request - -GET /v2.0/fw/firewall_policies.json + List firewall policies: JSON request + GET /v2.0/fw/firewall_policies.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - List Firewall Policies: Response + List firewall policies: JSON response
- - -
- Show Firewall Policy + Show firewall policy details @@ -727,40 +685,35 @@ Accept: application/json - &GET; - + &GET; /fw/firewall_policies/firewall_policy-id - Returns details about a specific Firewall Policy. + Shows firewall policy details. Normal Response Code: - 200 + 200 - Error Response Codes: Unauthorized (401), - Not Found (404) - - This operation does not require a request body. + Error Response Codes: Unauthorized + (401), Not Found + (404) + This operation does not require a request + body. This operation returns a response body. - Show Firewall Policy: Request + Show firewall policy: JSON request - -GET /v2.0/fw/firewall_policies/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json + GET /v2.0/fw/firewall_policies/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Show Firewall Policy: Response + Show firewall policy: JSON response
- - -
- Create Firewall Policy + Create firewall policy @@ -776,38 +729,32 @@ Accept: application/json &POST; /fw/firewall_policies - Creates a new Firewall Policy. + Creates a firewall policy. Normal Response Code: 201 - Error Response Codes: Unauthorized (401). + Error Response Codes: Unauthorized + (401). This operation requires a request body. This operation returns a response body. - Create Firewall Policy: Request - -POST /v2.0/fw/firewall_policies.json + Create firewall policy: JSON request + POST /v2.0/fw/firewall_policies.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Create Firewall Policy: Response - -HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - + Create firewall policy: JSON response + HTTP/1.1 201 Created +Content-Type: application/json; charset=UTF-8
- - -
- Update Firewall Policy + Update firewall policy @@ -823,36 +770,31 @@ Content-Type: application/json; charset=UTF-8 &PUT; /fw/firewall_policies/firewall_policy-id - Updates a Firewall Policy. + Updates a firewall policy. - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Not Found (404) + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Not Found + (404) - Update Firewall Policy: Request - -PUT /v2.0/fw/firewall_policies/41bfef97-af4e-4f6b-a5d3-4678859d2485.json + Update firewall policy: JSON request + PUT /v2.0/fw/firewall_policies/41bfef97-af4e-4f6b-a5d3-4678859d2485.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Update Firewall Policy: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - + Update firewall policy: JSON response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8
- - -
- Delete Firewall Policy + Delete firewall policy @@ -868,39 +810,35 @@ Content-Type: application/json; charset=UTF-8 &DELETE; /fw/firewall_policies/firewall_policy-id - Removes a Firewall Policy. + Deletes a firewall policy. Normal Response Code: 204 - Error Response Codes: Unauthorized (401), - Not Found (404), Conflict (409 - ). Conflict error code is returned the firewall policy - is in use. - This operation does not require a request body. - This operation does not return a response body. + Error Response Codes: Unauthorized + (401), Not Found + (404), Conflict + (409 ). Conflict error code + is returned the firewall policy is in use. + This operation does not require a request + body. + This operation does not return a response + body. - Delete Firewall Policy: Request - -DELETE /v2.0/fw/firewall_policies/1be5e5f7-c45e-49ba-85da-156575b60d50.json + Delete firewall policy: JSON request + DELETE /v2.0/fw/firewall_policies/1be5e5f7-c45e-49ba-85da-156575b60d50.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Delete Firewall Policy: Response - -HTTP/1.1 204 No Content -Content-Length: 0 - + Delete firewall policy: JSON response + HTTP/1.1 204 No Content +Content-Length: 0
- - -
- Positionally inserting a Firewall Rule in a Firewall Policy + Insert firewall rule in firewall policy @@ -916,42 +854,45 @@ Content-Length: 0 &PUT; /fw/firewall_policies/firewall_policy-id/insert_rule - Inserts a Firewall Rule in a Firewall Policy relative to the position of other rules. + Inserts a firewall rule in a firewall + policy relative to the position of other + rules. - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404). - Bad Request error is returned in the case the rule information is missing. + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404). Bad Request error is + returned in the case the rule information is + missing. - Insert Firewall Rule in Firewall Policy: Request - -PUT /v2.0/fw/firewall_policies/41bfef97-af4e-4f6b-a5d3-4678859d2485/insert_rule.json + Insert firewall rule in firewall policy: JSON + request + PUT /v2.0/fw/firewall_policies/41bfef97-af4e-4f6b-a5d3-4678859d2485/insert_rule.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Insert Firewall Rule in Firewall Policy: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - + Insert firewall rule in firewall policy: + Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 - insert_before and insert_after parameters refer to firewall rule uuids - already associated with the firewall policy. firewall_rule_id refers to - uuid of the rule being inserted. insert_before takes precedence over - insert_after and if neither is specified, firewall_rule_is is inserted - at the first position. + insert_before and insert_after parameters refer to + firewall rule uuids already associated with the + firewall policy. firewall_rule_id refers to uuid of + the rule being inserted. insert_before takes + precedence over insert_after and if neither is + specified, firewall_rule_is inserted at the first + position.
- - -
- Removing a Firewall Rule from a Firewall Policy + Remove firewall rule from firewall policy @@ -967,47 +908,43 @@ Content-Type: application/json; charset=UTF-8 &PUT; /fw/firewall_policies/firewall_policy-id/remove_rule - Removes a Firewall Rule from a Firewall Policy. + Removes a firewall rule from a firewall + policy. - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404). - Bad Request error is returned if the rule information is missing or when a - firewall rule is tried to be removed from a firewall policy to which it is - not associated. + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404). Bad Request error is + returned if the rule information is missing or when a + firewall rule is tried to be removed from a firewall + policy to which it is not associated. - Remove Firewall Rule from Firewall Policy: Request - -PUT /v2.0/fw/firewall_policies/41bfef97-af4e-4f6b-a5d3-4678859d2485/remove_rule.json + Remove firewall rule from firewall policy: JSON + request + PUT /v2.0/fw/firewall_policies/41bfef97-af4e-4f6b-a5d3-4678859d2485/remove_rule.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Remove Firewall Rule from Firewall Policy: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - + Remove firewall rule from firewall policy: JSON + response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8
- -
- - - +
+
- Firewall Operations - This section discusses operations for managing a Firewall - through this extension. - - + Firewalls + Manage firewalls. - + @@ -1020,28 +957,35 @@ Content-Type: application/json; charset=UTF-8 - - - + + @@ -1053,7 +997,8 @@ Content-Type: application/json; charset=UTF-8 - + @@ -1062,8 +1007,9 @@ Content-Type: application/json; charset=UTF-8 - + @@ -1072,8 +1018,9 @@ Content-Type: application/json; charset=UTF-8 - + @@ -1082,8 +1029,8 @@ Content-Type: application/json; charset=UTF-8 - + @@ -1092,9 +1039,10 @@ Content-Type: application/json; charset=UTF-8 - + @@ -1103,10 +1051,11 @@ Content-Type: application/json; charset=UTF-8 - + @@ -1115,9 +1064,10 @@ Content-Type: application/json; charset=UTF-8 - + @@ -1125,19 +1075,16 @@ Content-Type: application/json; charset=UTF-8 - - +
Firewall AttributesFirewall attributes
Attribute Type RequiredCRUD - - - - - 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. - - - + 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
R generated N/AUnique identifier for the Firewall object.Unique identifier for the firewall + object.
tenant_idCR Derived from Authentication token N/AOwner of the Firewall. Only admin users can - specify a tenant identifier other than their own.Owner of the firewall. Only admin users can + specify a tenant identifier other than their + own.
nameCRU None N/AHuman readable name for the Firewall (255 - characters limit). Does not have to be unique.Human readable name for the firewall (255 + characters limit). Does not have to be + unique.
descriptionCRU None N/AHuman readable description for the Firewall (1024 - characters limit)Human readable description for the firewall + (1024 characters limit)
admin_state_upCRU true {true | false }Administrative state of the Firewall. If false - (down), firewall does not forward packets and will - drop all traffic to/from VMs behind the firewall.Administrative state of the firewall. If false + (down), firewall does not forward packets and + will drop all traffic to/from VMs behind the + firewall.
statusR N/A N/AIndicates whether Firewall resource is currently - operational. Possible values include: - ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, - PENDING_UPDATE, or PENDING_DELETE.Indicates whether firewall resource is + currently operational. Possible values + include: ACTIVE, DOWN, BUILD, ERROR, + PENDING_CREATE, PENDING_UPDATE, or + PENDING_DELETE.
sharedCRU false {true | false}When set to True makes this Firewall Rule visible - to tenants other than its owner, and can be used - in Firewall Policies not owned by its tenant.When set to True makes this firewall rule + visible to tenants other than its owner, and + can be used in firewall policies not owned by + its tenant.
firewall_policy_idNo CRU Nonevalid Firewall Policy uuidThe Firewall Policy uuid that this Firewall - is associated with. This Firewall will implement - the rules contained in the Firewall Policy + valid firewall policy uuidThe firewall policy uuid that this firewall is + associated with. This firewall will implement + the rules contained in the firewall policy represented by this uuid.
- - -
- List Firewalls + List firewalls @@ -1151,37 +1098,33 @@ Content-Type: application/json; charset=UTF-8 - &GET; - + &GET; /fw/firewalls - List Firewalls. + Lists firewalls. Normal Response Code: - 200 + 200 - Error Response Codes: Unauthorized (401) - This operation does not require a request body. + Error Response Codes: Unauthorized + (401) + This operation does not require a request + body. This operation returns a response body. - List Firewalls: Request - -GET /v2.0/fw/firewalls.json + List firewalls: JSON request + GET /v2.0/fw/firewalls.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - List Firewalls: Response + List firewalls: JSON response
- - -
- Show Firewall + Show firewall details @@ -1195,40 +1138,36 @@ Accept: application/json - &GET; - + &GET; /fw/firewalls/firewall-id - Returns details about a specific Firewall. + Shows firewall details. Normal Response Code: - 200 + 200 - Error Response Codes: Unauthorized (401), - Forbidden (403), Not Found (404) - - This operation does not require a request body. + Error Response Codes: Unauthorized + (401), Forbidden + (403), Not Found + (404) + This operation does not require a request + body. This operation returns a response body. - Show Firewall: Request + Show firewall: JSON request - -GET /v2.0/fw/firewalls/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json + GET /v2.0/fw/firewalls/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Show Firewall: Response + Show firewall: JSON response
- - -
- Create Firewall + Create firewall @@ -1244,39 +1183,33 @@ Accept: application/json &POST; /fw/firewalls - Creates a new Firewall. + Creates a firewall. Normal Response Code: 201 - Error Response Codes: Unauthorized (401), - Bad Request (400) + Error Response Codes: Unauthorized + (401), Bad Request + (400) This operation requires a request body. This operation returns a response body. - Create Firewall: Request - -POST /v2.0/fw/firewalls.json + Create firewall: JSON request + POST /v2.0/fw/firewalls.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Create Firewall: Response - -HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - + Create firewall: JSON response + HTTP/1.1 201 Created +Content-Type: application/json; charset=UTF-8
- - -
- Update Firewall + Update firewall @@ -1292,36 +1225,33 @@ Content-Type: application/json; charset=UTF-8 &PUT; /fw/firewalls/firewall-id - Updates a Firewall, provided status is not indicating a PENDING_* state. + Updates a firewall, provided status is not + PENDING_*. - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404) + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404) - Update Firewall: Request - -PUT /v2.0/fw/firewalls/41bfef97-af4e-4f6b-a5d3-4678859d2485.json + Update firewall: JSON request + PUT /v2.0/fw/firewalls/41bfef97-af4e-4f6b-a5d3-4678859d2485.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Update Firewall: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - + Update firewall: JSON response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8
- - -
- Delete Firewall + Delete firewall @@ -1337,35 +1267,30 @@ Content-Type: application/json; charset=UTF-8 &DELETE; /fw/firewalls/firewall-id - Removes a Firewall. + Deletes a firewall. Normal Response Code: 204 - Error Response Codes: Unauthorized (401), - Not Found (404) - This operation does not require a request body. - This operation does not return a response body. + Error Response Codes: Unauthorized + (401), Not Found + (404) + This operation does not require a request + body. + This operation does not return a response + body. - Delete Firewall: Request - -DELETE /v2.0/fw/firewalls/1be5e5f7-c45e-49ba-85da-156575b60d50.json + Delete firewall: JSON request + DELETE /v2.0/fw/firewalls/1be5e5f7-c45e-49ba-85da-156575b60d50.json User-Agent: python-neutronclient -Accept: application/json - +Accept: application/json - Delete Firewall: Response - -HTTP/1.1 204 No Content -Content-Length: 0 - + Delete firewall: JSON response + HTTP/1.1 204 No Content +Content-Length: 0
- -
- - - -
+
+
diff --git a/v2.0/section_neutron-ext-layer3.xml b/v2.0/section_neutron-ext-layer3.xml new file mode 100644 index 0000000..b5d036c --- /dev/null +++ b/v2.0/section_neutron-ext-layer3.xml @@ -0,0 +1,262 @@ + +
+ Layer-3 networking (<literal>router</literal>) + The Layer-3 networking extension enables OpenStack + Networking API users to route packets between subnets, forward + packets from internal networks to external ones, and access + instances from external networks through floating IPs. + The OpenStack Networking layer-3 extension defines these + resources: + + + router. A logical + entity that forwards packets across internal subnets + and NATs them on external networks through an + appropriate external gateway. + A router has an interface for each subnet with which + it is associated. By default, the IP address of such + interface is the subnet's gateway IP. Also, whenever a + router is associated with a subnet, a port for that + router interface is added to the subnet's + network. + + + floatingip. + Represents an external IP address that is mapped to an + OpenStack Networking port and, optionally, a specific + IP address on a private OpenStack Networking network. + A floating IP enables access to an instance on a + private network from an external network. Floating IPs + can only be defined on networks where the router:external attribute + (by the external network extension) is set to + True. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Router attributes
AttributeTypeRequiredCRUD + + + + 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the router.
nameStringNoCRUNoneN/AHuman readable name for the router. Does not have + to be unique.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the router.
statusStringN/ARN/AN/AIndicates whether or not a router is currently + operational.
tenant_iduuid-strNoCRDerived from Authentication tokenN/AOwner of the router. Only admin users can specify + a tenant identifier other than its own.
external_gateway_infodictNoCRUNoneNo constraintInformation on external gateway for the + router.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Floating IP attributes
AttributeTypeRequiredCRUDDefault valueValidation constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the floating IP + instance.
floating_network_iduuid-strYesCRN/AUUID PatternUUID of the external network where the floating IP + is to be created.
port_iduuid-strYesCRUN/AUUID PatternUUID of the port on an internal OpenStack + Networking network that is associated with the + floating IP.
fixed_ip_addressIP AddressNoCRUNoneIP address or nullSpecific IP address on port_id + which should be associated with the floating + IP.
floating_ip_addressIP AddressN/ARAutomatically allocated from poolN/AAddress of the floating IP on the external + network.
tenant_iduuid-strNoCRDerived from Authentication tokenN/AOwner of the floating IP. Only admin users can + specify a tenant identifier other than its + own.
+ + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/v2.0/section_neutron-ext-lbaas.xml b/v2.0/section_neutron-ext-lbaas.xml new file mode 100644 index 0000000..a0a31f0 --- /dev/null +++ b/v2.0/section_neutron-ext-lbaas.xml @@ -0,0 +1,745 @@ + +GET'> +PUT'> +POST'> +DELETE'> +]> +
+ Load Balancer as a Service (LBaaS) + The LBaaS extension enables OpenStack tenants to + load-balance their VM traffic. The extension enables you + to: + + + Load-balance client traffic from one network to + application services, such as VMs, on the same or a + different network. + + + Load-balance several protocols, such as TCP and + HTTP. + + + Monitor the health of application services. + + + Support session persistence. + + +
+ Concepts + This extension introduces these concepts: + + + VIP + + The primary load balancing configuration + object. Specifies the virtual IP address and + port where client traffic is received. Also + defines other details such as the load + balancing method to be used, protocol, and so + on. + This entity is sometimes known in + load-balancing products as a + virtual server, + vserver, or + listener. + + + + pool + + A logical set of devices, such as web + servers, that you group together to receive + and process traffic. + The load balancing function chooses which + member of the pool handles the new requests or + connections received on the VIP address. Each + VIP has one pool. + + + + pool member + + The application that runs on the back-end + server. + + + + health monitor + + Determines whether or not back-end members + of the VIP pool can process a request. A pool + can have several health monitors associated + with it. + The LBaaS extension supports these types of + health monitors: + + + PING. Pings the members + by using ICMP. + + + TCP. Connects to the + members by using TCP. + + + HTTP. Sends an HTTP + request to the member. + + + HTTPS. Sends a secure + HTTP request to the member. + + + When a pool has several monitors associated + with it, all monitors check each member of the + pool. If any monitor declares a member as + unhealthy, the member status is changed to + inactive + and the member does not participate in the + load balancing for the pool. + All monitors must declare the member to be + healthy for it to stay active. + + + + session persistence + + Forces connections or requests in the same + session to be processed by the same member as + long as it is active. + The LBaaS extension supports these types of + persistence: + + + SOURCE_IP. All + connections that originate from the + same source IP address are handled by + the same member of the pool. + + + HTTP_COOKIE. The load + balancing function creates a cookie on + the first request from a client. + Subsequent requests that contain the + same cookie value are handled by the + same member of the pool. + + + APP_COOKIE. The load + balancing function relies on a cookie + established by the back-end + application. All requests with the + same cookie value are handled by the + same member of the pool. + + + Absence of session_persistence + attribute means no session persistence + mechanism is used. + When no session persistence is used, the + session_persistence attribute + does not appear in the API response, instead + of returning null. + You can clear session persistence for the + VIP by sending null in + session_persistence attribute + in a VIP update request. + + + +
+
+ High-level task flow + To use the LBaaS extension to configure load balancing, + you must complete these high-level tasks: + + + Create a pool, which is initially empty. + + + Create one or several members in the + pool. + + + Create one or several health monitors. + + + Associate the health monitors with the + pool. + + + Create a VIP that is associated with the + pool. + + +
+
+ VIP operations + + + + + + + + + + + +
+ +
+ Pool operations + This section discusses operations for managing load + balancer pools through the Load balancing as a service + extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Pool Attributes
AttributeTypeRequiredCRUD + + + 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the pool.
tenant_iduuid-strYesCRDerived from authentication token.N/AOwner of the pool. Only an admin user can + specify a tenant identifier other than its + own
vip_iduuid-strNoRNoneUUID pattern.The vip that the pool + associated with.
nameStringNoCRUNoneN/AHuman readable name for the pool. Does not + have to be unique.
descriptionStringNoCRUNoneN/AHuman readable description for the pool.
subnet_iduuid-strNoCRNoneUUID pattern.The network that pool members belong to.
protocolStringYesCRNone{ "TCP" | "HTTP" | "HTTPS" }The protocol of the pool.
lb_methodStringYesCRUNoneNoneThe algorithm used to distribute load between + the members of the pool.
health_monitorsuuid-listNoCRUNoneN/AList of health monitors to associate with the + pool.
membersuuid-listNoRNoneN/AList of members that belong to the pool.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the pool.
statusStringN/ARN/AN/AIndicates whether a pool is currently + operational or not.
+ + + + + + + + + + + +
+ +
+ Member operations + This section discusses operations for managing pool + members through the Load balancing as a service + extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Member Attributes
AttributeTypeRequiredCRUD + + + 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the member.
tenant_iduuid-strYesCRDerived from authentication token.N/AOwner of the member. Only an admin user can + specify a tenant identifier other than its + own.
pool_iduuid-strYesCRUNoneUUID pattern.The pool that the member + belongs to.
addressIPYesCRNoneIP address or null.The IP address of the member.
protocol_portIntegerYesCRNone[0..65535]The port on which the application is + hosted.
weightIntegerNoCRU1[0..256]The weight of a member determines the portion + of requests or connections it services + compared to the other members of the pool. A + value of 0 means the member does not + participate in load-balancing but still + accepts persistent connections.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the member.
statusStringN/ARN/AN/AIndicates whether or not a member is currently + operational.
+ + + + + + + + + + + +
+ +
+ Health monitor operations + This section discusses operations for managing load + balancer health monitors through the LBaaS + extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Health monitor attributes
AttributeTypeRequiredCRUD + + + 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique ID for the health monitor.
tenant_iduuid-strYesCRDerived from authentication token.N/AOwner of the health monitor. Only an admin + user can specify a tenant identifier other + than its own.
typeStringYesCRNone{"PING" | "TCP" | "HTTP" | "HTTPS"}The type of probe send by load balancer to + verify member state
delayIntegerYesCRUNonenon-negativeThe time in seconds between sending probes to + members.
timeoutuuid-strYesCRUNonenon-negativeThe maximum number of seconds for a monitor to + wait for a connection to be established before + it times out. The value must be less than the + delay value.
max_retriesIntegerYesCRUNone[1..10]Number of allowed connection failures before + changing the member's status to INACTIVE.
http_methodStringNo + Required if type + is HTTP or + HTTPS. + CRUGETNoneThe HTTP method used for requests by the + monitor.
url_pathStringNoCRU/NoneThe HTTP path of the request sent by the + monitor to test a member's health. This must + be a string beginning with a / (forward + slash).
expected_codesStringNoCRU200Single value, such as 200, list, such as 200, + 202, or range, such as 200-204.The list of HTTP status codes expected in + response from the member to declare it + healthy.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the health + monitor.
statusStringN/ARN/AN/AIndicates whether or not a health monitor is + currently operational.
+ + + + + + + + + + + + + + + + + +
+
diff --git a/v2.0/section_neutron-ext-metering.xml b/v2.0/section_neutron-ext-metering.xml new file mode 100644 index 0000000..8e40dfb --- /dev/null +++ b/v2.0/section_neutron-ext-metering.xml @@ -0,0 +1,36 @@ + +
+ Metering labels and rules + Create, modify, and delete OpenStack Layer3 metering + labels and rules. + + + + + + + + + + + + + + + + + + +
diff --git a/v2.0/section_neutron-multi-provider-ext.xml b/v2.0/section_neutron-ext-provider-networks-multi.xml similarity index 80% rename from v2.0/section_neutron-multi-provider-ext.xml rename to v2.0/section_neutron-ext-provider-networks-multi.xml index 37f7ff9..1cfcfae 100644 --- a/v2.0/section_neutron-multi-provider-ext.xml +++ b/v2.0/section_neutron-ext-provider-networks-multi.xml @@ -1,22 +1,20 @@ -
- Network API operations with multiple provider - extension + Multiple provider networks Set and retrieve the multiple provider networks extension attributes for network objects. - + + - +
diff --git a/v2.0/section_neutron-ext-provider-networks.xml b/v2.0/section_neutron-ext-provider-networks.xml new file mode 100644 index 0000000..962aed1 --- /dev/null +++ b/v2.0/section_neutron-ext-provider-networks.xml @@ -0,0 +1,91 @@ + + + +GET'> +PUT'> +POST'> +DELETE'> + +]> +
+ Provider networks (<literal>provider</literal>) + The provider extended attributes for + networks enable administrative users to specify how network + objects map to the underlying networking infrastructure. These + extended attributes also appear when administrative users + query networks. + To this aim, it extends the network resource by defining a set of + attributes prefixed with provider. + These attributes are added 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. + + + 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 Administrator + Guide to understand which values should be + specific for each of these attributes when OpenStack + Networking is deployed with a particular plug-in. The examples + shown in this chapter refer to the Open vSwitch + plug-in. + The default policy settings enable only users with + administrative rights to specify these parameters in requests + and to see their values in responses. By default, the provider + network extension attributes are completely hidden from + regular tenants. As a rule of thumb, if these attributes are + not visible in a GET + /networks/<network-id> operation, this + implies the user submitting the request is not authorized to + view or manipulate provider network attributes. + + + + + + + + + + + +
diff --git a/v2.0/section_neutron-ext-quotas.xml b/v2.0/section_neutron-ext-quotas.xml new file mode 100644 index 0000000..0e2e15d --- /dev/null +++ b/v2.0/section_neutron-ext-quotas.xml @@ -0,0 +1,30 @@ + +
+ Quotas + Use the neutron.conf configuration file + to define and apply default quota values to all tenants. This + extension enables an administrative user to define quotas + values on a per-tenant basis. For example, an administrative + user can permit tenant A to create at most + n networks and tenant B to + create at most n networks. + + + + + + + + + + +
diff --git a/v2.0/section_neutron-security-groups-ext.xml b/v2.0/section_neutron-ext-security-groups-rules.xml similarity index 100% rename from v2.0/section_neutron-security-groups-ext.xml rename to v2.0/section_neutron-ext-security-groups-rules.xml diff --git a/v2.0/section_neutron-ext-show-info.xml b/v2.0/section_neutron-ext-show-info.xml new file mode 100644 index 0000000..789a9cd --- /dev/null +++ b/v2.0/section_neutron-ext-show-info.xml @@ -0,0 +1,24 @@ + +
+ Get extension information + List available extensions and show details for a specified + extension. + + + + + + + + +
diff --git a/v2.0/section_neutron-ext-vpnaas.xml b/v2.0/section_neutron-ext-vpnaas.xml new file mode 100644 index 0000000..275fd08 --- /dev/null +++ b/v2.0/section_neutron-ext-vpnaas.xml @@ -0,0 +1,1680 @@ + + +GET'> +PUT'> +POST'> +DELETE'> +]> +
+ Virtual Private Network as a Service (VPNaaS) + The VPNaaS extension provides OpenStack tenants with the + ability to extend private networks across the public + telecommunication infrastructure. The capabilities provided by + this initial implementation of the VPNaaS extension + are: + + + Site-to-site Virtual Private Network connecting two + private networks. + + + Multiple VPN connections per tenant. + + + Supporting IKEv1 policy with 3des, aes-128, aes-256, + or aes-192 encryption. + + + Supporting IPSec policy with 3des, aes-128, aes-256, + or aes-192 encryption, sha1 authentication, ESP, AH, + or AH-ESP transform protocol, and tunnel or transport + mode encapsulation. + + + Dead Peer Detection (DPD) allowing hold, clear, + restart, disabled, or restart-by-peer actions. + + + This extension introduces new resources: + + + service, a high + level object that associates VPN with a specific + subnet and router. + + + ikepolicy, the + Internet Key Exchange policy identifying the + authentication and encryption algorithm used during + phase one and phase two negotiation of a VPN + connection. + + + ipsecpolicy, the IP + security policy specifying the authentication and + encryption algorithm, and encapsulation mode used for + the established VPN connection. + + + ipsec-site-connection, has details for + the site-to-site IPsec connection, including the peer + CIDRs, MTU, authentication mode, peer address, DPD + settings, and status. + + + + This extension is experimental for the Havana release. The + API may change without backward compatibility. + +
+ Concepts + A VPN service relates + the Virtual Private Network with a specific subnet and + router for a tenant. + An IKE Policy is used + for phase one and phase two negotiation of the VPN + connection. Configuration selects the authentication and + encryption algorithm used to establish a + connection. + An IPsec Policy is used + to specify the encryption algorithm, transform protocol, + and mode (tunnel/transport) for the VPN connection. + A VPN connection + represents the IPsec tunnel established between two sites + for the tenant. This contains configuration settings + specifying the policies used, peer information, MTU, and + the DPD actions to take. +
+
+ High-level flow + The high-level task flow for using VPNaaS API to + configure a site-to-site Virtual Private Network is as + follows: + + + The tenant creates a VPN service specifying the + router and subnet. + + + The tenant creates an IKE Policy. + + + The tenant creates an IPsec Policy. + + + The tenant creates a VPN connection, specifying + the VPN service, peer information, and IKE and + IPsec policies. + + +
+
+ VPN services + Manage a tenant's VPN service through this + extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VPN Service Attributes
AttributeTypeRequiredCRUD + + + 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the VPN Service + object.
tenant_iduuid-strYesCRDerived from Authentication tokenvalid tenant_idOwner of the VPN service. Only admin users can + specify a tenant identifier other than their + own.
nameStringNoCRUNoneN/AHuman readable name for the VPN service. Does + not have to be unique.
descriptionStringNoCRUNoneN/AHuman readable description for the VPN + service.
statusStringN/ARN/AN/AIndicates whether IPsec VPN service is + currently operational. Possible values + include: ACTIVE, DOWN, BUILD, ERROR, + PENDING_CREATE, PENDING_UPDATE, or + PENDING_DELETE.
admin_state_upBoolN/ACRUtrue{true | false }Administrative state of the vpnservice. If + false (down), port does not forward + packets.
subnet_iduuid-strYesCRN/Avalid subnet IDThe subnet on which the tenant wants the VPN + service. This may be extended in the future to + support multiple subnets.
router_iduuid-strYesCRN/Avalid router IDRouter ID to which the VPN service is + inserted. This may change in the future, when + router level insertion is available.
+ + + +
+ List VPN services + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/vpnservices + Lists VPN services. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List VPN Services: Request + GET /v2.0/vpn/vpnservices.json +User-Agent: python-neutronclient +Accept: application/json + + + List VPN Services: Response + + +
+
+ Show VPN service details + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/vpnservices/service-id + Shows details about a specified VPN + service. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403), Not Found + (404) + This operation does not require a request + body. + This operation returns a response body. + + Show VPN Service: Request + + GET /v2.0/vpn/vpnservices/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json +User-Agent: python-neutronclient +Accept: application/json + + + Show VPN Service: Response + + +
+
+ Create VPN service + + + + + + + Verb + URI + Description + + + + + &POST; + /vpn/vpnservices + Creates a VPN service. + + + + Normal Response Code: 201 + + Error Response Codes: Unauthorized + (401), Bad Request + (400) + This operation requires a request body. + This operation returns a response body. + + Create VPN Service: Request + POST /v2.0/vpn/vpnservices.json +User-Agent: python-neutronclient +Accept: application/json + + + + Create VPN: Response + HTTP/1.1 201 Created +Content-Type: application/json; charset=UTF-8 + + +
+
+ Update VPN service + + + + + + + Verb + URI + Description + + + + + &PUT; + /vpn/vpnservices/service-id + Updates a VPN service, provided status is + not indicating a PENDING_* state. + + + + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404) + + Update VPN Service: Request + PUT /v2.0/vpn/vpnservices/41bfef97-af4e-4f6b-a5d3-4678859d2485.json +User-Agent: python-neutronclient +Accept: application/json + + + + Update VPN Service: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Delete VPN service + + + + + + + Verb + URI + Description + + + + + &DELETE; + /vpn/vpnservices/service-id + Deletes a VPN service. + + + + Normal Response Code: 204 + + Error Response Codes: Unauthorized + (401), Not Found + (404), Conflict + (409) + This operation does not require a request + body. + This operation does not return a response + body. + + Delete VPN Service: Request + DELETE /v2.0/vpn/vpnservices/1be5e5f7-c45e-49ba-85da-156575b60d50.json +User-Agent: python-neutronclient +Accept: application/json + + + Delete VPN Service: Response + HTTP/1.1 204 No Content +Content-Length: 0 + +
+ +
+ +
+ IKE policies + Manage IKE policies through the VPN as a Service + extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IKE Policy Attributes
AttributeTypeRequiredCRUD + + + 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the IKE policy.
tenant_iduuid-strYesCRNonevalid tenant_idUnique identifier for owner of the VPN + service.
namestringyesCRUNoneN/AFriendly name for the IKE policy.
descriptionstringnoCRUNoneN/ADescription of the IKE policy.
auth_algorithmstringnoCRUsha1N/AAuthentication Hash algorithms: sha1.
encryption_algorithmstringnoCRUaes-128N/AEncryption Algorithms: 3des, aes-128, aes-256, + aes-192, etc.
phase1_negotiation_modestringnoCRUMain ModeN/AIKE mode: Main Mode.
pfsstringnoCRUGroup5N/APerfect Forward Secrecy: Group2, Group5, or + Group14.
ike_versionstringnoCRUv1N/AVersion: v1 or v2.
lifetimedictnoCRUunits: seconds, value: 3600.Dictionary should be in this form: {'units': + 'seconds', 'value': 2000}. Value is a positive + integer.Lifetime of the SA. Units in 'seconds'. Either + units or value may be omitted.
+ + + +
+ List IKE policies + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/ikepolicies + Lists IKE policies. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List IKE Policies: Request + + GET /v2.0/vpn/ikepolicies.json +User-Agent: python-neutronclient +Accept: application/json + + + List IKE Policies: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Show IKE policy details + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/ikepolicies/ikepolicy-id + Shows details for a specified IKE + policy. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403), Not Found + (404) + This operation does not require a request + body. + This operation returns a response body. + + Show IKE Policy: Request + + GET /v2.0/vpn/ikepolicies/5522aff7-1b3c-48dd-9c3c-b50f016b73db.json +User-Agent: python-neutronclient +Accept: application/json + + + Show IKE Policy: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Create IKE policy + + + + + + + Verb + URI + Description + + + + + &POST; + /vpn/ikepolicies + Creates an IKE policy. + + + + Normal Response Code: 201 + + Error Response Codes: Unauthorized + (401), Bad Request + (400) + This operation requires a request body. + This operation returns a response body. + + Create IKE Policy: Request + POST /v2.0/vpn/ikepolicies.json +User-Agent: python-neutronclient +Accept: application/json + + + + Create IKE Policy: Response + HTTP/1.1 201 Created +Content-Type: application/json; charset=UTF-8 + + +
+
+ Update IKE policy + + + + + + + Verb + URI + Description + + + + + &PUT; + /vpn/ikepolicies/ikepolicy-id + Updates an IKE policy. + + + + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404) + + Update IKE Policy: Request + PUT /v2.0/vpn/ikepolicies/5522aff7-1b3c-48dd-9c3c-b50f016b73db.json +User-Agent: python-neutronclient +Accept: application/json + + + + Update IKE Policy: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Delete IKE policy + + + + + + + Verb + URI + Description + + + + + &DELETE; + /vpn/ikepolicies/ikepolicy-id + Deletes an IKE policy. + + + + Normal Response Code: 204 + + Error Response Codes: Unauthorized + (401), Not Found + (404), Conflict + (409) + This operation does not require a request + body. + This operation does not return a response + body. + + Delete IKE Policy: Request + DELETE /v2.0/vpn/ikepolicies/5522aff7-1b3c-48dd-9c3c-b50f016b73db.json +User-Agent: python-neutronclient +Accept: application/json + + + Delete IKE Policy: Response + HTTP/1.1 204 No Content +Content-Length: 0 + +
+ +
+ +
+ IPSec policies + Manage IPSec policies through the VPN as a Service + extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IPSec Policy Attributes
AttributeTypeRequiredCRUD + + + 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the IPsec policy.
tenant_iduuid-strYesCRNonevalid tenant_idUnique identifier for owner of the VPN + service.
namestringyesCRUNoneN/AFriendly name for the IPsec policy.
descriptionstringnoCRUNoneN/ADescription of the IPSec policy.
transform_protocolstringnoCRUESPN/ATransform protocol used: ESP, AH, or + AH-ESP.
encapsulation_modestringnoCRUtunnelN/AEncapsulation mode: tunnel or transport.
auth_algorithmstringnoCRUsha1N/AAuthentication algorithm: sha1.
encryption_algorithmstringnoCRUaes-128N/AEncryption Algorithms: 3des, aes-128, aes-256, + or aes-192.
pfsstringnoCRUgroup5N/APerfect Forward Secrecy: group2, group5, or + group14.
lifetimedictnoCRUunits: seconds, value: 3600.Dictionary should be in this form: {'units': + 'seconds', 'value': 2000}. Value is a positive + integer.Lifetime of the SA. Units in 'seconds'. Either + units or value may be omitted.
+ + + +
+ List IPSec policies + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/ipsecpolicies + Lists IPSec policies. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List IPSec Policies: Request + + GET /v2.0/vpn/ipsecpolicies.json +User-Agent: python-neutronclient +Accept: application/json + + + List IPSec Policies: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Show IPSec policy details + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/ipsecpolicies/ipsecpolicy-id + Shows details for a specified IPSec + policy. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403), Not Found + (404) + This operation does not require a request + body. + This operation returns a response body. + + Show IPSec policy: Request + + GET /v2.0/vpn/ipsecpolicies/5291b189-fd84-46e5-84bd-78f40c05d69c.json +User-Agent: python-neutronclient +Accept: application/json + + + Show IPSec policy: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Create IPSec Policy + + + + + + + Verb + URI + Description + + + + + &POST; + /vpn/ipsecpolicies + Creates an IPSec policy. + + + + Normal Response Code: 201 + + Error Response Codes: Unauthorized + (401), Bad Request + (400) + This operation requires a request body. + This operation returns a response body. + + Create IPSec policy: Request + POST /v2.0/vpn/ipsecpolicies.json +User-Agent: python-neutronclient +Accept: application/json + + + + Create IPSec policy: Response + HTTP/1.1 201 Created +Content-Type: application/json; charset=UTF-8 + + +
+
+ Update IPSec Policy + + + + + + + Verb + URI + Description + + + + + &PUT; + /vpn/ipsecpolicies/ipsecpolicy-id + Updates an IPSec policy. + + + + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404) + + Update IPSec policy: Request + PUT /v2.0/vpn/ipsecpolicies/5291b189-fd84-46e5-84bd-78f40c05d69c.json +User-Agent: python-neutronclient +Accept: application/json + + + + Update IPSec policy: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Delete IPSec policy + + + + + + + Verb + URI + Description + + + + + &DELETE; + /vpn/ipsecpolicies/ipsecpolicy-id + Deletes an IPSec policy. + + + + Normal Response Code: 204 + + Error Response Codes: Unauthorized + (401), Not Found + (404), Conflict + (409) + This operation does not require a request + body. + This operation does not return a response + body. + + Delete IPSec policy: Request + DELETE /v2.0/vpn/ipsecpolicies/5291b189-fd84-46e5-84bd-78f40c05d69c.json +User-Agent: python-neutronclient +Accept: application/json + + + Delete IPSec policy: Response + HTTP/1.1 204 No Content +Content-Length: 0 + +
+
+ +
+ IPSec site connections + Manage IPSec site-to-site connections through the VPN as + a Service extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IPSec site connection attributes
AttributeTypeRequiredCRUD + + + 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the IPSec site-to-site + connection.
tenant_iduuid-strYesCRNonevalid tenant_idUnique identifier for owner of the VPN + service.
namestringnoCRUNoneN/AName for IPSec site-to-site connection.
descriptionstringnoCRUNoneN/ADescription of the IPSec site-to-site + connection.
peer_addressstringyesCRUN/AN/APeer gateway public IPv4/IPv6 address or + FQDN.
peer_idstringyesCRUN/AN/APeer router identity for authentication. Can + be IPv4/IPv6 address, e-mail address, key id, + or FQDN.
peer_cidrslist[string]yesCRUN/Aunique list of valid cidr in the form + <net_address>/<prefix>Peer private CIDRs.
route_modestringnoRstaticstaticRoute mode: static. This will be extended in + the future.
mtuintegernoCRU1500Integer. Minimum is 68 for IPv4 and 1280 for + IPv6.Maximum Transmission Unit to address + fragmentation.
auth_modestringnoRpskpsk/certsAuthentication mode: PSK or certificate.
pskstringyesCRUN/ANOPre Shared Key: any string.
initiatorstringnoCRUbi-directionalbi-directional / response-onlyWhether this VPN can only respond to + connections or can initiate as well.
admin_state_upboolN/ACRUTRUEtrue / falseAdministrative state of VPN connection. If + false (down), VPN connection does not forward + packets.
statusstringN/ARN/AN/AIndicates whether VPN connection is currently + operational. Possible values include: ACTIVE, + DOWN, BUILD, ERROR, PENDING_CREATE, + PENDING_UPDATE, or PENDING_DELETE.
ikepolicy_iduuidyesCRN/AUnique identifier of IKE policyUnique identifier of IKE policy.
ipsecpolicy_iduuidyesCRN/AUnique identifier of IPSec policyUnique identifier of IPSec policy.
vpnservice_iduuidyesCRN/AUnique identifier of VPN serviceUnique identifier of VPN service.
dpddictnoCRUaction: hold, interval: 30, timeout: 120Dictionary should be in this form: {'action': + 'clear', 'interval': 20, 'timeout': 60}. + Interval is positive integer. Timeout is + greater than interval.Dead Peer Detection protocol controls. Action: + clear, hold, restart, disabled, or + restart-by-peer. Interval and timeout in + seconds.
+ + + +
+ List IPSec site connections + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/ipsec-site-connections + Lists the IPSec site-to-site + connections. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403) + This operation does not require a request + body. + This operation returns a response body. + + List IPSec site connections: Request + + GET /v2.0/vpn/ipsec-site-connections.json +User-Agent: python-neutronclient +Accept: application/json + + + List IPSec site connections: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Show IPSec site connection details + + + + + + + Verb + URI + Description + + + + + &GET; + /vpn/ipsec-site-connections/connection-id + Shows details about a specified IPSec + site-to-site connection. + + + + Normal Response Code: + 200 + + Error Response Codes: Unauthorized + (401), Forbidden + (403), Not Found + (404) + This operation does not require a request + body. + This operation returns a response body. + + Show IPSec site connection: Request + GET /v2.0/vpn/ipsec-site-connections/cbc152a0-7e93-4f98-9f04-b085a4bf2511.json +User-Agent: python-neutronclient +Accept: application/json + + + Show IPSec site connection: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Create IPSec site connection + + + + + + + Verb + URI + Description + + + + + &POST; + /vpn/ipsec-site-connections + Creates an IPSec site connection. + + + + Normal Response Code: 201 + + Error Response Codes: Unauthorized + (401), Bad Request + (400) + This operation requires a request body. + This operation returns a response body. + + Create IPSec site connection: Request + POST /v2.0/vpn/ipsec-site-connections.json +User-Agent: python-neutronclient +Accept: application/json + + + + Create IPSec site connection: Response + HTTP/1.1 201 Created +Content-Type: application/json; charset=UTF-8 + + +
+
+ Update IPSec site connection + + + + + + + Verb + URI + Description + + + + + &PUT; + /vpn/ipsec-site-connections/connection-id + Updates an IPSec site-to-site connection, + provided status is not indicating a + PENDING_* state. + + + + Normal Response Code: + 200 + Error Response Codes: Unauthorized + (401), Bad Request + (400), Not Found + (404) + + Update IPSec site connection: Request + PUT /v2.0/vpn/ipsec-site-connections/f7cf7305-f491-45f4-ad9c-8e7240fe3d72.json +User-Agent: python-neutronclient +Accept: application/json + + + + Update IPSec site connection: Response + HTTP/1.1 200 OK +Content-Type: application/json; charset=UTF-8 + + +
+
+ Delete IPSec site connection + + + + + + + Verb + URI + Description + + + + + &DELETE; + /vpn/ipsec-site-connections/connection-id + Deletes an IPSec site-to-site + connection. + + + + Normal Response Code: 204 + + Error Response Codes: Unauthorized + (401), Not Found + (404), Conflict + (409) + This operation does not require a request + body. + This operation does not return a response + body. + + Delete IPSec site connection: Request + DELETE /v2.0/vpn/ipsec-site-connections/cbc152a0-7e93-4f98-9f04-b085a4bf2511.json +User-Agent: python-neutronclient +Accept: application/json + + + Delete IPSec site connection: Response + HTTP/1.1 204 No Content +Content-Length: 0 + +
+
+
diff --git a/v2.0/section_neutron-extra-dhcp-opt-ext.xml b/v2.0/section_neutron-extra-dhcp-opt-ext.xml deleted file mode 100755 index c9d13a9..0000000 --- a/v2.0/section_neutron-extra-dhcp-opt-ext.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - - '> - - - - - - '> -]> -
- The Extra DHCP Options Extension (extra-dhcp-opt) - The Neutron DHCP options extension allows adding DHCP options that are associated to a - Neutron Port. They are tagged such that they can be associated from the hosts file to - designate a specific network interface and port. The DHCP tag scheme used to associate - options to the host files is the port_id (UUID - in the form of 8-4-4-4-12 for a total of 36 - characters), these associate options to a Neutron Port and its network. The Dynamic Host - Configuration Protocol (DHCP) provides a framework for passing configuration information to - hosts on a TCP/IP network. Configuration parameters and other information are carried in - tagged data items that are stored in the 'options' field of the DHCP message. - You can specify a DHCP options when defining or updating a Port by specifying the - extra_dhcp_opts tag and providing its options as name value pairs e.g. - opt_name='bootfile-name', opt_value='pxelinux.0'. -
- Concepts - The extra-dhcp-opt extension is an attribute extension which adds the following set of - attributes to the port resource: - - - - extra-dhcp-opt:opt_name - Specified - the DHCP option that this is defined as mapped to this port resource. - Examples are bootfile-name, - server-ip-address, tftp-server, - etc.. - - - extra-dhcp-opt:opt_value - Identifies - the value associated with the opt_name. These are handled in opt_name, - opt_value pairs only. value_opt can be any text string depending upon the - name. - - - - The actual semantics of extra-dhcp-opt attributes depend on the name of the dhcp - option being used that defines the vendor extension to DHCP. For example reference RFC: - http://tools.ietf.org/html/rfc2132, contains specific detail on BOOTP Vendor Extensions. - -
-
- Port API operations with extra-dhcp-opt port extension - This section discusses operations for setting and retrieving the extra-dhcp-opt port - extension attributes for port objects. -
- List Ports - - - - - - - Verb - URI - Description - - - - - &GET; - /ports - Returns a list of ports with their attributes. - - - - Normal Response Code: 200 OK - Error Response Codes: 401 Unauthorized - This operation returns, all the ports defined in Neutron that this user has - access to. - - List Ports with extra_dhcp_opts: JSON Response - - -
-
- Show Port - - - - - - - - Verb - URI - Description - - - - - &GET; - /ports/port_id - Returns details about a specific port, including extra-dhcp-opt - attributes. - - - - - Normal Response Code: 200 OK - Error Response Code: 401 Unauthorized, 404 Not Found - This operation returns, for the port specified in the request URI, its port - attributes, including the extra_dhcp_opts attributes. - - Show port with extra-dhcp-opt attributes: JSON Response - - -
-
- Create Port - - - - - - - - Verb - URI - Description - - - - - &POST; - /ports - Create a new port and explicitly specify attributes with the - extra-dhcp-opt extension attributes. - - - - - Normal Response Code: 200 OK - Error Response Code: 401 Unauthorized. - This operation returns, for the port specified in the request URI, its port - attributes, including the extra_dhcp_opts attributes. - - Create port with extra-dhcp-opt attributes: JSON Request - - - - Create port with extra-dhcp-opt attributes: JSON Response - - -
-
- Update Port - - - - - - - Verb - URI - Description - - - - - &PUT; - /ports/port_id - Updates a port's attributes, including extra_dhcp_opts extension - attributes. - - - - - Normal Response Code: 200 OK - Error Response Code: 401 Unauthorized. - This operation allow for the updating of attributes for the port specified in the - request URI, its port attributes, including the extra_dhcp_opts attributes. - - Update port with extra-dhcp-opt attributes: JSON Request - - - - Update port with extra-dhcp-opt attributes: JSON Response - - -
-
- -
diff --git a/v2.0/section_neutron-l3-ext.xml b/v2.0/section_neutron-l3-ext.xml deleted file mode 100644 index 87f9a37..0000000 --- a/v2.0/section_neutron-l3-ext.xml +++ /dev/null @@ -1,990 +0,0 @@ - - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - - '> - - - - - - '> - -]> -
- Layer-3 Networking Extension - (<literal>router</literal>) - The Layer-3 networking extension enables OpenStack - Networking API users to route packets between subnets, forward - packets from internal networks to external ones, and access - instances from external networks through Floating IPs. - This extension introduces the following resources: - - router, a - logical entity for forwarding packets across - internal subnets and NATting them on external - networks through an appropriate external - gateway. - - - floatingip, - representing an external IP address mapped to a - OpenStack Networking port attached to an internal - network. - - - -
- Concepts - The OpenStack Networking layer-3 extension is a resource - extension. It defines two new resources: router and floatingip. - A router is used to - interconnect subnets and forward traffic among them. - Another feature of the router is to NAT internal traffic - to external networks. - A router has an interface for each subnet it is - associated with. By default the IP address of such - interface is the subnet's gateway IP. Also, whenever a - router is associated with a subnet, a port for that router - interface will be added to the subnet's network. - A floating IP is an IP - address on an external network, which is associated with a - specific port, and optionally a specific IP address, on a - private OpenStack Networking network. Therefore a floating - IP allows access to an instance on a private network from - an external network. Floating IPs can only be defined on - networks for which the attribute - router:external (by the external network - extension) has been set to True. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Router Attributes
AttributeTypeRequiredCRUD - - - - 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the router.
nameStringNoCRUNoneN/AHuman readable name for the router. Does not - have to be unique
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the router
statusStringN/ARN/AN/AIndicates whether a router is currently - operational or not
tenant_iduuid-strNoCRDerived from Authentication tokenN/AOwner of the router. Only admin users can - specify a tenant identifier other than its own -
external_gateway_infodictNoCRUNoneNo constraintInformation on external gateway for the - router
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Floating IP Attributes
AttributeTypeRequiredCRUDDefault ValueValidation ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the Floating IP - instance
floating_network_iduuid-strYesCRN/AUUID PatternUUID of the external network where the - floating IP is to be created
port_iduuid-strYesCRUN/AUUID PatternUUID of the port on an internal OpenStack - Networking network which should be associated - to the Floating IP
fixed_ip_addressIP AddressNoCRUNoneIP address or nullSpecific IP address on - port_id which should be - associated with the floating IP
floating_ip_addressIP AddressN/ARAutomatically allocated from poolN/AAddress of the floating IP on the external - network
tenant_iduuid-strNoCRDerived from Authentication tokenN/AOwner of the Floating IP. Only admin users can - specify a tenant identifier other than its own -
-
- -
- Router API Operations - This section discusses operations for creating and - managing routers through the OpenStack Networking L3 API - extension. -
- List Routers - - - - - - - - Verb - URI - Description - - - - - &GET; - /routers - Returns a list of logical routers - accessible to the tenant submitting - the request. - - - - - Normal Response Code: 200 - - Error Response Codes: Unauthorized - (401) - This operation returns a list of routers to which - the tenant has access. Default policy settings return - only those routers 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 should be returned by using - the fields query parameter. - Additionally, results can be filtered by using query - string parameters. - This operation does not require a request body; this - operation returns a response body. - - List Routers: JSON Request - GET /v2.0/routers -Accept: application/json - - - List Routers: JSON Response - - -
- -
- Show Router - - - - - - - - Verb - URI - Description - - - - - &GET; - /routers/router_id - Returns details about a specific - logical router. - - - - - Normal Response Code: 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), Not Found - (404) - This operation returns the details for a specific - router whose identifier is specified on the request - URI. Users can control which attributes should be - returned by using the fields - query parameter. - This operation does not require a request - body. - This operation returns a response body. - - Show Router: JSON Request - GET /v2.0/routers/a9254bdb-2613-4a13-ac4c-adc581fba50d -Accept: application/json - - - Show Router: JSON Response - - -
- -
- Create Router - - - - - - - - Verb - URI - Description - - - - - &POST; - /routers - Create a new logical router. - - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized - (401), Bad Request - (400) - This operation creates a new logical router. When - it is created, a logical router does not have any - internal interface. In other words, it is not - associated to any subnet. The user can optionally - specify an external gateway for a router at create - time; a router's external gateway must be plugged into - an external network, that is to say a network for - which the extended field - router:external is set to true. - In order to specify an external gateway, the - identifier of the external network must be passed in - the request body's - external_gateway_info - attribute. This can be achieved as shown in the - following snippet: - "external_gateway_info" : -{ - "network_id": <external_network_uuid> -} - This operation requires a request body. - This operation returns a response body. - - Create Router: JSON Request - - - - Create Router: JSON Response - - -
- -
- Update Router - - - - - - - - Verb - URI - Description - - - - - &PUT; - /routers/router_id - Updates a logical router. - - - - - Normal Response Code: 200 - - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404) - This operation updates a logical router. Beyond - the name and the administrative state, the only - parameter which can be updated with this operation is - the external gateway. For more information concerning - how to set the external gateway for a router, please - refer to the previous section (Create Router) or to - the following example. - Please note that this operation does not allow to - update router interfaces. To this aim, the add router - interface and remove router - interface should be used. - - Update Router: JSON Request - - - - Update Router: JSON Response - - -
- -
- Delete Router - - - - - - - - Verb - URI - Description - - - - - &DELETE; - /routers/router_id - Removes a logical router and its - external gateway interface, if it - exists - - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized - (401), Not Found - (404), Conflict - (409) - This operation removes a logical router; the - operation will fail if the router still has some - internal interfaces. - Users must remove all router interfaces before - deleting the router, by removing all internal - interfaces through remove router - interface operation. - This operation does not require a request - body. - This operation does not return a response - body. - - Delete Router: JSON Request - DELETE /v2.0/routers/8604a0de-7f6b-409a-a47c-a1cc7bc77b2e -Accept: application/json - -
-
- Add Interface to Router - - - - - - - - Verb - URI - Description - - - - - &PUT; - /routers/router_id/add_router_interface - Adds an internal interface to a - logical router. - - - - - Normal Response Code: 200 - - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404), Conflict - (409) - This operation attaches a subnet to an internal - router interface. Either a subnet identifier or a port - identifier must be passed in the request body. If both - are specified, a 400 Bad Request - error is returned. - When the subnet_id attribute is - specified in the request body, the subnet's gateway ip - address is used to create the router interface; - otherwise, if port_id is specified, - the IP address associated with the port is used for - creating the router interface. - It is worth remarking that a 400 Bad - Request error is returned if several IP - addresses are associated with the specified port, or - if no IP address is associated with the port; also a - 409 Conflict is returned if the - port is already used. - - Add Router Interface: JSON Request - PUT /v2.0/routers/8604a0de-7f6b-409a-a47c-a1cc7bc77b2e/add_router_interface -Accept: application/json - -{"subnet_id": "a2f1f29d-571b-4533-907f-5803ab96ead1"} - - - Add Router Interface: JSON Response - { - "subnet_id": "a2f1f29d-571b-4533-907f-5803ab96ead1", - "port_id": "3a44f4e5-1694-493a-a1fb-393881c673a4" -} - - The port identifier returned by this operation can - either be the same identifier passed in the request - body or the identifier of a new port created by this - operation to attach the subnet specified by - subnet_id to the router. - It is also worth noting that after executing this - operation, the device_id attribute - of this port is set to the router's identifier, and - the device_owner attribute is set - to network:router_interface, as - shown in the following example: - -
- -
- Remove Interface from Router - - - - - - - - Verb - URI - Description - - - - - &PUT; - /routers/router_id/remove_router_interface - Removes an internal interface from a - logical router. - - - - - Normal Response Code: 200 - - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404), Conflict - (409) - This request requires a request body. - This request returns a response body. - This operation removes an internal router interface, - thus detaching a subnet from the router. - This operation removes an internal router interface, - which detaches a subnet from the router. You must - specify either a subnet ID or port ID in the request - body; this value is used to identify the router - interface to remove. - You can also specify both a subnet ID and port ID. - If you specify both IDs, the subnet ID must correspond - to the subnet ID of the first IP address on the port - specified by the port ID. Otherwise, the operation - returns a 409 - Conflict error. The response - contains information about the affected router and - interface. - A 404 - Not Found error will be - returned either if the router or the subnet/port do - not exist or are not visible to the user. - As a consequence of this operation, the port - connecting the router with the subnet is removed from - the subnet's network. - - Remove Router Interface: JSON Request - PUT /v2.0/routers/8604a0de-7f6b-409a-a47c-a1cc7bc77b2e/remove_router_interface -Accept: application/json - -{"subnet_id": "a2f1f29d-571b-4533-907f-5803ab96ead1"} - - - Remove Router Interface: Response - { - "id": "8604a0de-7f6b-409a-a47c-a1cc7bc77b2e", - "tenant_id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7", - "port_id": "3a44f4e5-1694-493a-a1fb-393881c673a4", - "subnet_id": "a2f1f29d-571b-4533-907f-5803ab96ead1" -} - - -
-
- -
- Floating IP API Operations - This section discusses operations for creating and - managing floating IPs through the OpenStack Networking L3 - API extension. -
- List Floating IPs - - - - - - - - Verb - URI - Description - - - - - &GET; - /floatingips - Returns a list of floating IPs - accessible to the tenant submitting - the request. - - - - - Normal Response Code: 200 OK - Error Response Codes: 401 Unauthorized - This operation does not require a request - body. - This operation returns a response body. - The operation returns a list of floating IPs to - which the tenant has access. Default policy settings - return only those floating IPs 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 should be returned by - using the fields query - parameter. Additionally, results can be filtered by - using query string parameters. - - List Floating IPs: JSON Request - GET /v2.0/floatingips -Accept: application/json - - - List Floating IPs: JSON Response - - -
-
- Show Floating IP - - - - - - - - Verb - URI - Description - - - - - &GET; - /floatingips/floatingip_id - Returns details about a specific - Floating IP. - - - - - Normal Response Code: 200 OK - Error Response Code: 401 Unauthorized, 404 Not - Found - This operation does not require a request - body. - This operation returns a response body. - This operation returns the details for a specific - floating IP whose identifier is specified on the - request URI. Users can control which attributes should - be returned by using the fields - query parameter. - - Show Floating IP: JSON Request - GET /v2.0/floatingips/2f245a7b-796b-4f26-9cf9-9e82d248fda7.json?fields=fixed_ip_address&fields=floating_ip_address -Accept: application/json - - - Show Floating IP: JSON Response - - -
- -
- Create Floating IP - - - - - - - - Verb - URI - Description - - - - - &POST; - /floatingips - Creates a floating IP, and configures - its association with an internal port, - if the relevant information are - specified - - - - - Normal Response Code: 200 OK - Error Response Code: 400 Bad Request, 401 - Unauthorized, 409 Conflict - This operation requires a request body. - This operation returns a response body. - This operation creates a floating IP. Users can - specify association information for this floating IP - in the request body. These information are however - optional, and can be specified with an UPDATE call at - a later stage. The only mandatory parameter in the - request body is the external network identifier, - floating_network_id. Floating - IPs can only be created on external networks. If the - network specified by - floating_network_id is not - external (for example, - router:external=False), a - 400 error is - returned. - An address for the floating ip will be automatically - allocated, unless the - floating_ip_address attribute - is specified in the request body. If the requested - floating IP address does not fall in the external - network's subnet range, a 400 - error will be returned. If the requested floating IP - address is already in use, a - 409 error code will be - returned. - Users can associate the floating IP with an internal - port using the port_id attribute in - the request body. If an invalid port identifier is - specified, a 404 error will be - returned. The internal OpenStack Networking port - associated with the Floating IP must have at least an - IP address configured, otherwise a - 400 error will be - returned. - As an OpenStack Networking port might be associated - with multiple IP addresses, the particular IP address - to associate with the floating IP can be specified - using the fixed_ip_address request - body parameter. The default logic of this operation is - to associate the floating IP with a single IP address - configured on a port; hence, if a port has multiple IP - addresses, it is mandatory to specify the - fixed_ip_address attribute. If - an invalid IP address is specified in - fixed_ip_address a - 400 error will be - returned. - If the internal OpenStack Networking port and ip - address selected for association are already - associated to another floating IP, a 409 error will be - returned. - - Create Floating IP: JSON Request - - - - Create Floating IP: JSON Response - - -
- -
- Update Floating IP - - - - - - - - Verb - URI - Description - - - - - &PUT; - /floatingips/floatingip_id - Updates a floating IP and its - association with an internal port, if - the relevant information are specified - in the request body. - - - - - Normal Response Code: 200 OK - Error Response Code: 400 Bad Request, 401 - Unauthorized, 404 Not Found, 409 Conflict - This operation requires a request body. - This operation returns a response body. - This operation updates an - association between a floating IP and an OpenStack - Networking port. The association process is exactly - the same as the one discussed for the create floating IP - operation. - To disassociate a floating IP from a port, set the - port_id request attribute to - null or omit it from the request body. - - Update Floating IP (associate): JSON - Request - - - - Update Floating IP (associate): JSON - Response - - - - Update Floating IP (disassociate): JSON - Request - - - - Update Floating IP (disassociate): JSON - Response - - -
-
- Delete Floating IP - - - - - - - - Verb - URI - Description - - - - - &DELETE; - /floatingips/floatingip_id - Removes a floating IP and its - association information. - - - - - Normal Response Code: 204 - Error Response Code: 401 Unauthorized, 404 Not - Found - This operation does not require a request - body. - This operation does not return a response - body. - The operation removes the floating IP whose - identifier is specified in the request URI. If the - floating IP being removed is associated with an - OpenStack Networking port, the association is removed - as well. - - - Delete Floating IP: JSON Request - DELETE /v2.0/floatingips/2f245a7b-796b-4f26-9cf9-9e82d248fda7 -Accept: application/json - - -
-
-
diff --git a/v2.0/section_neutron-loadbalancer-ext.xml b/v2.0/section_neutron-loadbalancer-ext.xml deleted file mode 100644 index 94c49d0..0000000 --- a/v2.0/section_neutron-loadbalancer-ext.xml +++ /dev/null @@ -1,1841 +0,0 @@ - -GET'> -PUT'> -POST'> -DELETE'> -]> -
- The Load Balancer as a Service (LBaaS) extension - The LBaaS extension enables OpenStack tenants to - load-balance their VM traffic. The extension enables you - to: - - - Load-balance client traffic from one network to - application services, such as VMs, on the same or a - different network. - - - Load-balance several protocols, such as TCP and - HTTP. - - - Monitor the health of application services. - - - Support session persistence. - - -
- Concepts - This extension introduces these concepts: - - - VIP - - The primary load balancing configuration - object. Specifies the virtual IP address and - port where client traffic is received. Also - defines other details such as the load - balancing method to be used, protocol, and so - on. - This entity is sometimes known in - load-balancing products as a - virtual server, - vserver, or - listener. - - - - pool - - A logical set of devices, such as web - servers, that you group together to receive - and process traffic. - The load balancing function chooses which - member of the pool handles the new requests or - connections received on the VIP address. Each - VIP has one pool. - - - - pool member - - The application that runs on the back-end - server. - - - - health monitor - - Determines whether or not back-end members - of the VIP pool can process a request. A pool - can have several health monitors associated - with it. - The LBaaS extension supports these types of - health monitors: - - - PING. Pings the members - by using ICMP. - - - TCP. Connects to the - members by using TCP. - - - HTTP. Sends an HTTP - request to the member. - - - HTTPS. Sends a secure - HTTP request to the member. - - - When a pool has several monitors associated - with it, all monitors check each member of the - pool. If any monitor declares a member as - unhealthy, the member status is changed to - inactive - and the member does not participate in the - load balancing for the pool. - All monitors must declare the member to be - healthy for it to stay active. - - - - session persistence - - Forces connections or requests in the same - session to be processed by the same member as - long as it is active. - The LBaaS extension supports these types of - persistence: - - - SOURCE_IP. All - connections that originate from the - same source IP address are handled by - the same member of the pool. - - - HTTP_COOKIE. The load - balancing function creates a cookie on - the first request from a client. - Subsequent requests that contain the - same cookie value are handled by the - same member of the pool. - - - APP_COOKIE. The load - balancing function relies on a cookie - established by the back-end - application. All requests with the - same cookie value are handled by the - same member of the pool. - - - Absence of session_persistence - attribute means no session persistence - mechanism is used. - When no session persistence is used, the - session_persistence attribute - does not appear in the API response, instead - of returning null. - You can clear session persistence for the - VIP by sending null in - session_persistence attribute - in a VIP update request. - - - -
-
- High-level task flow - To use the LBaaS extension to configure load balancing, - you must complete these high-level tasks: - - - Create a pool, which is initially empty. - - - Create one or several members in the - pool. - - - Create one or several health monitors. - - - Associate the health monitors with the - pool. - - - Create a VIP that is associated with the - pool. - - -
-
- VIP operations - This section discusses operations for managing load - balancer VIPs through the LBaaS extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VIP attributes
AttributeTypeRequiredCRUD - - - 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the VIP.
tenant_iduuid-strYesCRDerived from authentication token.N/AOwner of the VIP. Only an admin user can - specify a tenant identifier other than its - own.
nameStringNoCRUNoneN/AHuman readable name for the VIP. Does not have - to be unique.
descriptionStringNoCRUNoneN/AHuman readable description for the VIP.
subnet_iduuid-strNoCRNoneUUID pattern.The subnet on which to allocate the VIP - address.
addressIPNoCRNoneIP address or nullThe IP address of the VIP.
protocolStringYesCRNone{ "TCP" | "HTTP" | "HTTPS" }The protocol of the VIP address.
protocol_portIntegerYesCRNone[0..65535]The port on which to listen to client traffic - that is associated with the VIP address.
pool_iduuid-strNoCRUNoneUUID pattern.The pool that the VIP - associated with.
session_persistencedictNoCRUNonecomposite - Session persistence is a dictionary - with the following attributes: - - - type - any of - APP_COOKIE, - HTTP_COOKIE or - SOURCE_IP - - - cookie_name - any - string, required if type is - APP_COOKIE - - - Session persistence parameters of the - VIP. - Absence of - session_persistence - attribute means no session persistence - mechanism is used. - When no session persistence is used, the - session_persistence - attribute does not appear in the API - response, instead of returning - null. - You can clear session persistence for - the VIP by sending null in - session_persistence - attribute in a VIP update - request.
connection_limitIntegerNoCRU-1NoneThe maximum number of connections allowed for - the VIP or -1 if the limit is not - set.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the VIP
statusStringN/ARN/AN/AIndicates whether a VIP is currently - operational.
-
- List VIPs - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/vips - Lists VIPs. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request - body. - This operation returns a response body. - - List VIPs: HTTP request - GET /v2.0/lb/vips.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - List VIPs: JSON response - - -
-
- Show VIP details - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/vips/vip-id - Shows details for a specified VIP. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), Not Found - (404) - This operation does not require a request - body. - This operation returns a response body. - - Show VIP details: HTTP request - GET /v2.0/lb/vips/4ec89087-d057-4e2c-911f-60a3b47ee304.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - Show VIP details: JSON response - - -
-
- Create VIP - - - - - - - Verb - URI - Description - - - - - &POST; - /lb/vips - Creates a load balancer VIP. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized - (401), Bad Request - (400) - This operation requires a request body. - This operation returns a response body. - - Create VIP: HTTP and JSON request - POST /v2.0/lb/vips.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - - Create VIP: HTTP and JSON response - HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - -
-
- Update VIP - - - - - - - Verb - URI - Description - - - - - &PUT; - /lb/vips/vip-id - Updates a load balancer VIP. - - - - Normal Response Code: - 200 - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404) - - Update VIP: HTTP and JSON request - PUT /v2.0/lb/vips/c987d2be-9a3c-4ac9-a046-e8716b1350e2.json -User-Agent: python-neutronclient -Accept: application/json - - - - Update VIP: HTTP and JSON response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Delete VIP - - - - - - - Verb - URI - Description - - - - - &DELETE; - /lb/vips/vip-id - Removes a load balancer VIP. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized - (401), Not Found - (404), Conflict - (409) - This operation does not require a request - body. - This operation does not return a response - body. - - Delete VIP: HTTP request - DELETE /v2.0/lb/vips/c987d2be-9a3c-4ac9-a046-e8716b1350e2.json HTTP/1.1 -Accept: application/json - - - Delete VIP: HTTP response - HTTP/1.1 204 No Content -Content-Length: 0 - -
-
- -
- Pool operations - This section discusses operations for managing load - balancer pools through the Load balancing as a service - extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pool Attributes
AttributeTypeRequiredCRUD - - - 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the pool.
tenant_iduuid-strYesCRDerived from authentication token.N/AOwner of the pool. Only an admin user can - specify a tenant identifier other than its - own
vip_iduuid-strNoRNoneUUID pattern.The vip that the pool - associated with.
nameStringNoCRUNoneN/AHuman readable name for the pool. Does not - have to be unique.
descriptionStringNoCRUNoneN/AHuman readable description for the pool.
subnet_iduuid-strNoCRNoneUUID pattern.The network that pool members belong to.
protocolStringYesCRNone{ "TCP" | "HTTP" | "HTTPS" }The protocol of the pool.
lb_methodStringYesCRUNoneNoneThe algorithm used to distribute load between - the members of the pool.
health_monitorsuuid-listNoCRUNoneN/AList of health monitors to associate with the - pool.
membersuuid-listNoRNoneN/AList of members that belong to the pool.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the pool.
statusStringN/ARN/AN/AIndicates whether a pool is currently - operational or not.
-
- List pools - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/pools - Lists pools. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request - body. - This operation returns a response body. - - List pools: HTTP request - GET /v2.0/lb/pools.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - List pools: HTTP and JSON response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Show pool - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/pools/pool-id - Returns details about a specific - pool. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), Not Found - (404) - This operation does not require a request - body. - This operation returns a response body. - - Show pool: HTTP request - GET /v2.0/lb/pools/72741b06-df4d-4715-b142-276b6bce75ab.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - Show pool: HTTP and JSON response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Create Pool - - - - - - - Verb - URI - Description - - - - - &POST; - /lb/pools - Create a new load balancer pool. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized - (401), Bad Request - (400) - This operation requires a request body. - This operation returns a response body. - - Create pool: HTTP request - POST /v2.0/lb/pools.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - - Create pool: HTTP and JSON response - HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - -
-
- Update Pool - - - - - - - Verb - URI - Description - - - - - &PUT; - /lb/pools/pool-id - Updates a load balancer pool. - - - - Normal Response Code: - 200 - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404) - - Update pool: HTTP and JSON request - PUT /v2.0/lb/pools/61b1f87a-7a21-4ad3-9dda-7f81d249944f.json -User-Agent: python-neutronclient -Accept: application/json - - - - Update pool: HTTP and JSON response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Delete pool - - - - - - - Verb - URI - Description - - - - - &DELETE; - /lb/pools/pool-id - Removes a load balancer pool. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized - (401), Not Found - (404), Conflict - (409) - This operation does not require a request - body. - This operation does not return a response - body. - - Delete pool: HTTP request - DELETE /v2.0/lb/pools/a224402b-794b-4c0c-9d08-d95640a6f5a1.json HTTP/1.1 -Accept: application/json - - - Delete pool: HTTP response - HTTP/1.1 204 No Content -Content-Length: 0 - -
-
- -
- Member operations - This section discusses operations for managing pool - members through the Load balancing as a service - extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Member Attributes
AttributeTypeRequiredCRUD - - - 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the member.
tenant_iduuid-strYesCRDerived from authentication token.N/AOwner of the member. Only an admin user can - specify a tenant identifier other than its - own.
pool_iduuid-strYesCRUNoneUUID pattern.The pool that the member - belongs to.
addressIPYesCRNoneIP address or null.The IP address of the member.
protocol_portIntegerYesCRNone[0..65535]The port on which the application is - hosted.
weightIntegerNoCRU1[0..256]The weight of a member determines the portion - of requests or connections it services - compared to the other members of the pool. A - value of 0 means the member does not - participate in load-balancing but still - accepts persistent connections.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the member.
statusStringN/ARN/AN/AIndicates whether or not a member is currently - operational.
-
- List members - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/members - Lists members. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request - body. - This operation returns a response body. - - List members: HTTP request - GET /v2.0/lb/members.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - List members: HTTP and JSON response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Show member - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/members/member-id - Returns details about a specific - member. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), Not Found - (404) - This operation does not require a request - body. - This operation returns a response body. - - Show member: HTTP request - GET /v2.0/lb/members/701b531b-111a-4f21-ad85-4795b7b12af6.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - Show member: HTTP and JSON response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Create member - - - - - - - Verb - URI - Description - - - - - &POST; - /lb/members - Creates a load balancer member. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized - (401), Bad Request - (400) - This operation requires a request body. - This operation returns a response body. - - Create member: HTTP and JSON request - POST /v2.0/lb/members.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - - Create member: HTTP and JSON response - HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - -
-
- Update member - - - - - - - Verb - URI - Description - - - - - &PUT; - /lb/members/member-id - Updates a load balancer member. - - - - Normal Response Code: - 200 - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404) - - Update member: HTTP and JSON request - PUT /v2.0/lb/members/b9a7012a-1097-45b2-a973-6572973619bc.json -User-Agent: python-neutronclient -Accept: application/json - - - - Update member: HTTP and JSON response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Delete member - - - - - - - Verb - URI - Description - - - - - &DELETE; - /lb/members/member-id - Removes a load balancer member. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized - (401), Not Found - (404), Conflict - (409) - This operation does not require a request - body. - This operation does not return a response - body. - - Delete member: HTTP request - DELETE /v2.0/lb/members/b9a7012a-1097-45b2-a973-6572973619bc.json HTTP/1.1 -Accept: application/json - - - Delete member: HTTP and JSON response - HTTP/1.1 204 No Content -Content-Length: 0 - -
-
- -
- Health monitor operations - This section discusses operations for managing load - balancer health monitors through the LBaaS - extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Health monitor attributes
AttributeTypeRequiredCRUD - - - 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 constraintsNotes
iduuid-strN/ARgeneratedN/AUnique ID for the health monitor.
tenant_iduuid-strYesCRDerived from authentication token.N/AOwner of the health monitor. Only an admin - user can specify a tenant identifier other - than its own.
typeStringYesCRNone{"PING" | "TCP" | "HTTP" | "HTTPS"}The type of probe send by load balancer to - verify member state
delayIntegerYesCRUNonenon-negativeThe time in seconds between sending probes to - members.
timeoutuuid-strYesCRUNonenon-negativeThe maximum number of seconds for a monitor to - wait for a connection to be established before - it times out. The value must be less than the - delay value.
max_retriesIntegerYesCRUNone[1..10]Number of allowed connection failures before - changing the member's status to INACTIVE.
http_methodStringNo - Required if type - is HTTP or - HTTPS. - CRUGETNoneThe HTTP method used for requests by the - monitor.
url_pathStringNoCRU/NoneThe HTTP path of the request sent by the - monitor to test a member's health. This must - be a string beginning with a / (forward - slash).
expected_codesStringNoCRU200Single value, such as 200, list, such as 200, - 202, or range, such as 200-204.The list of HTTP status codes expected in - response from the member to declare it - healthy.
admin_state_upBoolNoCRUtrue{true | false }Administrative state of the health - monitor.
statusStringN/ARN/AN/AIndicates whether or not a health monitor is - currently operational.
-
- List health monitors - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/health_monitors - Lists health monitors. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request - body. - This operation returns a response body. - - List health monitors: HTTP request - GET /v2.0/lb/health_monitors.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - List health monitors: HTTP and JSON - response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Show health monitor - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/health_monitors/health_monitor-id - Show details for a specified health - monitor. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), Not Found - (404) - This operation does not require a request - body. - This operation returns a response body. - - Show health monitor: HTTP request - GET /v2.0/lb/health_monitors/701b531b-111a-4f21-ad85-4795b7b12af6.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - Show health monitor: HTTP and JSON - response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Create health monitor - - - - - - - Verb - URI - Description - - - - - &POST; - /lb/health_monitors - Creates a load balancer health - monitor. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized - (401), Bad Request - (400) - This operation requires a request body. - This operation returns a response body. - - Create health monitor: HTTP and JSON - request - POST /v2.0/lb/health_monitors.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - - Create health monitor: HTTP and JSON - response - HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - -
-
- Update health monitor - - - - - - - Verb - URI - Description - - - - - &PUT; - /lb/health_monitors/health_monitor-id - Updates a load balancer health - monitor. - - - - Normal Response Code: - 200 - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404) - - Update health monitor: HTTP and JSON - request - PUT /v2.0/lb/health_monitors/466c8345-28d8-4f84-a246-e04380b0461d.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - - Update health monitor: HTTP and JSON - response - HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - -
-
- Delete health monitor - - - - - - - Verb - URI - Description - - - - - &DELETE; - /lb/health_monitors/healthmonitor-id - Deletes a specified health monitor. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized - (401), Not Found - (404), Conflict - (409) - This operation does not require a request - body. - This operation does not return a response - body. - - Delete health monitor: HTTP request - DELETE /v2.0/lb/health_monitors/ada338f0-10d0-4326-b02e-cc123114f240.json HTTP/1.1 -Accept: application/json - - - Delete health monitor: HTTP response - HTTP/1.1 204 No Content -Content-Length: 0 - -
-
- Associate health monitor with a pool - - - - - - - Verb - URI - Description - - - - - &POST; - /lb/pools/pool-id/health_monitors - Associate health monitor with the - pool. - - - - Normal Response Code: - 200 - Error Response Codes: Unauthorized - (401), Bad Request - (400), Not Found - (404) - - Associate health monitor: HTTP and JSON - request - POST /v2.0/lb/pools/72741b06-df4d-4715-b142-276b6bce75ab/health_monitors.json HTTP/1.1 -User-Agent: python-neutronclient -Accept: application/json - - - - Associate health monitor: HTTP and JSON - response - HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - -
-
- Disassociate health monitor from a pool - - - - - - - Verb - URI - Description - - - - - &DELETE; - /lb/pools/pool-id/health_monitors/healthmonitor-id - Disassociates a health monitor from the - pool. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized - (401), Not Found - (404), Conflict - (409) - This operation does not require a request - body. - This operation does not return a response - body. - - Disassociate health monitor: HTTP - request - DELETE /v2.0/lb/pools/72741b06-df4d-4715-b142-276b6bce75ab/health_monitors/ada338f0-10d0-4326-b02e-cc123114f240.json HTTP/1.1 -Accept: application/json - - - Disassociate health monitor: HTTP - response - HTTP/1.1 204 No Content -Content-Length: 0 - -
-
- -
- diff --git a/v2.0/section_neutron-metering-ext.xml b/v2.0/section_neutron-metering-ext.xml deleted file mode 100644 index bc73914..0000000 --- a/v2.0/section_neutron-metering-ext.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - - '> - - - - - - '> - -]> -
- Metering labels and rules - Creates, modifies, and deletes OpenStack Layer3 Metering labels - and rules. - -
diff --git a/v2.0/section_neutron-provider-ext.xml b/v2.0/section_neutron-provider-ext.xml deleted file mode 100644 index 30d267b..0000000 --- a/v2.0/section_neutron-provider-ext.xml +++ /dev/null @@ -1,101 +0,0 @@ - - -
- The Provider Networks Extension - (<literal>provider</literal>) - The provider networks extension allows OpenStack Networking - API users with the appropriate rights, to specify how an - OpenStack Networking network object is mapped to the - underlying networking infrastructure. It also allows users - with the appropriate rights to view such attributes when - networks are queried. - To this aim, it extends the network resource by defining a set of - attributes prefixed with the 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. - - - 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 - Administrator Guide to understand which - values should be specific for each of these attributes - when OpenStack Networking is deployed with a particular - plug-in. The examples shown in this chapter refer to the - Open vSwitch plug-in. - It is also worth noting that the default policy settings - allow only users with administrative rights to specify - these parameters in requests, and to see their values in - responses. By default, the provider network extension - attributes are completely hidden from regular tenants. As - a rule of thumb, if these attributes are not visible in a - GET - /networks/<network-id> operation, this - implies the user submitting the request is not authorized - to view or manipulate provider network attributes. -
-
- Network API operations with provider extension - Set and retrieve the provider extension attributes for - network objects. - - - - - - - - - - - -
-
diff --git a/v2.0/section_neutron-quotas-ext.xml b/v2.0/section_neutron-quotas-ext.xml deleted file mode 100644 index 0393698..0000000 --- a/v2.0/section_neutron-quotas-ext.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - - '> - - - - - '> - -]> -
- Quotas - The neutron.conf configuration file - defines default quota values that are applied to all tenants. - This extension enables an administrative user to define quotas - values on a per-tenant basis. For example, an administrative - user can permit tenant A to create at most X networks and - tenant B to create at most Y networks. - -
diff --git a/v2.0/section_neutron-scheduler-ext.xml b/v2.0/section_neutron-scheduler-ext.xml deleted file mode 100644 index 8bbb1e7..0000000 --- a/v2.0/section_neutron-scheduler-ext.xml +++ /dev/null @@ -1,650 +0,0 @@ - - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - '> -]> - -
- Agent Schedulers - The agent scheduler extensions schedule resources among agents on top of - the agent management extension. - - The agent scheduler feature consist of several agent scheduler extensions. - In Havana, the following extensions are available. - - DHCP Agent Scheduler (dhcp_agent_scheduler) - L3 Agent Scheduler (l3_agent_scheduler) - Load Balancer Agent Scheduler (lbaas_agent_scheduler) - - - In Grizzly, the DHCP Agent Scheduler and the L3 Agent Scheduler features are provided - by a single extension named the Agent Scheduler (agent_scheduler). - In Havana, this extension is split into the DHCP Agent Scheduler and - the L3 Agent Scheduler extensions. - The Load Balancer Agent Scheduler extension is added in Havana. - -
- DHCP Agent Scheduler (<literal>dhcp_agent_scheduler</literal>) - The DHCP Agent Scheduler extension allows administrators to assign DHCP servers - for Neutron networks to given Neutron DHCP agents, and retrieve mappings between Neutron - networks and DHCP agents. - This feature is implemented on top of Agent Management extension. - - - - - - - - Verb - URI - Description - - - - - &GET; - /agents/agent_id/dhcp-networks - List networks the given DHCP agent is hosting. - - - &GET; - /networks/network_id/dhcp-agents - List DHCP agents hosting the given network. - - - &POST; - /agents/agent_id/dhcp-networks - Schedule the network to the given DHCP agent. - - - &DELETE; - /agents/agent_id/dhcp-networks/network_id - Remove the network from the given DHCP agent. - - - -
- List Networks hosted by one DHCP agent - - - - - - - Verb - URI - Description - - - - - &GET; - /agents/agent_id/dhcp-networks - List networks the given DHCP agent is hosting. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request body. - This operation returns a response body. - - List Networks on DHCP agent: JSON Request - GET /v2.0/agents/d5724d7e-389d-4ba0-8d00-fc673a147bfa/dhcp-networks HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: 797f94caf0a8481c893a232cc0c1dfca - - - - - List Networks on DHCP agent: JSON Response - - -
-
- List DHCP agents hosting network - - - - - - - Verb - URI - Description - - - - - &GET; - /networks/network_id/dhcp-agents - List DHCP agents hosting the given network. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request - body. - This operation returns a response body. - - List DHCP agents hosting network: JSON Request - - GET /v2.0/networks/2d627131-c841-4e3a-ace6-f2dd75773b6d/dhcp-agents HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: cc0f378bdf1545fb8dea2120c89eb532 - - - - - - List DHCP agents hosting network: JSON Response - - -
- -
- Schedule network to DHCP agent - - - - - - - Verb - URI - Description - - - - - &POST; - /agents/agent_id/dhcp-networks - Schedule the network to the given DHCP agent. - - - - Normal Response Code: - 201 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), - Conflict (409) if the network is - already hosted by the given DHCP agent, - NotFound(404) when the specified agent is - not a valid DHCP agent. - This operation requires a request body. - - This operation returns a null body. - - Schedule Network: JSON Request - POST /v2.0/agents/d5724d7e-389d-4ba0-8d00-fc673a147bfa/dhcp-networks.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: d88f7af21ee34f6c87e23e46cf3f986d -Content-Length: 54 - - - - - Schedule Network: JSON Response - - -
-
- Remove Network From DHCP agent - - - - - - - Verb - URI - Description - - - - - &DELETE; - /agents/agent_id/dhcp-networks/network_id - Remove the network from the given DHCP agent. - - - - Normal Response Code: - 204 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), NotFound - (404), - Conflict (409) if the network is - not hosted by the given DHCP agent. - This operation does not require a request - body. - This operation does not return a response - body. - - Remove Network From DHCP agent: JSON Request - - DELETE /v2.0/agents/d5724d7e-389d-4ba0-8d00-fc673a147bfa/dhcp-networks/1ae075ca-708b-4e66-b4a7-b7698632f05f.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: 7ae91cde8f504031be5a2cd5b99d4fe9 - - - -
-
-
- L3 Agent Scheduler (<literal>l3_agent_scheduler</literal>) - The L3 Agent Scheduler extension allows administrators to assign Neutron routers - to Neutron L3 agents, and retrieve mappings between Neutron routers and L3 agents. - This feature is implemented on top of Agent Management extension. - - - - - - - - Verb - URI - Description - - - - - &GET; - /agents/agent_id/l3-routers - List routers the given L3 agent is hosting. - - - &GET; - /routers/router_id/l3-agents - List L3 agents hosting the given router. - - - &POST; - /agents/agent_id/l3-routers - Schedule the router to the given L3 agent. - - - &DELETE; - /agents/agent_id/l3-routers/router_id - Remove the router from the given L3 agent. - - - -
- List Routers hosted by one L3 agent - - - - - - - Verb - URI - Description - - - - - &GET; - /agents/agent_id/l3-routers - List routers the given L3 agent is hosting. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request body. - This operation returns a response body. - - List Routers on L3 agent: JSON Request - GET /v2.0/agents/fa24e88e-3d2f-4fc2-b038-5fb5be294c03/l3-routers.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: 6eeea6e73b68415f85d8368902a32c11 - - - - - List Routers on L3 agent: JSON Response - - -
- -
- List L3 agents hosting router - - - - - - - Verb - URI - Description - - - - - &GET; - /routers/router_id/l3-agents - List L3 agents hosting the given router. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request - body. - This operation returns a response body. - - List L3 agents hosting router: JSON Request - - GET /v2.0/routers/8eef2388-f27d-4a17-986e-9319a77ccd9d/l3-agents.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: bce63afb1e794c70972a19a7c2d6dcab - - - - - - List L3 agents hosting router: JSON Response - - -
- -
- Schedule router to L3 agent - - - - - - - Verb - URI - Description - - - - - &POST; - /agents/agent_id/l3-routers - Schedule one router to the given L3 agent. - - - - Normal Response Code: - 201 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), - Conflict (409) if the router is - already hosted, - NotFound (404) if the specified agent is not - a valid L3 agent. - This operation requires a request body. - - This operation returns a null body. - - Schedule Router: JSON Request - GET /v2.0/agents/fa24e88e-3d2f-4fc2-b038-5fb5be294c03/l3-routers.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: d88f7af21ee34f6c87e23e46cf3f986d -Content-Length: 54 - - - - - Schedule Router: JSON Response - - -
-
- Remove Router From L3 agent - - - - - - - Verb - URI - Description - - - - - &DELETE; - /agents/agent_id/l3-routers/network_id - Remove the router from the given L3 agent. - - - - Normal Response Code: - 204 - - Error Response Codes: Unauthorized - (401), Forbidden - (403), - Conflict (409) if the router is - not hosted by the given L3 agent. - This operation does not require a request - body. - This operation does not return a response - body. - - Remove Router From L3 agent: JSON Request - - DELETE /v2.0/agents/b7d7ba43-1a05-4b09-ba07-67242d4a98f4/l3-routers/8eef2388-f27d-4a17-986e-9319a77ccd9d.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: 2147ef6fe4444f0299b1c0b6b529ff47 - - - -
-
-
- Load Balancer Agent Scheduler (<literal>lbaas_agent_scheduler</literal>) - The LBaaS Agent Scheduler extension allows administrators to retrieve - mappings between load balancer pools to LBaaS agents. - In Havana, this extension does not provide an ability to assign load balancer pool - to specific LBaaS agent. Pools are scheduled automatically when created. - This feature is implemented on top of Agent Management extension. - The Load Balancer Agent Scheduler extension is added in Havana. - - - - - - - - Verb - URI - Description - - - - - &GET; - /agents/agent_id/loadbalancer-pools - List pools the given LBaaS agent is hosting. - - - &GET; - /lb/pools/pool_id/loadbalancer-agent - Show a LBaaS agent hosting the given pool. - - - -
- List Pools hosted by one LBaaS agent - - - - - - - Verb - URI - Description - - - - - &GET; - /agents/agent_id/loadbalancer-pools - List pools the given LBaaS agent is hosting. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request body. - This operation returns a response body. - - List Pools on LBaaS agent: JSON Request - GET /v2.0/agents/6ee1df7f-bae4-4ee9-910a-d33b000773b0/loadbalancer-pools.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: 6eeea6e73b68415f85d8368902a32c11 - - - - - List Pools on LBaaS agent: JSON Response - - -
- -
- Show LBaaS agent hosting pool - - - - - - - Verb - URI - Description - - - - - &GET; - /lb/pools/pool_id/loadbalancer-agent - Show a LBaaS agent hosting the given pool. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - This operation does not require a request body. - This operation returns a response body. - - Show LBaaS agent hosting pool: JSON Request - - GET /v2.0/lb/pools/28296abb-e675-4288-9cd0-6c112c720db0/loadbalancer-agent.json HTTP/1.1 -Host: localhost:9696 -User-Agent: python-neutronclient -Content-Type: application/json -Accept: application/json -X-Auth-Token: bce63afb1e794c70972a19a7c2d6dcab - - - - - - Show LBaaS agent hosting pool: JSON Response - - -
-
-
diff --git a/v2.0/section_neutron-vpn-ext.xml b/v2.0/section_neutron-vpn-ext.xml deleted file mode 100644 index 560eee6..0000000 --- a/v2.0/section_neutron-vpn-ext.xml +++ /dev/null @@ -1,1771 +0,0 @@ - - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - '> -]> -
- - The Virtual Private Network as a Service (VPNaaS) Extension - The VPNaaS extension provides OpenStack tenants - with the ability to extend private networks across the public - telecommunication infrastructure. - - The capabilities provided by this initial implementation of the - VPNaaS extension are: - - - Site-to-site Virtual Private Network connecting two - private networks. - - - Multiple VPN connections per tenant. - - - Supporting IKEv1 policy with 3des, aes-128, aes-256, - or aes-192 encryption. - - - Supporting IPSec policy with 3des, aes-128, aes-256, - or aes-192 encryption, sha1 authentication, ESP, AH, - or AH-ESP transform protocol, and tunnel or transport - mode encapsulation. - - - Dead Peer Detection (DPD) allowing hold, clear, restart, - disabled, or restart-by-peer actions. - - - - - This extension introduces new resources: - - - service, a high level - object that associates VPN with a specific subnet and - router. - - - ikepolicy, the Internet - Key Exchange policy identifying the authentication and - encryption algorithm used during phase one and phase - two negotiation of a VPN connection. - - - ipsecpolicy, the IP - security policy specifying the authentication and - encryption algorithm, and encapsulation mode used for - the established VPN connection. - - - ipsec-site-connection, - has details for the site-to-site IPsec connection, - including the peer CIDRs, MTU, authentication mode, - peer address, DPD settings, and status. - - - - - - This extension is experimental - for the Havana release. The API may change without backward - compatibility. - - - - -
- Concepts - - - A VPN service relates the - Virtual Private Network with a specific subnet and router for a - tenant. - - - - An IKE Policy is used for - phase one and phase two negotiation of the VPN connection. - Configuration selects the authentication and encryption - algorithm used to establish a connection. - - - - An IPsec Policy is used to - specify the encryption algorithm, transform protocol, and - mode (tunnel/transport) for the VPN connection. - - - - A VPN connection represents - the IPsec tunnel established between two sites for the tenant. - This contains configuration settings specifying the policies - used, peer information, MTU, and the DPD actions to take. - - -
- - - -
- High-level flow - - - The high-level task flow for using VPNaaS API to configure a - site-to-site Virtual Private Network is as follows: - - - - The tenant creates a VPN service specifying the router - and subnet. - - - The tenant creates an IKE Policy. - - - The tenant creates an IPsec Policy. - - - The tenant creates a VPN connection, specifying the - VPN service, peer information, and IKE and IPsec - policies. - - - - -
- - - -
- VPN Service Operations - This section discusses operations for managing a tenant's - VPN service through this extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VPN Service Attributes
AttributeTypeRequiredCRUD - - - - - 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the VPN Service object.
tenant_iduuid-strYesCRDerived from Authentication tokenvalid tenant_idOwner of the VPN service. Only admin users can specify a - tenant identifier other than their own.
nameStringNoCRUNoneN/AHuman readable name for the VPN service. - Does not have to be unique. -
descriptionStringNoCRUNoneN/AHuman readable description for the VPN service.
statusStringN/ARN/AN/AIndicates whether IPsec VPN service is currently - operational. Possible values include: - ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, - PENDING_UPDATE, or PENDING_DELETE.
admin_state_upBoolN/ACRUtrue{true | false }Administrative state of the vpnservice. If false - (down), port does not forward packets.
subnet_iduuid-strYesCRN/Avalid subnet IDThe subnet on which the tenant wants the VPN service. This - may be extended in the future to support multiple subnets.
router_iduuid-strYesCRN/Avalid router IDRouter ID to which the VPN service is inserted. This may - change in the future, when router level insertion is available.
- - - -
- List VPN Services - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/vpnservices - Lists VPN services. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized (401), - Forbidden (403) - - This operation does not require a request body. - This operation returns a response body. - - List VPN Services: Request - -GET /v2.0/vpn/vpnservices.json -User-Agent: python-neutronclient -Accept: application/json - - - - List VPN Services: Response - - -
- - - -
- Show VPN Service - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/vpnservices/service-id - Returns details about a specific VPN service. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized (401), - Forbidden (403), Not Found (404) - - This operation does not require a request body. - This operation returns a response body. - - Show VPN Service: Request - - -GET /v2.0/vpn/vpnservices/9faaf49f-dd89-4e39-a8c6-101839aa49bc.json -User-Agent: python-neutronclient -Accept: application/json - - - - Show VPN Service: Response - - -
- - - -
- Create VPN Service - - - - - - - Verb - URI - Description - - - - - &POST; - /vpn/vpnservices - Creates a new VPN service. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized (401), - Bad Request (400) - This operation requires a request body. - This operation returns a response body. - - Create VPN Service: Request - -POST /v2.0/vpn/vpnservices.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Create VPN: Response - -HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Update VPN Service - - - - - - - Verb - URI - Description - - - - - &PUT; - /vpn/vpnservices/service-id - Updates a VPN service, provided status is not - indicating a PENDING_* state. - - - - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404) - - Update VPN Service: Request - -PUT /v2.0/vpn/vpnservices/41bfef97-af4e-4f6b-a5d3-4678859d2485.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Update VPN Service: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Delete VPN Service - - - - - - - Verb - URI - Description - - - - - &DELETE; - /vpn/vpnservices/service-id - Removes a VPN service. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized (401), - Not Found (404), Conflict - (409) - This operation does not require a request body. - This operation does not return a response body. - - Delete VPN Service: Request - -DELETE /v2.0/vpn/vpnservices/1be5e5f7-c45e-49ba-85da-156575b60d50.json -User-Agent: python-neutronclient -Accept: application/json - - - - Delete VPN Service: Response - -HTTP/1.1 204 No Content -Content-Length: 0 - - -
- -
- - - -
- IKE Policy Operations - This section discusses operations for managing IKE Policies - through the VPN as a Service extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IKE Policy Attributes
AttributeTypeRequiredCRUD - - - - - 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the IKE policy.
tenant_iduuid-strYesCRNonevalid tenant_idUnique identifier for owner of the VPN service.
namestringyesCRUNoneN/AFriendly name for the IKE policy.
descriptionstringnoCRUNoneN/ADescription of the IKE policy.
auth_algorithmstringnoCRUsha1N/AAuthentication Hash algorithms: sha1.
encryption_algorithmstringnoCRUaes-128N/AEncryption Algorithms: 3des, aes-128, aes-256, aes-192, etc.
phase1_negotiation_modestringnoCRUMain ModeN/AIKE mode: Main Mode.
pfsstringnoCRUGroup5N/APerfect Forward Secrecy: Group2, Group5, or Group14.
ike_versionstringnoCRUv1N/AVersion: v1 or v2.
lifetimedictnoCRUunits: seconds, value: 3600.Dictionary should be in this form: {'units': 'seconds', 'value': 2000}. - Value is a positive integer.Lifetime of the SA. Units in 'seconds'. Either units or - value may be omitted.
- - - -
- List IKE Policies - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/ikepolicies - Lists IKE policies. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - - This operation does not require a request body. - This operation returns a response body. - - List IKE Policies: Request - - -GET /v2.0/vpn/ikepolicies.json -User-Agent: python-neutronclient -Accept: application/json - - - - List IKE Policies: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Show IKE Policy - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/ikepolicies/ikepolicy-id - Returns details about a specific IKE policy. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized (401), - Forbidden (403), Not Found (404) - - This operation does not require a request body. - This operation returns a response body. - - Show IKE Policy: Request - - -GET /v2.0/vpn/ikepolicies/5522aff7-1b3c-48dd-9c3c-b50f016b73db.json -User-Agent: python-neutronclient -Accept: application/json - - - - Show IKE Policy: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Create IKE Policy - - - - - - - Verb - URI - Description - - - - - &POST; - /vpn/ikepolicies - Creates a new IKE policy. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized (401), - Bad Request (400) - This operation requires a request body. - This operation returns a response body. - - Create IKE Policy: Request - -POST /v2.0/vpn/ikepolicies.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Create IKE Policy: Response - -HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Update IKE Policy - - - - - - - Verb - URI - Description - - - - - &PUT; - /vpn/ikepolicies/ikepolicy-id - Updates an IKE policy. - - - - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404) - - Update IKE Policy: Request - -PUT /v2.0/vpn/ikepolicies/5522aff7-1b3c-48dd-9c3c-b50f016b73db.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Update IKE Policy: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Delete IKE Policy - - - - - - - Verb - URI - Description - - - - - &DELETE; - /vpn/ikepolicies/ikepolicy-id - Removes an IKE policy. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized (401), - Not Found (404), Conflict - (409) - This operation does not require a request body. - This operation does not return a response body. - - Delete IKE Policy: Request - -DELETE /v2.0/vpn/ikepolicies/5522aff7-1b3c-48dd-9c3c-b50f016b73db.json -User-Agent: python-neutronclient -Accept: application/json - - - - Delete IKE Policy: Response - -HTTP/1.1 204 No Content -Content-Length: 0 - - -
- -
- - - -
- IPSec Policy Operations - This section discusses operations for managing IPSec - policies through the VPN as a Service extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IPSec Policy Attributes
AttributeTypeRequiredCRUD - - - - - 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the IPsec policy.
tenant_iduuid-strYesCRNonevalid tenant_idUnique identifier for owner of the VPN service.
namestringyesCRUNoneN/AFriendly name for the IPsec policy.
descriptionstringnoCRUNoneN/ADescription of the IPSec policy.
transform_protocolstringnoCRUESPN/ATransform protocol used: ESP, AH, or AH-ESP.
encapsulation_modestringnoCRUtunnelN/AEncapsulation mode: tunnel or transport.
auth_algorithmstringnoCRUsha1N/AAuthentication algorithm: sha1.
encryption_algorithmstringnoCRUaes-128N/AEncryption Algorithms: 3des, aes-128, aes-256, or aes-192.
pfsstringnoCRUgroup5N/APerfect Forward Secrecy: group2, group5, or group14.
lifetimedictnoCRUunits: seconds, value: 3600.Dictionary should be in this form: {'units': 'seconds', 'value': 2000}. - Value is a positive integer.Lifetime of the SA. Units in 'seconds'. Either units or - value may be omitted.
- - - -
- List IPSec Policy - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/ipsecpolicies - Lists IPSec policies. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - - This operation does not require a request body. - This operation returns a response body. - - List IPSec Policies: Request - - -GET /v2.0/vpn/ipsecpolicies.json -User-Agent: python-neutronclient -Accept: application/json - - - - List IPSec Policies: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Show IPSec Policy - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/ipsecpolicies/ipsecpolicy-id - Returns details about a specific IPSec policy. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized (401), - Forbidden (403), Not Found (404) - - This operation does not require a request body. - This operation returns a response body. - - Show IPSec Policy: Request - - -GET /v2.0/vpn/ipsecpolicies/5291b189-fd84-46e5-84bd-78f40c05d69c.json -User-Agent: python-neutronclient -Accept: application/json - - - - Show IPSec Policy: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Create IPSec Policy - - - - - - - Verb - URI - Description - - - - - &POST; - /vpn/ipsecpolicies - Creates a new IPSec policy. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized (401), - Bad Request (400) - This operation requires a request body. - This operation returns a response body. - - Create IPSec Policy: Request - -POST /v2.0/vpn/ipsecpolicies.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Create IPSec Policy: Response - -HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Update IPSec Policy - - - - - - - Verb - URI - Description - - - - - &PUT; - /vpn/ipsecpolicies/ipsecpolicy-id - Updates a IPSec policy. - - - - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404) - - Update IPSec Policy: Request - -PUT /v2.0/vpn/ipsecpolicies/5291b189-fd84-46e5-84bd-78f40c05d69c.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Update IPSec Policy: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Delete IPSec Policy - - - - - - - Verb - URI - Description - - - - - &DELETE; - /vpn/ipsecpolicies/ipsecpolicy-id - Removes a IPSec policy. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized (401), - Not Found (404), Conflict - (409) - This operation does not require a request body. - This operation does not return a response body. - - Delete IPSec Policy: Request - -DELETE /v2.0/vpn/ipsecpolicies/5291b189-fd84-46e5-84bd-78f40c05d69c.json -User-Agent: python-neutronclient -Accept: application/json - - - - Delete IPSec Policy: Response - -HTTP/1.1 204 No Content -Content-Length: 0 - - -
- -
- - - -
- IPSec Site Connection Operations - This section discusses operations for managing IPSec - site-to-site connections through the VPN as a Service extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IPSec Site Connection Attributes
AttributeTypeRequiredCRUD - - - - - 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 ConstraintsNotes
iduuid-strN/ARgeneratedN/AUnique identifier for the IPSec site-to-site connection.
tenant_iduuid-strYesCRNonevalid tenant_idUnique identifier for owner of the VPN service.
namestringnoCRUNoneN/AName for IPSec site-to-site connection.
descriptionstringnoCRUNoneN/ADescription of the IPSec site-to-site connection.
peer_addressstringyesCRUN/AN/APeer gateway public IPv4/IPv6 address or FQDN.
peer_idstringyesCRUN/AN/APeer router identity for authentication. Can be - IPv4/IPv6 address, e-mail address, key id, or FQDN.
peer_cidrslist[string]yesCRUN/Aunique list of valid cidr in the form <net_address>/<prefix>Peer private CIDRs.
route_modestringnoRstaticstaticRoute mode: static. This will be extended in the future.
mtuintegernoCRU1500Integer. Minimum is 68 for IPv4 and 1280 for IPv6.Maximum Transmission Unit to address fragmentation.
auth_modestringnoRpskpsk/certsAuthentication mode: PSK or certificate.
pskstringyesCRUN/ANOPre Shared Key: any string.
initiatorstringnoCRUbi-directionalbi-directional / response-onlyWhether this VPN can only respond to connections or can - initiate as well.
admin_state_upboolN/ACRUTRUEtrue / falseAdministrative state of VPN connection. If false (down), - VPN connection does not forward packets.
statusstringN/ARN/AN/AIndicates whether VPN connection is currently operational. - Possible values include: ACTIVE, DOWN, BUILD, ERROR, - PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
ikepolicy_iduuidyesCRN/AUnique identifier of IKE policyUnique identifier of IKE policy.
ipsecpolicy_iduuidyesCRN/AUnique identifier of IPSec policyUnique identifier of IPSec policy.
vpnservice_iduuidyesCRN/AUnique identifier of VPN serviceUnique identifier of VPN service.
dpddictnoCRUaction: hold, interval: 30, timeout: 120Dictionary should be in this form: - {'action': 'clear', 'interval': 20, 'timeout': 60}. - Interval is positive integer. Timeout is greater - than interval.Dead Peer Detection protocol controls. Action: clear, hold, - restart, disabled, or restart-by-peer. Interval and timeout - in seconds.
- - - -
- List IPSec Site Connections - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/ipsec-site-connections - Lists the IPSec site-to-site connections. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized - (401), Forbidden - (403) - - This operation does not require a request body. - This operation returns a response body. - - List IPSec Site Connections: Request - - -GET /v2.0/vpn/ipsec-site-connections.json -User-Agent: python-neutronclient -Accept: application/json - - - - List IPSec Site Connections: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
- - - -
- Show IPSec Site Connection - - - - - - - Verb - URI - Description - - - - - &GET; - - /vpn/ipsec-site-connections/connection-id - Returns details about a specific IPSec site-to-site connection. - - - - Normal Response Code: - 200 - - Error Response Codes: Unauthorized (401), - Forbidden (403), Not Found (404) - - This operation does not require a request body. - This operation returns a response body. - - Show IPSec Site Connection: Request - - -GET /v2.0/vpn/ipsec-site-connections/cbc152a0-7e93-4f98-9f04-b085a4bf2511.json -User-Agent: python-neutronclient -Accept: application/json - - - - Show IPSec Site Connection: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
-
- Create IPSec Site Connection - - - - - - - Verb - URI - Description - - - - - &POST; - /vpn/ipsec-site-connections - Creates a new IPSec site connection. - - - - Normal Response Code: 201 - - Error Response Codes: Unauthorized (401), - Bad Request (400) - This operation requires a request body. - This operation returns a response body. - - Create IPSec Site Connection: Request - -POST /v2.0/vpn/ipsec-site-connections.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Create IPSec Site Connection: Response - -HTTP/1.1 201 Created -Content-Type: application/json; charset=UTF-8 - - - -
-
- Update IPSec Site Connection - - - - - - - Verb - URI - Description - - - - - &PUT; - /vpn/ipsec-site-connections/connection-id - Updates an IPSec site-to-site connection, provided status is not - indicating a PENDING_* state. - - - - Normal Response Code: 200 - Error Response Codes: Unauthorized (401), - Bad Request (400), Not Found (404) - - Update IPSec Site Connection: Request - -PUT /v2.0/vpn/ipsec-site-connections/f7cf7305-f491-45f4-ad9c-8e7240fe3d72.json -User-Agent: python-neutronclient -Accept: application/json - - - - - Update IPSec Site Connection: Response - -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 - - - -
-
- Delete IPSec Site Connection - - - - - - - Verb - URI - Description - - - - - &DELETE; - /vpn/ipsec-site-connections/connection-id - Deletes a IPSec site-to-site connection. - - - - Normal Response Code: 204 - - Error Response Codes: Unauthorized (401), - Not Found (404), Conflict - (409) - This operation does not require a request body. - This operation does not return a response body. - - Delete IPSec Site Connection: Request - -DELETE /v2.0/vpn/ipsec-site-connections/cbc152a0-7e93-4f98-9f04-b085a4bf2511.json -User-Agent: python-neutronclient -Accept: application/json - - - - Delete IPSec Site Connection: Response - -HTTP/1.1 204 No Content -Content-Length: 0 - - -
- -
- -
diff --git a/v2.0/section_neutron_binding_ext_ports.xml b/v2.0/section_neutron_binding_ext_ports.xml deleted file mode 100644 index 23fe99e..0000000 --- a/v2.0/section_neutron_binding_ext_ports.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - - - - '> - - - - - - - - - '> - -]> -
- The <literal>binding</literal> Extended Attributes for - 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: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
binding Extended Attributes - for Ports
AttributeTypeRequiredCRUD - - - 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 ConstraintsNotes
binding:vif_typeStringN/ARNoneN/ARead-only. The vif type for the specified - port. -
- binding:host_iduuid-strN/ACRUNoneN/AThe ID of the host where the port is - allocated. In some cases different - implementations can run on different - hosts. -
- 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:vif_detailslist(dict)N/ARNoneNone - Read-only. A dictionary that enables the - application to pass information about - 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_typeStringN/ACRUnormal(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.
- - - - - - - - - - -
diff --git a/v2.0/section_neutron_list-extensions.xml b/v2.0/section_neutron_list-extensions.xml deleted file mode 100644 index 3ceb8f9..0000000 --- a/v2.0/section_neutron_list-extensions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - '> - - - - - '> - -]> -
- List available extensions - You can list available extensions through the /v2.0/extensions URI. - - You must authenticate these requests just like any other - API request. - - The following example response shows a list of - extensions: - Status Code: 200 OK - Connection: keep-alive - Content-Length: 654 - Content-Type: application/xml; charset=UTF-8 - Date: Wed, 12 Sep 2012 11:32:56 GMT - - Also, you can query for specific extension using the - extension alias. For instance, querying - /v2.0/extensions/router, results in the - following response: - Status Code: 200 OK -Connection: keep-alive -Content-Length: 350 -Content-Type: application/xml; charset=UTF-8 -Date: Wed, 12 Sep 2012 11:36:20 GMT - -
diff --git a/v2.0/section_provider_ext_networks.xml b/v2.0/section_provider_ext_networks.xml deleted file mode 100644 index e9635b1..0000000 --- a/v2.0/section_provider_ext_networks.xml +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - - - - '> - - - - - - - - - '> - -]> -
- Network API Operations - Use the &APIv2; with the provider - extended attributes to get information about, create, and - update networks. - The provider-prefixed extended - attributes for networks are: - - - - - - - - - - - - - - - - - - - - - - - - -
provider Extended Attributes - for Networks
AttributeDescription
provider:network_typeThe type of physical network that maps to - this networks resource. Examples are - flat, - vlan, vxlan, local, and - gre.
- provider:physical_networkThe physical network on which this network - object is implemented. The &APIv2; does not - provide a way to list available physical - networks. For example, the Open vSwitch - plug-in configuration file defines a symbolic - name that maps to specific bridges on each - Compute host.
- provider:segmentation_idAn isolated segment on the physical network. - The network_type attribute - defines the segmentation model. For example, - if network_type is - vlan, this ID is a - vlan identifier. If - network_type is - gre, this ID is a - gre key.
-
- List Networks - - - - - - - - Verb - URI - Description - - - - - &GET; - /networks - Lists networks. The - provider - extended attributes are visible to only - administrative users. - - - - - Normal Response Code: 200 OK - Error Response Codes: 401 Unauthorized - This operation lists network attributes including - provider extended attributes. - The provider extended attributes - are visible to only administrative users. - - List Networks with provider extended attributes: - JSON Response - - - - List Networks with provider extended attributes: - XML Response - - -
-
- Show Network - - - - - - - - Verb - URI - Description - - - - - &GET; - /networks/network_id - Shows information for a specified network. - The provider - extended attributes are visible to only - administrative users. - - - - - Normal Response Code: 200 OK - Error Response Code: 401 Unauthorized, 404 Not - Found - This operation shows information for a specified - network. The provider extended - attributes are visible to only administrative - users. - - Show Network with provider extended attributes: - JSON Response - - - - Show Network with provider extended attributes: XML - Response - - -
-
- Create Network - - - - - - - - Verb - URI - Description - - - - - &POST; - /networks - Creates a network. Only administrative - users can add the - provider - extended attributes. - - - - - Normal Response Code: 200 OK - Error Response Code: 400 Bad Request, 401 Unauthorized, - 403 Forbidden - This operation enables administrative users to create a - network and define how it is mapped on the underlying - network infrastructure. - If the user submitting the request is not allowed to set - provider networks attributes, a 403 Forbidden response is - 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 extended attributes: - JSON Request - - - - Create Network with provider extended attributes: - XML Request - - -
-
- Update Network - - - - - - - - Verb - URI - Description - - - - - &PUT; - /networks/network_id - Updates a network. Only administrative - users can update the - provider - extended 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 is - 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 to map it to a flat network (such - as, the no vlan tag); the example refers to an OpenStack - Networking deployment that uses the Open vSwitch - plug-in. - - Update Network with provider extended attributes: - JSON Request -PUT /v2.0/networks/3a06dfc7-d239-4aad-9a57-21cd171c72e5.json - -Content-Type: application/json -Accept: application/json - - - - Update Network with provider extended attributes: - XML Request -PUT /v2.0/networks/3a06dfc7-d239-4aad-9a57-21cd171c72e5.xml - -Content-Type: application/xml -Accept: application/xml - - -
-
diff --git a/v2.0/section_provider_extended_attrs.xml b/v2.0/section_provider_extended_attrs.xml deleted file mode 100644 index 50593c0..0000000 --- a/v2.0/section_provider_extended_attrs.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> - - - - - - '> - - - - - '> - -]> -
- The <literal>provider</literal> Extended Attributes for - Networks - The provider extended attributes for - networks enables administrative users to specify how network - objects map to the underlying networking infrastructure. These - extended attributes also appear when administrative users - query networks. - The technology back end of the particular plug-in determines - the semantics of these attributes. To understand which values - to specify for each attribute when you deploy &APIv2; with a - particular plug-in, see the plug-in documentation and the - OpenStack Cloud Administrator - Guide. The following examples use the Open vSwitch - plug-in. - - The default policy settings enable only administrative - users to specify and view these attributes. If you cannot - see these attributes in a &GET; - /networks/<network-id> operation, - you do not have administrative privileges. - - -