arno
/
gns3-server
mirror of https://github.com/GNS3/gns3-server
1
0
Fork 0
Code Issues Releases Wiki Activity

Regenerate documentation

Browse Source
pull/565/head
Julien Duponchelle 8 years ago
parent 58d4a529d4
commit b01d974f91
No known key found for this signature in database
GPG Key ID: CE8B29639E07F5E8
192 changed files with 63 additions and 6261 deletions
Show Stats Download Patch File Download Diff File

6
docs/api/examples/controller_delete_projectsprojectid.txt
Unescape View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/65cf5095-11e2-4b5f-a953-b74aca5a34ec'
curl -i -X DELETE 'http://localhost:3080/v2/projects/e9125918-e385-48b2-8b51-0a58b0aedc26'
DELETE /v2/projects/65cf5095-11e2-4b5f-a953-b74aca5a34ec HTTP/1.1
DELETE /v2/projects/e9125918-e385-48b2-8b51-0a58b0aedc26 HTTP/1.1
@ -8,6 +8,6 @@ HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/projects/{project_id}

12
docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt
Unescape View File

@ -1,18 +1,14 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/7e95cc8e-44b0-42ca-9c2b-8769755b7586/links/8805466a-991c-40ec-937f-517561ecf65b'
curl -i -X DELETE 'http://localhost:3080/v2/projects/b16e5e4f-0bca-457d-bc09-4c21c3bc8ce6/links/6e92a937-ca19-468c-89b8-4a0978ab9c63'
DELETE /v2/projects/7e95cc8e-44b0-42ca-9c2b-8769755b7586/links/8805466a-991c-40ec-937f-517561ecf65b HTTP/1.1
DELETE /v2/projects/b16e5e4f-0bca-457d-bc09-4c21c3bc8ce6/links/6e92a937-ca19-468c-89b8-4a0978ab9c63 HTTP/1.1
HTTP/1.1 201
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 72
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/projects/{project_id}/links/{link_id}
{
"link_id": "8805466a-991c-40ec-937f-517561ecf65b",
"vms": []
}

6
docs/api/examples/controller_get_version.txt
Unescape View File

@ -1,4 +1,4 @@
curl -i -X GET 'http://localhost:8000/v2/version'
curl -i -X GET 'http://localhost:3080/v2/version'
GET /v2/version HTTP/1.1
@ -9,10 +9,10 @@ ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 49
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/version
{
"local": true,
"version": "1.5.0dev1"
"version": "2.0.0dev1"
}

30
docs/api/examples/controller_post_hypervisors.txt
Unescape View File

@ -1,30 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisors' -d '{"host": "example.com", "hypervisor_id": "my_hypervisor_id", "password": "secure", "port": 84, "protocol": "http", "user": "julien"}'
POST /v2/hypervisors HTTP/1.1
{
"host": "example.com",
"hypervisor_id": "my_hypervisor_id",
"password": "secure",
"port": 84,
"protocol": "http",
"user": "julien"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 184
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisors
{
"connected": false,
"host": "example.com",
"hypervisor_id": "my_hypervisor_id",
"port": 84,
"protocol": "http",
"user": "julien",
"version": "1.5.0dev1"
}

4
docs/api/examples/controller_post_projects.txt
Unescape View File

@ -1,4 +1,4 @@
curl -i -X POST 'http://localhost:8000/v2/projects' -d '{"name": "test", "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"}'
curl -i -X POST 'http://localhost:3080/v2/projects' -d '{"name": "test", "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"}'
POST /v2/projects HTTP/1.1
{
@ -12,7 +12,7 @@ ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 122
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/projects
{

6
docs/api/examples/controller_post_projectsprojectidclose.txt
Unescape View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/d7c2d234-9854-47d4-bb78-93a94f2d8bfc/close' -d '{}'
curl -i -X POST 'http://localhost:3080/v2/projects/6f734cbe-2109-4b01-803d-082f5fbca7ee/close' -d '{}'
POST /v2/projects/d7c2d234-9854-47d4-bb78-93a94f2d8bfc/close HTTP/1.1
POST /v2/projects/6f734cbe-2109-4b01-803d-082f5fbca7ee/close HTTP/1.1
{}
@ -8,6 +8,6 @@ HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/projects/{project_id}/close

6
docs/api/examples/controller_post_projectsprojectidcommit.txt
Unescape View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/cf4f50f1-0a93-494b-ada6-39fe0c3df67d/commit' -d '{}'
curl -i -X POST 'http://localhost:3080/v2/projects/34e69920-237f-4162-a0bc-f53272726603/commit' -d '{}'
POST /v2/projects/cf4f50f1-0a93-494b-ada6-39fe0c3df67d/commit HTTP/1.1
POST /v2/projects/34e69920-237f-4162-a0bc-f53272726603/commit HTTP/1.1
{}
@ -8,6 +8,6 @@ HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/projects/{project_id}/commit

16
docs/api/examples/controller_post_projectsprojectidlinks.txt
Unescape View File

@ -1,17 +1,17 @@
curl -i -X POST 'http://localhost:8000/v2/projects/b61e91b1-e69c-4eaa-a012-9d98135a53e0/links' -d '{"vms": [{"adapter_number": 0, "port_number": 3, "vm_id": "0f349889-091d-4919-87d2-11d7ec429066"}, {"adapter_number": 2, "port_number": 4, "vm_id": "bc556663-16a6-41e0-9562-4e541037d890"}]}'
curl -i -X POST 'http://localhost:3080/v2/projects/6693d45f-ea1b-4b25-878c-333b179cb7dc/links' -d '{"vms": [{"adapter_number": 0, "port_number": 3, "vm_id": "0f1f5a24-4f91-4779-b6ce-3e0f4754fef0"}, {"adapter_number": 2, "port_number": 4, "vm_id": "28701ffc-e393-46a0-981f-eb4d67611fde"}]}'
POST /v2/projects/b61e91b1-e69c-4eaa-a012-9d98135a53e0/links HTTP/1.1
POST /v2/projects/6693d45f-ea1b-4b25-878c-333b179cb7dc/links HTTP/1.1
{
"vms": [
{
"adapter_number": 0,
"port_number": 3,
"vm_id": "0f349889-091d-4919-87d2-11d7ec429066"
"vm_id": "0f1f5a24-4f91-4779-b6ce-3e0f4754fef0"
},
{
"adapter_number": 2,
"port_number": 4,
"vm_id": "bc556663-16a6-41e0-9562-4e541037d890"
"vm_id": "28701ffc-e393-46a0-981f-eb4d67611fde"
}
]
}
@ -22,21 +22,21 @@ ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 364
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/projects/{project_id}/links
{
"link_id": "43bd7b6b-8878-48fd-b8f7-1ca876b372ae",
"link_id": "e662f691-6ac5-4833-876a-e4eb83157b9e",
"vms": [
{
"adapter_number": 0,
"port_number": 3,
"vm_id": "0f349889-091d-4919-87d2-11d7ec429066"
"vm_id": "0f1f5a24-4f91-4779-b6ce-3e0f4754fef0"
},
{
"adapter_number": 2,
"port_number": 4,
"vm_id": "bc556663-16a6-41e0-9562-4e541037d890"
"vm_id": "28701ffc-e393-46a0-981f-eb4d67611fde"
}
]
}

18
docs/api/examples/controller_post_projectsprojectidvms.txt
Unescape View File

@ -1,8 +1,8 @@
curl -i -X POST 'http://localhost:8000/v2/projects/e00d950d-0d48-422c-b3ea-43d0fbaa8291/vms' -d '{"hypervisor_id": "example.com", "name": "test", "properties": {"startup_script": "echo test"}, "vm_type": "vpcs"}'
curl -i -X POST 'http://localhost:3080/v2/projects/40743a17-5552-4ccc-aedb-648f9577c5ce/vms' -d '{"compute_id": "example.com", "name": "test", "properties": {"startup_script": "echo test"}, "vm_type": "vpcs"}'
POST /v2/projects/e00d950d-0d48-422c-b3ea-43d0fbaa8291/vms HTTP/1.1
POST /v2/projects/40743a17-5552-4ccc-aedb-648f9577c5ce/vms HTTP/1.1
{
"hypervisor_id": "example.com",
"compute_id": "example.com",
"name": "test",
"properties": {
"startup_script": "echo test"
@ -13,21 +13,21 @@ POST /v2/projects/e00d950d-0d48-422c-b3ea-43d0fbaa8291/vms HTTP/1.1
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 308
CONTENT-LENGTH: 305
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/projects/{project_id}/vms
{
"console": null,
"compute_id": "example.com",
"console": 2048,
"console_type": "telnet",
"hypervisor_id": "example.com",
"name": "test",
"project_id": "e00d950d-0d48-422c-b3ea-43d0fbaa8291",
"project_id": "40743a17-5552-4ccc-aedb-648f9577c5ce",
"properties": {
"startup_script": "echo test"
},
"vm_id": "a311973e-9ede-4aa2-823c-268e972fc66a",
"vm_id": "bca482df-96d4-46d4-aeed-5b38e874c6b0",
"vm_type": "vpcs"
}

8
docs/api/examples/controller_post_version.txt
Unescape View File

@ -1,8 +1,8 @@
curl -i -X POST 'http://localhost:8000/v2/version' -d '{"version": "1.5.0dev1"}'
curl -i -X POST 'http://localhost:3080/v2/version' -d '{"version": "2.0.0dev1"}'
POST /v2/version HTTP/1.1
{
"version": "1.5.0dev1"
"version": "2.0.0dev1"
}
@ -11,9 +11,9 @@ ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 30
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
SERVER: Python/3.5 GNS3/2.0.0dev1
X-ROUTE: /v2/version
{
"version": "1.5.0dev1"
"version": "2.0.0dev1"
}

13
docs/api/examples/hypervisor_delete_projectsprojectid.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80 HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}

13
docs/api/examples/hypervisor_delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/acaac98d-b81f-4490-9392-ffa7fad3832e/adapters/0/ports/0/nio'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/acaac98d-b81f-4490-9392-ffa7fad3832e/adapters/0/ports/0/nio HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio

13
docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmid.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/30962bb6-155f-4da8-b5e3-499f899e103b'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/30962bb6-155f-4da8-b5e3-499f899e103b HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}

13
docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4a38812f-0a66-4219-937a-c4f688dd2c08/adapters/1/ports/0/nio'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4a38812f-0a66-4219-937a-c4f688dd2c08/adapters/1/ports/0/nio HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio

13
docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmid.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/dd357050-393f-4f87-85a8-312c47aed7e6'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/dd357050-393f-4f87-85a8-312c47aed7e6 HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}

13
docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/986f79ba-ad3a-417b-a56f-d3769cfd7f82/adapters/1/ports/0/nio'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/986f79ba-ad3a-417b-a56f-d3769cfd7f82/adapters/1/ports/0/nio HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio

13
docs/api/examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/364e147a-7c89-4104-b987-6d0d7853f8de/adapters/0/ports/0/nio'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/364e147a-7c89-4104-b987-6d0d7853f8de/adapters/0/ports/0/nio HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio

13
docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmid.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b3c886ce-7ad3-4721-9544-c93709c8b638'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b3c886ce-7ad3-4721-9544-c93709c8b638 HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}

13
docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X DELETE 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/06588b10-2226-43b1-8d08-28e1aa4f5393/adapters/0/ports/0/nio'
DELETE /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/06588b10-2226-43b1-8d08-28e1aa4f5393/adapters/0/ports/0/nio HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio

336
docs/api/examples/hypervisor_get_interfaces.txt
Unescape View File

@ -1,336 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/interfaces'
GET /v2/hypervisor/interfaces HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 6277
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/interfaces
[
{
"id": "bridge0",
"ip_address": "",
"name": "bridge0"
},
{
"id": "en0",
"ip_address": "",
"name": "en0"
},
{
"id": "en1",
"ip_address": "192.168.84.114",
"name": "en1"
},
{
"id": "en2",
"ip_address": "",
"name": "en2"
},
{
"id": "fw0",
"ip_address": "",
"name": "fw0"
},
{
"id": "lo0",
"ip_address": "127.0.0.1",
"name": "lo0"
},
{
"id": "p2p0",
"ip_address": "",
"name": "p2p0"
},
{
"id": "vboxnet0",
"ip_address": "",
"name": "vboxnet0"
},
{
"id": "vboxnet1",
"ip_address": "",
"name": "vboxnet1"
},
{
"id": "vboxnet2",
"ip_address": "",
"name": "vboxnet2"
},
{
"id": "vboxnet3",
"ip_address": "",
"name": "vboxnet3"
},
{
"id": "vboxnet4",
"ip_address": "",
"name": "vboxnet4"
},
{
"id": "vboxnet5",
"ip_address": "",
"name": "vboxnet5"
},
{
"id": "vboxnet6",
"ip_address": "",
"name": "vboxnet6"
},
{
"id": "vmnet1",
"ip_address": "172.16.16.1",
"name": "vmnet1"
},
{
"id": "vmnet10",
"ip_address": "172.16.7.1",
"name": "vmnet10"
},
{
"id": "vmnet11",
"ip_address": "172.16.8.1",
"name": "vmnet11"
},
{
"id": "vmnet12",
"ip_address": "172.16.9.1",
"name": "vmnet12"
},
{
"id": "vmnet13",
"ip_address": "172.16.10.1",
"name": "vmnet13"
},
{
"id": "vmnet14",
"ip_address": "172.16.11.1",
"name": "vmnet14"
},
{
"id": "vmnet15",
"ip_address": "172.16.12.1",
"name": "vmnet15"
},
{
"id": "vmnet16",
"ip_address": "172.16.13.1",
"name": "vmnet16"
},
{
"id": "vmnet17",
"ip_address": "172.16.14.1",
"name": "vmnet17"
},
{
"id": "vmnet18",
"ip_address": "172.16.15.1",
"name": "vmnet18"
},
{
"id": "vmnet19",
"ip_address": "172.16.17.1",
"name": "vmnet19"
},
{
"id": "vmnet2",
"ip_address": "172.16.0.1",
"name": "vmnet2"
},
{
"id": "vmnet20",
"ip_address": "172.16.18.1",
"name": "vmnet20"
},
{
"id": "vmnet21",
"ip_address": "172.16.19.1",
"name": "vmnet21"
},
{
"id": "vmnet22",
"ip_address": "172.16.20.1",
"name": "vmnet22"
},
{
"id": "vmnet23",
"ip_address": "172.16.21.1",
"name": "vmnet23"
},
{
"id": "vmnet24",
"ip_address": "172.16.22.1",
"name": "vmnet24"
},
{
"id": "vmnet25",
"ip_address": "172.16.23.1",
"name": "vmnet25"
},
{
"id": "vmnet26",
"ip_address": "172.16.24.1",
"name": "vmnet26"
},
{
"id": "vmnet27",
"ip_address": "172.16.25.1",
"name": "vmnet27"
},
{
"id": "vmnet28",
"ip_address": "172.16.26.1",
"name": "vmnet28"
},
{
"id": "vmnet29",
"ip_address": "172.16.27.1",
"name": "vmnet29"
},
{
"id": "vmnet3",
"ip_address": "172.16.1.1",
"name": "vmnet3"
},
{
"id": "vmnet30",
"ip_address": "172.16.28.1",
"name": "vmnet30"
},
{
"id": "vmnet31",
"ip_address": "172.16.29.1",
"name": "vmnet31"
},
{
"id": "vmnet32",
"ip_address": "172.16.30.1",
"name": "vmnet32"
},
{
"id": "vmnet33",
"ip_address": "172.16.31.1",
"name": "vmnet33"
},
{
"id": "vmnet34",
"ip_address": "172.16.32.1",
"name": "vmnet34"
},
{
"id": "vmnet35",
"ip_address": "172.16.33.1",
"name": "vmnet35"
},
{
"id": "vmnet36",
"ip_address": "172.16.34.1",
"name": "vmnet36"
},
{
"id": "vmnet37",
"ip_address": "172.16.35.1",
"name": "vmnet37"
},
{
"id": "vmnet38",
"ip_address": "172.16.36.1",
"name": "vmnet38"
},
{
"id": "vmnet39",
"ip_address": "172.16.37.1",
"name": "vmnet39"
},
{
"id": "vmnet4",
"ip_address": "172.16.2.1",
"name": "vmnet4"
},
{
"id": "vmnet40",
"ip_address": "172.16.38.1",
"name": "vmnet40"
},
{
"id": "vmnet41",
"ip_address": "172.16.39.1",
"name": "vmnet41"
},
{
"id": "vmnet42",
"ip_address": "172.16.40.1",
"name": "vmnet42"
},
{
"id": "vmnet43",
"ip_address": "172.16.41.1",
"name": "vmnet43"
},
{
"id": "vmnet44",
"ip_address": "172.16.42.1",
"name": "vmnet44"
},
{
"id": "vmnet45",
"ip_address": "172.16.43.1",
"name": "vmnet45"
},
{
"id": "vmnet46",
"ip_address": "172.16.44.1",
"name": "vmnet46"
},
{
"id": "vmnet47",
"ip_address": "172.16.45.1",
"name": "vmnet47"
},
{
"id": "vmnet48",
"ip_address": "172.16.46.1",
"name": "vmnet48"
},
{
"id": "vmnet49",
"ip_address": "172.16.47.1",
"name": "vmnet49"
},
{
"id": "vmnet5",
"ip_address": "172.16.3.1",
"name": "vmnet5"
},
{
"id": "vmnet50",
"ip_address": "172.16.48.1",
"name": "vmnet50"
},
{
"id": "vmnet6",
"ip_address": "172.16.4.1",
"name": "vmnet6"
},
{
"id": "vmnet7",
"ip_address": "172.16.5.1",
"name": "vmnet7"
},
{
"id": "vmnet8",
"ip_address": "192.168.229.1",
"name": "vmnet8"
},
{
"id": "vmnet9",
"ip_address": "172.16.6.1",
"name": "vmnet9"
}
]

20
docs/api/examples/hypervisor_get_iouvms.txt
Unescape View File

@ -1,20 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/iou/vms'
GET /v2/hypervisor/iou/vms HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 72
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/iou/vms
[
{
"filename": "iou.bin",
"path": "iou.bin"
}
]

26
docs/api/examples/hypervisor_get_projects.txt
Unescape View File

@ -1,26 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects'
GET /v2/hypervisor/projects HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 254
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects
[
{
"name": "test",
"project_id": "52010203-0405-0607-0809-0a0b0c0d0e0b",
"temporary": false
},
{
"name": "test",
"project_id": "51010203-0405-0607-0809-0a0b0c0d0e0f",
"temporary": false
}
]

19
docs/api/examples/hypervisor_get_projectsprojectid.txt
Unescape View File

@ -1,19 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects/40010203-0405-0607-0809-0a0b0c0d0e02'
GET /v2/hypervisor/projects/40010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 104
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}
{
"name": "test",
"project_id": "40010203-0405-0607-0809-0a0b0c0d0e02",
"temporary": false
}

24
docs/api/examples/hypervisor_get_projectsprojectidfiles.txt
Unescape View File

@ -1,24 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/files'
GET /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/files HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 204
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/files
[
{
"md5sum": "ad0234829205b9033196ba818f7a872b",
"path": "test.txt"
},
{
"md5sum": "098f6bcd4621d373cade4e832627b4f6",
"path": "vm-1/dynamips/test.bin"
}
]

33
docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmid.txt
Unescape View File

@ -1,33 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2e4fb556-c2ff-487a-b893-89ce71664e50'
GET /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2e4fb556-c2ff-487a-b893-89ce71664e50 HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 643
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}
{
"command_line": "",
"console": 2001,
"ethernet_adapters": 2,
"iourc_path": null,
"l1_keepalives": false,
"md5sum": null,
"name": "PC TEST 1",
"nvram": 128,
"path": "iou.bin",
"private_config": null,
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256,
"serial_adapters": 2,
"startup_config": null,
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphaiimisv/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/2e4fb556-c2ff-487a-b893-89ce71664e50",
"vm_id": "2e4fb556-c2ff-487a-b893-89ce71664e50"
}

17
docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmidconfigs.txt
Unescape View File

@ -1,17 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ad0bffec-9cc8-40ab-8912-deb6747e8816/configs'
GET /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ad0bffec-9cc8-40ab-8912-deb6747e8816/configs HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 40
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/configs
{
"startup_config_content": "TEST"
}

56
docs/api/examples/hypervisor_get_projectsprojectidqemuvmsvmid.txt
Unescape View File

@ -1,56 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/91ef9646-40e4-476d-843f-15903bbd8ab7'
GET /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/91ef9646-40e4-476d-843f-15903bbd8ab7 HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 1386
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}
{
"acpi_shutdown": false,
"adapter_type": "e1000",
"adapters": 1,
"boot_priority": "c",
"cdrom_image": "",
"cdrom_image_md5sum": null,
"command_line": "",
"console": 2001,
"console_type": "telnet",
"cpu_throttling": 0,
"cpus": 1,
"hda_disk_image": "",
"hda_disk_image_md5sum": null,
"hda_disk_interface": "ide",
"hdb_disk_image": "",
"hdb_disk_image_md5sum": null,
"hdb_disk_interface": "ide",
"hdc_disk_image": "",
"hdc_disk_image_md5sum": null,
"hdc_disk_interface": "ide",
"hdd_disk_image": "",
"hdd_disk_image_md5sum": null,
"hdd_disk_interface": "ide",
"initrd": "",
"initrd_md5sum": null,
"kernel_command_line": "",
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:8a:b7:00",
"name": "PC TEST 1",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpusrb0a1j/qemu-system-x86_64",
"ram": 256,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/91ef9646-40e4-476d-843f-15903bbd8ab7",
"vm_id": "91ef9646-40e4-476d-843f-15903bbd8ab7"
}

29
docs/api/examples/hypervisor_get_projectsprojectidvirtualboxvmsvmid.txt
Unescape View File

@ -1,29 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e959b3bc-0d08-4528-a0a1-512bdd6b6cc8'
GET /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e959b3bc-0d08-4528-a0a1-512bdd6b6cc8 HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 415
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}
{
"acpi_shutdown": false,
"adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
"adapters": 0,
"console": 2002,
"enable_remote_console": false,
"headless": false,
"name": "VMTEST",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 0,
"use_any_adapter": false,
"vm_directory": null,
"vm_id": "e959b3bc-0d08-4528-a0a1-512bdd6b6cc8",
"vmname": "VMTEST"
}

26
docs/api/examples/hypervisor_get_projectsprojectidvpcsvmsvmid.txt
Unescape View File

@ -1,26 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/7aa4b445-5fe9-4525-9704-8f409ce002f1'
GET /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/7aa4b445-5fe9-4525-9704-8f409ce002f1 HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 485
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}
{
"command_line": "",
"console": 2010,
"console_type": "telnet",
"name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/7aa4b445-5fe9-4525-9704-8f409ce002f1",
"vm_id": "7aa4b445-5fe9-4525-9704-8f409ce002f1"
}

32
docs/api/examples/hypervisor_get_qemubinaries.txt
Unescape View File

@ -1,32 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/qemu/binaries' -d '{"archs": ["i386"]}'
GET /v2/hypervisor/qemu/binaries HTTP/1.1
{
"archs": [
"i386"
]
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 212
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/qemu/binaries
[
{
"path": "/tmp/x86_64",
"version": "2.2.0"
},
{
"path": "/tmp/alpha",
"version": "2.1.0"
},
{
"path": "/tmp/i386",
"version": "2.1.0"
}
]

19
docs/api/examples/hypervisor_get_qemucapabilities.txt
Unescape View File

@ -1,19 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/qemu/capabilities'
GET /v2/hypervisor/qemu/capabilities HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 39
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/qemu/capabilities
{
"kvm": [
"x86_64"
]
}

18
docs/api/examples/hypervisor_get_version.txt
Unescape View File

@ -1,18 +0,0 @@
curl -i -X GET 'http://localhost:8000/v2/hypervisor/version'
GET /v2/hypervisor/version HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 49
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/version
{
"local": true,
"version": "1.5.0dev1"
}

13
docs/api/examples/hypervisor_post_configreload.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/config/reload' -d '{}'
POST /v2/hypervisor/config/reload HTTP/1.1
{}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/config/reload

22
docs/api/examples/hypervisor_post_projects.txt
Unescape View File

@ -1,22 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects' -d '{"name": "test", "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"}'
POST /v2/hypervisor/projects HTTP/1.1
{
"name": "test",
"project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 104
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects
{
"name": "test",
"project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f",
"temporary": false
}

13
docs/api/examples/hypervisor_post_projectsprojectidclose.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/close

13
docs/api/examples/hypervisor_post_projectsprojectidcommit.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/commit

25
docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,25 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/30686a1e-59ac-4e43-8b0e-aeec3f1180c8/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/30686a1e-59ac-4e43-8b0e-aeec3f1180c8/adapters/0/ports/0/nio HTTP/1.1
{
"lport": 4242,
"rhost": "127.0.0.1",
"rport": 4343,
"type": "nio_udp"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 89
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
{
"lport": 4242,
"rhost": "127.0.0.1",
"rport": 4343,
"type": "nio_udp"
}

20
docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
Unescape View File

@ -1,20 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/430212e5-c7c1-42c5-bdf2-51f2fdd9d1f2/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/430212e5-c7c1-42c5-bdf2-51f2fdd9d1f2/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 167
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphaiimisv/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

13
docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/f407d63c-43cd-44d5-b759-182527f85e6b/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/f407d63c-43cd-44d5-b759-182527f85e6b/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

38
docs/api/examples/hypervisor_post_projectsprojectidiouvms.txt
Unescape View File

@ -1,38 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"name": "PC TEST 1", "path": "iou.bin", "startup_config_content": "hostname test", "vm_id": "3b289fdd-8fc9-48de-8366-db79c1a1dbe4"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1
{
"name": "PC TEST 1",
"path": "iou.bin",
"startup_config_content": "hostname test",
"vm_id": "3b289fdd-8fc9-48de-8366-db79c1a1dbe4"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 659
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms
{
"command_line": "",
"console": 2001,
"ethernet_adapters": 2,
"iourc_path": null,
"l1_keepalives": false,
"md5sum": null,
"name": "PC TEST 1",
"nvram": 128,
"path": "iou.bin",
"private_config": null,
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256,
"serial_adapters": 2,
"startup_config": "startup-config.cfg",
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphaiimisv/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/3b289fdd-8fc9-48de-8366-db79c1a1dbe4",
"vm_id": "3b289fdd-8fc9-48de-8366-db79c1a1dbe4"
}

21
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,21 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/946c98ca-806d-4335-80e3-9cb65d13dbf4/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_generic_ethernet"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/946c98ca-806d-4335-80e3-9cb65d13dbf4/adapters/1/ports/0/nio HTTP/1.1
{
"ethernet_device": "bridge0",
"type": "nio_generic_ethernet"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 72
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
{
"ethernet_device": "bridge0",
"type": "nio_generic_ethernet"
}

20
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
Unescape View File

@ -1,20 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7c669c68-7877-4542-a652-f3243556fb58/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7c669c68-7877-4542-a652-f3243556fb58/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 167
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphaiimisv/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

13
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0c9e3dff-9bab-4523-a89c-6c1093e301a1/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0c9e3dff-9bab-4523-a89c-6c1093e301a1/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

13
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidreload.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/dafdd9c1-4d5c-4d40-8a13-b866a74bb2c8/reload' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/dafdd9c1-4d5c-4d40-8a13-b866a74bb2c8/reload HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/reload

35
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstart.txt
Unescape View File

@ -1,35 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/cca906af-beae-4410-a54d-604a07eab8e3/start' -d '{"iourc_content": "test"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/cca906af-beae-4410-a54d-604a07eab8e3/start HTTP/1.1
{
"iourc_content": "test"
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 707
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/start
{
"command_line": "",
"console": 2001,
"ethernet_adapters": 2,
"iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8j6jo9a_/iourc",
"l1_keepalives": false,
"md5sum": null,
"name": "PC TEST 1",
"nvram": 128,
"path": "iou.bin",
"private_config": null,
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256,
"serial_adapters": 2,
"startup_config": null,
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphaiimisv/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/cca906af-beae-4410-a54d-604a07eab8e3",
"vm_id": "cca906af-beae-4410-a54d-604a07eab8e3"
}

13
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstop.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d6a25ceb-736a-4d24-b3d2-cba27138ce09/stop' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d6a25ceb-736a-4d24-b3d2-cba27138ce09/stop HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/stop

17
docs/api/examples/hypervisor_post_projectsprojectidportsudp.txt
Unescape View File

@ -1,17 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/ports/udp' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/ports/udp HTTP/1.1
{}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 25
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/ports/udp
{
"udp_port": 10000
}

61
docs/api/examples/hypervisor_post_projectsprojectidqemuvms.txt
Unescape View File

@ -1,61 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpusrb0a1j/qemu-system-x86_64", "ram": 1024}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1
{
"hda_disk_image": "linux\u8f7d.img",
"name": "PC TEST 1",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpusrb0a1j/qemu-system-x86_64",
"ram": 1024
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 1432
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms
{
"acpi_shutdown": false,
"adapter_type": "e1000",
"adapters": 1,
"boot_priority": "c",
"cdrom_image": "",
"cdrom_image_md5sum": null,
"command_line": "",
"console": 2001,
"console_type": "telnet",
"cpu_throttling": 0,
"cpus": 1,
"hda_disk_image": "linux\u8f7d.img",
"hda_disk_image_md5sum": "c4ca4238a0b923820dcc509a6f75849b",
"hda_disk_interface": "ide",
"hdb_disk_image": "",
"hdb_disk_image_md5sum": null,
"hdb_disk_interface": "ide",
"hdc_disk_image": "",
"hdc_disk_image_md5sum": null,
"hdc_disk_interface": "ide",
"hdd_disk_image": "",
"hdd_disk_image_md5sum": null,
"hdd_disk_interface": "ide",
"initrd": "",
"initrd_md5sum": null,
"kernel_command_line": "",
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:18:4a:00",
"name": "PC TEST 1",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpusrb0a1j/qemu-system-x86_64",
"ram": 1024,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/11bbadb6-e914-4182-ba7a-647b5f5d184a",
"vm_id": "11bbadb6-e914-4182-ba7a-647b5f5d184a"
}

21
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,21 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/26f94755-2893-4ca8-b5cd-01f4f5aeb667/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/26f94755-2893-4ca8-b5cd-01f4f5aeb667/adapters/1/ports/0/nio HTTP/1.1
{
"ethernet_device": "eth0",
"type": "nio_generic_ethernet"
}
HTTP/1.1 409
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 89
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
{
"message": "NIO of type nio_generic_ethernet is not supported",
"status": 409
}

13
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidreload.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/34c53d14-505e-43c0-8f01-4140d2b12f02/reload' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/34c53d14-505e-43c0-8f01-4140d2b12f02/reload HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/reload

13
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidresume.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/51ea2f31-1a16-46e7-8088-a8bc0d0b6726/resume' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/51ea2f31-1a16-46e7-8088-a8bc0d0b6726/resume HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/resume

56
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstart.txt
Unescape View File

@ -1,56 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7d920e6d-b929-4a3b-a299-a9641030efaf/start' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7d920e6d-b929-4a3b-a299-a9641030efaf/start HTTP/1.1
{}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 1386
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/start
{
"acpi_shutdown": false,
"adapter_type": "e1000",
"adapters": 1,
"boot_priority": "c",
"cdrom_image": "",
"cdrom_image_md5sum": null,
"command_line": "",
"console": 2001,
"console_type": "telnet",
"cpu_throttling": 0,
"cpus": 1,
"hda_disk_image": "",
"hda_disk_image_md5sum": null,
"hda_disk_interface": "ide",
"hdb_disk_image": "",
"hdb_disk_image_md5sum": null,
"hdb_disk_interface": "ide",
"hdc_disk_image": "",
"hdc_disk_image_md5sum": null,
"hdc_disk_interface": "ide",
"hdd_disk_image": "",
"hdd_disk_image_md5sum": null,
"hdd_disk_interface": "ide",
"initrd": "",
"initrd_md5sum": null,
"kernel_command_line": "",
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:ef:af:00",
"name": "PC TEST 1",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpusrb0a1j/qemu-system-x86_64",
"ram": 256,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/7d920e6d-b929-4a3b-a299-a9641030efaf",
"vm_id": "7d920e6d-b929-4a3b-a299-a9641030efaf"
}

13
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstop.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b9ad593f-25d6-4942-9379-6c7e8d0c82ca/stop' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b9ad593f-25d6-4942-9379-6c7e8d0c82ca/stop HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/stop

13
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidsuspend.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5ee4acd6-bc2d-489a-b3c5-4133351d9425/suspend' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5ee4acd6-bc2d-489a-b3c5-4133351d9425/suspend HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/suspend

33
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvms.txt
Unescape View File

@ -1,33 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms' -d '{"linked_clone": false, "name": "VM1", "vmname": "VM1"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1
{
"linked_clone": false,
"name": "VM1",
"vmname": "VM1"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 409
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms
{
"acpi_shutdown": false,
"adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
"adapters": 0,
"console": 2001,
"enable_remote_console": false,
"headless": false,
"name": "VM1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 0,
"use_any_adapter": false,
"vm_directory": null,
"vm_id": "abab4e24-e383-441d-94c6-f652c42bd118",
"vmname": "VM1"
}

25
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,25 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/eb5565b0-a548-470d-9e4c-221b1e5d82a5/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/eb5565b0-a548-470d-9e4c-221b1e5d82a5/adapters/0/ports/0/nio HTTP/1.1
{
"lport": 4242,
"rhost": "127.0.0.1",
"rport": 4343,
"type": "nio_udp"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 89
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
{
"lport": 4242,
"rhost": "127.0.0.1",
"rport": 4343,
"type": "nio_udp"
}

13
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidreload.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/b179e3b1-87b6-4dcc-a3de-1ad9e89358c4/reload' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/b179e3b1-87b6-4dcc-a3de-1ad9e89358c4/reload HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/reload

13
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidresume.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e6529446-ab5d-4190-a139-244c8a67c9c7/resume' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e6529446-ab5d-4190-a139-244c8a67c9c7/resume HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/resume

13
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstart.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e90e3431-d33b-48c1-b209-a020ef8bfb3b/start' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e90e3431-d33b-48c1-b209-a020ef8bfb3b/start HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/start

13
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstop.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f9284ef5-ac37-4fc1-80ec-557601b73014/stop' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f9284ef5-ac37-4fc1-80ec-557601b73014/stop HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/stop

13
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidsuspend.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c678bfc1-e72f-4f98-a2f1-3c7d8045b314/suspend' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c678bfc1-e72f-4f98-a2f1-3c7d8045b314/suspend HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/suspend

28
docs/api/examples/hypervisor_post_projectsprojectidvpcsvms.txt
Unescape View File

@ -1,28 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms' -d '{"name": "PC TEST 1"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1
{
"name": "PC TEST 1"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 485
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms
{
"command_line": "",
"console": 2010,
"console_type": "telnet",
"name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/0df154bc-6b88-4a64-a2ac-98bb4d533080",
"vm_id": "0df154bc-6b88-4a64-a2ac-98bb4d533080"
}

25
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
Unescape View File

@ -1,25 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/92d44e75-bf67-4af4-bb8a-5d37a11910a7/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/92d44e75-bf67-4af4-bb8a-5d37a11910a7/adapters/0/ports/0/nio HTTP/1.1
{
"lport": 4242,
"rhost": "127.0.0.1",
"rport": 4343,
"type": "nio_udp"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 89
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/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"
}

13
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidreload.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/878612a6-3fa2-40a6-9139-a7b0e9e8e240/reload' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/878612a6-3fa2-40a6-9139-a7b0e9e8e240/reload HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/reload

26
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt
Unescape View File

@ -1,26 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/0dbd6567-d8ab-42e2-b4c5-353ca46b8ebd/start' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/0dbd6567-d8ab-42e2-b4c5-353ca46b8ebd/start HTTP/1.1
{}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 485
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/start
{
"command_line": "",
"console": 2010,
"console_type": "telnet",
"name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/0dbd6567-d8ab-42e2-b4c5-353ca46b8ebd",
"vm_id": "0dbd6567-d8ab-42e2-b4c5-353ca46b8ebd"
}

13
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstop.txt
Unescape View File

@ -1,13 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/258a6795-534b-4f3c-a201-9a5a880120c7/stop' -d '{}'
POST /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/258a6795-534b-4f3c-a201-9a5a880120c7/stop HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/stop

22
docs/api/examples/hypervisor_post_qemuimg.txt
Unescape View File

@ -1,22 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/qemu/img' -d '{"cluster_size": 64, "format": "qcow2", "lazy_refcounts": "off", "path": "/tmp/hda.qcow2", "preallocation": "metadata", "qemu_img": "/tmp/qemu-img", "refcount_bits": 12, "size": 100}'
POST /v2/hypervisor/qemu/img HTTP/1.1
{
"cluster_size": 64,
"format": "qcow2",
"lazy_refcounts": "off",
"path": "/tmp/hda.qcow2",
"preallocation": "metadata",
"qemu_img": "/tmp/qemu-img",
"refcount_bits": 12,
"size": 100
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/qemu/img

19
docs/api/examples/hypervisor_post_version.txt
Unescape View File

@ -1,19 +0,0 @@
curl -i -X POST 'http://localhost:8000/v2/hypervisor/version' -d '{"version": "1.5.0dev1"}'
POST /v2/hypervisor/version HTTP/1.1
{
"version": "1.5.0dev1"
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 30
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/version
{
"version": "1.5.0dev1"
}

21
docs/api/examples/hypervisor_put_projectsprojectid.txt
Unescape View File

@ -1,21 +0,0 @@
curl -i -X PUT 'http://localhost:8000/v2/hypervisor/projects/90010203-0405-0607-0809-0a0b0c0d0e0b' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-29/test_update_path_project_non_l0"}'
PUT /v2/hypervisor/projects/90010203-0405-0607-0809-0a0b0c0d0e0b HTTP/1.1
{
"name": "second_name",
"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-29/test_update_path_project_non_l0"
}
HTTP/1.1 403
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 96
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}
{
"message": "You are not allowed to modify the project directory path",
"status": 403
}

33
docs/api/examples/hypervisor_put_projectsprojectiddockervmsvmid.txt
Unescape View File

@ -1,33 +0,0 @@
curl -i -X PUT 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/2e306044-f567-47d5-a484-2da89c0f769b' -d '{"console": 2003, "environment": "GNS3=1\nGNS4=0", "name": "test", "start_command": "yes"}'
PUT /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/2e306044-f567-47d5-a484-2da89c0f769b HTTP/1.1
{
"console": 2003,
"environment": "GNS3=1\nGNS4=0",
"name": "test",
"start_command": "yes"
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 531
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}
{
"adapters": 2,
"aux": 2002,
"console": 2003,
"console_type": "telnet",
"container_id": "8bd8153ea8f5",
"environment": "GNS3=1\nGNS4=0",
"image": "nginx",
"name": "test",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"start_command": "yes",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphaiimisv/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/docker/2e306044-f567-47d5-a484-2da89c0f769b",
"vm_id": "2e306044-f567-47d5-a484-2da89c0f769b"
}

44
docs/api/examples/hypervisor_put_projectsprojectidiouvmsvmid.txt
Unescape View File

@ -1,44 +0,0 @@
curl -i -X PUT 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/f3b53fd5-aecd-4fa3-a309-7ff7a95cd1ca' -d '{"console": 2002, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}'
PUT /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/f3b53fd5-aecd-4fa3-a309-7ff7a95cd1ca HTTP/1.1
{
"console": 2002,
"ethernet_adapters": 4,
"iourc_content": "test",
"l1_keepalives": true,
"name": "test",
"nvram": 2048,
"ram": 512,
"serial_adapters": 0,
"startup_config_content": "hostname test",
"use_default_iou_values": true
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 718
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}
{
"command_line": "",
"console": 2002,
"ethernet_adapters": 4,
"iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmppwv76w68/iourc",
"l1_keepalives": true,
"md5sum": null,
"name": "test",
"nvram": 2048,
"path": "iou.bin",
"private_config": null,
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 512,
"serial_adapters": 0,
"startup_config": "startup-config.cfg",
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphaiimisv/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/f3b53fd5-aecd-4fa3-a309-7ff7a95cd1ca",
"vm_id": "f3b53fd5-aecd-4fa3-a309-7ff7a95cd1ca"
}

61
docs/api/examples/hypervisor_put_projectsprojectidqemuvmsvmid.txt
Unescape View File

@ -1,61 +0,0 @@
curl -i -X PUT 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/80dba7a3-62f4-4ff0-9c83-4dbe38ae647f' -d '{"console": 2002, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}'
PUT /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/80dba7a3-62f4-4ff0-9c83-4dbe38ae647f HTTP/1.1
{
"console": 2002,
"hdb_disk_image": "linux.img",
"name": "test",
"ram": 1024
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 1391
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}
{
"acpi_shutdown": false,
"adapter_type": "e1000",
"adapters": 1,
"boot_priority": "c",
"cdrom_image": "",
"cdrom_image_md5sum": null,
"command_line": "",
"console": 2002,
"console_type": "telnet",
"cpu_throttling": 0,
"cpus": 1,
"hda_disk_image": "",
"hda_disk_image_md5sum": null,
"hda_disk_interface": "ide",
"hdb_disk_image": "linux.img",
"hdb_disk_image_md5sum": null,
"hdb_disk_interface": "ide",
"hdc_disk_image": "",
"hdc_disk_image_md5sum": null,
"hdc_disk_interface": "ide",
"hdd_disk_image": "",
"hdd_disk_image_md5sum": null,
"hdd_disk_interface": "ide",
"initrd": "",
"initrd_md5sum": null,
"kernel_command_line": "",
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:64:7f:00",
"name": "test",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpusrb0a1j/qemu-system-x86_64",
"ram": 1024,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/80dba7a3-62f4-4ff0-9c83-4dbe38ae647f",
"vm_id": "80dba7a3-62f4-4ff0-9c83-4dbe38ae647f"
}

32
docs/api/examples/hypervisor_put_projectsprojectidvirtualboxvmsvmid.txt
Unescape View File

@ -1,32 +0,0 @@
curl -i -X PUT 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ca8d44c3-d536-4649-a7f2-317c915b81f5' -d '{"console": 2011, "name": "test"}'
PUT /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ca8d44c3-d536-4649-a7f2-317c915b81f5 HTTP/1.1
{
"console": 2011,
"name": "test"
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 413
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}
{
"acpi_shutdown": false,
"adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
"adapters": 0,
"console": 2011,
"enable_remote_console": false,
"headless": false,
"name": "test",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 0,
"use_any_adapter": false,
"vm_directory": null,
"vm_id": "ca8d44c3-d536-4649-a7f2-317c915b81f5",
"vmname": "VMTEST"
}

30
docs/api/examples/hypervisor_put_projectsprojectidvpcsvmsvmid.txt
Unescape View File

@ -1,30 +0,0 @@
curl -i -X PUT 'http://localhost:8000/v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f444597-b557-498a-9771-ab87707d3807' -d '{"console": 2012, "name": "test", "startup_script": "ip 192.168.1.1"}'
PUT /v2/hypervisor/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f444597-b557-498a-9771-ab87707d3807 HTTP/1.1
{
"console": 2012,
"name": "test",
"startup_script": "ip 192.168.1.1"
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 501
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}
{
"command_line": "",
"console": 2012,
"console_type": "telnet",
"name": "test",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": "ip 192.168.1.1",
"startup_script_path": "startup.vpc",
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpynsw_k3v/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/6f444597-b557-498a-9771-ab87707d3807",
"vm_id": "6f444597-b557-498a-9771-ab87707d3807"
}

8
docs/api/v2/controller/hypervisor.rst
Unescape View File

@ -1,8 +0,0 @@
Hypervisor
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
hypervisor/*

42
docs/api/v2/controller/hypervisor/s.rst
Unescape View File

@ -1,42 +0,0 @@
/v2/hypervisors
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Register a hypervisor
Response status codes
**********************
- **201**: Hypervisor added
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>password</td> <td> </td> <td>string</td> <td>Password for auth</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>True if controller is connected to the hypervisor</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote hypervisor</td> </tr>
</table>

14
docs/api/v2/controller/hypervisor/sshutdown.rst
Unescape View File

@ -1,14 +0,0 @@
/v2/hypervisors/shutdown
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisors/shutdown
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Shutdown the local hypervisor
Response status codes
**********************
- **201**: Hypervisor is shutting down
- **403**: Hypervisor shutdown refused

4
docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
Unescape View File

@ -9,13 +9,13 @@ Delete a link instance
Parameters
**********
- **link_id**: UUID of the link
- **project_id**: UUID for the project
- **link_id**: UUID of the link
Response status codes
**********************
- **400**: Invalid request
- **201**: Link deleted
- **204**: Link deleted
Sample session
***************

20
docs/api/v2/controller/project/projectsprojectid.rst
Unescape View File

@ -3,6 +3,26 @@
.. contents::
GET /v2/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get the project
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **200**: The project exist
- **404**: The project doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectid.txt
DELETE /v2/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a project from disk

4
docs/api/v2/controller/vm/projectsprojectidvms.rst
Unescape View File

@ -22,9 +22,9 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Hypervisor identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Hypervisor identifier</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VM name</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
@ -38,9 +38,9 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Hypervisor identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Hypervisor identifier</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VM name</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>

8
docs/api/v2/hypervisor/config.rst
Unescape View File

@ -1,8 +0,0 @@
Config
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
config/*

20
docs/api/v2/hypervisor/config/configreload.rst
Unescape View File

@ -1,20 +0,0 @@
/v2/hypervisor/config/reload
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/config/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Check if version is the same as the server
Response status codes
**********************
- **201**: Config reload
- **403**: Config reload refused
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_configreload.txt

8
docs/api/v2/hypervisor/docker.rst
Unescape View File

@ -1,8 +0,0 @@
Docker
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
docker/*

13
docs/api/v2/hypervisor/docker/dockerimages.rst
Unescape View File

@ -1,13 +0,0 @@
/v2/hypervisor/docker/images
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/hypervisor/docker/images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get all available Docker images
Response status codes
**********************
- **200**: Success

56
docs/api/v2/hypervisor/docker/projectsprojectiddockervms.rst
Unescape View File

@ -1,56 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new Docker container
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>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>

20
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsid.rst
Unescape View File

@ -1,20 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
DELETE /v2/hypervisor/projects/**{project_id}**/docker/vms/**{id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a Docker container
Parameters
**********
- **project_id**: UUID for the project
- **id**: ID for the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted

57
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidreload.rst
Unescape View File

@ -1,57 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{id}/reload
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms/**{id}**/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Restart a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance restarted
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>

57
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstart.rst
Unescape View File

@ -1,57 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{id}/start
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms/**{id}**/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>

57
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstop.rst
Unescape View File

@ -1,57 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{id}/stop
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms/**{id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>

57
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidsuspend.rst
Unescape View File

@ -1,57 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{id}/suspend
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms/**{id}**/suspend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Pause a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance paused
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>

62
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmid.rst
Unescape View File

@ -1,62 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
PUT /v2/hypervisor/projects/**{project_id}**/docker/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a Docker instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
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>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectiddockervmsvmid.txt

52
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst
Unescape View File

@ -1,52 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a NIO to a Docker container
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/hypervisor/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove a NIO from a Docker container
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt

39
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
Unescape View File

@ -1,39 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a packet capture on a IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
- **200**: Capture started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **409**: VM not started
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>
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt

29
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
Unescape View File

@ -1,29 +0,0 @@
/v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a packet capture on a IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
- **409**: VM not started
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt

8
docs/api/v2/hypervisor/dynamips_device.rst
Unescape View File

@ -1,8 +0,0 @@
Dynamips device
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
dynamips_device/*

43
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevices.rst
Unescape View File

@ -1,43 +0,0 @@
/v2/hypervisor/projects/{project_id}/dynamips/devices
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/dynamips/devices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new Dynamips device 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>device_id</td> <td> </td> <td></td> <td>Dynamips device instance identifier</td> </tr>
<tr><td>device_type</td> <td>&#10004;</td> <td>string</td> <td>Dynamips device type</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Dynamips device name</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>device_id</td> <td>&#10004;</td> <td>string</td> <td>Dynamips router instance UUID</td> </tr>
<tr><td>mappings</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Dynamips device instance name</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
</table>

107
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst
Unescape View File

@ -1,107 +0,0 @@
/v2/hypervisor/projects/{project_id}/dynamips/devices/{device_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/hypervisor/projects/**{project_id}**/dynamips/devices/**{device_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
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>device_id</td> <td>&#10004;</td> <td>string</td> <td>Dynamips router instance UUID</td> </tr>
<tr><td>mappings</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Dynamips device instance name</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
</table>
PUT /v2/hypervisor/projects/**{project_id}**/dynamips/devices/**{device_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
- **200**: Instance updated
- **400**: Invalid request
- **404**: Instance doesn't exist
- **409**: Conflict
Input
*******
Types
+++++++++
EthernetSwitchPort
^^^^^^^^^^^^^^^^^^^^^^
Ethernet switch port
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>ethertype</td> <td> </td> <td>enum</td> <td>Possible values: , 0x8100, 0x88A8, 0x9100, 0x9200</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Port number</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: access, dot1q, qinq</td> </tr>
<tr><td>vlan</td> <td>&#10004;</td> <td>integer</td> <td>VLAN number</td> </tr>
</table>
Body
+++++++++
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Dynamips device instance name</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>device_id</td> <td>&#10004;</td> <td>string</td> <td>Dynamips router instance UUID</td> </tr>
<tr><td>mappings</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Dynamips device instance name</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
</table>
DELETE /v2/hypervisor/projects/**{project_id}**/dynamips/devices/**{device_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted

151
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst
Unescape View File

@ -1,151 +0,0 @@
/v2/hypervisor/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/nio
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a NIO to a Dynamips device instance
Parameters
**********
- **port_number**: Port on the device
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **404**: Instance doesn't exist
Input
*******
Types
+++++++++
Ethernet
^^^^^^^^^^^^^^^^^^^^^^
Generic Ethernet Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>ethernet_device</td> <td>&#10004;</td> <td>string</td> <td>Ethernet device name e.g. eth0</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_generic_ethernet</td> </tr>
</table>
LinuxEthernet
^^^^^^^^^^^^^^^^^^^^^^
Linux Ethernet Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>ethernet_device</td> <td>&#10004;</td> <td>string</td> <td>Ethernet device name e.g. eth0</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_linux_ethernet</td> </tr>
</table>
NAT
^^^^^^^^^^^^^^^^^^^^^^
NAT Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_nat</td> </tr>
</table>
NULL
^^^^^^^^^^^^^^^^^^^^^^
NULL Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_null</td> </tr>
</table>
TAP
^^^^^^^^^^^^^^^^^^^^^^
TAP Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>tap_device</td> <td>&#10004;</td> <td>string</td> <td>TAP device name e.g. tap0</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_tap</td> </tr>
</table>
UDP
^^^^^^^^^^^^^^^^^^^^^^
UDP Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>lport</td> <td>&#10004;</td> <td>integer</td> <td>Local port</td> </tr>
<tr><td>rhost</td> <td>&#10004;</td> <td>string</td> <td>Remote host</td> </tr>
<tr><td>rport</td> <td>&#10004;</td> <td>integer</td> <td>Remote port</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_udp</td> </tr>
</table>
UNIX
^^^^^^^^^^^^^^^^^^^^^^
UNIX Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local_file</td> <td>&#10004;</td> <td>string</td> <td>path to the UNIX socket file (local)</td> </tr>
<tr><td>remote_file</td> <td>&#10004;</td> <td>string</td> <td>path to the UNIX socket file (remote)</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_unix</td> </tr>
</table>
VDE
^^^^^^^^^^^^^^^^^^^^^^
VDE Network Input/Output
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>control_file</td> <td>&#10004;</td> <td>string</td> <td>path to the VDE control file</td> </tr>
<tr><td>local_file</td> <td>&#10004;</td> <td>string</td> <td>path to the VDE control file</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: nio_vde</td> </tr>
</table>
Body
+++++++++
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>mappings</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>nio</td> <td>&#10004;</td> <td>UDP, Ethernet, LinuxEthernet, NAT, TAP, UNIX, VDE, NULL</td> <td></td> </tr>
<tr><td>port_settings</td> <td> </td> <td>object</td> <td>Ethernet switch</td> </tr>
</table>
DELETE /v2/hypervisor/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove a NIO from a Dynamips device instance
Parameters
**********
- **port_number**: Port on the device
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted

31
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst
Unescape View File

@ -1,31 +0,0 @@
/v2/hypervisor/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/start_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/start_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a packet capture on a Dynamips device instance
Parameters
**********
- **port_number**: Port on the device
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
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>
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
</table>

21
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst
Unescape View File

@ -1,21 +0,0 @@
/v2/hypervisor/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/stop_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/stop_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a packet capture on a Dynamips device instance
Parameters
**********
- **port_number**: Port on the device
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped

Some files were not shown because too many files have changed in this diff Show More

Write Preview
Loading…
Cancel
Save