From e80dd401215cfb140a9185635f10a1778468d0c0 Mon Sep 17 00:00:00 2001 From: Julien Duponchelle Date: Sat, 4 Jun 2016 10:40:39 +0200 Subject: [PATCH] Update docs --- .../compute_delete_projectsprojectid.txt | 1 - ...ptersadapternumberdportsportnumberdnio.txt | 5 +- ...delete_projectsprojectidiounodesnodeid.txt | 5 +- ...ptersadapternumberdportsportnumberdnio.txt | 5 +- ...elete_projectsprojectidqemunodesnodeid.txt | 5 +- ...ptersadapternumberdportsportnumberdnio.txt | 5 +- ...ptersadapternumberdportsportnumberdnio.txt | 5 +- ...elete_projectsprojectidvpcsnodesnodeid.txt | 5 +- ...ptersadapternumberdportsportnumberdnio.txt | 5 +- docs/api/examples/compute_get_interfaces.txt | 307 +++++++++++++++++- ...iounodes.txt => compute_get_iouimages.txt} | 7 +- docs/api/examples/compute_get_projects.txt | 9 +- .../compute_get_projectsprojectid.txt | 6 +- ...te_get_projectsprojectidiounodesnodeid.txt | 15 +- ...projectsprojectidiounodesnodeidconfigs.txt | 5 +- ...e_get_projectsprojectidqemunodesnodeid.txt | 18 +- ...projectsprojectidvirtualboxnodesnodeid.txt | 12 +- ...e_get_projectsprojectidvpcsnodesnodeid.txt | 13 +- .../api/examples/compute_get_qemubinaries.txt | 1 - .../examples/compute_get_qemucapabilities.txt | 1 - docs/api/examples/compute_get_version.txt | 1 - .../examples/compute_post_configreload.txt | 13 - docs/api/examples/compute_post_projects.txt | 6 +- .../compute_post_projectsprojectidclose.txt | 1 - .../compute_post_projectsprojectidcommit.txt | 1 - ...ptersadapternumberdportsportnumberdnio.txt | 5 +- ...ternumberdportsportnumberdstartcapture.txt | 7 +- ...pternumberdportsportnumberdstopcapture.txt | 5 +- ...compute_post_projectsprojectidiounodes.txt | 15 +- ...ptersadapternumberdportsportnumberdnio.txt | 11 +- ...ternumberdportsportnumberdstartcapture.txt | 7 +- ...pternumberdportsportnumberdstopcapture.txt | 5 +- ..._projectsprojectidiounodesnodeidreload.txt | 5 +- ...t_projectsprojectidiounodesnodeidstart.txt | 17 +- ...st_projectsprojectidiounodesnodeidstop.txt | 5 +- ...compute_post_projectsprojectidportsudp.txt | 1 - ...ompute_post_projectsprojectidqemunodes.txt | 18 +- ...ptersadapternumberdportsportnumberdnio.txt | 11 +- ...projectsprojectidqemunodesnodeidreload.txt | 5 +- ...projectsprojectidqemunodesnodeidresume.txt | 5 +- ..._projectsprojectidqemunodesnodeidstart.txt | 18 +- ...t_projectsprojectidqemunodesnodeidstop.txt | 5 +- ...rojectsprojectidqemunodesnodeidsuspend.txt | 5 +- ..._post_projectsprojectidvirtualboxnodes.txt | 8 +- ...ptersadapternumberdportsportnumberdnio.txt | 5 +- ...tsprojectidvirtualboxnodesnodeidreload.txt | 5 +- ...tsprojectidvirtualboxnodesnodeidresume.txt | 5 +- ...ctsprojectidvirtualboxnodesnodeidstart.txt | 5 +- ...ectsprojectidvirtualboxnodesnodeidstop.txt | 5 +- ...sprojectidvirtualboxnodesnodeidsuspend.txt | 5 +- ...ompute_post_projectsprojectidvpcsnodes.txt | 9 +- ...ptersadapternumberdportsportnumberdnio.txt | 5 +- ...projectsprojectidvpcsnodesnodeidreload.txt | 5 +- ..._projectsprojectidvpcsnodesnodeidstart.txt | 13 +- ...t_projectsprojectidvpcsnodesnodeidstop.txt | 5 +- docs/api/examples/compute_post_qemuimg.txt | 1 - docs/api/examples/compute_post_version.txt | 1 - .../compute_put_projectsprojectid.txt | 5 +- ...put_projectsprojectiddockernodesnodeid.txt | 14 +- ...te_put_projectsprojectidiounodesnodeid.txt | 17 +- ...e_put_projectsprojectidqemunodesnodeid.txt | 18 +- ...projectsprojectidvirtualboxnodesnodeid.txt | 12 +- ...e_put_projectsprojectidvpcsnodesnodeid.txt | 13 +- .../controller_delete_projectsprojectid.txt | 5 +- ...er_delete_projectsprojectidlinkslinkid.txt | 8 +- ...er_delete_projectsprojectidnodesnodeid.txt | 7 +- docs/api/examples/controller_get_computes.txt | 4 +- .../controller_get_computescomputeid.txt | 22 ++ docs/api/examples/controller_get_projects.txt | 8 +- .../controller_get_projectsprojectid.txt | 12 +- .../controller_get_projectsprojectidlinks.txt | 34 ++ .../controller_get_projectsprojectidnodes.txt | 19 +- ...projectidnodesnodeiddynamipsautoidlepc.txt | 16 + ...ctidnodesnodeiddynamipsidlepcproposals.txt | 17 + docs/api/examples/controller_get_version.txt | 1 - .../api/examples/controller_post_computes.txt | 4 +- .../api/examples/controller_post_projects.txt | 8 +- ...controller_post_projectsprojectidclose.txt | 5 +- ...ontroller_post_projectsprojectidcommit.txt | 5 +- ...controller_post_projectsprojectidlinks.txt | 20 +- ...ojectsprojectidlinkslinkidstartcapture.txt | 12 +- ...rojectsprojectidlinkslinkidstopcapture.txt | 12 +- ...controller_post_projectsprojectidnodes.txt | 19 +- ...ost_projectsprojectidnodesnodeidreload.txt | 20 +- ...post_projectsprojectidnodesnodeidstart.txt | 20 +- ..._post_projectsprojectidnodesnodeidstop.txt | 20 +- ...st_projectsprojectidnodesnodeidsuspend.txt | 20 +- ...ller_post_projectsprojectidnodesreload.txt | 12 + ...oller_post_projectsprojectidnodesstart.txt | 12 + ...roller_post_projectsprojectidnodesstop.txt | 12 + ...ler_post_projectsprojectidnodessuspend.txt | 12 + .../api/examples/controller_post_shutdown.txt | 12 + docs/api/examples/controller_post_version.txt | 1 - .../controller_put_computescomputeid.txt | 29 ++ ...oller_put_projectsprojectidnodesnodeid.txt | 21 +- .../{dynamips_device.rst => atm_switch.rst} | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 22 ++ .../projectsprojectidatmswitchnodes.rst | 43 +++ .../projectsprojectidatmswitchnodesnodeid.rst | 92 ++++++ ...ptersadapternumberdportsportnumberdnio.rst | 40 +++ ...ternumberdportsportnumberdstartcapture.rst | 32 ++ ...ctsprojectidatmswitchnodesnodeidstart.rst} | 13 +- ...jectsprojectidatmswitchnodesnodeidstop.rst | 20 ++ ...tsprojectidatmswitchnodesnodeidsuspend.rst | 20 ++ docs/api/v2/compute/{config.rst => cloud.rst} | 4 +- .../cloud/projectsprojectidcloudnodes.rst | 105 ++++++ .../projectsprojectidcloudnodesnodeid.rst | 155 +++++++++ ...ptersadapternumberdportsportnumberdnio.rst | 40 +++ ...ernumberdportsportnumberdstartcapture.rst} | 13 +- ...pternumberdportsportnumberdstopcapture.rst | 22 ++ ...projectsprojectidcloudnodesnodeidstart.rst | 20 ++ .../projectsprojectidcloudnodesnodeidstop.rst | 20 ++ ...ojectsprojectidcloudnodesnodeidsuspend.rst | 20 ++ .../docker/projectsprojectiddockernodes.rst | 33 +- .../projectsprojectiddockernodesnodeid.rst | 33 +- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...ternumberdportsportnumberdstartcapture.rst | 6 +- ...pternumberdportsportnumberdstopcapture.rst | 8 +- ...rojectsprojectiddockernodesnodeidpause.rst | 20 ++ ...ojectsprojectiddockernodesnodeidreload.rst | 47 +-- ...rojectsprojectiddockernodesnodeidstart.rst | 47 +-- ...projectsprojectiddockernodesnodeidstop.rst | 47 +-- ...jectsprojectiddockernodesnodeidsuspend.rst | 63 ---- ...jectsprojectiddockernodesnodeidunpause.rst | 20 ++ .../projectsprojectiddynamipsdevices.rst | 43 --- ...ojectsprojectiddynamipsdevicesdeviceid.rst | 107 ------ ...mipsdevicesdeviceidportsportnumberdnio.rst | 151 --------- .../{dynamipsnodes.rst => dynamipsimages.rst} | 8 +- .../dynamipsimagesfilename.rst} | 12 +- .../projectsprojectiddynamipsnodes.rst | 99 +++--- .../projectsprojectiddynamipsnodesnodeid.rst | 153 ++++----- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...ternumberdportsportnumberdstartcapture.rst | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 4 +- ...projectiddynamipsnodesnodeidautoidlepc.rst | 5 + ...ctsprojectiddynamipsnodesnodeidconfigs.rst | 5 + ...rojectiddynamipsnodesnodeidconfigssave.rst | 5 + ...ctiddynamipsnodesnodeididlepcproposals.rst | 5 + ...ectsprojectiddynamipsnodesnodeidreload.rst | 4 +- ...ectsprojectiddynamipsnodesnodeidresume.rst | 4 +- ...jectsprojectiddynamipsnodesnodeidstart.rst | 4 +- ...ojectsprojectiddynamipsnodesnodeidstop.rst | 4 +- ...ctsprojectiddynamipsnodesnodeidsuspend.rst | 4 +- docs/api/v2/compute/ethernet_hub.rst | 8 + .../projectsprojectidethernethubnodes.rst | 59 ++++ ...rojectsprojectidethernethubnodesnodeid.rst | 108 ++++++ ...ptersadapternumberdportsportnumberdnio.rst | 40 +++ ...ternumberdportsportnumberdstartcapture.rst | 32 ++ ...pternumberdportsportnumberdstopcapture.rst | 22 ++ ...tsprojectidethernethubnodesnodeidstart.rst | 20 ++ ...ctsprojectidethernethubnodesnodeidstop.rst | 20 ++ ...projectidethernethubnodesnodeidsuspend.rst | 20 ++ docs/api/v2/compute/ethernet_switch.rst | 8 + .../projectsprojectidethernetswitchnodes.rst | 62 ++++ ...ectsprojectidethernetswitchnodesnodeid.rst | 111 +++++++ ...ptersadapternumberdportsportnumberdnio.rst | 40 +++ ...ternumberdportsportnumberdstartcapture.rst | 32 ++ ...pternumberdportsportnumberdstopcapture.rst | 22 ++ ...rojectidethernetswitchnodesnodeidstart.rst | 20 ++ ...projectidethernetswitchnodesnodeidstop.rst | 20 ++ ...jectidethernetswitchnodesnodeidsuspend.rst | 20 ++ docs/api/v2/compute/frame_relay_switch.rst | 8 + ...projectsprojectidframerelayswitchnodes.rst | 43 +++ ...tsprojectidframerelayswitchnodesnodeid.rst | 92 ++++++ ...ptersadapternumberdportsportnumberdnio.rst | 40 +++ ...ternumberdportsportnumberdstartcapture.rst | 32 ++ ...pternumberdportsportnumberdstopcapture.rst | 22 ++ ...jectidframerelayswitchnodesnodeidstart.rst | 20 ++ ...ojectidframerelayswitchnodesnodeidstop.rst | 20 ++ ...ctidframerelayswitchnodesnodeidsuspend.rst | 20 ++ .../iou/{iounodes.rst => iouimages.rst} | 10 +- .../iouimagesfilename.rst} | 10 +- .../compute/iou/projectsprojectidiounodes.rst | 12 +- .../iou/projectsprojectidiounodesnodeid.rst | 34 +- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...ternumberdportsportnumberdstartcapture.rst | 6 +- ...pternumberdportsportnumberdstopcapture.rst | 6 +- ...projectsprojectidiounodesnodeidconfigs.rst | 5 + ...ectsprojectidiounodesnodeidconfigssave.rst | 5 + .../projectsprojectidiounodesnodeidreload.rst | 6 +- .../projectsprojectidiounodesnodeidstart.rst | 12 +- .../projectsprojectidiounodesnodeidstop.rst | 6 +- .../network/projectsprojectidportsudp.rst | 2 +- .../compute/notification/notificationsws.rst | 2 +- docs/api/v2/compute/project/projects.rst | 6 +- .../v2/compute/project/projectsprojectid.rst | 13 +- .../project/projectsprojectidclose.rst | 4 +- .../project/projectsprojectidcommit.rst | 2 +- .../project/projectsprojectidexport.rst | 4 +- .../project/projectsprojectidfiles.rst | 4 +- .../project/projectsprojectidfilespath.rst | 12 +- .../project/projectsprojectidimport.rst | 5 +- .../projectsprojectidnotifications.rst | 4 +- .../project/projectsprojectidstreampath.rst | 4 +- .../qemu/projectsprojectidqemunodes.rst | 33 +- .../qemu/projectsprojectidqemunodesnodeid.rst | 60 ++-- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...projectsprojectidqemunodesnodeidreload.rst | 4 +- ...projectsprojectidqemunodesnodeidresume.rst | 4 +- .../projectsprojectidqemunodesnodeidstart.rst | 23 +- .../projectsprojectidqemunodesnodeidstop.rst | 4 +- ...rojectsprojectidqemunodesnodeidsuspend.rst | 4 +- docs/api/v2/compute/qemu/qemubinaries.rst | 2 +- .../qemu/{qemunodes.rst => qemuimages.rst} | 6 +- ...munodespath.rst => qemuimagesfilename.rst} | 10 +- docs/api/v2/compute/qemu/qemuimg.rst | 2 +- docs/api/v2/compute/version/version.rst | 12 +- .../projectsprojectidvirtualboxnodes.rst | 31 +- ...projectsprojectidvirtualboxnodesnodeid.rst | 52 +-- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...ternumberdportsportnumberdstartcapture.rst | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 4 +- ...tsprojectidvirtualboxnodesnodeidreload.rst | 4 +- ...tsprojectidvirtualboxnodesnodeidresume.rst | 4 +- ...ctsprojectidvirtualboxnodesnodeidstart.rst | 4 +- ...ectsprojectidvirtualboxnodesnodeidstop.rst | 4 +- ...sprojectidvirtualboxnodesnodeidsuspend.rst | 4 +- .../vmware/projectsprojectidvmwarenodes.rst | 37 +-- .../projectsprojectidvmwarenodesnodeid.rst | 61 ++-- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...ternumberdportsportnumberdstartcapture.rst | 4 +- ...pternumberdportsportnumberdstopcapture.rst | 4 +- ...jectidvmwarenodesnodeidinterfacesvmnet.rst | 4 +- ...ojectsprojectidvmwarenodesnodeidreload.rst | 4 +- ...ojectsprojectidvmwarenodesnodeidresume.rst | 4 +- ...rojectsprojectidvmwarenodesnodeidstart.rst | 4 +- ...projectsprojectidvmwarenodesnodeidstop.rst | 4 +- ...jectsprojectidvmwarenodesnodeidsuspend.rst | 4 +- .../vpcs/projectsprojectidvpcsnodes.rst | 14 +- .../vpcs/projectsprojectidvpcsnodesnodeid.rst | 30 +- ...ptersadapternumberdportsportnumberdnio.rst | 8 +- ...projectsprojectidvpcsnodesnodeidreload.rst | 4 +- .../projectsprojectidvpcsnodesnodeidstart.rst | 12 +- .../projectsprojectidvpcsnodesnodeidstop.rst | 4 +- docs/api/v2/controller/compute/s.rst | 28 +- docs/api/v2/controller/compute/sid.rst | 86 +++++ .../controller/compute/sidemulatoraction.rst | 18 + docs/api/v2/controller/compute/sshutdown.rst | 14 - .../link/projectsprojectidlinks.rst | 39 ++- .../link/projectsprojectidlinkslinkid.rst | 4 +- .../link/projectsprojectidlinkslinkidpcap.rst | 8 +- ...ojectsprojectidlinkslinkidstartcapture.rst | 17 +- ...rojectsprojectidlinkslinkidstopcapture.rst | 4 +- .../node/projectsprojectidnodes.rst | 30 +- .../node/projectsprojectidnodesnodeid.rst | 34 +- ...projectidnodesnodeiddynamipsautoidlepc.rst | 26 ++ ...ctidnodesnodeiddynamipsidlepcproposals.rst | 26 ++ .../projectsprojectidnodesnodeidreload.rst | 19 +- .../projectsprojectidnodesnodeidstart.rst | 19 +- .../node/projectsprojectidnodesnodeidstop.rst | 21 +- .../projectsprojectidnodesnodeidsuspend.rst | 21 +- .../node/projectsprojectidnodesreload.rst | 45 +++ .../node/projectsprojectidnodesstart.rst | 45 +++ .../node/projectsprojectidnodesstop.rst | 45 +++ .../node/projectsprojectidnodessuspend.rst | 45 +++ docs/api/v2/controller/project/projects.rst | 2 - .../controller/project/projectsprojectid.rst | 8 +- .../project/projectsprojectidclose.rst | 2 +- .../project/projectsprojectidcommit.rst | 2 +- .../projectsprojectidnotifications.rst | 4 +- .../projectsprojectidnotificationsws.rst | 4 +- .../v2/controller/{version.rst => server.rst} | 4 +- .../server/shutdown.rst} | 12 +- .../{version => server}/version.rst | 12 +- 264 files changed, 3544 insertions(+), 1582 deletions(-) rename docs/api/examples/{compute_get_iounodes.txt => compute_get_iouimages.txt} (57%) delete mode 100644 docs/api/examples/compute_post_configreload.txt create mode 100644 docs/api/examples/controller_get_computescomputeid.txt create mode 100644 docs/api/examples/controller_get_projectsprojectidlinks.txt create mode 100644 docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt create mode 100644 docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt create mode 100644 docs/api/examples/controller_post_projectsprojectidnodesreload.txt create mode 100644 docs/api/examples/controller_post_projectsprojectidnodesstart.txt create mode 100644 docs/api/examples/controller_post_projectsprojectidnodesstop.txt create mode 100644 docs/api/examples/controller_post_projectsprojectidnodessuspend.txt create mode 100644 docs/api/examples/controller_post_shutdown.txt create mode 100644 docs/api/examples/controller_put_computescomputeid.txt rename docs/api/v2/compute/{dynamips_device.rst => atm_switch.rst} (65%) create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodes.rst create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeid.rst create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst rename docs/api/v2/compute/{dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst => atm_switch/projectsprojectidatmswitchnodesnodeidstart.rst} (51%) create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstop.rst create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidsuspend.rst rename docs/api/v2/compute/{config.rst => cloud.rst} (78%) create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodes.rst create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst rename docs/api/v2/compute/{dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst => cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst} (70%) create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstart.rst create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstop.rst create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidsuspend.rst create mode 100644 docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst delete mode 100644 docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidsuspend.rst create mode 100644 docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst delete mode 100644 docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevices.rst delete mode 100644 docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst delete mode 100644 docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst rename docs/api/v2/compute/dynamips_vm/{dynamipsnodes.rst => dynamipsimages.rst} (72%) rename docs/api/v2/compute/{iou/iounodespath.rst => dynamips_vm/dynamipsimagesfilename.rst} (62%) create mode 100644 docs/api/v2/compute/ethernet_hub.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodes.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeid.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstart.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstop.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidsuspend.rst create mode 100644 docs/api/v2/compute/ethernet_switch.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodes.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstart.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstop.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidsuspend.rst create mode 100644 docs/api/v2/compute/frame_relay_switch.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodes.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeid.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstart.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstop.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidsuspend.rst rename docs/api/v2/compute/iou/{iounodes.rst => iouimages.rst} (69%) rename docs/api/v2/compute/{dynamips_vm/dynamipsnodespath.rst => iou/iouimagesfilename.rst} (71%) rename docs/api/v2/compute/qemu/{qemunodes.rst => qemuimages.rst} (81%) rename docs/api/v2/compute/qemu/{qemunodespath.rst => qemuimagesfilename.rst} (71%) create mode 100644 docs/api/v2/controller/compute/sid.rst create mode 100644 docs/api/v2/controller/compute/sidemulatoraction.rst delete mode 100644 docs/api/v2/controller/compute/sshutdown.rst create mode 100644 docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst create mode 100644 docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst create mode 100644 docs/api/v2/controller/node/projectsprojectidnodesreload.rst create mode 100644 docs/api/v2/controller/node/projectsprojectidnodesstart.rst create mode 100644 docs/api/v2/controller/node/projectsprojectidnodesstop.rst create mode 100644 docs/api/v2/controller/node/projectsprojectidnodessuspend.rst rename docs/api/v2/controller/{version.rst => server.rst} (77%) rename docs/api/v2/{compute/config/configreload.rst => controller/server/shutdown.rst} (63%) rename docs/api/v2/controller/{version => server}/version.rst (81%) diff --git a/docs/api/examples/compute_delete_projectsprojectid.txt b/docs/api/examples/compute_delete_projectsprojectid.txt index a74dbb81..990fad88 100644 --- a/docs/api/examples/compute_delete_projectsprojectid.txt +++ b/docs/api/examples/compute_delete_projectsprojectid.txt @@ -5,7 +5,6 @@ DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80 HTTP/1.1 HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_delete_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt index ccf1a0e3..e67b5f1f 100644 --- a/docs/api/examples/compute_delete_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_delete_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/33a9c805-e9ea-46af-9954-fb96266e7b6e/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/1b8d4158-9102-4157-9dd5-f38e6cd19934/adapters/0/ports/0/nio' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/33a9c805-e9ea-46af-9954-fb96266e7b6e/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/1b8d4158-9102-4157-9dd5-f38e6cd19934/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/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectidiounodesnodeid.txt b/docs/api/examples/compute_delete_projectsprojectidiounodesnodeid.txt index 15fdd76a..ad157ee6 100644 --- a/docs/api/examples/compute_delete_projectsprojectidiounodesnodeid.txt +++ b/docs/api/examples/compute_delete_projectsprojectidiounodesnodeid.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/c2f16f3e-7010-473e-ab84-9e4b92823df1' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3a447a6a-2bd3-45e9-b688-3a3a796b2c3c' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/c2f16f3e-7010-473e-ab84-9e4b92823df1 HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3a447a6a-2bd3-45e9-b688-3a3a796b2c3c 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/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_delete_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt index 294e6320..1c8e5c5a 100644 --- a/docs/api/examples/compute_delete_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_delete_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/0fd3bfe1-91e0-430e-9028-bc724829e296/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/f4dce4b0-99f0-47c2-b96c-44aea053420a/adapters/1/ports/0/nio' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/0fd3bfe1-91e0-430e-9028-bc724829e296/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/f4dce4b0-99f0-47c2-b96c-44aea053420a/adapters/1/ports/0/nio HTTP/1.1 HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeid.txt b/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeid.txt index 236907ce..3389291b 100644 --- a/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeid.txt +++ b/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeid.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/07a4a0b0-97c7-4252-9ba5-deace10899a3' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/b986e9eb-a616-4374-bda1-ce63e429ed32' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/07a4a0b0-97c7-4252-9ba5-deace10899a3 HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/b986e9eb-a616-4374-bda1-ce63e429ed32 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/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt index b713b833..8dcf2f79 100644 --- a/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_delete_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/c6a898c6-9112-4cce-aca4-9dd821a46de0/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/e00f5705-c2a1-42af-a692-ce69cb261c6d/adapters/1/ports/0/nio' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/c6a898c6-9112-4cce-aca4-9dd821a46de0/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/e00f5705-c2a1-42af-a692-ce69cb261c6d/adapters/1/ports/0/nio HTTP/1.1 HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_delete_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt index 74a85219..8c3a7e0b 100644 --- a/docs/api/examples/compute_delete_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_delete_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/5f749530-f702-460a-b873-05060ecc5c2f/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/ea60ee76-64c1-4afb-8c52-e0480eaba964/adapters/0/ports/0/nio' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/5f749530-f702-460a-b873-05060ecc5c2f/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/ea60ee76-64c1-4afb-8c52-e0480eaba964/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/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeid.txt b/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeid.txt index aa3881f2..6efaab6d 100644 --- a/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeid.txt +++ b/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeid.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/3deff6a0-3bd4-43ab-bc98-a76fd59d5901' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/608d9ace-7462-42b5-a918-773981772681' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/3deff6a0-3bd4-43ab-bc98-a76fd59d5901 HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/608d9ace-7462-42b5-a918-773981772681 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/2.0.0dev1 diff --git a/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt index 357dae48..fc7b79c9 100644 --- a/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_delete_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/b5aa6c6c-3566-4a6e-ad2e-b8019ed07f23/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/d782a674-5385-4dce-9e30-f2f419d6c9db/adapters/0/ports/0/nio' -DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/b5aa6c6c-3566-4a6e-ad2e-b8019ed07f23/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/d782a674-5385-4dce-9e30-f2f419d6c9db/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/2.0.0dev1 diff --git a/docs/api/examples/compute_get_interfaces.txt b/docs/api/examples/compute_get_interfaces.txt index e72ab2e0..09c5959f 100644 --- a/docs/api/examples/compute_get_interfaces.txt +++ b/docs/api/examples/compute_get_interfaces.txt @@ -5,8 +5,7 @@ GET /v2/compute/interfaces HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 1858 +CONTENT-LENGTH: 9082 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -16,7 +15,7 @@ X-ROUTE: /v2/compute/interfaces { "id": "bridge0", "ip_address": "", - "mac_address": "6a:a8:6d:a4:2a:00", + "mac_address": "3e:07:54:87:bc:00", "name": "bridge0" }, { @@ -27,7 +26,7 @@ X-ROUTE: /v2/compute/interfaces }, { "id": "en1", - "ip_address": "192.168.84.148", + "ip_address": "192.168.84.106", "mac_address": "68:a8:6d:4a:c3:16", "name": "en1" }, @@ -96,5 +95,305 @@ X-ROUTE: /v2/compute/interfaces "ip_address": "", "mac_address": "0a:00:27:00:00:06", "name": "vboxnet6" + }, + { + "id": "vmnet1", + "ip_address": "172.16.16.1", + "mac_address": "00:50:56:c0:00:01", + "name": "vmnet1" + }, + { + "id": "vmnet10", + "ip_address": "172.16.7.1", + "mac_address": "00:50:56:c0:00:0a", + "name": "vmnet10" + }, + { + "id": "vmnet11", + "ip_address": "172.16.8.1", + "mac_address": "00:50:56:c0:00:0b", + "name": "vmnet11" + }, + { + "id": "vmnet12", + "ip_address": "172.16.9.1", + "mac_address": "00:50:56:c0:00:0c", + "name": "vmnet12" + }, + { + "id": "vmnet13", + "ip_address": "172.16.10.1", + "mac_address": "00:50:56:c0:00:0d", + "name": "vmnet13" + }, + { + "id": "vmnet14", + "ip_address": "172.16.11.1", + "mac_address": "00:50:56:c0:00:0e", + "name": "vmnet14" + }, + { + "id": "vmnet15", + "ip_address": "172.16.12.1", + "mac_address": "00:50:56:c0:00:0f", + "name": "vmnet15" + }, + { + "id": "vmnet16", + "ip_address": "172.16.13.1", + "mac_address": "00:50:56:c0:00:10", + "name": "vmnet16" + }, + { + "id": "vmnet17", + "ip_address": "172.16.14.1", + "mac_address": "00:50:56:c0:00:11", + "name": "vmnet17" + }, + { + "id": "vmnet18", + "ip_address": "172.16.15.1", + "mac_address": "00:50:56:c0:00:12", + "name": "vmnet18" + }, + { + "id": "vmnet19", + "ip_address": "172.16.17.1", + "mac_address": "00:50:56:c0:00:13", + "name": "vmnet19" + }, + { + "id": "vmnet2", + "ip_address": "172.16.0.1", + "mac_address": "00:50:56:c0:00:02", + "name": "vmnet2" + }, + { + "id": "vmnet20", + "ip_address": "172.16.18.1", + "mac_address": "00:50:56:c0:00:14", + "name": "vmnet20" + }, + { + "id": "vmnet21", + "ip_address": "172.16.19.1", + "mac_address": "00:50:56:c0:00:15", + "name": "vmnet21" + }, + { + "id": "vmnet22", + "ip_address": "172.16.20.1", + "mac_address": "00:50:56:c0:00:16", + "name": "vmnet22" + }, + { + "id": "vmnet23", + "ip_address": "172.16.21.1", + "mac_address": "00:50:56:c0:00:17", + "name": "vmnet23" + }, + { + "id": "vmnet24", + "ip_address": "172.16.22.1", + "mac_address": "00:50:56:c0:00:18", + "name": "vmnet24" + }, + { + "id": "vmnet25", + "ip_address": "172.16.23.1", + "mac_address": "00:50:56:c0:00:19", + "name": "vmnet25" + }, + { + "id": "vmnet26", + "ip_address": "172.16.24.1", + "mac_address": "00:50:56:c0:00:1a", + "name": "vmnet26" + }, + { + "id": "vmnet27", + "ip_address": "172.16.25.1", + "mac_address": "00:50:56:c0:00:1b", + "name": "vmnet27" + }, + { + "id": "vmnet28", + "ip_address": "172.16.26.1", + "mac_address": "00:50:56:c0:00:1c", + "name": "vmnet28" + }, + { + "id": "vmnet29", + "ip_address": "172.16.27.1", + "mac_address": "00:50:56:c0:00:1d", + "name": "vmnet29" + }, + { + "id": "vmnet3", + "ip_address": "172.16.1.1", + "mac_address": "00:50:56:c0:00:03", + "name": "vmnet3" + }, + { + "id": "vmnet30", + "ip_address": "172.16.28.1", + "mac_address": "00:50:56:c0:00:1e", + "name": "vmnet30" + }, + { + "id": "vmnet31", + "ip_address": "172.16.29.1", + "mac_address": "00:50:56:c0:00:1f", + "name": "vmnet31" + }, + { + "id": "vmnet32", + "ip_address": "172.16.30.1", + "mac_address": "00:50:56:c0:00:20", + "name": "vmnet32" + }, + { + "id": "vmnet33", + "ip_address": "172.16.31.1", + "mac_address": "00:50:56:c0:00:21", + "name": "vmnet33" + }, + { + "id": "vmnet34", + "ip_address": "172.16.32.1", + "mac_address": "00:50:56:c0:00:22", + "name": "vmnet34" + }, + { + "id": "vmnet35", + "ip_address": "172.16.33.1", + "mac_address": "00:50:56:c0:00:23", + "name": "vmnet35" + }, + { + "id": "vmnet36", + "ip_address": "172.16.34.1", + "mac_address": "00:50:56:c0:00:24", + "name": "vmnet36" + }, + { + "id": "vmnet37", + "ip_address": "172.16.35.1", + "mac_address": "00:50:56:c0:00:25", + "name": "vmnet37" + }, + { + "id": "vmnet38", + "ip_address": "172.16.36.1", + "mac_address": "00:50:56:c0:00:26", + "name": "vmnet38" + }, + { + "id": "vmnet39", + "ip_address": "172.16.37.1", + "mac_address": "00:50:56:c0:00:27", + "name": "vmnet39" + }, + { + "id": "vmnet4", + "ip_address": "172.16.2.1", + "mac_address": "00:50:56:c0:00:04", + "name": "vmnet4" + }, + { + "id": "vmnet40", + "ip_address": "172.16.38.1", + "mac_address": "00:50:56:c0:00:28", + "name": "vmnet40" + }, + { + "id": "vmnet41", + "ip_address": "172.16.39.1", + "mac_address": "00:50:56:c0:00:29", + "name": "vmnet41" + }, + { + "id": "vmnet42", + "ip_address": "172.16.40.1", + "mac_address": "00:50:56:c0:00:2a", + "name": "vmnet42" + }, + { + "id": "vmnet43", + "ip_address": "172.16.41.1", + "mac_address": "00:50:56:c0:00:2b", + "name": "vmnet43" + }, + { + "id": "vmnet44", + "ip_address": "172.16.42.1", + "mac_address": "00:50:56:c0:00:2c", + "name": "vmnet44" + }, + { + "id": "vmnet45", + "ip_address": "172.16.43.1", + "mac_address": "00:50:56:c0:00:2d", + "name": "vmnet45" + }, + { + "id": "vmnet46", + "ip_address": "172.16.44.1", + "mac_address": "00:50:56:c0:00:2e", + "name": "vmnet46" + }, + { + "id": "vmnet47", + "ip_address": "172.16.45.1", + "mac_address": "00:50:56:c0:00:2f", + "name": "vmnet47" + }, + { + "id": "vmnet48", + "ip_address": "172.16.46.1", + "mac_address": "00:50:56:c0:00:30", + "name": "vmnet48" + }, + { + "id": "vmnet49", + "ip_address": "172.16.47.1", + "mac_address": "00:50:56:c0:00:31", + "name": "vmnet49" + }, + { + "id": "vmnet5", + "ip_address": "172.16.3.1", + "mac_address": "00:50:56:c0:00:05", + "name": "vmnet5" + }, + { + "id": "vmnet50", + "ip_address": "172.16.48.1", + "mac_address": "00:50:56:c0:00:32", + "name": "vmnet50" + }, + { + "id": "vmnet6", + "ip_address": "172.16.4.1", + "mac_address": "00:50:56:c0:00:06", + "name": "vmnet6" + }, + { + "id": "vmnet7", + "ip_address": "172.16.5.1", + "mac_address": "00:50:56:c0:00:07", + "name": "vmnet7" + }, + { + "id": "vmnet8", + "ip_address": "192.168.229.1", + "mac_address": "00:50:56:c0:00:08", + "name": "vmnet8" + }, + { + "id": "vmnet9", + "ip_address": "172.16.6.1", + "mac_address": "00:50:56:c0:00:09", + "name": "vmnet9" } ] diff --git a/docs/api/examples/compute_get_iounodes.txt b/docs/api/examples/compute_get_iouimages.txt similarity index 57% rename from docs/api/examples/compute_get_iounodes.txt rename to docs/api/examples/compute_get_iouimages.txt index a122fe58..87c51ec2 100644 --- a/docs/api/examples/compute_get_iounodes.txt +++ b/docs/api/examples/compute_get_iouimages.txt @@ -1,16 +1,15 @@ -curl -i -X GET 'http://localhost:3080/v2/compute/iou/nodes' +curl -i -X GET 'http://localhost:3080/v2/compute/iou/images' -GET /v2/compute/iou/nodes HTTP/1.1 +GET /v2/compute/iou/images HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 72 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 -X-ROUTE: /v2/compute/iou/nodes +X-ROUTE: /v2/compute/iou/images [ { diff --git a/docs/api/examples/compute_get_projects.txt b/docs/api/examples/compute_get_projects.txt index e580662b..e2e41882 100644 --- a/docs/api/examples/compute_get_projects.txt +++ b/docs/api/examples/compute_get_projects.txt @@ -5,8 +5,7 @@ GET /v2/compute/projects HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 254 +CONTENT-LENGTH: 198 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -15,12 +14,10 @@ X-ROUTE: /v2/compute/projects [ { "name": "test", - "project_id": "52010203-0405-0607-0809-0a0b0c0d0e0b", - "temporary": false + "project_id": "51010203-0405-0607-0809-0a0b0c0d0e0f" }, { "name": "test", - "project_id": "51010203-0405-0607-0809-0a0b0c0d0e0f", - "temporary": false + "project_id": "52010203-0405-0607-0809-0a0b0c0d0e0b" } ] diff --git a/docs/api/examples/compute_get_projectsprojectid.txt b/docs/api/examples/compute_get_projectsprojectid.txt index c8315569..e7ab79bc 100644 --- a/docs/api/examples/compute_get_projectsprojectid.txt +++ b/docs/api/examples/compute_get_projectsprojectid.txt @@ -5,8 +5,7 @@ GET /v2/compute/projects/40010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 104 +CONTENT-LENGTH: 80 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -14,6 +13,5 @@ X-ROUTE: /v2/compute/projects/{project_id} { "name": "test", - "project_id": "40010203-0405-0607-0809-0a0b0c0d0e02", - "temporary": false + "project_id": "40010203-0405-0607-0809-0a0b0c0d0e02" } diff --git a/docs/api/examples/compute_get_projectsprojectidiounodesnodeid.txt b/docs/api/examples/compute_get_projectsprojectidiounodesnodeid.txt index d679b087..41981811 100644 --- a/docs/api/examples/compute_get_projectsprojectidiounodesnodeid.txt +++ b/docs/api/examples/compute_get_projectsprojectidiounodesnodeid.txt @@ -1,12 +1,11 @@ -curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/96b132df-9ce7-46ef-b8fb-406a3d867c38' +curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/511d4e03-9127-4185-8d26-113b892e3b4d' -GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/96b132df-9ce7-46ef-b8fb-406a3d867c38 HTTP/1.1 +GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/511d4e03-9127-4185-8d26-113b892e3b4d HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 645 +CONTENT-LENGTH: 702 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -15,12 +14,14 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id} { "command_line": "", "console": 5000, + "console_type": "telnet", "ethernet_adapters": 2, "iourc_path": null, "l1_keepalives": false, "md5sum": null, "name": "PC TEST 1", - "node_id": "96b132df-9ce7-46ef-b8fb-406a3d867c38", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpz4_fxv1q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/511d4e03-9127-4185-8d26-113b892e3b4d", + "node_id": "511d4e03-9127-4185-8d26-113b892e3b4d", "nvram": 128, "path": "iou.bin", "private_config": null, @@ -28,6 +29,6 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id} "ram": 256, "serial_adapters": 2, "startup_config": null, - "use_default_iou_values": true, - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0vou54g1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/96b132df-9ce7-46ef-b8fb-406a3d867c38" + "status": "stopped", + "use_default_iou_values": true } diff --git a/docs/api/examples/compute_get_projectsprojectidiounodesnodeidconfigs.txt b/docs/api/examples/compute_get_projectsprojectidiounodesnodeidconfigs.txt index f8b3e6e2..a785e3b8 100644 --- a/docs/api/examples/compute_get_projectsprojectidiounodesnodeidconfigs.txt +++ b/docs/api/examples/compute_get_projectsprojectidiounodesnodeidconfigs.txt @@ -1,11 +1,10 @@ -curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/04746a91-7738-491a-829d-6fa0f933f6bb/configs' +curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/881f5049-8a61-47f6-81b7-aa767592a942/configs' -GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/04746a91-7738-491a-829d-6fa0f933f6bb/configs HTTP/1.1 +GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/881f5049-8a61-47f6-81b7-aa767592a942/configs HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 40 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_get_projectsprojectidqemunodesnodeid.txt b/docs/api/examples/compute_get_projectsprojectidqemunodesnodeid.txt index 7d08ef98..326231c4 100644 --- a/docs/api/examples/compute_get_projectsprojectidqemunodesnodeid.txt +++ b/docs/api/examples/compute_get_projectsprojectidqemunodesnodeid.txt @@ -1,12 +1,11 @@ -curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/530d47d9-0234-4798-a25f-80d769b4fa84' +curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/6670bc67-b9c6-4051-9617-9ef416f0776e' -GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/530d47d9-0234-4798-a25f-80d769b4fa84 HTTP/1.1 +GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/6670bc67-b9c6-4051-9617-9ef416f0776e HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 1388 +CONTENT-LENGTH: 1415 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -42,15 +41,16 @@ X-ROUTE: /v2/compute/projects/{project_id}/qemu/nodes/{node_id} "kernel_image": "", "kernel_image_md5sum": null, "legacy_networking": false, - "mac_address": "00:00:ab:fa:84:00", + "mac_address": "00:dd:80:77:6e:00", "name": "PC TEST 1", - "node_id": "530d47d9-0234-4798-a25f-80d769b4fa84", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/6670bc67-b9c6-4051-9617-9ef416f0776e", + "node_id": "6670bc67-b9c6-4051-9617-9ef416f0776e", "options": "", "platform": "x86_64", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmptlp_o4d8/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8s9ej_hh/qemu-system-x86_64", "ram": 256, - "usage": "", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/530d47d9-0234-4798-a25f-80d769b4fa84" + "status": "stopped", + "usage": "" } diff --git a/docs/api/examples/compute_get_projectsprojectidvirtualboxnodesnodeid.txt b/docs/api/examples/compute_get_projectsprojectidvirtualboxnodesnodeid.txt index 2ecc1931..c1726a13 100644 --- a/docs/api/examples/compute_get_projectsprojectidvirtualboxnodesnodeid.txt +++ b/docs/api/examples/compute_get_projectsprojectidvirtualboxnodesnodeid.txt @@ -1,12 +1,11 @@ -curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/635ebd8e-23a4-4a8c-97ea-190076434488' +curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/2c321919-2dec-4d8c-953a-a964679036ee' -GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/635ebd8e-23a4-4a8c-97ea-190076434488 HTTP/1.1 +GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/2c321919-2dec-4d8c-953a-a964679036ee HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 417 +CONTENT-LENGTH: 444 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -20,10 +19,11 @@ X-ROUTE: /v2/compute/projects/{project_id}/virtualbox/nodes/{node_id} "enable_remote_console": false, "headless": false, "name": "VMTEST", - "node_id": "635ebd8e-23a4-4a8c-97ea-190076434488", + "node_directory": null, + "node_id": "2c321919-2dec-4d8c-953a-a964679036ee", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 0, + "status": "stopped", "use_any_adapter": false, - "vm_directory": null, "vmname": "VMTEST" } diff --git a/docs/api/examples/compute_get_projectsprojectidvpcsnodesnodeid.txt b/docs/api/examples/compute_get_projectsprojectidvpcsnodesnodeid.txt index 0e5b8258..3bf8940f 100644 --- a/docs/api/examples/compute_get_projectsprojectidvpcsnodesnodeid.txt +++ b/docs/api/examples/compute_get_projectsprojectidvpcsnodesnodeid.txt @@ -1,12 +1,11 @@ -curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/f69cd7e8-e3d8-4917-b7ee-0fb5e58d945e' +curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/6e24ecc3-7a6b-4876-b881-47dcc1bf13f5' -GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/f69cd7e8-e3d8-4917-b7ee-0fb5e58d945e HTTP/1.1 +GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/6e24ecc3-7a6b-4876-b881-47dcc1bf13f5 HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 487 +CONTENT-LENGTH: 489 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -17,10 +16,10 @@ X-ROUTE: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id} "console": 5009, "console_type": "telnet", "name": "PC TEST 1", - "node_id": "f69cd7e8-e3d8-4917-b7ee-0fb5e58d945e", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/6e24ecc3-7a6b-4876-b881-47dcc1bf13f5", + "node_id": "6e24ecc3-7a6b-4876-b881-47dcc1bf13f5", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, - "status": "stopped", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/f69cd7e8-e3d8-4917-b7ee-0fb5e58d945e" + "status": "stopped" } diff --git a/docs/api/examples/compute_get_qemubinaries.txt b/docs/api/examples/compute_get_qemubinaries.txt index e67ab204..009a2cb3 100644 --- a/docs/api/examples/compute_get_qemubinaries.txt +++ b/docs/api/examples/compute_get_qemubinaries.txt @@ -9,7 +9,6 @@ GET /v2/compute/qemu/binaries HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 212 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_get_qemucapabilities.txt b/docs/api/examples/compute_get_qemucapabilities.txt index 0aed3a55..7741ed76 100644 --- a/docs/api/examples/compute_get_qemucapabilities.txt +++ b/docs/api/examples/compute_get_qemucapabilities.txt @@ -5,7 +5,6 @@ GET /v2/compute/qemu/capabilities HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 39 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_get_version.txt b/docs/api/examples/compute_get_version.txt index c5320d44..5c4dc735 100644 --- a/docs/api/examples/compute_get_version.txt +++ b/docs/api/examples/compute_get_version.txt @@ -5,7 +5,6 @@ GET /v2/compute/version HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 49 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_post_configreload.txt b/docs/api/examples/compute_post_configreload.txt deleted file mode 100644 index 50b3fa58..00000000 --- a/docs/api/examples/compute_post_configreload.txt +++ /dev/null @@ -1,13 +0,0 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/config/reload' -d '{}' - -POST /v2/compute/config/reload HTTP/1.1 -{} - - -HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 0 -DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.5 GNS3/2.0.0dev1 -X-ROUTE: /v2/compute/config/reload - diff --git a/docs/api/examples/compute_post_projects.txt b/docs/api/examples/compute_post_projects.txt index 950de2bb..5008d644 100644 --- a/docs/api/examples/compute_post_projects.txt +++ b/docs/api/examples/compute_post_projects.txt @@ -8,8 +8,7 @@ POST /v2/compute/projects HTTP/1.1 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 104 +CONTENT-LENGTH: 80 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -17,6 +16,5 @@ X-ROUTE: /v2/compute/projects { "name": "test", - "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f", - "temporary": false + "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f" } diff --git a/docs/api/examples/compute_post_projectsprojectidclose.txt b/docs/api/examples/compute_post_projectsprojectidclose.txt index f52391cf..c41bf64b 100644 --- a/docs/api/examples/compute_post_projectsprojectidclose.txt +++ b/docs/api/examples/compute_post_projectsprojectidclose.txt @@ -5,7 +5,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close HTTP/1.1 HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidcommit.txt b/docs/api/examples/compute_post_projectsprojectidcommit.txt index ba819b85..f9d24e39 100644 --- a/docs/api/examples/compute_post_projectsprojectidcommit.txt +++ b/docs/api/examples/compute_post_projectsprojectidcommit.txt @@ -5,7 +5,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit HTTP/1.1 HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt index 460807b1..17cd74d1 100644 --- a/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/0a78c30a-020d-4fb3-a46a-c90371e7e639/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/7e716b2f-2e3c-4693-9f30-a97ee0e6b240/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/0a78c30a-020d-4fb3-a46a-c90371e7e639/adapters/0/ports/0/nio HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/7e716b2f-2e3c-4693-9f30-a97ee0e6b240/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", @@ -10,7 +10,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/0a78 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 89 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt index 2a66b1b9..8702fd29 100644 --- a/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt +++ b/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/5709b8c8-d826-4a39-96b0-b9e8d858a2af/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/974d54a5-b9d4-40cd-84f0-aed270b0e216/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/5709b8c8-d826-4a39-96b0-b9e8d858a2af/adapters/0/ports/0/start_capture HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/974d54a5-b9d4-40cd-84f0-aed270b0e216/adapters/0/ports/0/start_capture HTTP/1.1 { "capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB" @@ -8,7 +8,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/5709 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 157 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT @@ -16,5 +15,5 @@ SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/compute/projects/{project_id}/docker/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture { - "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0vou54g1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/tmp/captures/test.pcap" + "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpz4_fxv1q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/tmp/captures/test.pcap" } diff --git a/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt index e836d65a..5419cd0f 100644 --- a/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt +++ b/docs/api/examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/f22df48a-4e90-459a-b18c-fb88a35908cf/adapters/0/ports/0/stop_capture' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/e1eb066f-0b18-40e7-9172-07611afe7be0/adapters/0/ports/0/stop_capture' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/f22df48a-4e90-459a-b18c-fb88a35908cf/adapters/0/ports/0/stop_capture HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/e1eb066f-0b18-40e7-9172-07611afe7be0/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/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidiounodes.txt b/docs/api/examples/compute_post_projectsprojectidiounodes.txt index 4177c5cd..2efa07c9 100644 --- a/docs/api/examples/compute_post_projectsprojectidiounodes.txt +++ b/docs/api/examples/compute_post_projectsprojectidiounodes.txt @@ -1,17 +1,16 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes' -d '{"name": "PC TEST 1", "node_id": "f057f072-47a1-4dde-8031-2255c955831d", "path": "iou.bin", "startup_config_content": "hostname test"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes' -d '{"name": "PC TEST 1", "node_id": "cdfe9b3f-4e88-419d-ac35-05818cce55e2", "path": "iou.bin", "startup_config_content": "hostname test"}' POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes HTTP/1.1 { "name": "PC TEST 1", - "node_id": "f057f072-47a1-4dde-8031-2255c955831d", + "node_id": "cdfe9b3f-4e88-419d-ac35-05818cce55e2", "path": "iou.bin", "startup_config_content": "hostname test" } HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 661 +CONTENT-LENGTH: 718 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -20,12 +19,14 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes { "command_line": "", "console": 5000, + "console_type": "telnet", "ethernet_adapters": 2, "iourc_path": null, "l1_keepalives": false, "md5sum": null, "name": "PC TEST 1", - "node_id": "f057f072-47a1-4dde-8031-2255c955831d", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpz4_fxv1q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/cdfe9b3f-4e88-419d-ac35-05818cce55e2", + "node_id": "cdfe9b3f-4e88-419d-ac35-05818cce55e2", "nvram": 128, "path": "iou.bin", "private_config": null, @@ -33,6 +34,6 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes "ram": 256, "serial_adapters": 2, "startup_config": "startup-config.cfg", - "use_default_iou_values": true, - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0vou54g1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/f057f072-47a1-4dde-8031-2255c955831d" + "status": "stopped", + "use_default_iou_values": true } diff --git a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt index 5b5428c9..cb87d187 100644 --- a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,15 +1,14 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/57832a42-5145-4de8-a09a-e917a5626b61/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_generic_ethernet"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/c778f4ec-ab3d-47e2-8d50-2cbb8cbbadf5/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_ethernet"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/57832a42-5145-4de8-a09a-e917a5626b61/adapters/1/ports/0/nio HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/c778f4ec-ab3d-47e2-8d50-2cbb8cbbadf5/adapters/1/ports/0/nio HTTP/1.1 { "ethernet_device": "bridge0", - "type": "nio_generic_ethernet" + "type": "nio_ethernet" } HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 72 +CONTENT-LENGTH: 64 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -17,5 +16,5 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id}/adapters/{adapter { "ethernet_device": "bridge0", - "type": "nio_generic_ethernet" + "type": "nio_ethernet" } diff --git a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt index 955a3503..91491230 100644 --- a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt +++ b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/c2edba43-104b-4159-909d-4df1dc262798/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3255b76e-6d3b-473d-86fb-53432ccddc5e/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/c2edba43-104b-4159-909d-4df1dc262798/adapters/0/ports/0/start_capture HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3255b76e-6d3b-473d-86fb-53432ccddc5e/adapters/0/ports/0/start_capture HTTP/1.1 { "capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB" @@ -8,7 +8,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/c2edba4 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 157 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT @@ -16,5 +15,5 @@ SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture { - "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0vou54g1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/tmp/captures/test.pcap" + "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpz4_fxv1q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/tmp/captures/test.pcap" } diff --git a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt index 9e947687..e414cecd 100644 --- a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt +++ b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/1610c995-af0f-46e1-92a4-0d70c6293afe/adapters/0/ports/0/stop_capture' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/5b862522-974a-44c4-9f11-89b687b8db80/adapters/0/ports/0/stop_capture' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/1610c995-af0f-46e1-92a4-0d70c6293afe/adapters/0/ports/0/stop_capture HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/5b862522-974a-44c4-9f11-89b687b8db80/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/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidreload.txt b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidreload.txt index ac536825..da86fbd0 100644 --- a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidreload.txt +++ b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidreload.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/af0377f7-490b-42ba-96c9-3dac785e68ac/reload' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/557ef5f1-daf9-4b14-96b7-a266f994ad15/reload' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/af0377f7-490b-42ba-96c9-3dac785e68ac/reload HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/557ef5f1-daf9-4b14-96b7-a266f994ad15/reload HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstart.txt b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstart.txt index bcc71b3e..1fdef01b 100644 --- a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstart.txt +++ b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstart.txt @@ -1,14 +1,13 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/9d260bc6-62d0-4fcd-bd1b-74a2afa0eff0/start' -d '{"iourc_content": "test"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/14dc1ccf-0e35-4acf-8a84-2669bf4f6b89/start' -d '{"iourc_content": "test"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/9d260bc6-62d0-4fcd-bd1b-74a2afa0eff0/start HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/14dc1ccf-0e35-4acf-8a84-2669bf4f6b89/start HTTP/1.1 { "iourc_content": "test" } HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 709 +CONTENT-LENGTH: 766 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -17,12 +16,14 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id}/start { "command_line": "", "console": 5000, + "console_type": "telnet", "ethernet_adapters": 2, - "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp68swteb4/iourc", + "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpulz6zjj7/iourc", "l1_keepalives": false, "md5sum": null, "name": "PC TEST 1", - "node_id": "9d260bc6-62d0-4fcd-bd1b-74a2afa0eff0", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpz4_fxv1q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/14dc1ccf-0e35-4acf-8a84-2669bf4f6b89", + "node_id": "14dc1ccf-0e35-4acf-8a84-2669bf4f6b89", "nvram": 128, "path": "iou.bin", "private_config": null, @@ -30,6 +31,6 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id}/start "ram": 256, "serial_adapters": 2, "startup_config": null, - "use_default_iou_values": true, - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0vou54g1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/9d260bc6-62d0-4fcd-bd1b-74a2afa0eff0" + "status": "stopped", + "use_default_iou_values": true } diff --git a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstop.txt b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstop.txt index ec29fe54..8a40a984 100644 --- a/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstop.txt +++ b/docs/api/examples/compute_post_projectsprojectidiounodesnodeidstop.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/faa706c0-3afe-4210-9067-54dd72c7c220/stop' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/bd7d845f-ded2-4e0d-b314-14562cc17af0/stop' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/faa706c0-3afe-4210-9067-54dd72c7c220/stop HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/bd7d845f-ded2-4e0d-b314-14562cc17af0/stop HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidportsudp.txt b/docs/api/examples/compute_post_projectsprojectidportsudp.txt index 9d7dde4f..292031f4 100644 --- a/docs/api/examples/compute_post_projectsprojectidportsudp.txt +++ b/docs/api/examples/compute_post_projectsprojectidportsudp.txt @@ -5,7 +5,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/ports/udp HTTP/1. HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 25 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodes.txt b/docs/api/examples/compute_post_projectsprojectidqemunodes.txt index 92eb1de1..36163f71 100644 --- a/docs/api/examples/compute_post_projectsprojectidqemunodes.txt +++ b/docs/api/examples/compute_post_projectsprojectidqemunodes.txt @@ -1,17 +1,16 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes' -d '{"hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmptlp_o4d8/qemu-system-x86_64", "ram": 1024}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes' -d '{"hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8s9ej_hh/qemu-system-x86_64", "ram": 1024}' POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes HTTP/1.1 { "hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmptlp_o4d8/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8s9ej_hh/qemu-system-x86_64", "ram": 1024 } HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 1434 +CONTENT-LENGTH: 1461 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -47,15 +46,16 @@ X-ROUTE: /v2/compute/projects/{project_id}/qemu/nodes "kernel_image": "", "kernel_image_md5sum": null, "legacy_networking": false, - "mac_address": "00:00:ab:e1:35:00", + "mac_address": "00:dd:80:73:24:00", "name": "PC TEST 1", - "node_id": "ac199989-ad61-41bb-9265-2a6aacd1e135", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/2c277ca4-c77f-41c0-86ce-da0a0e3b7324", + "node_id": "2c277ca4-c77f-41c0-86ce-da0a0e3b7324", "options": "", "platform": "x86_64", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmptlp_o4d8/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8s9ej_hh/qemu-system-x86_64", "ram": 1024, - "usage": "", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/ac199989-ad61-41bb-9265-2a6aacd1e135" + "status": "stopped", + "usage": "" } diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt index aa09a38c..18e0dea3 100644 --- a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,21 +1,20 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/e3abe5d8-0f61-41c8-8f76-cd64a3790443/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/8e21be81-23cc-49c8-8915-7e4e44d09d02/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_ethernet"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/e3abe5d8-0f61-41c8-8f76-cd64a3790443/adapters/1/ports/0/nio HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/8e21be81-23cc-49c8-8915-7e4e44d09d02/adapters/1/ports/0/nio HTTP/1.1 { "ethernet_device": "eth0", - "type": "nio_generic_ethernet" + "type": "nio_ethernet" } HTTP/1.1 409 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 89 +CONTENT-LENGTH: 81 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/compute/projects/{project_id}/qemu/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { - "message": "NIO of type nio_generic_ethernet is not supported", + "message": "NIO of type nio_ethernet is not supported", "status": 409 } diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidreload.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidreload.txt index 807ab410..2f7ab431 100644 --- a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidreload.txt +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidreload.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/06aa598c-fe4f-4590-825b-1cc1a255b72f/reload' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/5cddb66b-66a0-40d5-bbb8-50041d611e35/reload' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/06aa598c-fe4f-4590-825b-1cc1a255b72f/reload HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/5cddb66b-66a0-40d5-bbb8-50041d611e35/reload HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidresume.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidresume.txt index 50a5f161..45cf411c 100644 --- a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidresume.txt +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidresume.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/2fd2bef9-0870-4cc0-8bee-41e5ee3d0567/resume' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/e9804cfa-12c7-4d31-ae40-38b70b1ddb70/resume' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/2fd2bef9-0870-4cc0-8bee-41e5ee3d0567/resume HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/e9804cfa-12c7-4d31-ae40-38b70b1ddb70/resume HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstart.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstart.txt index 847e9867..c0b7f644 100644 --- a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstart.txt +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstart.txt @@ -1,12 +1,11 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/774f7849-bc8c-4e4f-920a-5d0e544b0bf0/start' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/38b9db4e-aa29-42d8-bfb9-e3c0db2d3c54/start' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/774f7849-bc8c-4e4f-920a-5d0e544b0bf0/start HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/38b9db4e-aa29-42d8-bfb9-e3c0db2d3c54/start HTTP/1.1 {} HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 1388 +CONTENT-LENGTH: 1415 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -42,15 +41,16 @@ X-ROUTE: /v2/compute/projects/{project_id}/qemu/nodes/{node_id}/start "kernel_image": "", "kernel_image_md5sum": null, "legacy_networking": false, - "mac_address": "00:00:ab:0b:f0:00", + "mac_address": "00:dd:80:3c:54:00", "name": "PC TEST 1", - "node_id": "774f7849-bc8c-4e4f-920a-5d0e544b0bf0", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/38b9db4e-aa29-42d8-bfb9-e3c0db2d3c54", + "node_id": "38b9db4e-aa29-42d8-bfb9-e3c0db2d3c54", "options": "", "platform": "x86_64", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmptlp_o4d8/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8s9ej_hh/qemu-system-x86_64", "ram": 256, - "usage": "", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/774f7849-bc8c-4e4f-920a-5d0e544b0bf0" + "status": "stopped", + "usage": "" } diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstop.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstop.txt index 293d73b9..2db925e8 100644 --- a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstop.txt +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidstop.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/8dc83697-0589-47ee-86ea-c092175764d9/stop' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/7f9f9e66-96d9-43a1-8112-80ffe7c180f4/stop' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/8dc83697-0589-47ee-86ea-c092175764d9/stop HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/7f9f9e66-96d9-43a1-8112-80ffe7c180f4/stop HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidsuspend.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidsuspend.txt index ed7d7211..10ff8c5c 100644 --- a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidsuspend.txt +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidsuspend.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/fa906669-98de-448b-b61e-1f6984745681/suspend' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/10cede69-964e-4551-bdc1-48cc3ffcb70a/suspend' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/fa906669-98de-448b-b61e-1f6984745681/suspend HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/10cede69-964e-4551-bdc1-48cc3ffcb70a/suspend HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodes.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodes.txt index 28e52d76..9f954fe4 100644 --- a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodes.txt +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodes.txt @@ -9,8 +9,7 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 411 +CONTENT-LENGTH: 438 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -24,10 +23,11 @@ X-ROUTE: /v2/compute/projects/{project_id}/virtualbox/nodes "enable_remote_console": false, "headless": false, "name": "VM1", - "node_id": "a6a4538d-cd54-45f5-a68a-c146eaed264b", + "node_directory": null, + "node_id": "48d2bb02-9048-497c-8432-a4ff7679e7d7", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 0, + "status": "stopped", "use_any_adapter": false, - "vm_directory": null, "vmname": "VM1" } diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt index a7e58d24..54264797 100644 --- a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/50e13103-1e98-4e5e-97e9-1706b8bf80e5/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/98650464-2470-4d82-8043-3b9ee4b44e05/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/50e13103-1e98-4e5e-97e9-1706b8bf80e5/adapters/0/ports/0/nio HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/98650464-2470-4d82-8043-3b9ee4b44e05/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", @@ -10,7 +10,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/ HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 89 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidreload.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidreload.txt index 0d2ec537..9b99f378 100644 --- a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidreload.txt +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidreload.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/bf57f9a3-3cd1-43ba-8b7f-3738c74ccbcb/reload' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/ad237fc5-f633-4251-9eb7-0f0deb10c869/reload' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/bf57f9a3-3cd1-43ba-8b7f-3738c74ccbcb/reload HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/ad237fc5-f633-4251-9eb7-0f0deb10c869/reload HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidresume.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidresume.txt index 478d77d6..069c9dbb 100644 --- a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidresume.txt +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidresume.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/f363585c-3440-48a0-b98c-26fc6a391b5b/resume' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/9fd683b2-89cb-4b35-8e8c-16af9e0ec449/resume' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/f363585c-3440-48a0-b98c-26fc6a391b5b/resume HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/9fd683b2-89cb-4b35-8e8c-16af9e0ec449/resume HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstart.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstart.txt index 8f0c2e68..81149be8 100644 --- a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstart.txt +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstart.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/e001487d-f9c9-4eca-87c9-0fe3eb0a9e4c/start' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/0755b329-2589-46ac-8864-0005f7091ed9/start' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/e001487d-f9c9-4eca-87c9-0fe3eb0a9e4c/start HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/0755b329-2589-46ac-8864-0005f7091ed9/start HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstop.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstop.txt index 90103645..c996aa50 100644 --- a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstop.txt +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidstop.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/c935caf1-63f8-4fce-acd0-78561f4f742b/stop' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/aef60979-b4cf-4fb6-8618-c8d439fc7552/stop' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/c935caf1-63f8-4fce-acd0-78561f4f742b/stop HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/aef60979-b4cf-4fb6-8618-c8d439fc7552/stop HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidsuspend.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidsuspend.txt index be9d7f33..b6c69851 100644 --- a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidsuspend.txt +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidsuspend.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/117e005a-a1a9-41bb-8dca-a2769425a4fa/suspend' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/f3d0977b-06d2-43ec-a4c1-aecac5895a63/suspend' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/117e005a-a1a9-41bb-8dca-a2769425a4fa/suspend HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/f3d0977b-06d2-43ec-a4c1-aecac5895a63/suspend HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidvpcsnodes.txt b/docs/api/examples/compute_post_projectsprojectidvpcsnodes.txt index fd8dcdda..9772f586 100644 --- a/docs/api/examples/compute_post_projectsprojectidvpcsnodes.txt +++ b/docs/api/examples/compute_post_projectsprojectidvpcsnodes.txt @@ -7,8 +7,7 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes HTTP/1 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 487 +CONTENT-LENGTH: 489 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -19,10 +18,10 @@ X-ROUTE: /v2/compute/projects/{project_id}/vpcs/nodes "console": 5009, "console_type": "telnet", "name": "PC TEST 1", - "node_id": "6719d2a9-7932-4f25-8ab5-583b62140965", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/8453f8ab-1326-4333-afb7-f41c2188be95", + "node_id": "8453f8ab-1326-4333-afb7-f41c2188be95", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, - "status": "stopped", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/6719d2a9-7932-4f25-8ab5-583b62140965" + "status": "stopped" } diff --git a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt index e4717030..24b13241 100644 --- a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/9a86a50f-bd87-4acc-ae3b-8958f5d756cc/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/4d176fbc-2122-436e-8a77-18259e23db92/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/9a86a50f-bd87-4acc-ae3b-8958f5d756cc/adapters/0/ports/0/nio HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/4d176fbc-2122-436e-8a77-18259e23db92/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", @@ -10,7 +10,6 @@ POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/9a86a5 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 89 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidreload.txt b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidreload.txt index ba7d532f..39afc6c9 100644 --- a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidreload.txt +++ b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidreload.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/c886766a-06cd-45a3-92ab-8cdef1c9d192/reload' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/2db6556b-829d-4008-b60e-0f02776121b5/reload' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/c886766a-06cd-45a3-92ab-8cdef1c9d192/reload HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/2db6556b-829d-4008-b60e-0f02776121b5/reload HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstart.txt b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstart.txt index eef5794d..d7e8b44e 100644 --- a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstart.txt +++ b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstart.txt @@ -1,12 +1,11 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/2c97c366-7919-425a-abe5-fff40b854f00/start' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/3a83a1e6-2d84-4081-ac1b-06d8a98b4208/start' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/2c97c366-7919-425a-abe5-fff40b854f00/start HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/3a83a1e6-2d84-4081-ac1b-06d8a98b4208/start HTTP/1.1 {} HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 487 +CONTENT-LENGTH: 489 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -17,10 +16,10 @@ X-ROUTE: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}/start "console": 5009, "console_type": "telnet", "name": "PC TEST 1", - "node_id": "2c97c366-7919-425a-abe5-fff40b854f00", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/3a83a1e6-2d84-4081-ac1b-06d8a98b4208", + "node_id": "3a83a1e6-2d84-4081-ac1b-06d8a98b4208", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, - "status": "stopped", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/2c97c366-7919-425a-abe5-fff40b854f00" + "status": "stopped" } diff --git a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstop.txt b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstop.txt index 0699795e..097ef9af 100644 --- a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstop.txt +++ b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidstop.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/dcd85ba4-f921-438f-9b10-999d04b250d5/stop' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/a6161ff3-c35a-479b-9ae1-830b740f23a5/stop' -d '{}' -POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/dcd85ba4-f921-438f-9b10-999d04b250d5/stop HTTP/1.1 +POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/a6161ff3-c35a-479b-9ae1-830b740f23a5/stop HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_qemuimg.txt b/docs/api/examples/compute_post_qemuimg.txt index 89f26cfb..e6fdd745 100644 --- a/docs/api/examples/compute_post_qemuimg.txt +++ b/docs/api/examples/compute_post_qemuimg.txt @@ -14,7 +14,6 @@ POST /v2/compute/qemu/img HTTP/1.1 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/compute_post_version.txt b/docs/api/examples/compute_post_version.txt index fefa9a79..273e8cf4 100644 --- a/docs/api/examples/compute_post_version.txt +++ b/docs/api/examples/compute_post_version.txt @@ -7,7 +7,6 @@ POST /v2/compute/version HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 30 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_put_projectsprojectid.txt b/docs/api/examples/compute_put_projectsprojectid.txt index a7ab2f9e..83cd67dc 100644 --- a/docs/api/examples/compute_put_projectsprojectid.txt +++ b/docs/api/examples/compute_put_projectsprojectid.txt @@ -1,14 +1,13 @@ -curl -i -X PUT 'http://localhost:3080/v2/compute/projects/90010203-0405-0607-0809-0a0b0c0d0e0b' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-152/test_update_path_project_non_l0"}' +curl -i -X PUT 'http://localhost:3080/v2/compute/projects/90010203-0405-0607-0809-0a0b0c0d0e0b' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-352/test_update_path_project_non_l0"}' PUT /v2/compute/projects/90010203-0405-0607-0809-0a0b0c0d0e0b HTTP/1.1 { "name": "second_name", - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-152/test_update_path_project_non_l0" + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-352/test_update_path_project_non_l0" } HTTP/1.1 403 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 96 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/compute_put_projectsprojectiddockernodesnodeid.txt b/docs/api/examples/compute_put_projectsprojectiddockernodesnodeid.txt index a60d45c6..c28d880b 100644 --- a/docs/api/examples/compute_put_projectsprojectiddockernodesnodeid.txt +++ b/docs/api/examples/compute_put_projectsprojectiddockernodesnodeid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/10e0eea7-ee6b-4e4f-8bfb-653b70b2fe6e' -d '{"console": 5002, "environment": "GNS3=1\nGNS4=0", "name": "test", "start_command": "yes"}' +curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/37b7b7c7-858b-49ee-a49b-a8def1cf9361' -d '{"console": 5002, "environment": "GNS3=1\nGNS4=0", "name": "test", "start_command": "yes"}' -PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/10e0eea7-ee6b-4e4f-8bfb-653b70b2fe6e HTTP/1.1 +PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/37b7b7c7-858b-49ee-a49b-a8def1cf9361 HTTP/1.1 { "console": 5002, "environment": "GNS3=1\nGNS4=0", @@ -10,8 +10,7 @@ PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/10e0e HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 631 +CONTENT-LENGTH: 665 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -27,10 +26,11 @@ X-ROUTE: /v2/compute/projects/{project_id}/docker/nodes/{node_id} "console_type": "telnet", "container_id": "8bd8153ea8f5", "environment": "GNS3=1\nGNS4=0", - "image": "nginx", + "image": "nginx:latest", "name": "test", - "node_id": "10e0eea7-ee6b-4e4f-8bfb-653b70b2fe6e", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpz4_fxv1q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/docker/37b7b7c7-858b-49ee-a49b-a8def1cf9361", + "node_id": "37b7b7c7-858b-49ee-a49b-a8def1cf9361", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "start_command": "yes", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0vou54g1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/docker/10e0eea7-ee6b-4e4f-8bfb-653b70b2fe6e" + "status": "stopped" } diff --git a/docs/api/examples/compute_put_projectsprojectidiounodesnodeid.txt b/docs/api/examples/compute_put_projectsprojectidiounodesnodeid.txt index 59b87e37..d260076d 100644 --- a/docs/api/examples/compute_put_projectsprojectidiounodesnodeid.txt +++ b/docs/api/examples/compute_put_projectsprojectidiounodesnodeid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/2800118d-916d-46b6-b4ef-148514ccc000' -d '{"console": 5001, "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:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/9a0f4afe-6c25-4613-87d8-3b0cc4db4fc9' -d '{"console": 5001, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}' -PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/2800118d-916d-46b6-b4ef-148514ccc000 HTTP/1.1 +PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/9a0f4afe-6c25-4613-87d8-3b0cc4db4fc9 HTTP/1.1 { "console": 5001, "ethernet_adapters": 4, @@ -16,8 +16,7 @@ PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/2800118d HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 720 +CONTENT-LENGTH: 777 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -26,12 +25,14 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id} { "command_line": "", "console": 5001, + "console_type": "telnet", "ethernet_adapters": 4, - "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzi3b0o9q/iourc", + "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmrvyb0q5/iourc", "l1_keepalives": true, "md5sum": null, "name": "test", - "node_id": "2800118d-916d-46b6-b4ef-148514ccc000", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpz4_fxv1q/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/9a0f4afe-6c25-4613-87d8-3b0cc4db4fc9", + "node_id": "9a0f4afe-6c25-4613-87d8-3b0cc4db4fc9", "nvram": 2048, "path": "iou.bin", "private_config": null, @@ -39,6 +40,6 @@ X-ROUTE: /v2/compute/projects/{project_id}/iou/nodes/{node_id} "ram": 512, "serial_adapters": 0, "startup_config": "startup-config.cfg", - "use_default_iou_values": true, - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0vou54g1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/2800118d-916d-46b6-b4ef-148514ccc000" + "status": "stopped", + "use_default_iou_values": true } diff --git a/docs/api/examples/compute_put_projectsprojectidqemunodesnodeid.txt b/docs/api/examples/compute_put_projectsprojectidqemunodesnodeid.txt index 382de0f5..a578c310 100644 --- a/docs/api/examples/compute_put_projectsprojectidqemunodesnodeid.txt +++ b/docs/api/examples/compute_put_projectsprojectidqemunodesnodeid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/74528119-b448-4fd7-8810-e7b561d89165' -d '{"console": 5001, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}' +curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/afc15cab-a0e6-4222-8124-aef2a1cbaeae' -d '{"console": 5001, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}' -PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/74528119-b448-4fd7-8810-e7b561d89165 HTTP/1.1 +PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/afc15cab-a0e6-4222-8124-aef2a1cbaeae HTTP/1.1 { "console": 5001, "hdb_disk_image": "linux.img", @@ -10,8 +10,7 @@ PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/7452811 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 1393 +CONTENT-LENGTH: 1420 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -47,15 +46,16 @@ X-ROUTE: /v2/compute/projects/{project_id}/qemu/nodes/{node_id} "kernel_image": "", "kernel_image_md5sum": null, "legacy_networking": false, - "mac_address": "00:00:ab:91:65:00", + "mac_address": "00:dd:80:ae:ae:00", "name": "test", - "node_id": "74528119-b448-4fd7-8810-e7b561d89165", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/afc15cab-a0e6-4222-8124-aef2a1cbaeae", + "node_id": "afc15cab-a0e6-4222-8124-aef2a1cbaeae", "options": "", "platform": "x86_64", "process_priority": "low", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmptlp_o4d8/qemu-system-x86_64", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp8s9ej_hh/qemu-system-x86_64", "ram": 1024, - "usage": "", - "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/74528119-b448-4fd7-8810-e7b561d89165" + "status": "stopped", + "usage": "" } diff --git a/docs/api/examples/compute_put_projectsprojectidvirtualboxnodesnodeid.txt b/docs/api/examples/compute_put_projectsprojectidvirtualboxnodesnodeid.txt index 99fb6ddc..dfeeefdd 100644 --- a/docs/api/examples/compute_put_projectsprojectidvirtualboxnodesnodeid.txt +++ b/docs/api/examples/compute_put_projectsprojectidvirtualboxnodesnodeid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/db36a6de-debc-4edd-9fcb-639b2a1ca05b' -d '{"console": 5010, "name": "test"}' +curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/299b6f05-f4e9-49fb-bc1f-c6d5b3e0d390' -d '{"console": 5010, "name": "test"}' -PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/db36a6de-debc-4edd-9fcb-639b2a1ca05b HTTP/1.1 +PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/299b6f05-f4e9-49fb-bc1f-c6d5b3e0d390 HTTP/1.1 { "console": 5010, "name": "test" @@ -8,8 +8,7 @@ PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/d HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 415 +CONTENT-LENGTH: 442 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -23,10 +22,11 @@ X-ROUTE: /v2/compute/projects/{project_id}/virtualbox/nodes/{node_id} "enable_remote_console": false, "headless": false, "name": "test", - "node_id": "db36a6de-debc-4edd-9fcb-639b2a1ca05b", + "node_directory": null, + "node_id": "299b6f05-f4e9-49fb-bc1f-c6d5b3e0d390", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 0, + "status": "stopped", "use_any_adapter": false, - "vm_directory": null, "vmname": "VMTEST" } diff --git a/docs/api/examples/compute_put_projectsprojectidvpcsnodesnodeid.txt b/docs/api/examples/compute_put_projectsprojectidvpcsnodesnodeid.txt index cea2e556..83b339cd 100644 --- a/docs/api/examples/compute_put_projectsprojectidvpcsnodesnodeid.txt +++ b/docs/api/examples/compute_put_projectsprojectidvpcsnodesnodeid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/c332cfd9-49c6-4e9c-a868-347cde6c5a08' -d '{"console": 5011, "name": "test", "startup_script": "ip 192.168.1.1"}' +curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/e1add1ee-b455-4afb-9d08-c75dfe1b4202' -d '{"console": 5011, "name": "test", "startup_script": "ip 192.168.1.1"}' -PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/c332cfd9-49c6-4e9c-a868-347cde6c5a08 HTTP/1.1 +PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/e1add1ee-b455-4afb-9d08-c75dfe1b4202 HTTP/1.1 { "console": 5011, "name": "test", @@ -9,8 +9,7 @@ PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/c332cfd HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 503 +CONTENT-LENGTH: 505 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -21,10 +20,10 @@ X-ROUTE: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id} "console": 5011, "console_type": "telnet", "name": "test", - "node_id": "c332cfd9-49c6-4e9c-a868-347cde6c5a08", + "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9l92lnh7/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/e1add1ee-b455-4afb-9d08-c75dfe1b4202", + "node_id": "e1add1ee-b455-4afb-9d08-c75dfe1b4202", "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/tmpzf6i_o35/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/c332cfd9-49c6-4e9c-a868-347cde6c5a08" + "status": "stopped" } diff --git a/docs/api/examples/controller_delete_projectsprojectid.txt b/docs/api/examples/controller_delete_projectsprojectid.txt index 3723ac6f..7cc15438 100644 --- a/docs/api/examples/controller_delete_projectsprojectid.txt +++ b/docs/api/examples/controller_delete_projectsprojectid.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/projects/8e0cfbfc-1c2e-45d5-a4dc-ad2feb1c6cb7' +curl -i -X DELETE 'http://localhost:3080/v2/projects/df0a6f2c-5db1-48fa-96a2-6d321bafa40c' -DELETE /v2/projects/8e0cfbfc-1c2e-45d5-a4dc-ad2feb1c6cb7 HTTP/1.1 +DELETE /v2/projects/df0a6f2c-5db1-48fa-96a2-6d321bafa40c 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/2.0.0dev1 diff --git a/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt b/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt index 7d79392e..f5c78616 100644 --- a/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt +++ b/docs/api/examples/controller_delete_projectsprojectidlinkslinkid.txt @@ -1,13 +1,11 @@ -curl -i -X DELETE 'http://localhost:3080/v2/projects/0f015b6f-23a9-4665-8be0-ce1844b26619/links/a34d2f6b-76d7-4ccd-9559-1d349a2bf2f9' +curl -i -X DELETE 'http://localhost:3080/v2/projects/d442e932-0513-4a89-a2e1-dafa14f7b977/links/ae7ecf27-7018-41fc-9b4a-83785257a36e' -DELETE /v2/projects/0f015b6f-23a9-4665-8be0-ce1844b26619/links/a34d2f6b-76d7-4ccd-9559-1d349a2bf2f9 HTTP/1.1 +DELETE /v2/projects/d442e932-0513-4a89-a2e1-dafa14f7b977/links/ae7ecf27-7018-41fc-9b4a-83785257a36e HTTP/1.1 HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 160 -CONTENT-TYPE: application/json +CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/projects/{project_id}/links/{link_id} diff --git a/docs/api/examples/controller_delete_projectsprojectidnodesnodeid.txt b/docs/api/examples/controller_delete_projectsprojectidnodesnodeid.txt index 99ca1b8d..62de8584 100644 --- a/docs/api/examples/controller_delete_projectsprojectidnodesnodeid.txt +++ b/docs/api/examples/controller_delete_projectsprojectidnodesnodeid.txt @@ -1,11 +1,10 @@ -curl -i -X DELETE 'http://localhost:3080/v2/projects/fe508bfa-60cf-446b-99c9-a4a7957f7000/nodes/ab33630f-bf76-46e4-bf72-a103bc6fcb91' +curl -i -X DELETE 'http://localhost:3080/v2/projects/6442a383-f28e-41bb-a59e-260537f3385e/nodes/0da6c10b-1302-4d73-b60c-d8419586587f' -DELETE /v2/projects/fe508bfa-60cf-446b-99c9-a4a7957f7000/nodes/ab33630f-bf76-46e4-bf72-a103bc6fcb91 HTTP/1.1 +DELETE /v2/projects/6442a383-f28e-41bb-a59e-260537f3385e/nodes/0da6c10b-1302-4d73-b60c-d8419586587f HTTP/1.1 -HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * +HTTP/1.1 204 CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/controller_get_computes.txt b/docs/api/examples/controller_get_computes.txt index c2ea15e8..4bdbe9bf 100644 --- a/docs/api/examples/controller_get_computes.txt +++ b/docs/api/examples/controller_get_computes.txt @@ -5,8 +5,7 @@ GET /v2/computes HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 186 +CONTENT-LENGTH: 221 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -17,6 +16,7 @@ X-ROUTE: /v2/computes "compute_id": "my_compute_id", "connected": false, "host": "example.com", + "name": "My super server", "port": 84, "protocol": "http", "user": "julien" diff --git a/docs/api/examples/controller_get_computescomputeid.txt b/docs/api/examples/controller_get_computescomputeid.txt new file mode 100644 index 00000000..06f5a715 --- /dev/null +++ b/docs/api/examples/controller_get_computescomputeid.txt @@ -0,0 +1,22 @@ +curl -i -X GET 'http://localhost:3080/v2/computes/my_compute_id' + +GET /v2/computes/my_compute_id HTTP/1.1 + + + +HTTP/1.1 200 +CONTENT-LENGTH: 194 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/computes/{compute_id} + +{ + "compute_id": "my_compute_id", + "connected": false, + "host": "example.com", + "name": "http://julien@example.com:84", + "port": 84, + "protocol": "http", + "user": "julien" +} diff --git a/docs/api/examples/controller_get_projects.txt b/docs/api/examples/controller_get_projects.txt index d0617670..6aa2da8e 100644 --- a/docs/api/examples/controller_get_projects.txt +++ b/docs/api/examples/controller_get_projects.txt @@ -5,8 +5,7 @@ GET /v2/projects HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 252 +CONTENT-LENGTH: 224 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -15,8 +14,7 @@ X-ROUTE: /v2/projects [ { "name": "test", - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-152/test_list_projects1", - "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f", - "temporary": false + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-352/test_list_projects1", + "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f" } ] diff --git a/docs/api/examples/controller_get_projectsprojectid.txt b/docs/api/examples/controller_get_projectsprojectid.txt index 609d16a8..9a659792 100644 --- a/docs/api/examples/controller_get_projectsprojectid.txt +++ b/docs/api/examples/controller_get_projectsprojectid.txt @@ -1,12 +1,11 @@ -curl -i -X GET 'http://localhost:3080/v2/projects/948df2b3-7367-4572-8524-d3fb7731b708' +curl -i -X GET 'http://localhost:3080/v2/projects/feeed322-19fa-4e7f-88e4-9b51dd49210a' -GET /v2/projects/948df2b3-7367-4572-8524-d3fb7731b708 HTTP/1.1 +GET /v2/projects/feeed322-19fa-4e7f-88e4-9b51dd49210a HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 226 +CONTENT-LENGTH: 202 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -14,7 +13,6 @@ X-ROUTE: /v2/projects/{project_id} { "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmplj6lpbnn/projects/948df2b3-7367-4572-8524-d3fb7731b708", - "project_id": "948df2b3-7367-4572-8524-d3fb7731b708", - "temporary": false + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmup_isrt/projects/feeed322-19fa-4e7f-88e4-9b51dd49210a", + "project_id": "feeed322-19fa-4e7f-88e4-9b51dd49210a" } diff --git a/docs/api/examples/controller_get_projectsprojectidlinks.txt b/docs/api/examples/controller_get_projectsprojectidlinks.txt new file mode 100644 index 00000000..f57fd122 --- /dev/null +++ b/docs/api/examples/controller_get_projectsprojectidlinks.txt @@ -0,0 +1,34 @@ +curl -i -X GET 'http://localhost:3080/v2/projects/07119acd-00bb-4807-837c-2354a7a89ea2/links' + +GET /v2/projects/07119acd-00bb-4807-837c-2354a7a89ea2/links HTTP/1.1 + + + +HTTP/1.1 200 +CONTENT-LENGTH: 594 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/projects/{project_id}/links + +[ + { + "capture_file_name": null, + "capture_file_path": null, + "capturing": false, + "link_id": "874d9b3c-176e-470a-a8f4-87c0de594dd2", + "nodes": [ + { + "adapter_number": 0, + "node_id": "d1229936-e044-4b1e-94f7-8c40a156b8e5", + "port_number": 3 + }, + { + "adapter_number": 2, + "node_id": "484e4af4-29f5-4443-89f5-fdeacbfabeaa", + "port_number": 4 + } + ], + "project_id": "07119acd-00bb-4807-837c-2354a7a89ea2" + } +] diff --git a/docs/api/examples/controller_get_projectsprojectidnodes.txt b/docs/api/examples/controller_get_projectsprojectidnodes.txt index cdc2a5b4..e376ad02 100644 --- a/docs/api/examples/controller_get_projectsprojectidnodes.txt +++ b/docs/api/examples/controller_get_projectsprojectidnodes.txt @@ -1,12 +1,11 @@ -curl -i -X GET 'http://localhost:3080/v2/projects/89b50c89-a26f-48b5-9948-dcc485949441/nodes' +curl -i -X GET 'http://localhost:3080/v2/projects/f2f077e5-3a75-4ce4-962a-96d163ebc13d/nodes' -GET /v2/projects/89b50c89-a26f-48b5-9948-dcc485949441/nodes HTTP/1.1 +GET /v2/projects/f2f077e5-3a75-4ce4-962a-96d163ebc13d/nodes HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 361 +CONTENT-LENGTH: 487 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -14,15 +13,19 @@ X-ROUTE: /v2/projects/{project_id}/nodes [ { + "command_line": null, "compute_id": "example.com", "console": 2048, - "console_type": "telnet", + "console_host": "example.org", + "console_type": null, "name": "test", - "node_id": "5f4ad652-2ffe-44dd-b4a3-0d48b36a25da", + "node_directory": null, + "node_id": "6a61157a-6210-4bc7-90cc-411007224bb6", "node_type": "vpcs", - "project_id": "89b50c89-a26f-48b5-9948-dcc485949441", + "project_id": "f2f077e5-3a75-4ce4-962a-96d163ebc13d", "properties": { "startup_script": "echo test" - } + }, + "status": "stopped" } ] diff --git a/docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt b/docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt new file mode 100644 index 00000000..a800180b --- /dev/null +++ b/docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt @@ -0,0 +1,16 @@ +curl -i -X GET 'http://localhost:3080/v2/projects/2b073599-518c-4cdc-8337-a11fc8f3c6e1/nodes/181b0687-47f5-456c-b8b0-c1844b64295e/dynamips/auto_idlepc' + +GET /v2/projects/2b073599-518c-4cdc-8337-a11fc8f3c6e1/nodes/181b0687-47f5-456c-b8b0-c1844b64295e/dynamips/auto_idlepc HTTP/1.1 + + + +HTTP/1.1 200 +CONTENT-LENGTH: 30 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/projects/{project_id}/nodes/{node_id}/dynamips/auto_idlepc + +{ + "idlepc": "0x60606f54" +} diff --git a/docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt b/docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt new file mode 100644 index 00000000..e084faf6 --- /dev/null +++ b/docs/api/examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt @@ -0,0 +1,17 @@ +curl -i -X GET 'http://localhost:3080/v2/projects/a5c223ff-91e7-4bb8-acba-7d4080600a0f/nodes/f6074e71-c937-4323-a1ec-4c27d6657c98/dynamips/idlepc_proposals' + +GET /v2/projects/a5c223ff-91e7-4bb8-acba-7d4080600a0f/nodes/f6074e71-c937-4323-a1ec-4c27d6657c98/dynamips/idlepc_proposals HTTP/1.1 + + + +HTTP/1.1 200 +CONTENT-LENGTH: 38 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/projects/{project_id}/nodes/{node_id}/dynamips/idlepc_proposals + +[ + "0x60606f54", + "0x33805a22" +] diff --git a/docs/api/examples/controller_get_version.txt b/docs/api/examples/controller_get_version.txt index 2dadbb58..498b537c 100644 --- a/docs/api/examples/controller_get_version.txt +++ b/docs/api/examples/controller_get_version.txt @@ -5,7 +5,6 @@ GET /v2/version HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 49 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/controller_post_computes.txt b/docs/api/examples/controller_post_computes.txt index 5160d4b3..f6db711e 100644 --- a/docs/api/examples/controller_post_computes.txt +++ b/docs/api/examples/controller_post_computes.txt @@ -12,8 +12,7 @@ POST /v2/computes HTTP/1.1 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 150 +CONTENT-LENGTH: 194 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -23,6 +22,7 @@ X-ROUTE: /v2/computes "compute_id": "my_compute_id", "connected": false, "host": "example.com", + "name": "http://julien@example.com:84", "port": 84, "protocol": "http", "user": "julien" diff --git a/docs/api/examples/controller_post_projects.txt b/docs/api/examples/controller_post_projects.txt index ab484b61..19b3948a 100644 --- a/docs/api/examples/controller_post_projects.txt +++ b/docs/api/examples/controller_post_projects.txt @@ -8,8 +8,7 @@ POST /v2/projects HTTP/1.1 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 226 +CONTENT-LENGTH: 202 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -17,7 +16,6 @@ X-ROUTE: /v2/projects { "name": "test", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpl74b705h/projects/10010203-0405-0607-0809-0a0b0c0d0e0f", - "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f", - "temporary": false + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp02l33jkt/projects/10010203-0405-0607-0809-0a0b0c0d0e0f", + "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f" } diff --git a/docs/api/examples/controller_post_projectsprojectidclose.txt b/docs/api/examples/controller_post_projectsprojectidclose.txt index b1edc313..b78464d3 100644 --- a/docs/api/examples/controller_post_projectsprojectidclose.txt +++ b/docs/api/examples/controller_post_projectsprojectidclose.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/9369b325-7964-402b-80b2-03c5239ae783/close' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/83c8be38-7319-4636-8f4d-2dab2be08554/close' -d '{}' -POST /v2/projects/9369b325-7964-402b-80b2-03c5239ae783/close HTTP/1.1 +POST /v2/projects/83c8be38-7319-4636-8f4d-2dab2be08554/close HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/controller_post_projectsprojectidcommit.txt b/docs/api/examples/controller_post_projectsprojectidcommit.txt index d2f2e532..669c92d2 100644 --- a/docs/api/examples/controller_post_projectsprojectidcommit.txt +++ b/docs/api/examples/controller_post_projectsprojectidcommit.txt @@ -1,11 +1,10 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/23a96a88-666c-49b9-b76f-a68ff800dfee/commit' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/5ab29bd8-43a1-48d0-9aa9-5f96aa382ab4/commit' -d '{}' -POST /v2/projects/23a96a88-666c-49b9-b76f-a68ff800dfee/commit HTTP/1.1 +POST /v2/projects/5ab29bd8-43a1-48d0-9aa9-5f96aa382ab4/commit HTTP/1.1 {} HTTP/1.1 204 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 diff --git a/docs/api/examples/controller_post_projectsprojectidlinks.txt b/docs/api/examples/controller_post_projectsprojectidlinks.txt index de5fa756..2bd6890d 100644 --- a/docs/api/examples/controller_post_projectsprojectidlinks.txt +++ b/docs/api/examples/controller_post_projectsprojectidlinks.txt @@ -1,16 +1,16 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/4eb295b3-8469-4774-b9b3-3da967577540/links' -d '{"nodes": [{"adapter_number": 0, "node_id": "45db581c-3a36-4d8b-960b-1a1884203e3a", "port_number": 3}, {"adapter_number": 2, "node_id": "b81f027a-aac0-4afa-8b30-73440aa5c8f1", "port_number": 4}]}' +curl -i -X POST 'http://localhost:3080/v2/projects/fa91f78d-63fc-4460-bcbd-219f9bf240b2/links' -d '{"nodes": [{"adapter_number": 0, "node_id": "17829f3f-f334-4051-910e-ffc5aa661c02", "port_number": 3}, {"adapter_number": 2, "node_id": "df5b3f33-a535-4f5b-b06a-ccc219e1f0d3", "port_number": 4}]}' -POST /v2/projects/4eb295b3-8469-4774-b9b3-3da967577540/links HTTP/1.1 +POST /v2/projects/fa91f78d-63fc-4460-bcbd-219f9bf240b2/links HTTP/1.1 { "nodes": [ { "adapter_number": 0, - "node_id": "45db581c-3a36-4d8b-960b-1a1884203e3a", + "node_id": "17829f3f-f334-4051-910e-ffc5aa661c02", "port_number": 3 }, { "adapter_number": 2, - "node_id": "b81f027a-aac0-4afa-8b30-73440aa5c8f1", + "node_id": "df5b3f33-a535-4f5b-b06a-ccc219e1f0d3", "port_number": 4 } ] @@ -18,8 +18,7 @@ POST /v2/projects/4eb295b3-8469-4774-b9b3-3da967577540/links HTTP/1.1 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 456 +CONTENT-LENGTH: 514 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -29,17 +28,18 @@ X-ROUTE: /v2/projects/{project_id}/links "capture_file_name": null, "capture_file_path": null, "capturing": false, - "link_id": "f52acf46-42ed-4a90-a780-2aa6a69a3886", + "link_id": "f7c8392b-d888-4824-8099-6f80fe40cef7", "nodes": [ { "adapter_number": 0, - "node_id": "45db581c-3a36-4d8b-960b-1a1884203e3a", + "node_id": "17829f3f-f334-4051-910e-ffc5aa661c02", "port_number": 3 }, { "adapter_number": 2, - "node_id": "b81f027a-aac0-4afa-8b30-73440aa5c8f1", + "node_id": "df5b3f33-a535-4f5b-b06a-ccc219e1f0d3", "port_number": 4 } - ] + ], + "project_id": "fa91f78d-63fc-4460-bcbd-219f9bf240b2" } diff --git a/docs/api/examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt b/docs/api/examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt index 0da5fded..3489a71a 100644 --- a/docs/api/examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt +++ b/docs/api/examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt @@ -1,12 +1,11 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/ff11646d-2bcc-4167-afb6-9f1423a07e7c/links/3fbabcfa-a045-47de-96f4-b464679545ec/start_capture' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/57bf5ae5-eb41-435b-967f-01d686b6663c/links/a8bf8f62-f38f-4291-a5d7-5ab92f5b6065/start_capture' -d '{}' -POST /v2/projects/ff11646d-2bcc-4167-afb6-9f1423a07e7c/links/3fbabcfa-a045-47de-96f4-b464679545ec/start_capture HTTP/1.1 +POST /v2/projects/57bf5ae5-eb41-435b-967f-01d686b6663c/links/a8bf8f62-f38f-4291-a5d7-5ab92f5b6065/start_capture HTTP/1.1 {} HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 160 +CONTENT-LENGTH: 218 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -16,6 +15,7 @@ X-ROUTE: /v2/projects/{project_id}/links/{link_id}/start_capture "capture_file_name": null, "capture_file_path": null, "capturing": false, - "link_id": "3fbabcfa-a045-47de-96f4-b464679545ec", - "nodes": [] + "link_id": "a8bf8f62-f38f-4291-a5d7-5ab92f5b6065", + "nodes": [], + "project_id": "57bf5ae5-eb41-435b-967f-01d686b6663c" } diff --git a/docs/api/examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt b/docs/api/examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt index 834acaac..ce8fd1af 100644 --- a/docs/api/examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt +++ b/docs/api/examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt @@ -1,12 +1,11 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/b80cf39c-f669-4e55-bedc-43d0f4b0a134/links/5e3e109b-c8b2-45b7-a8ae-89507cf5950a/stop_capture' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/416b6eb9-19b7-44a5-a2bc-8956fc6c4c52/links/0fc905b3-7dba-4b34-a371-21b4835d1a1d/stop_capture' -d '{}' -POST /v2/projects/b80cf39c-f669-4e55-bedc-43d0f4b0a134/links/5e3e109b-c8b2-45b7-a8ae-89507cf5950a/stop_capture HTTP/1.1 +POST /v2/projects/416b6eb9-19b7-44a5-a2bc-8956fc6c4c52/links/0fc905b3-7dba-4b34-a371-21b4835d1a1d/stop_capture HTTP/1.1 {} HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 160 +CONTENT-LENGTH: 218 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 @@ -16,6 +15,7 @@ X-ROUTE: /v2/projects/{project_id}/links/{link_id}/stop_capture "capture_file_name": null, "capture_file_path": null, "capturing": false, - "link_id": "5e3e109b-c8b2-45b7-a8ae-89507cf5950a", - "nodes": [] + "link_id": "0fc905b3-7dba-4b34-a371-21b4835d1a1d", + "nodes": [], + "project_id": "416b6eb9-19b7-44a5-a2bc-8956fc6c4c52" } diff --git a/docs/api/examples/controller_post_projectsprojectidnodes.txt b/docs/api/examples/controller_post_projectsprojectidnodes.txt index 88da3867..df6d2ff0 100644 --- a/docs/api/examples/controller_post_projectsprojectidnodes.txt +++ b/docs/api/examples/controller_post_projectsprojectidnodes.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/7602518d-75f4-4a2a-85a6-ff851e3358d4/nodes' -d '{"compute_id": "example.com", "name": "test", "node_type": "vpcs", "properties": {"startup_script": "echo test"}}' +curl -i -X POST 'http://localhost:3080/v2/projects/402a3284-b90c-4394-bd05-01502f6a11d0/nodes' -d '{"compute_id": "example.com", "name": "test", "node_type": "vpcs", "properties": {"startup_script": "echo test"}}' -POST /v2/projects/7602518d-75f4-4a2a-85a6-ff851e3358d4/nodes HTTP/1.1 +POST /v2/projects/402a3284-b90c-4394-bd05-01502f6a11d0/nodes HTTP/1.1 { "compute_id": "example.com", "name": "test", @@ -12,22 +12,25 @@ POST /v2/projects/7602518d-75f4-4a2a-85a6-ff851e3358d4/nodes HTTP/1.1 HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 309 +CONTENT-LENGTH: 419 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/projects/{project_id}/nodes { + "command_line": null, "compute_id": "example.com", "console": 2048, - "console_type": "telnet", + "console_host": "example.org", + "console_type": null, "name": "test", - "node_id": "571ee68c-aa2f-476c-ad63-c900ba382390", + "node_directory": null, + "node_id": "a6a7931e-e4f0-4c90-b823-f838a4a5e1cc", "node_type": "vpcs", - "project_id": "7602518d-75f4-4a2a-85a6-ff851e3358d4", + "project_id": "402a3284-b90c-4394-bd05-01502f6a11d0", "properties": { "startup_script": "echo test" - } + }, + "status": "stopped" } diff --git a/docs/api/examples/controller_post_projectsprojectidnodesnodeidreload.txt b/docs/api/examples/controller_post_projectsprojectidnodesnodeidreload.txt index bf0e76d8..a9299499 100644 --- a/docs/api/examples/controller_post_projectsprojectidnodesnodeidreload.txt +++ b/docs/api/examples/controller_post_projectsprojectidnodesnodeidreload.txt @@ -1,24 +1,12 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/54b7717b-a6c1-49c3-be0c-f74ef1eac9f6/nodes/8c3bd6f3-7241-4de0-92e6-093dc76dfba9/reload' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/895f8203-3d3e-4c88-8da1-7ab55762d293/nodes/560d4f40-6aef-4f38-a8a5-54c1884df387/reload' -d '{}' -POST /v2/projects/54b7717b-a6c1-49c3-be0c-f74ef1eac9f6/nodes/8c3bd6f3-7241-4de0-92e6-093dc76dfba9/reload HTTP/1.1 +POST /v2/projects/895f8203-3d3e-4c88-8da1-7ab55762d293/nodes/560d4f40-6aef-4f38-a8a5-54c1884df387/reload HTTP/1.1 {} -HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 266 -CONTENT-TYPE: application/json +HTTP/1.1 204 +CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/projects/{project_id}/nodes/{node_id}/reload -{ - "compute_id": "example.com", - "console": null, - "console_type": "telnet", - "name": "test", - "node_id": "8c3bd6f3-7241-4de0-92e6-093dc76dfba9", - "node_type": "vpcs", - "project_id": "54b7717b-a6c1-49c3-be0c-f74ef1eac9f6", - "properties": {} -} diff --git a/docs/api/examples/controller_post_projectsprojectidnodesnodeidstart.txt b/docs/api/examples/controller_post_projectsprojectidnodesnodeidstart.txt index 7b13e979..158151fb 100644 --- a/docs/api/examples/controller_post_projectsprojectidnodesnodeidstart.txt +++ b/docs/api/examples/controller_post_projectsprojectidnodesnodeidstart.txt @@ -1,24 +1,12 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/5a61b567-1cbb-4283-acd7-f9cbe4aa8eab/nodes/7f78cc45-579c-437c-a3b3-1129e7b5803b/start' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/c2455e83-bb9a-44d6-930f-e0b07c7240ac/nodes/65be7fda-1816-40dd-8808-1bae7087f407/start' -d '{}' -POST /v2/projects/5a61b567-1cbb-4283-acd7-f9cbe4aa8eab/nodes/7f78cc45-579c-437c-a3b3-1129e7b5803b/start HTTP/1.1 +POST /v2/projects/c2455e83-bb9a-44d6-930f-e0b07c7240ac/nodes/65be7fda-1816-40dd-8808-1bae7087f407/start HTTP/1.1 {} -HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 266 -CONTENT-TYPE: application/json +HTTP/1.1 204 +CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/projects/{project_id}/nodes/{node_id}/start -{ - "compute_id": "example.com", - "console": null, - "console_type": "telnet", - "name": "test", - "node_id": "7f78cc45-579c-437c-a3b3-1129e7b5803b", - "node_type": "vpcs", - "project_id": "5a61b567-1cbb-4283-acd7-f9cbe4aa8eab", - "properties": {} -} diff --git a/docs/api/examples/controller_post_projectsprojectidnodesnodeidstop.txt b/docs/api/examples/controller_post_projectsprojectidnodesnodeidstop.txt index af25129b..6d5a1a5d 100644 --- a/docs/api/examples/controller_post_projectsprojectidnodesnodeidstop.txt +++ b/docs/api/examples/controller_post_projectsprojectidnodesnodeidstop.txt @@ -1,24 +1,12 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/8e81df5a-5d97-4f7a-b2d9-a86a1cfc6b44/nodes/514d81b8-b05c-476a-b127-84881e527732/stop' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/6432473a-128a-4f7b-9f41-70f5d2049854/nodes/49481355-f2c9-430b-bdd5-11ee4c94e600/stop' -d '{}' -POST /v2/projects/8e81df5a-5d97-4f7a-b2d9-a86a1cfc6b44/nodes/514d81b8-b05c-476a-b127-84881e527732/stop HTTP/1.1 +POST /v2/projects/6432473a-128a-4f7b-9f41-70f5d2049854/nodes/49481355-f2c9-430b-bdd5-11ee4c94e600/stop HTTP/1.1 {} -HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 266 -CONTENT-TYPE: application/json +HTTP/1.1 204 +CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/projects/{project_id}/nodes/{node_id}/stop -{ - "compute_id": "example.com", - "console": null, - "console_type": "telnet", - "name": "test", - "node_id": "514d81b8-b05c-476a-b127-84881e527732", - "node_type": "vpcs", - "project_id": "8e81df5a-5d97-4f7a-b2d9-a86a1cfc6b44", - "properties": {} -} diff --git a/docs/api/examples/controller_post_projectsprojectidnodesnodeidsuspend.txt b/docs/api/examples/controller_post_projectsprojectidnodesnodeidsuspend.txt index 5564a2b9..8eaf2390 100644 --- a/docs/api/examples/controller_post_projectsprojectidnodesnodeidsuspend.txt +++ b/docs/api/examples/controller_post_projectsprojectidnodesnodeidsuspend.txt @@ -1,24 +1,12 @@ -curl -i -X POST 'http://localhost:3080/v2/projects/1c60cc7c-b41f-487f-9953-5287041a7146/nodes/a1648be8-6817-491b-8e07-c839d888e94a/suspend' -d '{}' +curl -i -X POST 'http://localhost:3080/v2/projects/1f9538a3-0817-47a2-adab-abf75dc39ca6/nodes/b5b6deca-b7f7-4f37-92bb-d8d115745441/suspend' -d '{}' -POST /v2/projects/1c60cc7c-b41f-487f-9953-5287041a7146/nodes/a1648be8-6817-491b-8e07-c839d888e94a/suspend HTTP/1.1 +POST /v2/projects/1f9538a3-0817-47a2-adab-abf75dc39ca6/nodes/b5b6deca-b7f7-4f37-92bb-d8d115745441/suspend HTTP/1.1 {} -HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 266 -CONTENT-TYPE: application/json +HTTP/1.1 204 +CONTENT-LENGTH: 0 DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/projects/{project_id}/nodes/{node_id}/suspend -{ - "compute_id": "example.com", - "console": null, - "console_type": "telnet", - "name": "test", - "node_id": "a1648be8-6817-491b-8e07-c839d888e94a", - "node_type": "vpcs", - "project_id": "1c60cc7c-b41f-487f-9953-5287041a7146", - "properties": {} -} diff --git a/docs/api/examples/controller_post_projectsprojectidnodesreload.txt b/docs/api/examples/controller_post_projectsprojectidnodesreload.txt new file mode 100644 index 00000000..a2f4167f --- /dev/null +++ b/docs/api/examples/controller_post_projectsprojectidnodesreload.txt @@ -0,0 +1,12 @@ +curl -i -X POST 'http://localhost:3080/v2/projects/b8e14439-5f56-40e0-8dc6-3f84a220a9d4/nodes/reload' -d '{}' + +POST /v2/projects/b8e14439-5f56-40e0-8dc6-3f84a220a9d4/nodes/reload HTTP/1.1 +{} + + +HTTP/1.1 204 +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/projects/{project_id}/nodes/reload + diff --git a/docs/api/examples/controller_post_projectsprojectidnodesstart.txt b/docs/api/examples/controller_post_projectsprojectidnodesstart.txt new file mode 100644 index 00000000..19e9bd83 --- /dev/null +++ b/docs/api/examples/controller_post_projectsprojectidnodesstart.txt @@ -0,0 +1,12 @@ +curl -i -X POST 'http://localhost:3080/v2/projects/a28708a0-50dc-4014-b98f-65b6e11f3f14/nodes/start' -d '{}' + +POST /v2/projects/a28708a0-50dc-4014-b98f-65b6e11f3f14/nodes/start HTTP/1.1 +{} + + +HTTP/1.1 204 +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/projects/{project_id}/nodes/start + diff --git a/docs/api/examples/controller_post_projectsprojectidnodesstop.txt b/docs/api/examples/controller_post_projectsprojectidnodesstop.txt new file mode 100644 index 00000000..b55be010 --- /dev/null +++ b/docs/api/examples/controller_post_projectsprojectidnodesstop.txt @@ -0,0 +1,12 @@ +curl -i -X POST 'http://localhost:3080/v2/projects/c2480e16-b293-47b7-aba0-6ed75b9a3fbc/nodes/stop' -d '{}' + +POST /v2/projects/c2480e16-b293-47b7-aba0-6ed75b9a3fbc/nodes/stop HTTP/1.1 +{} + + +HTTP/1.1 204 +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/projects/{project_id}/nodes/stop + diff --git a/docs/api/examples/controller_post_projectsprojectidnodessuspend.txt b/docs/api/examples/controller_post_projectsprojectidnodessuspend.txt new file mode 100644 index 00000000..aa39d2c0 --- /dev/null +++ b/docs/api/examples/controller_post_projectsprojectidnodessuspend.txt @@ -0,0 +1,12 @@ +curl -i -X POST 'http://localhost:3080/v2/projects/836e2401-c323-48df-971a-b89b0ef73106/nodes/suspend' -d '{}' + +POST /v2/projects/836e2401-c323-48df-971a-b89b0ef73106/nodes/suspend HTTP/1.1 +{} + + +HTTP/1.1 204 +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/projects/{project_id}/nodes/suspend + diff --git a/docs/api/examples/controller_post_shutdown.txt b/docs/api/examples/controller_post_shutdown.txt new file mode 100644 index 00000000..ea61dcbe --- /dev/null +++ b/docs/api/examples/controller_post_shutdown.txt @@ -0,0 +1,12 @@ +curl -i -X POST 'http://localhost:3080/v2/shutdown' -d '{}' + +POST /v2/shutdown HTTP/1.1 +{} + + +HTTP/1.1 201 +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/shutdown + diff --git a/docs/api/examples/controller_post_version.txt b/docs/api/examples/controller_post_version.txt index 87a11127..1cc277d7 100644 --- a/docs/api/examples/controller_post_version.txt +++ b/docs/api/examples/controller_post_version.txt @@ -7,7 +7,6 @@ POST /v2/version HTTP/1.1 HTTP/1.1 200 -ACCESS-CONTROL-ALLOW-ORIGIN: * CONTENT-LENGTH: 30 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT diff --git a/docs/api/examples/controller_put_computescomputeid.txt b/docs/api/examples/controller_put_computescomputeid.txt new file mode 100644 index 00000000..4f46f2f2 --- /dev/null +++ b/docs/api/examples/controller_put_computescomputeid.txt @@ -0,0 +1,29 @@ +curl -i -X PUT 'http://localhost:3080/v2/computes/my_compute_id' -d '{"compute_id": "my_compute_id", "host": "example.com", "password": "secure", "port": 84, "protocol": "https", "user": "julien"}' + +PUT /v2/computes/my_compute_id HTTP/1.1 +{ + "compute_id": "my_compute_id", + "host": "example.com", + "password": "secure", + "port": 84, + "protocol": "https", + "user": "julien" +} + + +HTTP/1.1 200 +CONTENT-LENGTH: 195 +CONTENT-TYPE: application/json +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.5 GNS3/2.0.0dev1 +X-ROUTE: /v2/computes/{compute_id} + +{ + "compute_id": "my_compute_id", + "connected": false, + "host": "example.com", + "name": "http://julien@example.com:84", + "port": 84, + "protocol": "https", + "user": "julien" +} diff --git a/docs/api/examples/controller_put_projectsprojectidnodesnodeid.txt b/docs/api/examples/controller_put_projectsprojectidnodesnodeid.txt index 073d49d2..29bece31 100644 --- a/docs/api/examples/controller_put_projectsprojectidnodesnodeid.txt +++ b/docs/api/examples/controller_put_projectsprojectidnodesnodeid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:3080/v2/projects/265f0fef-ac97-4c5a-b7a5-a3474d9fcfd1/nodes/ff8a4b59-a8f9-4a79-8a56-d2f8ca5e5598' -d '{"compute_id": "example.com", "name": "test", "node_type": "vpcs", "properties": {"startup_script": "echo test"}}' +curl -i -X PUT 'http://localhost:3080/v2/projects/4cc0bd3e-27e6-4e17-9e9e-b996a48aa8bb/nodes/e76db071-66d8-4983-81c4-68367e5b3735' -d '{"compute_id": "example.com", "name": "test", "node_type": "vpcs", "properties": {"startup_script": "echo test"}}' -PUT /v2/projects/265f0fef-ac97-4c5a-b7a5-a3474d9fcfd1/nodes/ff8a4b59-a8f9-4a79-8a56-d2f8ca5e5598 HTTP/1.1 +PUT /v2/projects/4cc0bd3e-27e6-4e17-9e9e-b996a48aa8bb/nodes/e76db071-66d8-4983-81c4-68367e5b3735 HTTP/1.1 { "compute_id": "example.com", "name": "test", @@ -11,23 +11,26 @@ PUT /v2/projects/265f0fef-ac97-4c5a-b7a5-a3474d9fcfd1/nodes/ff8a4b59-a8f9-4a79-8 } -HTTP/1.1 201 -ACCESS-CONTROL-ALLOW-ORIGIN: * -CONTENT-LENGTH: 309 +HTTP/1.1 200 +CONTENT-LENGTH: 419 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.5 GNS3/2.0.0dev1 X-ROUTE: /v2/projects/{project_id}/nodes/{node_id} { + "command_line": null, "compute_id": "example.com", "console": 2048, - "console_type": "telnet", + "console_host": "example.org", + "console_type": null, "name": "test", - "node_id": "ff8a4b59-a8f9-4a79-8a56-d2f8ca5e5598", + "node_directory": null, + "node_id": "e76db071-66d8-4983-81c4-68367e5b3735", "node_type": "vpcs", - "project_id": "265f0fef-ac97-4c5a-b7a5-a3474d9fcfd1", + "project_id": "4cc0bd3e-27e6-4e17-9e9e-b996a48aa8bb", "properties": { "startup_script": "echo test" - } + }, + "status": "stopped" } diff --git a/docs/api/v2/compute/dynamips_device.rst b/docs/api/v2/compute/atm_switch.rst similarity index 65% rename from docs/api/v2/compute/dynamips_device.rst rename to docs/api/v2/compute/atm_switch.rst index 2135b93d..e7b17146 100644 --- a/docs/api/v2/compute/dynamips_device.rst +++ b/docs/api/v2/compute/atm_switch.rst @@ -1,8 +1,8 @@ -Dynamips device +Atm switch ----------------------------- .. toctree:: :glob: :maxdepth: 2 - dynamips_device/* + atm_switch/* diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst new file mode 100644 index 00000000..8951280c --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -0,0 +1,22 @@ +/v2/compute/projects/{project_id}/atm_relay_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/atm_relay_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a packet capture on an ATM switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Capture stopped + diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodes.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodes.rst new file mode 100644 index 00000000..901f086f --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodes.rst @@ -0,0 +1,43 @@ +/v2/compute/projects/{project_id}/atm_switch/nodes +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/atm_switch/nodes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a new ATM switch instance + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: Instance created +- **409**: Conflict + +Input +******* +.. raw:: html + + + + + + +
Name Mandatory Type Description
mappings object ATM mappings
name string ATM switch name
node_id Node UUID
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object ATM mappings
name string ATM switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeid.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeid.rst new file mode 100644 index 00000000..740fc5be --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeid.rst @@ -0,0 +1,92 @@ +/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id} +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get an ATM switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Success +- **400**: Invalid request +- **404**: Instance doesn't exist + +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object ATM mappings
name string ATM switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +PUT /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Update an ATM switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Instance updated +- **400**: Invalid request +- **404**: Instance doesn't exist +- **409**: Conflict + +Input +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object ATM mappings
name string ATM switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object ATM mappings
name string ATM switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +DELETE /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete an ATM switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance deleted + diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst new file mode 100644 index 00000000..5f3e6f33 --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -0,0 +1,40 @@ +/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Add a NIO to an ATM switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: NIO created +- **404**: Instance doesn't exist + + +DELETE /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Remove a NIO from an ATM switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: NIO deleted + diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst new file mode 100644 index 00000000..7d4de696 --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -0,0 +1,32 @@ +/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a packet capture on an ATM switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Capture started +- **400**: Invalid request +- **404**: Instance doesn't exist + +Input +******* +.. raw:: html + + + + + +
Name Mandatory Type Description
capture_file_name string Capture file name
data_link_type enum Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC
+ diff --git a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstart.rst similarity index 51% rename from docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst rename to docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstart.rst index 36bd36b0..121048b4 100644 --- a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstart.rst @@ -1,21 +1,20 @@ -/v2/compute/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/stop_capture +/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id}/start ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -POST /v2/compute/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/stop_capture +POST /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/start ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a packet capture on a Dynamips device instance +Start an ATM switch Parameters ********** -- **port_number**: Port on the device -- **device_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request - **404**: Instance doesn't exist -- **204**: Capture stopped +- **204**: Instance started diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstop.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstop.rst new file mode 100644 index 00000000..97de81c8 --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstop.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id}/stop +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop an ATM switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance stopped + diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidsuspend.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidsuspend.rst new file mode 100644 index 00000000..d893d4d8 --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidsuspend.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id}/suspend +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/suspend +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Suspend an ATM Relay switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance suspended + diff --git a/docs/api/v2/compute/config.rst b/docs/api/v2/compute/cloud.rst similarity index 78% rename from docs/api/v2/compute/config.rst rename to docs/api/v2/compute/cloud.rst index 5f404149..7c18b50b 100644 --- a/docs/api/v2/compute/config.rst +++ b/docs/api/v2/compute/cloud.rst @@ -1,8 +1,8 @@ -Config +Cloud ----------------------------- .. toctree:: :glob: :maxdepth: 2 - config/* + cloud/* diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodes.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodes.rst new file mode 100644 index 00000000..5b1eba6f --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodes.rst @@ -0,0 +1,105 @@ +/v2/compute/projects/{project_id}/cloud/nodes +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/cloud/nodes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a new cloud instance + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: Instance created +- **409**: Conflict + +Input +******* +Types ++++++++++ +EthernetInterfacePort +^^^^^^^^^^^^^^^^^^^^^^ +Ethernet interface port + +.. raw:: html + + + + + + + +
Name Mandatory Type Description
interface string Ethernet interface name e.g. eth0
name string Port name
port_number integer Port number
type enum Possible values: ethernet
+ +HostInterfaces +^^^^^^^^^^^^^^^^^^^^^^ +Interfaces on this host + +.. raw:: html + + + + + +
Name Mandatory Type Description
name string Interface name
type enum Possible values: Ethernet, TAP
+ +TAPInterfacePort +^^^^^^^^^^^^^^^^^^^^^^ +TAP interface port + +.. raw:: html + + + + + + + +
Name Mandatory Type Description
interface string TAP interface name e.g. tap0
name string Port name
port_number integer Port number
type enum Possible values: tap
+ +UDPTunnelPort +^^^^^^^^^^^^^^^^^^^^^^ +UDP tunnel port + +.. raw:: html + + + + + + + + + +
Name Mandatory Type Description
lport integer Local UDP tunnel port
name string Port name
port_number integer Port number
rhost string Remote UDP tunnel host
rport integer Remote UDP tunnel port
type enum Possible values: udp
+ +Body ++++++++++ +.. raw:: html + + + + + + + +
Name Mandatory Type Description
interfaces array
name string Cloud name
node_id Node UUID
ports array
+ +Output +******* +.. raw:: html + + + + + + + + + +
Name Mandatory Type Description
interfaces array
name string Cloud name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst new file mode 100644 index 00000000..630167ab --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst @@ -0,0 +1,155 @@ +/v2/compute/projects/{project_id}/cloud/nodes/{node_id} +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get a cloud instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Success +- **400**: Invalid request +- **404**: Instance doesn't exist + +Output +******* +.. raw:: html + + + + + + + + + +
Name Mandatory Type Description
interfaces array
name string Cloud name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Update a cloud instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Instance updated +- **400**: Invalid request +- **404**: Instance doesn't exist +- **409**: Conflict + +Input +******* +Types ++++++++++ +EthernetInterfacePort +^^^^^^^^^^^^^^^^^^^^^^ +Ethernet interface port + +.. raw:: html + + + + + + + +
Name Mandatory Type Description
interface string Ethernet interface name e.g. eth0
name string Port name
port_number integer Port number
type enum Possible values: ethernet
+ +HostInterfaces +^^^^^^^^^^^^^^^^^^^^^^ +Interfaces on this host + +.. raw:: html + + + + + +
Name Mandatory Type Description
name string Interface name
type enum Possible values: ethernet, tap
+ +TAPInterfacePort +^^^^^^^^^^^^^^^^^^^^^^ +TAP interface port + +.. raw:: html + + + + + + + +
Name Mandatory Type Description
interface string TAP interface name e.g. tap0
name string Port name
port_number integer Port number
type enum Possible values: tap
+ +UDPTunnelPort +^^^^^^^^^^^^^^^^^^^^^^ +UDP tunnel port + +.. raw:: html + + + + + + + + + +
Name Mandatory Type Description
lport integer Local UDP tunnel port
name string Port name
port_number integer Port number
rhost string Remote UDP tunnel host
rport integer Remote UDP tunnel port
type enum Possible values: udp
+ +Body ++++++++++ +.. raw:: html + + + + + + + + + +
Name Mandatory Type Description
interfaces array
name string Cloud name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ +Output +******* +.. raw:: html + + + + + + + + + +
Name Mandatory Type Description
interfaces array
name string Cloud name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete a cloud instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance deleted + diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst new file mode 100644 index 00000000..333336c0 --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -0,0 +1,40 @@ +/v2/compute/projects/{project_id}/cloud/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Add a NIO to a cloud instance + +Parameters +********** +- **adapter_number**: Adapter on the cloud (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the cloud +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: NIO created +- **404**: Instance doesn't exist + + +DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Remove a NIO from a cloud instance + +Parameters +********** +- **adapter_number**: Adapter on the cloud (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the cloud +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: NIO deleted + diff --git a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst similarity index 70% rename from docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst rename to docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst index 36e2c0ae..81b6cc86 100644 --- a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -1,17 +1,18 @@ -/v2/compute/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/start_capture +/v2/compute/projects/{project_id}/cloud/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -POST /v2/compute/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/start_capture +POST /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a packet capture on a Dynamips device instance +Start a packet capture on a cloud instance Parameters ********** -- **port_number**: Port on the device -- **device_id**: UUID for the instance -- **project_id**: UUID for the project +- **adapter_number**: Adapter on the cloud (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the cloud +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst new file mode 100644 index 00000000..acf54da2 --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -0,0 +1,22 @@ +/v2/compute/projects/{project_id}/cloud/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a packet capture on a cloud instance + +Parameters +********** +- **adapter_number**: Adapter on the cloud (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the cloud +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Capture stopped + diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstart.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstart.rst new file mode 100644 index 00000000..7332ec76 --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstart.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/cloud/nodes/{node_id}/start +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a cloud + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance started + diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstop.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstop.rst new file mode 100644 index 00000000..6a1070a7 --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstop.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/cloud/nodes/{node_id}/stop +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a cloud + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance stopped + diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidsuspend.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidsuspend.rst new file mode 100644 index 00000000..28c5de49 --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidsuspend.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/cloud/nodes/{node_id}/suspend +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/suspend +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Suspend a cloud + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance suspended + diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodes.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodes.rst index 7e2e53b1..52047f72 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodes.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodes.rst @@ -9,7 +9,7 @@ Create a new Docker container Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -23,17 +23,17 @@ Input - - - + + + - - + + - - - - + + + +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
adapters ['integer', 'null'] Number of adapters
aux ['integer', 'null'] Auxiliary TCP port
console ['integer', 'null'] Console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution ['string', 'null'] console resolution for VNC
console_http_port integer Internal port in the container for the HTTP server
console_resolution ['string', 'null'] Console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker VM instance identifier
environment ['string', 'null'] Docker environment variables
image string Docker image name
name string Docker container name
node_id string Node UUID
start_command ['string', 'null'] Docker CMD entry
@@ -44,19 +44,20 @@ Output - - + + - - + + - + + - +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux integer auxilary TCP port
console integer console TCP port
aux integer Auxiliary TCP port
console integer Console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution string console resolution for VNC
console_http_port integer Internal port in the container for the HTTP server
console_resolution string Console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
container_id string Docker container ID
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker container instance UUID
node_directory string Path to the node working directory
node_id string Node UUID
project_id string Project UUID
start_command ['string', 'null'] Docker CMD entry
vm_directory string
status enum Possible values: started, stopped, suspended
diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst index c5f3971b..b87bcc83 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst @@ -9,8 +9,8 @@ Delete a Docker container Parameters ********** -- **node_id**: ID for the container -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -25,8 +25,8 @@ Update a Docker instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -41,14 +41,14 @@ Input - - - + + + - - + + - +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
adapters ['integer', 'null'] Number of adapters
aux ['integer', 'null'] Auxiliary TCP port
console ['integer', 'null'] Console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution ['string', 'null'] console resolution for VNC
console_http_port integer Internal port in the container for the HTTP server
console_resolution ['string', 'null'] Console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
environment ['string', 'null'] Docker environment
environment ['string', 'null'] Docker environment variables
name string Docker container name
start_command ['string', 'null'] Docker CMD entry
@@ -60,20 +60,21 @@ Output - - + + - - + + - + + - +
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux integer auxilary TCP port
console integer console TCP port
aux integer Auxiliary TCP port
console integer Console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution string console resolution for VNC
console_http_port integer Internal port in the container for the HTTP server
console_resolution string Console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
container_id string Docker container ID
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker container instance UUID
node_directory string Path to the node working directory
node_id string Node UUID
project_id string Project UUID
start_command ['string', 'null'] Docker CMD entry
vm_directory string
status enum Possible values: started, stopped, suspended
Sample session diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst index c610a68f..e48108d6 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a Docker container Parameters ********** - **adapter_number**: Adapter where the nio should be added +- **node_id**: Node UUID - **port_number**: Port on the adapter -- **node_id**: ID of the container -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -34,9 +34,9 @@ Remove a NIO from a Docker container Parameters ********** - **adapter_number**: Adapter where the nio should be added +- **node_id**: Node UUID - **port_number**: Port on the adapter -- **node_id**: ID of the container -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst index e5025f53..731abbc1 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -5,14 +5,14 @@ POST /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a packet capture on a Docker VM instance +Start a packet capture on a Docker container instance Parameters ********** - **adapter_number**: Adapter to start a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst index 8444860d..65bb655f 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -5,21 +5,21 @@ POST /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a packet capture on a IOU VM instance +Stop a packet capture on a Docker container instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request - **404**: Instance doesn't exist - **204**: Capture stopped -- **409**: VM not started +- **409**: Container not started Sample session *************** diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst new file mode 100644 index 00000000..62ea8357 --- /dev/null +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/docker/nodes/{node_id}/pause +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/pause +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Pause a Docker container + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance paused + diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst index 5ae9fdb9..12b5d9e1 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst @@ -9,8 +9,8 @@ Restart a Docker container Parameters ********** -- **node_id**: ID of the container -- **project_id**: UUID of the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -18,46 +18,3 @@ Response status codes - **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_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution ['string', 'null'] console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker VM instance identifier
start_command ['string', 'null'] Docker CMD entry
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux integer auxilary TCP port
console integer console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution string console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
container_id string Docker container ID
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker container instance UUID
project_id string Project UUID
start_command ['string', 'null'] Docker CMD entry
vm_directory string
- diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst index 9d046d64..073462cb 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst @@ -9,8 +9,8 @@ Start a Docker container Parameters ********** -- **node_id**: ID of the container -- **project_id**: UUID of the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -18,46 +18,3 @@ Response status codes - **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_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution ['string', 'null'] console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker VM instance identifier
start_command ['string', 'null'] Docker CMD entry
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux integer auxilary TCP port
console integer console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution string console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
container_id string Docker container ID
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker container instance UUID
project_id string Project UUID
start_command ['string', 'null'] Docker CMD entry
vm_directory string
- diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst index a319ff9e..88ca6b9a 100644 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst @@ -9,8 +9,8 @@ Stop a Docker container Parameters ********** -- **node_id**: ID of the container -- **project_id**: UUID of the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -18,46 +18,3 @@ Response status codes - **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_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution ['string', 'null'] console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker VM instance identifier
start_command ['string', 'null'] Docker CMD entry
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux integer auxilary TCP port
console integer console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution string console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
container_id string Docker container ID
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker container instance UUID
project_id string Project UUID
start_command ['string', 'null'] Docker CMD entry
vm_directory string
- diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidsuspend.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidsuspend.rst deleted file mode 100644 index 3025c50b..00000000 --- a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidsuspend.rst +++ /dev/null @@ -1,63 +0,0 @@ -/v2/compute/projects/{project_id}/docker/nodes/{node_id}/suspend ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/suspend -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Pause a Docker container - -Parameters -********** -- **node_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
adapters ['integer', 'null'] number of adapters
aux ['integer', 'null'] auxilary TCP port
console ['integer', 'null'] console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution ['string', 'null'] console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker VM instance identifier
start_command ['string', 'null'] Docker CMD entry
- -Output -******* -.. raw:: html - - - - - - - - - - - - - - - - - - -
Name Mandatory Type Description
adapters ['integer', 'null'] number of adapters
aux integer auxilary TCP port
console integer console TCP port
console_http_path string Path of the web interface
console_http_port integer Internal port in the container of the HTTP server
console_resolution string console resolution for VNC
console_type enum Possible values: telnet, vnc, http, https
container_id string Docker container ID
environment ['string', 'null'] Docker environment
image string Docker image name
name string Docker container name
node_id string Docker container instance UUID
project_id string Project UUID
start_command ['string', 'null'] Docker CMD entry
vm_directory string
- diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst new file mode 100644 index 00000000..327ed120 --- /dev/null +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/docker/nodes/{node_id}/unpause +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/unpause +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Unpause a Docker container + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance unpaused + diff --git a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevices.rst b/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevices.rst deleted file mode 100644 index e09628ca..00000000 --- a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevices.rst +++ /dev/null @@ -1,43 +0,0 @@ -/v2/compute/projects/{project_id}/dynamips/devices ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/compute/projects/**{project_id}**/dynamips/devices -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new Dynamips device instance - -Parameters -********** -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: Instance created -- **409**: Conflict - -Input -******* -.. raw:: html - - - - - - -
Name Mandatory Type Description
device_id Dynamips device instance identifier
device_type string Dynamips device type
name string Dynamips device name
- -Output -******* -.. raw:: html - - - - - - - - -
Name Mandatory Type Description
device_id string Dynamips router instance UUID
mappings object
name string Dynamips device instance name
ports array
project_id string Project UUID
- diff --git a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst b/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst deleted file mode 100644 index 967f0664..00000000 --- a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst +++ /dev/null @@ -1,107 +0,0 @@ -/v2/compute/projects/{project_id}/dynamips/devices/{device_id} ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -GET /v2/compute/projects/**{project_id}**/dynamips/devices/**{device_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a Dynamips device instance - -Parameters -********** -- **device_id**: UUID for the instance -- **project_id**: UUID for the project - -Response status codes -********************** -- **200**: Success -- **400**: Invalid request -- **404**: Instance doesn't exist - -Output -******* -.. raw:: html - - - - - - - - -
Name Mandatory Type Description
device_id string Dynamips router instance UUID
mappings object
name string Dynamips device instance name
ports array
project_id string Project UUID
- - -PUT /v2/compute/projects/**{project_id}**/dynamips/devices/**{device_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a Dynamips device instance - -Parameters -********** -- **device_id**: UUID for the instance -- **project_id**: UUID for the project - -Response status codes -********************** -- **200**: Instance updated -- **400**: Invalid request -- **404**: Instance doesn't exist -- **409**: Conflict - -Input -******* -Types -+++++++++ -EthernetSwitchPort -^^^^^^^^^^^^^^^^^^^^^^ -Ethernet switch port - -.. raw:: html - - - - - - - -
Name Mandatory Type Description
ethertype enum Possible values: , 0x8100, 0x88A8, 0x9100, 0x9200
port integer Port number
type enum Possible values: access, dot1q, qinq
vlan integer VLAN number
- -Body -+++++++++ -.. raw:: html - - - - - -
Name Mandatory Type Description
name string Dynamips device instance name
ports array
- -Output -******* -.. raw:: html - - - - - - - - -
Name Mandatory Type Description
device_id string Dynamips router instance UUID
mappings object
name string Dynamips device instance name
ports array
project_id string Project UUID
- - -DELETE /v2/compute/projects/**{project_id}**/dynamips/devices/**{device_id}** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a Dynamips device instance - -Parameters -********** -- **device_id**: UUID for the instance -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: Instance deleted - diff --git a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst b/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst deleted file mode 100644 index f0ca33a3..00000000 --- a/docs/api/v2/compute/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst +++ /dev/null @@ -1,151 +0,0 @@ -/v2/compute/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/nio ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/compute/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add a NIO to a Dynamips device instance - -Parameters -********** -- **port_number**: Port on the device -- **device_id**: UUID for the instance -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **201**: NIO created -- **404**: Instance doesn't exist - -Input -******* -Types -+++++++++ -Ethernet -^^^^^^^^^^^^^^^^^^^^^^ -Generic Ethernet Network Input/Output - -.. raw:: html - - - - - -
Name Mandatory Type Description
ethernet_device string Ethernet device name e.g. eth0
type enum Possible values: nio_generic_ethernet
- -LinuxEthernet -^^^^^^^^^^^^^^^^^^^^^^ -Linux Ethernet Network Input/Output - -.. raw:: html - - - - - -
Name Mandatory Type Description
ethernet_device string Ethernet device name e.g. eth0
type enum Possible values: nio_linux_ethernet
- -NAT -^^^^^^^^^^^^^^^^^^^^^^ -NAT Network Input/Output - -.. raw:: html - - - - -
Name Mandatory Type Description
type enum Possible values: nio_nat
- -NULL -^^^^^^^^^^^^^^^^^^^^^^ -NULL Network Input/Output - -.. raw:: html - - - - -
Name Mandatory Type Description
type enum Possible values: nio_null
- -TAP -^^^^^^^^^^^^^^^^^^^^^^ -TAP Network Input/Output - -.. raw:: html - - - - - -
Name Mandatory Type Description
tap_device string TAP device name e.g. tap0
type enum Possible values: nio_tap
- -UDP -^^^^^^^^^^^^^^^^^^^^^^ -UDP Network Input/Output - -.. raw:: html - - - - - - - -
Name Mandatory Type Description
lport integer Local port
rhost string Remote host
rport integer Remote port
type enum Possible values: nio_udp
- -UNIX -^^^^^^^^^^^^^^^^^^^^^^ -UNIX Network Input/Output - -.. raw:: html - - - - - - -
Name Mandatory Type Description
local_file string path to the UNIX socket file (local)
remote_file string path to the UNIX socket file (remote)
type enum Possible values: nio_unix
- -VDE -^^^^^^^^^^^^^^^^^^^^^^ -VDE Network Input/Output - -.. raw:: html - - - - - - -
Name Mandatory Type Description
control_file string path to the VDE control file
local_file string path to the VDE control file
type enum Possible values: nio_vde
- -Body -+++++++++ -.. raw:: html - - - - - - -
Name Mandatory Type Description
mappings object
nio UDP, Ethernet, LinuxEthernet, NAT, TAP, UNIX, VDE, NULL
port_settings object Ethernet switch
- - -DELETE /v2/compute/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/nio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Remove a NIO from a Dynamips device instance - -Parameters -********** -- **port_number**: Port on the device -- **device_id**: UUID for the instance -- **project_id**: UUID for the project - -Response status codes -********************** -- **400**: Invalid request -- **404**: Instance doesn't exist -- **204**: NIO deleted - diff --git a/docs/api/v2/compute/dynamips_vm/dynamipsnodes.rst b/docs/api/v2/compute/dynamips_vm/dynamipsimages.rst similarity index 72% rename from docs/api/v2/compute/dynamips_vm/dynamipsnodes.rst rename to docs/api/v2/compute/dynamips_vm/dynamipsimages.rst index 8a3fbbae..aaa0be7e 100644 --- a/docs/api/v2/compute/dynamips_vm/dynamipsnodes.rst +++ b/docs/api/v2/compute/dynamips_vm/dynamipsimages.rst @@ -1,13 +1,13 @@ -/v2/compute/dynamips/nodes +/v2/compute/dynamips/images ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -GET /v2/compute/dynamips/nodes +GET /v2/compute/dynamips/images ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the list of Dynamips VMS +Retrieve the list of Dynamips IOS images Response status codes ********************** -- **200**: List of Dynamips VM retrieved +- **200**: List of Dynamips IOS images diff --git a/docs/api/v2/compute/iou/iounodespath.rst b/docs/api/v2/compute/dynamips_vm/dynamipsimagesfilename.rst similarity index 62% rename from docs/api/v2/compute/iou/iounodespath.rst rename to docs/api/v2/compute/dynamips_vm/dynamipsimagesfilename.rst index ec587bb6..ed115e53 100644 --- a/docs/api/v2/compute/iou/iounodespath.rst +++ b/docs/api/v2/compute/dynamips_vm/dynamipsimagesfilename.rst @@ -1,13 +1,17 @@ -/v2/compute/iou/nodes/{path} +/v2/compute/dynamips/images/{filename:.+} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -POST /v2/compute/iou/nodes/**{path}** +POST /v2/compute/dynamips/images/**{filename:.+}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upload IOU image. +Upload a Dynamips IOS image + +Parameters +********** +- **filename**: Image filename Response status codes ********************** -- **204**: Image uploaded +- **204**: Upload a Dynamips IOS image diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst index 4d70aa64..a1c30ef8 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst @@ -9,7 +9,7 @@ Create a new Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -23,35 +23,35 @@ Input - - - - - + + + + + - - - - - + + + + + - - - + + + - + - + - - + + - - + + - + @@ -60,11 +60,11 @@ Input - - - + + + - + @@ -76,35 +76,36 @@ Output
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
auto_delete_disks boolean Automatically delete nvram and disk files
aux integer Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
dynamips_id integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer Dynamips ID
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
node_id Node identifier
node_id Node UUID
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
private_config string Path to the IOS private configuration file
private_config_base64 string Private configuration base64 encoded
private_config_content string Content of IOS private configuration file
ram integer amount of RAM in MB
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file
startup_config_base64 string Startup configuration base64 encoded
startup_config_content string Content of IOS startup configuration file
system_id string system ID
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- - - - - + + + + + - - + + - - + + - - - + + + - + - + + - - + + - - + + - + @@ -113,11 +114,11 @@ Output - - - - - + + + + + diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst index 5a5d48f4..c7f7a768 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst @@ -9,8 +9,8 @@ Get a Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -24,35 +24,36 @@ Output
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
auto_delete_disks boolean Automatically delete nvram and disk files
aux ['integer', 'null'] Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
node_id string Node instance UUID
node_directory string
node_id string Node UUID
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
private_config string Path to the IOS private configuration file
private_config_base64 string Private configuration base64 encoded
project_id string Project UUID
ram integer amount of RAM in MB
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
system_id string system ID
vm_directory string
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file
startup_config_base64 string Startup configuration base64 encoded
status enum Possible values: started, stopped, suspended
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- - - - - + + + + + - - + + - - + + - - - + + + - + - + + - - + + - - + + - + @@ -61,11 +62,11 @@ Output - - - - - + + + + + @@ -78,8 +79,8 @@ Update a Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -94,32 +95,34 @@ Input
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
auto_delete_disks boolean Automatically delete nvram and disk files
aux ['integer', 'null'] Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
node_id string Node instance UUID
node_directory string
node_id string Node UUID
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
private_config string Path to the IOS private configuration file
private_config_base64 string Private configuration base64 encoded
project_id string Project UUID
ram integer amount of RAM in MB
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
system_id string system ID
vm_directory string
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file
startup_config_base64 string Startup configuration base64 encoded
status enum Possible values: started, stopped, suspended
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- - - - - + + + + + - - - - + + + + + - - - + + + - + - - + + - + + - + @@ -128,10 +131,11 @@ Input - - + + + - + @@ -143,35 +147,36 @@ Output
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
auto_delete_disks boolean Automatically delete nvram and disk files
aux integer Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
exec_area integer exec area value
idlemax integer idlemax value
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer Dynamips ID
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config_base64 string private configuration base64 encoded
private_config string Path to the IOS private configuration file.
private_config_base64 string Private configuration base64 encoded
private_config_content string Content of IOS private configuration file
ram integer amount of RAM in MB
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config_base64 string startup configuration base64 encoded
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file.
startup_config_base64 string Startup configuration base64 encoded
startup_config_content string Content of IOS startup configuration file
system_id string system ID
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
- - - - - + + + + + - - + + - - + + - - - + + + - + - + + - - + + - - + + - + @@ -180,11 +185,11 @@ Output - - - - - + + + + + @@ -197,8 +202,8 @@ Delete a Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst index 4d287ad5..a0b54f44 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a Dynamips VM instance Parameters ********** - **adapter_number**: Adapter where the nio should be added +- **node_id**: Node UUID - **port_number**: Port on the adapter -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID 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 +- **node_id**: Node UUID - **port_number**: Port on the adapter -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst index 09a02173..e810e40e 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -10,9 +10,9 @@ Start a packet capture on a Dynamips VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst index 824524ab..f174ec25 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -10,9 +10,9 @@ Stop a packet capture on a Dynamips VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidautoidlepc.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidautoidlepc.rst index 244130d1..81a775f4 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidautoidlepc.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidautoidlepc.rst @@ -7,6 +7,11 @@ GET /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/auto_idle ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Retrieve the idlepc proposals +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + Response status codes ********************** - **200**: Best Idle-pc value found diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigs.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigs.rst index 1c92fad2..09ddcdd1 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigs.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigs.rst @@ -7,6 +7,11 @@ GET /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/configs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Retrieve the startup and private configs content +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + Response status codes ********************** - **200**: Configs retrieved diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigssave.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigssave.rst index f0d0f9e2..be0bba50 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigssave.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidconfigssave.rst @@ -7,6 +7,11 @@ POST /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/configs/ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Save the startup and private configs content +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + Response status codes ********************** - **200**: Configs saved diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeididlepcproposals.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeididlepcproposals.rst index 784ed573..53d61343 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeididlepcproposals.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeididlepcproposals.rst @@ -7,6 +7,11 @@ GET /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/idlepc_pr ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Retrieve the idlepc proposals +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + Response status codes ********************** - **200**: Idle-PCs retrieved diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst index ba00c984..9ae98a06 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst @@ -9,8 +9,8 @@ Reload a Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst index f49cb3ec..d45ede09 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst @@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst index d4b58920..de898325 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst @@ -9,8 +9,8 @@ Start a Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst index 079cb7d1..c9b01c50 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst @@ -9,8 +9,8 @@ Stop a Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst index 4c14bf1a..075f3df6 100644 --- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst @@ -9,8 +9,8 @@ Suspend a Dynamips VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/ethernet_hub.rst b/docs/api/v2/compute/ethernet_hub.rst new file mode 100644 index 00000000..96d2c9e5 --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub.rst @@ -0,0 +1,8 @@ +Ethernet hub +----------------------------- + +.. toctree:: + :glob: + :maxdepth: 2 + + ethernet_hub/* diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodes.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodes.rst new file mode 100644 index 00000000..45e85534 --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodes.rst @@ -0,0 +1,59 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a new Ethernet hub instance + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: Instance created +- **409**: Conflict + +Input +******* +Types ++++++++++ +EthernetHubPort +^^^^^^^^^^^^^^^^^^^^^^ +Ethernet port + +.. raw:: html + +
Name Mandatory Type Description
auto_delete_disks boolean automatically delete nvram and disk files
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
console integer console TCP port
auto_delete_disks boolean Automatically delete nvram and disk files
aux ['integer', 'null'] Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer ID to use with Dynamips
exec_area integer exec area value
idlemax integer idlemax value
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer idlesleep value
image string path to the IOS image
image_md5sum ['string', 'null'] checksum of the IOS image
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string base MAC address
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
node_id string Node instance UUID
node_directory string
node_id string Node UUID
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer amount of NVRAM in KB
platform string platform
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config string path to the IOS private configuration file
private_config_base64 string private configuration base64 encoded
private_config string Path to the IOS private configuration file
private_config_base64 string Private configuration base64 encoded
project_id string Project UUID
ram integer amount of RAM in MB
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean sparse memory feature
startup_config string path to the IOS startup configuration file
startup_config_base64 string startup configuration base64 encoded
system_id string system ID
vm_directory string
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file
startup_config_base64 string Startup configuration base64 encoded
status enum Possible values: started, stopped, suspended
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0
+ + + +
Name Mandatory Type Description
name string Port name
port_number integer Port number
+ +Body ++++++++++ +.. raw:: html + + + + + + +
Name Mandatory Type Description
name string Ethernet hub name
node_id Node UUID
ports array
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet hub name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeid.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeid.rst new file mode 100644 index 00000000..b47b6e7f --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeid.rst @@ -0,0 +1,108 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id} +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get an Ethernet hub instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Success +- **400**: Invalid request +- **404**: Instance doesn't exist + +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet hub name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +PUT /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Update an Ethernet hub instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Instance updated +- **400**: Invalid request +- **404**: Instance doesn't exist +- **409**: Conflict + +Input +******* +Types ++++++++++ +EthernetHubPort +^^^^^^^^^^^^^^^^^^^^^^ +Ethernet port + +.. raw:: html + + + + + +
Name Mandatory Type Description
name string Port name
port_number integer Port number
+ +Body ++++++++++ +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet hub name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet hub name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +DELETE /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete an Ethernet hub instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance deleted + diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst new file mode 100644 index 00000000..4c27e195 --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -0,0 +1,40 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Add a NIO to an Ethernet hub instance + +Parameters +********** +- **adapter_number**: Adapter on the hub (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the hub +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: NIO created +- **404**: Instance doesn't exist + + +DELETE /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Remove a NIO from an Ethernet hub instance + +Parameters +********** +- **adapter_number**: Adapter on the hub (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the hub +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: NIO deleted + diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst new file mode 100644 index 00000000..b38b67cf --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -0,0 +1,32 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a packet capture on an Ethernet hub instance + +Parameters +********** +- **adapter_number**: Adapter on the hub (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the hub +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Capture started +- **400**: Invalid request +- **404**: Instance doesn't exist + +Input +******* +.. raw:: html + + + + + +
Name Mandatory Type Description
capture_file_name string Capture file name
data_link_type enum Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC
+ diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst new file mode 100644 index 00000000..b736f453 --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -0,0 +1,22 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a packet capture on an Ethernet hub instance + +Parameters +********** +- **adapter_number**: Adapter on the hub (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the hub +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Capture stopped + diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstart.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstart.rst new file mode 100644 index 00000000..275d9a62 --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstart.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/start +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start an Ethernet hub + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance started + diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstop.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstop.rst new file mode 100644 index 00000000..7a98a5dc --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstop.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/stop +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop an Ethernet hub + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance stopped + diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidsuspend.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidsuspend.rst new file mode 100644 index 00000000..1ee67e63 --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidsuspend.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/suspend +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/suspend +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Suspend an Ethernet hub + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance suspended + diff --git a/docs/api/v2/compute/ethernet_switch.rst b/docs/api/v2/compute/ethernet_switch.rst new file mode 100644 index 00000000..7f842b8b --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch.rst @@ -0,0 +1,8 @@ +Ethernet switch +----------------------------- + +.. toctree:: + :glob: + :maxdepth: 2 + + ethernet_switch/* diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodes.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodes.rst new file mode 100644 index 00000000..63dc039a --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodes.rst @@ -0,0 +1,62 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a new Ethernet switch instance + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: Instance created +- **409**: Conflict + +Input +******* +Types ++++++++++ +EthernetSwitchPort +^^^^^^^^^^^^^^^^^^^^^^ +Ethernet port + +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
ethertype enum Possible values: null, 0x8100, 0x88A8, 0x9100, 0x9200
name string Port name
port_number integer Port number
type enum Possible values: access, dot1q, qinq
vlan integer VLAN number
+ +Body ++++++++++ +.. raw:: html + + + + + + +
Name Mandatory Type Description
name string Ethernet switch name
node_id Node UUID
ports array
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet switch name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst new file mode 100644 index 00000000..d47bf391 --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst @@ -0,0 +1,111 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id} +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get an Ethernet switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Success +- **400**: Invalid request +- **404**: Instance doesn't exist + +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet switch name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +PUT /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Update an Ethernet switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Instance updated +- **400**: Invalid request +- **404**: Instance doesn't exist +- **409**: Conflict + +Input +******* +Types ++++++++++ +EthernetSwitchPort +^^^^^^^^^^^^^^^^^^^^^^ +Ethernet port + +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
ethertype enum Possible values: null, 0x8100, 0x88A8, 0x9100, 0x9200
name string Port name
port_number integer Port number
type enum Possible values: access, dot1q, qinq
vlan integer VLAN number
+ +Body ++++++++++ +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet switch name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
name string Ethernet switch name
node_id string Node UUID
ports array
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +DELETE /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete an Ethernet switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance deleted + diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst new file mode 100644 index 00000000..c65883ef --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -0,0 +1,40 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Add a NIO to an Ethernet switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: NIO created +- **404**: Instance doesn't exist + + +DELETE /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Remove a NIO from an Ethernet switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: NIO deleted + diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst new file mode 100644 index 00000000..d39394b9 --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -0,0 +1,32 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a packet capture on an Ethernet switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Capture started +- **400**: Invalid request +- **404**: Instance doesn't exist + +Input +******* +.. raw:: html + + + + + +
Name Mandatory Type Description
capture_file_name string Capture file name
data_link_type enum Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC
+ diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst new file mode 100644 index 00000000..aac278cc --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -0,0 +1,22 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a packet capture on an Ethernet switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Capture stopped + diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstart.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstart.rst new file mode 100644 index 00000000..a3d3d51d --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstart.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/start +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start an Ethernet switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance started + diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstop.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstop.rst new file mode 100644 index 00000000..a5b5e5ec --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstop.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/stop +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop an Ethernet switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance stopped + diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidsuspend.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidsuspend.rst new file mode 100644 index 00000000..89755223 --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidsuspend.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/suspend +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/suspend +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Suspend an Ethernet switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance suspended + diff --git a/docs/api/v2/compute/frame_relay_switch.rst b/docs/api/v2/compute/frame_relay_switch.rst new file mode 100644 index 00000000..e9be48bd --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch.rst @@ -0,0 +1,8 @@ +Frame relay switch +----------------------------- + +.. toctree:: + :glob: + :maxdepth: 2 + + frame_relay_switch/* diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodes.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodes.rst new file mode 100644 index 00000000..49c5b291 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodes.rst @@ -0,0 +1,43 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a new Frame Relay switch instance + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: Instance created +- **409**: Conflict + +Input +******* +.. raw:: html + + + + + + +
Name Mandatory Type Description
mappings object Frame Relay mappings
name string Frame Relay switch name
node_id Node UUID
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object Frame Relay mappings
name string Frame Relay switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeid.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeid.rst new file mode 100644 index 00000000..245dce77 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeid.rst @@ -0,0 +1,92 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id} +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get a Frame Relay switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Success +- **400**: Invalid request +- **404**: Instance doesn't exist + +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object Frame Relay mappings
name string Frame Relay switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +PUT /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Update a Frame Relay switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Instance updated +- **400**: Invalid request +- **404**: Instance doesn't exist +- **409**: Conflict + +Input +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object Frame Relay mappings
name string Frame Relay switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ +Output +******* +.. raw:: html + + + + + + + + +
Name Mandatory Type Description
mappings object Frame Relay mappings
name string Frame Relay switch name
node_id string Node UUID
project_id string Project UUID
status enum Possible values: started, stopped, suspended
+ + +DELETE /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete a Frame Relay switch instance + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance deleted + diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst new file mode 100644 index 00000000..2dc1f8a5 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -0,0 +1,40 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Add a NIO to a Frame Relay switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **201**: NIO created +- **404**: Instance doesn't exist + + +DELETE /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Remove a NIO from a Frame Relay switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: NIO deleted + diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst new file mode 100644 index 00000000..ca6bf402 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -0,0 +1,32 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a packet capture on a Frame Relay switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: Capture started +- **400**: Invalid request +- **404**: Instance doesn't exist + +Input +******* +.. raw:: html + + + + + +
Name Mandatory Type Description
capture_file_name string Capture file name
data_link_type enum Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC
+ diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst new file mode 100644 index 00000000..54f34581 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -0,0 +1,22 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a packet capture on a Frame Relay switch instance + +Parameters +********** +- **adapter_number**: Adapter on the switch (always 0) +- **node_id**: Node UUID +- **port_number**: Port on the switch +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Capture stopped + diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstart.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstart.rst new file mode 100644 index 00000000..89a7a3c9 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstart.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/start +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start a Frame Relay switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance started + diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstop.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstop.rst new file mode 100644 index 00000000..9d6e3273 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstop.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/stop +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop a Frame Relay switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance stopped + diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidsuspend.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidsuspend.rst new file mode 100644 index 00000000..aae9bc87 --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidsuspend.rst @@ -0,0 +1,20 @@ +/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/suspend +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/suspend +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Suspend a Frame Relay switch + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance suspended + diff --git a/docs/api/v2/compute/iou/iounodes.rst b/docs/api/v2/compute/iou/iouimages.rst similarity index 69% rename from docs/api/v2/compute/iou/iounodes.rst rename to docs/api/v2/compute/iou/iouimages.rst index 0720e180..95456098 100644 --- a/docs/api/v2/compute/iou/iounodes.rst +++ b/docs/api/v2/compute/iou/iouimages.rst @@ -1,19 +1,19 @@ -/v2/compute/iou/nodes +/v2/compute/iou/images ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -GET /v2/compute/iou/nodes +GET /v2/compute/iou/images ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve the list of IOU VMS +Retrieve the list of IOU images Response status codes ********************** -- **200**: List of IOU VM retrieved +- **200**: List of IOU images Sample session *************** -.. literalinclude:: ../../../examples/compute_get_iounodes.txt +.. literalinclude:: ../../../examples/compute_get_iouimages.txt diff --git a/docs/api/v2/compute/dynamips_vm/dynamipsnodespath.rst b/docs/api/v2/compute/iou/iouimagesfilename.rst similarity index 71% rename from docs/api/v2/compute/dynamips_vm/dynamipsnodespath.rst rename to docs/api/v2/compute/iou/iouimagesfilename.rst index cd728c62..a1929428 100644 --- a/docs/api/v2/compute/dynamips_vm/dynamipsnodespath.rst +++ b/docs/api/v2/compute/iou/iouimagesfilename.rst @@ -1,11 +1,15 @@ -/v2/compute/dynamips/nodes/{path} +/v2/compute/iou/images/{filename:.+} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -POST /v2/compute/dynamips/nodes/**{path}** +POST /v2/compute/iou/images/**{filename:.+}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upload Dynamips image +Upload an IOU image + +Parameters +********** +- **filename**: Image filename Response status codes ********************** diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodes.rst b/docs/api/v2/compute/iou/projectsprojectidiounodes.rst index c7fc7720..7445d90d 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodes.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodes.rst @@ -9,7 +9,7 @@ Create a new IOU instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -23,13 +23,13 @@ Input - + - + @@ -48,12 +48,14 @@ Output
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
console ['integer', 'null'] Console TCP port
ethernet_adapters integer How many ethernet adapters are connected to the IOU
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
l1_keepalives ['boolean', 'null'] Always up ethernet interface
md5sum ['string', 'null'] Checksum of iou binary
name string IOU VM name
node_id IOU VM identifier
node_id Node UUID
nvram ['integer', 'null'] Allocated NVRAM KB
path string Path of iou binary
private_config ['string', 'null'] Path to the private-config of IOU
- + + + @@ -62,8 +64,8 @@ Output + -
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
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
node_directory string Path to the node working directory
node_id string IOU VM UUID
nvram integer Allocated NVRAM KB
path string Path of iou binary
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
status enum Possible values: started, stopped, suspended
use_default_iou_values ['boolean', 'null'] Use default IOU values
vm_directory string
Sample session diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst index 8391a05f..2e331edb 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst @@ -5,12 +5,12 @@ GET /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a IOU instance +Get an IOU instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -25,12 +25,14 @@ Output - + + + @@ -39,8 +41,8 @@ Output + -
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
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
node_directory string Path to the node working directory
node_id string IOU VM UUID
nvram integer Allocated NVRAM KB
path string Path of iou binary
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
status enum Possible values: started, stopped, suspended
use_default_iou_values ['boolean', 'null'] Use default IOU values
vm_directory string
Sample session @@ -52,12 +54,12 @@ Sample session PUT /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Update a IOU instance +Update an IOU instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -72,7 +74,7 @@ Input - + @@ -80,9 +82,11 @@ Input + +
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
console ['integer', 'null'] Console TCP port
ethernet_adapters ['integer', 'null'] How many ethernet adapters are connected to the IOU
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
l1_keepalives ['boolean', 'null'] Always up ethernet interface
name ['string', 'null'] IOU VM name
nvram ['integer', 'null'] Allocated NVRAM KB
path ['string', 'null'] Path of iou binary
private_config ['string', 'null'] Path to the private-config of IOU
private_config_content ['string', 'null'] Private-config of IOU
ram ['integer', 'null'] Allocated RAM MB
serial_adapters ['integer', 'null'] How many serial adapters are connected to the IOU
startup_config ['string', 'null'] Path to the startup-config of IOU
startup_config_content ['string', 'null'] Startup-config of IOU
use_default_iou_values ['boolean', 'null'] Use default IOU values
@@ -94,12 +98,14 @@ Output - + + + @@ -108,8 +114,8 @@ Output + -
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
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
node_directory string Path to the node working directory
node_id string IOU VM UUID
nvram integer Allocated NVRAM KB
path string Path of iou binary
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
status enum Possible values: started, stopped, suspended
use_default_iou_values ['boolean', 'null'] Use default IOU values
vm_directory string
Sample session @@ -121,12 +127,12 @@ Sample session DELETE /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete a IOU instance +Delete an IOU instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst index 46c0b46f..2d05d5b9 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a IOU instance Parameters ********** - **adapter_number**: Network adapter where the nio is located +- **node_id**: Node UUID - **port_number**: Port where the nio should be added -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -34,9 +34,9 @@ Remove a NIO from a IOU instance Parameters ********** - **adapter_number**: Network adapter where the nio is located +- **node_id**: Node UUID - **port_number**: Port from where the nio should be removed -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst index ea223b51..9cf61f32 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -5,14 +5,14 @@ POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a packet capture on a IOU VM instance +Start a packet capture on an IOU VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst index 9bbf4ce0..ca1fd52f 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -5,14 +5,14 @@ POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a packet capture on a IOU VM instance +Stop a packet capture on an IOU VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigs.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigs.rst index 0c299468..3fb62188 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigs.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigs.rst @@ -7,6 +7,11 @@ GET /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/configs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Retrieve the startup and private configs content +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + Response status codes ********************** - **200**: Configs retrieved diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigssave.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigssave.rst index 60378bd6..8af1013b 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigssave.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidconfigssave.rst @@ -7,6 +7,11 @@ POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/configs/save ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Save the startup and private configs content +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + Response status codes ********************** - **200**: Configs saved diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidreload.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidreload.rst index ae5daca6..86ada843 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidreload.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidreload.rst @@ -5,12 +5,12 @@ POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/reload ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reload a IOU instance +Reload an IOU instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstart.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstart.rst index 1f4c949a..ce771822 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstart.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstart.rst @@ -5,12 +5,12 @@ POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/start ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a IOU instance +Start an IOU instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -34,12 +34,14 @@ Output - + + + @@ -48,8 +50,8 @@ Output + -
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
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
node_directory string Path to the node working directory
node_id string IOU VM UUID
nvram integer Allocated NVRAM KB
path string Path of iou binary
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
status enum Possible values: started, stopped, suspended
use_default_iou_values ['boolean', 'null'] Use default IOU values
vm_directory string
Sample session diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstop.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstop.rst index dc14c40a..e1df8aa9 100644 --- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstop.rst +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstop.rst @@ -5,12 +5,12 @@ POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/stop ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Stop a IOU instance +Stop an IOU instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/network/projectsprojectidportsudp.rst b/docs/api/v2/compute/network/projectsprojectidportsudp.rst index bbdb019d..ca5f9b03 100644 --- a/docs/api/v2/compute/network/projectsprojectidportsudp.rst +++ b/docs/api/v2/compute/network/projectsprojectidportsudp.rst @@ -9,7 +9,7 @@ Allocate an UDP port on the server Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/notification/notificationsws.rst b/docs/api/v2/compute/notification/notificationsws.rst index e33af507..d288db92 100644 --- a/docs/api/v2/compute/notification/notificationsws.rst +++ b/docs/api/v2/compute/notification/notificationsws.rst @@ -5,7 +5,7 @@ GET /v2/compute/notifications/ws ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Send notifications about what happend using websockets +Send notifications using Websockets Response status codes ********************** diff --git a/docs/api/v2/compute/project/projects.rst b/docs/api/v2/compute/project/projects.rst index c9fc0ff1..61d47962 100644 --- a/docs/api/v2/compute/project/projects.rst +++ b/docs/api/v2/compute/project/projects.rst @@ -5,7 +5,7 @@ GET /v2/compute/projects ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -List projects opened on the server +List all projects opened on the server Response status codes ********************** @@ -25,7 +25,7 @@ Create a new project on the server Response status codes ********************** - **201**: Project created -- **403**: You are not allowed to modify this property +- **403**: Forbidden to create a project - **409**: Project already created Input @@ -37,7 +37,6 @@ Input name ['string', 'null'] Project name path ['string', 'null'] Project directory project_id ['string', 'null'] Project UUID - temporary boolean If project is a temporary project Output @@ -49,7 +48,6 @@ Output name ['string', 'null'] Project name path ['string', 'null'] Project directory project_id ✔ string Project UUID - temporary ✔ boolean If project is a temporary project Sample session diff --git a/docs/api/v2/compute/project/projectsprojectid.rst b/docs/api/v2/compute/project/projectsprojectid.rst index cb6845f1..10b91cab 100644 --- a/docs/api/v2/compute/project/projectsprojectid.rst +++ b/docs/api/v2/compute/project/projectsprojectid.rst @@ -9,7 +9,7 @@ Get project information Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** @@ -25,7 +25,6 @@ Output name ['string', 'null'] Project name path ['string', 'null'] Project directory project_id ✔ string Project UUID - temporary ✔ boolean If project is a temporary project Sample session @@ -41,12 +40,12 @@ Update a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: The project has been updated -- **403**: You are not allowed to modify this property +- **200**: Project updated +- **403**: Forbidden to update this project - **404**: The project doesn't exist Input @@ -57,7 +56,6 @@ Input Name Mandatory Type Description name ['string', 'null'] Project name path ['string', 'null'] Path of the project on the server (work only with --local) - temporary boolean If project is a temporary project Output @@ -69,7 +67,6 @@ Output name ['string', 'null'] Project name path ['string', 'null'] Project directory project_id ✔ string Project UUID - temporary ✔ boolean If project is a temporary project Sample session @@ -85,7 +82,7 @@ Delete a project from disk Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/project/projectsprojectidclose.rst b/docs/api/v2/compute/project/projectsprojectidclose.rst index cacc758d..45c77199 100644 --- a/docs/api/v2/compute/project/projectsprojectidclose.rst +++ b/docs/api/v2/compute/project/projectsprojectidclose.rst @@ -9,12 +9,12 @@ Close a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** - **404**: The project doesn't exist -- **204**: The project has been closed +- **204**: Project closed Sample session *************** diff --git a/docs/api/v2/compute/project/projectsprojectidcommit.rst b/docs/api/v2/compute/project/projectsprojectidcommit.rst index e2d60d61..d2018214 100644 --- a/docs/api/v2/compute/project/projectsprojectidcommit.rst +++ b/docs/api/v2/compute/project/projectsprojectidcommit.rst @@ -9,7 +9,7 @@ Write changes on disk Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/project/projectsprojectidexport.rst b/docs/api/v2/compute/project/projectsprojectidexport.rst index f80c784d..56c3d007 100644 --- a/docs/api/v2/compute/project/projectsprojectidexport.rst +++ b/docs/api/v2/compute/project/projectsprojectidexport.rst @@ -9,10 +9,10 @@ Export a project as a portable archive Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: Return the file +- **200**: File returned - **404**: The project doesn't exist diff --git a/docs/api/v2/compute/project/projectsprojectidfiles.rst b/docs/api/v2/compute/project/projectsprojectidfiles.rst index 9f48cdb5..5d425d20 100644 --- a/docs/api/v2/compute/project/projectsprojectidfiles.rst +++ b/docs/api/v2/compute/project/projectsprojectidfiles.rst @@ -9,10 +9,10 @@ List files of a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: Return list of files +- **200**: Return a list of files - **404**: The project doesn't exist diff --git a/docs/api/v2/compute/project/projectsprojectidfilespath.rst b/docs/api/v2/compute/project/projectsprojectidfilespath.rst index 2d550328..b52d0553 100644 --- a/docs/api/v2/compute/project/projectsprojectidfilespath.rst +++ b/docs/api/v2/compute/project/projectsprojectidfilespath.rst @@ -5,30 +5,30 @@ GET /v2/compute/projects/**{project_id}**/files/**{path:.+}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a file of a project +Get a file from a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: Return the file +- **200**: File returned - **403**: Permission denied - **404**: The file doesn't exist POST /v2/compute/projects/**{project_id}**/files/**{path:.+}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get a file of a project +Write a file to a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: Return the file +- **200**: File returned - **403**: Permission denied - **404**: The path doesn't exist diff --git a/docs/api/v2/compute/project/projectsprojectidimport.rst b/docs/api/v2/compute/project/projectsprojectidimport.rst index 6f6edf92..a83924eb 100644 --- a/docs/api/v2/compute/project/projectsprojectidimport.rst +++ b/docs/api/v2/compute/project/projectsprojectidimport.rst @@ -9,12 +9,12 @@ Import a project from a portable archive Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** - **200**: Project imported -- **403**: You are not allowed to modify this property +- **403**: Forbidden to import project Output ******* @@ -25,6 +25,5 @@ Output name ['string', 'null'] Project name path ['string', 'null'] Project directory project_id ✔ string Project UUID - temporary ✔ boolean If project is a temporary project diff --git a/docs/api/v2/compute/project/projectsprojectidnotifications.rst b/docs/api/v2/compute/project/projectsprojectidnotifications.rst index 56a9a776..e5a3b01f 100644 --- a/docs/api/v2/compute/project/projectsprojectidnotifications.rst +++ b/docs/api/v2/compute/project/projectsprojectidnotifications.rst @@ -5,11 +5,11 @@ GET /v2/compute/projects/**{project_id}**/notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Receive notifications about the projects +Receive notifications about the project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/project/projectsprojectidstreampath.rst b/docs/api/v2/compute/project/projectsprojectidstreampath.rst index f13eea91..edf4cc80 100644 --- a/docs/api/v2/compute/project/projectsprojectidstreampath.rst +++ b/docs/api/v2/compute/project/projectsprojectidstreampath.rst @@ -9,11 +9,11 @@ Stream a file from a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: Return the file +- **200**: File returned - **403**: Permission denied - **404**: The file doesn't exist diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst index 3980df2c..c028493d 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst @@ -9,7 +9,7 @@ Create a new Qemu VM instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -25,14 +25,14 @@ Input Name Mandatory Type Description acpi_shutdown ['boolean', 'null'] ACPI shutdown support adapter_type ['string', 'null'] QEMU adapter type - adapters ['integer', 'null'] number of adapters + adapters ['integer', 'null'] Number of adapters boot_priority enum Possible values: c, d, n, cn, cd cdrom_image string QEMU cdrom image path cdrom_image_md5sum ['string', 'null'] QEMU cdrom image checksum - console ['integer', 'null'] console TCP port + console ['integer', 'null'] Console TCP port console_type enum Possible values: telnet, vnc cpu_throttling ['integer', 'null'] Percentage of CPU allowed for QEMU - cpus ['integer', 'null'] number of vCPUs + 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 @@ -51,15 +51,15 @@ Input kernel_image string QEMU kernel image path kernel_image_md5sum ['string', 'null'] QEMU kernel image checksum legacy_networking ['boolean', 'null'] Use QEMU legagy networking commands (-net syntax) - linked_clone boolean either the VM is a linked clone or not + linked_clone boolean Whether the VM is a linked clone or not mac_address ['string', 'null'] QEMU MAC address name ✔ string QEMU VM instance name - node_id QEMU VM identifier + node_id Node UUID options ['string', 'null'] Additional QEMU options platform enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null process_priority enum Possible values: realtime, very high, high, normal, low, very low, null qemu_path ['string', 'null'] Path to QEMU - ram ['integer', 'null'] amount of RAM in MB + ram ['integer', 'null'] Amount of RAM in MB usage string How to use the qemu VM @@ -71,15 +71,15 @@ Output Name Mandatory Type Description acpi_shutdown ✔ boolean ACPI shutdown support adapter_type ✔ string QEMU adapter type - adapters ✔ integer number of adapters + 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 ✔ 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 + 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 @@ -100,15 +100,16 @@ Output legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax) mac_address ✔ string QEMU MAC address name ✔ string QEMU VM instance name - node_id ✔ string QEMU VM uuid + node_directory ✔ string + node_id ✔ string Node UUID 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 + project_id ✔ string Project UUID + qemu_path ✔ string Path to QEMU + ram ✔ integer Amount of RAM in MB + status ✔ enum Possible values: started, stopped, suspended + usage ✔ string How to use the QEMU VM Sample session diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst index 1e12ac06..10e2b4df 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst @@ -9,8 +9,8 @@ Get a Qemu VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -26,15 +26,15 @@ Output Name Mandatory Type Description acpi_shutdown ✔ boolean ACPI shutdown support adapter_type ✔ string QEMU adapter type - adapters ✔ integer number of adapters + 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 ✔ 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 + 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 @@ -55,15 +55,16 @@ Output legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax) mac_address ✔ string QEMU MAC address name ✔ string QEMU VM instance name - node_id ✔ string QEMU VM uuid + node_directory ✔ string + node_id ✔ string Node UUID 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 + project_id ✔ string Project UUID + qemu_path ✔ string Path to QEMU + ram ✔ integer Amount of RAM in MB + status ✔ enum Possible values: started, stopped, suspended + usage ✔ string How to use the QEMU VM Sample session @@ -79,8 +80,8 @@ Update a Qemu VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -97,14 +98,14 @@ Input Name Mandatory Type Description acpi_shutdown ['boolean', 'null'] ACPI shutdown support adapter_type ['string', 'null'] QEMU adapter type - adapters ['integer', 'null'] number of adapters + adapters ['integer', 'null'] Number of adapters boot_priority enum Possible values: c, d, n, cn, cd cdrom_image string QEMU cdrom image path cdrom_image_md5sum ['string', 'null'] QEMU cdrom image checksum - console ['integer', 'null'] console TCP port + console ['integer', 'null'] Console TCP port console_type enum Possible values: telnet, vnc cpu_throttling ['integer', 'null'] Percentage of CPU allowed for QEMU - cpus ['integer', 'null'] number of vCPUs + 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 @@ -129,8 +130,8 @@ Input platform enum Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null process_priority enum Possible values: realtime, very high, high, normal, low, very low, null qemu_path ['string', 'null'] Path to QEMU - ram ['integer', 'null'] amount of RAM in MB - usage string How to use the qemu VM + ram ['integer', 'null'] Amount of RAM in MB + usage string How to use the QEMU VM Output @@ -141,15 +142,15 @@ Output Name Mandatory Type Description acpi_shutdown ✔ boolean ACPI shutdown support adapter_type ✔ string QEMU adapter type - adapters ✔ integer number of adapters + 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 ✔ 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 + 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 @@ -170,15 +171,16 @@ Output legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax) mac_address ✔ string QEMU MAC address name ✔ string QEMU VM instance name - node_id ✔ string QEMU VM uuid + node_directory ✔ string + node_id ✔ string Node UUID 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 + project_id ✔ string Project UUID + qemu_path ✔ string Path to QEMU + ram ✔ integer Amount of RAM in MB + status ✔ enum Possible values: started, stopped, suspended + usage ✔ string How to use the QEMU VM Sample session @@ -194,8 +196,8 @@ Delete a Qemu VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst index 2ca19eb0..fa44f1b5 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a Qemu VM instance Parameters ********** - **adapter_number**: Network adapter where the nio is located +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -34,9 +34,9 @@ Remove a NIO from a Qemu VM instance Parameters ********** - **adapter_number**: Network adapter where the nio is located +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst index a2f76591..dff97a96 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst @@ -9,8 +9,8 @@ Reload a Qemu VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst index 64ac995b..b19656e5 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst @@ -9,8 +9,8 @@ Resume a Qemu VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst index 3b22e6e1..1cf2ac05 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst @@ -9,8 +9,8 @@ Start a Qemu VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -26,15 +26,15 @@ Output Name Mandatory Type Description acpi_shutdown ✔ boolean ACPI shutdown support adapter_type ✔ string QEMU adapter type - adapters ✔ integer number of adapters + 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 ✔ 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 + 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 @@ -55,15 +55,16 @@ Output legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax) mac_address ✔ string QEMU MAC address name ✔ string QEMU VM instance name - node_id ✔ string QEMU VM uuid + node_directory ✔ string + node_id ✔ string Node UUID 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 + project_id ✔ string Project UUID + qemu_path ✔ string Path to QEMU + ram ✔ integer Amount of RAM in MB + status ✔ enum Possible values: started, stopped, suspended + usage ✔ string How to use the QEMU VM Sample session diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst index 2a8089c2..bcd612d6 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst @@ -9,8 +9,8 @@ Stop a Qemu VM instance Parameters ********** -- **vm_node**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst index 5c58bad8..306e3189 100644 --- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst @@ -9,8 +9,8 @@ Suspend a Qemu VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/qemu/qemubinaries.rst b/docs/api/v2/compute/qemu/qemubinaries.rst index 702b89f0..f1a4173b 100644 --- a/docs/api/v2/compute/qemu/qemubinaries.rst +++ b/docs/api/v2/compute/qemu/qemubinaries.rst @@ -19,7 +19,7 @@ Input - +
Name Mandatory Type Description
archs array Architectures to filter binaries by
archs array Architectures to filter binaries with
Sample session diff --git a/docs/api/v2/compute/qemu/qemunodes.rst b/docs/api/v2/compute/qemu/qemuimages.rst similarity index 81% rename from docs/api/v2/compute/qemu/qemunodes.rst rename to docs/api/v2/compute/qemu/qemuimages.rst index 2294f456..a3751fb4 100644 --- a/docs/api/v2/compute/qemu/qemunodes.rst +++ b/docs/api/v2/compute/qemu/qemuimages.rst @@ -1,13 +1,13 @@ -/v2/compute/qemu/nodes +/v2/compute/qemu/images ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -GET /v2/compute/qemu/nodes +GET /v2/compute/qemu/images ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Retrieve the list of Qemu images Response status codes ********************** -- **200**: List of Qemu images retrieved +- **200**: List of Qemu images diff --git a/docs/api/v2/compute/qemu/qemunodespath.rst b/docs/api/v2/compute/qemu/qemuimagesfilename.rst similarity index 71% rename from docs/api/v2/compute/qemu/qemunodespath.rst rename to docs/api/v2/compute/qemu/qemuimagesfilename.rst index 5f54423e..5a401de8 100644 --- a/docs/api/v2/compute/qemu/qemunodespath.rst +++ b/docs/api/v2/compute/qemu/qemuimagesfilename.rst @@ -1,11 +1,15 @@ -/v2/compute/qemu/nodes/{path:.+} +/v2/compute/qemu/images/{filename:.+} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -POST /v2/compute/qemu/nodes/**{path:.+}** +POST /v2/compute/qemu/images/**{filename:.+}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upload Qemu image. +Upload Qemu image + +Parameters +********** +- **filename**: Image filename Response status codes ********************** diff --git a/docs/api/v2/compute/qemu/qemuimg.rst b/docs/api/v2/compute/qemu/qemuimg.rst index cc7644ff..b64f4d8d 100644 --- a/docs/api/v2/compute/qemu/qemuimg.rst +++ b/docs/api/v2/compute/qemu/qemuimg.rst @@ -25,7 +25,7 @@ Input preallocation enum Possible values: off, metadata, falloc, full qemu_img ✔ string Path to the qemu-img binary refcount_bits integer - size ✔ integer Image size in M + size ✔ integer Image size in Megabytes static enum Possible values: on, off subformat enum Possible values: dynamic, fixed, streamOptimized, twoGbMaxExtentSparse, twoGbMaxExtentFlat, monolithicSparse, monolithicFlat zeroed_grain enum Possible values: on, off diff --git a/docs/api/v2/compute/version/version.rst b/docs/api/v2/compute/version/version.rst index 92d4113a..20bc2811 100644 --- a/docs/api/v2/compute/version/version.rst +++ b/docs/api/v2/compute/version/version.rst @@ -17,8 +17,8 @@ Output - - + +
Name Mandatory Type Description
local boolean Either this is a local server
version string Version number human readable
local boolean Whether this is a local server or not
version string Version number
Sample session @@ -43,8 +43,8 @@ Input - - + +
Name Mandatory Type Description
local boolean Either this is a local server
version string Version number human readable
local boolean Whether this is a local server or not
version string Version number
Output @@ -53,8 +53,8 @@ Output - - + +
Name Mandatory Type Description
local boolean Either this is a local server
version string Version number human readable
local boolean Whether this is a local server or not
version string Version number
Sample session diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodes.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodes.rst index 9c5e5059..b1c08b17 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodes.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodes.rst @@ -9,7 +9,7 @@ Create a new VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -25,15 +25,15 @@ Input Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VirtualBox adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode - linked_clone ✔ boolean either the VM is a linked clone or not + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode + linked_clone ✔ boolean Whether the VM is a linked clone or not name ✔ string VirtualBox VM instance name - node_id VirtualBox VM instance identifier + node_id Node UUID ram integer Amount of RAM - use_any_adapter boolean allow GNS3 to use any VirtualBox adapter + use_any_adapter boolean Allow GNS3 to use any VirtualBox adapter vmname ✔ string VirtualBox VM name (in VirtualBox itself) @@ -45,16 +45,17 @@ Output Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VirtualBox adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name ✔ string VirtualBox VM instance name - node_id ✔ string VirtualBox VM instance UUID + node_directory ✔ ['string', 'null'] + node_id ✔ string Node UUID project_id ✔ string Project UUID ram integer Amount of RAM - use_any_adapter boolean allow GNS3 to use any VirtualBox adapter - vm_directory ✔ ['string', 'null'] + status enum Possible values: started, stopped, suspended + use_any_adapter boolean Allow GNS3 to use any VirtualBox adapter vmname string VirtualBox VM name (in VirtualBox itself) diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeid.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeid.rst index 7ba5c008..87692080 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeid.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeid.rst @@ -9,8 +9,8 @@ Get a VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -26,16 +26,17 @@ Output Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VirtualBox adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name ✔ string VirtualBox VM instance name - node_id ✔ string VirtualBox VM instance UUID + node_directory ✔ ['string', 'null'] + node_id ✔ string Node UUID project_id ✔ string Project UUID ram integer Amount of RAM - use_any_adapter boolean allow GNS3 to use any VirtualBox adapter - vm_directory ✔ ['string', 'null'] + status enum Possible values: started, stopped, suspended + use_any_adapter boolean Allow GNS3 to use any VirtualBox adapter vmname string VirtualBox VM name (in VirtualBox itself) @@ -52,8 +53,8 @@ Update a VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -70,13 +71,13 @@ Input Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VirtualBox adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name string VirtualBox VM instance name ram integer Amount of RAM - use_any_adapter boolean allow GNS3 to use any VirtualBox adapter + use_any_adapter boolean Allow GNS3 to use any VirtualBox adapter vmname string VirtualBox VM name (in VirtualBox itself) @@ -88,16 +89,17 @@ Output Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VirtualBox adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name ✔ string VirtualBox VM instance name - node_id ✔ string VirtualBox VM instance UUID + node_directory ✔ ['string', 'null'] + node_id ✔ string Node UUID project_id ✔ string Project UUID ram integer Amount of RAM - use_any_adapter boolean allow GNS3 to use any VirtualBox adapter - vm_directory ✔ ['string', 'null'] + status enum Possible values: started, stopped, suspended + use_any_adapter boolean Allow GNS3 to use any VirtualBox adapter vmname string VirtualBox VM name (in VirtualBox itself) @@ -114,8 +116,8 @@ Delete a VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst index 8f89e19d..dab4ee14 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter where the nio should be added +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -34,9 +34,9 @@ Remove a NIO from a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter from where the nio should be removed +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst index 3341b722..4beeb50b 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -10,9 +10,9 @@ Start a packet capture on a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst index b288ceaa..8bb24f7b 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -10,9 +10,9 @@ Stop a packet capture on a VirtualBox VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidreload.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidreload.rst index c0239245..ba593e10 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidreload.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidreload.rst @@ -9,8 +9,8 @@ Reload a VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidresume.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidresume.rst index 724aba37..50e1bba3 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidresume.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidresume.rst @@ -9,8 +9,8 @@ Resume a suspended VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstart.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstart.rst index 81cc62e0..62ead042 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstart.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstart.rst @@ -9,8 +9,8 @@ Start a VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst index 15b80a6f..202424dc 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst @@ -9,8 +9,8 @@ Stop a VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidsuspend.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidsuspend.rst index 93a5b026..e1dad875 100644 --- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidsuspend.rst +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidsuspend.rst @@ -9,8 +9,8 @@ Suspend a VirtualBox VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodes.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodes.rst index b9a468e8..788f1919 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodes.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodes.rst @@ -9,7 +9,7 @@ Create a new VMware VM instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -25,16 +25,15 @@ Input Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VMware adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode - linked_clone ✔ boolean either the VM is a linked clone or not + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode + linked_clone ✔ boolean Whether the VM is a linked clone or not name ✔ string VMware VM instance name - node_id string VMware VM instance identifier - use_any_adapter boolean allow GNS3 to use any VMware adapter - use_ubridge boolean use uBridge for network connections - vmx_path ✔ string path to the vmx file + node_id string Node UUID + use_any_adapter boolean Allow GNS3 to use any VMware adapter + vmx_path ✔ string Path to the vmx file Output @@ -45,16 +44,16 @@ Output Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VMware adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name ✔ string VMware VM instance name - node_id ✔ string VMware VM instance UUID + node_directory ['string', 'null'] + node_id ✔ string Node UUID project_id ✔ string Project UUID - use_any_adapter boolean allow GNS3 to use any VMware adapter - use_ubridge boolean use uBridge for network connections - vm_directory ['string', 'null'] - vmx_path string path to the vmx file + status enum Possible values: started, stopped, suspended + use_any_adapter boolean Allow GNS3 to use any VMware adapter + vmx_path string Path to the vmx file diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeid.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeid.rst index 1da401fd..6c1fbcbf 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeid.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeid.rst @@ -9,8 +9,8 @@ Get a VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -26,17 +26,17 @@ Output Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VMware adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name ✔ string VMware VM instance name - node_id ✔ string VMware VM instance UUID + node_directory ['string', 'null'] + node_id ✔ string Node UUID project_id ✔ string Project UUID - use_any_adapter boolean allow GNS3 to use any VMware adapter - use_ubridge boolean use uBridge for network connections - vm_directory ['string', 'null'] - vmx_path string path to the vmx file + status enum Possible values: started, stopped, suspended + use_any_adapter boolean Allow GNS3 to use any VMware adapter + vmx_path string Path to the vmx file @@ -46,8 +46,8 @@ Update a VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -64,14 +64,13 @@ Input Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VMware adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name string VMware VM instance name - use_any_adapter boolean allow GNS3 to use any VMware adapter - use_ubridge boolean use uBridge for network connections - vmx_path string path to the vmx file + use_any_adapter boolean Allow GNS3 to use any VMware adapter + vmx_path string Path to the vmx file Output @@ -82,17 +81,17 @@ Output Name Mandatory Type Description acpi_shutdown boolean ACPI shutdown adapter_type string VMware adapter type - adapters integer number of adapters - console integer console TCP port - enable_remote_console boolean enable the remote console - headless boolean headless mode + adapters integer Number of adapters + console integer Console TCP port + enable_remote_console boolean Enable the remote console + headless boolean Headless mode name ✔ string VMware VM instance name - node_id ✔ string VMware VM instance UUID + node_directory ['string', 'null'] + node_id ✔ string Node UUID project_id ✔ string Project UUID - use_any_adapter boolean allow GNS3 to use any VMware adapter - use_ubridge boolean use uBridge for network connections - vm_directory ['string', 'null'] - vmx_path string path to the vmx file + status enum Possible values: started, stopped, suspended + use_any_adapter boolean Allow GNS3 to use any VMware adapter + vmx_path string Path to the vmx file @@ -102,8 +101,8 @@ Delete a VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst index 45ec9780..0170f22a 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a VMware VM instance Parameters ********** - **adapter_number**: Adapter where the nio should be added +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID 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 +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst index 530fa344..8ae38290 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -10,9 +10,9 @@ Start a packet capture on a VMware VM instance Parameters ********** - **adapter_number**: Adapter to start a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst index 361cc6ab..5d6c4023 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -10,9 +10,9 @@ Stop a packet capture on a VMware VM instance Parameters ********** - **adapter_number**: Adapter to stop a packet capture +- **node_id**: Node UUID - **port_number**: Port on the adapter (always 0) -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidinterfacesvmnet.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidinterfacesvmnet.rst index cfe95e7c..16913e56 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidinterfacesvmnet.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidinterfacesvmnet.rst @@ -9,8 +9,8 @@ Allocate a VMware VMnet interface on the server Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: The UUID of the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidreload.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidreload.rst index 4d6ed20f..d63d89d9 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidreload.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidreload.rst @@ -9,8 +9,8 @@ Reload a VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidresume.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidresume.rst index a84ccfba..84d21d6c 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidresume.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidresume.rst @@ -9,8 +9,8 @@ Resume a suspended VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstart.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstart.rst index 895bc749..3240f8da 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstart.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstart.rst @@ -9,8 +9,8 @@ Start a VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstop.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstop.rst index b269c36c..a260c0c8 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstop.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstop.rst @@ -9,8 +9,8 @@ Stop a VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidsuspend.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidsuspend.rst index 8970d4dc..b2306c74 100644 --- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidsuspend.rst +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidsuspend.rst @@ -9,8 +9,8 @@ Suspend a VMware VM instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodes.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodes.rst index 38355b1e..892e8aee 100644 --- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodes.rst +++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodes.rst @@ -9,7 +9,7 @@ Create a new VPCS instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -23,10 +23,10 @@ Input - + - +
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
console ['integer', 'null'] Console TCP port
console_type enum Possible values: telnet
name string VPCS VM name
node_id VPCS VM identifier
node_id Node UUID
startup_script ['string', 'null'] Content of the VPCS startup script
@@ -37,15 +37,15 @@ Output - + - + + - - +
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
name string VPCS VM name
node_id string VPCS VM UUID
node_directory string
node_id string Node UUID
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
status enum Possible values: started, stopped, suspended
Sample session diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeid.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeid.rst index 57f70537..641002f8 100644 --- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeid.rst +++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeid.rst @@ -9,8 +9,8 @@ Get a VPCS instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -25,15 +25,15 @@ Output - + - + + - - +
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
name string VPCS VM name
node_id string VPCS VM UUID
node_directory string
node_id string Node UUID
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
status enum Possible values: started, stopped, suspended
Sample session @@ -49,8 +49,8 @@ Update a VPCS instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -65,7 +65,7 @@ Input - + @@ -79,15 +79,15 @@ Output
Name Mandatory Type Description
console ['integer', 'null'] console TCP port
console ['integer', 'null'] Console TCP port
console_type enum Possible values: telnet
name ['string', 'null'] VPCS VM name
startup_script ['string', 'null'] Content of the VPCS startup script
- + - + + - - +
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
name string VPCS VM name
node_id string VPCS VM UUID
node_directory string
node_id string Node UUID
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
status enum Possible values: started, stopped, suspended
Sample session @@ -103,8 +103,8 @@ Delete a VPCS instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst index 3648e4e5..cd2cb34f 100644 --- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst @@ -10,9 +10,9 @@ Add a NIO to a VPCS instance Parameters ********** - **adapter_number**: Network adapter where the nio is located +- **node_id**: Node UUID - **port_number**: Port where the nio should be added -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -34,9 +34,9 @@ Remove a NIO from a VPCS instance Parameters ********** - **adapter_number**: Network adapter where the nio is located +- **node_id**: Node UUID - **port_number**: Port from where the nio should be removed -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidreload.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidreload.rst index e3411bb5..e3cc4ec9 100644 --- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidreload.rst +++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidreload.rst @@ -9,8 +9,8 @@ Reload a VPCS instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstart.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstart.rst index 0c604f86..6f438a4f 100644 --- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstart.rst +++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstart.rst @@ -9,8 +9,8 @@ Start a VPCS instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** @@ -25,15 +25,15 @@ Output - + - + + - - +
Name Mandatory Type Description
command_line string Last command line used by GNS3 to start QEMU
console integer console TCP port
console integer Console TCP port
console_type enum Possible values: telnet
name string VPCS VM name
node_id string VPCS VM UUID
node_directory string
node_id string Node UUID
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
status enum Possible values: started, stopped, suspended
Sample session diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstop.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstop.rst index 5ffb6663..280dbca1 100644 --- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstop.rst +++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidstop.rst @@ -9,8 +9,8 @@ Stop a VPCS instance Parameters ********** -- **node_id**: UUID for the instance -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/compute/s.rst b/docs/api/v2/controller/compute/s.rst index 9d600eb4..0b43adbb 100644 --- a/docs/api/v2/controller/compute/s.rst +++ b/docs/api/v2/controller/compute/s.rst @@ -5,11 +5,11 @@ POST /v2/computes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Register a compute +Register a compute server Response status codes ********************** -- **201**: Compute added +- **201**: Compute server added Input ******* @@ -17,12 +17,13 @@ Input - - - - - - + + + + + + +
Name Mandatory Type Description
compute_id string Server identifier
host string Server host
password string Password for auth
port integer Server port
protocol enum Possible values: http, https
user string User for auth
compute_id string Server identifier
host string Server host
name string Server name
password ['string', 'null'] Password for authentication
port integer Server port
protocol enum Possible values: http, https
user ['string', 'null'] User for authentication
Output @@ -32,20 +33,21 @@ Output - + + - - + +
Name Mandatory Type Description
compute_id string Server identifier
connected boolean True if controller is connected to the compute
connected boolean Whether the controller is connected to the compute server or not
host string Server host
name string Server name
port integer Server port
protocol enum Possible values: http, https
user string User for auth
version ['string', 'null'] Version of the GNS3 remote compute
user ['string', 'null'] User for authentication
version ['string', 'null'] Version of the GNS3 remote compute server
GET /v2/computes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -List compute nodes +List of compute servers Response status codes ********************** -- **200**: Compute list +- **200**: Compute servers list returned diff --git a/docs/api/v2/controller/compute/sid.rst b/docs/api/v2/controller/compute/sid.rst new file mode 100644 index 00000000..9495bf30 --- /dev/null +++ b/docs/api/v2/controller/compute/sid.rst @@ -0,0 +1,86 @@ +/v2/computes/{compute_id} +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +PUT /v2/computes/**{compute_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get a compute server information + +Response status codes +********************** +- **200**: Compute server updated +- **400**: Invalid request +- **404**: Instance doesn't exist + +Input +******* +.. raw:: html + + + + + + + + + + +
Name Mandatory Type Description
compute_id string Server identifier
host string Server host
name string Server name
password ['string', 'null'] Password for authentication
port integer Server port
protocol enum Possible values: http, https
user ['string', 'null'] User for authentication
+ +Output +******* +.. raw:: html + + + + + + + + + + + +
Name Mandatory Type Description
compute_id string Server identifier
connected boolean Whether the controller is connected to the compute server or not
host string Server host
name string Server name
port integer Server port
protocol enum Possible values: http, https
user ['string', 'null'] User for authentication
version ['string', 'null'] Version of the GNS3 remote compute server
+ + +GET /v2/computes/**{compute_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get a compute server information + +Response status codes +********************** +- **200**: Compute server information returned + +Output +******* +.. raw:: html + + + + + + + + + + + +
Name Mandatory Type Description
compute_id string Server identifier
connected boolean Whether the controller is connected to the compute server or not
host string Server host
name string Server name
port integer Server port
protocol enum Possible values: http, https
user ['string', 'null'] User for authentication
version ['string', 'null'] Version of the GNS3 remote compute server
+ + +DELETE /v2/computes/**{compute_id}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete a compute instance + +Parameters +********** +- **compute_id**: Compute UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance deleted + diff --git a/docs/api/v2/controller/compute/sidemulatoraction.rst b/docs/api/v2/controller/compute/sidemulatoraction.rst new file mode 100644 index 00000000..dcbcce5e --- /dev/null +++ b/docs/api/v2/controller/compute/sidemulatoraction.rst @@ -0,0 +1,18 @@ +/v2/computes/{compute_id}/{emulator}/{action} +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/computes/**{compute_id}**/**{emulator}**/**{action}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Forward call specific to compute node. Read the full compute API for available actions + +Parameters +********** +- **compute_id**: Compute UUID + +Response status codes +********************** +- **200**: OK +- **404**: Instance doesn't exist + diff --git a/docs/api/v2/controller/compute/sshutdown.rst b/docs/api/v2/controller/compute/sshutdown.rst deleted file mode 100644 index 185ba5b9..00000000 --- a/docs/api/v2/controller/compute/sshutdown.rst +++ /dev/null @@ -1,14 +0,0 @@ -/v2/computes/shutdown ------------------------------------------------------------------------------------------------------------------------------------------- - -.. contents:: - -POST /v2/computes/shutdown -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Shutdown the local compute - -Response status codes -********************** -- **201**: Compute is shutting down -- **403**: Compute shutdown refused - diff --git a/docs/api/v2/controller/link/projectsprojectidlinks.rst b/docs/api/v2/controller/link/projectsprojectidlinks.rst index c7490008..eb86a2de 100644 --- a/docs/api/v2/controller/link/projectsprojectidlinks.rst +++ b/docs/api/v2/controller/link/projectsprojectidlinks.rst @@ -3,13 +3,32 @@ .. contents:: +GET /v2/projects/**{project_id}**/links +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +List links of a project + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **200**: List of links returned + +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinks.txt + + POST /v2/projects/**{project_id}**/links ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Create a new link instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -22,11 +41,12 @@ Input - - - - + + + + +
Name Mandatory Type Description
capture_file_name ['string', 'null'] Read only propertie. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only propertie. The full path of the capture file if capture is running
capturing boolean Read only propertie. True if a capture running on the link
link_id string Link identifier
capture_file_name ['string', 'null'] Read only property. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only property. The full path of the capture file if capture is running
capturing boolean Read only property. True if a capture running on the link
link_id string Link UUID
nodes array List of the VMS
project_id string Project UUID
Output @@ -35,11 +55,12 @@ Output - - - - + + + + +
Name Mandatory Type Description
capture_file_name ['string', 'null'] Read only propertie. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only propertie. The full path of the capture file if capture is running
capturing boolean Read only propertie. True if a capture running on the link
link_id string Link identifier
capture_file_name ['string', 'null'] Read only property. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only property. The full path of the capture file if capture is running
capturing boolean Read only property. True if a capture running on the link
link_id string Link UUID
nodes array List of the VMS
project_id string Project UUID
Sample session diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst index 77bf986a..f7a97dc9 100644 --- a/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst +++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst @@ -9,8 +9,8 @@ Delete a link instance Parameters ********** -- **link_id**: UUID of the link -- **project_id**: UUID for the project +- **link_id**: Link UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst index df5d0fa8..45885529 100644 --- a/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst +++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst @@ -5,16 +5,16 @@ GET /v2/projects/**{project_id}**/links/**{link_id}**/pcap ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get the pcap from the capture +Steam the pcap capture file Parameters ********** -- **link_id**: UUID of the link -- **project_id**: UUID for the project +- **link_id**: Link UUID +- **project_id**: Project UUID Response status codes ********************** -- **200**: Return the file +- **200**: File returned - **403**: Permission denied - **404**: The file doesn't exist diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst index 4b8a4f05..0bcdbfc5 100644 --- a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst +++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst @@ -5,12 +5,12 @@ POST /v2/projects/**{project_id}**/links/**{link_id}**/start_capture ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start capture on a link instance. By default we consider it as an ethernet link +Start capture on a link instance. By default we consider it as an Ethernet link Parameters ********** -- **link_id**: UUID of the link -- **project_id**: UUID for the project +- **link_id**: Link UUID +- **project_id**: Project UUID Response status codes ********************** @@ -23,7 +23,7 @@ Input - +
Name Mandatory Type Description
capture_file_name string Read only propertie. The name of the capture file if capture is running
capture_file_name string Read only property. The name of the capture file if capture is running
data_link_type enum Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC
@@ -33,11 +33,12 @@ Output - - - - + + + + +
Name Mandatory Type Description
capture_file_name ['string', 'null'] Read only propertie. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only propertie. The full path of the capture file if capture is running
capturing boolean Read only propertie. True if a capture running on the link
link_id string Link identifier
capture_file_name ['string', 'null'] Read only property. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only property. The full path of the capture file if capture is running
capturing boolean Read only property. True if a capture running on the link
link_id string Link UUID
nodes array List of the VMS
project_id string Project UUID
Sample session diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst index eaec1760..53c97524 100644 --- a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst +++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst @@ -9,8 +9,8 @@ Stop capture on a link instance Parameters ********** -- **link_id**: UUID of the link -- **project_id**: UUID for the project +- **link_id**: Link UUID +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/node/projectsprojectidnodes.rst b/docs/api/v2/controller/node/projectsprojectidnodes.rst index 7c0a66bc..e8228186 100644 --- a/docs/api/v2/controller/node/projectsprojectidnodes.rst +++ b/docs/api/v2/controller/node/projectsprojectidnodes.rst @@ -9,7 +9,7 @@ Create a new node instance Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** @@ -22,14 +22,18 @@ Input + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Output @@ -38,14 +42,18 @@ Output + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Sample session @@ -61,11 +69,11 @@ List nodes of a project Parameters ********** -- **project_id**: UUID for the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: List of nodes +- **200**: List of nodes returned Sample session *************** diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst index 06b62b56..6aaea2c5 100644 --- a/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst +++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst @@ -9,8 +9,9 @@ Update a node instance Response status codes ********************** +- **200**: Instance updated - **400**: Invalid request -- **201**: Instance created +- **404**: Instance doesn't exist Input ******* @@ -18,14 +19,18 @@ Input + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Output @@ -34,14 +39,18 @@ Output + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Sample session @@ -57,13 +66,14 @@ Delete a node instance Parameters ********** -- **node_id**: UUID for the node -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request -- **201**: Instance deleted +- **404**: Instance doesn't exist +- **204**: Instance deleted Sample session *************** diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst new file mode 100644 index 00000000..cc04c2e5 --- /dev/null +++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst @@ -0,0 +1,26 @@ +/v2/projects/{project_id}/nodes/{node_id}/dynamips/auto_idlepc +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/projects/**{project_id}**/nodes/**{node_id}**/dynamips/auto_idlepc +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Compute the IDLE PC for a Dynamips node + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance reloaded + +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt + diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst new file mode 100644 index 00000000..e5e05092 --- /dev/null +++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst @@ -0,0 +1,26 @@ +/v2/projects/{project_id}/nodes/{node_id}/dynamips/idlepc_proposals +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +GET /v2/projects/**{project_id}**/nodes/**{node_id}**/dynamips/idlepc_proposals +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Compute a list of potential idle PC for a node + +Parameters +********** +- **node_id**: Node UUID +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: Instance reloaded + +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt + diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst index 64ced06e..e7a1dec3 100644 --- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst +++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst @@ -9,13 +9,14 @@ Reload a node instance Parameters ********** -- **node_id**: UUID for the node -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request -- **201**: Instance created +- **404**: Instance doesn't exist +- **204**: Instance reloaded Output ******* @@ -23,14 +24,18 @@ Output + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Sample session diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst index 862c6ec6..067a2e0d 100644 --- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst +++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst @@ -9,13 +9,14 @@ Start a node instance Parameters ********** -- **node_id**: UUID for the node -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request -- **201**: Instance created +- **404**: Instance doesn't exist +- **204**: Instance started Output ******* @@ -23,14 +24,18 @@ Output + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Sample session diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst index 04851fba..605d19a0 100644 --- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst +++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst @@ -5,17 +5,18 @@ POST /v2/projects/**{project_id}**/nodes/**{node_id}**/stop ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a node instance +Stop a node instance Parameters ********** -- **node_id**: UUID for the node -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request -- **201**: Instance created +- **404**: Instance doesn't exist +- **204**: Instance stopped Output ******* @@ -23,14 +24,18 @@ Output + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Sample session diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst index 9d7d934c..b63c8ccb 100644 --- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst +++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst @@ -5,17 +5,18 @@ POST /v2/projects/**{project_id}**/nodes/**{node_id}**/suspend ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Start a node instance +Suspend a node instance Parameters ********** -- **node_id**: UUID for the node -- **project_id**: UUID for the project +- **node_id**: Node UUID +- **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request -- **201**: Instance created +- **404**: Instance doesn't exist +- **204**: Instance suspended Output ******* @@ -23,14 +24,18 @@ Output + - + + - - - + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_type enum Possible values: serial, vnc, telnet
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_id string Node identifier
node_type enum Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project identifier
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
Sample session diff --git a/docs/api/v2/controller/node/projectsprojectidnodesreload.rst b/docs/api/v2/controller/node/projectsprojectidnodesreload.rst new file mode 100644 index 00000000..22932c4a --- /dev/null +++ b/docs/api/v2/controller/node/projectsprojectidnodesreload.rst @@ -0,0 +1,45 @@ +/v2/projects/{project_id}/nodes/reload +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/projects/**{project_id}**/nodes/reload +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Reload all nodes belonging to the project + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: All nodes successfully reloaded + +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesreload.txt + diff --git a/docs/api/v2/controller/node/projectsprojectidnodesstart.rst b/docs/api/v2/controller/node/projectsprojectidnodesstart.rst new file mode 100644 index 00000000..17b201bd --- /dev/null +++ b/docs/api/v2/controller/node/projectsprojectidnodesstart.rst @@ -0,0 +1,45 @@ +/v2/projects/{project_id}/nodes/start +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/projects/**{project_id}**/nodes/start +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Start all nodes belonging to the project + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: All nodes successfully started + +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstart.txt + diff --git a/docs/api/v2/controller/node/projectsprojectidnodesstop.rst b/docs/api/v2/controller/node/projectsprojectidnodesstop.rst new file mode 100644 index 00000000..c3ae6dc7 --- /dev/null +++ b/docs/api/v2/controller/node/projectsprojectidnodesstop.rst @@ -0,0 +1,45 @@ +/v2/projects/{project_id}/nodes/stop +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/projects/**{project_id}**/nodes/stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Stop all nodes belonging to the project + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: All nodes successfully stopped + +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstop.txt + diff --git a/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst b/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst new file mode 100644 index 00000000..b524663a --- /dev/null +++ b/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst @@ -0,0 +1,45 @@ +/v2/projects/{project_id}/nodes/suspend +------------------------------------------------------------------------------------------------------------------------------------------ + +.. contents:: + +POST /v2/projects/**{project_id}**/nodes/suspend +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Suspend all nodes belonging to the project + +Parameters +********** +- **project_id**: Project UUID + +Response status codes +********************** +- **400**: Invalid request +- **404**: Instance doesn't exist +- **204**: All nodes successfully suspended + +Output +******* +.. raw:: html + + + + + + + + + + + + + + + +
Name Mandatory Type Description
command_line ['null', 'string'] Command line use to start the node
compute_id string Compute identifier
console ['integer', 'null'] Console TCP port
console_host string Console host
console_type enum Possible values: serial, vnc, telnet, null
name string Node name
node_directory ['null', 'string'] Working directory of the node. Read only
node_id string Node UUID
node_type enum Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu
project_id string Project UUID
properties object Properties specific to an emulator
status enum Possible values: stopped, started, suspended
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodessuspend.txt + diff --git a/docs/api/v2/controller/project/projects.rst b/docs/api/v2/controller/project/projects.rst index c4bd7acd..67f9c512 100644 --- a/docs/api/v2/controller/project/projects.rst +++ b/docs/api/v2/controller/project/projects.rst @@ -21,7 +21,6 @@ Input name ['string', 'null'] Project name path ['string', 'null'] Project directory project_id ['string', 'null'] Project UUID - temporary boolean If project is a temporary project Output @@ -33,7 +32,6 @@ Output name ['string', 'null'] Project name path ['string', 'null'] Project directory project_id ✔ string Project UUID - temporary ✔ boolean If project is a temporary project Sample session diff --git a/docs/api/v2/controller/project/projectsprojectid.rst b/docs/api/v2/controller/project/projectsprojectid.rst index e852894e..cfe1ed22 100644 --- a/docs/api/v2/controller/project/projectsprojectid.rst +++ b/docs/api/v2/controller/project/projectsprojectid.rst @@ -5,15 +5,15 @@ GET /v2/projects/**{project_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Get the project +Get a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** -- **200**: The project exist +- **200**: Project information returned - **404**: The project doesn't exist Sample session @@ -29,7 +29,7 @@ Delete a project from disk Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/project/projectsprojectidclose.rst b/docs/api/v2/controller/project/projectsprojectidclose.rst index 5f595600..0d961ee6 100644 --- a/docs/api/v2/controller/project/projectsprojectidclose.rst +++ b/docs/api/v2/controller/project/projectsprojectidclose.rst @@ -9,7 +9,7 @@ Close a project Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/project/projectsprojectidcommit.rst b/docs/api/v2/controller/project/projectsprojectidcommit.rst index f857750c..2bf37add 100644 --- a/docs/api/v2/controller/project/projectsprojectidcommit.rst +++ b/docs/api/v2/controller/project/projectsprojectidcommit.rst @@ -9,7 +9,7 @@ Write changes on disk Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/project/projectsprojectidnotifications.rst b/docs/api/v2/controller/project/projectsprojectidnotifications.rst index 8cc66fae..84ce19d6 100644 --- a/docs/api/v2/controller/project/projectsprojectidnotifications.rst +++ b/docs/api/v2/controller/project/projectsprojectidnotifications.rst @@ -5,11 +5,11 @@ GET /v2/projects/**{project_id}**/notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Receive notifications about the projects +Receive notifications about projects Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/project/projectsprojectidnotificationsws.rst b/docs/api/v2/controller/project/projectsprojectidnotificationsws.rst index ceb3d181..a87fd411 100644 --- a/docs/api/v2/controller/project/projectsprojectidnotificationsws.rst +++ b/docs/api/v2/controller/project/projectsprojectidnotificationsws.rst @@ -5,11 +5,11 @@ GET /v2/projects/**{project_id}**/notifications/ws ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Receive notifications about the projects via Websocket +Receive notifications about projects from a Websocket Parameters ********** -- **project_id**: The UUID of the project +- **project_id**: Project UUID Response status codes ********************** diff --git a/docs/api/v2/controller/version.rst b/docs/api/v2/controller/server.rst similarity index 77% rename from docs/api/v2/controller/version.rst rename to docs/api/v2/controller/server.rst index 70939776..d6b9081f 100644 --- a/docs/api/v2/controller/version.rst +++ b/docs/api/v2/controller/server.rst @@ -1,8 +1,8 @@ -Version +Server ----------------------------- .. toctree:: :glob: :maxdepth: 2 - version/* + server/* diff --git a/docs/api/v2/compute/config/configreload.rst b/docs/api/v2/controller/server/shutdown.rst similarity index 63% rename from docs/api/v2/compute/config/configreload.rst rename to docs/api/v2/controller/server/shutdown.rst index 8b4d6d9d..27d95fed 100644 --- a/docs/api/v2/compute/config/configreload.rst +++ b/docs/api/v2/controller/server/shutdown.rst @@ -1,20 +1,20 @@ -/v2/compute/config/reload +/v2/shutdown ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: -POST /v2/compute/config/reload +POST /v2/shutdown ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Check if version is the same as the server +Shutdown the local server Response status codes ********************** -- **201**: Config reload -- **403**: Config reload refused +- **201**: Server is shutting down +- **403**: Server shutdown refused Sample session *************** -.. literalinclude:: ../../../examples/compute_post_configreload.txt +.. literalinclude:: ../../../examples/controller_post_shutdown.txt diff --git a/docs/api/v2/controller/version/version.rst b/docs/api/v2/controller/server/version.rst similarity index 81% rename from docs/api/v2/controller/version/version.rst rename to docs/api/v2/controller/server/version.rst index a83f4d27..70c5f5db 100644 --- a/docs/api/v2/controller/version/version.rst +++ b/docs/api/v2/controller/server/version.rst @@ -17,8 +17,8 @@ Output - - + +
Name Mandatory Type Description
local boolean Either this is a local server
version string Version number human readable
local boolean Whether this is a local server or not
version string Version number
Sample session @@ -43,8 +43,8 @@ Input - - + +
Name Mandatory Type Description
local boolean Either this is a local server
version string Version number human readable
local boolean Whether this is a local server or not
version string Version number
Output @@ -53,8 +53,8 @@ Output - - + +
Name Mandatory Type Description
local boolean Either this is a local server
version string Version number human readable
local boolean Whether this is a local server or not
version string Version number
Sample session