gns3-server/docs/api/v1/iou/projectsprojectidiouvmsvmid.rst

/v1/projects/{project_id}/iou/vms/{vm_id}

GET /v1/projects/{project_id}/iou/vms/{vm_id}

Get a IOU instance

Parameters

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

Response status codes

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

Output

Name	Mandatory	Type	Description
console	✔	integer	console TCP port
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
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
use_default_iou_values	✔	['boolean', 'null']	Use default IOU values
vm_directory		string
vm_id	✔	string	IOU VM UUID

Sample session

../../examples/get_projectsprojectidiouvmsvmid.txt

PUT /v1/projects/{project_id}/iou/vms/{vm_id}

Update a IOU 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
console		['integer', 'null']	console TCP port
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_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_content		['string', 'null']	Startup-config of IOU
use_default_iou_values		['boolean', 'null']	Use default IOU values

Output

Name	Mandatory	Type	Description
console	✔	integer	console TCP port
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
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
use_default_iou_values	✔	['boolean', 'null']	Use default IOU values
vm_directory		string
vm_id	✔	string	IOU VM UUID

Sample session

../../examples/put_projectsprojectidiouvmsvmid.txt

DELETE /v1/projects/{project_id}/iou/vms/{vm_id}

Delete a IOU 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 deleted

Sample session

../../examples/delete_projectsprojectidiouvmsvmid.txt