From fb795433425f212858c3fe7c2beadcaf9f189f46 Mon Sep 17 00:00:00 2001 From: Julien Duponchelle Date: Wed, 10 Jun 2015 14:35:53 +0200 Subject: [PATCH] Build documentation --- .../delete_projectsprojectidiouvmsvmid.txt | 4 +- ...ptersadapternumberdportsportnumberdnio.txt | 4 +- .../delete_projectsprojectidqemuvmsvmid.txt | 4 +- ...ptersadapternumberdportsportnumberdnio.txt | 4 +- ...ptersadapternumberdportsportnumberdnio.txt | 4 +- .../delete_projectsprojectidvpcsvmsvmid.txt | 4 +- ...ptersadapternumberdportsportnumberdnio.txt | 4 +- docs/api/examples/get_interfaces.txt | 8 ++-- docs/api/examples/get_iouvms.txt | 19 +++++++++ docs/api/examples/get_projectsprojectid.txt | 4 +- .../examples/get_projectsprojectidfiles.txt | 24 +++++++++++ .../get_projectsprojectidiouvmsvmid.txt | 13 +++--- ...get_projectsprojectidiouvmsvmidconfigs.txt | 17 ++++++++ ...ojectsprojectidiouvmsvmidinitialconfig.txt | 17 -------- .../get_projectsprojectidqemuvmsvmid.txt | 13 +++--- ...get_projectsprojectidvirtualboxvmsvmid.txt | 9 +++-- .../get_projectsprojectidvpcsvmsvmid.txt | 9 +++-- docs/api/examples/post_projects.txt | 6 +-- .../examples/post_projectsprojectidiouvms.txt | 17 ++++---- ...ptersadapternumberdportsportnumberdnio.txt | 10 ++--- ...ternumberdportsportnumberdstartcapture.txt | 6 +-- ...pternumberdportsportnumberdstopcapture.txt | 4 +- ...post_projectsprojectidiouvmsvmidreload.txt | 4 +- .../post_projectsprojectidiouvmsvmidstart.txt | 4 +- .../post_projectsprojectidiouvmsvmidstop.txt | 4 +- .../post_projectsprojectidqemuvms.txt | 13 +++--- ...ptersadapternumberdportsportnumberdnio.txt | 4 +- ...ost_projectsprojectidqemuvmsvmidreload.txt | 4 +- ...ost_projectsprojectidqemuvmsvmidresume.txt | 4 +- ...post_projectsprojectidqemuvmsvmidstart.txt | 4 +- .../post_projectsprojectidqemuvmsvmidstop.txt | 4 +- ...st_projectsprojectidqemuvmsvmidsuspend.txt | 4 +- .../post_projectsprojectidvirtualboxvms.txt | 5 ++- ...ptersadapternumberdportsportnumberdnio.txt | 4 +- ...ojectsprojectidvirtualboxvmsvmidreload.txt | 4 +- ...ojectsprojectidvirtualboxvmsvmidresume.txt | 4 +- ...rojectsprojectidvirtualboxvmsvmidstart.txt | 4 +- ...projectsprojectidvirtualboxvmsvmidstop.txt | 4 +- ...jectsprojectidvirtualboxvmsvmidsuspend.txt | 4 +- .../post_projectsprojectidvpcsvms.txt | 5 ++- ...ptersadapternumberdportsportnumberdnio.txt | 4 +- ...ost_projectsprojectidvpcsvmsvmidreload.txt | 4 +- ...post_projectsprojectidvpcsvmsvmidstart.txt | 4 +- .../post_projectsprojectidvpcsvmsvmidstop.txt | 4 +- docs/api/examples/put_projectsprojectid.txt | 6 +-- .../put_projectsprojectidiouvmsvmid.txt | 17 ++++---- .../put_projectsprojectidqemuvmsvmid.txt | 13 +++--- ...put_projectsprojectidvirtualboxvmsvmid.txt | 9 +++-- .../put_projectsprojectidvpcsvmsvmid.txt | 9 +++-- ...ojectsprojectiddynamipsdevicesdeviceid.rst | 6 +-- ...mipsdevicesdeviceidportsportnumberdnio.rst | 17 ++++++-- ...esdeviceidportsportnumberdstartcapture.rst | 2 +- ...cesdeviceidportsportnumberdstopcapture.rst | 2 +- .../v1/dynamips_vm/dynamipsvmsfilename.rst | 13 ++++++ .../projectsprojectiddynamipsvms.rst | 2 + .../projectsprojectiddynamipsvmsvmid.rst | 3 ++ ...ptersadapternumberdportsportnumberdnio.rst | 8 ++-- ...ternumberdportsportnumberdstartcapture.rst | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 4 +- ...rojectsprojectiddynamipsvmsvmidconfigs.rst | 4 +- docs/api/v1/iou/iouvms.rst | 6 +++ docs/api/v1/iou/iouvmsfilename.rst | 13 ++++++ docs/api/v1/iou/projectsprojectidiouvms.rst | 9 +++-- .../v1/iou/projectsprojectidiouvmsvmid.rst | 9 +++-- ...ptersadapternumberdportsportnumberdnio.rst | 8 ++-- ...ternumberdportsportnumberdstartcapture.rst | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 4 +- ...=> projectsprojectidiouvmsvmidconfigs.rst} | 13 +++--- ...projectsprojectidiouvmsvmidconfigssave.rst | 15 +++++++ .../api/v1/project/projectsprojectidfiles.rst | 24 +++++++++++ .../v1/project/projectsprojectidfilespath.rst | 19 +++++++++ .../projectsprojectidnotifications.rst | 18 +++++++++ docs/api/v1/qemu/projectsprojectidqemuvms.rst | 6 +++ .../v1/qemu/projectsprojectidqemuvmsvmid.rst | 9 +++++ ...ptersadapternumberdportsportnumberdnio.rst | 8 ++-- docs/api/v1/qemu/qemuimgbinaries.rst | 15 +++++++ docs/api/v1/qemu/qemuvmsfilename.rst | 13 ++++++ .../projectsprojectidvirtualboxvms.rst | 2 + .../projectsprojectidvirtualboxvmsvmid.rst | 3 ++ ...ptersadapternumberdportsportnumberdnio.rst | 8 ++-- ...ternumberdportsportnumberdstartcapture.rst | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 4 +- .../v1/vmware/projectsprojectidvmwarevms.rst | 6 +++ .../vmware/projectsprojectidvmwarevmsvmid.rst | 9 +++++ ...ptersadapternumberdportsportnumberdnio.rst | 40 +++++++++++++++++++ docs/api/v1/vmware/vmwarevms.rst | 13 ++++++ docs/api/v1/vpcs/projectsprojectidvpcsvms.rst | 1 + .../v1/vpcs/projectsprojectidvpcsvmsvmid.rst | 2 + ...ptersadapternumberdportsportnumberdnio.rst | 8 ++-- tests/handlers/api/test_project.py | 2 +- tests/modules/vpcs/test_vpcs_vm.py | 2 +- 91 files changed, 515 insertions(+), 204 deletions(-) create mode 100644 docs/api/examples/get_iouvms.txt create mode 100644 docs/api/examples/get_projectsprojectidfiles.txt create mode 100644 docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt delete mode 100644 docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt create mode 100644 docs/api/v1/dynamips_vm/dynamipsvmsfilename.rst create mode 100644 docs/api/v1/iou/iouvmsfilename.rst rename docs/api/v1/iou/{projectsprojectidiouvmsvmidinitialconfig.rst => projectsprojectidiouvmsvmidconfigs.rst} (52%) create mode 100644 docs/api/v1/iou/projectsprojectidiouvmsvmidconfigssave.rst create mode 100644 docs/api/v1/project/projectsprojectidfiles.rst create mode 100644 docs/api/v1/project/projectsprojectidfilespath.rst create mode 100644 docs/api/v1/project/projectsprojectidnotifications.rst create mode 100644 docs/api/v1/qemu/qemuimgbinaries.rst create mode 100644 docs/api/v1/qemu/qemuvmsfilename.rst create mode 100644 docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst create mode 100644 docs/api/v1/vmware/vmwarevms.rst diff --git a/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt b/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt index d1fa8cf3..053cd8f7 100644 --- a/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/32773db2-f466-4118-8bef-02b585f92619' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2490ab98-57b1-4cb2-9214-6d741f5a5db3' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/32773db2-f466-4118-8bef-02b585f92619 HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2490ab98-57b1-4cb2-9214-6d741f5a5db3 HTTP/1.1 diff --git a/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt index eb8f1a08..ded37033 100644 --- a/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/22fb7e95-ac48-466a-a5e7-a03d2c9b57aa/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4eb051c3-ac81-4768-8e26-d04a1dc3e540/adapters/1/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/22fb7e95-ac48-466a-a5e7-a03d2c9b57aa/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4eb051c3-ac81-4768-8e26-d04a1dc3e540/adapters/1/ports/0/nio HTTP/1.1 diff --git a/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt index 84a4fcde..5beff400 100644 --- a/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/df85e698-3851-4172-b195-2caeb3fc5cf6' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/67edc289-2ece-4573-ab31-74eef86fc9ab' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/df85e698-3851-4172-b195-2caeb3fc5cf6 HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/67edc289-2ece-4573-ab31-74eef86fc9ab HTTP/1.1 diff --git a/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 89e38b92..9a61853f 100644 --- a/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2a5cfc20-5a1f-4180-897a-c90362a01832/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2f57c403-1fb8-44ad-91b9-1548b6679338/adapters/1/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2a5cfc20-5a1f-4180-897a-c90362a01832/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2f57c403-1fb8-44ad-91b9-1548b6679338/adapters/1/ports/0/nio HTTP/1.1 diff --git a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt index f67cc1d4..15bab244 100644 --- a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c413ed57-0064-4e42-9cc0-59a6dc3143e0/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ac6d84a3-c129-496e-88c9-c7dcf46f94fc/adapters/0/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c413ed57-0064-4e42-9cc0-59a6dc3143e0/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ac6d84a3-c129-496e-88c9-c7dcf46f94fc/adapters/0/ports/0/nio HTTP/1.1 diff --git a/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt index b50c3a72..4a4fa5c7 100644 --- a/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/44a0ec89-6cb1-4165-a4d5-ebf99963440f' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/8dd59ef3-c7f3-4cc5-a1f3-bf74dc10a417' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/44a0ec89-6cb1-4165-a4d5-ebf99963440f HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/8dd59ef3-c7f3-4cc5-a1f3-bf74dc10a417 HTTP/1.1 diff --git a/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 7a27263a..eafad1c2 100644 --- a/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/f12f73cc-dfd6-4b04-a731-1e0e6ead343a/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6207942f-b820-4299-8b25-8897a671896d/adapters/0/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/f12f73cc-dfd6-4b04-a731-1e0e6ead343a/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6207942f-b820-4299-8b25-8897a671896d/adapters/0/ports/0/nio HTTP/1.1 diff --git a/docs/api/examples/get_interfaces.txt b/docs/api/examples/get_interfaces.txt index d332fbe2..48851f13 100644 --- a/docs/api/examples/get_interfaces.txt +++ b/docs/api/examples/get_interfaces.txt @@ -29,6 +29,10 @@ X-ROUTE: /v1/interfaces "id": "en1", "name": "en1" }, + { + "id": "en0", + "name": "en0" + }, { "id": "fw0", "name": "fw0" @@ -37,10 +41,6 @@ X-ROUTE: /v1/interfaces "id": "en2", "name": "en2" }, - { - "id": "en0", - "name": "en0" - }, { "id": "p2p0", "name": "p2p0" diff --git a/docs/api/examples/get_iouvms.txt b/docs/api/examples/get_iouvms.txt new file mode 100644 index 00000000..2c14e9e2 --- /dev/null +++ b/docs/api/examples/get_iouvms.txt @@ -0,0 +1,19 @@ +curl -i -X GET 'http://localhost:8000/v1/iou/vms' + +GET /v1/iou/vms HTTP/1.1 + + + +HTTP/1.1 200 +CONNECTION: keep-alive +CONTENT-LENGTH: 45 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.4 GNS3/1.4.0.dev1 +X-ROUTE: /v1/iou/vms + +[ + { + "filename": "iou.bin" + } +] diff --git a/docs/api/examples/get_projectsprojectid.txt b/docs/api/examples/get_projectsprojectid.txt index c2fd7629..f6438b1c 100644 --- a/docs/api/examples/get_projectsprojectid.txt +++ b/docs/api/examples/get_projectsprojectid.txt @@ -13,9 +13,9 @@ SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id} { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqyrnrqv5", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpgee6or3v", "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqyrnrqv5/00010203-0405-0607-0809-0a0b0c0d0e02", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpgee6or3v/00010203-0405-0607-0809-0a0b0c0d0e02", "project_id": "00010203-0405-0607-0809-0a0b0c0d0e02", "temporary": false } diff --git a/docs/api/examples/get_projectsprojectidfiles.txt b/docs/api/examples/get_projectsprojectidfiles.txt new file mode 100644 index 00000000..0ea9ee4b --- /dev/null +++ b/docs/api/examples/get_projectsprojectidfiles.txt @@ -0,0 +1,24 @@ +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/files' + +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/files HTTP/1.1 + + + +HTTP/1.1 200 +CONNECTION: keep-alive +CONTENT-LENGTH: 204 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.4 GNS3/1.4.0.dev1 +X-ROUTE: /v1/projects/{project_id}/files + +[ + { + "md5sum": "ad0234829205b9033196ba818f7a872b", + "path": "test.txt" + }, + { + "md5sum": "098f6bcd4621d373cade4e832627b4f6", + "path": "vm-1/dynamips/test.bin" + } +] diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt index 169d6822..4d0a99b1 100644 --- a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt @@ -1,12 +1,12 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/570b3403-25ed-44bb-ab47-cbead7965a46' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/1f04d468-329c-44d1-b46f-9fa1a916aa70' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/570b3403-25ed-44bb-ab47-cbead7965a46 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/1f04d468-329c-44d1-b46f-9fa1a916aa70 HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 467 +CONTENT-LENGTH: 495 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 @@ -15,15 +15,16 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} { "console": 2000, "ethernet_adapters": 2, - "initial_config": null, "iourc_path": null, "l1_keepalives": false, "name": "PC TEST 1", "nvram": 128, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-25/test_iou_get0/iou.bin", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-10/test_iou_get0/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_id": "570b3403-25ed-44bb-ab47-cbead7965a46" + "vm_id": "1f04d468-329c-44d1-b46f-9fa1a916aa70" } diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt b/docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt new file mode 100644 index 00000000..7277b19a --- /dev/null +++ b/docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt @@ -0,0 +1,17 @@ +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/053713a7-614a-488f-be8c-572f434d991b/configs' + +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/053713a7-614a-488f-be8c-572f434d991b/configs HTTP/1.1 + + + +HTTP/1.1 200 +CONNECTION: keep-alive +CONTENT-LENGTH: 40 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.4 GNS3/1.4.0.dev1 +X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/configs + +{ + "startup_config_content": "TEST" +} diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt b/docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt deleted file mode 100644 index fc6ef2c5..00000000 --- a/docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt +++ /dev/null @@ -1,17 +0,0 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/733d8688-05fd-4e25-86fb-9ce302264936/initial_config' - -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/733d8688-05fd-4e25-86fb-9ce302264936/initial_config HTTP/1.1 - - - -HTTP/1.1 200 -CONNECTION: keep-alive -CONTENT-LENGTH: 25 -CONTENT-TYPE: application/json -DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.4.0.dev1 -X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/initial_config - -{ - "content": "TEST" -} diff --git a/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt index 0352bb8c..d8e53f19 100644 --- a/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt @@ -1,18 +1,19 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/86cb38a5-d580-41b2-ab31-57dd5c2e2317' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5a34dba5-d6e4-4fd7-8ee0-63174bbb144a' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/86cb38a5-d580-41b2-ab31-57dd5c2e2317 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5a34dba5-d6e4-4fd7-8ee0-63174bbb144a HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 597 +CONTENT-LENGTH: 682 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} { + "acpi_shutdown": false, "adapter_type": "e1000", "adapters": 1, "console": 2000, @@ -24,12 +25,14 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} "initrd": "", "kernel_command_line": "", "kernel_image": "", + "kvm": true, "legacy_networking": false, + "mac_address": "00:00:ab:14:4a:00", "name": "PC TEST 1", "options": "", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnb5_wdn4/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2vvnz4z_/qemu_x42", "ram": 256, - "vm_id": "86cb38a5-d580-41b2-ab31-57dd5c2e2317" + "vm_id": "5a34dba5-d6e4-4fd7-8ee0-63174bbb144a" } diff --git a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt index 808686b4..48d1a354 100644 --- a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt @@ -1,18 +1,19 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c6006b62-b9c1-4be0-9cc6-81d12bdd29d5' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e70eb611-1587-450c-a9af-6d10f33d73a6' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c6006b62-b9c1-4be0-9cc6-81d12bdd29d5 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e70eb611-1587-450c-a9af-6d10f33d73a6 HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 361 +CONTENT-LENGTH: 389 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} { + "acpi_shutdown": false, "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)", "adapters": 0, "console": 2001, @@ -22,6 +23,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 0, "use_any_adapter": false, - "vm_id": "c6006b62-b9c1-4be0-9cc6-81d12bdd29d5", + "vm_id": "e70eb611-1587-450c-a9af-6d10f33d73a6", "vmname": "VMTEST" } diff --git a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt index 218c2d63..ac6e0131 100644 --- a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt @@ -1,12 +1,12 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3d70ec8d-d4af-4bb3-9bc2-1e7833f44a3e' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/bd6c3ed5-b279-4c51-bab2-4bd7a78fa6f7' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3d70ec8d-d4af-4bb3-9bc2-1e7833f44a3e HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/bd6c3ed5-b279-4c51-bab2-4bd7a78fa6f7 HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 220 +CONTENT-LENGTH: 245 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 @@ -18,5 +18,6 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, - "vm_id": "3d70ec8d-d4af-4bb3-9bc2-1e7833f44a3e" + "status": "stopped", + "vm_id": "bd6c3ed5-b279-4c51-bab2-4bd7a78fa6f7" } diff --git a/docs/api/examples/post_projects.txt b/docs/api/examples/post_projects.txt index 83c6f912..9db8647d 100644 --- a/docs/api/examples/post_projects.txt +++ b/docs/api/examples/post_projects.txt @@ -15,9 +15,9 @@ SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpue5qtaa2", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpreddb0ft", "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpue5qtaa2/abc875ab-6e67-484c-8db0-4e05de5f00b0", - "project_id": "abc875ab-6e67-484c-8db0-4e05de5f00b0", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpreddb0ft/de3bdbbe-3f13-461b-9b1f-5fe764004670", + "project_id": "de3bdbbe-3f13-461b-9b1f-5fe764004670", "temporary": false } diff --git a/docs/api/examples/post_projectsprojectidiouvms.txt b/docs/api/examples/post_projectsprojectidiouvms.txt index 252cd4c3..f66aec29 100644 --- a/docs/api/examples/post_projectsprojectidiouvms.txt +++ b/docs/api/examples/post_projectsprojectidiouvms.txt @@ -1,17 +1,17 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"initial_config_content": "hostname test", "name": "PC TEST 1", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-25/test_iou_create_initial_config0/iou.bin", "vm_id": "aaf267e2-745e-40b3-bce7-3e80f5230899"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"name": "PC TEST 1", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-10/test_iou_create_startup_config0/iou.bin", "startup_config_content": "hostname test", "vm_id": "76cb4ec0-d88e-484b-ada6-4e5dd9c2cf74"}' POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1 { - "initial_config_content": "hostname test", "name": "PC TEST 1", - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-25/test_iou_create_initial_config0/iou.bin", - "vm_id": "aaf267e2-745e-40b3-bce7-3e80f5230899" + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-10/test_iou_create_startup_config0/iou.bin", + "startup_config_content": "hostname test", + "vm_id": "76cb4ec0-d88e-484b-ada6-4e5dd9c2cf74" } HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 501 +CONTENT-LENGTH: 529 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 @@ -20,15 +20,16 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms { "console": 2000, "ethernet_adapters": 2, - "initial_config": "initial-config.cfg", "iourc_path": null, "l1_keepalives": false, "name": "PC TEST 1", "nvram": 128, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-25/test_iou_create_initial_config0/iou.bin", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-10/test_iou_create_startup_config0/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_id": "aaf267e2-745e-40b3-bce7-3e80f5230899" + "vm_id": "76cb4ec0-d88e-484b-ada6-4e5dd9c2cf74" } diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt index c66434a6..dd9056d4 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,21 +1,21 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/5fff6292-2ac7-4f25-9fa7-5bdaaa7fbe84/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0f0f340a-7d25-4020-96f8-5d615437d173/adapters/1/ports/0/nio' -d '{"ethernet_device": "lo0", "type": "nio_generic_ethernet"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/5fff6292-2ac7-4f25-9fa7-5bdaaa7fbe84/adapters/1/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0f0f340a-7d25-4020-96f8-5d615437d173/adapters/1/ports/0/nio HTTP/1.1 { - "ethernet_device": "eth0", + "ethernet_device": "lo0", "type": "nio_generic_ethernet" } HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 69 +CONTENT-LENGTH: 68 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { - "ethernet_device": "eth0", + "ethernet_device": "lo0", "type": "nio_generic_ethernet" } diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt index 1f1ad3bf..bbd8a16a 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3101e74a-8456-4ccf-ba7a-fd1b3cdf0729/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d5b26573-562d-4a4f-90a2-b8b6c8ce5b0f/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3101e74a-8456-4ccf-ba7a-fd1b3cdf0729/adapters/0/ports/0/start_capture HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d5b26573-562d-4a4f-90a2-b8b6c8ce5b0f/adapters/0/ports/0/start_capture HTTP/1.1 { "capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB" @@ -16,5 +16,5 @@ SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/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/tmpossrvwje/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap" + "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpfuqmuevw/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap" } diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt index 0c85536f..8735004a 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2309d25b-8095-4a1a-9478-6345dad9f579/adapters/0/ports/0/stop_capture' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4f23d204-379b-4403-a369-747315c67df6/adapters/0/ports/0/stop_capture' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2309d25b-8095-4a1a-9478-6345dad9f579/adapters/0/ports/0/stop_capture HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4f23d204-379b-4403-a369-747315c67df6/adapters/0/ports/0/stop_capture HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt index 67c1ec57..56ba2a84 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c4018290-fe62-41c8-bf06-88d832eb0477/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ff11bb56-5bc4-4cca-8800-95c2d04b3d9e/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c4018290-fe62-41c8-bf06-88d832eb0477/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ff11bb56-5bc4-4cca-8800-95c2d04b3d9e/reload HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt index 6666f708..7d508404 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2fe292e5-ab46-473a-bd91-edf0ea58fc47/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0754f25c-e62c-4823-91a8-b7a7c81baee0/start' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2fe292e5-ab46-473a-bd91-edf0ea58fc47/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0754f25c-e62c-4823-91a8-b7a7c81baee0/start HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt index bee9429d..b8a8d115 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/8dc543e0-ae2c-45cc-bdc2-82baa781c8a7/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/bc841fee-2579-44fc-a32a-639fe3520590/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/8dc543e0-ae2c-45cc-bdc2-82baa781c8a7/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/bc841fee-2579-44fc-a32a-639fe3520590/stop HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidqemuvms.txt b/docs/api/examples/post_projectsprojectidqemuvms.txt index 74beb465..f8bcdb1f 100644 --- a/docs/api/examples/post_projectsprojectidqemuvms.txt +++ b/docs/api/examples/post_projectsprojectidqemuvms.txt @@ -1,23 +1,24 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "/tmp/hda", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnb5_wdn4/qemu_x42", "ram": 1024}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "/tmp/hda", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2vvnz4z_/qemu_x42", "ram": 1024}' POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1 { "hda_disk_image": "/tmp/hda", "name": "PC TEST 1", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnb5_wdn4/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2vvnz4z_/qemu_x42", "ram": 1024 } HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 606 +CONTENT-LENGTH: 691 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms { + "acpi_shutdown": false, "adapter_type": "e1000", "adapters": 1, "console": 2000, @@ -29,12 +30,14 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms "initrd": "", "kernel_command_line": "", "kernel_image": "", + "kvm": true, "legacy_networking": false, + "mac_address": "00:00:ab:27:46:00", "name": "PC TEST 1", "options": "", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnb5_wdn4/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2vvnz4z_/qemu_x42", "ram": 1024, - "vm_id": "c0fd0a60-1952-47e7-a293-7a233c83ce8e" + "vm_id": "3aabf5a2-3367-4863-afeb-4a3197d32746" } diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 1797d515..ab52e44f 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d378a8bd-711d-47b1-aaa0-dfa0c3ff420b/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/122f6e7b-5f24-4e22-9f3c-a62734c2a2c5/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d378a8bd-711d-47b1-aaa0-dfa0c3ff420b/adapters/1/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/122f6e7b-5f24-4e22-9f3c-a62734c2a2c5/adapters/1/ports/0/nio HTTP/1.1 { "ethernet_device": "eth0", "type": "nio_generic_ethernet" diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt index a80380b1..122e9a9b 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/96e58ba8-0d90-4f45-a410-ba738338b5f8/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/8934f7c3-cfc2-4813-86e6-c431db2cc63a/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/96e58ba8-0d90-4f45-a410-ba738338b5f8/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/8934f7c3-cfc2-4813-86e6-c431db2cc63a/reload HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt index ebd6e3c9..ddfd6ad1 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f112cd1e-d307-4f95-ab6b-8d2387d520d5/resume' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/167972e8-aa39-4894-9346-fca6db989043/resume' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f112cd1e-d307-4f95-ab6b-8d2387d520d5/resume HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/167972e8-aa39-4894-9346-fca6db989043/resume HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt index d484e275..fa5e02cd 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/14c7e896-28cf-4705-801c-76ab2a4ee387/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/ea693a1a-e696-491e-9890-f685ea07d07a/start' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/14c7e896-28cf-4705-801c-76ab2a4ee387/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/ea693a1a-e696-491e-9890-f685ea07d07a/start HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt index 9cb889e1..45f2d660 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d730f891-a552-4df5-9399-fab1ed15358e/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/570da710-7809-43bd-bc09-f71e2e9ab7b0/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d730f891-a552-4df5-9399-fab1ed15358e/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/570da710-7809-43bd-bc09-f71e2e9ab7b0/stop HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt index b45534fc..5de36b96 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/64c8e5e5-056b-4ec8-9d86-912c7e053560/suspend' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/fd5203df-48c2-4185-b266-8bcf512dca51/suspend' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/64c8e5e5-056b-4ec8-9d86-912c7e053560/suspend HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/fd5203df-48c2-4185-b266-8bcf512dca51/suspend HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt index 1cd38b1d..72afb24a 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt @@ -10,13 +10,14 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1 HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 355 +CONTENT-LENGTH: 383 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms { + "acpi_shutdown": false, "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)", "adapters": 0, "console": 2000, @@ -26,6 +27,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 0, "use_any_adapter": false, - "vm_id": "f9407c6b-39bf-4445-9d53-70676fe7e3dc", + "vm_id": "de50008a-0f46-481b-99c0-9788618faa06", "vmname": "VM1" } diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt index fa91f290..b77abb6a 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/d18556e2-fc68-486c-a039-0cd9200322d3/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c8671922-23e0-43c7-bb36-dfb4d5fa82c9/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/d18556e2-fc68-486c-a039-0cd9200322d3/adapters/0/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c8671922-23e0-43c7-bb36-dfb4d5fa82c9/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt index 4004050e..20be26eb 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/cb66c1db-e2f8-4149-9065-976db1af7afb/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f31ce37d-9ef3-45c8-8b3e-e6ad163aba9c/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/cb66c1db-e2f8-4149-9065-976db1af7afb/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f31ce37d-9ef3-45c8-8b3e-e6ad163aba9c/reload HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt index cc304ddd..aab8e545 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/158053af-713e-4a72-a05d-c33aa05208f7/resume' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/554fc4ca-6861-496f-a70b-f107c5423176/resume' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/158053af-713e-4a72-a05d-c33aa05208f7/resume HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/554fc4ca-6861-496f-a70b-f107c5423176/resume HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt index 34ae9b83..0630bc8d 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a18cc3a2-a31b-4d4a-b79a-0b1e714760fb/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/1c59f62c-6728-43ae-a819-9506450f4bda/start' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a18cc3a2-a31b-4d4a-b79a-0b1e714760fb/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/1c59f62c-6728-43ae-a819-9506450f4bda/start HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt index 41397c9e..84a7ff9f 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/6b897ee5-9c9f-4de1-9858-2a0280d2e551/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/980d0c2f-2c8d-495d-ab62-3ffffe899c65/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/6b897ee5-9c9f-4de1-9858-2a0280d2e551/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/980d0c2f-2c8d-495d-ab62-3ffffe899c65/stop HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt index f9cab5fe..9511817e 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/6b5139c6-3bcd-4edc-a37f-fd73d28cd9bd/suspend' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/afbc681b-8a60-4911-bacc-cc8d0b8f36bf/suspend' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/6b5139c6-3bcd-4edc-a37f-fd73d28cd9bd/suspend HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/afbc681b-8a60-4911-bacc-cc8d0b8f36bf/suspend HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvpcsvms.txt b/docs/api/examples/post_projectsprojectidvpcsvms.txt index 5d9f94ad..59e89e44 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvms.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvms.txt @@ -8,7 +8,7 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1 HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 220 +CONTENT-LENGTH: 245 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 @@ -20,5 +20,6 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, - "vm_id": "104b72e1-1d73-4153-989f-96731442f6a1" + "status": "stopped", + "vm_id": "a0b0ad7c-bffe-4fb1-8b85-b50016acc46a" } diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt index fa73145e..f78bc169 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b5d32250-bacf-4594-be35-e2d2d814a45c/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/08dc7b7e-dc5a-44cc-bc80-8e71ce7c5973/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b5d32250-bacf-4594-be35-e2d2d814a45c/adapters/0/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/08dc7b7e-dc5a-44cc-bc80-8e71ce7c5973/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt index edc0e24e..1ede2bd1 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/722b7e9d-ecc1-44cf-b743-609bb267ec65/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/34458b84-4696-4914-8e38-5548f7783b50/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/722b7e9d-ecc1-44cf-b743-609bb267ec65/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/34458b84-4696-4914-8e38-5548f7783b50/reload HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt index ba660775..c1591d17 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/0986e25f-6d7e-4a64-a8ea-b1a3a5541c46/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/88a924fe-d7be-4e4f-bbe6-d01844ed6caa/start' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/0986e25f-6d7e-4a64-a8ea-b1a3a5541c46/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/88a924fe-d7be-4e4f-bbe6-d01844ed6caa/start HTTP/1.1 {} diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt index 2271f66c..24ce7a5b 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a9b859ce-d847-402c-9db2-cd2d1bc4f67a/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/249fb5b4-1b5c-4675-982c-375ad8f31fad/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a9b859ce-d847-402c-9db2-cd2d1bc4f67a/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/249fb5b4-1b5c-4675-982c-375ad8f31fad/stop HTTP/1.1 {} diff --git a/docs/api/examples/put_projectsprojectid.txt b/docs/api/examples/put_projectsprojectid.txt index 13f3f6a7..15243116 100644 --- a/docs/api/examples/put_projectsprojectid.txt +++ b/docs/api/examples/put_projectsprojectid.txt @@ -1,9 +1,9 @@ -curl -i -X PUT 'http://localhost:8000/v1/projects/ac4b48cf-f26c-4ab6-bce1-368fdffb112f' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-25/test_update_path_project_non_l0"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/3df5ad8b-1d2a-4204-b8b2-3c14048f765c' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-10/test_update_path_project_non_l0"}' -PUT /v1/projects/ac4b48cf-f26c-4ab6-bce1-368fdffb112f HTTP/1.1 +PUT /v1/projects/3df5ad8b-1d2a-4204-b8b2-3c14048f765c HTTP/1.1 { "name": "second_name", - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-25/test_update_path_project_non_l0" + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-10/test_update_path_project_non_l0" } diff --git a/docs/api/examples/put_projectsprojectidiouvmsvmid.txt b/docs/api/examples/put_projectsprojectidiouvmsvmid.txt index fc1bc621..dbe97ccf 100644 --- a/docs/api/examples/put_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidiouvmsvmid.txt @@ -1,23 +1,23 @@ -curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b75e3ec5-b42d-4e42-80a3-e79b2aab1efa' -d '{"console": 2001, "ethernet_adapters": 4, "initial_config_content": "hostname test", "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "use_default_iou_values": true}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/65baee88-6b5f-4f4c-94d4-a4b37b74e701' -d '{"console": 2001, "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 /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b75e3ec5-b42d-4e42-80a3-e79b2aab1efa HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/65baee88-6b5f-4f4c-94d4-a4b37b74e701 HTTP/1.1 { "console": 2001, "ethernet_adapters": 4, - "initial_config_content": "hostname test", "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 CONNECTION: keep-alive -CONTENT-LENGTH: 545 +CONTENT-LENGTH: 573 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 @@ -26,15 +26,16 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} { "console": 2001, "ethernet_adapters": 4, - "initial_config": "initial-config.cfg", - "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmprshqaaaj/iourc", + "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpbum1ehij/iourc", "l1_keepalives": true, "name": "test", "nvram": 2048, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-25/test_iou_update0/iou.bin", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-10/test_iou_update0/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_id": "b75e3ec5-b42d-4e42-80a3-e79b2aab1efa" + "vm_id": "65baee88-6b5f-4f4c-94d4-a4b37b74e701" } diff --git a/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt index 43bfd71f..38473fa1 100644 --- a/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/8338f125-5b24-4bc9-a891-6ca1510396ad' -d '{"console": 2001, "hdb_disk_image": "/tmp/hdb", "name": "test", "ram": 1024}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/552a08c8-811f-4a20-97f7-8ada2a36f0a5' -d '{"console": 2001, "hdb_disk_image": "/tmp/hdb", "name": "test", "ram": 1024}' -PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/8338f125-5b24-4bc9-a891-6ca1510396ad HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/552a08c8-811f-4a20-97f7-8ada2a36f0a5 HTTP/1.1 { "console": 2001, "hdb_disk_image": "/tmp/hdb", @@ -11,13 +11,14 @@ PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/8338f125-5b24-4bc HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 601 +CONTENT-LENGTH: 686 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} { + "acpi_shutdown": false, "adapter_type": "e1000", "adapters": 1, "console": 2001, @@ -29,12 +30,14 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} "initrd": "", "kernel_command_line": "", "kernel_image": "", + "kvm": true, "legacy_networking": false, + "mac_address": "00:00:ab:f0:a5:00", "name": "test", "options": "", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnb5_wdn4/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2vvnz4z_/qemu_x42", "ram": 1024, - "vm_id": "8338f125-5b24-4bc9-a891-6ca1510396ad" + "vm_id": "552a08c8-811f-4a20-97f7-8ada2a36f0a5" } diff --git a/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt index b4070901..60e4d5aa 100644 --- a/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4dac8148-a8d2-42a5-9f91-805c3490e0f6' -d '{"console": 2010, "name": "test"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/0991cab9-28ea-4dc3-942e-f81a296344d9' -d '{"console": 2010, "name": "test"}' -PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4dac8148-a8d2-42a5-9f91-805c3490e0f6 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/0991cab9-28ea-4dc3-942e-f81a296344d9 HTTP/1.1 { "console": 2010, "name": "test" @@ -9,13 +9,14 @@ PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4dac8148-a8 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 359 +CONTENT-LENGTH: 387 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} { + "acpi_shutdown": false, "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)", "adapters": 0, "console": 2010, @@ -25,6 +26,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 0, "use_any_adapter": false, - "vm_id": "4dac8148-a8d2-42a5-9f91-805c3490e0f6", + "vm_id": "0991cab9-28ea-4dc3-942e-f81a296344d9", "vmname": "VMTEST" } diff --git a/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt index f0007143..5e788ecd 100644 --- a/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/19169b30-8673-43e6-a096-11a6ebea1538' -d '{"console": 2011, "name": "test", "startup_script": "ip 192.168.1.1"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/fa77b9a7-efc7-4076-a733-a1cc56ef1042' -d '{"console": 2011, "name": "test", "startup_script": "ip 192.168.1.1"}' -PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/19169b30-8673-43e6-a096-11a6ebea1538 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/fa77b9a7-efc7-4076-a733-a1cc56ef1042 HTTP/1.1 { "console": 2011, "name": "test", @@ -10,7 +10,7 @@ PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/19169b30-8673-43e HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 236 +CONTENT-LENGTH: 261 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 GNS3/1.4.0.dev1 @@ -22,5 +22,6 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": "ip 192.168.1.1", "startup_script_path": "startup.vpc", - "vm_id": "19169b30-8673-43e6-a096-11a6ebea1538" + "status": "stopped", + "vm_id": "fa77b9a7-efc7-4076-a733-a1cc56ef1042" } diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst index 1ff726ba..7f0e65e4 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst @@ -9,8 +9,8 @@ Get a Dynamips device instance Parameters ********** -- **device_id**: UUID for the instance - **project_id**: UUID for the project +- **device_id**: UUID for the instance Response status codes ********************** @@ -38,8 +38,8 @@ Update a Dynamips device instance Parameters ********** -- **device_id**: UUID for the instance - **project_id**: UUID for the project +- **device_id**: UUID for the instance Response status codes ********************** @@ -95,8 +95,8 @@ Delete a Dynamips device instance Parameters ********** -- **device_id**: UUID for the instance - **project_id**: UUID for the project +- **device_id**: UUID for the instance Response status codes ********************** diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst index f74e9656..97b14b9d 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst @@ -9,9 +9,9 @@ Add a NIO to a Dynamips device instance Parameters ********** +- **project_id**: UUID for the project - **device_id**: UUID for the instance - **port_number**: Port on the device -- **project_id**: UUID for the project Response status codes ********************** @@ -47,6 +47,17 @@ Linux Ethernet Network Input/Output 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 @@ -117,7 +128,7 @@ Body - +
Name Mandatory Type Description
mappings object
nio ✔ UDP, Ethernet, LinuxEthernet, TAP, UNIX, VDE, NULL
nio ✔ UDP, Ethernet, LinuxEthernet, NAT, TAP, UNIX, VDE, NULL
port_settings object Ethernet switch
@@ -128,9 +139,9 @@ Remove a NIO from a Dynamips device instance Parameters ********** +- **project_id**: UUID for the project - **device_id**: UUID for the instance - **port_number**: Port on the device -- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst index a33ba970..19852f49 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst @@ -9,9 +9,9 @@ Start a packet capture on a Dynamips device instance Parameters ********** +- **project_id**: UUID for the project - **device_id**: UUID for the instance - **port_number**: Port on the device -- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst index 75cf96a4..cc312e43 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst @@ -9,9 +9,9 @@ Stop a packet capture on a Dynamips device instance Parameters ********** +- **project_id**: UUID for the project - **device_id**: UUID for the instance - **port_number**: Port on the device -- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/dynamipsvmsfilename.rst b/docs/api/v1/dynamips_vm/dynamipsvmsfilename.rst new file mode 100644 index 00000000..ed7e219c --- /dev/null +++ b/docs/api/v1/dynamips_vm/dynamipsvmsfilename.rst @@ -0,0 +1,13 @@ +/v1/dynamips/vms/{filename} +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/dynamips/vms/**{filename}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Upload Dynamips image. + +Response status codes +********************** +- **204**: Image uploaded + diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst index a8b15b28..72f3cf83 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst @@ -23,6 +23,7 @@ Input + @@ -73,6 +74,7 @@ Output
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
+ diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst index 9f8b27db..85b6b979 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst @@ -24,6 +24,7 @@ Output
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
+ @@ -90,6 +91,7 @@ Input
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
+ @@ -136,6 +138,7 @@ Output
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
+ diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 7886ad07..e08e9f1e 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance Parameters ********** -- **port_number**: Port on the adapter - **vm_id**: UUID for the instance -- **adapter_number**: Adapter where the nio should be added - **project_id**: UUID for the project +- **adapter_number**: Adapter where the nio should be added +- **port_number**: Port on the adapter Response status codes ********************** @@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance Parameters ********** -- **port_number**: Port on the adapter - **vm_id**: UUID for the instance -- **adapter_number**: Adapter from where the nio should be removed - **project_id**: UUID for the project +- **adapter_number**: Adapter from where the nio should be removed +- **port_number**: Port on the adapter Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index 6cc4d452..8e041d67 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance Parameters ********** -- **port_number**: Port on the adapter - **vm_id**: UUID for the instance -- **adapter_number**: Adapter to start a packet capture - **project_id**: UUID for the project +- **adapter_number**: Adapter to start a packet capture +- **port_number**: Port on the adapter Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index ce104421..5df68984 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Adapter to stop a packet capture - **project_id**: UUID for the project +- **adapter_number**: Adapter to stop a packet capture +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst index 547b9e25..d8aae9a1 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst @@ -19,7 +19,7 @@ Output
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
- - + +
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
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/v1/iou/iouvms.rst b/docs/api/v1/iou/iouvms.rst index 80be4a0c..466ae34c 100644 --- a/docs/api/v1/iou/iouvms.rst +++ b/docs/api/v1/iou/iouvms.rst @@ -11,3 +11,9 @@ Response status codes ********************** - **200**: List of IOU VM retrieved +Sample session +*************** + + +.. literalinclude:: ../../examples/get_iouvms.txt + diff --git a/docs/api/v1/iou/iouvmsfilename.rst b/docs/api/v1/iou/iouvmsfilename.rst new file mode 100644 index 00000000..3772f59a --- /dev/null +++ b/docs/api/v1/iou/iouvmsfilename.rst @@ -0,0 +1,13 @@ +/v1/iou/vms/{filename} +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/iou/vms/**{filename}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Upload IOU image. + +Response status codes +********************** +- **204**: Image uploaded + diff --git a/docs/api/v1/iou/projectsprojectidiouvms.rst b/docs/api/v1/iou/projectsprojectidiouvms.rst index e780349e..2ff983d8 100644 --- a/docs/api/v1/iou/projectsprojectidiouvms.rst +++ b/docs/api/v1/iou/projectsprojectidiouvms.rst @@ -25,15 +25,17 @@ Input Name Mandatory Type Description console ['integer', 'null'] console TCP port ethernet_adapters integer How many ethernet adapters are connected to the IOU - initial_config ['string', 'null'] Path to the initial configuration of IOU - initial_config_content ['string', 'null'] Initial configuration of IOU iourc_content ['string', 'null'] Content of the iourc file, if a file exist on servers this variable is ignored. It's mostly for compatibility with < 1.3 releases l1_keepalives ['boolean', 'null'] Always up ethernet interface 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 @@ -46,15 +48,16 @@ Output Name Mandatory Type Description console ✔ integer console TCP port ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU - initial_config ✔ ['string', 'null'] Path of the initial config content relative to project directory iourc_path ['string', 'null'] Path of the iourc file used by remote servers l1_keepalives ✔ boolean Always up ethernet interface 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_id ✔ string IOU VM UUID diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmid.rst b/docs/api/v1/iou/projectsprojectidiouvmsvmid.rst index 6d98a4bc..4deb1d17 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmid.rst +++ b/docs/api/v1/iou/projectsprojectidiouvmsvmid.rst @@ -26,15 +26,16 @@ Output Name Mandatory Type Description console ✔ integer console TCP port ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU - initial_config ✔ ['string', 'null'] Path of the initial config content relative to project directory iourc_path ['string', 'null'] Path of the iourc file used by remote servers l1_keepalives ✔ boolean Always up ethernet interface 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_id ✔ string IOU VM UUID @@ -70,14 +71,15 @@ Input Name Mandatory Type Description console ['integer', 'null'] console TCP port ethernet_adapters ['integer', 'null'] How many ethernet adapters are connected to the IOU - initial_config_content ['string', 'null'] Initial configuration of IOU iourc_content ['string', 'null'] Content of the iourc file, if a file exist on servers this variable is ignored. It's mostly for compatibility with < 1.3 releases l1_keepalives ['boolean', 'null'] Always up ethernet interface 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 @@ -89,15 +91,16 @@ Output Name Mandatory Type Description console ✔ integer console TCP port ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU - initial_config ✔ ['string', 'null'] Path of the initial config content relative to project directory iourc_path ['string', 'null'] Path of the iourc file used by remote servers l1_keepalives ✔ boolean Always up ethernet interface 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_id ✔ string IOU VM UUID diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 4f203c58..ebec7d20 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a IOU instance Parameters ********** -- **port_number**: Port where the nio should be added - **vm_id**: UUID for the instance -- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project +- **adapter_number**: Network adapter where the nio is located +- **port_number**: Port where the nio should be added Response status codes ********************** @@ -33,10 +33,10 @@ Remove a NIO from a IOU instance Parameters ********** -- **port_number**: Port from where the nio should be removed - **vm_id**: UUID for the instance -- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project +- **adapter_number**: Network adapter where the nio is located +- **port_number**: Port from where the nio should be removed Response status codes ********************** diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index 8886e031..6e985b9d 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance Parameters ********** -- **port_number**: Port on the adapter - **vm_id**: UUID for the instance -- **adapter_number**: Adapter to start a packet capture - **project_id**: UUID for the project +- **adapter_number**: Adapter to start a packet capture +- **port_number**: Port on the adapter Response status codes ********************** diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index a1b1d625..699eec12 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Adapter to stop a packet capture - **project_id**: UUID for the project +- **adapter_number**: Adapter to stop a packet capture +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidinitialconfig.rst b/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigs.rst similarity index 52% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidinitialconfig.rst rename to docs/api/v1/iou/projectsprojectidiouvmsvmidconfigs.rst index 6159e783..f9955b7e 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidinitialconfig.rst +++ b/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigs.rst @@ -1,15 +1,15 @@ -/v1/projects/{project_id}/iou/vms/{vm_id}/initial_config +/v1/projects/{project_id}/iou/vms/{vm_id}/configs ---------------------------------------------------------------------------------------------------------------------- .. contents:: -GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/initial_config +GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/configs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the initial config content +Retrieve the startup and private configs content Response status codes ********************** -- **200**: Initial config retrieved +- **200**: Configs retrieved - **400**: Invalid request - **404**: Instance doesn't exist @@ -19,12 +19,13 @@ Output - + +
Name Mandatory Type Description
content ✔ ['string', 'null'] Content of the initial configuration file
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/get_projectsprojectidiouvmsvmidinitialconfig.txt +.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmidconfigs.txt diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigssave.rst b/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigssave.rst new file mode 100644 index 00000000..b212fc51 --- /dev/null +++ b/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigssave.rst @@ -0,0 +1,15 @@ +/v1/projects/{project_id}/iou/vms/{vm_id}/configs/save +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/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/v1/project/projectsprojectidfiles.rst b/docs/api/v1/project/projectsprojectidfiles.rst new file mode 100644 index 00000000..2c877216 --- /dev/null +++ b/docs/api/v1/project/projectsprojectidfiles.rst @@ -0,0 +1,24 @@ +/v1/projects/{project_id}/files +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +GET /v1/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/get_projectsprojectidfiles.txt + diff --git a/docs/api/v1/project/projectsprojectidfilespath.rst b/docs/api/v1/project/projectsprojectidfilespath.rst new file mode 100644 index 00000000..4ce054ef --- /dev/null +++ b/docs/api/v1/project/projectsprojectidfilespath.rst @@ -0,0 +1,19 @@ +/v1/projects/{project_id}/files/{path:.+} +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +GET /v1/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/v1/project/projectsprojectidnotifications.rst b/docs/api/v1/project/projectsprojectidnotifications.rst new file mode 100644 index 00000000..7967deb0 --- /dev/null +++ b/docs/api/v1/project/projectsprojectidnotifications.rst @@ -0,0 +1,18 @@ +/v1/projects/{project_id}/notifications +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +GET /v1/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/v1/qemu/projectsprojectidqemuvms.rst b/docs/api/v1/qemu/projectsprojectidqemuvms.rst index 62ce6757..0fbdb8f7 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvms.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvms.rst @@ -23,6 +23,7 @@ Input + @@ -34,7 +35,9 @@ Input + + @@ -49,6 +52,7 @@ Output
Name Mandatory Type Description
acpi_shutdown ['boolean', 'null'] ACPI shutdown support
adapter_type ['string', 'null'] QEMU adapter type
adapters ['integer', 'null'] number of adapters
console ['integer', 'null'] console TCP port
initrd ['string', 'null'] QEMU initrd path
kernel_command_line ['string', 'null'] QEMU kernel command line
kernel_image ['string', 'null'] QEMU kernel image path
kvm ['boolean', 'null'] KVM support
legacy_networking ['boolean', 'null'] Use QEMU legagy networking commands (-net syntax)
mac_address ['string', 'null'] QEMU MAC address
name ✔ string QEMU VM instance name
options ['string', 'null'] Additional QEMU options
process_priority enum Possible values: realtime, very high, high, normal, low, very low, null
+ @@ -60,7 +64,9 @@ Output + + diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst index 7cf89de6..758d6449 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst @@ -24,6 +24,7 @@ Output
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
console ✔ integer console TCP port
initrd ✔ string QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kvm ✔ ['boolean', 'null'] KVM support
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
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
+ @@ -35,7 +36,9 @@ Output + + @@ -74,6 +77,7 @@ Input
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
console ✔ integer console TCP port
initrd ✔ string QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kvm ✔ ['boolean', 'null'] KVM support
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
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
+ @@ -85,7 +89,9 @@ Input + + @@ -99,6 +105,7 @@ Output
Name Mandatory Type Description
acpi_shutdown ['boolean', 'null'] ACPI shutdown support
adapter_type ['string', 'null'] QEMU adapter type
adapters ['integer', 'null'] number of adapters
console ['integer', 'null'] console TCP port
initrd ['string', 'null'] QEMU initrd path
kernel_command_line ['string', 'null'] QEMU kernel command line
kernel_image ['string', 'null'] QEMU kernel image path
kvm ['boolean', 'null'] KVM support
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
process_priority enum Possible values: realtime, very high, high, normal, low, very low, null
+ @@ -110,7 +117,9 @@ Output + + diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 71edd895..f06974ee 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a Qemu VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project +- **adapter_number**: Network adapter where the nio is located +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -33,10 +33,10 @@ Remove a NIO from a Qemu VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project +- **adapter_number**: Network adapter where the nio is located +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/qemu/qemuimgbinaries.rst b/docs/api/v1/qemu/qemuimgbinaries.rst new file mode 100644 index 00000000..596e0b69 --- /dev/null +++ b/docs/api/v1/qemu/qemuimgbinaries.rst @@ -0,0 +1,15 @@ +/v1/qemu/img-binaries +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +GET /v1/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/v1/qemu/qemuvmsfilename.rst b/docs/api/v1/qemu/qemuvmsfilename.rst new file mode 100644 index 00000000..b44f4ce2 --- /dev/null +++ b/docs/api/v1/qemu/qemuvmsfilename.rst @@ -0,0 +1,13 @@ +/v1/qemu/vms/{filename} +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/qemu/vms/**{filename}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Upload Qemu image. + +Response status codes +********************** +- **204**: Image uploaded + diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst index a6a77682..e8463831 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst @@ -23,6 +23,7 @@ Input
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
console ✔ integer console TCP port
initrd ✔ string QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kvm ✔ ['boolean', 'null'] KVM support
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
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
+ @@ -42,6 +43,7 @@ Output
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
+ diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst index d345c454..7f8d3726 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst @@ -24,6 +24,7 @@ Output
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
+ @@ -66,6 +67,7 @@ Input
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
+ @@ -83,6 +85,7 @@ Output
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
+ diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst index c6e4393b..bbcc5e32 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Adapter where the nio should be added - **project_id**: UUID for the project +- **adapter_number**: Adapter where the nio should be added +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -33,10 +33,10 @@ Remove a NIO from a VirtualBox VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Adapter from where the nio should be removed - **project_id**: UUID for the project +- **adapter_number**: Adapter from where the nio should be removed +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index ac55cd81..2d3c2f36 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Adapter to start a packet capture - **project_id**: UUID for the project +- **adapter_number**: Adapter to start a packet capture +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 65899c26..664f5845 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance Parameters ********** -- **port_number**: Port on the adapter (always 0) - **vm_id**: UUID for the instance -- **adapter_number**: Adapter to stop a packet capture - **project_id**: UUID for the project +- **adapter_number**: Adapter to stop a packet capture +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevms.rst b/docs/api/v1/vmware/projectsprojectidvmwarevms.rst index bb8ea8a1..f500d18c 100644 --- a/docs/api/v1/vmware/projectsprojectidvmwarevms.rst +++ b/docs/api/v1/vmware/projectsprojectidvmwarevms.rst @@ -23,11 +23,14 @@ Input
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
+ + +
Name Mandatory Type Description
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
vm_id string VMware VM instance identifier
vmx_path ✔ string path to the vmx file
@@ -38,11 +41,14 @@ Output + + +
Name Mandatory Type Description
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
vm_id ✔ string VMware VM instance UUID
vmx_path string path to the vmx file
diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmid.rst b/docs/api/v1/vmware/projectsprojectidvmwarevmsvmid.rst index 54445e72..246d7ce9 100644 --- a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmid.rst +++ b/docs/api/v1/vmware/projectsprojectidvmwarevmsvmid.rst @@ -24,11 +24,14 @@ Output + + +
Name Mandatory Type Description
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
vm_id ✔ string VMware VM instance UUID
vmx_path string path to the vmx file
@@ -56,10 +59,13 @@ Input + + +
Name Mandatory Type Description
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
vmx_path string path to the vmx file
@@ -69,11 +75,14 @@ Output + + +
Name Mandatory Type Description
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
vm_id ✔ string VMware VM instance UUID
vmx_path string path to the vmx file
diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst new file mode 100644 index 00000000..67c32e7d --- /dev/null +++ b/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -0,0 +1,40 @@ +/v1/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/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 +********** +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project +- **adapter_number**: Adapter where the nio should be added +- **port_number**: Port on the adapter (always 0) + +Response status codes +********************** +- **400**: Invalid request +- **201**: NIO created +- **404**: Instance doesn't exist + + +DELETE /v1/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 +********** +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project +- **adapter_number**: Adapter from where the nio should be removed +- **port_number**: Port on the adapter (always 0) + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: NIO deleted + diff --git a/docs/api/v1/vmware/vmwarevms.rst b/docs/api/v1/vmware/vmwarevms.rst new file mode 100644 index 00000000..af366959 --- /dev/null +++ b/docs/api/v1/vmware/vmwarevms.rst @@ -0,0 +1,13 @@ +/v1/vmware/vms +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +GET /v1/vmware/vms +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get all VMware VMs available + +Response status codes +********************** +- **200**: Success + diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst index 3bc1e779..90d6d894 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst @@ -40,6 +40,7 @@ Output 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_id ✔ string VPCS VM UUID diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst index 0ff49d0a..455d54d8 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst @@ -29,6 +29,7 @@ Output 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_id ✔ string VPCS VM UUID @@ -77,6 +78,7 @@ Output 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_id ✔ string VPCS VM UUID diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 21a4ae02..92b8751d 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a VPCS instance Parameters ********** -- **port_number**: Port where the nio should be added - **vm_id**: UUID for the instance -- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project +- **adapter_number**: Network adapter where the nio is located +- **port_number**: Port where the nio should be added Response status codes ********************** @@ -33,10 +33,10 @@ Remove a NIO from a VPCS instance Parameters ********** -- **port_number**: Port from where the nio should be removed - **vm_id**: UUID for the instance -- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project +- **adapter_number**: Network adapter where the nio is located +- **port_number**: Port from where the nio should be removed Response status codes ********************** diff --git a/tests/handlers/api/test_project.py b/tests/handlers/api/test_project.py index 852c27fd..843af8e2 100644 --- a/tests/handlers/api/test_project.py +++ b/tests/handlers/api/test_project.py @@ -233,7 +233,7 @@ def test_get_file(server, tmpdir): with open(os.path.join(project.path, "hello"), "w+") as f: f.write("world") - response = server.get("/projects/{project_id}/files/hello".format(project_id=project.id), raw=True, example=True) + response = server.get("/projects/{project_id}/files/hello".format(project_id=project.id), raw=True) assert response.status == 200 assert response.body == b"world" diff --git a/tests/modules/vpcs/test_vpcs_vm.py b/tests/modules/vpcs/test_vpcs_vm.py index e0cb9ff0..0fb269c5 100644 --- a/tests/modules/vpcs/test_vpcs_vm.py +++ b/tests/modules/vpcs/test_vpcs_vm.py @@ -202,7 +202,7 @@ def test_update_startup_script_h(vm): def test_get_startup_script(vm): content = "echo GNS3 VPCS\nip 192.168.1.2" vm.startup_script = content - assert vm.startup_script == os.linesep.join(["echo GNS3 VPCS","ip 192.168.1.2"]) + assert vm.startup_script == os.linesep.join(["echo GNS3 VPCS", "ip 192.168.1.2"]) def test_get_startup_script_using_default_script(vm):