From 70ad9fff2630fa38b5c7b7b03ba590a5a95ed750 Mon Sep 17 00:00:00 2001 From: Julien Duponchelle Date: Tue, 17 Feb 2015 09:46:18 +0100 Subject: [PATCH] Documentation update --- ...svmidadaptersadapteriddportsportiddnio.txt | 13 ------ docs/api/examples/get_projectsprojectid.txt | 4 +- .../get_projectsprojectidiouvmsvmid.txt | 4 +- ...get_projectsprojectidvirtualboxvmsvmid.txt | 2 +- .../get_projectsprojectidvpcsvmsvmid.txt | 2 +- .../examples/post_projectsprojectidiouvms.txt | 11 ++--- .../post_projectsprojectidvirtualboxvms.txt | 2 +- ...svmidadaptersadapteriddportsportiddnio.txt | 25 ------------ .../post_projectsprojectidvpcsvms.txt | 2 +- docs/api/examples/put_projectsprojectid.txt | 4 +- docs/api/v1projectsprojectiddynamipsvms.rst | 4 ++ .../v1projectsprojectiddynamipsvmsvmid.rst | 3 ++ docs/api/v1projectsprojectidiouvms.rst | 1 + docs/api/v1projectsprojectidiouvmsvmid.rst | 2 +- ...ptersadapternumberdportsportnumberdnio.rst | 4 +- ...svmidadaptersadapteriddportsportiddnio.rst | 40 ------------------- ...xvmsvmidadaptersadapteriddstartcapture.rst | 30 -------------- ...oxvmsvmidadaptersadapteriddstopcapture.rst | 21 ---------- ...ptersadapternumberdportsportnumberdnio.rst | 4 +- 19 files changed, 29 insertions(+), 149 deletions(-) delete mode 100644 docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt delete mode 100644 docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt delete mode 100644 docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.rst delete mode 100644 docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstartcapture.rst delete mode 100644 docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstopcapture.rst diff --git a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt b/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt deleted file mode 100644 index 0c732706..00000000 --- a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt +++ /dev/null @@ -1,13 +0,0 @@ -curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/ports/{port_id:\d+}/nio' - -DELETE /projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/ports/{port_id:\d+}/nio HTTP/1.1 - - - -HTTP/1.1 204 -CONNECTION: keep-alive -CONTENT-LENGTH: 0 -DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 -X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/ports/{port_id:\d+}/nio - diff --git a/docs/api/examples/get_projectsprojectid.txt b/docs/api/examples/get_projectsprojectid.txt index 2cfcf9d8..0823bf08 100644 --- a/docs/api/examples/get_projectsprojectid.txt +++ b/docs/api/examples/get_projectsprojectid.txt @@ -13,8 +13,8 @@ SERVER: Python/3.4 GNS3/1.3.dev1 X-ROUTE: /v1/projects/{project_id} { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp5cndh7nh", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp5cndh7nh/00010203-0405-0607-0809-0a0b0c0d0e0f", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpd4_jlup7", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpd4_jlup7/00010203-0405-0607-0809-0a0b0c0d0e0f", "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f", "temporary": false } diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt index 3cd4491d..e702d104 100644 --- a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt @@ -18,9 +18,9 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} "l1_keepalives": false, "name": "PC TEST 1", "nvram": 128, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_iou_get0/iou.bin", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_iou_get0/iou.bin", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 256, "serial_adapters": 2, - "vm_id": "548ed6e5-2ab6-421d-8f85-9dee638617fb" + "vm_id": "8d4ce7ee-9c5e-4ac0-9106-f8cf28a12b5d" } diff --git a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt index fc9f1ff6..d87a9f2a 100644 --- a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt @@ -21,6 +21,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} "name": "VMTEST", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "use_any_adapter": false, - "vm_id": "f70dc1dd-563e-46cc-9cf7-bb169730b8e2", + "vm_id": "591dcdfc-f25f-4a87-bd06-6091551c6f8e", "vmname": "VMTEST" } diff --git a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt index cde6eea4..83c6f71d 100644 --- a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt @@ -17,5 +17,5 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} "name": "PC TEST 1", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, - "vm_id": "ed3e4572-df65-4581-9332-324e749d480a" + "vm_id": "37726103-1521-42c3-8925-fd4fabea9caf" } diff --git a/docs/api/examples/post_projectsprojectidiouvms.txt b/docs/api/examples/post_projectsprojectidiouvms.txt index 0e129869..9f9a6d91 100644 --- a/docs/api/examples/post_projectsprojectidiouvms.txt +++ b/docs/api/examples/post_projectsprojectidiouvms.txt @@ -1,13 +1,14 @@ -curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms' -d '{"ethernet_adapters": 0, "iourc_path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_iou_create_with_params0/iourc", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_iou_create_with_params0/iou.bin", "ram": 1024, "serial_adapters": 4}' +curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms' -d '{"ethernet_adapters": 0, "initial_config": "hostname test", "iourc_path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_iou_create_with_params0/iourc", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_iou_create_with_params0/iou.bin", "ram": 1024, "serial_adapters": 4}' POST /projects/{project_id}/iou/vms HTTP/1.1 { "ethernet_adapters": 0, - "iourc_path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_iou_create_with_params0/iourc", + "initial_config": "hostname test", + "iourc_path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_iou_create_with_params0/iourc", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_iou_create_with_params0/iou.bin", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_iou_create_with_params0/iou.bin", "ram": 1024, "serial_adapters": 4 } @@ -27,9 +28,9 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_iou_create_with_params0/iou.bin", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_iou_create_with_params0/iou.bin", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 1024, "serial_adapters": 4, - "vm_id": "12acb1c1-304e-4c3e-81c4-23c52e6c01ba" + "vm_id": "f1bafbbe-96ba-4088-83e2-391cf9477e89" } diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt index 2b3c4fb3..751f5867 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt @@ -25,6 +25,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms "name": "VM1", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "use_any_adapter": false, - "vm_id": "ad5dba5d-0219-41a0-9bd3-eaca69649f6c", + "vm_id": "be653307-d7d6-4884-932f-0d87c7e2c06b", "vmname": "VM1" } diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt deleted file mode 100644 index a2be8b22..00000000 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.txt +++ /dev/null @@ -1,25 +0,0 @@ -curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/ports/{port_id:\d+}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' - -POST /projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/ports/{port_id:\d+}/nio HTTP/1.1 -{ - "lport": 4242, - "rhost": "127.0.0.1", - "rport": 4343, - "type": "nio_udp" -} - - -HTTP/1.1 201 -CONNECTION: keep-alive -CONTENT-LENGTH: 89 -CONTENT-TYPE: application/json -DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 -X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/ports/{port_id:\d+}/nio - -{ - "lport": 4242, - "rhost": "127.0.0.1", - "rport": 4343, - "type": "nio_udp" -} diff --git a/docs/api/examples/post_projectsprojectidvpcsvms.txt b/docs/api/examples/post_projectsprojectidvpcsvms.txt index 60df8000..9ed92782 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvms.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvms.txt @@ -19,5 +19,5 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms "name": "PC TEST 1", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, - "vm_id": "6c343265-dc55-4bfe-8d4e-f3f21eeeca8d" + "vm_id": "154fff9a-bd47-4740-8a00-847ec30dd6e0" } diff --git a/docs/api/examples/put_projectsprojectid.txt b/docs/api/examples/put_projectsprojectid.txt index 878274d0..ebab8846 100644 --- a/docs/api/examples/put_projectsprojectid.txt +++ b/docs/api/examples/put_projectsprojectid.txt @@ -1,8 +1,8 @@ -curl -i -X PUT 'http://localhost:8000/projects/{project_id}' -d '{"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_update_path_project_non_l0"}' +curl -i -X PUT 'http://localhost:8000/projects/{project_id}' -d '{"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_update_path_project_non_l0"}' PUT /projects/{project_id} HTTP/1.1 { - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2262/test_update_path_project_non_l0" + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2628/test_update_path_project_non_l0" } diff --git a/docs/api/v1projectsprojectiddynamipsvms.rst b/docs/api/v1projectsprojectiddynamipsvms.rst index 0479e826..410f5f87 100644 --- a/docs/api/v1projectsprojectiddynamipsvms.rst +++ b/docs/api/v1projectsprojectiddynamipsvms.rst @@ -24,6 +24,7 @@ Input + @@ -46,6 +47,7 @@ Input + @@ -58,6 +60,7 @@ Input + @@ -72,6 +75,7 @@ Output
Name Mandatory Type Description
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
private_config_content string Content of IOS private configuration file
ram ✔ integer amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
startup_config_content string Content of IOS startup configuration file
system_id string system ID
vm_id Dynamips VM instance identifier
wic0 Network module WIC slot 0
+ diff --git a/docs/api/v1projectsprojectiddynamipsvmsvmid.rst b/docs/api/v1projectsprojectiddynamipsvmsvmid.rst index 07b207ac..bce8b927 100644 --- a/docs/api/v1projectsprojectiddynamipsvmsvmid.rst +++ b/docs/api/v1projectsprojectiddynamipsvmsvmid.rst @@ -25,6 +25,7 @@ Output
Name Mandatory Type Description
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
+ @@ -91,6 +92,7 @@ Input
Name Mandatory Type Description
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
+ @@ -137,6 +139,7 @@ Output
Name Mandatory Type Description
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
+ diff --git a/docs/api/v1projectsprojectidiouvms.rst b/docs/api/v1projectsprojectidiouvms.rst index a462804a..978cf3ff 100644 --- a/docs/api/v1projectsprojectidiouvms.rst +++ b/docs/api/v1projectsprojectidiouvms.rst @@ -25,6 +25,7 @@ Input + diff --git a/docs/api/v1projectsprojectidiouvmsvmid.rst b/docs/api/v1projectsprojectidiouvmsvmid.rst index 30935bbd..e3dd7611 100644 --- a/docs/api/v1projectsprojectidiouvmsvmid.rst +++ b/docs/api/v1projectsprojectidiouvmsvmid.rst @@ -61,7 +61,7 @@ Input - + diff --git a/docs/api/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst index cd0e5f27..56437eec 100644 --- a/docs/api/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a IOU instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port where the nio should be added - **vm_id**: UUID for the instance - **project_id**: UUID for the project +- **port_number**: Port where the nio should be added Response status codes ********************** @@ -28,9 +28,9 @@ Remove a NIO from a IOU instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port from where the nio should be removed - **vm_id**: UUID for the instance - **project_id**: UUID for the project +- **port_number**: Port from where the nio should be removed Response status codes ********************** diff --git a/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.rst b/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.rst deleted file mode 100644 index 7a9228c5..00000000 --- a/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddportsportiddnio.rst +++ /dev/null @@ -1,40 +0,0 @@ -/v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/ports/{port_id:\d+}/nio ------------------------------------------------------------------------------------------------------------------ - -.. contents:: - -POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_id:\d+}**/ports/**{port_id:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a VirtualBox VM instance - -Parameters -********** -- **port_id**: Port in the adapter (always 0 for virtualbox) -- **vm_id**: UUID for the instance -- **project_id**: UUID for the project -- **adapter_id**: Adapter where the nio should be added - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - - -DELETE /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_id:\d+}**/ports/**{port_id:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a VirtualBox VM instance - -Parameters -********** -- **port_id**: Port in the adapter (always 0 for virtualbox) -- **vm_id**: UUID for the instance -- **project_id**: UUID for the project -- **adapter_id**: Adapter from where the nio should be removed - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - diff --git a/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstartcapture.rst b/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstartcapture.rst deleted file mode 100644 index 6a3320de..00000000 --- a/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstartcapture.rst +++ /dev/null @@ -1,30 +0,0 @@ -/v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/start_capture ------------------------------------------------------------------------------------------------------------------ - -.. contents:: - -POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_id:\d+}**/start_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a packet capture on a VirtualBox VM instance - -Parameters -********** -- **vm_id**: UUID for the instance -- **project_id**: UUID for the project -- **adapter_id**: Adapter to start a packet capture - -Response status codes -********************** -- **200**: Capture started -- **400**: Invalid request -- **404**: Instance doesn't exist - -Input -******* -.. raw:: html - -
Name Mandatory Type Description
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
ethernet_adapters integer How many ethernet adapters are connected to the IOU
initial_config ['string', 'null'] Initial configuration of the IOU
iourc_path string Path of iourc
l1_keepalives ['boolean', 'null'] Always up ethernet interface
name ✔ string IOU VM name
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
ethernet_adapters ['integer', 'null'] How many ethernet adapters are connected to the IOU
initial_config ['string', 'null'] Initial configuration path
initial_config ['string', 'null'] Initial configuration of the IOU
iourc_path ['string', 'null'] Path of iourc
l1_keepalives ['boolean', 'null'] Always up ethernet interface
name ['string', 'null'] IOU VM name
- - -
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
- diff --git a/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstopcapture.rst b/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstopcapture.rst deleted file mode 100644 index 9ceeef26..00000000 --- a/docs/api/v1projectsprojectidvirtualboxvmsvmidadaptersadapteriddstopcapture.rst +++ /dev/null @@ -1,21 +0,0 @@ -/v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/stop_capture ------------------------------------------------------------------------------------------------------------------ - -.. contents:: - -POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_id:\d+}**/stop_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a packet capture on a VirtualBox VM instance - -Parameters -********** -- **vm_id**: UUID for the instance -- **project_id**: UUID for the project -- **adapter_id**: Adapter to stop a packet capture - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Capture stopped - diff --git a/docs/api/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 1c756021..f1183c0a 100644 --- a/docs/api/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a VPCS instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port where the nio should be added - **vm_id**: UUID for the instance - **project_id**: UUID for the project +- **port_number**: Port where the nio should be added Response status codes ********************** @@ -28,9 +28,9 @@ Remove a NIO from a VPCS instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port from where the nio should be removed - **vm_id**: UUID for the instance - **project_id**: UUID for the project +- **port_number**: Port from where the nio should be removed Response status codes **********************