Remove Networking API files
The Networking APIs will be managed by the networking team in the networking repo. Change-Id: Ib3efa8543d575e601503748e30e1ea23026d4b1f
This commit is contained in:
KATO Tomoyuki
parent
9c1129a66a
commit
46ef886242
@ -138,17 +138,6 @@
|
||||
<pdfFilenameBase>api-ref-image-v1</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-networking-v2</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-networking-v2.xml </includes>
|
||||
<pdfFilenameBase>api-ref-networking-v2</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-objectstorage-v1</id>
|
||||
<goals>
|
||||
|
||||
@ -1,40 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:linkend="http://www.w3.org/1999/linkend"
|
||||
xmlns:xref="http://www.w3.org/1999/xref"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-networking-pdf">
|
||||
<info>
|
||||
<title>OpenStack Networking (neutron) API v2.0 and Extensions
|
||||
Reference</title>
|
||||
<?rax title.font.size="32px"?>
|
||||
<?rax subtitle.font.size="32px"?>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2016</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Networking (neutron)</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="apache2">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_networking-v2.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_networking-v2-ext.xml"/>
|
||||
</book>
|
||||
@ -40,8 +40,6 @@
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_data-processing-v1.1.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_images-v2.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_images-v1.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_networking-v2.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_networking-v2-ext.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_objectstorage-v1.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_orchestration-v1.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_share-v2.xml"/>
|
||||
|
||||
@ -135,28 +135,6 @@
|
||||
<pdfFilename>bk-api-ref-image-v1</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-networking-v2</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> api-ref-networking-v2.xml </includes>
|
||||
<pdfFilename>bk-api-ref-networking-v2</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-networking-v2-ext</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> api-ref-networking-v2-ext.xml </includes>
|
||||
<pdfFilename>bk-api-ref-networking-v2-ext</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-objectstorage-v1</id>
|
||||
<goals>
|
||||
|
||||
@ -1,102 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
==========
|
||||
Extensions
|
||||
==========
|
||||
|
||||
Lists available Networking API v2.0 extensions and shows details
|
||||
for an extension.
|
||||
|
||||
|
||||
List extensions
|
||||
===============
|
||||
|
||||
.. rest_method:: GET /v2.0/extensions
|
||||
|
||||
Lists available extensions.
|
||||
|
||||
Extensions introduce features and vendor-specific functionality to
|
||||
the API.
|
||||
|
||||
The response shows the extension name and its alias. To show
|
||||
details for an extension, you specify the alias.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- updated: updated
|
||||
- description: description
|
||||
- links: links
|
||||
- alias: alias
|
||||
- extension: extension
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/extensions/extensions-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show extension details
|
||||
======================
|
||||
|
||||
.. rest_method:: GET /v2.0/extensions/{alias}
|
||||
|
||||
Shows details for an extension, by alias.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- alias: alias
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- updated: updated
|
||||
- description: description
|
||||
- links: links
|
||||
- alias: alias
|
||||
- extension: extension
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/extensions/extension-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,91 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
======================
|
||||
Extra routes (routers)
|
||||
======================
|
||||
|
||||
Adds extra routes to the ``router`` resource.
|
||||
|
||||
You can update a router to add a set of next hop IPs and
|
||||
destination CIDRs.
|
||||
|
||||
The next hop IP must be part of a subnet to which the router
|
||||
interfaces are connected. You can configure the ``routes``
|
||||
attribute on only update operations.
|
||||
|
||||
|
||||
Update extra routes
|
||||
===================
|
||||
|
||||
.. rest_method:: PUT /v2.0/routers/{router_id}
|
||||
|
||||
Updates extra routes on a router.
|
||||
|
||||
The next hop IP address must be a part of one of the subnets to
|
||||
which the router interfaces are connected. Otherwise, the server
|
||||
responds with the ``Bad Request (400)`` error code.
|
||||
|
||||
When a validation error is detected, such as a format error of IP
|
||||
address or CIDR, the server responds with the ``Bad Request (400)``
|
||||
response code.
|
||||
|
||||
When Networking receives a request to delete the router interface
|
||||
for subnets that are used by one or more routes, it responds with a
|
||||
``Conflict (409)`` response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,409,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- destination: destination
|
||||
- nexthop: nexthop
|
||||
- routes: routes
|
||||
- router: router
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
- router_id: router_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- status: status
|
||||
- enable_snat: enable_snat
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- routes: routes
|
||||
- router: router
|
||||
- id: id
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,612 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=====================================================================
|
||||
Networking Flavors Framework v2.0 (CURRENT) (flavor, service_profile)
|
||||
=====================================================================
|
||||
|
||||
Extension that allows user selection of operator-curated flavors
|
||||
during resource creation.
|
||||
|
||||
Service ``q-flavors`` must be enabled in the configuration to use
|
||||
this feature.
|
||||
|
||||
|
||||
Disassociate a flavor.
|
||||
======================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/flavors/{flavor_id}/service_profiles/{profile_id}
|
||||
|
||||
Disassociate a flavor from a service profile.
|
||||
|
||||
Error response codes:404,403,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- profile_id: profile_id
|
||||
- flavor_id: flavor_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show service profile details
|
||||
============================
|
||||
|
||||
.. rest_method:: GET /v2.0/service_profiles/{profile_id}
|
||||
|
||||
Shows details for a service profile.
|
||||
|
||||
This operation returns a service profile object by ID. If you are
|
||||
not an administrative user and the object is not visible to your
|
||||
tenant account, the service returns the HTTP ``Forbidden (403)``
|
||||
response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- profile_id: profile_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- driver: driver
|
||||
- enabled: enabled
|
||||
- metainfo: metainfo
|
||||
- service_profile: service_profile
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/service-profile-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update service profile
|
||||
======================
|
||||
|
||||
.. rest_method:: PUT /v2.0/service_profiles/{profile_id}
|
||||
|
||||
Updates a service profile.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- service_profile: service_profile
|
||||
- enabled: enabled
|
||||
- driver: driver
|
||||
- description: description
|
||||
- metainfo: metainfo
|
||||
- profile_id: profile_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/service-profile-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- driver: driver
|
||||
- enabled: enabled
|
||||
- metainfo: metainfo
|
||||
- service_profile: service_profile
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/service-profile-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete service profile
|
||||
======================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/service_profiles/{profile_id}
|
||||
|
||||
Deletes a service profile.
|
||||
|
||||
Attempting to delete a service profile that is currently associated
|
||||
with a flavor will return a ``Conflict 409`` with a response body
|
||||
containing an in use message.
|
||||
|
||||
Error response codes:409,404,403,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- profile_id: profile_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List service profiles
|
||||
=====================
|
||||
|
||||
.. rest_method:: GET /v2.0/service_profiles
|
||||
|
||||
Lists all service profiles visible for the tenant account.
|
||||
|
||||
The list can be empty.
|
||||
|
||||
Standard query parameters are supported on the URI.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- driver: driver
|
||||
- enabled: enabled
|
||||
- metainfo: metainfo
|
||||
- service_profiles: service_profiles
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/service-profiles-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create service profile
|
||||
======================
|
||||
|
||||
.. rest_method:: POST /v2.0/service_profiles
|
||||
|
||||
Creates a service profile.
|
||||
|
||||
This operation establishes a new service profile that can be
|
||||
associated with one or more flavors.
|
||||
|
||||
Either metadata or a driver is required.
|
||||
|
||||
If a driver is specified but does not exist, call will return a
|
||||
``Not found 404`` error with the response body explaining that the
|
||||
driver could not be found.
|
||||
|
||||
Creation currently limited to administrators. Other users will
|
||||
receive a ``Forbidden 403`` response code with a response body
|
||||
NeutronError message expressing that creation is disallowed by
|
||||
policy.
|
||||
|
||||
If the API cannot fulfill the request due to insufficient data or
|
||||
data that is not valid, the service returns the HTTP ``Bad Request
|
||||
(400)`` response code with information about the failure in the
|
||||
response body. Validation errors require that you correct the error
|
||||
and submit the request again.
|
||||
|
||||
Error response codes:201,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- service_profile: service_profile
|
||||
- enabled: enabled
|
||||
- driver: driver
|
||||
- description: description
|
||||
- metainfo: metainfo
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/service-profile-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- driver: driver
|
||||
- enabled: enabled
|
||||
- metainfo: metainfo
|
||||
- service_profile: service_profile
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List flavors
|
||||
============
|
||||
|
||||
.. rest_method:: GET /v2.0/flavors
|
||||
|
||||
Lists all flavors visible for the tenant account.
|
||||
|
||||
The list can be empty.
|
||||
|
||||
Standard query parameters are supported on the URI. For example,
|
||||
``fields`` can be used to limit the returned response to just name
|
||||
by appending ``?fields=name``. If Neutron configuration supports
|
||||
pagination by overriding allow_pagination = false, the ``marker``
|
||||
query parameter can set the last element id the client has seen and
|
||||
``limit`` set the maximum number of items to return. if Neutron
|
||||
configuration has allow_sorting = true, ``sort_key`` and
|
||||
``sort_dir`` pairs can be used where sort direction is 'asc' or
|
||||
'desc'.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- flavors: flavors
|
||||
- description: description
|
||||
- enabled: enabled
|
||||
- service_profiles: service_profiles
|
||||
- service_type: service_type
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/flavors-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create flavor
|
||||
=============
|
||||
|
||||
.. rest_method:: POST /v2.0/flavors
|
||||
|
||||
Creates a flavor.
|
||||
|
||||
This operation establishes a new flavor.
|
||||
|
||||
The service_type to which the flavor applies is a required
|
||||
parameter. The corresponding service plugin must have been
|
||||
activated as part of the configuration. See `Service providers
|
||||
<http://developer.openstack.org/api-ref-networking-v2.html#service-
|
||||
type>`_ for how to see currently loaded service types. Additionally
|
||||
the service plugin needs to support the use of flavors. For
|
||||
example, the LOADBALANCERV2 service type using the LBaaSv2 API
|
||||
currently supports Neutron service flavors.
|
||||
|
||||
Creation currently limited to administrators. Other users will
|
||||
receive a ``Forbidden 403`` response code with a response body
|
||||
NeutronError message expressing that creation is disallowed by
|
||||
policy.
|
||||
|
||||
Until one or more service profiles are associated with the flavor
|
||||
by the operator, attempts to use the flavor during resource
|
||||
creations will currently return a ``Not Found 404`` with a response
|
||||
body that indicates no service profile could be found.
|
||||
|
||||
If the API cannot fulfill the request due to insufficient data or
|
||||
data that is not valid, the service returns the HTTP ``Bad Request
|
||||
(400)`` response code with information about the failure in the
|
||||
response body. Validation errors require that you correct the error
|
||||
and submit the request again.
|
||||
|
||||
Error response codes:201,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- service_type: service_type
|
||||
- flavor: flavor
|
||||
- enabled: enabled
|
||||
- description: description
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/flavor-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- enabled: enabled
|
||||
- service_profiles: service_profiles
|
||||
- service_type: service_type
|
||||
- flavor: flavor
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Associate flavor
|
||||
================
|
||||
|
||||
.. rest_method:: POST /v2.0/flavors/{flavor_id}/service_profiles
|
||||
|
||||
Associate a flavor with a service profile.
|
||||
|
||||
A flavor can be associated with more than one profile.
|
||||
|
||||
Will return ``409 Conflict`` if association already exists.
|
||||
|
||||
Error response codes:201,404,403,401,400,409,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- service_profile: service_profile
|
||||
- id: id
|
||||
- flavor_id: flavor_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/flavor-associate-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- service_profile: service_profile
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show flavor details
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v2.0/flavors/{flavor_id}
|
||||
|
||||
Shows details for a flavor.
|
||||
|
||||
This operation returns a flavor object by ID. If you are not an
|
||||
administrative user and the flavor object is not visible to your
|
||||
tenant account, the service returns the HTTP ``Forbidden (403)``
|
||||
response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- flavor_id: flavor_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- enabled: enabled
|
||||
- service_profiles: service_profiles
|
||||
- service_type: service_type
|
||||
- flavor: flavor
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/flavor-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update flavor
|
||||
=============
|
||||
|
||||
.. rest_method:: PUT /v2.0/flavors/{flavor_id}
|
||||
|
||||
Updates a flavor.
|
||||
|
||||
The service_type cannot be updated as there may be associated
|
||||
service profiles and consumers depending on the value.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- flavor: flavor
|
||||
- enabled: enabled
|
||||
- description: description
|
||||
- name: name
|
||||
- flavor_id: flavor_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/flavor-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- enabled: enabled
|
||||
- service_profiles: service_profiles
|
||||
- service_type: service_type
|
||||
- flavor: flavor
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/flavors/flavor-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete flavor
|
||||
=============
|
||||
|
||||
.. rest_method:: DELETE /v2.0/flavors/{flavor_id}
|
||||
|
||||
Deletes a flavor.
|
||||
|
||||
Error response codes:404,403,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- flavor_id: flavor_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,917 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=======================================================================
|
||||
FWaaS v2.0 (CURRENT) (fw, firewalls, firewall_policies, firewall_rules)
|
||||
=======================================================================
|
||||
|
||||
Use the Firewall-as-a-Service (FWaaS) v2.0 extension to deploy
|
||||
firewalls to protect your networks.
|
||||
|
||||
The FWaaS extension enables you to:
|
||||
|
||||
- Apply firewall rules on traffic entering and leaving tenant
|
||||
networks.
|
||||
|
||||
- Apply TCP, UDP, ICMP, or protocol-agnostic rules.
|
||||
|
||||
- Create and share firewall policies that hold an ordered collection
|
||||
of the firewall rules.
|
||||
|
||||
- Audit firewall rules and policies.
|
||||
|
||||
This extension introduces these resources:
|
||||
|
||||
- ``firewall``. A logical firewall resource that a tenant can
|
||||
instantiate and manage. A firewall can have one firewall policy.
|
||||
|
||||
- ``firewall_policy``. An ordered collection of firewall rules. You
|
||||
can share a firewall policy across tenants. You can include a
|
||||
firewall policy as part of an audit workflow so that an
|
||||
authorized relevant entity can audit the firewall policy. This
|
||||
entity can differ from the tenant who created, or the tenants
|
||||
that use, the firewall policy.
|
||||
|
||||
- ``firewall_rule``. A collection of attributes, such as ports and
|
||||
IP addresses. These attributes define match criteria and an
|
||||
action to take, such as allow or deny, on matched data traffic.
|
||||
|
||||
|
||||
Insert rule into a firewall policy
|
||||
==================================
|
||||
|
||||
.. rest_method:: PUT /v2.0/fw/firewall_policies/{firewall_policy_id}/insert_rule
|
||||
|
||||
Insert firewall rule into a policy.
|
||||
|
||||
A firewall_rule_id is inserted relative to the position of the
|
||||
firewall_rule_id set in ``insert_before`` or ``insert_after``. If
|
||||
``insert_before`` is set, ``insert_after`` is ignored. If both
|
||||
``insert_before`` and ``insert_after`` are not set, the new
|
||||
firewall_rule_id is inserted at the top of the policy.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,409,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- insert_after: insert_after
|
||||
- firewall_rule_id: firewall_rule_id
|
||||
- insert_before: insert_before
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-insert-rule-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- firewall_rules: firewall_rules
|
||||
- tenant_id: tenant_id
|
||||
- firewall_list: firewall_list
|
||||
- audited: audited
|
||||
- shared: shared
|
||||
- id: id
|
||||
- description: description
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-insert-rule-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show firewall policy details
|
||||
============================
|
||||
|
||||
.. rest_method:: GET /v2.0/fw/firewall_policies/{firewall_policy_id}
|
||||
|
||||
Shows details for a firewall policy.
|
||||
|
||||
If the user is not an administrative user and the firewall policy
|
||||
object does not belong to the tenant account, this call returns the
|
||||
``Forbidden (403)`` response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_policy: firewall_policy
|
||||
- name: name
|
||||
- firewall_rules: firewall_rules
|
||||
- tenant_id: tenant_id
|
||||
- audited: audited
|
||||
- shared: shared
|
||||
- id: id
|
||||
- description: description
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update firewall policy
|
||||
======================
|
||||
|
||||
.. rest_method:: PUT /v2.0/fw/firewall_policies/{firewall_policy_id}
|
||||
|
||||
Updates a firewall policy.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_policy: firewall_policy
|
||||
- name: name
|
||||
- firewall_rules: firewall_rules
|
||||
- tenant_id: tenant_id
|
||||
- audited: audited
|
||||
- shared: shared
|
||||
- id: id
|
||||
- description: description
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete firewall policy
|
||||
======================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/fw/firewall_policies/{firewall_policy_id}
|
||||
|
||||
Deletes a firewall policy.
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List firewall policies
|
||||
======================
|
||||
|
||||
.. rest_method:: GET /v2.0/fw/firewall_policies
|
||||
|
||||
Lists all firewall policies.
|
||||
|
||||
The list might be empty.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- firewall_rules: firewall_rules
|
||||
- tenant_id: tenant_id
|
||||
- audited: audited
|
||||
- firewall_policies: firewall_policies
|
||||
- shared: shared
|
||||
- id: id
|
||||
- description: description
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policies-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create firewall policy
|
||||
======================
|
||||
|
||||
.. rest_method:: POST /v2.0/fw/firewall_policies
|
||||
|
||||
Creates a firewall policy.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rules_id: firewall_rules_id
|
||||
- firewall_policy: firewall_policy
|
||||
- name: name
|
||||
- tenant_id: tenant_id
|
||||
- shared: shared
|
||||
- audited: audited
|
||||
- description: description
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_policy: firewall_policy
|
||||
- name: name
|
||||
- firewall_rules: firewall_rules
|
||||
- tenant_id: tenant_id
|
||||
- audited: audited
|
||||
- shared: shared
|
||||
- id: id
|
||||
- description: description
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show firewall rule details
|
||||
==========================
|
||||
|
||||
.. rest_method:: GET /v2.0/fw/firewall_rules/{firewall_rule_id}
|
||||
|
||||
Shows details for a firewall rule.
|
||||
|
||||
If the user is not an administrative user and the firewall rule
|
||||
object does not belong to the tenant account, this call returns the
|
||||
``Forbidden (403)`` response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule_id: firewall_rule_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule: firewall_rule
|
||||
- description: description
|
||||
- source_ip_address: source_ip_address
|
||||
- tenant_id: tenant_id
|
||||
- enabled: enabled
|
||||
- protocol: protocol
|
||||
- source_port: source_port
|
||||
- ip_version: ip_version
|
||||
- destination_ip_address: destination_ip_address
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- shared: shared
|
||||
- action: action
|
||||
- position: position
|
||||
- destination_port: destination_port
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-rule-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update firewall rule
|
||||
====================
|
||||
|
||||
.. rest_method:: PUT /v2.0/fw/firewall_rules/{firewall_rule_id}
|
||||
|
||||
Updates a firewall rule.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule: firewall_rule
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- enabled: enabled
|
||||
- ip_version: ip_version
|
||||
- destination_ip_address: destination_ip_address
|
||||
- source_port: source_port
|
||||
- shared: shared
|
||||
- action: action
|
||||
- protocol: protocol
|
||||
- destination_port: destination_port
|
||||
- name: name
|
||||
- firewall_rule_id: firewall_rule_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-rule-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule: firewall_rule
|
||||
- description: description
|
||||
- source_ip_address: source_ip_address
|
||||
- tenant_id: tenant_id
|
||||
- enabled: enabled
|
||||
- protocol: protocol
|
||||
- source_port: source_port
|
||||
- ip_version: ip_version
|
||||
- destination_ip_address: destination_ip_address
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- shared: shared
|
||||
- action: action
|
||||
- position: position
|
||||
- destination_port: destination_port
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-rule-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete firewall rule
|
||||
====================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/fw/firewall_rules/{firewall_rule_id}
|
||||
|
||||
Deletes a firewall rule.
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule_id: firewall_rule_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show firewall details
|
||||
=====================
|
||||
|
||||
.. rest_method:: GET /v2.0/fw/firewalls/{firewall_id}
|
||||
|
||||
Shows details for a firewall.
|
||||
|
||||
If the user is not an administrative user and the firewall object
|
||||
does not belong to the tenant account, this call returns the
|
||||
``Forbidden (403)`` response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_id: firewall_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router_ids: router_ids
|
||||
- description: description
|
||||
- admin_state_up: admin_state_up
|
||||
- firewall: firewall
|
||||
- tenant_id: tenant_id
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update firewall
|
||||
===============
|
||||
|
||||
.. rest_method:: PUT /v2.0/fw/firewalls/{firewall_id}
|
||||
|
||||
Updates a firewall.
|
||||
|
||||
To update a service, the service status cannot be a ``PENDING_*``
|
||||
status.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_ids: router_ids
|
||||
- description: description
|
||||
- admin_state_up: admin_state_up
|
||||
- firewall: firewall
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- name: name
|
||||
- firewall_id: firewall_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router_ids: router_ids
|
||||
- description: description
|
||||
- admin_state_up: admin_state_up
|
||||
- firewall: firewall
|
||||
- tenant_id: tenant_id
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete firewall
|
||||
===============
|
||||
|
||||
.. rest_method:: DELETE /v2.0/fw/firewalls/{firewall_id}
|
||||
|
||||
Deletes a firewall.
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_id: firewall_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List firewall rules
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v2.0/fw/firewall_rules
|
||||
|
||||
Lists all firewall rules.
|
||||
|
||||
The list might be empty.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- protocol: protocol
|
||||
- description: description
|
||||
- source_ip_address: source_ip_address
|
||||
- tenant_id: tenant_id
|
||||
- enabled: enabled
|
||||
- id: id
|
||||
- ip_version: ip_version
|
||||
- destination_ip_address: destination_ip_address
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- shared: shared
|
||||
- action: action
|
||||
- position: position
|
||||
- destination_port: destination_port
|
||||
- source_port: source_port
|
||||
- firewalls: firewalls
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-rules-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create firewall rule
|
||||
====================
|
||||
|
||||
.. rest_method:: POST /v2.0/fw/firewall_rules
|
||||
|
||||
Creates a firewall rule.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule: firewall_rule
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- enabled: enabled
|
||||
- ip_version: ip_version
|
||||
- destination_ip_address: destination_ip_address
|
||||
- source_port: source_port
|
||||
- shared: shared
|
||||
- action: action
|
||||
- protocol: protocol
|
||||
- destination_port: destination_port
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-rule-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule: firewall_rule
|
||||
- description: description
|
||||
- source_ip_address: source_ip_address
|
||||
- tenant_id: tenant_id
|
||||
- enabled: enabled
|
||||
- protocol: protocol
|
||||
- source_port: source_port
|
||||
- ip_version: ip_version
|
||||
- destination_ip_address: destination_ip_address
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- shared: shared
|
||||
- action: action
|
||||
- position: position
|
||||
- destination_port: destination_port
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List firewalls
|
||||
==============
|
||||
|
||||
.. rest_method:: GET /v2.0/fw/firewalls
|
||||
|
||||
Lists all firewalls.
|
||||
|
||||
The list might be empty.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router_ids: router_ids
|
||||
- description: description
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- firewalls: firewalls
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewalls-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create firewall
|
||||
===============
|
||||
|
||||
.. rest_method:: POST /v2.0/fw/firewalls
|
||||
|
||||
Creates a firewall.
|
||||
|
||||
The firewall must be associated with a firewall policy.
|
||||
|
||||
If ``admin_state_up`` is ``false``, the firewall would block all
|
||||
traffic.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_ids: router_ids
|
||||
- description: description
|
||||
- admin_state_up: admin_state_up
|
||||
- firewall: firewall
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router_ids: router_ids
|
||||
- description: description
|
||||
- admin_state_up: admin_state_up
|
||||
- firewall: firewall
|
||||
- tenant_id: tenant_id
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Remove rule from firewall policy
|
||||
================================
|
||||
|
||||
.. rest_method:: PUT /v2.0/fw/firewall_policies/{firewall_policy_id}/remove_rule
|
||||
|
||||
Remove firewall rule from a policy.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- firewall_rule_id: firewall_rule_id
|
||||
- firewall_policy_id: firewall_policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-remove-rule-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- firewall_rules: firewall_rules
|
||||
- tenant_id: tenant_id
|
||||
- firewall_list: firewall_list
|
||||
- audited: audited
|
||||
- shared: shared
|
||||
- id: id
|
||||
- description: description
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/firewalls/firewall-policy-remove-rule-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,861 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=========================================
|
||||
Layer-3 networking (routers, floatingips)
|
||||
=========================================
|
||||
|
||||
Routes packets between subnets, forwards packets from internal
|
||||
networks to external ones, and accesses instances from external
|
||||
networks through floating IPs.
|
||||
|
||||
This extension introduces these resources:
|
||||
|
||||
- **router**. A logical entity for forwarding packets across
|
||||
internal subnets and NATting them on external networks through an
|
||||
appropriate external gateway.
|
||||
|
||||
- **floatingip**. An external IP address that you map to a port in
|
||||
an internal network.
|
||||
|
||||
|
||||
List floating IPs
|
||||
=================
|
||||
|
||||
.. rest_method:: GET /v2.0/floatingips
|
||||
|
||||
Lists floating IPs that are accessible to the tenant who submits the request.
|
||||
|
||||
Default policy settings return only those floating IPs that are
|
||||
owned by the tenant who submits the request, unless an admin user
|
||||
submits the request.
|
||||
|
||||
This example request lists floating IPs in JSON format:
|
||||
|
||||
::
|
||||
|
||||
GET /v2.0/floatingips
|
||||
Accept: application/json
|
||||
|
||||
Use the ``fields`` query parameter to control which fields are
|
||||
returned in the response body. Additionally, you can filter results
|
||||
by using query string parameters. For information, see `Filtering
|
||||
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
|
||||
-specification#Filtering_and_Column_Selection>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_id: router_id
|
||||
- status: status
|
||||
- tenant_id: tenant_id
|
||||
- floating_network_id: floating_network_id
|
||||
- fixed_ip_address: fixed_ip_address
|
||||
- floating_ip_address: floating_ip_address
|
||||
- port_id: port_id
|
||||
- id: id
|
||||
- floatingips: floatingips
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/floating-ips-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create floating IP
|
||||
==================
|
||||
|
||||
.. rest_method:: POST /v2.0/floatingips
|
||||
|
||||
Creates a floating IP, and, if you specify port information, associates the floating IP with an internal port.
|
||||
|
||||
To associate the floating IP with an internal port, specify the
|
||||
port UUID attribute in the request body. If you do not specify a
|
||||
port UUID in the request, you can issue a PUT request instead of a
|
||||
POST request.
|
||||
|
||||
Default policy settings enable only administrative users to set
|
||||
floating IP addresses and some non-administrative users might
|
||||
require a floating IP address. If you do not specify a floating IP
|
||||
address in the request, the operation automatically allocates one.
|
||||
|
||||
By default, this operation associates the floating IP address with
|
||||
a single fixed IP address that is configured on an OpenStack
|
||||
Networking port. If a port has multiple IP addresses, you must
|
||||
specify the ``fixed_ip_address`` attribute in the request body to
|
||||
associate a fixed IP address with the floating IP address.
|
||||
|
||||
You can create floating IPs on only external networks. When you
|
||||
create a floating IP, you must specify the UUID of the network on
|
||||
which you want to create the floating IP. Alternatively, you can
|
||||
create a floating IP on a subnet in the external network, based on
|
||||
the costs and quality of that subnet.
|
||||
|
||||
You must configure an IP address with the internal OpenStack
|
||||
Networking port that is associated with the floating IP address.
|
||||
|
||||
Error codes:
|
||||
|
||||
- ``400`` The operation returns this error code for one of these
|
||||
reasons:
|
||||
|
||||
- The network is not external, such as ``router:external=False``.
|
||||
|
||||
- The internal OpenStack Networking port is not associated with the
|
||||
floating IP address.
|
||||
|
||||
- The requested floating IP address does not fall in the subnet
|
||||
range for the external network.
|
||||
|
||||
- The fixed IP address is not valid.
|
||||
|
||||
- ``401`` The operation is not authorized.
|
||||
|
||||
- ``404`` The port UUID is not valid.
|
||||
|
||||
- ``409`` The operation returns this error code for one of these
|
||||
reasons:
|
||||
|
||||
- The requested floating IP address is already in use.
|
||||
|
||||
- The internal OpenStack Networking port and fixed IP address are
|
||||
already associated with another floating IP.
|
||||
|
||||
Error response codes:201,404,409,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- floatingip: floatingip
|
||||
- tenant_id: tenant_id
|
||||
- floating_network_id: floating_network_id
|
||||
- fixed_ip_address: fixed_ip_address
|
||||
- floating_ip_address: floating_ip_address
|
||||
- port_id: port_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/floatingip-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_id: router_id
|
||||
- status: status
|
||||
- floatingip: floatingip
|
||||
- tenant_id: tenant_id
|
||||
- floating_network_id: floating_network_id
|
||||
- fixed_ip_address: fixed_ip_address
|
||||
- floating_ip_address: floating_ip_address
|
||||
- port_id: port_id
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Add interface to router
|
||||
=======================
|
||||
|
||||
.. rest_method:: PUT /v2.0/routers/{router_id}/add_router_interface
|
||||
|
||||
Adds an internal interface to a logical router.
|
||||
|
||||
Attaches a subnet to an internal router interface.
|
||||
|
||||
Specify the UUID of a subnet or port in the request body:
|
||||
|
||||
- Subnet UUID. The gateway IP address for the subnet is used to
|
||||
create the router interface.
|
||||
|
||||
- Port UUID. The IP address associated with the port is used to
|
||||
create the router interface.
|
||||
|
||||
When you specify an IPv6 subnet, this operation adds the subnet to
|
||||
an existing internal port with same network UUID, on the router. If
|
||||
a port with the same network UUID does not exist, this operation
|
||||
creates a port on the router for that subnet.
|
||||
|
||||
The limitation of one IPv4 subnet per router port remains, though a
|
||||
port can contain any number of IPv6 subnets that belong to the same
|
||||
network UUID.
|
||||
|
||||
When you use the ``port-create`` command to add a port and then
|
||||
call ``router-interface-add`` with this port UUID, this operation
|
||||
adds the port to the router if the following conditions are met:
|
||||
|
||||
- The port has no more than one IPv4 subnet.
|
||||
|
||||
The IPv6 subnets, if any, on the port do not have same network
|
||||
UUID as the network UUID of IPv6 subnets on any other ports.
|
||||
|
||||
If you specify both UUIDs, this operation returns the ``Bad Request
|
||||
(400)`` response code.
|
||||
|
||||
If the port is already in use, this operation returns the
|
||||
``Conflict (409)`` response code.
|
||||
|
||||
This operation returns a port UUID that is either:
|
||||
|
||||
- The same UUID that is passed in the request body.
|
||||
|
||||
- The UUID of a port that this operation creates to attach the
|
||||
subnet to the router.
|
||||
|
||||
After you run this operation, the operation sets:
|
||||
|
||||
- The device UUID of this port to the router UUID.
|
||||
|
||||
- The ``device_owner`` attribute to ``network:router_interface``.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,409,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet_id: subnet_id
|
||||
- port_id: port_id
|
||||
- router_id: router_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-add-interface-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet_id: subnet_id
|
||||
- tenant_id: tenant_id
|
||||
- port_id: port_id
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-add-interface-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete interface from router
|
||||
============================
|
||||
|
||||
.. rest_method:: PUT /v2.0/routers/{router_id}/remove_router_interface
|
||||
|
||||
Deletes an internal interface from a logical router.
|
||||
|
||||
This operation deletes an internal router interface, which detaches
|
||||
a subnet from the router. If this subnet UUID is the last subnet on
|
||||
the port, this operation deletes the port itself. You must specify
|
||||
either a subnet UUID or port UUID in the request body; the
|
||||
operation uses this value to identify which router interface to
|
||||
deletes.
|
||||
|
||||
You can also specify both a subnet UUID and port UUID. If you
|
||||
specify both UUIDs, the subnet UUID must correspond to the subnet
|
||||
UUID of the first IP address on the port. Otherwise, this operation
|
||||
returns the ``Conflict (409)`` response code with information about
|
||||
the affected router and interface.
|
||||
|
||||
If the router or the subnet and port do not exist or are not
|
||||
visible to you, this operation returns the ``Not Found (404)``
|
||||
response code. As a consequence of this operation, the operation
|
||||
removes the port connecting the router with the subnet from the
|
||||
subnet for the network.
|
||||
|
||||
This example deletes an interface from a router:
|
||||
|
||||
::
|
||||
|
||||
PUT /v2.0/routers/{router_id}/remove_router_interface Accept: application/json
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,409,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet_id: subnet_id
|
||||
- port_id: port_id
|
||||
- router_id: router_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-remove-interface-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet_id: subnet_id
|
||||
- tenant_id: tenant_id
|
||||
- port_id: port_id
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-remove-interface-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show floating IP details
|
||||
========================
|
||||
|
||||
.. rest_method:: GET /v2.0/floatingips/{floatingip_id}
|
||||
|
||||
Shows details for a floating IP.
|
||||
|
||||
Use the ``fields`` query parameter to control which fields are
|
||||
returned in the response body. For information, see `Filtering and
|
||||
Column Selection <http://specs.openstack.org/openstack /neutron-
|
||||
specs/specs/api/networking_general_api_information.html #filtering-
|
||||
and-column- selection>`_.
|
||||
|
||||
This example request shows details for a floating IP in JSON
|
||||
format. This example also filters the result by the
|
||||
``fixed_ip_address`` and ``floating_ip_address`` fields.
|
||||
|
||||
::
|
||||
|
||||
GET /v2.0/floatingips/{floatingip_id}?fields=fixed_ip_address
|
||||
&
|
||||
fields=floating_ip_address
|
||||
Accept: application/json
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- floatingip_id: floatingip_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_id: router_id
|
||||
- status: status
|
||||
- floatingip: floatingip
|
||||
- tenant_id: tenant_id
|
||||
- floating_network_id: floating_network_id
|
||||
- fixed_ip_address: fixed_ip_address
|
||||
- floating_ip_address: floating_ip_address
|
||||
- port_id: port_id
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/floatingip-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update floating IP
|
||||
==================
|
||||
|
||||
.. rest_method:: PUT /v2.0/floatingips/{floatingip_id}
|
||||
|
||||
Updates a floating IP and its association with an internal port.
|
||||
|
||||
The association process is the same as the process for the create
|
||||
floating IP operation.
|
||||
|
||||
To disassociate a floating IP from a port, set the ``port_id``
|
||||
attribute to null or omit it from the request body.
|
||||
|
||||
This example updates a floating IP:
|
||||
|
||||
::
|
||||
|
||||
PUT /v2.0/floatingips/{floatingip_id} Accept: application/json
|
||||
|
||||
Depending on the request body that you submit, this request
|
||||
associates a port with or disassociates a port from a floating IP.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,409,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- port_id: port_id
|
||||
- floatingip: floatingip
|
||||
- floatingip_id: floatingip_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/floatingip-disassociate-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_id: router_id
|
||||
- status: status
|
||||
- floatingip: floatingip
|
||||
- tenant_id: tenant_id
|
||||
- floating_network_id: floating_network_id
|
||||
- fixed_ip_address: fixed_ip_address
|
||||
- floating_ip_address: floating_ip_address
|
||||
- port_id: port_id
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/floatingip-disassociate-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete floating IP
|
||||
==================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/floatingips/{floatingip_id}
|
||||
|
||||
Deletes a floating IP and, if present, its associated port.
|
||||
|
||||
This example deletes a floating IP:
|
||||
|
||||
::
|
||||
|
||||
DELETE /v2.0/floatingips/{floatingip_id} Accept: application/json
|
||||
|
||||
Error response codes:404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- floatingip_id: floatingip_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show router details
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v2.0/routers/{router_id}
|
||||
|
||||
Shows details for a router.
|
||||
|
||||
This example request shows details for a router in JSON format:
|
||||
|
||||
::
|
||||
|
||||
GET /v2.0/routers/{router_id} Accept: application/json
|
||||
|
||||
Use the ``fields`` query parameter to control which fields are
|
||||
returned in the response body. For information, see `Filtering and
|
||||
Column Selection <http://specs.openstack.org/openstack/neutron-
|
||||
specs/specs/api/networking_general_api_information.html#filtering-
|
||||
and-column-selection>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_id: router_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- status: status
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- distributed: distributed
|
||||
- enable_snat: enable_snat
|
||||
- routes: routes
|
||||
- router: router
|
||||
- ha: ha
|
||||
- id: id
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update router
|
||||
=============
|
||||
|
||||
.. rest_method:: PUT /v2.0/routers/{router_id}
|
||||
|
||||
Updates a logical router.
|
||||
|
||||
You can update the name, administrative state, and the external
|
||||
gateway. For more information about how to set the external gateway
|
||||
for a router, see the create router operation. This operation does
|
||||
not enable the update of router interfaces. To update a router, use
|
||||
the add router interface and remove router interface operations.
|
||||
|
||||
This example updates the external gateway information for a router:
|
||||
|
||||
::
|
||||
|
||||
PUT /v2.0/routers/{router_id} Accept: application/json
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- enable_snat: enable_snat
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- router: router
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
- router_id: router_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- status: status
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- distributed: distributed
|
||||
- enable_snat: enable_snat
|
||||
- routes: routes
|
||||
- router: router
|
||||
- ha: ha
|
||||
- id: id
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete router
|
||||
=============
|
||||
|
||||
.. rest_method:: DELETE /v2.0/routers/{router_id}
|
||||
|
||||
Deletes a logical router and, if present, its external gateway interface.
|
||||
|
||||
This operation fails if the router has attached interfaces.
|
||||
|
||||
Use the remove router interface operation to remove all router
|
||||
interfaces before you delete the router.
|
||||
|
||||
This example deletes a router:
|
||||
|
||||
::
|
||||
|
||||
DELETE /v2.0/routers/{router_id} Accept: application/json
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router_id: router_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List routers
|
||||
============
|
||||
|
||||
.. rest_method:: GET /v2.0/routers
|
||||
|
||||
Lists logical routers that the tenant who submits the request can access.
|
||||
|
||||
Default policy settings return only those routers that the tenant
|
||||
who submits the request owns, unless an administrative user submits
|
||||
the request.
|
||||
|
||||
This example request lists routers in JSON format:
|
||||
|
||||
::
|
||||
|
||||
GET /v2.0/routers Accept: application/json
|
||||
|
||||
Use the ``fields`` query parameter to control which fields are
|
||||
returned in the response body. Additionally, you can filter results
|
||||
by using query string parameters. For information, see `Filtering
|
||||
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
|
||||
-specification#Filtering_and_Column_Selection>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- status: status
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- routers: routers
|
||||
- distributed: distributed
|
||||
- enable_snat: enable_snat
|
||||
- tenant_id: tenant_id
|
||||
- routes: routes
|
||||
- ha: ha
|
||||
- id: id
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/routers-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create router
|
||||
=============
|
||||
|
||||
.. rest_method:: POST /v2.0/routers
|
||||
|
||||
Creates a logical router.
|
||||
|
||||
This operation creates a logical router. The logical router does
|
||||
not have any internal interface and it is not associated with any
|
||||
subnet. You can optionally specify an external gateway for a router
|
||||
at create time. The external gateway for the router must be plugged
|
||||
into an external network. An external network has its
|
||||
``router:external`` extended field set to ``true``. To specify an
|
||||
external gateway, the UUID of the external network must be passed
|
||||
in the ``external_gateway_info`` attribute in the request body, as
|
||||
follows:
|
||||
|
||||
.. code-block:: json
|
||||
|
||||
{
|
||||
"router": {
|
||||
"external_gateway_info": {
|
||||
"network_id": "8ca37218-28ff-41cb-9b10-039601ea7e6b"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- enable_snat: enable_snat
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- router: router
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/routers/router-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- external_gateway_info: external_gateway_info
|
||||
- status: status
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- distributed: distributed
|
||||
- enable_snat: enable_snat
|
||||
- routes: routes
|
||||
- router: router
|
||||
- ha: ha
|
||||
- id: id
|
||||
- external_fixed_ips: external_fixed_ips
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,334 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=================================================================
|
||||
Metering labels and rules (metering-labels, metering-label-rules)
|
||||
=================================================================
|
||||
|
||||
Creates, modifies, and deletes OpenStack Layer3 metering labels and
|
||||
rules.
|
||||
|
||||
|
||||
List metering labels
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.0/metering/metering-labels
|
||||
|
||||
Lists all L3 metering labels that belong to the tenant.
|
||||
|
||||
The list shows the UUID for each metering label.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- metering_labels: metering_labels
|
||||
- shared: shared
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/metering-labels/metering-labels-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create metering label
|
||||
=====================
|
||||
|
||||
.. rest_method:: POST /v2.0/metering/metering-labels
|
||||
|
||||
Creates an L3 metering label.
|
||||
|
||||
Error response codes:201,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- shared: shared
|
||||
- metering_label: metering_label
|
||||
- description: description
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/metering-labels/metering-label-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- metering_label: metering_label
|
||||
- shared: shared
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show metering label details
|
||||
===========================
|
||||
|
||||
.. rest_method:: GET /v2.0/metering/metering-labels/{metering-label-id}
|
||||
|
||||
Shows details for a metering label.
|
||||
|
||||
The response body shows the description, name, and UUID.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- metering_label: metering_label
|
||||
- shared: shared
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/metering-labels/metering-label-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete metering label
|
||||
=====================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/metering/metering-labels/{metering-label-id}
|
||||
|
||||
Deletes an L3 metering label.
|
||||
|
||||
Error response codes:404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List metering label rules
|
||||
=========================
|
||||
|
||||
.. rest_method:: GET /v2.0/metering/metering-label-rules
|
||||
|
||||
Lists a summary of all L3 metering label rules that belong to the tenant.
|
||||
|
||||
The list shows the UUID for each metering label rule.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- direction: direction
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- metering_label_rules: metering_label_rules
|
||||
- excluded : excluded
|
||||
- metering_label_id: metering_label_id
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/metering-labels/metering-label-rules-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create metering label rule
|
||||
==========================
|
||||
|
||||
.. rest_method:: POST /v2.0/metering/metering-label-rules
|
||||
|
||||
Creates an L3 metering label rule.
|
||||
|
||||
Error response codes:201,404,403,401,400,409,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- direction: direction
|
||||
- metering_label_id: metering_label_id
|
||||
- metering_label_rule: metering_label_rule
|
||||
- excluded: excluded
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/metering-labels/metering-label-rule-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- direction: direction
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- excluded : excluded
|
||||
- metering_label_id: metering_label_id
|
||||
- metering_label_rule: metering_label_rule
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show metering label rule details
|
||||
================================
|
||||
|
||||
.. rest_method:: GET /v2.0/metering/metering-label-rules/{metering-label-rule-id}
|
||||
|
||||
Shows details for a metering label rule.
|
||||
|
||||
The response body shows this information for each metering label
|
||||
rule:
|
||||
|
||||
- ``direction``. Either ingress or egress.
|
||||
|
||||
- ``excluded``. Either ``true`` or ``false``.
|
||||
|
||||
- The UUID for the metering label rule.
|
||||
|
||||
- The remote IP prefix.
|
||||
|
||||
- The metering label ID for the metering label with which the rule
|
||||
is associated.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/metering-labels/metering-label-rule-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete metering label rule
|
||||
==========================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/metering/metering-label-rules/{metering-label-rule-id}
|
||||
|
||||
Deletes an L3 metering label rule.
|
||||
|
||||
Error response codes:404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,285 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
================================================
|
||||
Networks provider extended attributes (networks)
|
||||
================================================
|
||||
|
||||
Lists, creates, shows information for, updates, and deletes
|
||||
networks.
|
||||
|
||||
The provider extension decorates network resources with additional
|
||||
attributes. These attributes are ``provider:network_type``,
|
||||
``provider:physical_network``, and ``provider:segmentation_id``.
|
||||
The validation rules for these attributes are the same as for the
|
||||
`Networks multiple provider extension
|
||||
<http://developer.openstack.org/api-ref-networking-v2-ext.html
|
||||
#networks-multi-provider-ext>`_ . You cannot use both extensions at
|
||||
the same time.
|
||||
|
||||
|
||||
Show network details
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.0/networks/{network_id}
|
||||
|
||||
Shows details for a network.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- network_id: network_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- subnets: subnets
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:network_type: provider:network_type
|
||||
- id: id
|
||||
- network: network
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update network
|
||||
==============
|
||||
|
||||
.. rest_method:: PUT /v2.0/networks/{network_id}
|
||||
|
||||
Updates a network.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- network: network
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- provider:network_type: provider:network_type
|
||||
- shared: shared
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- name: name
|
||||
- network_id: network_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- network: network
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:network_type: provider:network_type
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete network
|
||||
==============
|
||||
|
||||
.. rest_method:: DELETE /v2.0/networks/{network_id}
|
||||
|
||||
Deletes a network.
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- network_id: network_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List networks
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v2.0/networks
|
||||
|
||||
Lists networks that are accessible to the tenant who submits the request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- networks: networks
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- subnets: subnets
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:network_type: provider:network_type
|
||||
- id: id
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/networks-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create network
|
||||
==============
|
||||
|
||||
.. rest_method:: POST /v2.0/networks
|
||||
|
||||
Creates a network.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router:external: router:external
|
||||
- network: network
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- provider:network_type: provider:network_type
|
||||
- shared: shared
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- network: network
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- subnets: subnets
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:network_type: provider:network_type
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,109 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=======================================
|
||||
Network IP availability and usage stats
|
||||
=======================================
|
||||
|
||||
List and show the network IP usage stats of all networks and a
|
||||
specified network. These operations are available in the Mitaka
|
||||
release (April 2016).
|
||||
|
||||
|
||||
Show Network IP Availability
|
||||
============================
|
||||
|
||||
.. rest_method:: GET /v2.0/network-ip-availabilities/{network_id}
|
||||
|
||||
Shows network IP availability details for a network.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- network_id: network_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- used_ips: used_ips
|
||||
- subnet_ip_availability: subnet_ip_availability
|
||||
- network_id: network_id
|
||||
- tenant_id: tenant_id
|
||||
- total_ips: total_ips
|
||||
- network_ip_availability: network_ip_availability
|
||||
- subnet_id: subnet_id
|
||||
- subnet_name: subnet_name
|
||||
- ip_version: ip_version
|
||||
- cidr: cidr
|
||||
- network_name: network_name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/network-ip-availability/network-ip-availability-show.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List Network IP Availability
|
||||
============================
|
||||
|
||||
.. rest_method:: GET /v2.0/network-ip-availabilities
|
||||
|
||||
Lists network IP availability of all networks.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- used_ips: used_ips
|
||||
- subnet_ip_availability: subnet_ip_availability
|
||||
- network_id: network_id
|
||||
- tenant_id: tenant_id
|
||||
- total_ips: total_ips
|
||||
- subnet_id: subnet_id
|
||||
- subnet_name: subnet_name
|
||||
- ip_version: ip_version
|
||||
- cidr: cidr
|
||||
- network_name: network_name
|
||||
- network_ip_availabilities: network_ip_availabilities
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/network-ip-availability/network-ip-availability-list.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,198 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
===============================================
|
||||
Networks multiple provider extension (networks)
|
||||
===============================================
|
||||
|
||||
Enables administrative users to define multiple physical bindings
|
||||
for an OpenStack Networking network and list or show details for
|
||||
networks with multiple physical bindings.
|
||||
|
||||
You cannot update any ``provider`` attributes. If you try to do so,
|
||||
an error occurs.
|
||||
|
||||
To delete a network with multiple physical bindings, issue a normal
|
||||
delete network request.
|
||||
|
||||
To define multiple physical bindings for a network, include a
|
||||
``segments`` list in the request body of a ``POST /v2.0/networks``
|
||||
request. Each element in the ``segments`` list has the same
|
||||
structure as the provider network attributes. These attributes are
|
||||
``provider:network_type``, ``provider:physical_network``, and
|
||||
``provider:segmentation_id``. The validation rules for these
|
||||
attributes are the same as for the `Networks provider extended
|
||||
attributes <http://developer.openstack.org/api-ref-
|
||||
networking-v2-ext.html#network_provider-ext>`_ . You cannot use
|
||||
both extensions at the same time.
|
||||
|
||||
The NSX and ML2 plug-ins support this extension. With the ML2 plug-
|
||||
in, you can specify multiple VLANs for a network, a VXLAN tunnel
|
||||
ID, and a VLAN.
|
||||
|
||||
|
||||
Show details for a network with multiple segments
|
||||
=================================================
|
||||
|
||||
.. rest_method:: GET /v2.0/networks/{network_id}
|
||||
|
||||
Shows details for a network with multiple segments.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- network_id: network_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- network: network
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- segments: segments
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:network_type: provider:network_type
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/networks-multi-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List networks
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v2.0/networks
|
||||
|
||||
Lists networks that are accessible to the tenant who submits the request. Networks with multiple segments include the ``segments`` list in the response.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- name: name
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- segments: segments
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- id: id
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:network_type: provider:network_type
|
||||
- networks: networks
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/networks-multi-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create network with multiple segment mappings
|
||||
=============================================
|
||||
|
||||
.. rest_method:: POST /v2.0/networks
|
||||
|
||||
Creates a network with multiple segment mappings.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router:external: router:external
|
||||
- network: network
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- segments: segments
|
||||
- provider:network_type: provider:network_type
|
||||
- shared: shared
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-multi-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- network: network
|
||||
- provider:physical_network: provider:physical_network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- provider:segmentation_id: provider:segmentation_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- port_security_enabled: port_security_enabled
|
||||
- provider:network_type: provider:network_type
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,178 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
======================================
|
||||
VLAN transparency extension (networks)
|
||||
======================================
|
||||
|
||||
Enables plug-ins that support VLAN transparency to deliver VLAN-
|
||||
transparent trunk networks. If the service does not support VLAN
|
||||
transparency and a user requests a VLAN-transparent network, the
|
||||
plug-in refuses to create one and returns an appropriate error to
|
||||
the user.
|
||||
|
||||
You cannot update the ``vlan-transparent`` attribute. If you try to
|
||||
do so, an error occurs.
|
||||
|
||||
To delete a VLAN-transparent network, issue a normal delete network
|
||||
request.
|
||||
|
||||
The ML2 plug-in currently supports this extension. With the ML2
|
||||
plug-in, you can set the ``vlan-transparent`` attribute to either
|
||||
``true`` or ``false``.
|
||||
|
||||
|
||||
Show VLAN-transparent network details
|
||||
=====================================
|
||||
|
||||
.. rest_method:: GET /v2.0/networks/{network_id}
|
||||
|
||||
Shows details for a VLAN-transparent network.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- network_id: network_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- network: network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- vlan_transparent: vlan_transparent
|
||||
- port_security_enabled: port_security_enabled
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-vlan-transparent-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List networks with VLAN transparency attribute
|
||||
==============================================
|
||||
|
||||
.. rest_method:: GET /v2.0/networks
|
||||
|
||||
Lists networks. The response shows the VLAN transparency attribute.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- mtu: mtu
|
||||
- vlan_transparent: vlan_transparent
|
||||
- shared: shared
|
||||
- id: id
|
||||
- port_security_enabled: port_security_enabled
|
||||
- networks: networks
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/networks-vlan-transparent-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create VLAN-transparent network
|
||||
===============================
|
||||
|
||||
.. rest_method:: POST /v2.0/networks
|
||||
|
||||
Creates a VLAN-transparent network.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router:external: router:external
|
||||
- network: network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- shared: shared
|
||||
- vlan_transparent: vlan_transparent
|
||||
- port_security_enabled: port_security_enabled
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-vlan-transparent-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- network: network
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- vlan_transparent: vlan_transparent
|
||||
- port_security_enabled: port_security_enabled
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,167 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=========================================
|
||||
Ports binding extended attributes (ports)
|
||||
=========================================
|
||||
|
||||
Lists, creates, shows information for, updates, and deletes ports.
|
||||
|
||||
|
||||
Show port details
|
||||
=================
|
||||
|
||||
.. rest_method:: GET /v2.0/ports/{port_id}
|
||||
|
||||
Shows details for a port.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- port_id: port_id
|
||||
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-bind-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
Update port
|
||||
===========
|
||||
|
||||
.. rest_method:: PUT /v2.0/ports/{port_id}
|
||||
|
||||
Updates a port.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- port_id: port_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-bind-create-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete port
|
||||
===========
|
||||
|
||||
.. rest_method:: DELETE /v2.0/ports/{port_id}
|
||||
|
||||
Deletes a port.
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- port_id: port_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List ports
|
||||
==========
|
||||
|
||||
.. rest_method:: GET /v2.0/ports
|
||||
|
||||
Lists ports to which the tenant has access.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/ports-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create port
|
||||
===========
|
||||
|
||||
.. rest_method:: POST /v2.0/ports
|
||||
|
||||
Creates a port on a network.
|
||||
|
||||
Error response codes:201,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,724 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
==================
|
||||
QoS policies (qos)
|
||||
==================
|
||||
|
||||
Lists, creates, shows information for, and updates QoS policies.
|
||||
|
||||
|
||||
Show bandwidth limit rule details
|
||||
=================================
|
||||
|
||||
.. rest_method:: GET /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{rule_id}
|
||||
|
||||
Shows details for a bandwidth limit rule for a QoS policy.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:500,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- rule_id: rule_id
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- bandwidth_limit_rule: bandwidth_limit_rule
|
||||
- max_kbps: max_kbps
|
||||
- id: id
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/bandwidth_limit_rule-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update bandwidth limit rule
|
||||
===========================
|
||||
|
||||
.. rest_method:: PUT /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{rule_id}
|
||||
|
||||
Updates a bandwidth limit rule for a QoS policy.
|
||||
|
||||
If the request is valid, the service returns the ``Accepted (202)``
|
||||
response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:400,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- bandwidth_limit_rule: bandwidth_limit_rule
|
||||
- max_kbps: max_kbps
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- policy_id: policy_id
|
||||
- rule_id: rule_id
|
||||
- policy_id: policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/bandwidth_limit_rule-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- bandwidth_limit_rule: bandwidth_limit_rule
|
||||
- max_kbps: max_kbps
|
||||
- id: id
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/bandwidth_limit_rule-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete bandwidth limit rule
|
||||
===========================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{rule_id}
|
||||
|
||||
Deletes a bandwidth limit rule for a QoS policy.
|
||||
|
||||
Error response codes:204,400,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- rule_id: rule_id
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List QoS policies
|
||||
=================
|
||||
|
||||
.. rest_method:: GET /v2.0/qos/policies
|
||||
|
||||
Lists all QoS policies that are associated with your tenant account.
|
||||
|
||||
The list might be empty.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:500,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- max_kbps: max_kbps
|
||||
- bandwidth_limit_rules: bandwidth_limit_rules
|
||||
- description: description
|
||||
- policy_id: policy_id
|
||||
- tenant_id: tenant_id
|
||||
- dscp_marking_rules: dscp_marking_rules
|
||||
- policies: policies
|
||||
- shared: shared
|
||||
- dscp_mark: dscp_mark
|
||||
- id: id
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/policies-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create QoS policy
|
||||
=================
|
||||
|
||||
.. rest_method:: POST /v2.0/qos/policies
|
||||
|
||||
Creates a QoS policy.
|
||||
|
||||
Creates a QoS policy by using the configuration that you define in
|
||||
the request object. A response object is returned. The object
|
||||
contains a unique ID.
|
||||
|
||||
If the caller is not an administrative user, this call returns the
|
||||
HTTP ``Forbidden (403)`` response code.
|
||||
|
||||
Users with an administrative role can create policies on behalf of
|
||||
other tenants by specifying a tenant UUID that is different than
|
||||
their own.
|
||||
|
||||
Error response codes:201,404,409,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- policy: policy
|
||||
- shared: shared
|
||||
- type: type
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/policy-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- policy: policy
|
||||
- shared: shared
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show DSCP marking rule details
|
||||
==============================
|
||||
|
||||
.. rest_method:: GET /v2.0/qos/policies/{policy_id}/dscp_marking_rules/{dscp_rule_id}
|
||||
|
||||
Shows details for a DSCP marking rule for a QoS policy.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:500,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- dscp_marking_rule: dscp_marking_rule
|
||||
- dscp_mark: dscp_mark
|
||||
- id: id
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/dscp_marking_rule-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update DSCP marking rule
|
||||
========================
|
||||
|
||||
.. rest_method:: PUT /v2.0/qos/policies/{policy_id}/dscp_marking_rules/{dscp_rule_id}
|
||||
|
||||
Updates a DSCP marking rule for a QoS policy.
|
||||
|
||||
If the request is valid, the service returns the ``Accepted (202)``
|
||||
response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:400,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- dscp_marking_rule: dscp_marking_rule
|
||||
- dscp_mark: dscp_mark
|
||||
- policy_id: policy_id
|
||||
- policy_id: policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/dscp_marking_rule-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- dscp_marking_rule: dscp_marking_rule
|
||||
- dscp_mark: dscp_mark
|
||||
- id: id
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/dscp_marking_rule-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete DSCP marking rule
|
||||
========================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/qos/policies/{policy_id}/dscp_marking_rules/{dscp_rule_id}
|
||||
|
||||
Deletes a DSCP marking rule for a QoS policy.
|
||||
|
||||
Error response codes:204,400,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List DSCP marking rules for QoS policy
|
||||
======================================
|
||||
|
||||
.. rest_method:: GET /v2.0/qos/policies/{policy_id}/dscp_marking_rules
|
||||
|
||||
Lists all DSCP marking rules for a QoS policy.
|
||||
|
||||
The list may be empty.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:500,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- dscp_marking_rules: dscp_marking_rules
|
||||
- dscp_mark: dscp_mark
|
||||
- id: id
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/dscp_marking_rules-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create DSCP marking rule
|
||||
========================
|
||||
|
||||
.. rest_method:: POST /v2.0/qos/policies/{policy_id}/dscp_marking_rules
|
||||
|
||||
Creates a DSCP marking rule for a QoS policy.
|
||||
|
||||
Error response codes:201,404,409,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- dscp_marking_rule: dscp_marking_rule
|
||||
- dscp_mark: dscp_mark
|
||||
- policy_id: policy_id
|
||||
- policy_id: policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/dscp_marking_rule-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- dscp_marking_rule: dscp_marking_rule
|
||||
- dscp_mark: dscp_mark
|
||||
- id: id
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Show QoS policy details
|
||||
=======================
|
||||
|
||||
.. rest_method:: GET /v2.0/qos/policies/{policy_id}
|
||||
|
||||
Shows details for a QoS policy.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:500,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- max_kbps: max_kbps
|
||||
- bandwidth_limit_rules: bandwidth_limit_rules
|
||||
- description: description
|
||||
- policy_id: policy_id
|
||||
- tenant_id: tenant_id
|
||||
- dscp_marking_rules: dscp_marking_rules
|
||||
- policy: policy
|
||||
- shared: shared
|
||||
- dscp_mark: dscp_mark
|
||||
- id: id
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/policy-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update QoS policy
|
||||
=================
|
||||
|
||||
.. rest_method:: PUT /v2.0/qos/policies/{policy_id}
|
||||
|
||||
Updates a QoS policy.
|
||||
|
||||
If the request is valid, the service returns the ``Accepted (202)``
|
||||
response code.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:400,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- policy: policy
|
||||
- shared: shared
|
||||
- type: type
|
||||
- name: name
|
||||
- policy_id: policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/policy-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenant_id: tenant_id
|
||||
- policy: policy
|
||||
- shared: shared
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/policy-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete QoS policy
|
||||
=================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/qos/policies/{policy_id}
|
||||
|
||||
Deletes a QoS policy.
|
||||
|
||||
Error response codes:204,400,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List bandwidth limit rules for QoS policy
|
||||
=========================================
|
||||
|
||||
.. rest_method:: GET /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules
|
||||
|
||||
Lists all bandwidth limit rules for a QoS policy.
|
||||
|
||||
The list might be empty.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:500,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- max_kbps: max_kbps
|
||||
- bandwidth_limit_rules: bandwidth_limit_rules
|
||||
- id: id
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/bandwidth_limit_rules-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create bandwidth limit rule
|
||||
===========================
|
||||
|
||||
.. rest_method:: POST /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules
|
||||
|
||||
Creates a bandwidth limit rule for a QoS policy.
|
||||
|
||||
Error response codes:201,404,409,401,413,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- bandwidth_limit_rule: bandwidth_limit_rule
|
||||
- max_kbps: max_kbps
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- policy_id: policy_id
|
||||
- policy_id: policy_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/qos/bandwidth_limit_rule-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- bandwidth_limit_rule: bandwidth_limit_rule
|
||||
- max_kbps: max_kbps
|
||||
- id: id
|
||||
- max_burst_kbps: max_burst_kbps
|
||||
- policy_id: policy_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,201 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=========================
|
||||
Quotas extension (quotas)
|
||||
=========================
|
||||
|
||||
Lists quotas for tenants who have non-default quota values, and
|
||||
lists, updates, and resets quotas for a tenant.
|
||||
|
||||
A quota value of ``-1`` means that quota has no limit.
|
||||
|
||||
|
||||
List quotas for tenants with non-default quota values
|
||||
=====================================================
|
||||
|
||||
.. rest_method:: GET /v2.0/quotas
|
||||
|
||||
Lists quotas for tenants who have non-default quota values.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet: subnet
|
||||
- network: network
|
||||
- floatingip: floatingip
|
||||
- subnetpool: subnetpool
|
||||
- quotas: quotas
|
||||
- security_group_rule: security_group_rule
|
||||
- security_group: security_group
|
||||
- router: router
|
||||
- rbac_policy: rbac_policy
|
||||
- port: port
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/quotas/quotas-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List quotas for a tenant
|
||||
========================
|
||||
|
||||
.. rest_method:: GET /v2.0/quotas/{tenant_id}
|
||||
|
||||
Lists quotas for a tenant.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet: subnet
|
||||
- network: network
|
||||
- floatingip: floatingip
|
||||
- subnetpool: subnetpool
|
||||
- quota: quota
|
||||
- security_group_rule: security_group_rule
|
||||
- security_group: security_group
|
||||
- router: router
|
||||
- rbac_policy: rbac_policy
|
||||
- port: port
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/quotas/quotas-list-for-tenant-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update quota for a tenant
|
||||
=========================
|
||||
|
||||
.. rest_method:: PUT /v2.0/quotas/{tenant_id}
|
||||
|
||||
Updates quotas for a tenant. Use when non-default quotas are desired.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet: subnet
|
||||
- network: network
|
||||
- floatingip: floatingip
|
||||
- subnetpool: subnetpool
|
||||
- quota: quota
|
||||
- security_group_rule: security_group_rule
|
||||
- security_group: security_group
|
||||
- router: router
|
||||
- rbac_policy: rbac_policy
|
||||
- port: port
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/quotas/quotas-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnet: subnet
|
||||
- network: network
|
||||
- floatingip: floatingip
|
||||
- subnetpool: subnetpool
|
||||
- quota: quota
|
||||
- security_group_rule: security_group_rule
|
||||
- security_group: security_group
|
||||
- router: router
|
||||
- rbac_policy: rbac_policy
|
||||
- port: port
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/quotas/quotas-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reset quota for a tenant
|
||||
========================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/quotas/{tenant_id}
|
||||
|
||||
Resets quotas to default values for a tenant.
|
||||
|
||||
Error response codes:404,403,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,268 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=================================
|
||||
Security groups (security-groups)
|
||||
=================================
|
||||
|
||||
Lists, creates, shows information for, updates, and deletes
|
||||
security groups.
|
||||
|
||||
|
||||
Show security group
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v2.0/security-groups/{security_group_id}
|
||||
|
||||
Shows details for a security group.
|
||||
|
||||
The response contains the description, name, UUID, and security
|
||||
group rules that are associated with the security group and tenant.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- security_group_id: security_group_id
|
||||
- verbose: verbose
|
||||
- fields: fields
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_group_id: remote_group_id
|
||||
- direction: direction
|
||||
- protocol: protocol
|
||||
- description: description
|
||||
- ethertype: ethertype
|
||||
- port_range_max: port_range_max
|
||||
- security_group_rules: security_group_rules
|
||||
- security_group_id: security_group_id
|
||||
- tenant_id: tenant_id
|
||||
- port_range_min: port_range_min
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- security_group: security_group
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-group-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update security group
|
||||
=====================
|
||||
|
||||
.. rest_method:: PUT /v2.0/security-groups/{security_group_id}
|
||||
|
||||
Updates a security group.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:413,405,404,403,401,400,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- name: name
|
||||
- security_group_id: security_group_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-group-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- security_group: security_group
|
||||
- tenant_id: tenant_id
|
||||
- description: description
|
||||
- name: name
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-group-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete security group
|
||||
=====================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/security-groups/{security_group_id}
|
||||
|
||||
Deletes an OpenStack Networking security group.
|
||||
|
||||
This operation deletes an OpenStack Networking security group and
|
||||
its associated security group rules, provided that a port is not
|
||||
associated with the security group.
|
||||
|
||||
This operation does not require a request body. This operation does
|
||||
not return a response body.
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- security_group_id: security_group_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List security groups
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.0/security-groups
|
||||
|
||||
Lists OpenStack Networking security groups to which the tenant has access.
|
||||
|
||||
The list shows the UUID for and the rules that are associated with
|
||||
each security group.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_group_id: remote_group_id
|
||||
- direction: direction
|
||||
- protocol: protocol
|
||||
- description: description
|
||||
- ethertype: ethertype
|
||||
- port_range_max: port_range_max
|
||||
- security_group_rules: security_group_rules
|
||||
- security_group_id: security_group_id
|
||||
- tenant_id: tenant_id
|
||||
- port_range_min: port_range_min
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- id: id
|
||||
- security_groups: security_groups
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-groups-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create security group
|
||||
=====================
|
||||
|
||||
.. rest_method:: POST /v2.0/security-groups
|
||||
|
||||
Creates an OpenStack Networking security group.
|
||||
|
||||
This operation creates a security group with default security group
|
||||
rules for the IPv4 and IPv6 ether types.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- security_group: security_group
|
||||
- tenant_id: tenant_id
|
||||
- description: description
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-group-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_group_id: remote_group_id
|
||||
- direction: direction
|
||||
- protocol: protocol
|
||||
- description: description
|
||||
- ethertype: ethertype
|
||||
- port_range_max: port_range_max
|
||||
- security_group_rules: security_group_rules
|
||||
- security_group_id: security_group_id
|
||||
- tenant_id: tenant_id
|
||||
- port_range_min: port_range_min
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- security_group: security_group
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,192 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
===========================================
|
||||
Security group rules (security-group-rules)
|
||||
===========================================
|
||||
|
||||
Lists, creates, shows information for, and deletes security group
|
||||
rules.
|
||||
|
||||
|
||||
Show security group rule
|
||||
========================
|
||||
|
||||
.. rest_method:: GET /v2.0/security-group-rules/{security-group-rules-id}
|
||||
|
||||
Shows detailed information for a security group rule.
|
||||
|
||||
The response body contains the following information about the
|
||||
security group rule:
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_group_id: remote_group_id
|
||||
- direction: direction
|
||||
- protocol: protocol
|
||||
- ethertype: ethertype
|
||||
- port_range_max: port_range_max
|
||||
- security_group_id: security_group_id
|
||||
- security_group_rule: security_group_rule
|
||||
- tenant_id: tenant_id
|
||||
- port_range_min: port_range_min
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-group-rule-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete security group rule
|
||||
==========================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/security-group-rules/{security-group-rules-id}
|
||||
|
||||
Deletes a rule from an OpenStack Networking security group.
|
||||
|
||||
Error response codes:404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List security group rules
|
||||
=========================
|
||||
|
||||
.. rest_method:: GET /v2.0/security-group-rules
|
||||
|
||||
Lists a summary of all OpenStack Networking security group rules that the tenant can access.
|
||||
|
||||
The list provides the UUID for each security group rule.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_group_id: remote_group_id
|
||||
- direction: direction
|
||||
- protocol: protocol
|
||||
- ethertype: ethertype
|
||||
- port_range_max: port_range_max
|
||||
- security_group_rules: security_group_rules
|
||||
- security_group_id: security_group_id
|
||||
- tenant_id: tenant_id
|
||||
- port_range_min: port_range_min
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-group-rules-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create security group rule
|
||||
==========================
|
||||
|
||||
.. rest_method:: POST /v2.0/security-group-rules
|
||||
|
||||
Creates an OpenStack Networking security group rule.
|
||||
|
||||
Error response codes:201,404,409,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_group_id: remote_group_id
|
||||
- direction: direction
|
||||
- protocol: protocol
|
||||
- ethertype: ethertype
|
||||
- port_range_max: port_range_max
|
||||
- security_group_id: security_group_id
|
||||
- security_group_rule: security_group_rule
|
||||
- port_range_min: port_range_min
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/security-groups/security-group-rule-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- remote_group_id: remote_group_id
|
||||
- direction: direction
|
||||
- protocol: protocol
|
||||
- ethertype: ethertype
|
||||
- port_range_max: port_range_max
|
||||
- security_group_id: security_group_id
|
||||
- security_group_rule: security_group_rule
|
||||
- tenant_id: tenant_id
|
||||
- port_range_min: port_range_min
|
||||
- remote_ip_prefix: remote_ip_prefix
|
||||
- id: id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,279 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
====================================
|
||||
Subnet pools extension (subnetpools)
|
||||
====================================
|
||||
|
||||
Lists, creates, shows details for, updates, and deletes subnet
|
||||
pools.
|
||||
|
||||
|
||||
Show subnet pool
|
||||
================
|
||||
|
||||
.. rest_method:: GET /v2.0/subnetpools/{subnetpool_id}
|
||||
|
||||
Shows information for a subnet pool.
|
||||
|
||||
Use the ``fields`` query parameter to filter the results.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnetpool_id: subnetpool_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- default_quota: default_quota
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- subnetpool: subnetpool
|
||||
- updated_at: updated_at
|
||||
- prefixes: prefixes
|
||||
- min_prefixlen: min_prefixlen
|
||||
- address_scope_id: address_scope_id
|
||||
- ip_version: ip_version
|
||||
- shared: shared
|
||||
- default_prefixlen: default_prefixlen
|
||||
- id: id
|
||||
- max_prefixlen: max_prefixlen
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/subnets/subnetpool-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update subnet pool
|
||||
==================
|
||||
|
||||
.. rest_method:: PUT /v2.0/subnetpools/{subnetpool_id}
|
||||
|
||||
Updates a subnet pool.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- default_quota: default_quota
|
||||
- tenant_id: tenant_id
|
||||
- subnetpool: subnetpool
|
||||
- prefixes: prefixes
|
||||
- min_prefixlen: min_prefixlen
|
||||
- address_scope_id: address_scope_id
|
||||
- default_prefixlen: default_prefixlen
|
||||
- max_prefixlen: max_prefixlen
|
||||
- subnetpool_id: subnetpool_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/subnets/subnetpool-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- default_quota: default_quota
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- subnetpool: subnetpool
|
||||
- updated_at: updated_at
|
||||
- prefixes: prefixes
|
||||
- min_prefixlen: min_prefixlen
|
||||
- address_scope_id: address_scope_id
|
||||
- ip_version: ip_version
|
||||
- shared: shared
|
||||
- default_prefixlen: default_prefixlen
|
||||
- id: id
|
||||
- max_prefixlen: max_prefixlen
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/subnets/subnetpool-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete subnet pool
|
||||
==================
|
||||
|
||||
.. rest_method:: DELETE /v2.0/subnetpools/{subnetpool_id}
|
||||
|
||||
Deletes a subnet pool.
|
||||
|
||||
The operation fails if any subnets allocated from the subnet pool
|
||||
are still in use.
|
||||
|
||||
Error response codes:404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- subnetpool_id: subnetpool_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List subnet pools
|
||||
=================
|
||||
|
||||
.. rest_method:: GET /v2.0/subnetpools
|
||||
|
||||
Lists subnet pools to which the tenant has access.
|
||||
|
||||
Default policy settings returns exclusively subnet pools owned by
|
||||
the tenant submitting the request, unless the request is submitted
|
||||
by a user with administrative rights.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- default_quota: default_quota
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- prefixes: prefixes
|
||||
- min_prefixlen: min_prefixlen
|
||||
- address_scope_id: address_scope_id
|
||||
- ip_version: ip_version
|
||||
- shared: shared
|
||||
- default_prefixlen: default_prefixlen
|
||||
- subnetpools: subnetpools
|
||||
- id: id
|
||||
- max_prefixlen: max_prefixlen
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/subnets/subnetpools-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create subnet pool
|
||||
==================
|
||||
|
||||
.. rest_method:: POST /v2.0/subnetpools
|
||||
|
||||
Creates a subnet pool.
|
||||
|
||||
Error response codes:201,404,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- default_quota: default_quota
|
||||
- tenant_id: tenant_id
|
||||
- subnetpool: subnetpool
|
||||
- prefixes: prefixes
|
||||
- min_prefixlen: min_prefixlen
|
||||
- address_scope_id: address_scope_id
|
||||
- shared: shared
|
||||
- default_prefixlen: default_prefixlen
|
||||
- max_prefixlen: max_prefixlen
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/subnets/subnetpool-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- default_quota: default_quota
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- subnetpool: subnetpool
|
||||
- updated_at: updated_at
|
||||
- prefixes: prefixes
|
||||
- min_prefixlen: min_prefixlen
|
||||
- address_scope_id: address_scope_id
|
||||
- ip_version: ip_version
|
||||
- shared: shared
|
||||
- default_prefixlen: default_prefixlen
|
||||
- id: id
|
||||
- max_prefixlen: max_prefixlen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,172 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
====================
|
||||
Tag extension (tags)
|
||||
====================
|
||||
|
||||
Shows details for, updates, and deletes tags. This extension is
|
||||
available since Mitaka release.
|
||||
|
||||
|
||||
Replace all tags
|
||||
================
|
||||
|
||||
.. rest_method:: PUT /v2.0/{resource_type}/{resource_id}/tags
|
||||
|
||||
Replaces all tags on the resource.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,400,503,500,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tags: tags
|
||||
- resource_type: resource_type
|
||||
- resource_id: resource_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/tag/tag-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tags: tags
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/tag/tag-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Remove all tags
|
||||
===============
|
||||
|
||||
.. rest_method:: DELETE /v2.0/{resource_type}/{resource_id}/tags
|
||||
|
||||
Removes all tags on the resource.
|
||||
|
||||
Error response codes:500,404,204,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- resource_type: resource_type
|
||||
- resource_id: resource_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Confirm a tag
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v2.0/{resource_type}/{resource_id}/tags/{tag}
|
||||
|
||||
Confirms a given tag is set on the resource.
|
||||
|
||||
Error response codes:500,404,204,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tag: tag
|
||||
- resource_type: resource_type
|
||||
- resource_id: resource_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Add a tag
|
||||
=========
|
||||
|
||||
.. rest_method:: PUT /v2.0/{resource_type}/{resource_id}/tags/{tag}
|
||||
|
||||
Adds a tag on the resource.
|
||||
|
||||
Error response codes:201,404,500,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tag: tag
|
||||
- resource_type: resource_type
|
||||
- resource_id: resource_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Remove a tag
|
||||
============
|
||||
|
||||
.. rest_method:: DELETE /v2.0/{resource_type}/{resource_id}/tags/{tag}
|
||||
|
||||
Removes a tag on the resource.
|
||||
|
||||
Error response codes:500,404,204,401,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tag: tag
|
||||
- resource_type: resource_type
|
||||
- resource_id: resource_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,338 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
========
|
||||
Networks
|
||||
========
|
||||
|
||||
Lists, shows details for, creates, updates, and deletes networks.
|
||||
|
||||
|
||||
Show network details
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.0/networks/{network_id}
|
||||
|
||||
Shows details for a network.
|
||||
|
||||
You can control which response parameters are returned by using the
|
||||
fields query parameter. For information, see `Filtering and column
|
||||
selection <http://specs.openstack.org/openstack/neutron-
|
||||
specs/specs/api/networking_general_api_information.html#filtering-
|
||||
and-column-selection>`_.
|
||||
|
||||
The response might show extension response parameters. For
|
||||
information, see `Networks multiple provider extension (networks)
|
||||
<http://developer.openstack.org/api-ref-
|
||||
networking-v2-ext.html#showProviderNetwork>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- network_id: network_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- updated_at: updated_at
|
||||
- changed_at: changed_at
|
||||
- mtu: mtu
|
||||
- qos_policy_id: qos_policy_id
|
||||
- subnets: subnets
|
||||
- shared: shared
|
||||
- id: id
|
||||
- network: network
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update network
|
||||
==============
|
||||
|
||||
.. rest_method:: PUT /v2.0/networks/{network_id}
|
||||
|
||||
Updates a network.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router:external: router:external
|
||||
- network: network
|
||||
- admin_state_up: admin_state_up
|
||||
- shared: shared
|
||||
- port_security_enabled: port_security_enabled
|
||||
- name: name
|
||||
- network_id: network_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- mtu: mtu
|
||||
- qos_policy_id: qos_policy_id
|
||||
- subnets: subnets
|
||||
- shared: shared
|
||||
- id: id
|
||||
- network: network
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete network
|
||||
==============
|
||||
|
||||
.. rest_method:: DELETE /v2.0/networks/{network_id}
|
||||
|
||||
Deletes a network and its associated resources.
|
||||
|
||||
Error response codes:409,404,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- network_id: network_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List networks
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v2.0/networks
|
||||
|
||||
Lists networks to which the tenant has access.
|
||||
|
||||
Use the ``fields`` query parameter to filter the response. For
|
||||
information, see `Filtering and Column Selection <https://wiki.open
|
||||
stack.org/wiki/Neutron/APIv2-specification#Filtering_and_Column_Sel
|
||||
ection>`_.
|
||||
|
||||
Use the ``tags``, ``tags-any``, ``not-tags``, ``not-tags-any``
|
||||
query parameter to filter the response with tags. For information,
|
||||
see `REST API Impact <http://specs.openstack.org/openstack/neutron-
|
||||
specs/specs/mitaka/add-tags-to-core-resources.html#rest-api-
|
||||
impact>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- networks: networks
|
||||
- mtu: mtu
|
||||
- subnets: subnets
|
||||
- shared: shared
|
||||
- id: id
|
||||
- qos_policy_id: qos_policy_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/networks-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create network
|
||||
==============
|
||||
|
||||
.. rest_method:: POST /v2.0/networks
|
||||
|
||||
Creates a network.
|
||||
|
||||
A request body is optional. An administrative user can specify
|
||||
another tenant UUID, which is the tenant who owns the network, in
|
||||
the request body.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/network-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- availability_zone_hints: availability_zone_hints
|
||||
- availability_zones: availability_zones
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- mtu: mtu
|
||||
- qos_policy_id: qos_policy_id
|
||||
- subnets: subnets
|
||||
- shared: shared
|
||||
- id: id
|
||||
- network: network
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Bulk create networks
|
||||
====================
|
||||
|
||||
.. rest_method:: POST /v2.0/networks
|
||||
|
||||
Creates multiple networks in a single request.
|
||||
|
||||
In the request body, specify a list of networks.
|
||||
|
||||
The bulk create operation is always atomic. Either all or no
|
||||
networks in the request body are created.
|
||||
|
||||
Error response codes:201,401,400,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- router:external: router:external
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- port_security_enabled: port_security_enabled
|
||||
- shared: shared
|
||||
- networks: networks
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/networks/networks-bulk-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status
|
||||
- router:external: router:external
|
||||
- subnets: subnets
|
||||
- name: name
|
||||
- admin_state_up: admin_state_up
|
||||
- tenant_id: tenant_id
|
||||
- mtu: mtu
|
||||
- shared: shared
|
||||
- id: id
|
||||
- port_security_enabled: port_security_enabled
|
||||
- networks: networks
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,430 +0,0 @@
|
||||
# variables in header
|
||||
{}
|
||||
|
||||
# variables in path
|
||||
network_id_1:
|
||||
description: |
|
||||
The UUID of the network.
|
||||
in: path
|
||||
required: false
|
||||
type: string
|
||||
port_id:
|
||||
description: |
|
||||
The UUID of the port.
|
||||
in: path
|
||||
required: false
|
||||
type: string
|
||||
subnet_id_2:
|
||||
description: |
|
||||
The UUID of the subnet.
|
||||
in: path
|
||||
required: false
|
||||
type: string
|
||||
|
||||
# variables in query
|
||||
{}
|
||||
|
||||
# variables in body
|
||||
admin_state_up:
|
||||
description: |
|
||||
The administrative state of the network, which is
|
||||
up (``true``) or down (``false``).
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
admin_state_up_1:
|
||||
description: |
|
||||
The administrative status of the port, which is
|
||||
up (``true``) or down (``false``).
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
admin_state_up_2:
|
||||
description: |
|
||||
The administrative state of the network, which is
|
||||
up (``true``) or down (``false``).
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
admin_state_up_3:
|
||||
description: |
|
||||
The administrative state of the port, which is up
|
||||
(``true``) or down (``false``).
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
allowed_address_pairs:
|
||||
description: |
|
||||
A set of zero or more allowed address pairs. An
|
||||
address pair contains an IP address and MAC address.
|
||||
in: body
|
||||
required: false
|
||||
type: array
|
||||
allowed_address_pairs_1:
|
||||
description: |
|
||||
A set of zero or more allowed address pairs. An
|
||||
address pair consists of an IP address and MAC address.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
availability_zone_hints:
|
||||
description: |
|
||||
The availability zone candidate for the network.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
availability_zones:
|
||||
description: |
|
||||
The availability zone for the network.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
changed_at:
|
||||
description: |
|
||||
Time at which the network has been created.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
created_at:
|
||||
description: |
|
||||
Time at which port has been created.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
default:
|
||||
description: |
|
||||
Defines whether the provider is the default for
|
||||
the service type. If this value is ``true``, the provider is the
|
||||
default. If this value is ``false``, the provider is not the
|
||||
default.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
device_id:
|
||||
description: |
|
||||
The UUID of the device that uses this port. For
|
||||
example, a virtual server.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
device_id_1:
|
||||
description: |
|
||||
The UUID of the device that uses this port. For
|
||||
example, a virtual server.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
device_owner:
|
||||
description: |
|
||||
The UUID of the entity that uses this port. For
|
||||
example, a DHCP agent.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
device_owner_1:
|
||||
description: |
|
||||
The UUID of the entity that uses this port. For
|
||||
example, a DHCP agent.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
extra_dhcp_opts:
|
||||
description: |
|
||||
A set of zero or more extra DHCP option pairs. An
|
||||
option pair consists of an option value and name.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
fixed_ips:
|
||||
description: |
|
||||
If you specify only a subnet UUID, OpenStack
|
||||
Networking allocates an available IP from that subnet to the port.
|
||||
If you specify both a subnet UUID and an IP address, OpenStack
|
||||
Networking tries to allocate the address to the port.
|
||||
in: body
|
||||
required: false
|
||||
type: array
|
||||
fixed_ips_1:
|
||||
description: |
|
||||
The IP addresses for the port. Includes the IP
|
||||
address and UUID of the subnet.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
id:
|
||||
description: |
|
||||
The UUID of the network.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
id_1:
|
||||
description: |
|
||||
The UUID of the port.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
ip_address:
|
||||
description: |
|
||||
The IP address of an allowed address pair.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
ip_address_1:
|
||||
description: |
|
||||
The fixed IP address of the port.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
location:
|
||||
description: |
|
||||
Full URL to a service or server.
|
||||
format: uri
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
mac_address:
|
||||
description: |
|
||||
The MAC address of an allowed address pair.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
mac_address_1:
|
||||
description: |
|
||||
The MAC address.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
mtu:
|
||||
description: |
|
||||
The MTU of a network resource.
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
name:
|
||||
description: |
|
||||
The network name.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
name_1:
|
||||
description: |
|
||||
A symbolic name for the port.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
name_2:
|
||||
description: |
|
||||
The network name.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
name_3:
|
||||
description: |
|
||||
The port name.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
name_4:
|
||||
description: |
|
||||
User-facing provider name.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
network:
|
||||
description: |
|
||||
A ``network`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
network_id:
|
||||
description: |
|
||||
The UUID of the network.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
network_id_2:
|
||||
description: |
|
||||
The UUID of the attached network.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
networks:
|
||||
description: |
|
||||
A list of ``network`` objects.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
opt_name:
|
||||
description: |
|
||||
The extra DHCP option name.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
opt_name_1:
|
||||
description: |
|
||||
The extra DHCP option name.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
opt_value:
|
||||
description: |
|
||||
The extra DHCP option value.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
opt_value_1:
|
||||
description: |
|
||||
The extra DHCP option value.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: |
|
||||
A ``port`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
port_security_enabled:
|
||||
description: |
|
||||
The port security status. A valid value is
|
||||
enabled (``true``) or disabled (``false``).
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
port_security_enabled_1:
|
||||
description: |
|
||||
The port security status. The status is enabled
|
||||
(``true``) or disabled (``false``).
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
ports:
|
||||
description: |
|
||||
A list of ``port`` objects.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
router:external:
|
||||
description: |
|
||||
Indicates whether this network is externally
|
||||
accessible.
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
router:external_1:
|
||||
description: |
|
||||
Indicates whether this network is externally
|
||||
accessible.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
security_groups:
|
||||
description: |
|
||||
One or more security group UUIDs.
|
||||
in: body
|
||||
required: false
|
||||
type: array
|
||||
security_groups_1:
|
||||
description: |
|
||||
The UUIDs of any attached security groups.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
service_providers:
|
||||
description: |
|
||||
A list of ``service_provider`` objects.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
service_type:
|
||||
description: |
|
||||
The service type, which is ``CORE``, ``DUMMY``,
|
||||
``FIREWALL``, ``FLAVORS``, ``L3_ROUTER_NAT``, ``LOADBALANCER``,
|
||||
``LOADBALANCERV2``, ``METERING``, ``QOS``, or ``VPN``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
shared:
|
||||
description: |
|
||||
Admin-only. Indicates whether this network is
|
||||
shared across all tenants.
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
shared_1:
|
||||
description: |
|
||||
Indicates whether this network is shared across
|
||||
all tenants. By default, only administrative users can change this
|
||||
value.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
status:
|
||||
description: |
|
||||
The network status.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
status_1:
|
||||
description: |
|
||||
The port status. Value is ``ACTIVE`` or ``DOWN``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
subnet_id:
|
||||
description: |
|
||||
If you specify only a subnet UUID, OpenStack
|
||||
Networking allocates an available IP from that subnet to the port.
|
||||
If you specify both a subnet UUID and an IP address, OpenStack
|
||||
Networking tries to allocate the address to the port.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
subnet_id_1:
|
||||
description: |
|
||||
The UUID of the subnet to which the port is
|
||||
attached.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
subnets:
|
||||
description: |
|
||||
The associated subnets.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
tenant_id:
|
||||
description: |
|
||||
The UUID of the tenant who owns the network. Only
|
||||
administrative users can specify a tenant UUID other than their
|
||||
own. You cannot change this value through authorization policies.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
tenant_id_1:
|
||||
description: |
|
||||
The UUID of the tenant.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
tenant_id_2:
|
||||
description: |
|
||||
The UUID of the tenant who owns the network. Only
|
||||
administrative users can specify a tenant UUID other than their
|
||||
own.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
updated_at:
|
||||
description: |
|
||||
Time at which port has been updated.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
updated_at_1:
|
||||
description: |
|
||||
Time at which the network has been updated.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
@ -1,420 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=====
|
||||
Ports
|
||||
=====
|
||||
|
||||
Lists, shows details for, creates, updates, and deletes ports.
|
||||
|
||||
|
||||
Show port details
|
||||
=================
|
||||
|
||||
.. rest_method:: GET /v2.0/ports/{port_id}
|
||||
|
||||
Shows details for a port.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- port_id: port_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- status: status
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- ip_address: ip_address
|
||||
- extra_dhcp_opts: extra_dhcp_opts
|
||||
- opt_name: opt_name
|
||||
- updated_at: updated_at
|
||||
- id: id
|
||||
- port: port
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- port_security_enabled: port_security_enabled
|
||||
- fixed_ips: fixed_ips
|
||||
- created_at: created_at
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update port
|
||||
===========
|
||||
|
||||
.. rest_method:: PUT /v2.0/ports/{port_id}
|
||||
|
||||
Updates a port.
|
||||
|
||||
You can update information for a port, such as its symbolic name
|
||||
and associated IPs. When you update IPs for a port, any previously
|
||||
associated IPs are removed, returned to the respective subnet
|
||||
allocation pools, and replaced by the IPs in the request body.
|
||||
Therefore, this operation replaces the ``fixed_ip`` attribute when
|
||||
you specify it in the request body. If the updated IP addresses are
|
||||
not valid or are already in use, the operation fails and the
|
||||
existing IP addresses are not removed from the port.
|
||||
|
||||
When you update security groups for a port and the operation
|
||||
succeeds, any associated security groups are removed and replaced
|
||||
by the security groups in the request body. Therefore, this
|
||||
operation replaces the ``security_groups`` attribute when you
|
||||
specify it in the request body. If the security groups are not
|
||||
valid, the operation fails and the existing security groups are not
|
||||
removed from the port.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:404,403,401,400,409,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- fixed_ips: fixed_ips
|
||||
- opt_name: opt_name
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- ip_address: ip_address
|
||||
- port: port
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
- port_id: port_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- status: status
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- ip_address: ip_address
|
||||
- extra_dhcp_opts: extra_dhcp_opts
|
||||
- opt_name: opt_name
|
||||
- updated_at: updated_at
|
||||
- id: id
|
||||
- port: port
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- port_security_enabled: port_security_enabled
|
||||
- fixed_ips: fixed_ips
|
||||
- created_at: created_at
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-update-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Delete port
|
||||
===========
|
||||
|
||||
.. rest_method:: DELETE /v2.0/ports/{port_id}
|
||||
|
||||
Deletes a port.
|
||||
|
||||
Any IP addresses that are associated with the port are returned to
|
||||
the respective subnets allocation pools.
|
||||
|
||||
Error response codes:404,403,204,401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- port_id: port_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
List ports
|
||||
==========
|
||||
|
||||
.. rest_method:: GET /v2.0/ports
|
||||
|
||||
Lists ports to which the tenant has access.
|
||||
|
||||
Default policy settings return only those ports that are owned by
|
||||
the tenant who submits the request, unless the request is submitted
|
||||
by a user with administrative rights. Users can control which
|
||||
attributes are returned by using the fields query parameter. You
|
||||
can use query parameters to filter the response.For information,
|
||||
see `Filtering and Column Selection <https://wiki.openstack.org/wik
|
||||
i/Neutron/APIv2-specification#Filtering_and_Column_Selection>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:401,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- status: status
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- ip_address: ip_address
|
||||
- extra_dhcp_opts: extra_dhcp_opts
|
||||
- opt_name: opt_name
|
||||
- updated_at: updated_at
|
||||
- id: id
|
||||
- ports: ports
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- port_security_enabled: port_security_enabled
|
||||
- fixed_ips: fixed_ips
|
||||
- created_at: created_at
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/ports-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create port
|
||||
===========
|
||||
|
||||
.. rest_method:: POST /v2.0/ports
|
||||
|
||||
Creates a port on a network.
|
||||
|
||||
To define the network in which to create the port, specify the
|
||||
``network_id`` attribute in the request body.
|
||||
|
||||
Error response codes:201,404,403,401,400,503,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- fixed_ips: fixed_ips
|
||||
- opt_name: opt_name
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- ip_address: ip_address
|
||||
- port: port
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/port-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- status: status
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- ip_address: ip_address
|
||||
- extra_dhcp_opts: extra_dhcp_opts
|
||||
- opt_name: opt_name
|
||||
- updated_at: updated_at
|
||||
- id: id
|
||||
- port: port
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- port_security_enabled: port_security_enabled
|
||||
- fixed_ips: fixed_ips
|
||||
- created_at: created_at
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Bulk create ports
|
||||
=================
|
||||
|
||||
.. rest_method:: POST /v2.0/ports
|
||||
|
||||
Creates multiple ports in a single request. Specify a list of ports in the request body.
|
||||
|
||||
Guarantees the atomic completion of the bulk operation.
|
||||
|
||||
Error response codes:201,404,403,401,400,503,409,
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- fixed_ips: fixed_ips
|
||||
- opt_name: opt_name
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- ip_address: ip_address
|
||||
- ports: ports
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ../samples/ports/ports-bulk-create-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- opt_value: opt_value
|
||||
- status: status
|
||||
- name: name
|
||||
- allowed_address_pairs: allowed_address_pairs
|
||||
- admin_state_up: admin_state_up
|
||||
- network_id: network_id
|
||||
- ip_address: ip_address
|
||||
- extra_dhcp_opts: extra_dhcp_opts
|
||||
- opt_name: opt_name
|
||||
- updated_at: updated_at
|
||||
- id: id
|
||||
- ports: ports
|
||||
- subnet_id: subnet_id
|
||||
- device_owner: device_owner
|
||||
- tenant_id: tenant_id
|
||||
- mac_address: mac_address
|
||||
- port_security_enabled: port_security_enabled
|
||||
- fixed_ips: fixed_ips
|
||||
- created_at: created_at
|
||||
- security_groups: security_groups
|
||||
- device_id: device_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
{
|
||||
"extension": {
|
||||
"updated": "2013-02-03T10:00:00-00:00",
|
||||
"name": "agent",
|
||||
"links": [],
|
||||
"alias": "agent",
|
||||
"description": "The agent management extension."
|
||||
}
|
||||
}
|
||||
@ -1,123 +0,0 @@
|
||||
{
|
||||
"extensions": [
|
||||
{
|
||||
"updated": "2013-01-20T00:00:00-00:00",
|
||||
"name": "Neutron Service Type Management",
|
||||
"links": [],
|
||||
"alias": "service-type",
|
||||
"description": "API for retrieving service providers for Neutron advanced services"
|
||||
},
|
||||
{
|
||||
"updated": "2012-10-05T10:00:00-00:00",
|
||||
"name": "security-group",
|
||||
"links": [],
|
||||
"alias": "security-group",
|
||||
"description": "The security groups extension."
|
||||
},
|
||||
{
|
||||
"updated": "2013-02-07T10:00:00-00:00",
|
||||
"name": "L3 Agent Scheduler",
|
||||
"links": [],
|
||||
"alias": "l3_agent_scheduler",
|
||||
"description": "Schedule routers among l3 agents"
|
||||
},
|
||||
{
|
||||
"updated": "2013-02-07T10:00:00-00:00",
|
||||
"name": "Loadbalancer Agent Scheduler",
|
||||
"links": [],
|
||||
"alias": "lbaas_agent_scheduler",
|
||||
"description": "Schedule pools among lbaas agents"
|
||||
},
|
||||
{
|
||||
"updated": "2013-03-28T10:00:00-00:00",
|
||||
"name": "Neutron L3 Configurable external gateway mode",
|
||||
"links": [],
|
||||
"alias": "ext-gw-mode",
|
||||
"description": "Extension of the router abstraction for specifying whether SNAT should occur on the external gateway"
|
||||
},
|
||||
{
|
||||
"updated": "2014-02-03T10:00:00-00:00",
|
||||
"name": "Port Binding",
|
||||
"links": [],
|
||||
"alias": "binding",
|
||||
"description": "Expose port bindings of a virtual port to external application"
|
||||
},
|
||||
{
|
||||
"updated": "2012-09-07T10:00:00-00:00",
|
||||
"name": "Provider Network",
|
||||
"links": [],
|
||||
"alias": "provider",
|
||||
"description": "Expose mapping of virtual networks to physical networks"
|
||||
},
|
||||
{
|
||||
"updated": "2013-02-03T10:00:00-00:00",
|
||||
"name": "agent",
|
||||
"links": [],
|
||||
"alias": "agent",
|
||||
"description": "The agent management extension."
|
||||
},
|
||||
{
|
||||
"updated": "2012-07-29T10:00:00-00:00",
|
||||
"name": "Quota management support",
|
||||
"links": [],
|
||||
"alias": "quotas",
|
||||
"description": "Expose functions for quotas management per tenant"
|
||||
},
|
||||
{
|
||||
"updated": "2013-02-07T10:00:00-00:00",
|
||||
"name": "DHCP Agent Scheduler",
|
||||
"links": [],
|
||||
"alias": "dhcp_agent_scheduler",
|
||||
"description": "Schedule networks among dhcp agents"
|
||||
},
|
||||
{
|
||||
"updated": "2013-06-27T10:00:00-00:00",
|
||||
"name": "Multi Provider Network",
|
||||
"links": [],
|
||||
"alias": "multi-provider",
|
||||
"description": "Expose mapping of virtual networks to multiple physical networks"
|
||||
},
|
||||
{
|
||||
"updated": "2013-01-14T10:00:00-00:00",
|
||||
"name": "Neutron external network",
|
||||
"links": [],
|
||||
"alias": "external-net",
|
||||
"description": "Adds external network attribute to network resource."
|
||||
},
|
||||
{
|
||||
"updated": "2012-07-20T10:00:00-00:00",
|
||||
"name": "Neutron L3 Router",
|
||||
"links": [],
|
||||
"alias": "router",
|
||||
"description": "Router abstraction for basic L3 forwarding between L2 Neutron networks and access to external networks via a NAT gateway."
|
||||
},
|
||||
{
|
||||
"updated": "2013-07-23T10:00:00-00:00",
|
||||
"name": "Allowed Address Pairs",
|
||||
"links": [],
|
||||
"alias": "allowed-address-pairs",
|
||||
"description": "Provides allowed address pairs"
|
||||
},
|
||||
{
|
||||
"updated": "2013-03-17T12:00:00-00:00",
|
||||
"name": "Neutron Extra DHCP opts",
|
||||
"links": [],
|
||||
"alias": "extra_dhcp_opt",
|
||||
"description": "Extra options configuration for DHCP. For example PXE boot options to DHCP clients can be specified (e.g. tftp-server, server-ip-address, bootfile-name)"
|
||||
},
|
||||
{
|
||||
"updated": "2012-10-07T10:00:00-00:00",
|
||||
"name": "LoadBalancing service",
|
||||
"links": [],
|
||||
"alias": "lbaas",
|
||||
"description": "Extension for LoadBalancing service"
|
||||
},
|
||||
{
|
||||
"updated": "2013-02-01T10:00:00-00:00",
|
||||
"name": "Neutron Extra Route",
|
||||
"links": [],
|
||||
"alias": "extraroute",
|
||||
"description": "Extra routes configuration for L3 router"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,6 +0,0 @@
|
||||
{
|
||||
"firewall": {
|
||||
"admin_state_up": true,
|
||||
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c"
|
||||
}
|
||||
}
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"firewall": {
|
||||
"admin_state_up": true,
|
||||
"description": "",
|
||||
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
|
||||
"name": "",
|
||||
"status": "PENDING_CREATE",
|
||||
"router_ids": [
|
||||
"650bfd2f-7766-4a0d-839f-218f33e16998"
|
||||
],
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,15 +0,0 @@
|
||||
{
|
||||
"firewall_policies": [
|
||||
{
|
||||
"audited": false,
|
||||
"description": "",
|
||||
"firewall_rules": [
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
],
|
||||
"id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"name": "test-policy",
|
||||
"shared": false,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"firewall_policy": {
|
||||
"firewall_rules": [
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
],
|
||||
"name": "test-policy"
|
||||
}
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"firewall_policy": {
|
||||
"audited": false,
|
||||
"description": "",
|
||||
"firewall_rules": [
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
],
|
||||
"id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"name": "test-policy",
|
||||
"shared": false,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"firewall_rule_id": "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692",
|
||||
"insert_after": "a08ef905-0ff6-4784-8374-175fffe7dade",
|
||||
"insert_before": ""
|
||||
}
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"audited": false,
|
||||
"description": "",
|
||||
"firewall_list": [],
|
||||
"firewall_rules": [
|
||||
"a08ef905-0ff6-4784-8374-175fffe7dade",
|
||||
"7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692",
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
],
|
||||
"id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"name": "test-policy",
|
||||
"shared": false,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
@ -1,3 +0,0 @@
|
||||
{
|
||||
"firewall_rule_id": "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692"
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"audited": false,
|
||||
"description": "",
|
||||
"firewall_list": [],
|
||||
"firewall_rules": [
|
||||
"a08ef905-0ff6-4784-8374-175fffe7dade",
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
],
|
||||
"id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"name": "test-policy",
|
||||
"shared": false,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"firewall_policy": {
|
||||
"audited": false,
|
||||
"description": "",
|
||||
"firewall_rules": [
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
],
|
||||
"id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"name": "test-policy",
|
||||
"shared": false,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"firewall_policy": {
|
||||
"firewall_rules": [
|
||||
"a08ef905-0ff6-4784-8374-175fffe7dade",
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"firewall_policy": {
|
||||
"audited": false,
|
||||
"description": "",
|
||||
"firewall_rules": [
|
||||
"a08ef905-0ff6-4784-8374-175fffe7dade",
|
||||
"8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
|
||||
],
|
||||
"id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"name": "test-policy",
|
||||
"shared": false,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,9 +0,0 @@
|
||||
{
|
||||
"firewall_rule": {
|
||||
"action": "allow",
|
||||
"destination_port": "80",
|
||||
"enabled": true,
|
||||
"name": "ALLOW_HTTP",
|
||||
"protocol": "tcp"
|
||||
}
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
{
|
||||
"firewall_rule": {
|
||||
"action": "allow",
|
||||
"description": "",
|
||||
"destination_ip_address": null,
|
||||
"destination_port": "80",
|
||||
"enabled": true,
|
||||
"firewall_policy_id": null,
|
||||
"id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
|
||||
"ip_version": 4,
|
||||
"name": "ALLOW_HTTP",
|
||||
"position": null,
|
||||
"protocol": "tcp",
|
||||
"shared": false,
|
||||
"source_ip_address": null,
|
||||
"source_port": null,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
{
|
||||
"firewall_rule": {
|
||||
"action": "allow",
|
||||
"description": "",
|
||||
"destination_ip_address": null,
|
||||
"destination_port": "80",
|
||||
"enabled": true,
|
||||
"firewall_policy_id": null,
|
||||
"id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
|
||||
"ip_version": 4,
|
||||
"name": "ALLOW_HTTP",
|
||||
"position": null,
|
||||
"protocol": "tcp",
|
||||
"shared": false,
|
||||
"source_ip_address": null,
|
||||
"source_port": null,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"firewall_rule": {
|
||||
"shared": "true"
|
||||
}
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
{
|
||||
"firewall_rule": {
|
||||
"action": "allow",
|
||||
"description": "",
|
||||
"destination_ip_address": null,
|
||||
"destination_port": "80",
|
||||
"enabled": true,
|
||||
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
|
||||
"ip_version": 4,
|
||||
"name": "ALLOW_HTTP",
|
||||
"position": 1,
|
||||
"protocol": "tcp",
|
||||
"shared": true,
|
||||
"source_ip_address": null,
|
||||
"source_port": null,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
{
|
||||
"firewall_rules": [
|
||||
{
|
||||
"action": "allow",
|
||||
"description": "",
|
||||
"destination_ip_address": null,
|
||||
"destination_port": "80",
|
||||
"enabled": true,
|
||||
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
|
||||
"ip_version": 4,
|
||||
"name": "ALLOW_HTTP",
|
||||
"position": 1,
|
||||
"protocol": "tcp",
|
||||
"shared": false,
|
||||
"source_ip_address": null,
|
||||
"source_port": null,
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"firewall": {
|
||||
"admin_state_up": true,
|
||||
"description": "",
|
||||
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
|
||||
"name": "",
|
||||
"status": "ACTIVE",
|
||||
"router_ids": [
|
||||
"650bfd2f-7766-4a0d-839f-218f33e16998"
|
||||
],
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"firewall": {
|
||||
"admin_state_up": "false"
|
||||
}
|
||||
}
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"firewall": {
|
||||
"admin_state_up": false,
|
||||
"description": "",
|
||||
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
|
||||
"name": "",
|
||||
"status": "PENDING_UPDATE",
|
||||
"router_ids": [
|
||||
"650bfd2f-7766-4a0d-839f-218f33e16998"
|
||||
],
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
}
|
||||
@ -1,16 +0,0 @@
|
||||
{
|
||||
"firewalls": [
|
||||
{
|
||||
"admin_state_up": true,
|
||||
"description": "",
|
||||
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
|
||||
"id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
|
||||
"name": "",
|
||||
"status": "ACTIVE",
|
||||
"router_ids": [
|
||||
"650bfd2f-7766-4a0d-839f-218f33e16998"
|
||||
],
|
||||
"tenant_id": "45977fa2dbd7482098dd68d0d8970117"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"service_profile": {
|
||||
"id": "4e5b9191-ffbe-4f7a-b112-2db98232fd32"
|
||||
}
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"service_profile": {
|
||||
"id": "7fc0581b-4509-49e1-90eb-c953c877fa4c"
|
||||
}
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"flavor": {
|
||||
"service_type": "LOADBALANCERV2",
|
||||
"enabled": true,
|
||||
"name": "dummy",
|
||||
"description": "Dummy flavor"
|
||||
}
|
||||
}
|
||||
@ -1,10 +0,0 @@
|
||||
{
|
||||
"flavor": {
|
||||
"id": "7fc0581b-4509-49e1-90eb-c953c877fa4c",
|
||||
"name": "dummy",
|
||||
"service_type": "LOADBALANCERV2",
|
||||
"description": "Dummy flavor",
|
||||
"enabled": true,
|
||||
"service_profiles": []
|
||||
}
|
||||
}
|
||||
@ -1,10 +0,0 @@
|
||||
{
|
||||
"flavor": {
|
||||
"description": "",
|
||||
"enabled": true,
|
||||
"service_profiles": [],
|
||||
"service_type": "LOADBALANCERV2",
|
||||
"id": "f7b14d9a-b0dc-4fbe-bb14-a0f4970a69e0",
|
||||
"name": "dummy"
|
||||
}
|
||||
}
|
||||
@ -1,7 +0,0 @@
|
||||
{
|
||||
"flavor": {
|
||||
"enabled": false,
|
||||
"name": "newname",
|
||||
"description": "New description"
|
||||
}
|
||||
}
|
||||
@ -1,10 +0,0 @@
|
||||
{
|
||||
"flavor": {
|
||||
"description": "New description",
|
||||
"enabled": false,
|
||||
"service_profiles": [],
|
||||
"service_type": "LOADBALANCERV2",
|
||||
"id": "7fc0581b-4509-49e1-90eb-c953c877fa4c",
|
||||
"name": "newname"
|
||||
}
|
||||
}
|
||||
@ -1,12 +0,0 @@
|
||||
{
|
||||
"flavors": [
|
||||
{
|
||||
"description": "",
|
||||
"enabled": true,
|
||||
"service_profiles": [],
|
||||
"service_type": "LOADBALANCERV2",
|
||||
"id": "f7b14d9a-b0dc-4fbe-bb14-a0f4970a69e0",
|
||||
"name": "dummy"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"service_profile": {
|
||||
"enabled": "true",
|
||||
"driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
|
||||
"description": "Dummy profile",
|
||||
"metainfo": "{'foo': 'bar'}"
|
||||
}
|
||||
}
|
||||
@ -1,9 +0,0 @@
|
||||
{
|
||||
"service_profile": {
|
||||
"enabled": true,
|
||||
"metainfo": "{'foo': 'bar'}",
|
||||
"driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
|
||||
"id": "7c793e5f-9b64-44e0-8b1f-902e59c85a01",
|
||||
"description": "Dummy profile"
|
||||
}
|
||||
}
|
||||
@ -1,9 +0,0 @@
|
||||
{
|
||||
"service_profile": {
|
||||
"enabled": true,
|
||||
"metainfo": "{'foo': 'bar'}",
|
||||
"driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
|
||||
"id": "7c793e5f-9b64-44e0-8b1f-902e59c85a01",
|
||||
"description": "Dummy profile"
|
||||
}
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"service_profile": {
|
||||
"enabled": false,
|
||||
"driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
|
||||
"description": "New description",
|
||||
"metainfo": "{'new': 'info'}"
|
||||
}
|
||||
}
|
||||
@ -1,9 +0,0 @@
|
||||
{
|
||||
"service_profile": {
|
||||
"enabled": false,
|
||||
"metainfo": "{'new': 'info'}",
|
||||
"driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
|
||||
"id": "7c793e5f-9b64-44e0-8b1f-902e59c85a01",
|
||||
"description": "New description"
|
||||
}
|
||||
}
|
||||
@ -1,18 +0,0 @@
|
||||
{
|
||||
"service_profiles": [
|
||||
{
|
||||
"id": "4e5b9191-ffbe-4f7a-b112-2db98232fd32",
|
||||
"enabled": true,
|
||||
"driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
|
||||
"description": "",
|
||||
"metainfo": ""
|
||||
},
|
||||
{
|
||||
"id": "684322c5-703a-48a2-8138-34b99942a7ef",
|
||||
"enabled": true,
|
||||
"driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
|
||||
"description": "",
|
||||
"metainfo": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"id": "b624decf-d5d3-4c66-9a3d-f047e7786181"
|
||||
}
|
||||
}
|
||||
@ -1,3 +0,0 @@
|
||||
{
|
||||
"health_monitor": {}
|
||||
}
|
||||
@ -1,12 +0,0 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"admin_state_up": true,
|
||||
"delay": "1",
|
||||
"expected_codes": "200,201,202",
|
||||
"http_method": "GET",
|
||||
"max_retries": 5,
|
||||
"timeout": 1,
|
||||
"type": "HTTP",
|
||||
"url_path": "/index.html"
|
||||
}
|
||||
}
|
||||
@ -1,15 +0,0 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"delay": 1,
|
||||
"expected_codes": "200,201,202",
|
||||
"max_retries": 5,
|
||||
"http_method": "GET",
|
||||
"timeout": 1,
|
||||
"pools": [],
|
||||
"url_path": "/index.html",
|
||||
"type": "HTTP",
|
||||
"id": "b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
}
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"delay": 1,
|
||||
"expected_codes": "200,201,202",
|
||||
"max_retries": 5,
|
||||
"http_method": "GET",
|
||||
"timeout": 1,
|
||||
"pools": [
|
||||
{
|
||||
"status": "ACTIVE",
|
||||
"status_description": null,
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
|
||||
}
|
||||
],
|
||||
"url_path": "/index.html",
|
||||
"type": "HTTP",
|
||||
"id": "b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
}
|
||||
}
|
||||
@ -1,11 +0,0 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"admin_state_up": false,
|
||||
"delay": "2",
|
||||
"expected_codes": "200",
|
||||
"http_method": "POST",
|
||||
"max_retries": 2,
|
||||
"timeout": 2,
|
||||
"url_path": "/page.html"
|
||||
}
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
{
|
||||
"health_monitor": {
|
||||
"admin_state_up": false,
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"delay": 2,
|
||||
"expected_codes": "200",
|
||||
"max_retries": 2,
|
||||
"http_method": "POST",
|
||||
"timeout": 2,
|
||||
"pools": [
|
||||
{
|
||||
"status": "ACTIVE",
|
||||
"status_description": null,
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
|
||||
}
|
||||
],
|
||||
"url_path": "/page.html",
|
||||
"type": "HTTP",
|
||||
"id": "b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
}
|
||||
}
|
||||
@ -1,23 +0,0 @@
|
||||
{
|
||||
"health_monitors": [
|
||||
{
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"delay": 1,
|
||||
"expected_codes": "200,201,202",
|
||||
"max_retries": 5,
|
||||
"http_method": "GET",
|
||||
"timeout": 1,
|
||||
"pools": [
|
||||
{
|
||||
"status": "ACTIVE",
|
||||
"status_description": null,
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
|
||||
}
|
||||
],
|
||||
"url_path": "/index.html",
|
||||
"type": "HTTP",
|
||||
"id": "b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,16 +0,0 @@
|
||||
{
|
||||
"listener": {
|
||||
"admin_state_up": true,
|
||||
"connection_limit": 100,
|
||||
"description": "listener one",
|
||||
"loadbalancer_id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"name": "listener1",
|
||||
"protocol": "HTTP",
|
||||
"protocol_port": "80",
|
||||
"default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"sni_container_refs": [
|
||||
"https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
|
||||
"https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -1,23 +0,0 @@
|
||||
{
|
||||
"listener": {
|
||||
"admin_state_up": true,
|
||||
"connection_limit": 100,
|
||||
"default_pool_id": null,
|
||||
"description": "listener one",
|
||||
"id": "39de4d56-d663-46e5-85a1-5b9d5fa17829",
|
||||
"loadbalancers": [
|
||||
{
|
||||
"id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c"
|
||||
}
|
||||
],
|
||||
"name": "listener1",
|
||||
"protocol": "HTTP",
|
||||
"protocol_port": 80,
|
||||
"tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
|
||||
"default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"sni_container_refs": [
|
||||
"https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
|
||||
"https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -1,23 +0,0 @@
|
||||
{
|
||||
"listener": {
|
||||
"admin_state_up": true,
|
||||
"connection_limit": 100,
|
||||
"default_pool_id": null,
|
||||
"description": "",
|
||||
"id": "35cb8516-1173-4035-8dae-0dae3453f37f",
|
||||
"loadbalancers": [
|
||||
{
|
||||
"id": "a9729389-6147-41a3-ab22-a24aed8692b2"
|
||||
}
|
||||
],
|
||||
"name": "",
|
||||
"protocol": "HTTP",
|
||||
"protocol_port": 80,
|
||||
"tenant_id": "3e4d8bec50a845fcb09e03a4375c691d",
|
||||
"default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"sni_container_refs": [
|
||||
"https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
|
||||
"https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"listener": {
|
||||
"admin_state_up": false,
|
||||
"connection_limit": 200,
|
||||
"description": "listener two",
|
||||
"name": "listener2",
|
||||
"default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"sni_container_refs": [
|
||||
"https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
|
||||
"https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -1,23 +0,0 @@
|
||||
{
|
||||
"listener": {
|
||||
"admin_state_up": false,
|
||||
"connection_limit": 200,
|
||||
"default_pool_id": null,
|
||||
"description": "listener two",
|
||||
"id": "39de4d56-d663-46e5-85a1-5b9d5fa17829",
|
||||
"loadbalancers": [
|
||||
{
|
||||
"id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c"
|
||||
}
|
||||
],
|
||||
"name": "listener2",
|
||||
"protocol": "HTTP",
|
||||
"protocol_port": 80,
|
||||
"tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
|
||||
"default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"sni_container_refs": [
|
||||
"https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
|
||||
"https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -1,25 +0,0 @@
|
||||
{
|
||||
"listeners": [
|
||||
{
|
||||
"admin_state_up": true,
|
||||
"connection_limit": 100,
|
||||
"default_pool_id": null,
|
||||
"description": "",
|
||||
"id": "35cb8516-1173-4035-8dae-0dae3453f37f",
|
||||
"loadbalancers": [
|
||||
{
|
||||
"id": "a9729389-6147-41a3-ab22-a24aed8692b2"
|
||||
}
|
||||
],
|
||||
"name": "",
|
||||
"protocol": "HTTP",
|
||||
"protocol_port": 80,
|
||||
"tenant_id": "3e4d8bec50a845fcb09e03a4375c691d",
|
||||
"default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"sni_container_refs": [
|
||||
"https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
|
||||
"https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,11 +0,0 @@
|
||||
{
|
||||
"loadbalancer": {
|
||||
"name": "loadbalancer1",
|
||||
"description": "simple lb",
|
||||
"tenant_id": "b7c1a69e88bf4b21a8148f787aef2081",
|
||||
"vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
|
||||
"vip_address": "10.0.0.4",
|
||||
"admin_state_up": true,
|
||||
"flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04"
|
||||
}
|
||||
}
|
||||
@ -1,16 +0,0 @@
|
||||
{
|
||||
"loadbalancer": {
|
||||
"admin_state_up": true,
|
||||
"description": "simple lb",
|
||||
"id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"listeners": [],
|
||||
"name": "loadbalancer1",
|
||||
"operating_status": "ONLINE",
|
||||
"provisioning_status": "ACTIVE",
|
||||
"tenant_id": "b7c1a69e88bf4b21a8148f787aef2081",
|
||||
"vip_address": "10.0.0.4",
|
||||
"vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
|
||||
"flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04",
|
||||
"provider": "sample_provider"
|
||||
}
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"loadbalancer": {
|
||||
"active_connections": 0,
|
||||
"total_connections": 0,
|
||||
"bytes_in": 0,
|
||||
"bytes_out": 0
|
||||
}
|
||||
}
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"loadbalancer": {
|
||||
"description": "simple lb",
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
|
||||
"provisioning_status": "ACTIVE",
|
||||
"listeners": [],
|
||||
"vip_address": "10.0.0.2",
|
||||
"vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
|
||||
"id": "a9729389-6147-41a3-ab22-a24aed8692b2",
|
||||
"operating_status": "ONLINE",
|
||||
"name": "loadbalancer1"
|
||||
}
|
||||
}
|
||||
@ -1,47 +0,0 @@
|
||||
{
|
||||
"statuses": {
|
||||
"loadbalancer": {
|
||||
"name": "lb1",
|
||||
"listeners": [
|
||||
{
|
||||
"pools": [
|
||||
{
|
||||
"name": "pool1",
|
||||
"provisioning_status": "ACTIVE",
|
||||
"health_monitor": {
|
||||
"type": "HTTP",
|
||||
"id": "90f7c765-0bc9-47c4-8513-4cc0c264c8f8",
|
||||
"provisioning_status": "ACTIVE"
|
||||
},
|
||||
"members": [
|
||||
{
|
||||
"address": "10.0.0.4",
|
||||
"protocol_port": 80,
|
||||
"id": "32723bee-2484-4de3-b6fc-c0b98d35fc84",
|
||||
"operating_status": "ONLINE",
|
||||
"provisioning_status": "ACTIVE"
|
||||
},
|
||||
{
|
||||
"address": "10.0.0.3",
|
||||
"protocol_port": 80,
|
||||
"id": "173b8164-0c9a-43ec-ab33-4ae0e7a8f863",
|
||||
"operating_status": "ONLINE",
|
||||
"provisioning_status": "ACTIVE"
|
||||
}
|
||||
],
|
||||
"id": "ae6f93b8-a3f6-46cd-bb18-c2ab0308abf7",
|
||||
"operating_status": "ONLINE"
|
||||
}
|
||||
],
|
||||
"name": "listener1",
|
||||
"id": "c2a41fbe-b70a-4645-bb11-4d3c28f23a25",
|
||||
"operating_status": "ONLINE",
|
||||
"provisioning_status": "ACTIVE"
|
||||
}
|
||||
],
|
||||
"id": "a4c19566-6f81-4c96-ac11-33954a9825a2",
|
||||
"operating_status": "ONLINE",
|
||||
"provisioning_status": "ACTIVE"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,7 +0,0 @@
|
||||
{
|
||||
"loadbalancer": {
|
||||
"admin_state_up": false,
|
||||
"description": "simple lb2",
|
||||
"name": "loadbalancer2"
|
||||
}
|
||||
}
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"loadbalancer": {
|
||||
"admin_state_up": false,
|
||||
"description": "simple lb2",
|
||||
"id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
|
||||
"listeners": [],
|
||||
"name": "loadbalancer2",
|
||||
"operating_status": "ONLINE",
|
||||
"provisioning_status": "PENDING_UPDATE",
|
||||
"tenant_id": "b7c1a69e88bf4b21a8148f787aef2081",
|
||||
"vip_address": "10.0.0.4",
|
||||
"vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2"
|
||||
}
|
||||
}
|
||||
@ -1,4 +0,0 @@
|
||||
#!wiki caution
|
||||
Note
|
||||
|
||||
A Load Balancer that is does not have a provisioning_status of ACTIVE cannot be updated.
|
||||
@ -1,16 +0,0 @@
|
||||
{
|
||||
"loadbalancers": [
|
||||
{
|
||||
"description": "simple lb",
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
|
||||
"provisioning_status": "ACTIVE",
|
||||
"listeners": [],
|
||||
"vip_address": "10.0.0.2",
|
||||
"vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
|
||||
"id": "a9729389-6147-41a3-ab22-a24aed8692b2",
|
||||
"operating_status": "ONLINE",
|
||||
"name": "loadbalancer1"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,9 +0,0 @@
|
||||
{
|
||||
"member": {
|
||||
"address": "10.0.0.22",
|
||||
"admin_state_up": true,
|
||||
"protocol_port": "90",
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
|
||||
"weight": "1"
|
||||
}
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"member": {
|
||||
"admin_state_up": true,
|
||||
"status": "PENDING_CREATE",
|
||||
"status_description": null,
|
||||
"weight": 1,
|
||||
"address": "10.0.1.22",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"protocol_port": 90,
|
||||
"id": "cf024846-7516-4e3a-b0fb-6590322c836f",
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
|
||||
}
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"member": {
|
||||
"admin_state_up": true,
|
||||
"status": "ACTIVE",
|
||||
"status_description": null,
|
||||
"weight": 1,
|
||||
"address": "10.0.1.22",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"protocol_port": 90,
|
||||
"id": "cf024846-7516-4e3a-b0fb-6590322c836f",
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
|
||||
}
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"member": {
|
||||
"weight": 5
|
||||
}
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"member": {
|
||||
"admin_state_up": true,
|
||||
"status": "PENDING_UPDATE",
|
||||
"status_description": null,
|
||||
"weight": 5,
|
||||
"address": "10.0.1.22",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"protocol_port": 90,
|
||||
"id": "cf024846-7516-4e3a-b0fb-6590322c836f",
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
|
||||
}
|
||||
}
|
||||
@ -1,15 +0,0 @@
|
||||
{
|
||||
"members": [
|
||||
{
|
||||
"admin_state_up": true,
|
||||
"status": "ACTIVE",
|
||||
"status_description": null,
|
||||
"weight": 1,
|
||||
"address": "10.0.1.22",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"protocol_port": 90,
|
||||
"id": "cf024846-7516-4e3a-b0fb-6590322c836f",
|
||||
"pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,10 +0,0 @@
|
||||
{
|
||||
"pool": {
|
||||
"admin_state_up": true,
|
||||
"description": "simple pool",
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"name": "my-pool",
|
||||
"protocol": "HTTP",
|
||||
"subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d"
|
||||
}
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
{
|
||||
"pool": {
|
||||
"status": "PENDING_CREATE",
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"protocol": "HTTP",
|
||||
"description": "simple pool",
|
||||
"health_monitors": [],
|
||||
"members": [],
|
||||
"status_description": null,
|
||||
"id": "af95e0ce-8a26-4f29-9524-db41e7769c73",
|
||||
"vip_id": null,
|
||||
"name": "my-pool",
|
||||
"admin_state_up": true,
|
||||
"subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"health_monitors_status": [],
|
||||
"provider": "haproxy"
|
||||
}
|
||||
}
|
||||
@ -1,20 +0,0 @@
|
||||
{
|
||||
"pools": [
|
||||
{
|
||||
"admin_state_up": true,
|
||||
"description": "simple pool",
|
||||
"healthmonitor_id": null,
|
||||
"id": "4c0a0a5f-cf8f-44b7-b912-957daa8ce5e5",
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"listeners": [
|
||||
{
|
||||
"id": "35cb8516-1173-4035-8dae-0dae3453f37f"
|
||||
}
|
||||
],
|
||||
"members": [],
|
||||
"name": "pool1",
|
||||
"protocol": "HTTP",
|
||||
"tenant_id": "1a3e005cf9ce40308c900bcb08e5320c"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
{
|
||||
"members": [
|
||||
{
|
||||
"address": "10.0.0.8",
|
||||
"admin_state_up": true,
|
||||
"id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313",
|
||||
"protocol_port": 80,
|
||||
"subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
|
||||
"tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
|
||||
"weight": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,29 +0,0 @@
|
||||
{
|
||||
"pool": {
|
||||
"status": "ACTIVE",
|
||||
"lb_algorithm": "ROUND_ROBIN",
|
||||
"protocol": "HTTP",
|
||||
"description": "",
|
||||
"health_monitors": [
|
||||
"b7633ade-24dc-4d72-8475-06aa22be5412"
|
||||
],
|
||||
"members": [
|
||||
"cf024846-7516-4e3a-b0fb-6590322c836f"
|
||||
],
|
||||
"status_description": null,
|
||||
"id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
|
||||
"vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
|
||||
"name": "pool1",
|
||||
"admin_state_up": true,
|
||||
"subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
|
||||
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
||||
"health_monitors_status": [
|
||||
{
|
||||
"monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
|
||||
"status": "ACTIVE",
|
||||
"status_description": null
|
||||
}
|
||||
],
|
||||
"provider": "haproxy"
|
||||
}
|
||||
}
|
||||
@ -1,5 +0,0 @@
|
||||
{
|
||||
"pool": {
|
||||
"name": "SuperPool"
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user