gns3-server/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst

/v1/projects/{project_id}/dynamips/devices/{device_id}

GET /v1/projects/{project_id}/dynamips/devices/{device_id}

Get a Dynamips device instance

Parameters

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

Response status codes

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

Output

Name	Mandatory	Type	Description
device_id	✔	string	Dynamips router instance UUID
mappings		object
name	✔	string	Dynamips device instance name
ports		array
project_id	✔	string	Project UUID

PUT /v1/projects/{project_id}/dynamips/devices/{device_id}

Update a Dynamips device instance

Parameters

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

Response status codes

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

Input

Types

EthernetSwitchPort

Ethernet switch port

Name	Mandatory	Type	Description
port	✔	integer	Port number
type	✔	enum	Possible values: access, dot1q, qinq
vlan	✔	integer	VLAN number

Body

Name	Mandatory	Type	Description
name		string	Dynamips device instance name
ports		array

Output

Name	Mandatory	Type	Description
device_id	✔	string	Dynamips router instance UUID
mappings		object
name	✔	string	Dynamips device instance name
ports		array
project_id	✔	string	Project UUID

DELETE /v1/projects/{project_id}/dynamips/devices/{device_id}

Delete a Dynamips device instance

Parameters

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

Response status codes

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