gns3-server/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst

/v1/projects/{project_id}/vpcs/vms

POST /v1/projects/{project_id}/vpcs/vms

Create a new VPCS instance

Parameters

• project_id: UUID for the project

Response status codes

• 400: Invalid request
• 201: Instance created
• 409: Conflict

Input

Name	Mandatory	Type	Description
console		['integer', 'null']	console TCP port
name	✔	string	VPCS VM name
startup_script		['string', 'null']	Content of the VPCS startup script
vm_id			VPCS VM identifier

Output

Name	Mandatory	Type	Description
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/post_projectsprojectidvpcsvms.txt