0ac922ece1
This patch brings the Networking API Reference to a repository under the neutron stadium. It is a part of the effort described here [1]: As we discussed in the stadium evolution [2], we plan to have the API stuff in neutron-lib, so the API reference is hosted on neutron-lib as well. The goal of this patch is to import converted RST API references. Cleanup is planned once this patch is merged. [1] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan [2] https://review.openstack.org/312199 Change-Id: I6f2c4d476c31b252bfb181138505673f397639fc
182 lines
4.1 KiB
ReStructuredText
182 lines
4.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=======
|
|
Subnets
|
|
=======
|
|
|
|
Lists, shows details for, creates, updates, and deletes subnet
|
|
resources.
|
|
|
|
List subnets
|
|
============
|
|
|
|
.. rest_method:: GET /v2.0/subnets
|
|
|
|
Lists subnets to which the tenant has access.
|
|
|
|
Default policy settings returns exclusively subnets owned by the
|
|
tenant submitting the request, unless the request is submitted by a
|
|
user with administrative rights. You can control which attributes
|
|
are returned by using the fields query parameter. You can filter
|
|
results by using query string parameters.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:401,
|
|
|
|
Request
|
|
-------
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/subnets/subnets-list-response.json
|
|
:language: javascript
|
|
|
|
Create subnet
|
|
=============
|
|
|
|
.. rest_method:: POST /v2.0/subnets
|
|
|
|
Creates a subnet on a network.
|
|
|
|
OpenStack Networking does not try to derive the correct IP version
|
|
from the CIDR. If you do not specify the ``gateway_ip`` attribute,
|
|
OpenStack Networking allocates an address from the CIDR for the
|
|
gateway for the subnet.
|
|
|
|
To specify a subnet without a gateway, set the ``gateway_ip``
|
|
attribute to ``null`` in the request body. If you do not specify
|
|
the ``allocation_pools`` attribute, OpenStack Networking
|
|
automatically allocates pools for covering all IP addresses in the
|
|
CIDR, excluding the address reserved for the subnet gateway.
|
|
Otherwise, you can explicitly specify allocation pools as shown in
|
|
the following example.
|
|
|
|
When you specify both the ``allocation_pools`` and ``gateway_ip``
|
|
attributes, you must ensure that the gateway IP does not overlap
|
|
with the allocation pools; otherwise, the call returns the
|
|
``Conflict (409)`` response code.
|
|
|
|
A subnet can have one or more name servers and host routes. Hosts
|
|
in this subnet use the name servers. Devices with IP addresses from
|
|
this subnet, not including the local subnet route, use the host
|
|
routes.
|
|
|
|
Specify the ``ipv6_ra_mode`` and ``ipv6_address_mode`` attributes
|
|
to create subnets that support IPv6 configurations, such as
|
|
stateless address autoconfiguration (SLAAC), DHCPv6 stateful, and
|
|
DHCPv6 stateless configurations.
|
|
|
|
Error response codes:201,404,403,401,400,409,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. .. rest_parameters:: parameters.yaml
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/subnets/subnet-create-request.json
|
|
:language: javascript
|
|
|
|
Bulk create subnet
|
|
==================
|
|
|
|
.. rest_method:: POST /v2.0/subnets
|
|
|
|
Creates multiple subnets in a single request. Specify a list of subnets in the request body.
|
|
|
|
The bulk create operation is always atomic. Either all or no
|
|
subnets in the request body are created.
|
|
|
|
Error response codes:201,404,403,401,400,409,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. .. rest_parameters:: parameters.yaml
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/subnets/subnets-create-bulk-request.json
|
|
:language: javascript
|
|
|
|
Show subnet details
|
|
===================
|
|
|
|
.. rest_method:: GET /v2.0/subnets/{subnet_id}
|
|
|
|
Shows details for a subnet.
|
|
|
|
Use the fields query parameter to filter the results.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:404,401,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnet_id: subnet_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/subnets/subnet-show-response.json
|
|
:language: javascript
|
|
|
|
Update subnet
|
|
=============
|
|
|
|
.. rest_method:: PUT /v2.0/subnets/{subnet_id}
|
|
|
|
Updates a subnet.
|
|
|
|
Some attributes, such as IP version (ip_version), and CIDR (cidr)
|
|
cannot be updated. Attempting to update these attributes results in
|
|
a ``400 Bad Request`` error.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:404,403,401,400,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnet_id: subnet_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/subnets/subnet-update-request.json
|
|
:language: javascript
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/subnets/subnet-update-response.json
|
|
:language: javascript
|
|
|
|
Delete subnet
|
|
=============
|
|
|
|
.. rest_method:: DELETE /v2.0/subnets/{subnet_id}
|
|
|
|
Deletes a subnet.
|
|
|
|
The operation fails if subnet IP addresses are still allocated.
|
|
|
|
Error response codes:409,404,204,401,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnet_id: subnet_id
|
|
|