c28b3ab8fe
The spec networking_general_api_information.html was moved to api-ref in [0] but some of the links pointing to it were not updated. This change makes all the refs consistent and adds links where missing. Also moved sync/async and bulk create sections lower to group all the filtering, pagination and sorting sections together since they are inter-related. [0] https://review.opendev.org/c/openstack/neutron-lib/+/362877 Change-Id: I895cc9aaee2546b95e93150c134f350a50346447
156 lines
3.6 KiB
PHP
156 lines
3.6 KiB
PHP
====================
|
|
Network Associations
|
|
====================
|
|
|
|
Associating a BGPVPN to a Network can be done for both BGPVPN of type L2 and of
|
|
type L3. For type L3, the semantic is that all Subnets bound to the Network
|
|
will be interconnected with the BGP VPN (and thus between themselves).
|
|
|
|
A given Network can be associated with multiple BGPVPNs.
|
|
|
|
Associating or disassociating a BGPVPN to a Network is done by manipulating a
|
|
Network association API resource as a sub-resource of the BGPVPN resource:
|
|
|
|
List Network Associations
|
|
=========================
|
|
|
|
.. rest_method:: GET /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations
|
|
|
|
Lists network associations for a given BGP VPN.
|
|
|
|
.. include:: filtering-list.inc
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bgpvpn_id: bgpvpn-id-path
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- network_associations: bgpvpn-network_associations
|
|
- id: bgpvpn-network_association_id
|
|
- network_id: bgpvpn-network_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-list-response.json
|
|
:language: javascript
|
|
|
|
Create Network Association
|
|
==========================
|
|
|
|
.. rest_method:: POST /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations
|
|
|
|
Creates a network association for a given BGP VPN
|
|
|
|
Normal response codes: 201
|
|
|
|
Error response codes: 400, 401, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bgpvpn_id: bgpvpn-id-path
|
|
- network_association: bgpvpn-network_association
|
|
- network_id: bgpvpn-network_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- network_association: bgpvpn-network_association
|
|
- id: bgpvpn-network_association_id
|
|
- network_id: bgpvpn-network_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-create-response.json
|
|
:language: javascript
|
|
|
|
Show Network Association details
|
|
================================
|
|
|
|
.. rest_method:: GET /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations/{network_association_id}
|
|
|
|
Shows details for a network association.
|
|
|
|
.. include:: filtering-show.inc
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bgpvpn_id: bgpvpn-id-path
|
|
- network_association_id: bgpvpn-network_association_id-path
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- network_association: bgpvpn-network_association
|
|
- id: bgpvpn-network_association_id
|
|
- network_id: bgpvpn-network_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-show-response.json
|
|
:language: javascript
|
|
|
|
Delete Network Association
|
|
==========================
|
|
|
|
.. rest_method:: DELETE /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations/{network_association_id}
|
|
|
|
Deletes a network association.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bgpvpn_id: bgpvpn-id-path
|
|
- network_association_id: bgpvpn-network_association_id-path
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content for the response of a successful DELETE request.
|