Documentation update

This commit is contained in:
Julien Duponchelle 2015-02-17 09:46:18 +01:00
parent dc4df68c7a
commit 70ad9fff26
19 changed files with 29 additions and 149 deletions

View File

@ -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

View File

@ -13,8 +13,8 @@ SERVER: Python/3.4 GNS3/1.3.dev1
X-ROUTE: /v1/projects/{project_id} X-ROUTE: /v1/projects/{project_id}
{ {
"location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp5cndh7nh", "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpd4_jlup7",
"path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp5cndh7nh/00010203-0405-0607-0809-0a0b0c0d0e0f", "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpd4_jlup7/00010203-0405-0607-0809-0a0b0c0d0e0f",
"project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f", "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f",
"temporary": false "temporary": false
} }

View File

@ -18,9 +18,9 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
"l1_keepalives": false, "l1_keepalives": false,
"name": "PC TEST 1", "name": "PC TEST 1",
"nvram": 128, "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", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256, "ram": 256,
"serial_adapters": 2, "serial_adapters": 2,
"vm_id": "548ed6e5-2ab6-421d-8f85-9dee638617fb" "vm_id": "8d4ce7ee-9c5e-4ac0-9106-f8cf28a12b5d"
} }

View File

@ -21,6 +21,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}
"name": "VMTEST", "name": "VMTEST",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"use_any_adapter": false, "use_any_adapter": false,
"vm_id": "f70dc1dd-563e-46cc-9cf7-bb169730b8e2", "vm_id": "591dcdfc-f25f-4a87-bd06-6091551c6f8e",
"vmname": "VMTEST" "vmname": "VMTEST"
} }

View File

@ -17,5 +17,5 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
"name": "PC TEST 1", "name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null, "startup_script": null,
"vm_id": "ed3e4572-df65-4581-9332-324e749d480a" "vm_id": "37726103-1521-42c3-8925-fd4fabea9caf"
} }

View File

@ -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 POST /projects/{project_id}/iou/vms HTTP/1.1
{ {
"ethernet_adapters": 0, "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, "l1_keepalives": true,
"name": "PC TEST 1", "name": "PC TEST 1",
"nvram": 512, "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, "ram": 1024,
"serial_adapters": 4 "serial_adapters": 4
} }
@ -27,9 +28,9 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms
"l1_keepalives": true, "l1_keepalives": true,
"name": "PC TEST 1", "name": "PC TEST 1",
"nvram": 512, "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", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 1024, "ram": 1024,
"serial_adapters": 4, "serial_adapters": 4,
"vm_id": "12acb1c1-304e-4c3e-81c4-23c52e6c01ba" "vm_id": "f1bafbbe-96ba-4088-83e2-391cf9477e89"
} }

View File

@ -25,6 +25,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms
"name": "VM1", "name": "VM1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"use_any_adapter": false, "use_any_adapter": false,
"vm_id": "ad5dba5d-0219-41a0-9bd3-eaca69649f6c", "vm_id": "be653307-d7d6-4884-932f-0d87c7e2c06b",
"vmname": "VM1" "vmname": "VM1"
} }

View File

@ -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"
}

View File

@ -19,5 +19,5 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms
"name": "PC TEST 1", "name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null, "startup_script": null,
"vm_id": "6c343265-dc55-4bfe-8d4e-f3f21eeeca8d" "vm_id": "154fff9a-bd47-4740-8a00-847ec30dd6e0"
} }

View File

@ -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 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"
} }

View File

@ -24,6 +24,7 @@ Input
<table> <table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr> <tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr> <tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr> <tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr> <tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
@ -46,6 +47,7 @@ Input
<tr><td>power_supplies</td> <td> </td> <td>array</td> <td>Power supplies status</td> </tr> <tr><td>power_supplies</td> <td> </td> <td>array</td> <td>Power supplies status</td> </tr>
<tr><td>private_config</td> <td> </td> <td>string</td> <td>path to the IOS private configuration file</td> </tr> <tr><td>private_config</td> <td> </td> <td>string</td> <td>path to the IOS private configuration file</td> </tr>
<tr><td>private_config_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr> <tr><td>private_config_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
<tr><td>private_config_content</td> <td> </td> <td>string</td> <td>Content of IOS private configuration file</td> </tr>
<tr><td>ram</td> <td>&#10004;</td> <td>integer</td> <td>amount of RAM in MB</td> </tr> <tr><td>ram</td> <td>&#10004;</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
<tr><td>sensors</td> <td> </td> <td>array</td> <td>Temperature sensors</td> </tr> <tr><td>sensors</td> <td> </td> <td>array</td> <td>Temperature sensors</td> </tr>
<tr><td>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr> <tr><td>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
@ -58,6 +60,7 @@ Input
<tr><td>sparsemem</td> <td> </td> <td>boolean</td> <td>sparse memory feature</td> </tr> <tr><td>sparsemem</td> <td> </td> <td>boolean</td> <td>sparse memory feature</td> </tr>
<tr><td>startup_config</td> <td> </td> <td>string</td> <td>path to the IOS startup configuration file</td> </tr> <tr><td>startup_config</td> <td> </td> <td>string</td> <td>path to the IOS startup configuration file</td> </tr>
<tr><td>startup_config_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr> <tr><td>startup_config_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr>
<tr><td>startup_config_content</td> <td> </td> <td>string</td> <td>Content of IOS startup configuration file</td> </tr>
<tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr> <tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr>
<tr><td>vm_id</td> <td> </td> <td></td> <td>Dynamips VM instance identifier</td> </tr> <tr><td>vm_id</td> <td> </td> <td></td> <td>Dynamips VM instance identifier</td> </tr>
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr> <tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
@ -72,6 +75,7 @@ Output
<table> <table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr> <tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr> <tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr> <tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr> <tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>

View File

@ -25,6 +25,7 @@ Output
<table> <table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr> <tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr> <tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr> <tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr> <tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
@ -91,6 +92,7 @@ Input
<table> <table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr> <tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr> <tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr> <tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr> <tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
@ -137,6 +139,7 @@ Output
<table> <table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr> <tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr> <tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr> <tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr> <tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>

View File

@ -25,6 +25,7 @@ Input
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr> <tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr> <tr><td>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>initial_config</td> <td> </td> <td>['string', 'null']</td> <td>Initial configuration of the IOU</td> </tr>
<tr><td>iourc_path</td> <td> </td> <td>string</td> <td>Path of iourc</td> </tr> <tr><td>iourc_path</td> <td> </td> <td>string</td> <td>Path of iourc</td> </tr>
<tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr> <tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>IOU VM name</td> </tr> <tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>IOU VM name</td> </tr>

View File

@ -61,7 +61,7 @@ Input
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr> <tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>ethernet_adapters</td> <td> </td> <td>['integer', 'null']</td> <td>How many ethernet adapters are connected to the IOU</td> </tr> <tr><td>ethernet_adapters</td> <td> </td> <td>['integer', 'null']</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>initial_config</td> <td> </td> <td>['string', 'null']</td> <td>Initial configuration path</td> </tr> <tr><td>initial_config</td> <td> </td> <td>['string', 'null']</td> <td>Initial configuration of the IOU</td> </tr>
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of iourc</td> </tr> <tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of iourc</td> </tr>
<tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr> <tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>IOU VM name</td> </tr> <tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>IOU VM name</td> </tr>

View File

@ -10,9 +10,9 @@ Add a NIO to a IOU instance
Parameters Parameters
********** **********
- **adapter_number**: Network adapter where the nio is located - **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **vm_id**: UUID for the instance - **vm_id**: UUID for the instance
- **project_id**: UUID for the project - **project_id**: UUID for the project
- **port_number**: Port where the nio should be added
Response status codes Response status codes
********************** **********************
@ -28,9 +28,9 @@ Remove a NIO from a IOU instance
Parameters Parameters
********** **********
- **adapter_number**: Network adapter where the nio is located - **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 - **vm_id**: UUID for the instance
- **project_id**: UUID for the project - **project_id**: UUID for the project
- **port_number**: Port from where the nio should be removed
Response status codes Response status codes
********************** **********************

View File

@ -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

View File

@ -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
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td>&#10004;</td> <td>string</td> <td>Capture file name</td> </tr>
</table>

View File

@ -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

View File

@ -10,9 +10,9 @@ Add a NIO to a VPCS instance
Parameters Parameters
********** **********
- **adapter_number**: Network adapter where the nio is located - **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **vm_id**: UUID for the instance - **vm_id**: UUID for the instance
- **project_id**: UUID for the project - **project_id**: UUID for the project
- **port_number**: Port where the nio should be added
Response status codes Response status codes
********************** **********************
@ -28,9 +28,9 @@ Remove a NIO from a VPCS instance
Parameters Parameters
********** **********
- **adapter_number**: Network adapter where the nio is located - **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 - **vm_id**: UUID for the instance
- **project_id**: UUID for the project - **project_id**: UUID for the project
- **port_number**: Port from where the nio should be removed
Response status codes Response status codes
********************** **********************