/v2/compute/projects/{project_id}/vmware/nodes/{node_id}¶
GET /v2/compute/projects/{project_id}/vmware/nodes/{node_id}¶
Get a VMware VM 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 |
---|---|---|---|
adapter_type | string | VMware adapter type | |
adapters | integer | Number of adapters | |
console | ['integer', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, none | |
custom_adapters | array | ||
headless | boolean | Headless mode | |
linked_clone | boolean | Whether the VM is a linked clone or not | |
name | string | VMware VM instance name | |
node_directory | ['string', 'null'] | Path to the node working directory | |
node_id | string | Node UUID | |
on_close | enum | Possible values: power_off, shutdown_signal, save_vm_state | |
project_id | string | Project UUID | |
status | enum | Possible values: started, stopped, suspended | |
usage | string | How to use the VMware VM | |
use_any_adapter | boolean | Allow GNS3 to use any VMware adapter | |
vmx_path | string | Path to the vmx file |
Sample session¶
curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/716f8727-4421-4ba9-9e24-031505533c36'
GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/716f8727-4421-4ba9-9e24-031505533c36 HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 611
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:29 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/vmware/nodes/{node_id}
{
"adapter_type": "e1000",
"adapters": 0,
"console": 5004,
"console_type": "telnet",
"headless": false,
"linked_clone": false,
"name": "VMTEST",
"node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vmware/716f8727-4421-4ba9-9e24-031505533c36",
"node_id": "716f8727-4421-4ba9-9e24-031505533c36",
"on_close": "power_off",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"status": "stopped",
"usage": "",
"use_any_adapter": false,
"vmx_path": "/tmp/pytest-of-grossmj/pytest-41/test_vmware_get0/test.vmx"
}
PUT /v2/compute/projects/{project_id}/vmware/nodes/{node_id}¶
Update a VMware VM 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 |
---|---|---|---|
adapter_type | string | VMware adapter type | |
adapters | integer | Number of adapters | |
console | ['integer', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, none | |
custom_adapters | array | ||
headless | boolean | Headless mode | |
linked_clone | boolean | Whether the VM is a linked clone or not | |
name | string | VMware VM instance name | |
node_directory | ['string', 'null'] | Path to the node working directory | |
node_id | string | Node UUID | |
on_close | enum | Possible values: power_off, shutdown_signal, save_vm_state | |
project_id | string | Project UUID | |
status | enum | Possible values: started, stopped, suspended | |
usage | string | How to use the VMware VM | |
use_any_adapter | boolean | Allow GNS3 to use any VMware adapter | |
vmx_path | string | Path to the vmx file |
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
adapter_type | string | VMware adapter type | |
adapters | integer | Number of adapters | |
console | ['integer', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, none | |
custom_adapters | array | ||
headless | boolean | Headless mode | |
linked_clone | boolean | Whether the VM is a linked clone or not | |
name | string | VMware VM instance name | |
node_directory | ['string', 'null'] | Path to the node working directory | |
node_id | string | Node UUID | |
on_close | enum | Possible values: power_off, shutdown_signal, save_vm_state | |
project_id | string | Project UUID | |
status | enum | Possible values: started, stopped, suspended | |
usage | string | How to use the VMware VM | |
use_any_adapter | boolean | Allow GNS3 to use any VMware adapter | |
vmx_path | string | Path to the vmx file |
Sample session¶
curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/2178f4e5-4cac-4300-becf-1853fe7d2226' -d '{"console": 5005, "name": "test"}'
PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/2178f4e5-4cac-4300-becf-1853fe7d2226 HTTP/1.1
{
"console": 5005,
"name": "test"
}
HTTP/1.1 200
Connection: close
Content-Length: 612
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:43 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/vmware/nodes/{node_id}
{
"adapter_type": "e1000",
"adapters": 0,
"console": 5005,
"console_type": "telnet",
"headless": false,
"linked_clone": false,
"name": "test",
"node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vmware/2178f4e5-4cac-4300-becf-1853fe7d2226",
"node_id": "2178f4e5-4cac-4300-becf-1853fe7d2226",
"on_close": "power_off",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"status": "stopped",
"usage": "",
"use_any_adapter": false,
"vmx_path": "/tmp/pytest-of-grossmj/pytest-41/test_vmware_update0/test.vmx"
}
DELETE /v2/compute/projects/{project_id}/vmware/nodes/{node_id}¶
Delete a VMware VM instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
204: Instance deleted
400: Invalid request
404: Instance doesn’t exist