openstack/tap-as-a-service
Code Issues Proposed changes

Docs: Point to apiref and remove old CLI examples

Browse Source 
Add link to networking api-ref and remove old
neutronclient CLI examples.

Change-Id: I622f24594a7584cbf5881a94665796d4c0c3be07
This commit is contained in:
elajkat 2023-10-25 11:33:12 +02:00
parent c9f147b56f
commit bf3bc1b400
1 changed files with 1 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

176
API_REFERENCE.rst
View File

@ -84,155 +84,7 @@ instance.
API REFERENCE
=============
Below is the list of REST APIs that can be used to interact with TaaS Neutron
extension
1. Create TapService
\
**POST /v2.0/taas/tap_services**
\
Json Request:
.. code-block:: python
{
"tap_service": {
"description": "Test_Tap",
"name": "Test",
"port_id": "c9beb5a1-21f5-4225-9eaf-02ddccdd50a9",
"tenant_id": "97e1586d580745d7b311406697aaf097"
}
}
\
Json Response:
.. code-block:: python
{
"tap_service": {
"description": "Test_Tap",
"id": "c352f537-ad49-48eb-ab05-1c6b8cb900ff",
"name": "Test",
"port_id": "c9beb5a1-21f5-4225-9eaf-02ddccdd50a9",
"tenant_id": "97e1586d580745d7b311406697aaf097"
}
}
2. List TapServices
\
**GET /v2.0/taas/tap_services/{tap_service_uuid}**
\
Json Response:
.. code-block:: python
{
"tap_services": [
{
"description": "Test_Tap",
"id": "c352f537-ad49-48eb-ab05-1c6b8cb900ff",
"name": "Test",
"port_id": "c9beb5a1-21f5-4225-9eaf-02ddccdd50a9",
"tenant_id": "97e1586d580745d7b311406697aaf097"
}
]
}
3. Delete TapService
\
**DELETE /v2.0/taas/tap_services/{tap_service_uuid}**
\
4. Create TapFlow
\
**POST /v2.0/taas/tap_flows**
\
Json Request:
.. code-block:: python
{
"tap_flow": {
"description": "Test_flow1",
"direction": "BOTH",
"name": "flow1",
"source_port": "775a58bb-e2c6-4529-a918-2f019169b5b1",
"tap_service_id": "69bd12b2-0e13-45ec-9045-b674fd9f0468",
"tenant_id": "97e1586d580745d7b311406697aaf097",
"vlan_filter": "9,18-27,36,45,54-63"
}
}
\
Json Response:
.. code-block:: python
{
"tap_flow": {
"description": "Test_flow1",
"direction": "BOTH",
"id": "cc47f881-345f-4e62-ad24-bea79eb28304",
"name": "flow1",
"source_port": "775a58bb-e2c6-4529-a918-2f019169b5b1",
"tap_service_id": "69bd12b2-0e13-45ec-9045-b674fd9f0468",
"tenant_id": "97e1586d580745d7b311406697aaf097",
"vlan_filter": "9,18-27,36,45,54-63"
}
}
5. List TapFlows
\
**GET /v2.0/taas/tap_flows/{tap_flow_uuid}**
\
Json Response:
.. code-block:: python
{
"tap_flows": [
{
"description": "Test_flow1",
"direction": "BOTH",
"id": "cc47f881-345f-4e62-ad24-bea79eb28304",
"name": "flow1",
"source_port": "775a58bb-e2c6-4529-a918-2f019169b5b1",
"tap_service_id": "c352f537-ad49-48eb-ab05-1c6b8cb900ff",
"tenant_id": "97e1586d580745d7b311406697aaf097",
"vlan_filter": "9,18-27,36,45,54-63"
}
]
}
6. Delete TapFlow
\
**DELETE /v2.0/taas/tap_flows/{tap_flow_uuid}**
\
https://docs.openstack.org/api-ref/network/v2/index.html#tap-as-a-service
TaaS CLI Reference
==================
@ -264,32 +116,6 @@ and tap-as-a-service has an extension for taas related commands.
* Update tap flow **openstack tap flow update** <tap flow id/tap flow name> --name <new name of the tap flow> --description <new description of the tap flow>
Neutron CLI
-----------
.. warning::
neutron CLI is now deprecated, and will be removed in the future.
Use openstack CLI instead.
The TaaS commands can be executed using TaaS CLI, which is integrated with neutron.
It can be used to send REST request and interact with the TaaS
extension. Given below are the detail of the CLIs:
- **neutron tap-service-create**: Creates a Tap service.
- **neutron tap-service-list**: Lists all the Tap services.
- **neutron tap-service-show**: Show the details for a Tap service.
- **neutron tap-service-update**: Update the information for a Tap service.
- **neutron tap-service-delete**: Delete an existing Tap service.
- **neutron tap-flow-create**: Creates a Tap flow.
- **neutron tap-flow-list**: Lists all the Tap flows.
- **neutron tap-flow-show**: Show the details for a Tap flow.
- **neutron tap-flow-update**: Update the information for a Tap flow.
- **neutron tap-flow-delete**: Delete an existing Tap flow.
For usage type **--help** after any of the above commands
in the terminal after TaaS has been installed.
Workflow
=========