gns3-server/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst

/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
------------------------------------------------------------------------------------------------------------------------------------------

.. contents::

POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a NIO to a VirtualBox VM instance

Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **vm_id**: UUID for the instance

Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **404**: Instance doesn't exist

Sample session
***************


.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt


DELETE /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove a NIO from a VirtualBox VM instance

Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter from where the nio should be removed
- **vm_id**: UUID for the instance

Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted

Sample session
***************


.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt
API V2 2016-03-07 16:57:12 +00:00			`/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio`
Create /hypervisor and /controller namespace 2016-03-07 14:01:35 +00:00			`------------------------------------------------------------------------------------------------------------------------------------------`
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00
			`.. contents::`

API V2 2016-03-07 16:57:12 +00:00			`POST /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio`
Create /hypervisor and /controller namespace 2016-03-07 14:01:35 +00:00			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
Better organisation of the API documentation 2015-02-17 09:37:09 +00:00			`Add a NIO to a VirtualBox VM instance`
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00
			`Parameters`
			`**********`
Remove /controller from the api endpoint 2016-03-11 16:16:09 +00:00			`- port_number: Port on the adapter (always 0)`
Dummy link api documentation 2016-03-11 16:02:50 +00:00			`- project_id: UUID for the project`
Fix doc generation 2016-03-11 14:28:45 +00:00			`- adapter_number: Adapter where the nio should be added`
Update documentation 2015-07-09 14:16:43 +00:00			`- vm_id: UUID for the instance`
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00
			`Response status codes`
			`**********************`
			`- 400: Invalid request`
			`- 201: NIO created`
			`- 404: Instance doesn't exist`

Fix doc generation 2015-02-24 10:38:57 +00:00			`Sample session`
			`***************`


Create /hypervisor and /controller namespace 2016-03-07 14:01:35 +00:00			`.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt`
Fix doc generation 2015-02-24 10:38:57 +00:00
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00
API V2 2016-03-07 16:57:12 +00:00			`DELETE /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio`
Create /hypervisor and /controller namespace 2016-03-07 14:01:35 +00:00			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
Better organisation of the API documentation 2015-02-17 09:37:09 +00:00			`Remove a NIO from a VirtualBox VM instance`
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00
			`Parameters`
			`**********`
Remove /controller from the api endpoint 2016-03-11 16:16:09 +00:00			`- port_number: Port on the adapter (always 0)`
Dummy link api documentation 2016-03-11 16:02:50 +00:00			`- project_id: UUID for the project`
Fix doc generation 2016-03-11 14:28:45 +00:00			`- adapter_number: Adapter from where the nio should be removed`
Update documentation 2015-07-09 14:16:43 +00:00			`- vm_id: UUID for the instance`
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00
			`Response status codes`
			`**********************`
			`- 400: Invalid request`
			`- 404: Instance doesn't exist`
			`- 204: NIO deleted`

Fix doc generation 2015-02-24 10:38:57 +00:00			`Sample session`
			`***************`


Create /hypervisor and /controller namespace 2016-03-07 14:01:35 +00:00			`.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt`
Fix doc generation 2015-02-24 10:38:57 +00:00