diff --git a/docs/api/examples/controller_delete_projectsprojectid.txt b/docs/api/examples/controller_delete_projectsprojectid.txt index f1daafba..bc1a6a20 100644 --- a/docs/api/examples/controller_delete_projectsprojectid.txt +++ b/docs/api/examples/controller_delete_projectsprojectid.txt @@ -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} diff --git a/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt b/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt index ef5eddde..a38f6a71 100644 --- a/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt +++ b/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt @@ -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": [] -} diff --git a/docs/api/examples/controller_get_version.txt b/docs/api/examples/controller_get_version.txt index 5b56211f..2dadbb58 100644 --- a/docs/api/examples/controller_get_version.txt +++ b/docs/api/examples/controller_get_version.txt @@ -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" } diff --git a/docs/api/examples/controller_post_hypervisors.txt b/docs/api/examples/controller_post_hypervisors.txt deleted file mode 100644 index 2052291c..00000000 --- a/docs/api/examples/controller_post_hypervisors.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/controller_post_projects.txt b/docs/api/examples/controller_post_projects.txt index c7d21b66..c53dc744 100644 --- a/docs/api/examples/controller_post_projects.txt +++ b/docs/api/examples/controller_post_projects.txt @@ -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 { diff --git a/docs/api/examples/controller_post_projectsprojectidclose.txt b/docs/api/examples/controller_post_projectsprojectidclose.txt index 0e2f7917..802a0268 100644 --- a/docs/api/examples/controller_post_projectsprojectidclose.txt +++ b/docs/api/examples/controller_post_projectsprojectidclose.txt @@ -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 diff --git a/docs/api/examples/controller_post_projectsprojectidcommit.txt b/docs/api/examples/controller_post_projectsprojectidcommit.txt index 6db8b18b..d5f61c01 100644 --- a/docs/api/examples/controller_post_projectsprojectidcommit.txt +++ b/docs/api/examples/controller_post_projectsprojectidcommit.txt @@ -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 diff --git a/docs/api/examples/controller_post_projectsprojectidlinks.txt b/docs/api/examples/controller_post_projectsprojectidlinks.txt index d59ca9ca..76d89602 100644 --- a/docs/api/examples/controller_post_projectsprojectidlinks.txt +++ b/docs/api/examples/controller_post_projectsprojectidlinks.txt @@ -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" } ] } diff --git a/docs/api/examples/controller_post_projectsprojectidvms.txt b/docs/api/examples/controller_post_projectsprojectidvms.txt index 190ca3e7..1a004c18 100644 --- a/docs/api/examples/controller_post_projectsprojectidvms.txt +++ b/docs/api/examples/controller_post_projectsprojectidvms.txt @@ -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" } diff --git a/docs/api/examples/controller_post_version.txt b/docs/api/examples/controller_post_version.txt index 4f31fc30..87a11127 100644 --- a/docs/api/examples/controller_post_version.txt +++ b/docs/api/examples/controller_post_version.txt @@ -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" } diff --git a/docs/api/examples/hypervisor_delete_projectsprojectid.txt b/docs/api/examples/hypervisor_delete_projectsprojectid.txt deleted file mode 100644 index f8d6d157..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectid.txt +++ /dev/null @@ -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} - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index 8b285df1..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmid.txt b/docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmid.txt deleted file mode 100644 index 519417c5..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmid.txt +++ /dev/null @@ -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} - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index 1c0a8832..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmid.txt deleted file mode 100644 index cfaf1b58..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmid.txt +++ /dev/null @@ -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} - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index 25e7d3d1..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index 1c3e77c6..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmid.txt deleted file mode 100644 index c9d11021..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmid.txt +++ /dev/null @@ -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} - diff --git a/docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index 94ff7cbb..00000000 --- a/docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_get_interfaces.txt b/docs/api/examples/hypervisor_get_interfaces.txt deleted file mode 100644 index 30703b3a..00000000 --- a/docs/api/examples/hypervisor_get_interfaces.txt +++ /dev/null @@ -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" - } -] diff --git a/docs/api/examples/hypervisor_get_iouvms.txt b/docs/api/examples/hypervisor_get_iouvms.txt deleted file mode 100644 index a9d50c57..00000000 --- a/docs/api/examples/hypervisor_get_iouvms.txt +++ /dev/null @@ -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" - } -] diff --git a/docs/api/examples/hypervisor_get_projects.txt b/docs/api/examples/hypervisor_get_projects.txt deleted file mode 100644 index fb3cdd44..00000000 --- a/docs/api/examples/hypervisor_get_projects.txt +++ /dev/null @@ -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 - } -] diff --git a/docs/api/examples/hypervisor_get_projectsprojectid.txt b/docs/api/examples/hypervisor_get_projectsprojectid.txt deleted file mode 100644 index 7c9cae8c..00000000 --- a/docs/api/examples/hypervisor_get_projectsprojectid.txt +++ /dev/null @@ -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 -} diff --git a/docs/api/examples/hypervisor_get_projectsprojectidfiles.txt b/docs/api/examples/hypervisor_get_projectsprojectidfiles.txt deleted file mode 100644 index 693e6ab3..00000000 --- a/docs/api/examples/hypervisor_get_projectsprojectidfiles.txt +++ /dev/null @@ -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" - } -] diff --git a/docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmid.txt b/docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmid.txt deleted file mode 100644 index 9de11739..00000000 --- a/docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmidconfigs.txt b/docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmidconfigs.txt deleted file mode 100644 index de112203..00000000 --- a/docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmidconfigs.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_get_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/hypervisor_get_projectsprojectidqemuvmsvmid.txt deleted file mode 100644 index 9791fcd9..00000000 --- a/docs/api/examples/hypervisor_get_projectsprojectidqemuvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_get_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/hypervisor_get_projectsprojectidvirtualboxvmsvmid.txt deleted file mode 100644 index fae2532f..00000000 --- a/docs/api/examples/hypervisor_get_projectsprojectidvirtualboxvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_get_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/hypervisor_get_projectsprojectidvpcsvmsvmid.txt deleted file mode 100644 index 28e79a29..00000000 --- a/docs/api/examples/hypervisor_get_projectsprojectidvpcsvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_get_qemubinaries.txt b/docs/api/examples/hypervisor_get_qemubinaries.txt deleted file mode 100644 index 95c7ee2c..00000000 --- a/docs/api/examples/hypervisor_get_qemubinaries.txt +++ /dev/null @@ -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" - } -] diff --git a/docs/api/examples/hypervisor_get_qemucapabilities.txt b/docs/api/examples/hypervisor_get_qemucapabilities.txt deleted file mode 100644 index 31f1dd98..00000000 --- a/docs/api/examples/hypervisor_get_qemucapabilities.txt +++ /dev/null @@ -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" - ] -} diff --git a/docs/api/examples/hypervisor_get_version.txt b/docs/api/examples/hypervisor_get_version.txt deleted file mode 100644 index 975d52fe..00000000 --- a/docs/api/examples/hypervisor_get_version.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_configreload.txt b/docs/api/examples/hypervisor_post_configreload.txt deleted file mode 100644 index 7f1cd0df..00000000 --- a/docs/api/examples/hypervisor_post_configreload.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projects.txt b/docs/api/examples/hypervisor_post_projects.txt deleted file mode 100644 index b808beaa..00000000 --- a/docs/api/examples/hypervisor_post_projects.txt +++ /dev/null @@ -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 -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidclose.txt b/docs/api/examples/hypervisor_post_projectsprojectidclose.txt deleted file mode 100644 index 81aea2f7..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidclose.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidcommit.txt b/docs/api/examples/hypervisor_post_projectsprojectidcommit.txt deleted file mode 100644 index 2055f5e0..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidcommit.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index 824cbb73..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt deleted file mode 100644 index c2c815f4..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt deleted file mode 100644 index 117e17a8..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidiouvms.txt b/docs/api/examples/hypervisor_post_projectsprojectidiouvms.txt deleted file mode 100644 index e524aa8f..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidiouvms.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index a15f7f8f..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt deleted file mode 100644 index 9ef3784c..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt deleted file mode 100644 index e880507e..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidreload.txt b/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidreload.txt deleted file mode 100644 index 081994dd..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidreload.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstart.txt b/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstart.txt deleted file mode 100644 index 1efcf5ec..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstart.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstop.txt b/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstop.txt deleted file mode 100644 index dcc6b035..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstop.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidportsudp.txt b/docs/api/examples/hypervisor_post_projectsprojectidportsudp.txt deleted file mode 100644 index 5850fcf6..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidportsudp.txt +++ /dev/null @@ -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 -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidqemuvms.txt b/docs/api/examples/hypervisor_post_projectsprojectidqemuvms.txt deleted file mode 100644 index 54524f5e..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidqemuvms.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index fc60646a..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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 -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidreload.txt b/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidreload.txt deleted file mode 100644 index cf9b94e7..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidreload.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidresume.txt b/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidresume.txt deleted file mode 100644 index b5358597..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidresume.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstart.txt b/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstart.txt deleted file mode 100644 index fc928c48..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstart.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstop.txt b/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstop.txt deleted file mode 100644 index e69d3a33..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstop.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidsuspend.txt b/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidsuspend.txt deleted file mode 100644 index 7b7711a6..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidsuspend.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvms.txt b/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvms.txt deleted file mode 100644 index 7573a6dd..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvms.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index a612d4dd..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidreload.txt b/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidreload.txt deleted file mode 100644 index 90a1ccff..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidreload.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidresume.txt b/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidresume.txt deleted file mode 100644 index 6366c83e..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidresume.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstart.txt b/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstart.txt deleted file mode 100644 index c14395a6..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstart.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstop.txt b/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstop.txt deleted file mode 100644 index da8c9f7d..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstop.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidsuspend.txt b/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidsuspend.txt deleted file mode 100644 index 3217b364..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidsuspend.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvms.txt b/docs/api/examples/hypervisor_post_projectsprojectidvpcsvms.txt deleted file mode 100644 index 03d08168..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvms.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt deleted file mode 100644 index ba400c14..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidreload.txt b/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidreload.txt deleted file mode 100644 index bf09ef46..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidreload.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt b/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt deleted file mode 100644 index b0ccbea9..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstop.txt b/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstop.txt deleted file mode 100644 index 513ba82e..00000000 --- a/docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstop.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_qemuimg.txt b/docs/api/examples/hypervisor_post_qemuimg.txt deleted file mode 100644 index 67674a6c..00000000 --- a/docs/api/examples/hypervisor_post_qemuimg.txt +++ /dev/null @@ -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 - diff --git a/docs/api/examples/hypervisor_post_version.txt b/docs/api/examples/hypervisor_post_version.txt deleted file mode 100644 index 3ab4ae45..00000000 --- a/docs/api/examples/hypervisor_post_version.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_put_projectsprojectid.txt b/docs/api/examples/hypervisor_put_projectsprojectid.txt deleted file mode 100644 index 58802cbf..00000000 --- a/docs/api/examples/hypervisor_put_projectsprojectid.txt +++ /dev/null @@ -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 -} diff --git a/docs/api/examples/hypervisor_put_projectsprojectiddockervmsvmid.txt b/docs/api/examples/hypervisor_put_projectsprojectiddockervmsvmid.txt deleted file mode 100644 index 9a87b881..00000000 --- a/docs/api/examples/hypervisor_put_projectsprojectiddockervmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_put_projectsprojectidiouvmsvmid.txt b/docs/api/examples/hypervisor_put_projectsprojectidiouvmsvmid.txt deleted file mode 100644 index 84794cae..00000000 --- a/docs/api/examples/hypervisor_put_projectsprojectidiouvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_put_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/hypervisor_put_projectsprojectidqemuvmsvmid.txt deleted file mode 100644 index faae44cd..00000000 --- a/docs/api/examples/hypervisor_put_projectsprojectidqemuvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_put_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/hypervisor_put_projectsprojectidvirtualboxvmsvmid.txt deleted file mode 100644 index 319db5d7..00000000 --- a/docs/api/examples/hypervisor_put_projectsprojectidvirtualboxvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/examples/hypervisor_put_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/hypervisor_put_projectsprojectidvpcsvmsvmid.txt deleted file mode 100644 index d445f543..00000000 --- a/docs/api/examples/hypervisor_put_projectsprojectidvpcsvmsvmid.txt +++ /dev/null @@ -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" -} diff --git a/docs/api/v2/controller/hypervisor.rst b/docs/api/v2/controller/hypervisor.rst deleted file mode 100644 index e921097b..00000000 --- a/docs/api/v2/controller/hypervisor.rst +++ /dev/null @@ -1,8 +0,0 @@ -Hypervisor ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - hypervisor/* diff --git a/docs/api/v2/controller/hypervisor/s.rst b/docs/api/v2/controller/hypervisor/s.rst deleted file mode 100644 index f609a964..00000000 --- a/docs/api/v2/controller/hypervisor/s.rst +++ /dev/null @@ -1,42 +0,0 @@ -/v2/hypervisors ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisors -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Register a hypervisor - -Response status codes -********************** -- **201**: Hypervisor added - -Input -******* -.. raw:: html - - - - - - - - - -
Name Mandatory Type Description
host ✔ string Server host
hypervisor_id ✔ string Server identifier
password string Password for auth
port ✔ integer Server port
protocol ✔ enum Possible values: http, https
user string User for auth
- -Output -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
connected boolean True if controller is connected to the hypervisor
host ✔ string Server host
hypervisor_id ✔ string Server identifier
port ✔ integer Server port
protocol ✔ enum Possible values: http, https
user string User for auth
version ['string', 'null'] Version of the GNS3 remote hypervisor
- diff --git a/docs/api/v2/controller/hypervisor/sshutdown.rst b/docs/api/v2/controller/hypervisor/sshutdown.rst deleted file mode 100644 index 5b67b04f..00000000 --- a/docs/api/v2/controller/hypervisor/sshutdown.rst +++ /dev/null @@ -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 - diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst index db0f3667..1db5a39a 100644 --- a/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst +++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst @@ -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 *************** diff --git a/docs/api/v2/controller/project/projectsprojectid.rst b/docs/api/v2/controller/project/projectsprojectid.rst index 9839dd19..e852894e 100644 --- a/docs/api/v2/controller/project/projectsprojectid.rst +++ b/docs/api/v2/controller/project/projectsprojectid.rst @@ -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 diff --git a/docs/api/v2/controller/vm/projectsprojectidvms.rst b/docs/api/v2/controller/vm/projectsprojectidvms.rst index 33d99991..f6f7261d 100644 --- a/docs/api/v2/controller/vm/projectsprojectidvms.rst +++ b/docs/api/v2/controller/vm/projectsprojectidvms.rst @@ -22,9 +22,9 @@ Input + - @@ -38,9 +38,9 @@ Output
Name Mandatory Type Description
compute_id ✔ string Hypervisor identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
hypervisor_id ✔ string Hypervisor identifier
name ✔ string VM name
project_id string Project identifier
properties object Properties specific to an emulator
+ - diff --git a/docs/api/v2/hypervisor/config.rst b/docs/api/v2/hypervisor/config.rst deleted file mode 100644 index 5f404149..00000000 --- a/docs/api/v2/hypervisor/config.rst +++ /dev/null @@ -1,8 +0,0 @@ -Config ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - config/* diff --git a/docs/api/v2/hypervisor/config/configreload.rst b/docs/api/v2/hypervisor/config/configreload.rst deleted file mode 100644 index 38ec104d..00000000 --- a/docs/api/v2/hypervisor/config/configreload.rst +++ /dev/null @@ -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 - diff --git a/docs/api/v2/hypervisor/docker.rst b/docs/api/v2/hypervisor/docker.rst deleted file mode 100644 index c035c8fd..00000000 --- a/docs/api/v2/hypervisor/docker.rst +++ /dev/null @@ -1,8 +0,0 @@ -Docker ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - docker/* diff --git a/docs/api/v2/hypervisor/docker/dockerimages.rst b/docs/api/v2/hypervisor/docker/dockerimages.rst deleted file mode 100644 index 7d719339..00000000 --- a/docs/api/v2/hypervisor/docker/dockerimages.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/docker/images ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/docker/images -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get all available Docker images - -Response status codes -********************** -- **200**: Success - diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervms.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervms.rst deleted file mode 100644 index f1c754a5..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervms.rst +++ /dev/null @@ -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 - -
Name Mandatory Type Description
compute_id ✔ string Hypervisor identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
hypervisor_id ✔ string Hypervisor identifier
name ✔ string VM name
project_id string Project identifier
properties object Properties specific to an emulator
- - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsid.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsid.rst deleted file mode 100644 index 51ce15bb..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsid.rst +++ /dev/null @@ -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 - diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidreload.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidreload.rst deleted file mode 100644 index 7ee62540..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidreload.rst +++ /dev/null @@ -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 - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstart.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstart.rst deleted file mode 100644 index 3ec44fe7..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstart.rst +++ /dev/null @@ -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 - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstop.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstop.rst deleted file mode 100644 index 87de4a3b..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstop.rst +++ /dev/null @@ -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 - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidsuspend.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidsuspend.rst deleted file mode 100644 index a5bb8678..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidsuspend.rst +++ /dev/null @@ -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 - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmid.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmid.rst deleted file mode 100644 index f7a35bd7..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmid.rst +++ /dev/null @@ -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 - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectiddockervmsvmid.txt - diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst deleted file mode 100644 index 20d1a978..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ /dev/null @@ -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 - diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst deleted file mode 100644 index 8e574c8c..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ /dev/null @@ -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 - - - - - -
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt - diff --git a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst deleted file mode 100644 index 53357120..00000000 --- a/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ /dev/null @@ -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 - diff --git a/docs/api/v2/hypervisor/dynamips_device.rst b/docs/api/v2/hypervisor/dynamips_device.rst deleted file mode 100644 index 2135b93d..00000000 --- a/docs/api/v2/hypervisor/dynamips_device.rst +++ /dev/null @@ -1,8 +0,0 @@ -Dynamips device ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - dynamips_device/* diff --git a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevices.rst b/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevices.rst deleted file mode 100644 index bb3a8f75..00000000 --- a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevices.rst +++ /dev/null @@ -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 - - - - - - -
Name Mandatory Type Description
device_id Dynamips device instance identifier
device_type ✔ string Dynamips device type
name ✔ string Dynamips device name
- -Output -******* -.. raw:: html - - - - - - - - -
Name Mandatory Type Description
device_id ✔ string Dynamips router instance UUID
mappings object
name ✔ string Dynamips device instance name
ports array
project_id ✔ string Project UUID
- diff --git a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst b/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst deleted file mode 100644 index 1c7669df..00000000 --- a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst +++ /dev/null @@ -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 - - - - - - - - -
Name Mandatory Type Description
device_id ✔ string Dynamips router instance UUID
mappings object
name ✔ string Dynamips device instance name
ports array
project_id ✔ string Project UUID
- - -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 - - - - - - - -
Name Mandatory Type Description
ethertype enum Possible values: , 0x8100, 0x88A8, 0x9100, 0x9200
port ✔ integer Port number
type ✔ enum Possible values: access, dot1q, qinq
vlan ✔ integer VLAN number
- -Body -+++++++++ -.. raw:: html - - - - - -
Name Mandatory Type Description
name string Dynamips device instance name
ports array
- -Output -******* -.. raw:: html - - - - - - - - -
Name Mandatory Type Description
device_id ✔ string Dynamips router instance UUID
mappings object
name ✔ string Dynamips device instance name
ports array
project_id ✔ string Project UUID
- - -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 - diff --git a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst b/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst deleted file mode 100644 index 54059f3c..00000000 --- a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst +++ /dev/null @@ -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 - - - - - -
Name Mandatory Type Description
ethernet_device ✔ string Ethernet device name e.g. eth0
type ✔ enum Possible values: nio_generic_ethernet
- -LinuxEthernet -^^^^^^^^^^^^^^^^^^^^^^ -Linux Ethernet Network Input/Output - -.. raw:: html - - - - - -
Name Mandatory Type Description
ethernet_device ✔ string Ethernet device name e.g. eth0
type ✔ enum Possible values: nio_linux_ethernet
- -NAT -^^^^^^^^^^^^^^^^^^^^^^ -NAT Network Input/Output - -.. raw:: html - - - - -
Name Mandatory Type Description
type ✔ enum Possible values: nio_nat
- -NULL -^^^^^^^^^^^^^^^^^^^^^^ -NULL Network Input/Output - -.. raw:: html - - - - -
Name Mandatory Type Description
type ✔ enum Possible values: nio_null
- -TAP -^^^^^^^^^^^^^^^^^^^^^^ -TAP Network Input/Output - -.. raw:: html - - - - - -
Name Mandatory Type Description
tap_device ✔ string TAP device name e.g. tap0
type ✔ enum Possible values: nio_tap
- -UDP -^^^^^^^^^^^^^^^^^^^^^^ -UDP Network Input/Output - -.. raw:: html - - - - - - - -
Name Mandatory Type Description
lport ✔ integer Local port
rhost ✔ string Remote host
rport ✔ integer Remote port
type ✔ enum Possible values: nio_udp
- -UNIX -^^^^^^^^^^^^^^^^^^^^^^ -UNIX Network Input/Output - -.. raw:: html - - - - - - -
Name Mandatory Type Description
local_file ✔ string path to the UNIX socket file (local)
remote_file ✔ string path to the UNIX socket file (remote)
type ✔ enum Possible values: nio_unix
- -VDE -^^^^^^^^^^^^^^^^^^^^^^ -VDE Network Input/Output - -.. raw:: html - - - - - - -
Name Mandatory Type Description
control_file ✔ string path to the VDE control file
local_file ✔ string path to the VDE control file
type ✔ enum Possible values: nio_vde
- -Body -+++++++++ -.. raw:: html - - - - - - -
Name Mandatory Type Description
mappings object
nio ✔ UDP, Ethernet, LinuxEthernet, NAT, TAP, UNIX, VDE, NULL
port_settings object Ethernet switch
- - -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 - diff --git a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst b/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst deleted file mode 100644 index 4c7134a6..00000000 --- a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst +++ /dev/null @@ -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 - - - - - -
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
- diff --git a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst b/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst deleted file mode 100644 index 81a35ee1..00000000 --- a/docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst +++ /dev/null @@ -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 - diff --git a/docs/api/v2/hypervisor/dynamips_vm.rst b/docs/api/v2/hypervisor/dynamips_vm.rst deleted file mode 100644 index b8b7c175..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm.rst +++ /dev/null @@ -1,8 +0,0 @@ -Dynamips vm ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - dynamips_vm/* diff --git a/docs/api/v2/hypervisor/dynamips_vm/dynamipsvms.rst b/docs/api/v2/hypervisor/dynamips_vm/dynamipsvms.rst deleted file mode 100644 index 58bfdd18..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/dynamipsvms.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/dynamips/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/dynamips/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the list of Dynamips VMS - -Response status codes -********************** -- **200**: List of Dynamips VM retrieved - diff --git a/docs/api/v2/hypervisor/dynamips_vm/dynamipsvmspath.rst b/docs/api/v2/hypervisor/dynamips_vm/dynamipsvmspath.rst deleted file mode 100644 index 5d760b86..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/dynamipsvmspath.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/dynamips/vms/{path} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/dynamips/vms/**{path}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upload Dynamips image. - -Response status codes -********************** -- **204**: Image uploaded - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvms.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvms.rst deleted file mode 100644 index 094036b4..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvms.rst +++ /dev/null @@ -1,123 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
dynamips_id integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image ✔ string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name ✔ string Dynamips VM instance name
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform ✔ string platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
private_config_content string Content of IOS private configuration file
ram ✔ integer amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
startup_config_content string Content of IOS startup configuration file
system_id string system ID
vm_id Dynamips VM instance identifier
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
dynamips_id ✔ integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name ✔ string Dynamips VM instance name
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
project_id ✔ string Project UUID
ram integer amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
system_id string system ID
vm_directory string
vm_id ✔ string Dynamips router instance UUID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst deleted file mode 100644 index aa3df0c5..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst +++ /dev/null @@ -1,205 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
dynamips_id ✔ integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name ✔ string Dynamips VM instance name
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
project_id ✔ string Project UUID
ram integer amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
system_id string system ID
vm_directory string
vm_id ✔ string Dynamips router instance UUID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- - -PUT /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a Dynamips VM 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
exec_area integer exec area value
idlemax integer idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
power_supplies array Power supplies status
private_config_base64 string private configuration base64 encoded
private_config_content string Content of IOS private configuration file
ram integer amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config_base64 string startup configuration base64 encoded
startup_config_content string Content of IOS startup configuration file
system_id string system ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
dynamips_id ✔ integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name ✔ string Dynamips VM instance name
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
project_id ✔ string Project UUID
ram integer amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
system_id string system ID
vm_directory string
vm_id ✔ string Dynamips router instance UUID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- - -DELETE /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance deleted - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst deleted file mode 100644 index 64aefeff..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ /dev/null @@ -1,40 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a Dynamips VM instance - -Parameters -********** -- **port_number**: Port on the adapter -- **adapter_number**: Adapter where the nio should be added -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - - -DELETE /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a Dynamips VM instance - -Parameters -********** -- **port_number**: Port on the adapter -- **adapter_number**: Adapter from where the nio should be removed -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst deleted file mode 100644 index 73af9886..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ /dev/null @@ -1,32 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a packet capture on a Dynamips 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 - -Input -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
- diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst deleted file mode 100644 index 45066456..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ /dev/null @@ -1,22 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a packet capture on a Dynamips 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 - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst deleted file mode 100644 index 6d49c337..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst +++ /dev/null @@ -1,15 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/auto_idlepc ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/auto_idlepc -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the idlepc proposals - -Response status codes -********************** -- **200**: Best Idle-pc value found -- **400**: Invalid request -- **404**: Instance doesn't exist - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst deleted file mode 100644 index e6b041f5..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst +++ /dev/null @@ -1,25 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/configs ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the startup and private configs content - -Response status codes -********************** -- **200**: Configs retrieved -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
private_config_content ['string', 'null'] Content of the private configuration file
startup_config_content ['string', 'null'] Content of the startup configuration file
- diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst deleted file mode 100644 index 66dd3ca2..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst +++ /dev/null @@ -1,15 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/configs/save ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs/save -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Save the startup and private configs content - -Response status codes -********************** -- **200**: Configs saved -- **400**: Invalid request -- **404**: Instance doesn't exist - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst deleted file mode 100644 index d22fdcd7..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst +++ /dev/null @@ -1,15 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/idlepc_proposals ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/idlepc_proposals -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the idlepc proposals - -Response status codes -********************** -- **200**: Idle-PCs retrieved -- **400**: Invalid request -- **404**: Instance doesn't exist - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst deleted file mode 100644 index 9080c021..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/reload ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/reload -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reload a Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance reloaded - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst deleted file mode 100644 index 4c2c7000..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/resume ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/resume -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Resume a suspended Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance resumed - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst deleted file mode 100644 index 3dd4fa35..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/start ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst deleted file mode 100644 index 4657bcf8..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/stop ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/stop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance stopped - diff --git a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst b/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst deleted file mode 100644 index 35e765e9..00000000 --- a/docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/dynamips/vms/{vm_id}/suspend ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/dynamips/vms/**{vm_id}**/suspend -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Suspend a Dynamips VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance suspended - diff --git a/docs/api/v2/hypervisor/file.rst b/docs/api/v2/hypervisor/file.rst deleted file mode 100644 index d3de2171..00000000 --- a/docs/api/v2/hypervisor/file.rst +++ /dev/null @@ -1,8 +0,0 @@ -File ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - file/* diff --git a/docs/api/v2/hypervisor/file/filesstream.rst b/docs/api/v2/hypervisor/file/filesstream.rst deleted file mode 100644 index 83cedc06..00000000 --- a/docs/api/v2/hypervisor/file/filesstream.rst +++ /dev/null @@ -1,24 +0,0 @@ -/v2/hypervisor/files/stream ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/files/stream -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stream a file from the server - -Response status codes -********************** -- **200**: File retrieved -- **409**: Can't access to file -- **404**: File doesn't exist - -Input -******* -.. raw:: html - - - - -
Name Mandatory Type Description
location ✔ ['string'] File path
- diff --git a/docs/api/v2/hypervisor/iou.rst b/docs/api/v2/hypervisor/iou.rst deleted file mode 100644 index e209e419..00000000 --- a/docs/api/v2/hypervisor/iou.rst +++ /dev/null @@ -1,8 +0,0 @@ -Iou ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - iou/* diff --git a/docs/api/v2/hypervisor/iou/iouvms.rst b/docs/api/v2/hypervisor/iou/iouvms.rst deleted file mode 100644 index f8968590..00000000 --- a/docs/api/v2/hypervisor/iou/iouvms.rst +++ /dev/null @@ -1,19 +0,0 @@ -/v2/hypervisor/iou/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/iou/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the list of IOU VMS - -Response status codes -********************** -- **200**: List of IOU VM retrieved - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_iouvms.txt - diff --git a/docs/api/v2/hypervisor/iou/iouvmspath.rst b/docs/api/v2/hypervisor/iou/iouvmspath.rst deleted file mode 100644 index 73336828..00000000 --- a/docs/api/v2/hypervisor/iou/iouvmspath.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/iou/vms/{path} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/iou/vms/**{path}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upload IOU image. - -Response status codes -********************** -- **204**: Image uploaded - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvms.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvms.rst deleted file mode 100644 index 9e374b55..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvms.rst +++ /dev/null @@ -1,74 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new IOU instance - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
ethernet_adapters integer How many ethernet adapters are connected to the IOU
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
l1_keepalives ['boolean', 'null'] Always up ethernet interface
md5sum ['string', 'null'] Checksum of iou binary
name ✔ string IOU VM name
nvram ['integer', 'null'] Allocated NVRAM KB
path ✔ string Path of iou binary
private_config ['string', 'null'] Path to the private-config of IOU
private_config_content ['string', 'null'] Private-config of IOU
ram ['integer', 'null'] Allocated RAM MB
serial_adapters integer How many serial adapters are connected to the IOU
startup_config ['string', 'null'] Path to the startup-config of IOU
startup_config_content ['string', 'null'] Startup-config of IOU
use_default_iou_values ['boolean', 'null'] Use default IOU values
vm_id IOU VM identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
l1_keepalives ✔ boolean Always up ethernet interface
md5sum ✔ ['string', 'null'] Checksum of iou binary
name ✔ string IOU VM name
nvram ✔ integer Allocated NVRAM KB
path ✔ string Path of iou binary
private_config ✔ ['string', 'null'] Path of the private-config content relative to project directory
project_id ✔ string Project UUID
ram ✔ integer Allocated RAM MB
serial_adapters ✔ integer How many serial adapters are connected to the IOU
startup_config ✔ ['string', 'null'] Path of the startup-config content relative to project directory
use_default_iou_values ✔ ['boolean', 'null'] Use default IOU values
vm_directory string
vm_id ✔ string IOU VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidiouvms.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmid.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmid.rst deleted file mode 100644 index f1d38502..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmid.rst +++ /dev/null @@ -1,142 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a IOU instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
l1_keepalives ✔ boolean Always up ethernet interface
md5sum ✔ ['string', 'null'] Checksum of iou binary
name ✔ string IOU VM name
nvram ✔ integer Allocated NVRAM KB
path ✔ string Path of iou binary
private_config ✔ ['string', 'null'] Path of the private-config content relative to project directory
project_id ✔ string Project UUID
ram ✔ integer Allocated RAM MB
serial_adapters ✔ integer How many serial adapters are connected to the IOU
startup_config ✔ ['string', 'null'] Path of the startup-config content relative to project directory
use_default_iou_values ✔ ['boolean', 'null'] Use default IOU values
vm_directory string
vm_id ✔ string IOU VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectidiouvmsvmid.txt - - -PUT /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a IOU 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 - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
ethernet_adapters ['integer', 'null'] How many ethernet adapters are connected to the IOU
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
l1_keepalives ['boolean', 'null'] Always up ethernet interface
md5sum ['string', 'null'] Checksum of iou binary
name ['string', 'null'] IOU VM name
nvram ['integer', 'null'] Allocated NVRAM KB
path ['string', 'null'] Path of iou binary
private_config_content ['string', 'null'] Private-config of IOU
ram ['integer', 'null'] Allocated RAM MB
serial_adapters ['integer', 'null'] How many serial adapters are connected to the IOU
startup_config_content ['string', 'null'] Startup-config of IOU
use_default_iou_values ['boolean', 'null'] Use default IOU values
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
l1_keepalives ✔ boolean Always up ethernet interface
md5sum ✔ ['string', 'null'] Checksum of iou binary
name ✔ string IOU VM name
nvram ✔ integer Allocated NVRAM KB
path ✔ string Path of iou binary
private_config ✔ ['string', 'null'] Path of the private-config content relative to project directory
project_id ✔ string Project UUID
ram ✔ integer Allocated RAM MB
serial_adapters ✔ integer How many serial adapters are connected to the IOU
startup_config ✔ ['string', 'null'] Path of the startup-config content relative to project directory
use_default_iou_values ✔ ['boolean', 'null'] Use default IOU values
vm_directory string
vm_id ✔ string IOU VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectidiouvmsvmid.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a IOU instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance deleted - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidiouvmsvmid.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst deleted file mode 100644 index 2257f43d..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ /dev/null @@ -1,52 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a IOU instance - -Parameters -********** -- **port_number**: Port where the nio should be added -- **adapter_number**: Network adapter where the nio is located -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a IOU instance - -Parameters -********** -- **port_number**: Port from where the nio should be removed -- **adapter_number**: Network adapter where the nio is located -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst deleted file mode 100644 index 529e00c9..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ /dev/null @@ -1,39 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/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 - - - - - -
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst deleted file mode 100644 index 4f603d0a..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ /dev/null @@ -1,29 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/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_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidconfigs.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidconfigs.rst deleted file mode 100644 index b7d24c8a..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidconfigs.rst +++ /dev/null @@ -1,31 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/configs ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}**/configs -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the startup and private configs content - -Response status codes -********************** -- **200**: Configs retrieved -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
private_config_content ['string', 'null'] Content of the private configuration file
startup_config_content ['string', 'null'] Content of the startup configuration file
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectidiouvmsvmidconfigs.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidconfigssave.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidconfigssave.rst deleted file mode 100644 index c15d2dd5..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidconfigssave.rst +++ /dev/null @@ -1,15 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/configs/save ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}**/configs/save -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Save the startup and private configs content - -Response status codes -********************** -- **200**: Configs saved -- **400**: Invalid request -- **404**: Instance doesn't exist - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidreload.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidreload.rst deleted file mode 100644 index 277675d0..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidreload.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/reload ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}**/reload -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reload a IOU instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance reloaded - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidiouvmsvmidreload.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstart.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstart.rst deleted file mode 100644 index 3a7e9161..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstart.rst +++ /dev/null @@ -1,60 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/start ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a IOU instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Instance started -- **400**: Invalid request -- **404**: Instance doesn't exist - -Input -******* -.. raw:: html - - - - -
Name Mandatory Type Description
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
l1_keepalives ✔ boolean Always up ethernet interface
md5sum ✔ ['string', 'null'] Checksum of iou binary
name ✔ string IOU VM name
nvram ✔ integer Allocated NVRAM KB
path ✔ string Path of iou binary
private_config ✔ ['string', 'null'] Path of the private-config content relative to project directory
project_id ✔ string Project UUID
ram ✔ integer Allocated RAM MB
serial_adapters ✔ integer How many serial adapters are connected to the IOU
startup_config ✔ ['string', 'null'] Path of the startup-config content relative to project directory
use_default_iou_values ✔ ['boolean', 'null'] Use default IOU values
vm_directory string
vm_id ✔ string IOU VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidiouvmsvmidstart.txt - diff --git a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstop.rst b/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstop.rst deleted file mode 100644 index ebce17a6..00000000 --- a/docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstop.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/stop ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/iou/vms/**{vm_id}**/stop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a IOU instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance stopped - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidiouvmsvmidstop.txt - diff --git a/docs/api/v2/hypervisor/network.rst b/docs/api/v2/hypervisor/network.rst deleted file mode 100644 index 1b2ae186..00000000 --- a/docs/api/v2/hypervisor/network.rst +++ /dev/null @@ -1,8 +0,0 @@ -Network ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - network/* diff --git a/docs/api/v2/hypervisor/network/interfaces.rst b/docs/api/v2/hypervisor/network/interfaces.rst deleted file mode 100644 index 8b68876c..00000000 --- a/docs/api/v2/hypervisor/network/interfaces.rst +++ /dev/null @@ -1,19 +0,0 @@ -/v2/hypervisor/interfaces ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/interfaces -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -List all the network interfaces available on the server - -Response status codes -********************** -- **200**: OK - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_interfaces.txt - diff --git a/docs/api/v2/hypervisor/network/projectsprojectidportsudp.rst b/docs/api/v2/hypervisor/network/projectsprojectidportsudp.rst deleted file mode 100644 index 936cb80b..00000000 --- a/docs/api/v2/hypervisor/network/projectsprojectidportsudp.rst +++ /dev/null @@ -1,24 +0,0 @@ -/v2/hypervisor/projects/{project_id}/ports/udp ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/ports/udp -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allocate an UDP port on the server - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **201**: UDP port allocated -- **404**: The project doesn't exist - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidportsudp.txt - diff --git a/docs/api/v2/hypervisor/project.rst b/docs/api/v2/hypervisor/project.rst deleted file mode 100644 index 75acbf89..00000000 --- a/docs/api/v2/hypervisor/project.rst +++ /dev/null @@ -1,8 +0,0 @@ -Project ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - project/* diff --git a/docs/api/v2/hypervisor/project/projects.rst b/docs/api/v2/hypervisor/project/projects.rst deleted file mode 100644 index 30e76af7..00000000 --- a/docs/api/v2/hypervisor/project/projects.rst +++ /dev/null @@ -1,59 +0,0 @@ -/v2/hypervisor/projects ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -List projects opened on the server - -Response status codes -********************** -- **200**: Project list - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projects.txt - - -POST /v2/hypervisor/projects -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new project on the server - -Response status codes -********************** -- **201**: Project created -- **409**: Project already created - -Input -******* -.. raw:: html - - - - - - - -
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Project directory
project_id ['string', 'null'] Project UUID
temporary boolean If project is a temporary project
- -Output -******* -.. raw:: html - - - - - - - -
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Project directory
project_id ✔ string Project UUID
temporary ✔ boolean If project is a temporary project
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projects.txt - diff --git a/docs/api/v2/hypervisor/project/projectsprojectid.rst b/docs/api/v2/hypervisor/project/projectsprojectid.rst deleted file mode 100644 index ea4c94f2..00000000 --- a/docs/api/v2/hypervisor/project/projectsprojectid.rst +++ /dev/null @@ -1,100 +0,0 @@ -/v2/hypervisor/projects/{project_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get project information - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **200**: Success -- **404**: The project doesn't exist - -Output -******* -.. raw:: html - - - - - - - -
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Project directory
project_id ✔ string Project UUID
temporary ✔ boolean If project is a temporary project
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectid.txt - - -PUT /v2/hypervisor/projects/**{project_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a project - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **200**: The project has been updated -- **403**: You are not allowed to modify this property -- **404**: The project doesn't exist - -Input -******* -.. raw:: html - - - - - - -
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Path of the project on the server (work only with --local)
temporary boolean If project is a temporary project
- -Output -******* -.. raw:: html - - - - - - - -
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Project directory
project_id ✔ string Project UUID
temporary ✔ boolean If project is a temporary project
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectid.txt - - -DELETE /v2/hypervisor/projects/**{project_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a project from disk - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **404**: The project doesn't exist -- **204**: Changes have been written on disk - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectid.txt - diff --git a/docs/api/v2/hypervisor/project/projectsprojectidclose.rst b/docs/api/v2/hypervisor/project/projectsprojectidclose.rst deleted file mode 100644 index 7a3cbca3..00000000 --- a/docs/api/v2/hypervisor/project/projectsprojectidclose.rst +++ /dev/null @@ -1,24 +0,0 @@ -/v2/hypervisor/projects/{project_id}/close ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/close -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Close a project - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **404**: The project doesn't exist -- **204**: The project has been closed - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidclose.txt - diff --git a/docs/api/v2/hypervisor/project/projectsprojectidcommit.rst b/docs/api/v2/hypervisor/project/projectsprojectidcommit.rst deleted file mode 100644 index 79c9e997..00000000 --- a/docs/api/v2/hypervisor/project/projectsprojectidcommit.rst +++ /dev/null @@ -1,24 +0,0 @@ -/v2/hypervisor/projects/{project_id}/commit ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/commit -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Write changes on disk - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **404**: The project doesn't exist -- **204**: Changes have been written on disk - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidcommit.txt - diff --git a/docs/api/v2/hypervisor/project/projectsprojectidfiles.rst b/docs/api/v2/hypervisor/project/projectsprojectidfiles.rst deleted file mode 100644 index 0c23c27b..00000000 --- a/docs/api/v2/hypervisor/project/projectsprojectidfiles.rst +++ /dev/null @@ -1,24 +0,0 @@ -/v2/hypervisor/projects/{project_id}/files ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -List files of a project - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **200**: Return list of files -- **404**: The project doesn't exist - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectidfiles.txt - diff --git a/docs/api/v2/hypervisor/project/projectsprojectidfilespath.rst b/docs/api/v2/hypervisor/project/projectsprojectidfilespath.rst deleted file mode 100644 index d242f623..00000000 --- a/docs/api/v2/hypervisor/project/projectsprojectidfilespath.rst +++ /dev/null @@ -1,19 +0,0 @@ -/v2/hypervisor/projects/{project_id}/files/{path:.+} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/files/**{path:.+}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a file of a project - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **200**: Return the file -- **403**: Permission denied -- **404**: The file doesn't exist - diff --git a/docs/api/v2/hypervisor/project/projectsprojectidnotifications.rst b/docs/api/v2/hypervisor/project/projectsprojectidnotifications.rst deleted file mode 100644 index 944ad02d..00000000 --- a/docs/api/v2/hypervisor/project/projectsprojectidnotifications.rst +++ /dev/null @@ -1,18 +0,0 @@ -/v2/hypervisor/projects/{project_id}/notifications ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/notifications -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Receive notifications about the projects - -Parameters -********** -- **project_id**: The UUID of the project - -Response status codes -********************** -- **200**: End of stream -- **404**: The project doesn't exist - diff --git a/docs/api/v2/hypervisor/qemu.rst b/docs/api/v2/hypervisor/qemu.rst deleted file mode 100644 index 5c46b504..00000000 --- a/docs/api/v2/hypervisor/qemu.rst +++ /dev/null @@ -1,8 +0,0 @@ -Qemu ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - qemu/* diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvms.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvms.rst deleted file mode 100644 index d7f6e2d2..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvms.rst +++ /dev/null @@ -1,119 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/qemu/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown ['boolean', 'null'] ACPI shutdown support
adapter_type ['string', 'null'] QEMU adapter type
adapters ['integer', 'null'] number of adapters
boot_priority enum Possible values: c, d, n, cn, cd
cdrom_image string QEMU cdrom image path
cdrom_image_md5sum ['string', 'null'] QEMU cdrom image checksum
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
cpu_throttling ['integer', 'null'] Percentage of CPU allowed for QEMU
cpus ['integer', 'null'] number of vCPUs
hda_disk_image string QEMU hda disk image path
hda_disk_image_md5sum ['string', 'null'] QEMU hda disk image checksum
hda_disk_interface string QEMU hda interface
hdb_disk_image string QEMU hdb disk image path
hdb_disk_image_md5sum ['string', 'null'] QEMU hdb disk image checksum
hdb_disk_interface string QEMU hdb interface
hdc_disk_image string QEMU hdc disk image path
hdc_disk_image_md5sum ['string', 'null'] QEMU hdc disk image checksum
hdc_disk_interface string QEMU hdc interface
hdd_disk_image string QEMU hdd disk image path
hdd_disk_image_md5sum ['string', 'null'] QEMU hdd disk image checksum
hdd_disk_interface string QEMU hdd interface
initrd string QEMU initrd path
initrd_md5sum ['string', 'null'] QEMU initrd path
kernel_command_line ['string', 'null'] QEMU kernel command line
kernel_image string QEMU kernel image path
kernel_image_md5sum ['string', 'null'] QEMU kernel image checksum
legacy_networking ['boolean', 'null'] Use QEMU legagy networking commands (-net syntax)
linked_clone boolean either the VM is a linked clone or not
mac_address ['string', 'null'] QEMU MAC address
name ✔ string QEMU VM instance name
options ['string', 'null'] Additional QEMU options
platform enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null
process_priority enum Possible values: realtime, very high, high, normal, low, very low, null
qemu_path ['string', 'null'] Path to QEMU
ram ['integer', 'null'] amount of RAM in MB
usage string How to use the qemu VM
vm_id QEMU VM identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
boot_priority ✔ enum Possible values: c, d, n, cn, cd
cdrom_image ✔ string QEMU cdrom image path
cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet, vnc
cpu_throttling ✔ integer Percentage of CPU allowed for QEMU
cpus ✔ ['integer', 'null'] number of vCPUs
hda_disk_image ✔ string QEMU hda disk image path
hda_disk_image_md5sum ✔ ['string', 'null'] QEMU hda disk image checksum
hda_disk_interface ✔ string QEMU hda interface
hdb_disk_image ✔ string QEMU hdb disk image path
hdb_disk_image_md5sum ✔ ['string', 'null'] QEMU hdb disk image checksum
hdb_disk_interface ✔ string QEMU hdb interface
hdc_disk_image ✔ string QEMU hdc disk image path
hdc_disk_image_md5sum ✔ ['string', 'null'] QEMU hdc disk image checksum
hdc_disk_interface ✔ string QEMU hdc interface
hdd_disk_image ✔ string QEMU hdd disk image path
hdd_disk_image_md5sum ✔ ['string', 'null'] QEMU hdd disk image checksum
hdd_disk_interface ✔ string QEMU hdd interface
initrd ✔ string QEMU initrd path
initrd_md5sum ✔ ['string', 'null'] QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kernel_image_md5sum ✔ ['string', 'null'] QEMU kernel image checksum
legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax)
mac_address ✔ string QEMU MAC address
name ✔ string QEMU VM instance name
options ✔ string Additional QEMU options
platform ✔ enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
project_id ✔ string Project uuid
qemu_path ✔ string path to QEMU
ram ✔ integer amount of RAM in MB
usage ✔ string How to use the qemu VM
vm_directory ✔ string
vm_id ✔ string QEMU VM uuid
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidqemuvms.txt - diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmid.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmid.rst deleted file mode 100644 index 64175e96..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmid.rst +++ /dev/null @@ -1,211 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
boot_priority ✔ enum Possible values: c, d, n, cn, cd
cdrom_image ✔ string QEMU cdrom image path
cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet, vnc
cpu_throttling ✔ integer Percentage of CPU allowed for QEMU
cpus ✔ ['integer', 'null'] number of vCPUs
hda_disk_image ✔ string QEMU hda disk image path
hda_disk_image_md5sum ✔ ['string', 'null'] QEMU hda disk image checksum
hda_disk_interface ✔ string QEMU hda interface
hdb_disk_image ✔ string QEMU hdb disk image path
hdb_disk_image_md5sum ✔ ['string', 'null'] QEMU hdb disk image checksum
hdb_disk_interface ✔ string QEMU hdb interface
hdc_disk_image ✔ string QEMU hdc disk image path
hdc_disk_image_md5sum ✔ ['string', 'null'] QEMU hdc disk image checksum
hdc_disk_interface ✔ string QEMU hdc interface
hdd_disk_image ✔ string QEMU hdd disk image path
hdd_disk_image_md5sum ✔ ['string', 'null'] QEMU hdd disk image checksum
hdd_disk_interface ✔ string QEMU hdd interface
initrd ✔ string QEMU initrd path
initrd_md5sum ✔ ['string', 'null'] QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kernel_image_md5sum ✔ ['string', 'null'] QEMU kernel image checksum
legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax)
mac_address ✔ string QEMU MAC address
name ✔ string QEMU VM instance name
options ✔ string Additional QEMU options
platform ✔ enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
project_id ✔ string Project uuid
qemu_path ✔ string path to QEMU
ram ✔ integer amount of RAM in MB
usage ✔ string How to use the qemu VM
vm_directory ✔ string
vm_id ✔ string QEMU VM uuid
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectidqemuvmsvmid.txt - - -PUT /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a Qemu VM 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown ['boolean', 'null'] ACPI shutdown support
adapter_type ['string', 'null'] QEMU adapter type
adapters ['integer', 'null'] number of adapters
boot_priority enum Possible values: c, d, n, cn, cd
cdrom_image string QEMU cdrom image path
cdrom_image_md5sum ['string', 'null'] QEMU cdrom image checksum
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
cpu_throttling ['integer', 'null'] Percentage of CPU allowed for QEMU
cpus ['integer', 'null'] number of vCPUs
hda_disk_image string QEMU hda disk image path
hda_disk_image_md5sum ['string', 'null'] QEMU hda disk image checksum
hda_disk_interface string QEMU hda interface
hdb_disk_image string QEMU hdb disk image path
hdb_disk_image_md5sum ['string', 'null'] QEMU hdb disk image checksum
hdb_disk_interface string QEMU hdb interface
hdc_disk_image string QEMU hdc disk image path
hdc_disk_image_md5sum ['string', 'null'] QEMU hdc disk image checksum
hdc_disk_interface string QEMU hdc interface
hdd_disk_image string QEMU hdd disk image path
hdd_disk_image_md5sum ['string', 'null'] QEMU hdd disk image checksum
hdd_disk_interface string QEMU hdd interface
initrd string QEMU initrd path
initrd_md5sum ['string', 'null'] QEMU initrd path
kernel_command_line ['string', 'null'] QEMU kernel command line
kernel_image string QEMU kernel image path
kernel_image_md5sum ['string', 'null'] QEMU kernel image checksum
legacy_networking ['boolean', 'null'] Use QEMU legagy networking commands (-net syntax)
mac_address ['string', 'null'] QEMU MAC address
name ['string', 'null'] QEMU VM instance name
options ['string', 'null'] Additional QEMU options
platform enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null
process_priority enum Possible values: realtime, very high, high, normal, low, very low, null
qemu_path ['string', 'null'] Path to QEMU
ram ['integer', 'null'] amount of RAM in MB
usage string How to use the qemu VM
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
boot_priority ✔ enum Possible values: c, d, n, cn, cd
cdrom_image ✔ string QEMU cdrom image path
cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet, vnc
cpu_throttling ✔ integer Percentage of CPU allowed for QEMU
cpus ✔ ['integer', 'null'] number of vCPUs
hda_disk_image ✔ string QEMU hda disk image path
hda_disk_image_md5sum ✔ ['string', 'null'] QEMU hda disk image checksum
hda_disk_interface ✔ string QEMU hda interface
hdb_disk_image ✔ string QEMU hdb disk image path
hdb_disk_image_md5sum ✔ ['string', 'null'] QEMU hdb disk image checksum
hdb_disk_interface ✔ string QEMU hdb interface
hdc_disk_image ✔ string QEMU hdc disk image path
hdc_disk_image_md5sum ✔ ['string', 'null'] QEMU hdc disk image checksum
hdc_disk_interface ✔ string QEMU hdc interface
hdd_disk_image ✔ string QEMU hdd disk image path
hdd_disk_image_md5sum ✔ ['string', 'null'] QEMU hdd disk image checksum
hdd_disk_interface ✔ string QEMU hdd interface
initrd ✔ string QEMU initrd path
initrd_md5sum ✔ ['string', 'null'] QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kernel_image_md5sum ✔ ['string', 'null'] QEMU kernel image checksum
legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax)
mac_address ✔ string QEMU MAC address
name ✔ string QEMU VM instance name
options ✔ string Additional QEMU options
platform ✔ enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
project_id ✔ string Project uuid
qemu_path ✔ string path to QEMU
ram ✔ integer amount of RAM in MB
usage ✔ string How to use the qemu VM
vm_directory ✔ string
vm_id ✔ string QEMU VM uuid
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectidqemuvmsvmid.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance deleted - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidqemuvmsvmid.txt - diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst deleted file mode 100644 index 2bc9e09c..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ /dev/null @@ -1,52 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a Qemu VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **adapter_number**: Network adapter where the nio is located -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a Qemu VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **adapter_number**: Network adapter where the nio is located -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt - diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidreload.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidreload.rst deleted file mode 100644 index 9c4a613d..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidreload.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/reload ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}**/reload -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reload a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance reloaded - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidqemuvmsvmidreload.txt - diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidresume.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidresume.rst deleted file mode 100644 index 46803865..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidresume.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/resume ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}**/resume -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Resume a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance resumed - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidqemuvmsvmidresume.txt - diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstart.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstart.rst deleted file mode 100644 index d7dfab02..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstart.rst +++ /dev/null @@ -1,74 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/start ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Instance started -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
boot_priority ✔ enum Possible values: c, d, n, cn, cd
cdrom_image ✔ string QEMU cdrom image path
cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet, vnc
cpu_throttling ✔ integer Percentage of CPU allowed for QEMU
cpus ✔ ['integer', 'null'] number of vCPUs
hda_disk_image ✔ string QEMU hda disk image path
hda_disk_image_md5sum ✔ ['string', 'null'] QEMU hda disk image checksum
hda_disk_interface ✔ string QEMU hda interface
hdb_disk_image ✔ string QEMU hdb disk image path
hdb_disk_image_md5sum ✔ ['string', 'null'] QEMU hdb disk image checksum
hdb_disk_interface ✔ string QEMU hdb interface
hdc_disk_image ✔ string QEMU hdc disk image path
hdc_disk_image_md5sum ✔ ['string', 'null'] QEMU hdc disk image checksum
hdc_disk_interface ✔ string QEMU hdc interface
hdd_disk_image ✔ string QEMU hdd disk image path
hdd_disk_image_md5sum ✔ ['string', 'null'] QEMU hdd disk image checksum
hdd_disk_interface ✔ string QEMU hdd interface
initrd ✔ string QEMU initrd path
initrd_md5sum ✔ ['string', 'null'] QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kernel_image_md5sum ✔ ['string', 'null'] QEMU kernel image checksum
legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax)
mac_address ✔ string QEMU MAC address
name ✔ string QEMU VM instance name
options ✔ string Additional QEMU options
platform ✔ enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
project_id ✔ string Project uuid
qemu_path ✔ string path to QEMU
ram ✔ integer amount of RAM in MB
usage ✔ string How to use the qemu VM
vm_directory ✔ string
vm_id ✔ string QEMU VM uuid
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidqemuvmsvmidstart.txt - diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstop.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstop.rst deleted file mode 100644 index aa56ee04..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstop.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/stop ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}**/stop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance stopped - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidqemuvmsvmidstop.txt - diff --git a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidsuspend.rst b/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidsuspend.rst deleted file mode 100644 index feec4451..00000000 --- a/docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidsuspend.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/suspend ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/qemu/vms/**{vm_id}**/suspend -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Suspend a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance suspended - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidqemuvmsvmidsuspend.txt - diff --git a/docs/api/v2/hypervisor/qemu/qemubinaries.rst b/docs/api/v2/hypervisor/qemu/qemubinaries.rst deleted file mode 100644 index 2a7b5fa6..00000000 --- a/docs/api/v2/hypervisor/qemu/qemubinaries.rst +++ /dev/null @@ -1,30 +0,0 @@ -/v2/hypervisor/qemu/binaries ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/qemu/binaries -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a list of available Qemu binaries - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Input -******* -.. raw:: html - - - - -
Name Mandatory Type Description
archs array Architectures to filter binaries by
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_qemubinaries.txt - diff --git a/docs/api/v2/hypervisor/qemu/qemucapabilities.rst b/docs/api/v2/hypervisor/qemu/qemucapabilities.rst deleted file mode 100644 index f1d12bfd..00000000 --- a/docs/api/v2/hypervisor/qemu/qemucapabilities.rst +++ /dev/null @@ -1,28 +0,0 @@ -/v2/hypervisor/qemu/capabilities ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/qemu/capabilities -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a list of Qemu capabilities on this server - -Response status codes -********************** -- **200**: Success - -Output -******* -.. raw:: html - - - - -
Name Mandatory Type Description
kvm array Architectures that KVM is enabled for
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_qemucapabilities.txt - diff --git a/docs/api/v2/hypervisor/qemu/qemuimg.rst b/docs/api/v2/hypervisor/qemu/qemuimg.rst deleted file mode 100644 index 702c182f..00000000 --- a/docs/api/v2/hypervisor/qemu/qemuimg.rst +++ /dev/null @@ -1,39 +0,0 @@ -/v2/hypervisor/qemu/img ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/qemu/img -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a Qemu image - -Response status codes -********************** -- **201**: Image created - -Input -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapter_type enum Possible values: ide, lsilogic, buslogic, legacyESX
cluster_size integer
format ✔ enum Possible values: qcow2, qcow, vpc, vdi, vmdk, raw
lazy_refcounts enum Possible values: on, off
path ✔ string Absolute or relative path of the image
preallocation enum Possible values: off, metadata, falloc, full
qemu_img ✔ string Path to the qemu-img binary
refcount_bits integer
size ✔ integer Image size in M
static enum Possible values: on, off
subformat enum Possible values: dynamic, fixed, streamOptimized, twoGbMaxExtentSparse, twoGbMaxExtentFlat, monolithicSparse, monolithicFlat
zeroed_grain enum Possible values: on, off
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_qemuimg.txt - diff --git a/docs/api/v2/hypervisor/qemu/qemuimgbinaries.rst b/docs/api/v2/hypervisor/qemu/qemuimgbinaries.rst deleted file mode 100644 index dacde9e4..00000000 --- a/docs/api/v2/hypervisor/qemu/qemuimgbinaries.rst +++ /dev/null @@ -1,15 +0,0 @@ -/v2/hypervisor/qemu/img-binaries ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/qemu/img-binaries -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a list of available Qemu-img binaries - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - diff --git a/docs/api/v2/hypervisor/qemu/qemuvms.rst b/docs/api/v2/hypervisor/qemu/qemuvms.rst deleted file mode 100644 index 9357026b..00000000 --- a/docs/api/v2/hypervisor/qemu/qemuvms.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/qemu/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/qemu/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the list of Qemu images - -Response status codes -********************** -- **200**: List of Qemu images retrieved - diff --git a/docs/api/v2/hypervisor/qemu/qemuvmspath.rst b/docs/api/v2/hypervisor/qemu/qemuvmspath.rst deleted file mode 100644 index 3d202a64..00000000 --- a/docs/api/v2/hypervisor/qemu/qemuvmspath.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/qemu/vms/{path:.+} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/qemu/vms/**{path:.+}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upload Qemu image. - -Response status codes -********************** -- **204**: Image uploaded - diff --git a/docs/api/v2/hypervisor/version.rst b/docs/api/v2/hypervisor/version.rst deleted file mode 100644 index 70939776..00000000 --- a/docs/api/v2/hypervisor/version.rst +++ /dev/null @@ -1,8 +0,0 @@ -Version ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - version/* diff --git a/docs/api/v2/hypervisor/version/version.rst b/docs/api/v2/hypervisor/version/version.rst deleted file mode 100644 index a4fc822b..00000000 --- a/docs/api/v2/hypervisor/version/version.rst +++ /dev/null @@ -1,65 +0,0 @@ -/v2/hypervisor/version ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/version -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the server version number - -Response status codes -********************** -- **200**: OK - -Output -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
local boolean Either this is a local server
version ✔ string Version number human readable
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_version.txt - - -POST /v2/hypervisor/version -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Check if version is the same as the server - -Response status codes -********************** -- **200**: Same version -- **409**: Invalid version - -Input -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
local boolean Either this is a local server
version ✔ string Version number human readable
- -Output -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
local boolean Either this is a local server
version ✔ string Version number human readable
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_version.txt - diff --git a/docs/api/v2/hypervisor/virtualbox.rst b/docs/api/v2/hypervisor/virtualbox.rst deleted file mode 100644 index 1a0cf671..00000000 --- a/docs/api/v2/hypervisor/virtualbox.rst +++ /dev/null @@ -1,8 +0,0 @@ -Virtualbox ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - virtualbox/* diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvms.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvms.rst deleted file mode 100644 index 7b12ca39..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvms.rst +++ /dev/null @@ -1,66 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VirtualBox adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
linked_clone ✔ boolean either the VM is a linked clone or not
name ✔ string VirtualBox VM instance name
ram integer Amount of RAM
use_any_adapter boolean allow GNS3 to use any VirtualBox adapter
vm_id VirtualBox VM instance identifier
vmname ✔ string VirtualBox VM name (in VirtualBox itself)
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VirtualBox adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name ✔ string VirtualBox VM instance name
project_id ✔ string Project UUID
ram integer Amount of RAM
use_any_adapter boolean allow GNS3 to use any VirtualBox adapter
vm_directory ✔ ['string', 'null']
vm_id ✔ string VirtualBox VM instance UUID
vmname string VirtualBox VM name (in VirtualBox itself)
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvms.txt - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmid.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmid.rst deleted file mode 100644 index 6970e0c3..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmid.rst +++ /dev/null @@ -1,125 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VirtualBox adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name ✔ string VirtualBox VM instance name
project_id ✔ string Project UUID
ram integer Amount of RAM
use_any_adapter boolean allow GNS3 to use any VirtualBox adapter
vm_directory ✔ ['string', 'null']
vm_id ✔ string VirtualBox VM instance UUID
vmname string VirtualBox VM name (in VirtualBox itself)
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectidvirtualboxvmsvmid.txt - - -PUT /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a VirtualBox VM 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 - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VirtualBox adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name string VirtualBox VM instance name
ram integer Amount of RAM
use_any_adapter boolean allow GNS3 to use any VirtualBox adapter
vmname string VirtualBox VM name (in VirtualBox itself)
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VirtualBox adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name ✔ string VirtualBox VM instance name
project_id ✔ string Project UUID
ram integer Amount of RAM
use_any_adapter boolean allow GNS3 to use any VirtualBox adapter
vm_directory ✔ ['string', 'null']
vm_id ✔ string VirtualBox VM instance UUID
vmname string VirtualBox VM name (in VirtualBox itself)
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectidvirtualboxvmsvmid.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance deleted - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst deleted file mode 100644 index 242bd10c..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ /dev/null @@ -1,52 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a VirtualBox VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **adapter_number**: Adapter where the nio should be added -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a VirtualBox VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **adapter_number**: Adapter from where the nio should be removed -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst deleted file mode 100644 index 9998de72..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ /dev/null @@ -1,32 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a packet capture on a VirtualBox VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **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 - -Input -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
- diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst deleted file mode 100644 index 3065bc70..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ /dev/null @@ -1,22 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a packet capture on a VirtualBox 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 - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst deleted file mode 100644 index c92c38aa..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/reload ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/reload -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reload a VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance reloaded - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidreload.txt - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst deleted file mode 100644 index 56a28de7..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/resume ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/resume -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Resume a suspended VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance resumed - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidresume.txt - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst deleted file mode 100644 index 246ff3f2..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/start ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstart.txt - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst deleted file mode 100644 index 074c3c1a..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/stop ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/stop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance stopped - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstop.txt - diff --git a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst b/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst deleted file mode 100644 index d666b3e0..00000000 --- a/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/suspend ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/suspend -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Suspend a VirtualBox VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance suspended - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidsuspend.txt - diff --git a/docs/api/v2/hypervisor/virtualbox/virtualboxvms.rst b/docs/api/v2/hypervisor/virtualbox/virtualboxvms.rst deleted file mode 100644 index 94f8856b..00000000 --- a/docs/api/v2/hypervisor/virtualbox/virtualboxvms.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/virtualbox/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/virtualbox/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get all VirtualBox VMs available - -Response status codes -********************** -- **200**: Success - diff --git a/docs/api/v2/hypervisor/vmware.rst b/docs/api/v2/hypervisor/vmware.rst deleted file mode 100644 index 3b1b5582..00000000 --- a/docs/api/v2/hypervisor/vmware.rst +++ /dev/null @@ -1,8 +0,0 @@ -Vmware ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - vmware/* diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevms.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevms.rst deleted file mode 100644 index e608a6a7..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevms.rst +++ /dev/null @@ -1,60 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
linked_clone ✔ boolean either the VM is a linked clone or not
name ✔ string VMware VM instance name
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vm_id string VMware VM instance identifier
vmx_path ✔ string path to the vmx file
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name ✔ string VMware VM instance name
project_id ✔ string Project UUID
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vm_directory ['string', 'null']
vm_id ✔ string VMware VM instance UUID
vmx_path string path to the vmx file
- diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmid.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmid.rst deleted file mode 100644 index 1871c3a6..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmid.rst +++ /dev/null @@ -1,113 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name ✔ string VMware VM instance name
project_id ✔ string Project UUID
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vm_directory ['string', 'null']
vm_id ✔ string VMware VM instance UUID
vmx_path string path to the vmx file
- - -PUT /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a VMware VM 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 - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name string VMware VM instance name
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vmx_path string path to the vmx file
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name ✔ string VMware VM instance name
project_id ✔ string Project UUID
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vm_directory ['string', 'null']
vm_id ✔ string VMware VM instance UUID
vmx_path string path to the vmx file
- - -DELETE /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance deleted - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst deleted file mode 100644 index 7f4d61ba..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ /dev/null @@ -1,40 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a VMware VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **adapter_number**: Adapter where the nio should be added -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - - -DELETE /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a VMware VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **adapter_number**: Adapter from where the nio should be removed -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst deleted file mode 100644 index 12855e25..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ /dev/null @@ -1,32 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a packet capture on a VMware VM instance - -Parameters -********** -- **port_number**: Port on the adapter (always 0) -- **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 - -Input -******* -.. raw:: html - - - - - -
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
- diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst deleted file mode 100644 index daddf975..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ /dev/null @@ -1,22 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a packet capture on a VMware 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 - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst deleted file mode 100644 index 2d399168..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst +++ /dev/null @@ -1,18 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/interfaces/vmnet ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/interfaces/vmnet -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allocate a VMware VMnet interface on the server - -Parameters -********** -- **project_id**: The UUID of the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **201**: VMnet interface allocated - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidreload.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidreload.rst deleted file mode 100644 index e1bb6cc9..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidreload.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/reload ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/reload -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reload a VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance reloaded - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidresume.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidresume.rst deleted file mode 100644 index 2f45fd61..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidresume.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/resume ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/resume -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Resume a suspended VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance resumed - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstart.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstart.rst deleted file mode 100644 index f077b904..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstart.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/start ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstop.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstop.rst deleted file mode 100644 index 3b9675ca..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstop.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/stop ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/stop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance stopped - diff --git a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidsuspend.rst b/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidsuspend.rst deleted file mode 100644 index 177b5162..00000000 --- a/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidsuspend.rst +++ /dev/null @@ -1,20 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/suspend ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/suspend -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Suspend a VMware VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance suspended - diff --git a/docs/api/v2/hypervisor/vmware/vmwarevms.rst b/docs/api/v2/hypervisor/vmware/vmwarevms.rst deleted file mode 100644 index dbddcfd9..00000000 --- a/docs/api/v2/hypervisor/vmware/vmwarevms.rst +++ /dev/null @@ -1,13 +0,0 @@ -/v2/hypervisor/vmware/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/vmware/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get all VMware VMs available - -Response status codes -********************** -- **200**: Success - diff --git a/docs/api/v2/hypervisor/vpcs.rst b/docs/api/v2/hypervisor/vpcs.rst deleted file mode 100644 index 30db7c0b..00000000 --- a/docs/api/v2/hypervisor/vpcs.rst +++ /dev/null @@ -1,8 +0,0 @@ -Vpcs ------------------------------ - -.. toctree:: - :glob: - :maxdepth: 2 - - vpcs/* diff --git a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvms.rst b/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvms.rst deleted file mode 100644 index b8d38ff7..00000000 --- a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvms.rst +++ /dev/null @@ -1,56 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vpcs/vms ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new VPCS instance - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - - - -
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet
name ✔ string VPCS VM name
startup_script ['string', 'null'] Content of the VPCS startup script
vm_id VPCS VM identifier
- -Output -******* -.. raw:: html - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet
name ✔ string VPCS VM name
project_id ✔ string Project UUID
startup_script ['string', 'null'] Content of the VPCS startup script
startup_script_path ✔ ['string', 'null'] Path of the VPCS startup script relative to project directory
status ✔ enum Possible values: started, stopped
vm_directory string
vm_id ✔ string VPCS VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvms.txt - diff --git a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmid.rst b/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmid.rst deleted file mode 100644 index 97b59784..00000000 --- a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmid.rst +++ /dev/null @@ -1,119 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a VPCS instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet
name ✔ string VPCS VM name
project_id ✔ string Project UUID
startup_script ['string', 'null'] Content of the VPCS startup script
startup_script_path ✔ ['string', 'null'] Path of the VPCS startup script relative to project directory
status ✔ enum Possible values: started, stopped
vm_directory string
vm_id ✔ string VPCS VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectidvpcsvmsvmid.txt - - -PUT /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a VPCS 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 - - - - - - - -
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet
name ['string', 'null'] VPCS VM name
startup_script ['string', 'null'] Content of the VPCS startup script
- -Output -******* -.. raw:: html - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet
name ✔ string VPCS VM name
project_id ✔ string Project UUID
startup_script ['string', 'null'] Content of the VPCS startup script
startup_script_path ✔ ['string', 'null'] Path of the VPCS startup script relative to project directory
status ✔ enum Possible values: started, stopped
vm_directory string
vm_id ✔ string VPCS VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectidvpcsvmsvmid.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a VPCS instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance deleted - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidvpcsvmsvmid.txt - diff --git a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst deleted file mode 100644 index e566cd0a..00000000 --- a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ /dev/null @@ -1,52 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a VPCS instance - -Parameters -********** -- **port_number**: Port where the nio should be added -- **adapter_number**: Network adapter where the nio is located -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt - - -DELETE /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a VPCS instance - -Parameters -********** -- **port_number**: Port from where the nio should be removed -- **adapter_number**: Network adapter where the nio is located -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt - diff --git a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidreload.rst b/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidreload.rst deleted file mode 100644 index c23ea252..00000000 --- a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidreload.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/reload ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/reload -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reload a VPCS instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance reloaded - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidreload.txt - diff --git a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst b/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst deleted file mode 100644 index 1d15c5a4..00000000 --- a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst +++ /dev/null @@ -1,44 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/start ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a VPCS instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - -Output -******* -.. raw:: html - - - - - - - - - - - - - -
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet
name ✔ string VPCS VM name
project_id ✔ string Project UUID
startup_script ['string', 'null'] Content of the VPCS startup script
startup_script_path ✔ ['string', 'null'] Path of the VPCS startup script relative to project directory
status ✔ enum Possible values: started, stopped
vm_directory string
vm_id ✔ string VPCS VM UUID
- -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt - diff --git a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstop.rst b/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstop.rst deleted file mode 100644 index baa8ced4..00000000 --- a/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstop.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/stop ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/stop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a VPCS instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance stopped - -Sample session -*************** - - -.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidstop.txt -