/v2/compute/projects/{project_id}/vmware/nodes/{node_id} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: GET /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Get a VMware VM instance Parameters ********** - **node_id**: Node UUID - **project_id**: Project UUID Response status codes ********************** - **200**: Success - **400**: Invalid request - **404**: Instance doesn't exist Output ******* .. raw:: html
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
PUT /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Update a VMware VM instance Parameters ********** - **node_id**: Node UUID - **project_id**: Project UUID Response status codes ********************** - **200**: Instance updated - **400**: Invalid request - **404**: Instance doesn't exist - **409**: Conflict Input ******* .. raw:: html
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
Output ******* .. raw:: html
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
DELETE /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Delete a VMware VM instance Parameters ********** - **node_id**: Node UUID - **project_id**: Project UUID Response status codes ********************** - **400**: Invalid request - **404**: Instance doesn't exist - **204**: Instance deleted