gns3-server/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst

/v2/compute/projects/{project_id}/cloud/nodes/{node_id}

GET /v2/compute/projects/{project_id}/cloud/nodes/{node_id}

Get a cloud instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 200: Success
• 400: Invalid request
• 404: Instance doesn't exist

Output

Name	Mandatory	Type	Description
interfaces		array
name	✔	string	Cloud name
node_directory		string	Path to the VM working directory
node_id	✔	string	Node UUID
ports_mapping	✔	array
project_id	✔	string	Project UUID
remote_console_host		['string']	Remote console host or IP
remote_console_http_path		string	Path of the remote web interface
remote_console_port		['integer', 'null']	Console TCP port
remote_console_type		enum	Possible values: telnet, vnc, spice, http, https, none
status		enum	Possible values: started, stopped, suspended

Sample session

../../../examples/compute_get_projectsprojectidcloudnodesnodeid.txt

PUT /v2/compute/projects/{project_id}/cloud/nodes/{node_id}

Update a cloud instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

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

Input

Types

HostInterfaces

Interfaces on this host

Name	Mandatory	Type	Description
name	✔	string	Interface name
special	✔	boolean	If true the interface is non standard (firewire for example)
type	✔	enum	Possible values: ethernet, tap

Body

Name	Mandatory	Type	Description
interfaces		array
name		string	Cloud name
node_directory		string	Path to the VM working directory
node_id		string	Node UUID
ports_mapping		array
project_id		string	Project UUID
remote_console_host		['string']	Remote console host or IP
remote_console_http_path		string	Path of the remote web interface
remote_console_port		['integer', 'null']	Console TCP port
remote_console_type		enum	Possible values: telnet, vnc, spice, http, https, none
status		enum	Possible values: started, stopped, suspended

Output

Name	Mandatory	Type	Description
interfaces		array
name	✔	string	Cloud name
node_directory		string	Path to the VM working directory
node_id	✔	string	Node UUID
ports_mapping	✔	array
project_id	✔	string	Project UUID
remote_console_host		['string']	Remote console host or IP
remote_console_http_path		string	Path of the remote web interface
remote_console_port		['integer', 'null']	Console TCP port
remote_console_type		enum	Possible values: telnet, vnc, spice, http, https, none
status		enum	Possible values: started, stopped, suspended

Sample session

../../../examples/compute_put_projectsprojectidcloudnodesnodeid.txt

DELETE /v2/compute/projects/{project_id}/cloud/nodes/{node_id}

Delete a cloud instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

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

Sample session

../../../examples/compute_delete_projectsprojectidcloudnodesnodeid.txt