gns3-server/docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmid.rst

/v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}

PUT /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}

Update a Docker instance

Parameters

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

Response status codes

• 200: Instance updated
• 400: Invalid request
• 404: Instance doesn't exist
• 409: Conflict

Input

Name	Mandatory	Type	Description
adapters		['integer', 'null']	number of adapters
aux		['integer', 'null']	auxilary TCP port
console		['integer', 'null']	console TCP port
console_type		enum	Possible values: telnet, vnc
environment		['string', 'null']	Docker environment
name		string	Docker container name
start_command		['string', 'null']	Docker CMD entry

Output

Name	Mandatory	Type	Description
adapters	✔	['integer', 'null']	number of adapters
aux	✔	['integer', 'null']	auxilary TCP port
console	✔	['integer', 'null']	console TCP port
console_type	✔	enum	Possible values: telnet, vnc
container_id	✔	string	Docker container ID
environment	✔	['string', 'null']	Docker environment
image	✔	string	Docker image name
name		string	Docker container name
project_id	✔	string	Project UUID
start_command	✔	['string', 'null']	Docker CMD entry
vm_directory	✔	string
vm_id	✔	string	Docker container instance UUID

Sample session

../../../examples/hypervisor_put_projectsprojectiddockervmsvmid.txt