gns3-server/docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst

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

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

Get an IOU 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
command_line	✔	string	Last command line used by GNS3 to start QEMU
console	✔	integer	Console TCP port
console_type		enum	Possible values: telnet
ethernet_adapters	✔	integer	How many ethernet adapters are connected to the IOU
iourc_path		['string', 'null']	Path of the iourc file used by remote servers
l1_keepalives	✔	boolean	Always up ethernet interface
md5sum	✔	['string', 'null']	Checksum of iou binary
name	✔	string	IOU VM name
node_directory		string	Path to the node working directory
node_id	✔	string	IOU VM UUID
nvram	✔	integer	Allocated NVRAM KB
path	✔	string	Path of iou binary
private_config	✔	['string', 'null']	Path of the private-config content relative to project directory
project_id	✔	string	Project UUID
ram	✔	integer	Allocated RAM MB
serial_adapters	✔	integer	How many serial adapters are connected to the IOU
startup_config	✔	['string', 'null']	Path of the startup-config content relative to project directory
status		enum	Possible values: started, stopped, suspended
use_default_iou_values	✔	['boolean', 'null']	Use default IOU values

Sample session

../../../examples/compute_get_projectsprojectidiounodesnodeid.txt

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

Update an IOU 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

Name	Mandatory	Type	Description
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: telnet, null
ethernet_adapters		['integer', 'null']	How many ethernet adapters are connected to the IOU
iourc_content		['string', 'null']	Content of the iourc file. Ignored if Null
l1_keepalives		['boolean', 'null']	Always up ethernet interface
md5sum		['string', 'null']	Checksum of iou binary
name		['string', 'null']	IOU VM name
nvram		['integer', 'null']	Allocated NVRAM KB
path		['string', 'null']	Path of iou binary
private_config		['string', 'null']	Path to the private-config of IOU
private_config_content		['string', 'null']	Private-config of IOU
ram		['integer', 'null']	Allocated RAM MB
serial_adapters		['integer', 'null']	How many serial adapters are connected to the IOU
startup_config		['string', 'null']	Path to the startup-config of IOU
startup_config_content		['string', 'null']	Startup-config of IOU
use_default_iou_values		['boolean', 'null']	Use default IOU values

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
ethernet_adapters	✔	integer	How many ethernet adapters are connected to the IOU
iourc_path		['string', 'null']	Path of the iourc file used by remote servers
l1_keepalives	✔	boolean	Always up ethernet interface
md5sum	✔	['string', 'null']	Checksum of iou binary
name	✔	string	IOU VM name
node_directory		string	Path to the node working directory
node_id	✔	string	IOU VM UUID
nvram	✔	integer	Allocated NVRAM KB
path	✔	string	Path of iou binary
private_config	✔	['string', 'null']	Path of the private-config content relative to project directory
project_id	✔	string	Project UUID
ram	✔	integer	Allocated RAM MB
serial_adapters	✔	integer	How many serial adapters are connected to the IOU
startup_config	✔	['string', 'null']	Path of the startup-config content relative to project directory
status		enum	Possible values: started, stopped, suspended
use_default_iou_values	✔	['boolean', 'null']	Use default IOU values

Sample session

../../../examples/compute_put_projectsprojectidiounodesnodeid.txt

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

Delete an IOU instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

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

Sample session

../../../examples/compute_delete_projectsprojectidiounodesnodeid.txt