mirror of https://github.com/GNS3/gns3-server
parent
2cab5293c7
commit
49f012cf4c
@ -0,0 +1,13 @@
|
|||||||
|
curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio'
|
||||||
|
|
||||||
|
DELETE /projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\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}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||||
|
|
@ -0,0 +1,13 @@
|
|||||||
|
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
|
||||||
|
|
@ -0,0 +1,13 @@
|
|||||||
|
curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio'
|
||||||
|
|
||||||
|
DELETE /projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\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}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||||
|
|
@ -0,0 +1,26 @@
|
|||||||
|
curl -i -X GET 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}'
|
||||||
|
|
||||||
|
GET /projects/{project_id}/iou/vms/{vm_id} HTTP/1.1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
HTTP/1.1 200
|
||||||
|
CONNECTION: keep-alive
|
||||||
|
CONTENT-LENGTH: 381
|
||||||
|
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}/iou/vms/{vm_id}
|
||||||
|
|
||||||
|
{
|
||||||
|
"console": 2000,
|
||||||
|
"ethernet_adapters": 2,
|
||||||
|
"l1_keepalives": false,
|
||||||
|
"name": "PC TEST 1",
|
||||||
|
"nvram": 128,
|
||||||
|
"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2249/test_iou_get0/iou.bin",
|
||||||
|
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
|
||||||
|
"ram": 256,
|
||||||
|
"serial_adapters": 2,
|
||||||
|
"vm_id": "3ab57efc-4016-4898-ac4c-6e804ed8d429"
|
||||||
|
}
|
@ -0,0 +1,26 @@
|
|||||||
|
curl -i -X GET 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}'
|
||||||
|
|
||||||
|
GET /projects/{project_id}/virtualbox/vms/{vm_id} HTTP/1.1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
HTTP/1.1 200
|
||||||
|
CONNECTION: keep-alive
|
||||||
|
CONTENT-LENGTH: 347
|
||||||
|
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}
|
||||||
|
|
||||||
|
{
|
||||||
|
"adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
|
||||||
|
"adapters": 0,
|
||||||
|
"console": 2001,
|
||||||
|
"enable_remote_console": false,
|
||||||
|
"headless": false,
|
||||||
|
"name": "VMTEST",
|
||||||
|
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
|
||||||
|
"use_any_adapter": false,
|
||||||
|
"vm_id": "3e6ed300-eefc-4582-80f0-acbdba7e2b9b",
|
||||||
|
"vmname": "VMTEST"
|
||||||
|
}
|
@ -0,0 +1,21 @@
|
|||||||
|
curl -i -X GET 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}'
|
||||||
|
|
||||||
|
GET /projects/{project_id}/vpcs/vms/{vm_id} HTTP/1.1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
HTTP/1.1 200
|
||||||
|
CONNECTION: keep-alive
|
||||||
|
CONTENT-LENGTH: 187
|
||||||
|
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}/vpcs/vms/{vm_id}
|
||||||
|
|
||||||
|
{
|
||||||
|
"console": 2009,
|
||||||
|
"name": "PC TEST 1",
|
||||||
|
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
|
||||||
|
"startup_script": null,
|
||||||
|
"vm_id": "b4ff501b-c24d-4f0c-854b-8163e31b9a8e"
|
||||||
|
}
|
@ -0,0 +1,35 @@
|
|||||||
|
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-2249/test_iou_create_with_params0/iourc", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2249/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-2249/test_iou_create_with_params0/iourc",
|
||||||
|
"l1_keepalives": true,
|
||||||
|
"name": "PC TEST 1",
|
||||||
|
"nvram": 512,
|
||||||
|
"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2249/test_iou_create_with_params0/iou.bin",
|
||||||
|
"ram": 1024,
|
||||||
|
"serial_adapters": 4
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
HTTP/1.1 201
|
||||||
|
CONNECTION: keep-alive
|
||||||
|
CONTENT-LENGTH: 396
|
||||||
|
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}/iou/vms
|
||||||
|
|
||||||
|
{
|
||||||
|
"console": 2000,
|
||||||
|
"ethernet_adapters": 0,
|
||||||
|
"l1_keepalives": true,
|
||||||
|
"name": "PC TEST 1",
|
||||||
|
"nvram": 512,
|
||||||
|
"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2249/test_iou_create_with_params0/iou.bin",
|
||||||
|
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
|
||||||
|
"ram": 1024,
|
||||||
|
"serial_adapters": 4,
|
||||||
|
"vm_id": "b6a61d51-7225-4f4a-904a-54c8a8917b87"
|
||||||
|
}
|
@ -0,0 +1,21 @@
|
|||||||
|
curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
|
||||||
|
|
||||||
|
POST /projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
|
||||||
|
{
|
||||||
|
"ethernet_device": "eth0",
|
||||||
|
"type": "nio_generic_ethernet"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
HTTP/1.1 201
|
||||||
|
CONNECTION: keep-alive
|
||||||
|
CONTENT-LENGTH: 69
|
||||||
|
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}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||||
|
|
||||||
|
{
|
||||||
|
"ethernet_device": "eth0",
|
||||||
|
"type": "nio_generic_ethernet"
|
||||||
|
}
|
@ -0,0 +1,30 @@
|
|||||||
|
curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms' -d '{"linked_clone": false, "name": "VM1", "vmname": "VM1"}'
|
||||||
|
|
||||||
|
POST /projects/{project_id}/virtualbox/vms HTTP/1.1
|
||||||
|
{
|
||||||
|
"linked_clone": false,
|
||||||
|
"name": "VM1",
|
||||||
|
"vmname": "VM1"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
HTTP/1.1 201
|
||||||
|
CONNECTION: keep-alive
|
||||||
|
CONTENT-LENGTH: 341
|
||||||
|
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
|
||||||
|
|
||||||
|
{
|
||||||
|
"adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
|
||||||
|
"adapters": 0,
|
||||||
|
"console": 2000,
|
||||||
|
"enable_remote_console": false,
|
||||||
|
"headless": false,
|
||||||
|
"name": "VM1",
|
||||||
|
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
|
||||||
|
"use_any_adapter": false,
|
||||||
|
"vm_id": "7abbfc73-3d92-4e31-a99c-3b9519b2e0e8",
|
||||||
|
"vmname": "VM1"
|
||||||
|
}
|
@ -0,0 +1,25 @@
|
|||||||
|
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"
|
||||||
|
}
|
@ -0,0 +1,23 @@
|
|||||||
|
curl -i -X POST 'http://localhost:8000/projects/{project_id}/vpcs/vms' -d '{"name": "PC TEST 1"}'
|
||||||
|
|
||||||
|
POST /projects/{project_id}/vpcs/vms HTTP/1.1
|
||||||
|
{
|
||||||
|
"name": "PC TEST 1"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
HTTP/1.1 201
|
||||||
|
CONNECTION: keep-alive
|
||||||
|
CONTENT-LENGTH: 187
|
||||||
|
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}/vpcs/vms
|
||||||
|
|
||||||
|
{
|
||||||
|
"console": 2009,
|
||||||
|
"name": "PC TEST 1",
|
||||||
|
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
|
||||||
|
"startup_script": null,
|
||||||
|
"vm_id": "b481d455-16d3-450f-bcec-afdf1ec0c682"
|
||||||
|
}
|
@ -0,0 +1,25 @@
|
|||||||
|
curl -i -X POST 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
|
||||||
|
|
||||||
|
POST /projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\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}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||||
|
|
||||||
|
{
|
||||||
|
"lport": 4242,
|
||||||
|
"rhost": "127.0.0.1",
|
||||||
|
"rport": 4343,
|
||||||
|
"type": "nio_udp"
|
||||||
|
}
|
@ -1,20 +1,20 @@
|
|||||||
curl -i -X PUT 'http://localhost:8000/projects/{project_id}' -d '{"path": "/tmp/pytest-48/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-2249/test_update_path_project_non_l0"}'
|
||||||
|
|
||||||
PUT /projects/{project_id} HTTP/1.1
|
PUT /projects/{project_id} HTTP/1.1
|
||||||
{
|
{
|
||||||
"path": "/tmp/pytest-48/test_update_path_project_non_l0"
|
"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-2249/test_update_path_project_non_l0"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
HTTP/1.1 403
|
HTTP/1.1 403
|
||||||
CONNECTION: close
|
CONNECTION: keep-alive
|
||||||
CONTENT-LENGTH: 101
|
CONTENT-LENGTH: 100
|
||||||
CONTENT-TYPE: application/json
|
CONTENT-TYPE: application/json
|
||||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||||
SERVER: Python/3.4 aiohttp/0.13.1
|
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||||
X-ROUTE: /v1/projects/{project_id}
|
X-ROUTE: /v1/projects/{project_id}
|
||||||
|
|
||||||
{
|
{
|
||||||
"message": "You are not allowed to modifiy the project directory location",
|
"message": "You are not allowed to modify the project directory location",
|
||||||
"status": 403
|
"status": 403
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,116 @@
|
|||||||
|
/v1/projects/{project_id}/dynamips/vms
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/dynamips/vms
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Create a new Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **201**: Instance created
|
||||||
|
- **409**: Conflict
|
||||||
|
|
||||||
|
Input
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<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>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>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||||
|
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||||
|
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||||
|
<tr><td>dynamips_id</td> <td> </td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||||
|
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||||
|
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||||
|
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||||
|
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||||
|
<tr><td>image</td> <td>✔</td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||||
|
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||||
|
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||||
|
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||||
|
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||||
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||||
|
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||||
|
<tr><td>platform</td> <td>✔</td> <td>string</td> <td>platform</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_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||||
|
<tr><td>ram</td> <td>✔</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>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||||
|
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||||
|
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||||
|
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||||
|
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||||
|
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||||
|
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</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_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</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>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
Output
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<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>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>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||||
|
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||||
|
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||||
|
<tr><td>dynamips_id</td> <td>✔</td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||||
|
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||||
|
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||||
|
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||||
|
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||||
|
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||||
|
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||||
|
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||||
|
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||||
|
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||||
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||||
|
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||||
|
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</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_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||||
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||||
|
<tr><td>ram</td> <td> </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>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||||
|
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||||
|
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||||
|
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||||
|
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||||
|
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||||
|
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</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_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</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>string</td> <td>Dynamips router instance UUID</td> </tr>
|
||||||
|
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
@ -0,0 +1,197 @@
|
|||||||
|
/v1/projects/{project_id}/dynamips/vms/{vm_id}
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
GET /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Get a Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **200**: Success
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
|
||||||
|
Output
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<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>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>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||||
|
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||||
|
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||||
|
<tr><td>dynamips_id</td> <td>✔</td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||||
|
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||||
|
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||||
|
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||||
|
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||||
|
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||||
|
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||||
|
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||||
|
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||||
|
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||||
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||||
|
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||||
|
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</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_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||||
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||||
|
<tr><td>ram</td> <td> </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>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||||
|
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||||
|
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||||
|
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||||
|
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||||
|
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||||
|
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</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_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</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>string</td> <td>Dynamips router instance UUID</td> </tr>
|
||||||
|
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
PUT /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Update a Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **200**: Instance updated
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **409**: Conflict
|
||||||
|
|
||||||
|
Input
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<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>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>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||||
|
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||||
|
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||||
|
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||||
|
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||||
|
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||||
|
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||||
|
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||||
|
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||||
|
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||||
|
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||||
|
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||||
|
<tr><td>name</td> <td> </td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||||
|
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||||
|
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</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_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||||
|
<tr><td>ram</td> <td> </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>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||||
|
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||||
|
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||||
|
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||||
|
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||||
|
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||||
|
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</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_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr>
|
||||||
|
<tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr>
|
||||||
|
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
Output
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<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>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>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||||
|
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||||
|
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||||
|
<tr><td>dynamips_id</td> <td>✔</td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||||
|
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||||
|
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||||
|
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||||
|
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||||
|
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||||
|
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||||
|
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||||
|
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||||
|
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||||
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||||
|
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||||
|
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</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_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||||
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||||
|
<tr><td>ram</td> <td> </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>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||||
|
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||||
|
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||||
|
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||||
|
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||||
|
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||||
|
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</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_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</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>string</td> <td>Dynamips router instance UUID</td> </tr>
|
||||||
|
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
DELETE /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Delete a Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance deleted
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/dynamips/vms/{vm_id}/reload
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/reload
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Reload a Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance reloaded
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/dynamips/vms/{vm_id}/resume
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/resume
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Resume a suspended Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance resumed
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/dynamips/vms/{vm_id}/start
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/start
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Start a Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance started
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/dynamips/vms/{vm_id}/stop
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/stop
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Stop a Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance stopped
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/dynamips/vms/{vm_id}/suspend
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/suspend
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Suspend a Dynamips VM instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance suspended
|
||||||
|
|
@ -0,0 +1,55 @@
|
|||||||
|
/v1/projects/{project_id}/iou/vms
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/iou/vms
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Create a new IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **201**: Instance created
|
||||||
|
- **409**: Conflict
|
||||||
|
|
||||||
|
Input
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<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>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</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>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated NVRAM KB</td> </tr>
|
||||||
|
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||||
|
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated RAM MB</td> </tr>
|
||||||
|
<tr><td>serial_adapters</td> <td> </td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||||
|
<tr><td>vm_id</td> <td> </td> <td></td> <td>IOU VM identifier</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
Output
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||||
|
<tr><td>console</td> <td>✔</td> <td>integer</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>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||||||
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||||||
|
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||||
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||||
|
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||||||
|
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||||
|
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
@ -0,0 +1,107 @@
|
|||||||
|
/v1/projects/{project_id}/iou/vms/{vm_id}
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Get a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **200**: Success
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
|
||||||
|
Output
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||||
|
<tr><td>console</td> <td>✔</td> <td>integer</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>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||||||
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||||||
|
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||||
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||||
|
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||||||
|
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||||
|
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
PUT /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Update a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **200**: Instance updated
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **409**: Conflict
|
||||||
|
|
||||||
|
Input
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<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>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>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>name</td> <td> </td> <td>['string', 'null']</td> <td>IOU VM name</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated NVRAM KB</td> </tr>
|
||||||
|
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Path of iou binary</td> </tr>
|
||||||
|
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated RAM MB</td> </tr>
|
||||||
|
<tr><td>serial_adapters</td> <td> </td> <td>['integer', 'null']</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
Output
|
||||||
|
*******
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||||
|
<tr><td>console</td> <td>✔</td> <td>integer</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>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||||||
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||||
|
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||||||
|
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||||
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||||
|
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||||||
|
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||||
|
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Delete a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance deleted
|
||||||
|
|
@ -0,0 +1,40 @@
|
|||||||
|
/v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Add a NIO to a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **port_number**: Port where the nio should be added
|
||||||
|
- **adapter_number**: Network adapter where the nio is located
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **201**: NIO created
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
|
||||||
|
|
||||||
|
DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Remove a NIO from a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **port_number**: Port from where the nio should be removed
|
||||||
|
- **adapter_number**: Network adapter where the nio is located
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: NIO deleted
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/iou/vms/{vm_id}/reload
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/reload
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Reload a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance reloaded
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/iou/vms/{vm_id}/start
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/start
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Start a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance started
|
||||||
|
|
@ -0,0 +1,20 @@
|
|||||||
|
/v1/projects/{project_id}/iou/vms/{vm_id}/stop
|
||||||
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
|
||||||
|
POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/stop
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Stop a IOU instance
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
**********
|
||||||
|
- **vm_id**: UUID for the instance
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
|
Response status codes
|
||||||
|
**********************
|
||||||
|
- **400**: Invalid request
|
||||||
|
- **404**: Instance doesn't exist
|
||||||
|
- **204**: Instance stopped
|
||||||
|
|
@ -1,17 +1,17 @@
|
|||||||
/v1/{project_id}/virtualbox/{vm_id}/capture/{adapter_id:\d+}/stop
|
/v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_id:\d+}/stop_capture
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/virtualbox/**{vm_id}**/capture/**{adapter_id:\d+}**/stop
|
POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_id:\d+}**/stop_capture
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Stop a packet capture on a VirtualBox VM instance
|
Stop a packet capture on a VirtualBox VM instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
**********
|
**********
|
||||||
- **vm_id**: UUID for the instance
|
- **vm_id**: UUID for the instance
|
||||||
- **project_id**: UUID for the project
|
|
||||||
- **adapter_id**: Adapter to stop a packet capture
|
- **adapter_id**: Adapter to stop a packet capture
|
||||||
|
- **project_id**: UUID for the project
|
||||||
|
|
||||||
Response status codes
|
Response status codes
|
||||||
**********************
|
**********************
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/virtualbox/vms/{vm_id}/reload
|
/v1/projects/{project_id}/virtualbox/vms/{vm_id}/reload
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/virtualbox/vms/**{vm_id}**/reload
|
POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/reload
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Reload a VirtualBox VM instance
|
Reload a VirtualBox VM instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/virtualbox/vms/{vm_id}/resume
|
/v1/projects/{project_id}/virtualbox/vms/{vm_id}/resume
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/virtualbox/vms/**{vm_id}**/resume
|
POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/resume
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Resume a suspended VirtualBox VM instance
|
Resume a suspended VirtualBox VM instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/virtualbox/vms/{vm_id}/start
|
/v1/projects/{project_id}/virtualbox/vms/{vm_id}/start
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/virtualbox/vms/**{vm_id}**/start
|
POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/start
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Start a VirtualBox VM instance
|
Start a VirtualBox VM instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/virtualbox/vms/{vm_id}/stop
|
/v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/virtualbox/vms/**{vm_id}**/stop
|
POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/stop
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Stop a VirtualBox VM instance
|
Stop a VirtualBox VM instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/virtualbox/vms/{vm_id}/suspend
|
/v1/projects/{project_id}/virtualbox/vms/{vm_id}/suspend
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/virtualbox/vms/**{vm_id}**/suspend
|
POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/suspend
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Suspend a VirtualBox VM instance
|
Suspend a VirtualBox VM instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/vpcs/vms/{vm_id}/reload
|
/v1/projects/{project_id}/vpcs/vms/{vm_id}/reload
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/vpcs/vms/**{vm_id}**/reload
|
POST /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}**/reload
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Reload a VPCS instance
|
Reload a VPCS instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/vpcs/vms/{vm_id}/start
|
/v1/projects/{project_id}/vpcs/vms/{vm_id}/start
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/vpcs/vms/**{vm_id}**/start
|
POST /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}**/start
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Start a VPCS instance
|
Start a VPCS instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
@ -1,10 +1,10 @@
|
|||||||
/v1/{project_id}/vpcs/vms/{vm_id}/stop
|
/v1/projects/{project_id}/vpcs/vms/{vm_id}/stop
|
||||||
-----------------------------------------------------------
|
-----------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
POST /v1/**{project_id}**/vpcs/vms/**{vm_id}**/stop
|
POST /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}**/stop
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Stop a VPCS instance
|
Stop a VPCS instance
|
||||||
|
|
||||||
Parameters
|
Parameters
|
Loading…
Reference in new issue