ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2025-05-17 08:13:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
gns3-server/docs/api/v1/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst
Julien Duponchelle 664cec97ba
Create /hypervisor and /controller namespace
2016-03-07 15:01:35 +01:00

2.6 KiB
Raw Blame History

/v1/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/start

POST /v1/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/start

Start a VPCS instance

Parameters

  • vm_id: UUID for the instance
  • project_id: UUID for the project

Response status codes

  • 400: Invalid request
  • 404: Instance doesn't exist
  • 204: Instance started

Output

Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start QEMU
console ✔ integer console TCP port
name ✔ string VPCS VM name
project_id ✔ string Project UUID
startup_script ['string', 'null'] Content of the VPCS startup script
startup_script_path ✔ ['string', 'null'] Path of the VPCS startup script relative to project directory
status ✔ enum Possible values: started, stopped
vm_directory string
vm_id ✔ string VPCS VM UUID

Sample session

../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt