From e4b12f49d187cb3aad2a2acea3e00004e4ebd182 Mon Sep 17 00:00:00 2001 From: Julien Duponchelle Date: Fri, 4 Mar 2016 17:50:17 +0100 Subject: [PATCH] Build doc support controller --- .../api/examples/delete_projectsprojectid.txt | 3 +- ...ptersadapternumberdportsportnumberdnio.txt | 13 ++++ .../delete_projectsprojectidiouvmsvmid.txt | 7 +- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- .../delete_projectsprojectidqemuvmsvmid.txt | 7 +- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- .../delete_projectsprojectidvpcsvmsvmid.txt | 7 +- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- docs/api/examples/get_interfaces.txt | 26 +++++-- docs/api/examples/get_iouvms.txt | 3 +- docs/api/examples/get_projects.txt | 13 ++-- docs/api/examples/get_projectsprojectid.txt | 9 +-- .../examples/get_projectsprojectidfiles.txt | 3 +- .../get_projectsprojectidiouvmsvmid.txt | 14 ++-- ...get_projectsprojectidiouvmsvmidconfigs.txt | 7 +- .../get_projectsprojectidqemuvmsvmid.txt | 18 ++--- ...get_projectsprojectidvirtualboxvmsvmid.txt | 9 +-- .../get_projectsprojectidvpcsvmsvmid.txt | 14 ++-- docs/api/examples/get_qemubinaries.txt | 3 +- docs/api/examples/get_qemucapabilities.txt | 3 +- docs/api/examples/get_version.txt | 7 +- docs/api/examples/post_configreload.txt | 3 +- docs/api/examples/post_projects.txt | 11 ++- .../examples/post_projectsprojectidclose.txt | 3 +- .../examples/post_projectsprojectidcommit.txt | 3 +- ...ptersadapternumberdportsportnumberdnio.txt | 25 +++++++ ...ternumberdportsportnumberdstartcapture.txt | 20 +++++ ...pternumberdportsportnumberdstopcapture.txt | 13 ++++ .../examples/post_projectsprojectidiouvms.txt | 14 ++-- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- ...ternumberdportsportnumberdstartcapture.txt | 11 ++- ...pternumberdportsportnumberdstopcapture.txt | 7 +- ...post_projectsprojectidiouvmsvmidreload.txt | 7 +- .../post_projectsprojectidiouvmsvmidstart.txt | 31 ++++++-- .../post_projectsprojectidiouvmsvmidstop.txt | 7 +- .../post_projectsprojectidportsudp.txt | 3 +- .../post_projectsprojectidqemuvms.txt | 24 +++--- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- ...ost_projectsprojectidqemuvmsvmidreload.txt | 7 +- ...ost_projectsprojectidqemuvmsvmidresume.txt | 7 +- ...post_projectsprojectidqemuvmsvmidstart.txt | 54 ++++++++++++-- .../post_projectsprojectidqemuvmsvmidstop.txt | 7 +- ...st_projectsprojectidqemuvmsvmidsuspend.txt | 7 +- .../post_projectsprojectidvirtualboxvms.txt | 5 +- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- ...ojectsprojectidvirtualboxvmsvmidreload.txt | 7 +- ...ojectsprojectidvirtualboxvmsvmidresume.txt | 7 +- ...rojectsprojectidvirtualboxvmsvmidstart.txt | 7 +- ...projectsprojectidvirtualboxvmsvmidstop.txt | 7 +- ...jectsprojectidvirtualboxvmsvmidsuspend.txt | 7 +- .../post_projectsprojectidvpcsvms.txt | 10 +-- ...ptersadapternumberdportsportnumberdnio.txt | 7 +- ...ost_projectsprojectidvpcsvmsvmidreload.txt | 7 +- ...post_projectsprojectidvpcsvmsvmidstart.txt | 23 ++++-- .../post_projectsprojectidvpcsvmsvmidstop.txt | 7 +- docs/api/examples/post_qemuimg.txt | 3 +- docs/api/examples/post_servers.txt | 30 ++++++++ docs/api/examples/post_version.txt | 11 ++- docs/api/examples/put_projectsprojectid.txt | 13 ++-- .../put_projectsprojectiddockervmsvmid.txt | 33 +++++++++ .../put_projectsprojectidiouvmsvmid.txt | 16 ++-- .../put_projectsprojectidqemuvmsvmid.txt | 18 ++--- ...put_projectsprojectidvirtualboxvmsvmid.txt | 9 +-- .../put_projectsprojectidvpcsvmsvmid.txt | 14 ++-- docs/api/v1/{ => controller}/server.rst | 0 docs/api/v1/controller/server/servers.rst | 48 ++++++++++++ .../docker/projectsprojectiddockerimages.rst | 49 ------------ .../projectsprojectiddockerimagesidreload.rst | 50 ------------- .../projectsprojectiddockerimagesidstart.rst | 50 ------------- .../projectsprojectiddockerimagesidstop.rst | 50 ------------- ...projectsprojectiddockerimagesidsuspend.rst | 50 ------------- .../iou/projectsprojectidiouvmsvmidstart.rst | 35 --------- .../projectsprojectidqemuvmsvmidstart.rst | 26 ------- docs/api/v1/{ => server}/config.rst | 0 .../v1/{ => server}/config/configreload.rst | 2 +- docs/api/v1/{ => server}/docker.rst | 0 .../v1/{ => server}/docker/dockerimages.rst | 0 .../docker/projectsprojectiddockervms.rst | 56 ++++++++++++++ .../docker/projectsprojectiddockervmsid.rst} | 6 +- .../projectsprojectiddockervmsidreload.rst | 57 ++++++++++++++ .../projectsprojectiddockervmsidstart.rst | 57 ++++++++++++++ .../projectsprojectiddockervmsidstop.rst | 57 ++++++++++++++ .../projectsprojectiddockervmsidsuspend.rst | 57 ++++++++++++++ .../docker/projectsprojectiddockervmsvmid.rst | 62 ++++++++++++++++ ...tersadapternumberdportsportnumberdnio.rst} | 22 ++++-- ...ternumberdportsportnumberdstartcapture.rst | 39 ++++++++++ ...pternumberdportsportnumberdstopcapture.rst | 29 ++++++++ docs/api/v1/{ => server}/dynamips_device.rst | 0 .../projectsprojectiddynamipsdevices.rst | 0 ...ojectsprojectiddynamipsdevicesdeviceid.rst | 6 +- ...mipsdevicesdeviceidportsportnumberdnio.rst | 4 +- ...esdeviceidportsportnumberdstartcapture.rst | 4 +- ...cesdeviceidportsportnumberdstopcapture.rst | 2 +- docs/api/v1/{ => server}/dynamips_vm.rst | 0 .../{ => server}/dynamips_vm/dynamipsvms.rst | 0 .../dynamips_vm/dynamipsvmspath.rst | 0 .../projectsprojectiddynamipsvms.rst | 0 .../projectsprojectiddynamipsvmsvmid.rst | 0 ...ptersadapternumberdportsportnumberdnio.rst | 4 +- ...ternumberdportsportnumberdstartcapture.rst | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 2 +- ...ectsprojectiddynamipsvmsvmidautoidlepc.rst | 0 ...rojectsprojectiddynamipsvmsvmidconfigs.rst | 0 ...ctsprojectiddynamipsvmsvmidconfigssave.rst | 0 ...rojectiddynamipsvmsvmididlepcproposals.rst | 0 ...projectsprojectiddynamipsvmsvmidreload.rst | 0 ...projectsprojectiddynamipsvmsvmidresume.rst | 0 .../projectsprojectiddynamipsvmsvmidstart.rst | 0 .../projectsprojectiddynamipsvmsvmidstop.rst | 0 ...rojectsprojectiddynamipsvmsvmidsuspend.rst | 0 docs/api/v1/{ => server}/file.rst | 0 docs/api/v1/{ => server}/file/filesstream.rst | 0 docs/api/v1/{ => server}/iou.rst | 0 docs/api/v1/{ => server}/iou/iouvms.rst | 2 +- docs/api/v1/{ => server}/iou/iouvmspath.rst | 0 .../iou/projectsprojectidiouvms.rst | 3 +- .../iou/projectsprojectidiouvmsvmid.rst | 8 +- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...ternumberdportsportnumberdstartcapture.rst | 6 +- ...pternumberdportsportnumberdstopcapture.rst | 4 +- .../projectsprojectidiouvmsvmidconfigs.rst | 2 +- ...projectsprojectidiouvmsvmidconfigssave.rst | 0 .../iou/projectsprojectidiouvmsvmidreload.rst | 2 +- .../iou/projectsprojectidiouvmsvmidstart.rst | 60 +++++++++++++++ .../iou/projectsprojectidiouvmsvmidstop.rst | 2 +- docs/api/v1/{ => server}/network.rst | 0 .../v1/{ => server}/network/interfaces.rst | 2 +- .../network/projectsprojectidportsudp.rst | 2 +- docs/api/v1/{ => server}/project.rst | 0 docs/api/v1/{ => server}/project/projects.rst | 4 +- .../project/projectsprojectid.rst | 6 +- .../project/projectsprojectidclose.rst | 2 +- .../project/projectsprojectidcommit.rst | 2 +- .../project/projectsprojectidfiles.rst | 2 +- .../project/projectsprojectidfilespath.rst | 0 .../projectsprojectidnotifications.rst | 0 docs/api/v1/{ => server}/qemu.rst | 0 .../qemu/projectsprojectidqemuvms.rst | 5 +- .../qemu/projectsprojectidqemuvmsvmid.rst | 14 ++-- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- .../projectsprojectidqemuvmsvmidreload.rst | 2 +- .../projectsprojectidqemuvmsvmidresume.rst | 2 +- .../projectsprojectidqemuvmsvmidstart.rst | 74 +++++++++++++++++++ .../qemu/projectsprojectidqemuvmsvmidstop.rst | 2 +- .../projectsprojectidqemuvmsvmidsuspend.rst | 2 +- .../api/v1/{ => server}/qemu/qemubinaries.rst | 2 +- .../v1/{ => server}/qemu/qemucapabilities.rst | 2 +- docs/api/v1/{ => server}/qemu/qemuimg.rst | 2 +- .../v1/{ => server}/qemu/qemuimgbinaries.rst | 0 docs/api/v1/{ => server}/qemu/qemuvms.rst | 0 docs/api/v1/{ => server}/qemu/qemuvmspath.rst | 0 docs/api/v1/server/server.rst | 8 ++ .../v1/server/{ => server}/servershutdown.rst | 0 docs/api/v1/{ => server}/version.rst | 0 docs/api/v1/{ => server}/version/version.rst | 4 +- docs/api/v1/{ => server}/virtualbox.rst | 0 .../projectsprojectidvirtualboxvms.rst | 2 +- .../projectsprojectidvirtualboxvmsvmid.rst | 4 +- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...ternumberdportsportnumberdstartcapture.rst | 3 +- ...pternumberdportsportnumberdstopcapture.rst | 2 +- ...ojectsprojectidvirtualboxvmsvmidreload.rst | 2 +- ...ojectsprojectidvirtualboxvmsvmidresume.rst | 2 +- ...rojectsprojectidvirtualboxvmsvmidstart.rst | 2 +- ...projectsprojectidvirtualboxvmsvmidstop.rst | 2 +- ...jectsprojectidvirtualboxvmsvmidsuspend.rst | 2 +- .../{ => server}/virtualbox/virtualboxvms.rst | 0 docs/api/v1/{ => server}/vmware.rst | 0 .../vmware/projectsprojectidvmwarevms.rst | 0 .../vmware/projectsprojectidvmwarevmsvmid.rst | 0 ...ptersadapternumberdportsportnumberdnio.rst | 4 +- ...ternumberdportsportnumberdstartcapture.rst | 3 +- ...pternumberdportsportnumberdstopcapture.rst | 2 +- ...sprojectidvmwarevmsvmidinterfacesvmnet.rst | 0 .../projectsprojectidvmwarevmsvmidreload.rst | 0 .../projectsprojectidvmwarevmsvmidresume.rst | 0 .../projectsprojectidvmwarevmsvmidstart.rst | 0 .../projectsprojectidvmwarevmsvmidstop.rst | 0 .../projectsprojectidvmwarevmsvmidsuspend.rst | 0 docs/api/v1/{ => server}/vmware/vmwarevms.rst | 0 docs/api/v1/{ => server}/vpcs.rst | 0 .../vpcs/projectsprojectidvpcsvms.rst | 3 +- .../vpcs/projectsprojectidvpcsvmsvmid.rst | 8 +- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- .../projectsprojectidvpcsvmsvmidreload.rst | 2 +- .../projectsprojectidvpcsvmsvmidstart.rst | 43 +++++++++++ .../vpcs/projectsprojectidvpcsvmsvmidstop.rst | 2 +- .../projectsprojectidvpcsvmsvmidstart.rst | 26 ------- docs/index.rst | 17 ++++- gns3server/web/documentation.py | 26 +++++-- gns3server/web/route.py | 1 + tests/handlers/api/test_server.py | 2 +- tests/web/test_documentation.py | 15 ++-- 194 files changed, 1259 insertions(+), 724 deletions(-) create mode 100644 docs/api/examples/delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt create mode 100644 docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt create mode 100644 docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/post_servers.txt create mode 100644 docs/api/examples/put_projectsprojectiddockervmsvmid.txt rename docs/api/v1/{ => controller}/server.rst (100%) create mode 100644 docs/api/v1/controller/server/servers.rst delete mode 100644 docs/api/v1/docker/projectsprojectiddockerimages.rst delete mode 100644 docs/api/v1/docker/projectsprojectiddockerimagesidreload.rst delete mode 100644 docs/api/v1/docker/projectsprojectiddockerimagesidstart.rst delete mode 100644 docs/api/v1/docker/projectsprojectiddockerimagesidstop.rst delete mode 100644 docs/api/v1/docker/projectsprojectiddockerimagesidsuspend.rst delete mode 100644 docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst delete mode 100644 docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst rename docs/api/v1/{ => server}/config.rst (100%) rename docs/api/v1/{ => server}/config/configreload.rst (89%) rename docs/api/v1/{ => server}/docker.rst (100%) rename docs/api/v1/{ => server}/docker/dockerimages.rst (100%) create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervms.rst rename docs/api/v1/{docker/projectsprojectiddockerimagesid.rst => server/docker/projectsprojectiddockervmsid.rst} (83%) create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervmsidreload.rst create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervmsidstart.rst create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervmsidstop.rst create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervmsidsuspend.rst create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervmsvmid.rst rename docs/api/v1/{docker/projectsprojectiddockerimagesidadaptersadapternumberdportsportnumberdnio.rst => server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst} (72%) create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst create mode 100644 docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst rename docs/api/v1/{ => server}/dynamips_device.rst (100%) rename docs/api/v1/{ => server}/dynamips_device/projectsprojectiddynamipsdevices.rst (100%) rename docs/api/v1/{ => server}/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst (100%) rename docs/api/v1/{ => server}/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst (100%) rename docs/api/v1/{ => server}/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst (87%) rename docs/api/v1/{ => server}/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/dynamipsvms.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/dynamipsvmspath.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvms.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst (87%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst (100%) rename docs/api/v1/{ => server}/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst (100%) rename docs/api/v1/{ => server}/file.rst (100%) rename docs/api/v1/{ => server}/file/filesstream.rst (100%) rename docs/api/v1/{ => server}/iou.rst (100%) rename docs/api/v1/{ => server}/iou/iouvms.rst (89%) rename docs/api/v1/{ => server}/iou/iouvmspath.rst (100%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvms.rst (96%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmid.rst (94%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst (87%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst (81%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst (88%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmidconfigs.rst (93%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmidconfigssave.rst (100%) rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmidreload.rst (89%) create mode 100644 docs/api/v1/server/iou/projectsprojectidiouvmsvmidstart.rst rename docs/api/v1/{ => server}/iou/projectsprojectidiouvmsvmidstop.rst (89%) rename docs/api/v1/{ => server}/network.rst (100%) rename docs/api/v1/{ => server}/network/interfaces.rst (89%) rename docs/api/v1/{ => server}/network/projectsprojectidportsudp.rst (89%) rename docs/api/v1/{ => server}/project.rst (100%) rename docs/api/v1/{ => server}/project/projects.rst (96%) rename docs/api/v1/{ => server}/project/projectsprojectid.rst (95%) rename docs/api/v1/{ => server}/project/projectsprojectidclose.rst (89%) rename docs/api/v1/{ => server}/project/projectsprojectidcommit.rst (89%) rename docs/api/v1/{ => server}/project/projectsprojectidfiles.rst (89%) rename docs/api/v1/{ => server}/project/projectsprojectidfilespath.rst (100%) rename docs/api/v1/{ => server}/project/projectsprojectidnotifications.rst (100%) rename docs/api/v1/{ => server}/qemu.rst (100%) rename docs/api/v1/{ => server}/qemu/projectsprojectidqemuvms.rst (97%) rename docs/api/v1/{ => server}/qemu/projectsprojectidqemuvmsvmid.rst (96%) rename docs/api/v1/{ => server}/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst (87%) rename docs/api/v1/{ => server}/qemu/projectsprojectidqemuvmsvmidreload.rst (89%) rename docs/api/v1/{ => server}/qemu/projectsprojectidqemuvmsvmidresume.rst (89%) create mode 100644 docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidstart.rst rename docs/api/v1/{ => server}/qemu/projectsprojectidqemuvmsvmidstop.rst (89%) rename docs/api/v1/{ => server}/qemu/projectsprojectidqemuvmsvmidsuspend.rst (89%) rename docs/api/v1/{ => server}/qemu/qemubinaries.rst (93%) rename docs/api/v1/{ => server}/qemu/qemucapabilities.rst (93%) rename docs/api/v1/{ => server}/qemu/qemuimg.rst (98%) rename docs/api/v1/{ => server}/qemu/qemuimgbinaries.rst (100%) rename docs/api/v1/{ => server}/qemu/qemuvms.rst (100%) rename docs/api/v1/{ => server}/qemu/qemuvmspath.rst (100%) create mode 100644 docs/api/v1/server/server.rst rename docs/api/v1/server/{ => server}/servershutdown.rst (100%) rename docs/api/v1/{ => server}/version.rst (100%) rename docs/api/v1/{ => server}/version/version.rst (95%) rename docs/api/v1/{ => server}/virtualbox.rst (100%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvms.rst (98%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmid.rst (98%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst (86%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst (88%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst (100%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst (88%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst (89%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst (88%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst (89%) rename docs/api/v1/{ => server}/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst (88%) rename docs/api/v1/{ => server}/virtualbox/virtualboxvms.rst (100%) rename docs/api/v1/{ => server}/vmware.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevms.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmid.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst (88%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidreload.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidresume.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidstart.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidstop.rst (100%) rename docs/api/v1/{ => server}/vmware/projectsprojectidvmwarevmsvmidsuspend.rst (100%) rename docs/api/v1/{ => server}/vmware/vmwarevms.rst (100%) rename docs/api/v1/{ => server}/vpcs.rst (100%) rename docs/api/v1/{ => server}/vpcs/projectsprojectidvpcsvms.rst (92%) rename docs/api/v1/{ => server}/vpcs/projectsprojectidvpcsvmsvmid.rst (90%) rename docs/api/v1/{ => server}/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst (87%) rename docs/api/v1/{ => server}/vpcs/projectsprojectidvpcsvmsvmidreload.rst (89%) create mode 100644 docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidstart.rst rename docs/api/v1/{ => server}/vpcs/projectsprojectidvpcsvmsvmidstop.rst (89%) delete mode 100644 docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst diff --git a/docs/api/examples/delete_projectsprojectid.txt b/docs/api/examples/delete_projectsprojectid.txt index 36665b8c..5a6f0870 100644 --- a/docs/api/examples/delete_projectsprojectid.txt +++ b/docs/api/examples/delete_projectsprojectid.txt @@ -6,9 +6,8 @@ DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80 HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id} diff --git a/docs/api/examples/delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt new file mode 100644 index 00000000..b2d1a2ae --- /dev/null +++ b/docs/api/examples/delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -0,0 +1,13 @@ +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/e855808c-9a1c-4451-b9db-1abcf06438b3/adapters/0/ports/0/nio' + +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/e855808c-9a1c-4451-b9db-1abcf06438b3/adapters/0/ports/0/nio HTTP/1.1 + + + +HTTP/1.1 204 +ACCESS-CONTROL-ALLOW-ORIGIN: * +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/1.5.0dev1 +X-ROUTE: /v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio + diff --git a/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt b/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt index 8270b459..7b6f3d0c 100644 --- a/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt @@ -1,14 +1,13 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0813062d-a796-44ef-a5ed-e690c633012e' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/462dc3bc-80d3-4597-afe9-332956132b1d' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0813062d-a796-44ef-a5ed-e690c633012e HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/462dc3bc-80d3-4597-afe9-332956132b1d HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} diff --git a/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 9432d0ee..0c1a3792 100644 --- a/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,14 +1,13 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/8759140f-eb6f-4f3b-9a7f-86c79ec747b9/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6febc8c7-15ae-4bcf-81d0-4320f8af74c3/adapters/1/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/8759140f-eb6f-4f3b-9a7f-86c79ec747b9/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6febc8c7-15ae-4bcf-81d0-4320f8af74c3/adapters/1/ports/0/nio HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt index a884ebc5..9f4297a7 100644 --- a/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt @@ -1,14 +1,13 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/1b1a72b7-97ea-4598-8c02-2edc285f7987' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/faf129e7-c74c-4851-8677-7030cdc63a75' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/1b1a72b7-97ea-4598-8c02-2edc285f7987 HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/faf129e7-c74c-4851-8677-7030cdc63a75 HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} diff --git a/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt index f1b7a599..f72fd4ad 100644 --- a/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,14 +1,13 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b5c23125-ea22-4008-a89e-72565ae9f746/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/07380e9c-270b-441a-ba40-9a96f61a9f42/adapters/1/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b5c23125-ea22-4008-a89e-72565ae9f746/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/07380e9c-270b-441a-ba40-9a96f61a9f42/adapters/1/ports/0/nio HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 0097d4f8..bbb84600 100644 --- a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,14 +1,13 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/3f79083e-3da8-433e-9e9b-fe72a602ab4e/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/b85227ef-5bd7-4f6f-8bee-fdc859ada69b/adapters/0/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/3f79083e-3da8-433e-9e9b-fe72a602ab4e/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/b85227ef-5bd7-4f6f-8bee-fdc859ada69b/adapters/0/ports/0/nio HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt index a65bc4f9..00b00189 100644 --- a/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt @@ -1,14 +1,13 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f9f4ab8-1b77-4eee-b0fb-e8d299b843a7' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/e2a4567d-d8e9-4bc9-aede-c00dce610025' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f9f4ab8-1b77-4eee-b0fb-e8d299b843a7 HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/e2a4567d-d8e9-4bc9-aede-c00dce610025 HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} diff --git a/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt index b82b051e..13672573 100644 --- a/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,14 +1,13 @@ -curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6666f3a7-d805-4572-a35c-bc15213f0b52/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/8acc4ad4-9c93-4ac9-88ac-46fd449fa994/adapters/0/ports/0/nio' -DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6666f3a7-d805-4572-a35c-bc15213f0b52/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/8acc4ad4-9c93-4ac9-88ac-46fd449fa994/adapters/0/ports/0/nio HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/get_interfaces.txt b/docs/api/examples/get_interfaces.txt index 546cee82..b1ab25c1 100644 --- a/docs/api/examples/get_interfaces.txt +++ b/docs/api/examples/get_interfaces.txt @@ -6,11 +6,10 @@ GET /v1/interfaces HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 1012 +CONTENT-LENGTH: 1253 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/interfaces [ @@ -51,12 +50,12 @@ X-ROUTE: /v1/interfaces }, { "id": "vboxnet0", - "ip_address": "172.16.43.1", + "ip_address": "", "name": "vboxnet0" }, { "id": "vboxnet1", - "ip_address": "192.168.59.3", + "ip_address": "", "name": "vboxnet1" }, { @@ -66,7 +65,22 @@ X-ROUTE: /v1/interfaces }, { "id": "vboxnet3", - "ip_address": "192.168.99.1", + "ip_address": "", "name": "vboxnet3" + }, + { + "id": "vboxnet4", + "ip_address": "", + "name": "vboxnet4" + }, + { + "id": "vboxnet5", + "ip_address": "", + "name": "vboxnet5" + }, + { + "id": "vboxnet6", + "ip_address": "", + "name": "vboxnet6" } ] diff --git a/docs/api/examples/get_iouvms.txt b/docs/api/examples/get_iouvms.txt index e9f45840..5b52e2ed 100644 --- a/docs/api/examples/get_iouvms.txt +++ b/docs/api/examples/get_iouvms.txt @@ -6,11 +6,10 @@ GET /v1/iou/vms HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 72 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/iou/vms [ diff --git a/docs/api/examples/get_projects.txt b/docs/api/examples/get_projects.txt index c838d962..3e2f61a6 100644 --- a/docs/api/examples/get_projects.txt +++ b/docs/api/examples/get_projects.txt @@ -6,25 +6,24 @@ GET /v1/projects HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 656 +CONTENT-LENGTH: 692 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects [ { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp56cw4wg9/projects", "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo/00010203-0405-0607-0809-0a0b0c0d0e0b", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp56cw4wg9/projects/00010203-0405-0607-0809-0a0b0c0d0e0b", "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0b", "temporary": false }, { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp56cw4wg9/projects", "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo/00010203-0405-0607-0809-0a0b0c0d0e0f", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp56cw4wg9/projects/00010203-0405-0607-0809-0a0b0c0d0e0f", "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f", "temporary": false } diff --git a/docs/api/examples/get_projectsprojectid.txt b/docs/api/examples/get_projectsprojectid.txt index abf0fc41..52db1d3b 100644 --- a/docs/api/examples/get_projectsprojectid.txt +++ b/docs/api/examples/get_projectsprojectid.txt @@ -6,17 +6,16 @@ GET /v1/projects/00010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 297 +CONTENT-LENGTH: 315 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id} { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpchvw88rg", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2r8r1n4h/projects", "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpchvw88rg/00010203-0405-0607-0809-0a0b0c0d0e02", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2r8r1n4h/projects/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 index fe554479..328eacce 100644 --- a/docs/api/examples/get_projectsprojectidfiles.txt +++ b/docs/api/examples/get_projectsprojectidfiles.txt @@ -6,11 +6,10 @@ GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/files HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 204 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/files [ diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt index ad02cc8e..55a4cf93 100644 --- a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt @@ -1,19 +1,19 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/82f6e25c-6960-421d-9567-a7453642935b' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/f2f721ce-fb76-4b27-bf90-c4fd548db372' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/82f6e25c-6960-421d-9567-a7453642935b HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/f2f721ce-fb76-4b27-bf90-c4fd548db372 HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 610 +CONTENT-LENGTH: 643 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} { + "command_line": "", "console": 2001, "ethernet_adapters": 2, "iourc_path": null, @@ -28,6 +28,6 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} "serial_adapters": 2, "startup_config": null, "use_default_iou_values": true, - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/82f6e25c-6960-421d-9567-a7453642935b", - "vm_id": "82f6e25c-6960-421d-9567-a7453642935b" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpsfiobxfb/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/f2f721ce-fb76-4b27-bf90-c4fd548db372", + "vm_id": "f2f721ce-fb76-4b27-bf90-c4fd548db372" } diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt b/docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt index fb976908..179d2768 100644 --- a/docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt +++ b/docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt @@ -1,16 +1,15 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/9ff2d283-1365-4422-93e7-e14c56b809cb/configs' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/cce11ae9-169f-4be9-8104-3a1ad07d95ea/configs' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/9ff2d283-1365-4422-93e7-e14c56b809cb/configs HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/cce11ae9-169f-4be9-8104-3a1ad07d95ea/configs HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 40 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/configs { diff --git a/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt index afcaa30b..b62fb757 100644 --- a/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt @@ -1,16 +1,15 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/84777300-eef4-4a3a-9135-d7009bdb0722' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b7c0e4f8-f8a9-4a48-9e5c-62b5845c22c6' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/84777300-eef4-4a3a-9135-d7009bdb0722 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b7c0e4f8-f8a9-4a48-9e5c-62b5845c22c6 HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 1353 +CONTENT-LENGTH: 1386 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} { @@ -20,6 +19,7 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} "boot_priority": "c", "cdrom_image": "", "cdrom_image_md5sum": null, + "command_line": "", "console": 2001, "console_type": "telnet", "cpu_throttling": 0, @@ -42,15 +42,15 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} "kernel_image": "", "kernel_image_md5sum": null, "legacy_networking": false, - "mac_address": "00:00:ab:07:22:00", + "mac_address": "00:00:ab:22:c6:00", "name": "PC TEST 1", "options": "", "platform": "x86_64", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpich388hc/qemu-system-x86_64", "ram": 256, "usage": "", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/84777300-eef4-4a3a-9135-d7009bdb0722", - "vm_id": "84777300-eef4-4a3a-9135-d7009bdb0722" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/b7c0e4f8-f8a9-4a48-9e5c-62b5845c22c6", + "vm_id": "b7c0e4f8-f8a9-4a48-9e5c-62b5845c22c6" } diff --git a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt index b2bee70c..72296073 100644 --- a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt @@ -1,16 +1,15 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/63b9b470-5a07-4cfe-b9d5-ae5d5518b988' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f8b22093-7b10-4043-ad98-1ff5d2d6bf64' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/63b9b470-5a07-4cfe-b9d5-ae5d5518b988 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f8b22093-7b10-4043-ad98-1ff5d2d6bf64 HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 415 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} { @@ -25,6 +24,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} "ram": 0, "use_any_adapter": false, "vm_directory": null, - "vm_id": "63b9b470-5a07-4cfe-b9d5-ae5d5518b988", + "vm_id": "f8b22093-7b10-4043-ad98-1ff5d2d6bf64", "vmname": "VMTEST" } diff --git a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt index 9854b65a..500be76d 100644 --- a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt @@ -1,25 +1,25 @@ -curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/7e24fcc2-e38c-43e8-a7bb-fc22d7b91547' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/1ef629f2-14b4-40d8-8a38-6e5efd975bf3' -GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/7e24fcc2-e38c-43e8-a7bb-fc22d7b91547 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/1ef629f2-14b4-40d8-8a38-6e5efd975bf3 HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 422 +CONTENT-LENGTH: 455 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} { + "command_line": "", "console": 2010, "name": "PC TEST 1", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, "status": "stopped", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/7e24fcc2-e38c-43e8-a7bb-fc22d7b91547", - "vm_id": "7e24fcc2-e38c-43e8-a7bb-fc22d7b91547" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/1ef629f2-14b4-40d8-8a38-6e5efd975bf3", + "vm_id": "1ef629f2-14b4-40d8-8a38-6e5efd975bf3" } diff --git a/docs/api/examples/get_qemubinaries.txt b/docs/api/examples/get_qemubinaries.txt index bba76e15..0b2b2065 100644 --- a/docs/api/examples/get_qemubinaries.txt +++ b/docs/api/examples/get_qemubinaries.txt @@ -10,11 +10,10 @@ GET /v1/qemu/binaries HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 212 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/qemu/binaries [ diff --git a/docs/api/examples/get_qemucapabilities.txt b/docs/api/examples/get_qemucapabilities.txt index 1f348cfa..681a2afe 100644 --- a/docs/api/examples/get_qemucapabilities.txt +++ b/docs/api/examples/get_qemucapabilities.txt @@ -6,11 +6,10 @@ GET /v1/qemu/capabilities HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 39 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/qemu/capabilities { diff --git a/docs/api/examples/get_version.txt b/docs/api/examples/get_version.txt index 76196256..f6e7b75d 100644 --- a/docs/api/examples/get_version.txt +++ b/docs/api/examples/get_version.txt @@ -6,14 +6,13 @@ GET /v1/version HTTP/1.1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 50 +CONTENT-LENGTH: 49 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/version { "local": true, - "version": "1.4.0dev13" + "version": "1.5.0dev1" } diff --git a/docs/api/examples/post_configreload.txt b/docs/api/examples/post_configreload.txt index 6d0ec2c0..2b71315d 100644 --- a/docs/api/examples/post_configreload.txt +++ b/docs/api/examples/post_configreload.txt @@ -6,9 +6,8 @@ POST /v1/config/reload HTTP/1.1 HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/config/reload diff --git a/docs/api/examples/post_projects.txt b/docs/api/examples/post_projects.txt index e63a90ac..184c1987 100644 --- a/docs/api/examples/post_projects.txt +++ b/docs/api/examples/post_projects.txt @@ -8,17 +8,16 @@ POST /v1/projects HTTP/1.1 HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 297 +CONTENT-LENGTH: 315 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpp319gdgn", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp5mz0iw2t/projects", "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpp319gdgn/054e6ecb-1e9d-4c74-ad08-1209264bd96d", - "project_id": "054e6ecb-1e9d-4c74-ad08-1209264bd96d", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp5mz0iw2t/projects/3a5333d2-6f73-4647-a263-664b5eb427eb", + "project_id": "3a5333d2-6f73-4647-a263-664b5eb427eb", "temporary": false } diff --git a/docs/api/examples/post_projectsprojectidclose.txt b/docs/api/examples/post_projectsprojectidclose.txt index e3538f17..93aebd77 100644 --- a/docs/api/examples/post_projectsprojectidclose.txt +++ b/docs/api/examples/post_projectsprojectidclose.txt @@ -6,9 +6,8 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/close diff --git a/docs/api/examples/post_projectsprojectidcommit.txt b/docs/api/examples/post_projectsprojectidcommit.txt index 18172833..fbd2f00a 100644 --- a/docs/api/examples/post_projectsprojectidcommit.txt +++ b/docs/api/examples/post_projectsprojectidcommit.txt @@ -6,9 +6,8 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit HTTP/1.1 HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/commit diff --git a/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt new file mode 100644 index 00000000..2934c90c --- /dev/null +++ b/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -0,0 +1,25 @@ +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/6bf1fc75-788a-4b87-89ee-3422d352fb91/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/docker/vms/6bf1fc75-788a-4b87-89ee-3422d352fb91/adapters/0/ports/0/nio HTTP/1.1 +{ + "lport": 4242, + "rhost": "127.0.0.1", + "rport": 4343, + "type": "nio_udp" +} + + +HTTP/1.1 201 +ACCESS-CONTROL-ALLOW-ORIGIN: * +CONTENT-LENGTH: 89 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/1.5.0dev1 +X-ROUTE: /v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio + +{ + "lport": 4242, + "rhost": "127.0.0.1", + "rport": 4343, + "type": "nio_udp" +} diff --git a/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..97ad851f --- /dev/null +++ b/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -0,0 +1,20 @@ +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/133a0c91-d934-4e2c-9fa0-db084a4a1630/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/docker/vms/133a0c91-d934-4e2c-9fa0-db084a4a1630/adapters/0/ports/0/start_capture HTTP/1.1 +{ + "capture_file_name": "test.pcap", + "data_link_type": "DLT_EN10MB" +} + + +HTTP/1.1 200 +ACCESS-CONTROL-ALLOW-ORIGIN: * +CONTENT-LENGTH: 167 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/1.5.0dev1 +X-ROUTE: /v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture + +{ + "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpsfiobxfb/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap" +} diff --git a/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..eecfa751 --- /dev/null +++ b/docs/api/examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -0,0 +1,13 @@ +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/aed39c77-db17-420d-87d3-aecd9a5748d4/adapters/0/ports/0/stop_capture' -d '{}' + +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/aed39c77-db17-420d-87d3-aecd9a5748d4/adapters/0/ports/0/stop_capture HTTP/1.1 +{} + + +HTTP/1.1 204 +ACCESS-CONTROL-ALLOW-ORIGIN: * +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/1.5.0dev1 +X-ROUTE: /v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture + diff --git a/docs/api/examples/post_projectsprojectidiouvms.txt b/docs/api/examples/post_projectsprojectidiouvms.txt index bf0fe67c..be2f5abf 100644 --- a/docs/api/examples/post_projectsprojectidiouvms.txt +++ b/docs/api/examples/post_projectsprojectidiouvms.txt @@ -1,24 +1,24 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"name": "PC TEST 1", "path": "iou.bin", "startup_config_content": "hostname test", "vm_id": "afa904bc-8968-4e7c-87b6-11d92174f1e6"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"name": "PC TEST 1", "path": "iou.bin", "startup_config_content": "hostname test", "vm_id": "0c8d2194-90a9-4877-bb6c-146dbd191115"}' POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1 { "name": "PC TEST 1", "path": "iou.bin", "startup_config_content": "hostname test", - "vm_id": "afa904bc-8968-4e7c-87b6-11d92174f1e6" + "vm_id": "0c8d2194-90a9-4877-bb6c-146dbd191115" } HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 626 +CONTENT-LENGTH: 659 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms { + "command_line": "", "console": 2001, "ethernet_adapters": 2, "iourc_path": null, @@ -33,6 +33,6 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms "serial_adapters": 2, "startup_config": "startup-config.cfg", "use_default_iou_values": true, - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/afa904bc-8968-4e7c-87b6-11d92174f1e6", - "vm_id": "afa904bc-8968-4e7c-87b6-11d92174f1e6" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpsfiobxfb/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/0c8d2194-90a9-4877-bb6c-146dbd191115", + "vm_id": "0c8d2194-90a9-4877-bb6c-146dbd191115" } diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 2ccdc22e..2fb8c0e5 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/eea449ce-e25b-4beb-b50f-fcd77241a97b/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_generic_ethernet"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e1c1a20a-4580-4d22-bf5d-82e8c0eb4d0d/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_generic_ethernet"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/eea449ce-e25b-4beb-b50f-fcd77241a97b/adapters/1/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e1c1a20a-4580-4d22-bf5d-82e8c0eb4d0d/adapters/1/ports/0/nio HTTP/1.1 { "ethernet_device": "bridge0", "type": "nio_generic_ethernet" @@ -9,11 +9,10 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/eea449ce-e25b-4be HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 72 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt index 1a506166..3a3254e7 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/14a4f240-54e7-47f7-b9e7-3640528415fe/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/4063d298-f884-45b7-be63-461cd7e3f245/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/14a4f240-54e7-47f7-b9e7-3640528415fe/adapters/0/ports/0/start_capture HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4063d298-f884-45b7-be63-461cd7e3f245/adapters/0/ports/0/start_capture HTTP/1.1 { "capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB" @@ -9,13 +9,12 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/14a4f240-54e7-47f HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 158 +CONTENT-LENGTH: 167 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 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/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap" + "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpsfiobxfb/projects/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 db79902e..e55f1d54 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/992e1579-2232-4aac-93ef-970c3bb67966/adapters/0/ports/0/stop_capture' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/a182c11a-29b5-4565-9f3b-0896382963db/adapters/0/ports/0/stop_capture' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/992e1579-2232-4aac-93ef-970c3bb67966/adapters/0/ports/0/stop_capture HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/a182c11a-29b5-4565-9f3b-0896382963db/adapters/0/ports/0/stop_capture HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt index 7c2eb3b4..5c1266c5 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7f23517b-b45e-4e7b-b908-c501c36abe16/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2ba21772-8623-4b47-9aca-4d976d899da7/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7f23517b-b45e-4e7b-b908-c501c36abe16/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2ba21772-8623-4b47-9aca-4d976d899da7/reload HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt index 6e308f54..5f895737 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt @@ -1,16 +1,35 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2923f599-894a-4b18-a9eb-17a389298f84/start' -d '{"iourc_content": "test"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/88d36ca9-c18e-4d97-99ba-da62c2d37f0b/start' -d '{"iourc_content": "test"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2923f599-894a-4b18-a9eb-17a389298f84/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/88d36ca9-c18e-4d97-99ba-da62c2d37f0b/start HTTP/1.1 { "iourc_content": "test" } -HTTP/1.1 204 +HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 0 +CONTENT-LENGTH: 707 +CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/start +{ + "command_line": "", + "console": 2001, + "ethernet_adapters": 2, + "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8y4tqbp1/iourc", + "l1_keepalives": false, + "md5sum": null, + "name": "PC TEST 1", + "nvram": 128, + "path": "iou.bin", + "private_config": null, + "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", + "ram": 256, + "serial_adapters": 2, + "startup_config": null, + "use_default_iou_values": true, + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpsfiobxfb/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/88d36ca9-c18e-4d97-99ba-da62c2d37f0b", + "vm_id": "88d36ca9-c18e-4d97-99ba-da62c2d37f0b" +} diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt index 3feaf6b0..142cafd4 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ff05b41f-cd2b-4b33-90be-9362430b68ae/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c54e54d0-dbe3-43cc-bf0e-27f199ffdad9/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ff05b41f-cd2b-4b33-90be-9362430b68ae/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c54e54d0-dbe3-43cc-bf0e-27f199ffdad9/stop HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/stop diff --git a/docs/api/examples/post_projectsprojectidportsudp.txt b/docs/api/examples/post_projectsprojectidportsudp.txt index b82c6f19..82480352 100644 --- a/docs/api/examples/post_projectsprojectidportsudp.txt +++ b/docs/api/examples/post_projectsprojectidportsudp.txt @@ -6,11 +6,10 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/ports/udp HTTP/1.1 HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 25 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/ports/udp { diff --git a/docs/api/examples/post_projectsprojectidqemuvms.txt b/docs/api/examples/post_projectsprojectidqemuvms.txt index 7949b11e..733be9a5 100644 --- a/docs/api/examples/post_projectsprojectidqemuvms.txt +++ b/docs/api/examples/post_projectsprojectidqemuvms.txt @@ -1,21 +1,20 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "linux.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64", "ram": 1024}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpich388hc/qemu-system-x86_64", "ram": 1024}' POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1 { - "hda_disk_image": "linux.img", + "hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpich388hc/qemu-system-x86_64", "ram": 1024 } HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 1363 +CONTENT-LENGTH: 1432 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms { @@ -25,12 +24,13 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms "boot_priority": "c", "cdrom_image": "", "cdrom_image_md5sum": null, + "command_line": "", "console": 2001, "console_type": "telnet", "cpu_throttling": 0, "cpus": 1, - "hda_disk_image": "linux.img", - "hda_disk_image_md5sum": null, + "hda_disk_image": "linux\u8f7d.img", + "hda_disk_image_md5sum": "c4ca4238a0b923820dcc509a6f75849b", "hda_disk_interface": "ide", "hdb_disk_image": "", "hdb_disk_image_md5sum": null, @@ -47,15 +47,15 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms "kernel_image": "", "kernel_image_md5sum": null, "legacy_networking": false, - "mac_address": "00:00:ab:50:58:00", + "mac_address": "00:00:ab:51:28:00", "name": "PC TEST 1", "options": "", "platform": "x86_64", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpich388hc/qemu-system-x86_64", "ram": 1024, "usage": "", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/b949f2e2-d338-4b51-aea9-270196ed5058", - "vm_id": "b949f2e2-d338-4b51-aea9-270196ed5058" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/197873df-1639-4517-b9c0-401c9b325128", + "vm_id": "197873df-1639-4517-b9c0-401c9b325128" } diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt index af51745e..c9bc07e8 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/82435d91-3cb5-4a44-abff-34a4ae46b24f/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/a314a5ca-5b21-4aaf-90d4-1fcbf77a1195/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/82435d91-3cb5-4a44-abff-34a4ae46b24f/adapters/1/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/a314a5ca-5b21-4aaf-90d4-1fcbf77a1195/adapters/1/ports/0/nio HTTP/1.1 { "ethernet_device": "eth0", "type": "nio_generic_ethernet" @@ -9,11 +9,10 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/82435d91-3cb5-4a HTTP/1.1 409 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 89 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt index 0140288a..671b160d 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/3275bdce-9b75-445f-8168-0103cd524182/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/612ea30a-90a3-417c-9ab5-c227fb37a4f3/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/3275bdce-9b75-445f-8168-0103cd524182/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/612ea30a-90a3-417c-9ab5-c227fb37a4f3/reload HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt index 8306c0c2..2dbed605 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2d03502f-6b3f-4551-b924-b74fd5d6cdf5/resume' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/362e8954-7222-4a5c-b3bb-8454ade32a11/resume' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2d03502f-6b3f-4551-b924-b74fd5d6cdf5/resume HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/362e8954-7222-4a5c-b3bb-8454ade32a11/resume HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/resume diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt index b4699682..69b50de5 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt @@ -1,14 +1,56 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/04afa03a-3d9b-4aa7-945f-8f3077b6790e/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/cd228046-7147-47eb-adae-4f8a854a1f31/start' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/04afa03a-3d9b-4aa7-945f-8f3077b6790e/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/cd228046-7147-47eb-adae-4f8a854a1f31/start HTTP/1.1 {} -HTTP/1.1 204 +HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 0 +CONTENT-LENGTH: 1386 +CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/start +{ + "acpi_shutdown": false, + "adapter_type": "e1000", + "adapters": 1, + "boot_priority": "c", + "cdrom_image": "", + "cdrom_image_md5sum": null, + "command_line": "", + "console": 2001, + "console_type": "telnet", + "cpu_throttling": 0, + "cpus": 1, + "hda_disk_image": "", + "hda_disk_image_md5sum": null, + "hda_disk_interface": "ide", + "hdb_disk_image": "", + "hdb_disk_image_md5sum": null, + "hdb_disk_interface": "ide", + "hdc_disk_image": "", + "hdc_disk_image_md5sum": null, + "hdc_disk_interface": "ide", + "hdd_disk_image": "", + "hdd_disk_image_md5sum": null, + "hdd_disk_interface": "ide", + "initrd": "", + "initrd_md5sum": null, + "kernel_command_line": "", + "kernel_image": "", + "kernel_image_md5sum": null, + "legacy_networking": false, + "mac_address": "00:00:ab:1f:31:00", + "name": "PC TEST 1", + "options": "", + "platform": "x86_64", + "process_priority": "low", + "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpich388hc/qemu-system-x86_64", + "ram": 256, + "usage": "", + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/cd228046-7147-47eb-adae-4f8a854a1f31", + "vm_id": "cd228046-7147-47eb-adae-4f8a854a1f31" +} diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt index 1b0b590e..d7c6da74 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f5bfbadc-9a09-4090-a624-89be68858746/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d6dea08f-6d73-4406-8679-400318a53efb/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f5bfbadc-9a09-4090-a624-89be68858746/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d6dea08f-6d73-4406-8679-400318a53efb/stop HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/stop diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt index 5fee4174..3c91a028 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/bb00b1e0-f19d-4ce8-b99a-82c1518fa33e/suspend' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/467a2d94-f2ca-45b3-ac96-f3f0ae945623/suspend' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/bb00b1e0-f19d-4ce8-b99a-82c1518fa33e/suspend HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/467a2d94-f2ca-45b3-ac96-f3f0ae945623/suspend HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/suspend diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt index 18ea88be..0056e0bb 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt @@ -10,11 +10,10 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1 HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 409 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms { @@ -29,6 +28,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms "ram": 0, "use_any_adapter": false, "vm_directory": null, - "vm_id": "39cc5964-d0be-487b-9f0c-8fbea600e452", + "vm_id": "db395c0e-8af7-4734-97cd-b62d6662d79a", "vmname": "VM1" } diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 2b40e2b9..09e4c7b9 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/556aba72-c19a-4fc3-a350-9454791687f4/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/1f3a669e-b3f0-49b4-ba04-d76b1420a1cc/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/556aba72-c19a-4fc3-a350-9454791687f4/adapters/0/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/1f3a669e-b3f0-49b4-ba04-d76b1420a1cc/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", @@ -11,11 +11,10 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/556aba72-c HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 89 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt index b4eb77d6..ee3bf4b6 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/1a517572-9b86-441a-8347-1d28b01d9a41/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/3f2bad54-376d-4322-8403-848f62fa1554/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/1a517572-9b86-441a-8347-1d28b01d9a41/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/3f2bad54-376d-4322-8403-848f62fa1554/reload HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt index 7ff55602..724493b1 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/7f5648e4-0ce8-49b3-b470-f2b821a5fe3e/resume' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/706462e6-5da3-4b1d-ace5-4043ed382ad4/resume' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/7f5648e4-0ce8-49b3-b470-f2b821a5fe3e/resume HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/706462e6-5da3-4b1d-ace5-4043ed382ad4/resume HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/resume diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt index a37f7d80..eb9f8a18 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ee1fef8f-cbe1-4590-8c47-fbd12f7f6beb/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a91edead-cc20-498f-a45d-7cb20841733b/start' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ee1fef8f-cbe1-4590-8c47-fbd12f7f6beb/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a91edead-cc20-498f-a45d-7cb20841733b/start HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/start diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt index d1b07cbf..316215fb 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5e8543c3-45a7-4668-824f-01eaeb848898/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/56604944-7340-4187-a378-dfbf0e7a5f13/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5e8543c3-45a7-4668-824f-01eaeb848898/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/56604944-7340-4187-a378-dfbf0e7a5f13/stop HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt index e7db500d..5fd1bf5b 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/95f620da-c0e5-4404-81fc-10f3e18786cb/suspend' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/eb76e968-9c4b-4ea3-939a-18b9d7515b4b/suspend' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/95f620da-c0e5-4404-81fc-10f3e18786cb/suspend HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/eb76e968-9c4b-4ea3-939a-18b9d7515b4b/suspend HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/suspend diff --git a/docs/api/examples/post_projectsprojectidvpcsvms.txt b/docs/api/examples/post_projectsprojectidvpcsvms.txt index 584c6d5b..d143e86d 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvms.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvms.txt @@ -8,20 +8,20 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1 HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 422 +CONTENT-LENGTH: 455 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms { + "command_line": "", "console": 2010, "name": "PC TEST 1", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, "status": "stopped", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/d1808514-893b-4aa5-86c2-c4dea88ff895", - "vm_id": "d1808514-893b-4aa5-86c2-c4dea88ff895" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/95fe2288-5ce4-4502-a350-8e06d6c0b17a", + "vm_id": "95fe2288-5ce4-4502-a350-8e06d6c0b17a" } diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 37833633..76c2b585 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/fbf2e4d7-d60e-4e03-95bc-1bd53b74689a/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/bdad8fd9-951e-4078-8809-debd42657ed0/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/fbf2e4d7-d60e-4e03-95bc-1bd53b74689a/adapters/0/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/bdad8fd9-951e-4078-8809-debd42657ed0/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", @@ -11,11 +11,10 @@ POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/fbf2e4d7-d60e-4e HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 89 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt index 2bb604c9..955bc272 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/1a1b95de-cc91-4a90-870b-5c7c8965eb5d/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/fb3ee909-4dad-4c93-aaf9-d6229054f633/reload' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/1a1b95de-cc91-4a90-870b-5c7c8965eb5d/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/fb3ee909-4dad-4c93-aaf9-d6229054f633/reload HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt index ae5a8998..e11b8fce 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt @@ -1,14 +1,25 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/184c6dcc-a8fd-4cc9-b333-86cc24f2e98e/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/76019245-f228-4c93-9bca-f19f93b17b2b/start' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/184c6dcc-a8fd-4cc9-b333-86cc24f2e98e/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/76019245-f228-4c93-9bca-f19f93b17b2b/start HTTP/1.1 {} -HTTP/1.1 204 +HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 0 +CONTENT-LENGTH: 455 +CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/start +{ + "command_line": "", + "console": 2010, + "name": "PC TEST 1", + "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", + "startup_script": null, + "startup_script_path": null, + "status": "stopped", + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/76019245-f228-4c93-9bca-f19f93b17b2b", + "vm_id": "76019245-f228-4c93-9bca-f19f93b17b2b" +} diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt index 4352ce57..5a3ac61f 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/bc34aac0-6c5e-4b91-b2ea-47b76d4b26f1/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/421e1c3f-55db-478f-aac5-87445f8a241d/stop' -d '{}' -POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/bc34aac0-6c5e-4b91-b2ea-47b76d4b26f1/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/421e1c3f-55db-478f-aac5-87445f8a241d/stop HTTP/1.1 {} HTTP/1.1 204 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/stop diff --git a/docs/api/examples/post_qemuimg.txt b/docs/api/examples/post_qemuimg.txt index 8fe3d69f..45ae339c 100644 --- a/docs/api/examples/post_qemuimg.txt +++ b/docs/api/examples/post_qemuimg.txt @@ -15,9 +15,8 @@ POST /v1/qemu/img HTTP/1.1 HTTP/1.1 201 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/qemu/img diff --git a/docs/api/examples/post_servers.txt b/docs/api/examples/post_servers.txt new file mode 100644 index 00000000..fbfff075 --- /dev/null +++ b/docs/api/examples/post_servers.txt @@ -0,0 +1,30 @@ +curl -i -X POST 'http://localhost:8000/v1/servers' -d '{"host": "example.com", "password": "secure", "port": 84, "protocol": "http", "server_id": "my_server_id", "user": "julien"}' + +POST /v1/servers HTTP/1.1 +{ + "host": "example.com", + "password": "secure", + "port": 84, + "protocol": "http", + "server_id": "my_server_id", + "user": "julien" +} + + +HTTP/1.1 201 +ACCESS-CONTROL-ALLOW-ORIGIN: * +CONTENT-LENGTH: 176 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/1.5.0dev1 +X-ROUTE: /v1/servers + +{ + "connected": false, + "host": "example.com", + "port": 84, + "protocol": "http", + "server_id": "my_server_id", + "user": "julien", + "version": "1.5.0dev1" +} diff --git a/docs/api/examples/post_version.txt b/docs/api/examples/post_version.txt index 37a197b0..c9d7884b 100644 --- a/docs/api/examples/post_version.txt +++ b/docs/api/examples/post_version.txt @@ -1,20 +1,19 @@ -curl -i -X POST 'http://localhost:8000/v1/version' -d '{"version": "1.4.0dev13"}' +curl -i -X POST 'http://localhost:8000/v1/version' -d '{"version": "1.5.0dev1"}' POST /v1/version HTTP/1.1 { - "version": "1.4.0dev13" + "version": "1.5.0dev1" } HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 31 +CONTENT-LENGTH: 30 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/version { - "version": "1.4.0dev13" + "version": "1.5.0dev1" } diff --git a/docs/api/examples/put_projectsprojectid.txt b/docs/api/examples/put_projectsprojectid.txt index f524c22d..11e98e43 100644 --- a/docs/api/examples/put_projectsprojectid.txt +++ b/docs/api/examples/put_projectsprojectid.txt @@ -1,22 +1,21 @@ -curl -i -X PUT 'http://localhost:8000/v1/projects/9d7dccbb-0fc0-40d0-9420-912733dcbf74' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-110/test_update_path_project_non_l0"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/4941798d-9f60-4c60-a154-1b34aaf36f04' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-57/test_update_path_project_non_l0"}' -PUT /v1/projects/9d7dccbb-0fc0-40d0-9420-912733dcbf74 HTTP/1.1 +PUT /v1/projects/4941798d-9f60-4c60-a154-1b34aaf36f04 HTTP/1.1 { "name": "second_name", - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-110/test_update_path_project_non_l0" + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-57/test_update_path_project_non_l0" } HTTP/1.1 403 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 100 +CONTENT-LENGTH: 96 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id} { - "message": "You are not allowed to modify the project directory location", + "message": "You are not allowed to modify the project directory path", "status": 403 } diff --git a/docs/api/examples/put_projectsprojectiddockervmsvmid.txt b/docs/api/examples/put_projectsprojectiddockervmsvmid.txt new file mode 100644 index 00000000..0a3241e7 --- /dev/null +++ b/docs/api/examples/put_projectsprojectiddockervmsvmid.txt @@ -0,0 +1,33 @@ +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/0c264aff-2a9f-4b78-8dd5-0364481a5cef' -d '{"console": 2003, "environment": "GNS3=1\nGNS4=0", "name": "test", "start_command": "yes"}' + +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/0c264aff-2a9f-4b78-8dd5-0364481a5cef HTTP/1.1 +{ + "console": 2003, + "environment": "GNS3=1\nGNS4=0", + "name": "test", + "start_command": "yes" +} + + +HTTP/1.1 200 +ACCESS-CONTROL-ALLOW-ORIGIN: * +CONTENT-LENGTH: 531 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/1.5.0dev1 +X-ROUTE: /v1/projects/{project_id}/docker/vms/{vm_id} + +{ + "adapters": 2, + "aux": 2002, + "console": 2003, + "console_type": "telnet", + "container_id": "8bd8153ea8f5", + "environment": "GNS3=1\nGNS4=0", + "image": "nginx", + "name": "test", + "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", + "start_command": "yes", + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpsfiobxfb/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/docker/0c264aff-2a9f-4b78-8dd5-0364481a5cef", + "vm_id": "0c264aff-2a9f-4b78-8dd5-0364481a5cef" +} diff --git a/docs/api/examples/put_projectsprojectidiouvmsvmid.txt b/docs/api/examples/put_projectsprojectidiouvmsvmid.txt index 55248a93..d544261f 100644 --- a/docs/api/examples/put_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidiouvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6438493a-152d-4cb0-b8d2-fcfe1f6bf540' -d '{"console": 2002, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/994d12ae-c1b6-441e-b483-f2a5bf398374' -d '{"console": 2002, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}' -PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6438493a-152d-4cb0-b8d2-fcfe1f6bf540 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/994d12ae-c1b6-441e-b483-f2a5bf398374 HTTP/1.1 { "console": 2002, "ethernet_adapters": 4, @@ -17,17 +17,17 @@ PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6438493a-152d-4cb0 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 685 +CONTENT-LENGTH: 718 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} { + "command_line": "", "console": 2002, "ethernet_adapters": 4, - "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyrljan4a/iourc", + "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp51cq19da/iourc", "l1_keepalives": true, "md5sum": null, "name": "test", @@ -39,6 +39,6 @@ X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} "serial_adapters": 0, "startup_config": "startup-config.cfg", "use_default_iou_values": true, - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/6438493a-152d-4cb0-b8d2-fcfe1f6bf540", - "vm_id": "6438493a-152d-4cb0-b8d2-fcfe1f6bf540" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpsfiobxfb/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/994d12ae-c1b6-441e-b483-f2a5bf398374", + "vm_id": "994d12ae-c1b6-441e-b483-f2a5bf398374" } diff --git a/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt index 52872ddf..eb7a5846 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/578b6391-e461-4f17-86f6-dd556d2f4dde' -d '{"console": 2002, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/c2fa621e-6bf7-4137-b097-035e3de00439' -d '{"console": 2002, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}' -PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/578b6391-e461-4f17-86f6-dd556d2f4dde HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/c2fa621e-6bf7-4137-b097-035e3de00439 HTTP/1.1 { "console": 2002, "hdb_disk_image": "linux.img", @@ -11,11 +11,10 @@ PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/578b6391-e461-4f1 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 1358 +CONTENT-LENGTH: 1391 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} { @@ -25,6 +24,7 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} "boot_priority": "c", "cdrom_image": "", "cdrom_image_md5sum": null, + "command_line": "", "console": 2002, "console_type": "telnet", "cpu_throttling": 0, @@ -47,15 +47,15 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} "kernel_image": "", "kernel_image_md5sum": null, "legacy_networking": false, - "mac_address": "00:00:ab:4d:de:00", + "mac_address": "00:00:ab:04:39:00", "name": "test", "options": "", "platform": "x86_64", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpich388hc/qemu-system-x86_64", "ram": 1024, "usage": "", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/578b6391-e461-4f17-86f6-dd556d2f4dde", - "vm_id": "578b6391-e461-4f17-86f6-dd556d2f4dde" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/c2fa621e-6bf7-4137-b097-035e3de00439", + "vm_id": "c2fa621e-6bf7-4137-b097-035e3de00439" } diff --git a/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt index b7a858c5..621999f3 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/aa45d68c-c68e-4296-9550-641b522a73c2' -d '{"console": 2011, "name": "test"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/7106debb-510b-4094-b694-8c3987f5c1de' -d '{"console": 2011, "name": "test"}' -PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/aa45d68c-c68e-4296-9550-641b522a73c2 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/7106debb-510b-4094-b694-8c3987f5c1de HTTP/1.1 { "console": 2011, "name": "test" @@ -9,11 +9,10 @@ PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/aa45d68c-c6 HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive CONTENT-LENGTH: 413 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} { @@ -28,6 +27,6 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} "ram": 0, "use_any_adapter": false, "vm_directory": null, - "vm_id": "aa45d68c-c68e-4296-9550-641b522a73c2", + "vm_id": "7106debb-510b-4094-b694-8c3987f5c1de", "vmname": "VMTEST" } diff --git a/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt index 0c1c229e..0db9421d 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/608a4cd0-476c-40ba-95db-0c81effc8e9c' -d '{"console": 2012, "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/e9d7b7e9-23bf-4b26-97c6-2b5ca0038092' -d '{"console": 2012, "name": "test", "startup_script": "ip 192.168.1.1"}' -PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/608a4cd0-476c-40ba-95db-0c81effc8e9c HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/e9d7b7e9-23bf-4b26-97c6-2b5ca0038092 HTTP/1.1 { "console": 2012, "name": "test", @@ -10,20 +10,20 @@ PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/608a4cd0-476c-40b HTTP/1.1 200 ACCESS-CONTROL-ALLOW-ORIGIN: * -CONNECTION: keep-alive -CONTENT-LENGTH: 438 +CONTENT-LENGTH: 471 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/1.4.0dev13 +SERVER: Python/3.5 GNS3/1.5.0dev1 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} { + "command_line": "", "console": 2012, "name": "test", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": "ip 192.168.1.1", "startup_script_path": "startup.vpc", "status": "stopped", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/608a4cd0-476c-40ba-95db-0c81effc8e9c", - "vm_id": "608a4cd0-476c-40ba-95db-0c81effc8e9c" + "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpxhp21u5q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/e9d7b7e9-23bf-4b26-97c6-2b5ca0038092", + "vm_id": "e9d7b7e9-23bf-4b26-97c6-2b5ca0038092" } diff --git a/docs/api/v1/server.rst b/docs/api/v1/controller/server.rst similarity index 100% rename from docs/api/v1/server.rst rename to docs/api/v1/controller/server.rst diff --git a/docs/api/v1/controller/server/servers.rst b/docs/api/v1/controller/server/servers.rst new file mode 100644 index 00000000..f3557094 --- /dev/null +++ b/docs/api/v1/controller/server/servers.rst @@ -0,0 +1,48 @@ +/v1/servers +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/servers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Register a server + +Response status codes +********************** +- **201**: Server added + +Input +******* +.. raw:: html + + + + + + + + + +
Name Mandatory Type Description
host ✔ string Server host
password string Password for auth
port ✔ integer Server port
protocol ✔ enum Possible values: http, https
server_id ✔ string Server identifier
user string User for auth
+ +Output +******* +.. raw:: html + + + + + + + + + + +
Name Mandatory Type Description
connected boolean True if controller is connected to the server
host ✔ string Server host
port ✔ integer Server port
protocol ✔ enum Possible values: http, https
server_id ✔ string Server identifier
user string User for auth
version ['string', 'null'] Version of the GNS3 remote server
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/post_servers.txt + diff --git a/docs/api/v1/docker/projectsprojectiddockerimages.rst b/docs/api/v1/docker/projectsprojectiddockerimages.rst deleted file mode 100644 index 01f41cc4..00000000 --- a/docs/api/v1/docker/projectsprojectiddockerimages.rst +++ /dev/null @@ -1,49 +0,0 @@ -/v1/projects/{project_id}/docker/images ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/docker/images -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new Docker container - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
console string console name
imagename string Docker image name
name string Docker container name
startcmd string Docker CMD entry
vm_id Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
cid string Docker container ID
image string Docker image name
name string Docker container name
project_id ✔ string Project UUID
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v1/docker/projectsprojectiddockerimagesidreload.rst b/docs/api/v1/docker/projectsprojectiddockerimagesidreload.rst deleted file mode 100644 index df8104d0..00000000 --- a/docs/api/v1/docker/projectsprojectiddockerimagesidreload.rst +++ /dev/null @@ -1,50 +0,0 @@ -/v1/projects/{project_id}/docker/images/{id}/reload ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/docker/images/**{id}**/reload -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Restart a Docker container - -Parameters -********** -- **id**: ID of the container -- **project_id**: UUID of the project - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance restarted - -Input -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
console string console name
imagename string Docker image name
name string Docker container name
startcmd string Docker CMD entry
vm_id Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
cid string Docker container ID
image string Docker image name
name string Docker container name
project_id ✔ string Project UUID
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v1/docker/projectsprojectiddockerimagesidstart.rst b/docs/api/v1/docker/projectsprojectiddockerimagesidstart.rst deleted file mode 100644 index 49fb5e28..00000000 --- a/docs/api/v1/docker/projectsprojectiddockerimagesidstart.rst +++ /dev/null @@ -1,50 +0,0 @@ -/v1/projects/{project_id}/docker/images/{id}/start ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/docker/images/**{id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a Docker container - -Parameters -********** -- **id**: ID of the container -- **project_id**: UUID of the project - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - -Input -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
console string console name
imagename string Docker image name
name string Docker container name
startcmd string Docker CMD entry
vm_id Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
cid string Docker container ID
image string Docker image name
name string Docker container name
project_id ✔ string Project UUID
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v1/docker/projectsprojectiddockerimagesidstop.rst b/docs/api/v1/docker/projectsprojectiddockerimagesidstop.rst deleted file mode 100644 index 797eb66c..00000000 --- a/docs/api/v1/docker/projectsprojectiddockerimagesidstop.rst +++ /dev/null @@ -1,50 +0,0 @@ -/v1/projects/{project_id}/docker/images/{id}/stop ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/docker/images/**{id}**/stop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a Docker container - -Parameters -********** -- **id**: ID of the container -- **project_id**: UUID of the project - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance stopped - -Input -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
console string console name
imagename string Docker image name
name string Docker container name
startcmd string Docker CMD entry
vm_id Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
cid string Docker container ID
image string Docker image name
name string Docker container name
project_id ✔ string Project UUID
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v1/docker/projectsprojectiddockerimagesidsuspend.rst b/docs/api/v1/docker/projectsprojectiddockerimagesidsuspend.rst deleted file mode 100644 index 11297147..00000000 --- a/docs/api/v1/docker/projectsprojectiddockerimagesidsuspend.rst +++ /dev/null @@ -1,50 +0,0 @@ -/v1/projects/{project_id}/docker/images/{id}/suspend ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/docker/images/**{id}**/suspend -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Pause a Docker container - -Parameters -********** -- **id**: ID of the container -- **project_id**: UUID of the project - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance paused - -Input -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
console string console name
imagename string Docker image name
name string Docker container name
startcmd string Docker CMD entry
vm_id Docker VM instance identifier
- -Output -******* -.. raw:: html - - - - - - - - - - -
Name Mandatory Type Description
adapter_type string Docker adapter type
adapters integer number of adapters
cid string Docker container ID
image string Docker image name
name string Docker container name
project_id ✔ string Project UUID
vm_id ✔ string Docker container instance UUID
- diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst b/docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst deleted file mode 100644 index 14124ac2..00000000 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst +++ /dev/null @@ -1,35 +0,0 @@ -/v1/projects/{project_id}/iou/vms/{vm_id}/start ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a IOU instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - -Input -******* -.. raw:: html - - - - -
Name Mandatory Type Description
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
- -Sample session -*************** - - -.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidstart.txt - diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst deleted file mode 100644 index 80a97d69..00000000 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v1/projects/{project_id}/qemu/vms/{vm_id}/start ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a Qemu VM instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - -Sample session -*************** - - -.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidstart.txt - diff --git a/docs/api/v1/config.rst b/docs/api/v1/server/config.rst similarity index 100% rename from docs/api/v1/config.rst rename to docs/api/v1/server/config.rst diff --git a/docs/api/v1/config/configreload.rst b/docs/api/v1/server/config/configreload.rst similarity index 89% rename from docs/api/v1/config/configreload.rst rename to docs/api/v1/server/config/configreload.rst index 02b0265f..8f47659b 100644 --- a/docs/api/v1/config/configreload.rst +++ b/docs/api/v1/server/config/configreload.rst @@ -16,5 +16,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_configreload.txt +.. literalinclude:: ../../../examples/post_configreload.txt diff --git a/docs/api/v1/docker.rst b/docs/api/v1/server/docker.rst similarity index 100% rename from docs/api/v1/docker.rst rename to docs/api/v1/server/docker.rst diff --git a/docs/api/v1/docker/dockerimages.rst b/docs/api/v1/server/docker/dockerimages.rst similarity index 100% rename from docs/api/v1/docker/dockerimages.rst rename to docs/api/v1/server/docker/dockerimages.rst diff --git a/docs/api/v1/server/docker/projectsprojectiddockervms.rst b/docs/api/v1/server/docker/projectsprojectiddockervms.rst new file mode 100644 index 00000000..c788b59d --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervms.rst @@ -0,0 +1,56 @@ +/v1/projects/{project_id}/docker/vms +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/docker/vms +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a new Docker container + +Parameters +********** +- **project_id**: UUID for the project + +Response status codes +********************** +- **400**: Invalid request +- **201**: Instance created +- **409**: Conflict + +Input +******* +.. raw:: html + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
+ +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
+ diff --git a/docs/api/v1/docker/projectsprojectiddockerimagesid.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsid.rst similarity index 83% rename from docs/api/v1/docker/projectsprojectiddockerimagesid.rst rename to docs/api/v1/server/docker/projectsprojectiddockervmsid.rst index 6a9e006d..e93792a5 100644 --- a/docs/api/v1/docker/projectsprojectiddockerimagesid.rst +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsid.rst @@ -1,16 +1,16 @@ -/v1/projects/{project_id}/docker/images/{id} +/v1/projects/{project_id}/docker/vms/{id} ---------------------------------------------------------------------------------------------------------------------- .. contents:: -DELETE /v1/projects/**{project_id}**/docker/images/**{id}** +DELETE /v1/projects/**{project_id}**/docker/vms/**{id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Delete a Docker container Parameters ********** -- **id**: ID for the container - **project_id**: UUID for the project +- **id**: ID for the container Response status codes ********************** diff --git a/docs/api/v1/server/docker/projectsprojectiddockervmsidreload.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsidreload.rst new file mode 100644 index 00000000..ef5f2fec --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsidreload.rst @@ -0,0 +1,57 @@ +/v1/projects/{project_id}/docker/vms/{id}/reload +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/docker/vms/**{id}**/reload +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Restart a Docker container + +Parameters +********** +- **project_id**: UUID of the project +- **id**: ID of the container + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance restarted + +Input +******* +.. raw:: html + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
+ +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
+ diff --git a/docs/api/v1/server/docker/projectsprojectiddockervmsidstart.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsidstart.rst new file mode 100644 index 00000000..45684fad --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsidstart.rst @@ -0,0 +1,57 @@ +/v1/projects/{project_id}/docker/vms/{id}/start +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/docker/vms/**{id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a Docker container + +Parameters +********** +- **project_id**: UUID of the project +- **id**: ID of the container + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance started + +Input +******* +.. raw:: html + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
+ +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
+ diff --git a/docs/api/v1/server/docker/projectsprojectiddockervmsidstop.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsidstop.rst new file mode 100644 index 00000000..0eba0060 --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsidstop.rst @@ -0,0 +1,57 @@ +/v1/projects/{project_id}/docker/vms/{id}/stop +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/docker/vms/**{id}**/stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a Docker container + +Parameters +********** +- **project_id**: UUID of the project +- **id**: ID of the container + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance stopped + +Input +******* +.. raw:: html + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
+ +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
+ diff --git a/docs/api/v1/server/docker/projectsprojectiddockervmsidsuspend.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsidsuspend.rst new file mode 100644 index 00000000..86c61b98 --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsidsuspend.rst @@ -0,0 +1,57 @@ +/v1/projects/{project_id}/docker/vms/{id}/suspend +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/docker/vms/**{id}**/suspend +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Pause a Docker container + +Parameters +********** +- **project_id**: UUID of the project +- **id**: ID of the container + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance paused + +Input +******* +.. raw:: html + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
vm_id string Docker VM instance identifier
+ +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
+ diff --git a/docs/api/v1/server/docker/projectsprojectiddockervmsvmid.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsvmid.rst new file mode 100644 index 00000000..782d13b0 --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsvmid.rst @@ -0,0 +1,62 @@ +/v1/projects/{project_id}/docker/vms/{vm_id} +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +PUT /v1/projects/**{project_id}**/docker/vms/**{vm_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Update a Docker instance + +Parameters +********** +- **project_id**: UUID for the project +- **vm_id**: UUID for the instance + +Response status codes +********************** +- **200**: Instance updated +- **400**: Invalid request +- **404**: Instance doesn't exist +- **409**: Conflict + +Input +******* +.. raw:: html + + + + + + + + + + +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_type enum Possible values: telnet, vnc
environment ['string', 'null'] Docker environment
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
+ +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
adapters ✔ ['integer', 'null'] number of adapters
aux ✔ ['integer', 'null'] auxilary TCP port
console ✔ ['integer', 'null'] console TCP port
console_type ✔ enum Possible values: telnet, vnc
container_id ✔ string Docker container ID
environment ✔ ['string', 'null'] Docker environment
image ✔ string Docker image name
name string Docker container name
project_id ✔ string Project UUID
start_command ✔ ['string', 'null'] Docker CMD entry
vm_directory ✔ string
vm_id ✔ string Docker container instance UUID
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/put_projectsprojectiddockervmsvmid.txt + diff --git a/docs/api/v1/docker/projectsprojectiddockerimagesidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst similarity index 72% rename from docs/api/v1/docker/projectsprojectiddockerimagesidadaptersadapternumberdportsportnumberdnio.rst rename to docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst index e5724d50..83b8d3f6 100644 --- a/docs/api/v1/docker/projectsprojectiddockerimagesidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -1,18 +1,18 @@ -/v1/projects/{project_id}/docker/images/{id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio +/v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio ---------------------------------------------------------------------------------------------------------------------- .. contents:: -POST /v1/projects/**{project_id}**/docker/images/**{id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +POST /v1/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Add a NIO to a Docker container Parameters ********** -- **id**: ID of the container - **adapter_number**: Adapter where the nio should be added - **project_id**: UUID for the project - **port_number**: Port on the adapter +- **id**: ID of the container Response status codes ********************** @@ -20,17 +20,23 @@ Response status codes - **201**: NIO created - **404**: Instance doesn't exist +Sample session +*************** -DELETE /v1/projects/**{project_id}**/docker/images/**{id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio + +.. literalinclude:: ../../../examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt + + +DELETE /v1/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Remove a NIO from a Docker container Parameters ********** -- **id**: ID of the container - **adapter_number**: Adapter where the nio should be added - **project_id**: UUID for the project - **port_number**: Port on the adapter +- **id**: ID of the container Response status codes ********************** @@ -38,3 +44,9 @@ Response status codes - **404**: Instance doesn't exist - **204**: NIO deleted +Sample session +*************** + + +.. literalinclude:: ../../../examples/delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt + diff --git a/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst new file mode 100644 index 00000000..92328323 --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -0,0 +1,39 @@ +/v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a packet capture on a IOU VM instance + +Parameters +********** +- **adapter_number**: Adapter to start a packet capture +- **project_id**: UUID for the project +- **vm_id**: UUID for the instance +- **port_number**: Port on the adapter + +Response status codes +********************** +- **200**: Capture started +- **400**: Invalid request +- **404**: Instance doesn't exist +- **409**: VM not started + +Input +******* +.. raw:: html + + + + + +
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt + diff --git a/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst new file mode 100644 index 00000000..3aa8955d --- /dev/null +++ b/docs/api/v1/server/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -0,0 +1,29 @@ +/v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a packet capture on a IOU VM instance + +Parameters +********** +- **adapter_number**: Adapter to stop a packet capture +- **project_id**: UUID for the project +- **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Capture stopped +- **409**: VM not started + +Sample session +*************** + + +.. literalinclude:: ../../../examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt + diff --git a/docs/api/v1/dynamips_device.rst b/docs/api/v1/server/dynamips_device.rst similarity index 100% rename from docs/api/v1/dynamips_device.rst rename to docs/api/v1/server/dynamips_device.rst diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst b/docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevices.rst similarity index 100% rename from docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst rename to docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevices.rst diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst b/docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst similarity index 100% rename from docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst rename to docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst index 2ccc6822..6a472e00 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst +++ b/docs/api/v1/server/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 ********************** @@ -96,8 +96,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/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst similarity index 100% rename from docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst rename to docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst index 4bbd4479..97b14b9d 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst +++ b/docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst @@ -9,8 +9,8 @@ Add a NIO to a Dynamips device instance Parameters ********** -- **device_id**: UUID for the instance - **project_id**: UUID for the project +- **device_id**: UUID for the instance - **port_number**: Port on the device Response status codes @@ -139,8 +139,8 @@ Remove a NIO from a Dynamips device instance Parameters ********** -- **device_id**: UUID for the instance - **project_id**: UUID for the project +- **device_id**: UUID for the instance - **port_number**: Port on the device Response status codes diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst b/docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst similarity index 87% rename from docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst rename to docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst index fc6abef3..2227bc64 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst +++ b/docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst @@ -9,8 +9,8 @@ Start a packet capture on a Dynamips device instance Parameters ********** -- **device_id**: UUID for the instance - **project_id**: UUID for the project +- **device_id**: UUID for the instance - **port_number**: Port on the device Response status codes @@ -26,6 +26,6 @@ Input - +
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type ✔ string PCAP data link type
data_link_type string PCAP data link type
diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst b/docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst similarity index 100% rename from docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst rename to docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst index 716c458d..cc312e43 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst +++ b/docs/api/v1/server/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst @@ -9,8 +9,8 @@ Stop a packet capture on a Dynamips device instance Parameters ********** -- **device_id**: UUID for the instance - **project_id**: UUID for the project +- **device_id**: UUID for the instance - **port_number**: Port on the device Response status codes diff --git a/docs/api/v1/dynamips_vm.rst b/docs/api/v1/server/dynamips_vm.rst similarity index 100% rename from docs/api/v1/dynamips_vm.rst rename to docs/api/v1/server/dynamips_vm.rst diff --git a/docs/api/v1/dynamips_vm/dynamipsvms.rst b/docs/api/v1/server/dynamips_vm/dynamipsvms.rst similarity index 100% rename from docs/api/v1/dynamips_vm/dynamipsvms.rst rename to docs/api/v1/server/dynamips_vm/dynamipsvms.rst diff --git a/docs/api/v1/dynamips_vm/dynamipsvmspath.rst b/docs/api/v1/server/dynamips_vm/dynamipsvmspath.rst similarity index 100% rename from docs/api/v1/dynamips_vm/dynamipsvmspath.rst rename to docs/api/v1/server/dynamips_vm/dynamipsvmspath.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvms.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvms.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index b7a216fd..01614d10 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a Dynamips VM instance Parameters ********** - **adapter_number**: Adapter where the nio should be added -- **port_number**: Port on the adapter - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter Response status codes ********************** @@ -28,9 +28,9 @@ Remove a NIO from a Dynamips VM instance Parameters ********** - **adapter_number**: Adapter from where the nio should be removed -- **port_number**: Port on the adapter - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst similarity index 87% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index cfebeb84..7e727b50 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -10,9 +10,9 @@ Start a packet capture on a Dynamips VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture -- **port_number**: Port on the adapter - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter Response status codes ********************** @@ -27,6 +27,6 @@ Input - +
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type ✔ string PCAP data link type
data_link_type string PCAP data link type
diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 960a0d6f..4d8ad822 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -10,9 +10,9 @@ Stop a packet capture on a Dynamips VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst b/docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst similarity index 100% rename from docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst rename to docs/api/v1/server/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst diff --git a/docs/api/v1/file.rst b/docs/api/v1/server/file.rst similarity index 100% rename from docs/api/v1/file.rst rename to docs/api/v1/server/file.rst diff --git a/docs/api/v1/file/filesstream.rst b/docs/api/v1/server/file/filesstream.rst similarity index 100% rename from docs/api/v1/file/filesstream.rst rename to docs/api/v1/server/file/filesstream.rst diff --git a/docs/api/v1/iou.rst b/docs/api/v1/server/iou.rst similarity index 100% rename from docs/api/v1/iou.rst rename to docs/api/v1/server/iou.rst diff --git a/docs/api/v1/iou/iouvms.rst b/docs/api/v1/server/iou/iouvms.rst similarity index 89% rename from docs/api/v1/iou/iouvms.rst rename to docs/api/v1/server/iou/iouvms.rst index 466ae34c..22b399ca 100644 --- a/docs/api/v1/iou/iouvms.rst +++ b/docs/api/v1/server/iou/iouvms.rst @@ -15,5 +15,5 @@ Sample session *************** -.. literalinclude:: ../../examples/get_iouvms.txt +.. literalinclude:: ../../../examples/get_iouvms.txt diff --git a/docs/api/v1/iou/iouvmspath.rst b/docs/api/v1/server/iou/iouvmspath.rst similarity index 100% rename from docs/api/v1/iou/iouvmspath.rst rename to docs/api/v1/server/iou/iouvmspath.rst diff --git a/docs/api/v1/iou/projectsprojectidiouvms.rst b/docs/api/v1/server/iou/projectsprojectidiouvms.rst similarity index 96% rename from docs/api/v1/iou/projectsprojectidiouvms.rst rename to docs/api/v1/server/iou/projectsprojectidiouvms.rst index 95620207..f9c4191e 100644 --- a/docs/api/v1/iou/projectsprojectidiouvms.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvms.rst @@ -47,6 +47,7 @@ Output + @@ -69,5 +70,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidiouvms.txt +.. literalinclude:: ../../../examples/post_projectsprojectidiouvms.txt diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmid.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmid.rst similarity index 94% rename from docs/api/v1/iou/projectsprojectidiouvmsvmid.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmid.rst index 33b73ae4..685fd66c 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmid.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmid.rst @@ -24,6 +24,7 @@ Output
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
+ @@ -46,7 +47,7 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmid.txt +.. literalinclude:: ../../../examples/get_projectsprojectidiouvmsvmid.txt PUT /v1/projects/**{project_id}**/iou/vms/**{vm_id}** @@ -92,6 +93,7 @@ Output
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
+ @@ -114,7 +116,7 @@ Sample session *************** -.. literalinclude:: ../../examples/put_projectsprojectidiouvmsvmid.txt +.. literalinclude:: ../../../examples/put_projectsprojectidiouvmsvmid.txt DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}** @@ -136,5 +138,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmid.txt +.. literalinclude:: ../../../examples/delete_projectsprojectidiouvmsvmid.txt diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst similarity index 87% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst index d7411d32..86edcc97 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a IOU instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port where the nio should be added - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port where the nio should be added Response status codes ********************** @@ -24,7 +24,7 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio @@ -34,9 +34,9 @@ Remove a NIO from a IOU instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port from where the nio should be removed - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port from where the nio should be removed Response status codes ********************** @@ -48,5 +48,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst similarity index 81% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index e94abb49..7849cbce 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -10,9 +10,9 @@ Start a packet capture on a IOU VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture -- **port_number**: Port on the adapter - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter Response status codes ********************** @@ -28,12 +28,12 @@ Input
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
- +
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type ✔ string PCAP data link type
data_link_type string PCAP data link type
Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt +.. literalinclude:: ../../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst similarity index 88% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 13b38095..dd3b08ce 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -10,9 +10,9 @@ Stop a packet capture on a IOU VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -25,5 +25,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt +.. literalinclude:: ../../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigs.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidconfigs.rst similarity index 93% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidconfigs.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmidconfigs.rst index f9955b7e..d328c6f5 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigs.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidconfigs.rst @@ -27,5 +27,5 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmidconfigs.txt +.. literalinclude:: ../../../examples/get_projectsprojectidiouvmsvmidconfigs.txt diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidconfigssave.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidconfigssave.rst similarity index 100% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidconfigssave.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmidconfigssave.rst diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidreload.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidreload.rst similarity index 89% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidreload.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmidreload.rst index 49be3d31..0243d395 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidreload.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidreload.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidreload.txt +.. literalinclude:: ../../../examples/post_projectsprojectidiouvmsvmidreload.txt diff --git a/docs/api/v1/server/iou/projectsprojectidiouvmsvmidstart.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidstart.rst new file mode 100644 index 00000000..50de685f --- /dev/null +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidstart.rst @@ -0,0 +1,60 @@ +/v1/projects/{project_id}/iou/vms/{vm_id}/start +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a IOU instance + +Parameters +********** +- **project_id**: UUID for the project +- **vm_id**: UUID for the instance + +Response status codes +********************** +- **200**: Instance started +- **400**: Invalid request +- **404**: Instance doesn't exist + +Input +******* +.. raw:: html + + + + +
Name Mandatory Type Description
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
+ +Output +******* +.. raw:: html + + + + + + + + + + + + + + + + + + + + +
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU
iourc_path ['string', 'null'] Path of the iourc file used by remote servers
l1_keepalives ✔ boolean Always up ethernet interface
md5sum ✔ ['string', 'null'] Checksum of iou binary
name ✔ string IOU VM name
nvram ✔ integer Allocated NVRAM KB
path ✔ string Path of iou binary
private_config ✔ ['string', 'null'] Path of the private-config content relative to project directory
project_id ✔ string Project UUID
ram ✔ integer Allocated RAM MB
serial_adapters ✔ integer How many serial adapters are connected to the IOU
startup_config ✔ ['string', 'null'] Path of the startup-config content relative to project directory
use_default_iou_values ✔ ['boolean', 'null'] Use default IOU values
vm_directory string
vm_id ✔ string IOU VM UUID
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/post_projectsprojectidiouvmsvmidstart.txt + diff --git a/docs/api/v1/iou/projectsprojectidiouvmsvmidstop.rst b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidstop.rst similarity index 89% rename from docs/api/v1/iou/projectsprojectidiouvmsvmidstop.rst rename to docs/api/v1/server/iou/projectsprojectidiouvmsvmidstop.rst index 220c81ad..4fdc31f5 100644 --- a/docs/api/v1/iou/projectsprojectidiouvmsvmidstop.rst +++ b/docs/api/v1/server/iou/projectsprojectidiouvmsvmidstop.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidstop.txt +.. literalinclude:: ../../../examples/post_projectsprojectidiouvmsvmidstop.txt diff --git a/docs/api/v1/network.rst b/docs/api/v1/server/network.rst similarity index 100% rename from docs/api/v1/network.rst rename to docs/api/v1/server/network.rst diff --git a/docs/api/v1/network/interfaces.rst b/docs/api/v1/server/network/interfaces.rst similarity index 89% rename from docs/api/v1/network/interfaces.rst rename to docs/api/v1/server/network/interfaces.rst index 35036d57..15d026bb 100644 --- a/docs/api/v1/network/interfaces.rst +++ b/docs/api/v1/server/network/interfaces.rst @@ -15,5 +15,5 @@ Sample session *************** -.. literalinclude:: ../../examples/get_interfaces.txt +.. literalinclude:: ../../../examples/get_interfaces.txt diff --git a/docs/api/v1/network/projectsprojectidportsudp.rst b/docs/api/v1/server/network/projectsprojectidportsudp.rst similarity index 89% rename from docs/api/v1/network/projectsprojectidportsudp.rst rename to docs/api/v1/server/network/projectsprojectidportsudp.rst index 046d863a..20ebd7ef 100644 --- a/docs/api/v1/network/projectsprojectidportsudp.rst +++ b/docs/api/v1/server/network/projectsprojectidportsudp.rst @@ -20,5 +20,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidportsudp.txt +.. literalinclude:: ../../../examples/post_projectsprojectidportsudp.txt diff --git a/docs/api/v1/project.rst b/docs/api/v1/server/project.rst similarity index 100% rename from docs/api/v1/project.rst rename to docs/api/v1/server/project.rst diff --git a/docs/api/v1/project/projects.rst b/docs/api/v1/server/project/projects.rst similarity index 96% rename from docs/api/v1/project/projects.rst rename to docs/api/v1/server/project/projects.rst index 13e87bd8..50660c8f 100644 --- a/docs/api/v1/project/projects.rst +++ b/docs/api/v1/server/project/projects.rst @@ -15,7 +15,7 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projects.txt +.. literalinclude:: ../../../examples/get_projects.txt POST /v1/projects @@ -56,5 +56,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projects.txt +.. literalinclude:: ../../../examples/post_projects.txt diff --git a/docs/api/v1/project/projectsprojectid.rst b/docs/api/v1/server/project/projectsprojectid.rst similarity index 95% rename from docs/api/v1/project/projectsprojectid.rst rename to docs/api/v1/server/project/projectsprojectid.rst index ce2e2c8a..0ed4eecb 100644 --- a/docs/api/v1/project/projectsprojectid.rst +++ b/docs/api/v1/server/project/projectsprojectid.rst @@ -33,7 +33,7 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projectsprojectid.txt +.. literalinclude:: ../../../examples/get_projectsprojectid.txt PUT /v1/projects/**{project_id}** @@ -78,7 +78,7 @@ Sample session *************** -.. literalinclude:: ../../examples/put_projectsprojectid.txt +.. literalinclude:: ../../../examples/put_projectsprojectid.txt DELETE /v1/projects/**{project_id}** @@ -98,5 +98,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectid.txt +.. literalinclude:: ../../../examples/delete_projectsprojectid.txt diff --git a/docs/api/v1/project/projectsprojectidclose.rst b/docs/api/v1/server/project/projectsprojectidclose.rst similarity index 89% rename from docs/api/v1/project/projectsprojectidclose.rst rename to docs/api/v1/server/project/projectsprojectidclose.rst index 5f9b867f..320a79fa 100644 --- a/docs/api/v1/project/projectsprojectidclose.rst +++ b/docs/api/v1/server/project/projectsprojectidclose.rst @@ -20,5 +20,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidclose.txt +.. literalinclude:: ../../../examples/post_projectsprojectidclose.txt diff --git a/docs/api/v1/project/projectsprojectidcommit.rst b/docs/api/v1/server/project/projectsprojectidcommit.rst similarity index 89% rename from docs/api/v1/project/projectsprojectidcommit.rst rename to docs/api/v1/server/project/projectsprojectidcommit.rst index f08f2a33..fd26554c 100644 --- a/docs/api/v1/project/projectsprojectidcommit.rst +++ b/docs/api/v1/server/project/projectsprojectidcommit.rst @@ -20,5 +20,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidcommit.txt +.. literalinclude:: ../../../examples/post_projectsprojectidcommit.txt diff --git a/docs/api/v1/project/projectsprojectidfiles.rst b/docs/api/v1/server/project/projectsprojectidfiles.rst similarity index 89% rename from docs/api/v1/project/projectsprojectidfiles.rst rename to docs/api/v1/server/project/projectsprojectidfiles.rst index 2c877216..44ee247b 100644 --- a/docs/api/v1/project/projectsprojectidfiles.rst +++ b/docs/api/v1/server/project/projectsprojectidfiles.rst @@ -20,5 +20,5 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projectsprojectidfiles.txt +.. literalinclude:: ../../../examples/get_projectsprojectidfiles.txt diff --git a/docs/api/v1/project/projectsprojectidfilespath.rst b/docs/api/v1/server/project/projectsprojectidfilespath.rst similarity index 100% rename from docs/api/v1/project/projectsprojectidfilespath.rst rename to docs/api/v1/server/project/projectsprojectidfilespath.rst diff --git a/docs/api/v1/project/projectsprojectidnotifications.rst b/docs/api/v1/server/project/projectsprojectidnotifications.rst similarity index 100% rename from docs/api/v1/project/projectsprojectidnotifications.rst rename to docs/api/v1/server/project/projectsprojectidnotifications.rst diff --git a/docs/api/v1/qemu.rst b/docs/api/v1/server/qemu.rst similarity index 100% rename from docs/api/v1/qemu.rst rename to docs/api/v1/server/qemu.rst diff --git a/docs/api/v1/qemu/projectsprojectidqemuvms.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvms.rst similarity index 97% rename from docs/api/v1/qemu/projectsprojectidqemuvms.rst rename to docs/api/v1/server/qemu/projectsprojectidqemuvms.rst index 3621e2ca..9e5e972a 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvms.rst +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvms.rst @@ -72,9 +72,10 @@ Output acpi_shutdown ✔ boolean ACPI shutdown support adapter_type ✔ string QEMU adapter type adapters ✔ integer number of adapters - boot_priority ✔ enum Possible values: c, d + boot_priority ✔ enum Possible values: c, d, n, cn, cd cdrom_image ✔ string QEMU cdrom image path cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum + command_line ✔ string Last command line used by GNS3 to start QEMU console ✔ integer console TCP port console_type ✔ enum Possible values: telnet, vnc cpu_throttling ✔ integer Percentage of CPU allowed for QEMU @@ -114,5 +115,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidqemuvms.txt +.. literalinclude:: ../../../examples/post_projectsprojectidqemuvms.txt diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmid.rst similarity index 96% rename from docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst rename to docs/api/v1/server/qemu/projectsprojectidqemuvmsvmid.rst index caf301ed..034e6d14 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmid.rst @@ -27,9 +27,10 @@ Output acpi_shutdown ✔ boolean ACPI shutdown support adapter_type ✔ string QEMU adapter type adapters ✔ integer number of adapters - boot_priority ✔ enum Possible values: c, d + boot_priority ✔ enum Possible values: c, d, n, cn, cd cdrom_image ✔ string QEMU cdrom image path cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum + command_line ✔ string Last command line used by GNS3 to start QEMU console ✔ integer console TCP port console_type ✔ enum Possible values: telnet, vnc cpu_throttling ✔ integer Percentage of CPU allowed for QEMU @@ -69,7 +70,7 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projectsprojectidqemuvmsvmid.txt +.. literalinclude:: ../../../examples/get_projectsprojectidqemuvmsvmid.txt PUT /v1/projects/**{project_id}**/qemu/vms/**{vm_id}** @@ -97,7 +98,7 @@ Input acpi_shutdown ['boolean', 'null'] ACPI shutdown support adapter_type ['string', 'null'] QEMU adapter type adapters ['integer', 'null'] number of adapters - boot_priority enum Possible values: c, d + boot_priority enum Possible values: c, d, n, cn, cd cdrom_image string QEMU cdrom image path cdrom_image_md5sum ['string', 'null'] QEMU cdrom image checksum console ['integer', 'null'] console TCP port @@ -141,9 +142,10 @@ Output acpi_shutdown ✔ boolean ACPI shutdown support adapter_type ✔ string QEMU adapter type adapters ✔ integer number of adapters - boot_priority ✔ enum Possible values: c, d + boot_priority ✔ enum Possible values: c, d, n, cn, cd cdrom_image ✔ string QEMU cdrom image path cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum + command_line ✔ string Last command line used by GNS3 to start QEMU console ✔ integer console TCP port console_type ✔ enum Possible values: telnet, vnc cpu_throttling ✔ integer Percentage of CPU allowed for QEMU @@ -183,7 +185,7 @@ Sample session *************** -.. literalinclude:: ../../examples/put_projectsprojectidqemuvmsvmid.txt +.. literalinclude:: ../../../examples/put_projectsprojectidqemuvmsvmid.txt DELETE /v1/projects/**{project_id}**/qemu/vms/**{vm_id}** @@ -205,5 +207,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectidqemuvmsvmid.txt +.. literalinclude:: ../../../examples/delete_projectsprojectidqemuvmsvmid.txt diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst similarity index 87% rename from docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst rename to docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 1da34454..60c67e48 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a Qemu VM instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -24,7 +24,7 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt DELETE /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio @@ -34,9 +34,9 @@ Remove a NIO from a Qemu VM instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -48,5 +48,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidreload.rst similarity index 89% rename from docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst rename to docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidreload.rst index 701115e5..35a3d01f 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidreload.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidreload.txt +.. literalinclude:: ../../../examples/post_projectsprojectidqemuvmsvmidreload.txt diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidresume.rst similarity index 89% rename from docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst rename to docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidresume.rst index 2d5314ff..65c8f6f2 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidresume.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidresume.txt +.. literalinclude:: ../../../examples/post_projectsprojectidqemuvmsvmidresume.txt diff --git a/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidstart.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidstart.rst new file mode 100644 index 00000000..8a35caea --- /dev/null +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidstart.rst @@ -0,0 +1,74 @@ +/v1/projects/{project_id}/qemu/vms/{vm_id}/start +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a Qemu VM instance + +Parameters +********** +- **project_id**: UUID for the project +- **vm_id**: UUID for the instance + +Response status codes +********************** +- **200**: Instance started +- **400**: Invalid request +- **404**: Instance doesn't exist + +Output +******* +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name Mandatory Type Description
acpi_shutdown ✔ boolean ACPI shutdown support
adapter_type ✔ string QEMU adapter type
adapters ✔ integer number of adapters
boot_priority ✔ enum Possible values: c, d, n, cn, cd
cdrom_image ✔ string QEMU cdrom image path
cdrom_image_md5sum ✔ ['string', 'null'] QEMU cdrom image checksum
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
console_type ✔ enum Possible values: telnet, vnc
cpu_throttling ✔ integer Percentage of CPU allowed for QEMU
cpus ✔ ['integer', 'null'] number of vCPUs
hda_disk_image ✔ string QEMU hda disk image path
hda_disk_image_md5sum ✔ ['string', 'null'] QEMU hda disk image checksum
hda_disk_interface ✔ string QEMU hda interface
hdb_disk_image ✔ string QEMU hdb disk image path
hdb_disk_image_md5sum ✔ ['string', 'null'] QEMU hdb disk image checksum
hdb_disk_interface ✔ string QEMU hdb interface
hdc_disk_image ✔ string QEMU hdc disk image path
hdc_disk_image_md5sum ✔ ['string', 'null'] QEMU hdc disk image checksum
hdc_disk_interface ✔ string QEMU hdc interface
hdd_disk_image ✔ string QEMU hdd disk image path
hdd_disk_image_md5sum ✔ ['string', 'null'] QEMU hdd disk image checksum
hdd_disk_interface ✔ string QEMU hdd interface
initrd ✔ string QEMU initrd path
initrd_md5sum ✔ ['string', 'null'] QEMU initrd path
kernel_command_line ✔ string QEMU kernel command line
kernel_image ✔ string QEMU kernel image path
kernel_image_md5sum ✔ ['string', 'null'] QEMU kernel image checksum
legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax)
mac_address ✔ string QEMU MAC address
name ✔ string QEMU VM instance name
options ✔ string Additional QEMU options
platform ✔ enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb
process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low
project_id ✔ string Project uuid
qemu_path ✔ string path to QEMU
ram ✔ integer amount of RAM in MB
usage ✔ string How to use the qemu VM
vm_directory ✔ string
vm_id ✔ string QEMU VM uuid
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/post_projectsprojectidqemuvmsvmidstart.txt + diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidstop.rst similarity index 89% rename from docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst rename to docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidstop.rst index 83ea04c0..b2ee9568 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidstop.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidstop.txt +.. literalinclude:: ../../../examples/post_projectsprojectidqemuvmsvmidstop.txt diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidsuspend.rst similarity index 89% rename from docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst rename to docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidsuspend.rst index f09da59d..f57e6f23 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst +++ b/docs/api/v1/server/qemu/projectsprojectidqemuvmsvmidsuspend.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidsuspend.txt +.. literalinclude:: ../../../examples/post_projectsprojectidqemuvmsvmidsuspend.txt diff --git a/docs/api/v1/qemu/qemubinaries.rst b/docs/api/v1/server/qemu/qemubinaries.rst similarity index 93% rename from docs/api/v1/qemu/qemubinaries.rst rename to docs/api/v1/server/qemu/qemubinaries.rst index b04a906c..a6a6c184 100644 --- a/docs/api/v1/qemu/qemubinaries.rst +++ b/docs/api/v1/server/qemu/qemubinaries.rst @@ -26,5 +26,5 @@ Sample session *************** -.. literalinclude:: ../../examples/get_qemubinaries.txt +.. literalinclude:: ../../../examples/get_qemubinaries.txt diff --git a/docs/api/v1/qemu/qemucapabilities.rst b/docs/api/v1/server/qemu/qemucapabilities.rst similarity index 93% rename from docs/api/v1/qemu/qemucapabilities.rst rename to docs/api/v1/server/qemu/qemucapabilities.rst index 390525df..c34f0b58 100644 --- a/docs/api/v1/qemu/qemucapabilities.rst +++ b/docs/api/v1/server/qemu/qemucapabilities.rst @@ -24,5 +24,5 @@ Sample session *************** -.. literalinclude:: ../../examples/get_qemucapabilities.txt +.. literalinclude:: ../../../examples/get_qemucapabilities.txt diff --git a/docs/api/v1/qemu/qemuimg.rst b/docs/api/v1/server/qemu/qemuimg.rst similarity index 98% rename from docs/api/v1/qemu/qemuimg.rst rename to docs/api/v1/server/qemu/qemuimg.rst index b94c4da8..138fa88f 100644 --- a/docs/api/v1/qemu/qemuimg.rst +++ b/docs/api/v1/server/qemu/qemuimg.rst @@ -35,5 +35,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_qemuimg.txt +.. literalinclude:: ../../../examples/post_qemuimg.txt diff --git a/docs/api/v1/qemu/qemuimgbinaries.rst b/docs/api/v1/server/qemu/qemuimgbinaries.rst similarity index 100% rename from docs/api/v1/qemu/qemuimgbinaries.rst rename to docs/api/v1/server/qemu/qemuimgbinaries.rst diff --git a/docs/api/v1/qemu/qemuvms.rst b/docs/api/v1/server/qemu/qemuvms.rst similarity index 100% rename from docs/api/v1/qemu/qemuvms.rst rename to docs/api/v1/server/qemu/qemuvms.rst diff --git a/docs/api/v1/qemu/qemuvmspath.rst b/docs/api/v1/server/qemu/qemuvmspath.rst similarity index 100% rename from docs/api/v1/qemu/qemuvmspath.rst rename to docs/api/v1/server/qemu/qemuvmspath.rst diff --git a/docs/api/v1/server/server.rst b/docs/api/v1/server/server.rst new file mode 100644 index 00000000..fcb176b4 --- /dev/null +++ b/docs/api/v1/server/server.rst @@ -0,0 +1,8 @@ +Server +--------------------- + +.. toctree:: + :glob: + :maxdepth: 2 + + server/* diff --git a/docs/api/v1/server/servershutdown.rst b/docs/api/v1/server/server/servershutdown.rst similarity index 100% rename from docs/api/v1/server/servershutdown.rst rename to docs/api/v1/server/server/servershutdown.rst diff --git a/docs/api/v1/version.rst b/docs/api/v1/server/version.rst similarity index 100% rename from docs/api/v1/version.rst rename to docs/api/v1/server/version.rst diff --git a/docs/api/v1/version/version.rst b/docs/api/v1/server/version/version.rst similarity index 95% rename from docs/api/v1/version/version.rst rename to docs/api/v1/server/version/version.rst index 942bb705..3728155a 100644 --- a/docs/api/v1/version/version.rst +++ b/docs/api/v1/server/version/version.rst @@ -25,7 +25,7 @@ Sample session *************** -.. literalinclude:: ../../examples/get_version.txt +.. literalinclude:: ../../../examples/get_version.txt POST /v1/version @@ -61,5 +61,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_version.txt +.. literalinclude:: ../../../examples/post_version.txt diff --git a/docs/api/v1/virtualbox.rst b/docs/api/v1/server/virtualbox.rst similarity index 100% rename from docs/api/v1/virtualbox.rst rename to docs/api/v1/server/virtualbox.rst diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvms.rst similarity index 98% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvms.rst index 879c24ea..a1931f69 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvms.rst @@ -62,5 +62,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvms.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvms.txt diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmid.rst similarity index 98% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmid.rst index 7028c292..820ab1b4 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmid.rst @@ -43,7 +43,7 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projectsprojectidvirtualboxvmsvmid.txt +.. literalinclude:: ../../../examples/get_projectsprojectidvirtualboxvmsvmid.txt PUT /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}** @@ -105,7 +105,7 @@ Sample session *************** -.. literalinclude:: ../../examples/put_projectsprojectidvirtualboxvmsvmid.txt +.. literalinclude:: ../../../examples/put_projectsprojectidvirtualboxvmsvmid.txt DELETE /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst similarity index 86% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst index bb37508f..ace11bcf 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter where the nio should be added -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -24,7 +24,7 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt DELETE /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio @@ -34,9 +34,9 @@ Remove a NIO from a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter from where the nio should be removed -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -48,5 +48,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst similarity index 88% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index 188bc6d5..ca465161 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -10,9 +10,9 @@ Start a packet capture on a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -27,5 +27,6 @@ Input +
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst similarity index 100% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 370f02da..502d5ee7 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -10,9 +10,9 @@ Stop a packet capture on a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst similarity index 88% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst index 9ae84c29..032312fb 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvmsvmidreload.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvmsvmidreload.txt diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst similarity index 89% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst index 0fb9d427..f440f493 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvmsvmidresume.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvmsvmidresume.txt diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst similarity index 88% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst index 5e6a6c42..87b5766b 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvmsvmidstart.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvmsvmidstart.txt diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst similarity index 89% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst index 1eaac889..5dc0be0c 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvmsvmidstop.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvmsvmidstop.txt diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst similarity index 88% rename from docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst rename to docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst index ad7f469b..824c9d3b 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst +++ b/docs/api/v1/server/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt diff --git a/docs/api/v1/virtualbox/virtualboxvms.rst b/docs/api/v1/server/virtualbox/virtualboxvms.rst similarity index 100% rename from docs/api/v1/virtualbox/virtualboxvms.rst rename to docs/api/v1/server/virtualbox/virtualboxvms.rst diff --git a/docs/api/v1/vmware.rst b/docs/api/v1/server/vmware.rst similarity index 100% rename from docs/api/v1/vmware.rst rename to docs/api/v1/server/vmware.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevms.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevms.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevms.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevms.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmid.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmid.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmid.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmid.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst index 3e026251..326f61a1 100644 --- a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a VMware VM instance Parameters ********** - **adapter_number**: Adapter where the nio should be added -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -28,9 +28,9 @@ Remove a NIO from a VMware VM instance Parameters ********** - **adapter_number**: Adapter from where the nio should be removed -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst similarity index 88% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index f988f5cd..8de9c89d 100644 --- a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -10,9 +10,9 @@ Start a packet capture on a VMware VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** @@ -27,5 +27,6 @@ Input +
Name Mandatory Type Description
capture_file_name ✔ string Capture file name
data_link_type string PCAP data link type
diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 23a1980e..f03c23ca 100644 --- a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -10,9 +10,9 @@ Stop a packet capture on a VMware VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture -- **port_number**: Port on the adapter (always 0) - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port on the adapter (always 0) Response status codes ********************** diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidreload.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidreload.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidreload.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidreload.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidresume.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidresume.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidresume.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidresume.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidstart.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidstart.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidstart.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidstart.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidstop.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidstop.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidstop.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidstop.rst diff --git a/docs/api/v1/vmware/projectsprojectidvmwarevmsvmidsuspend.rst b/docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidsuspend.rst similarity index 100% rename from docs/api/v1/vmware/projectsprojectidvmwarevmsvmidsuspend.rst rename to docs/api/v1/server/vmware/projectsprojectidvmwarevmsvmidsuspend.rst diff --git a/docs/api/v1/vmware/vmwarevms.rst b/docs/api/v1/server/vmware/vmwarevms.rst similarity index 100% rename from docs/api/v1/vmware/vmwarevms.rst rename to docs/api/v1/server/vmware/vmwarevms.rst diff --git a/docs/api/v1/vpcs.rst b/docs/api/v1/server/vpcs.rst similarity index 100% rename from docs/api/v1/vpcs.rst rename to docs/api/v1/server/vpcs.rst diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst b/docs/api/v1/server/vpcs/projectsprojectidvpcsvms.rst similarity index 92% rename from docs/api/v1/vpcs/projectsprojectidvpcsvms.rst rename to docs/api/v1/server/vpcs/projectsprojectidvpcsvms.rst index 5f576e24..5866acdd 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst +++ b/docs/api/v1/server/vpcs/projectsprojectidvpcsvms.rst @@ -35,6 +35,7 @@ Output + @@ -49,5 +50,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvpcsvms.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvpcsvms.txt diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmid.rst similarity index 90% rename from docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst rename to docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmid.rst index 38eb6f6a..6b0082d0 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst +++ b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmid.rst @@ -24,6 +24,7 @@ Output
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
name ✔ string VPCS VM name
project_id ✔ string Project UUID
+ @@ -38,7 +39,7 @@ Sample session *************** -.. literalinclude:: ../../examples/get_projectsprojectidvpcsvmsvmid.txt +.. literalinclude:: ../../../examples/get_projectsprojectidvpcsvmsvmid.txt PUT /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}** @@ -74,6 +75,7 @@ Output
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
name ✔ string VPCS VM name
project_id ✔ string Project UUID
+ @@ -88,7 +90,7 @@ Sample session *************** -.. literalinclude:: ../../examples/put_projectsprojectidvpcsvmsvmid.txt +.. literalinclude:: ../../../examples/put_projectsprojectidvpcsvmsvmid.txt DELETE /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}** @@ -110,5 +112,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectidvpcsvmsvmid.txt +.. literalinclude:: ../../../examples/delete_projectsprojectidvpcsvmsvmid.txt diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst similarity index 87% rename from docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst rename to docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index c56e69c7..9dffd20c 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a VPCS instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port where the nio should be added - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port where the nio should be added Response status codes ********************** @@ -24,7 +24,7 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt DELETE /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio @@ -34,9 +34,9 @@ Remove a NIO from a VPCS instance Parameters ********** - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port from where the nio should be removed - **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **port_number**: Port from where the nio should be removed Response status codes ********************** @@ -48,5 +48,5 @@ Sample session *************** -.. literalinclude:: ../../examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +.. literalinclude:: ../../../examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidreload.rst similarity index 89% rename from docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst rename to docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidreload.rst index 224798fd..1f6f6cd8 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst +++ b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidreload.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvpcsvmsvmidreload.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvpcsvmsvmidreload.txt diff --git a/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidstart.rst b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidstart.rst new file mode 100644 index 00000000..ca70e4a1 --- /dev/null +++ b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidstart.rst @@ -0,0 +1,43 @@ +/v1/projects/{project_id}/vpcs/vms/{vm_id}/start +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a VPCS instance + +Parameters +********** +- **project_id**: UUID for the project +- **vm_id**: UUID for the instance + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance started + +Output +******* +.. raw:: html + +
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
name ✔ string VPCS VM name
project_id ✔ string Project UUID
+ + + + + + + + + + +
Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
name ✔ string VPCS VM name
project_id ✔ string Project UUID
startup_script ['string', 'null'] Content of the VPCS startup script
startup_script_path ✔ ['string', 'null'] Path of the VPCS startup script relative to project directory
status ✔ enum Possible values: started, stopped
vm_directory string
vm_id ✔ string VPCS VM UUID
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/post_projectsprojectidvpcsvmsvmidstart.txt + diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidstop.rst similarity index 89% rename from docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst rename to docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidstop.rst index 269c8953..0264d441 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst +++ b/docs/api/v1/server/vpcs/projectsprojectidvpcsvmsvmidstop.rst @@ -22,5 +22,5 @@ Sample session *************** -.. literalinclude:: ../../examples/post_projectsprojectidvpcsvmsvmidstop.txt +.. literalinclude:: ../../../examples/post_projectsprojectidvpcsvmsvmidstop.txt diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst deleted file mode 100644 index b87f43a6..00000000 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst +++ /dev/null @@ -1,26 +0,0 @@ -/v1/projects/{project_id}/vpcs/vms/{vm_id}/start ----------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v1/projects/**{project_id}**/vpcs/vms/**{vm_id}**/start -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a VPCS instance - -Parameters -********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance started - -Sample session -*************** - - -.. literalinclude:: ../../examples/post_projectsprojectidvpcsvmsvmidstart.txt - diff --git a/docs/index.rst b/docs/index.rst index 5c8665ba..54c57bb0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,13 +10,22 @@ Welcome to API documentation! glossary development - -API Endpoints -~~~~~~~~~~~~~~~ +Controller API Endpoints +~~~~~~~~~~~~~~~~~~~~~~~~ .. toctree:: :glob: :maxdepth: 2 - api/v1/* + api/v1/controller/* + + +Low level API Endpoints +~~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :glob: + :maxdepth: 2 + + api/v1/server/* diff --git a/gns3server/web/documentation.py b/gns3server/web/documentation.py index f068d889..98a8fc11 100644 --- a/gns3server/web/documentation.py +++ b/gns3server/web/documentation.py @@ -36,6 +36,11 @@ class Documentation(object): self._directory = directory def write(self): + self.write_documentation(False) + # Controller documentation + self.write_documentation(True) + + def write_documentation(self, controller): for handler_name in sorted(self._documentation): print("Build {}".format(handler_name)) @@ -45,11 +50,20 @@ class Documentation(object): if api_version is None: continue - self._create_handler_directory(handler_name, api_version) + if self._documentation[handler_name][path].get("controller", False): + server_type = "controller" + if not controller: + continue + else: + server_type = "server" + if controller: + continue + + self._create_handler_directory(handler_name, api_version, server_type) filename = self._file_path(path) handler_doc = self._documentation[handler_name][path] - with open("{}/api/v{}/{}/{}.rst".format(self._directory, api_version, handler_name, filename), 'w+') as f: + with open("{}/api/v{}/{}/{}/{}.rst".format(self._directory, api_version, server_type, handler_name, filename), 'w+') as f: f.write('{}\n----------------------------------------------------------------------------------------------------------------------\n\n'.format(path)) f.write('.. contents::\n') for method in handler_doc["methods"]: @@ -81,13 +95,13 @@ class Documentation(object): self._include_query_example(f, method, path, api_version) - def _create_handler_directory(self, handler_name, api_version): + def _create_handler_directory(self, handler_name, api_version, server_type): """Create a directory for the handler and add an index inside""" - directory = "{}/api/v{}/{}".format(self._directory, api_version, handler_name) + directory = "{}/api/v{}/{}/{}".format(self._directory, api_version, server_type, handler_name) os.makedirs(directory, exist_ok=True) - with open("{}/api/v{}/{}.rst".format(self._directory, api_version, handler_name), "w+") as f: + with open("{}/api/v{}/{}/{}.rst".format(self._directory, api_version, server_type, handler_name), "w+") as f: f.write(handler_name.replace("api.", "").replace("_", " ", ).capitalize()) f.write("\n---------------------\n\n") f.write(".. toctree::\n :glob:\n :maxdepth: 2\n\n {}/*\n".format(handler_name)) @@ -98,7 +112,7 @@ class Documentation(object): query_path = "{}_{}.txt".format(m, self._file_path(path)) if os.path.isfile(os.path.join(self._directory, "api", "examples", query_path)): f.write("Sample session\n***************\n") - f.write("\n\n.. literalinclude:: ../../examples/{}\n\n".format(query_path)) + f.write("\n\n.. literalinclude:: ../../../examples/{}\n\n".format(query_path)) def _file_path(self, path): return re.sub("^v1", "", re.sub("[^a-z0-9]", "", path)) diff --git a/gns3server/web/route.py b/gns3server/web/route.py index 97b9d0f9..c71cf5d9 100644 --- a/gns3server/web/route.py +++ b/gns3server/web/route.py @@ -135,6 +135,7 @@ class Route(object): handler = func.__module__.replace("_handler", "").replace("gns3server.handlers.api.", "") cls._documentation.setdefault(handler, {}) cls._documentation[handler].setdefault(route, {"api_version": api_version, + "controller": kw.get("controller", False), "methods": []}) cls._documentation[handler][route]["methods"].append({ diff --git a/tests/handlers/api/test_server.py b/tests/handlers/api/test_server.py index 845920e7..617c9277 100644 --- a/tests/handlers/api/test_server.py +++ b/tests/handlers/api/test_server.py @@ -26,7 +26,7 @@ def test_server_create(server, controller): "user": "julien", "password": "secure" } - response = server.post("/servers", params) + response = server.post("/servers", params, example=True) assert response.status == 201 assert response.route == "/servers" assert response.json["user"] == "julien" diff --git a/tests/web/test_documentation.py b/tests/web/test_documentation.py index 111d24aa..6a57dcfe 100644 --- a/tests/web/test_documentation.py +++ b/tests/web/test_documentation.py @@ -30,11 +30,14 @@ def test_documentation_write(tmpdir): Documentation(Route, str(tmpdir)).write() assert os.path.exists(str(tmpdir / "api")) - assert os.path.exists(str(tmpdir / "api" / "v1")) - assert os.path.exists(str(tmpdir / "api" / "v1" / "virtualbox.rst")) - assert os.path.exists(str(tmpdir / "api" / "v1" / "virtualbox")) - assert os.path.exists(str(tmpdir / "api" / "v1" / "virtualbox" / "virtualboxvms.rst")) - with open(str(tmpdir / "api" / "v1" / "virtualbox" / "projectsprojectidvirtualboxvms.rst")) as f: + assert os.path.exists(str(tmpdir / "api" / "v1" / "server")) + assert os.path.exists(str(tmpdir / "api" / "v1" / "server" / "virtualbox.rst")) + assert os.path.exists(str(tmpdir / "api" / "v1" / "server" / "virtualbox")) + assert os.path.exists(str(tmpdir / "api" / "v1" / "server" / "virtualbox" / "virtualboxvms.rst")) + with open(str(tmpdir / "api" / "v1" / "server" / "virtualbox" / "projectsprojectidvirtualboxvms.rst")) as f: content = f.read() assert "Sample session" in content - assert "literalinclude:: ../../examples/post_projectsprojectidvirtualboxvms.txt" in content + assert "literalinclude:: ../../../examples/post_projectsprojectidvirtualboxvms.txt" in content + + assert os.path.exists(str(tmpdir / "api" / "v1" / "controller" / "server.rst")) +