/v2/compute/projects/{project_id}/vmware/nodes

POST /v2/compute/projects/{project_id}/vmware/nodes

Create a new VMware VM instance

Parameters

  • project_id: Project UUID

Response status codes

  • 400: Invalid request
  • 201: Instance created
  • 409: Conflict

Input

Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer Number of adapters
console integer Console TCP port
console_type enum Possible values: telnet
headless boolean Headless mode
linked_clone ✔ boolean Whether the VM is a linked clone or not
name ✔ string VMware VM instance name
node_id string Node UUID
use_any_adapter boolean Allow GNS3 to use any VMware adapter
vmx_path ✔ string Path to the vmx file

Output

Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer Number of adapters
console integer Console TCP port
console_type enum Possible values: telnet
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
project_id string Project UUID
status enum Possible values: started, stopped, suspended
use_any_adapter boolean Allow GNS3 to use any VMware adapter
vmx_path string Path to the vmx file

Sample session

curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes' -d '{"linked_clone": false, "name": "VM1", "vmx_path": "/tmp/pytest-of-grossmj/pytest-23/test_vmware_create0/test.vmx"}'

POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes HTTP/1.1
{
    "linked_clone": false,
    "name": "VM1",
    "vmx_path": "/tmp/pytest-of-grossmj/pytest-23/test_vmware_create0/test.vmx"
}


HTTP/1.1 201
Connection: close
Content-Length: 593
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:34:59 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/compute/projects/{project_id}/vmware/nodes

{
    "acpi_shutdown": false,
    "adapter_type": "e1000",
    "adapters": 0,
    "console": 5004,
    "console_type": "telnet",
    "headless": false,
    "linked_clone": false,
    "name": "VM1",
    "node_directory": "/tmp/tmp4zak1_kl/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vmware/7973e845-5a86-463b-bdbc-480cd83c76a2",
    "node_id": "7973e845-5a86-463b-bdbc-480cd83c76a2",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "status": "stopped",
    "use_any_adapter": false,
    "vmx_path": "/tmp/pytest-of-grossmj/pytest-23/test_vmware_create0/test.vmx"
}