neutron-lib/api-ref/source/v2/subnetpool_prefix_ops.inc
Ryan Tidwell a6438f4279 Introduce subnet pool prefix operations extension
This introduces a new extension that provides API's that enable
operations against the prefix list of a subnet pool to be more
explicit. In its current form, the subnetpool extension does not
clearly define how operations on the prefix list of a subnet pool
are to be performed and leaves unnecessary ambiguity to be handled
by implementers of the extension. This extension makes prefix
management for subnet pools explicit operations, while making support
for this discoverable for clients.

Change-Id: Ia84d767f582f28a2fc77799a58f6729a7fd42f34
Related-Bug: #1792901
2019-02-27 17:53:51 +00:00

84 lines
1.6 KiB
ReStructuredText

.. -*- rst -*-
=====================================================
Subnet pool prefix operations (subnetpool-prefix-ops)
=====================================================
Add and remove prefixes from a subnet pool prefix list.
Add prefixes
============
.. rest_method:: PUT /v2.0/subnetpools/{subnetpool_id}/add_prefixes
Adds prefixes to a subnet pool.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 409, 412
Request
-------
.. rest_parameters:: parameters.yaml
- subnetpool_id: subnetpool_id
- prefixes: prefixes
Request Example
---------------
.. literalinclude:: samples/subnets/subnetpool-add-prefixes-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- prefixes: prefixes-response
Response Example
----------------
.. literalinclude:: samples/subnets/subnetpool-add-prefixes-response.json
:language: javascript
Remove prefixes
===============
.. rest_method:: PUT /v2.0/subnetpools/{subnetpool_id}/remove_prefixes
Remove prefixes from a subnet pool.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 409, 412
Request
-------
.. rest_parameters:: parameters.yaml
- subnetpool_id: subnetpool_id
- prefixes: prefixes_remove
Request Example
---------------
.. literalinclude:: samples/subnets/subnetpool-remove-prefixes-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- prefixes: prefixes-response
Response Example
----------------
.. literalinclude:: samples/subnets/subnetpool-remove-prefixes-response.json
:language: javascript