1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-29 10:18:10 +00:00
gns3-server/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst

77 lines
2.6 KiB
ReStructuredText
Raw Normal View History

2016-08-25 12:43:19 +00:00
/v2/compute/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a NIO to a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
2018-01-08 08:26:44 +00:00
- **port_number**: Port on the nat
2016-08-25 12:43:19 +00:00
Response status codes
**********************
- **201**: NIO created
- **400**: Invalid request
2016-08-25 12:43:19 +00:00
- **404**: Instance doesn't exist
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
2017-03-21 12:32:04 +00:00
2018-01-08 04:57:07 +00:00
PUT /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO on a NAT instance
2017-03-21 12:32:04 +00:00
2018-01-08 04:57:07 +00:00
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
2018-01-08 08:26:44 +00:00
- **port_number**: Port from where the nio should be updated
2018-01-08 04:57:07 +00:00
Response status codes
**********************
- **201**: NIO updated
- **400**: Invalid request
2018-01-08 04:57:07 +00:00
- **404**: Instance doesn't exist
2017-03-21 12:32:04 +00:00
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
2016-08-25 12:43:19 +00:00
DELETE /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove a NIO from a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
2018-01-08 08:26:44 +00:00
- **port_number**: Port on the nat
2016-08-25 12:43:19 +00:00
Response status codes
**********************
- **204**: NIO deleted
2016-08-25 12:43:19 +00:00
- **400**: Invalid request
- **404**: Instance doesn't exist
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
2017-03-21 12:32:04 +00:00