gns3-server/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst
Julien Duponchelle ed291da566
Rebuild doc
2016-03-14 20:37:07 +01:00

2.8 KiB

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

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

Start a VPCS instance

Parameters

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

Response status codes

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

Output

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

Sample session

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