mirror of
https://github.com/GNS3/gns3-server.git
synced 2025-01-03 19:44:11 +00:00
6.7 KiB
6.7 KiB
/v2/appliances/{appliance_id}
GET /v2/appliances/{appliance_id}
Get an appliance
Response status codes
- 200: Appliance found
- 400: Invalid request
- 404: Appliance doesn't exist
Output
Name | Mandatory | Type | Description |
---|---|---|---|
appliance_id | ✔ | string | Appliance UUID from which the node has been created. Read only |
appliance_type | ✔ | enum | Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu |
builtin | ✔ | boolean | Appliance is builtin |
category | ✔ | Appliance category | |
compute_id | ✔ | string | Compute identifier |
default_name_format | ✔ | string | Default name format |
name | ✔ | string | Appliance name |
symbol | ✔ | string | Symbol of the appliance |
Sample session
../../../examples/controller_get_appliancesapplianceid.txt
PUT /v2/appliances/{appliance_id}
Update an appliance
Response status codes
- 200: Appliance updated
- 400: Invalid request
- 404: Appliance doesn't exist
Input
Name | Mandatory | Type | Description |
---|---|---|---|
appliance_id | string | Appliance UUID from which the node has been created. Read only | |
appliance_type | enum | Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu | |
builtin | boolean | Appliance is builtin | |
category | Appliance category | ||
compute_id | string | Compute identifier | |
default_name_format | string | Default name format | |
name | string | Appliance name | |
symbol | string | Symbol of the appliance |
Output
Name | Mandatory | Type | Description |
---|---|---|---|
appliance_id | ✔ | string | Appliance UUID from which the node has been created. Read only |
appliance_type | ✔ | enum | Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu |
builtin | ✔ | boolean | Appliance is builtin |
category | ✔ | Appliance category | |
compute_id | ✔ | string | Compute identifier |
default_name_format | ✔ | string | Default name format |
name | ✔ | string | Appliance name |
symbol | ✔ | string | Symbol of the appliance |
Sample session
../../../examples/controller_put_appliancesapplianceid.txt
DELETE /v2/appliances/{appliance_id}
Delete an appliance
Parameters
- appliance_id: appliance UUID
Response status codes
- 204: Appliance deleted
- 400: Invalid request
- 404: Appliance doesn't exist
Sample session
../../../examples/controller_delete_appliancesapplianceid.txt