Skip to content

Vmware Virtual Machine

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/vmware-virtual-machine/ List Vmware Virtual Machine
GET /api/vmware-virtual-machine/{uuid}/ Retrieve
POST /api/vmware-virtual-machine/ Create
POST /api/vmware-virtual-machine/{uuid}/create_disk/ Create disk
POST /api/vmware-virtual-machine/{uuid}/create_port/ Create port
POST /api/vmware-virtual-machine/{uuid}/pull/ Synchronize resource state
POST /api/vmware-virtual-machine/{uuid}/unlink/ Unlink resource
PUT /api/vmware-virtual-machine/{uuid}/ Update
PATCH /api/vmware-virtual-machine/{uuid}/ Partial Update
DELETE /api/vmware-virtual-machine/{uuid}/ Delete
Other Actions
GET /api/vmware-virtual-machine/{uuid}/console/ This endpoint provides access to Virtual Machine Remote Console aka VMRC
GET /api/vmware-virtual-machine/{uuid}/web_console/ This endpoint provides access to HTML Console aka WMKS
POST /api/vmware-virtual-machine/{uuid}/reboot_guest/ Reboot guest
POST /api/vmware-virtual-machine/{uuid}/reset/ Reset
POST /api/vmware-virtual-machine/{uuid}/shutdown_guest/ Shutdown guest
POST /api/vmware-virtual-machine/{uuid}/start/ Start
POST /api/vmware-virtual-machine/{uuid}/stop/ Stop
POST /api/vmware-virtual-machine/{uuid}/suspend/ Suspend

Core CRUD

List Vmware Virtual Machine

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: vmware_virtual_machine_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareVirtualMachineList } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string
can_manage boolean Can manage
customer string (uuid)
customer_abbreviation string
customer_name string
customer_native_name string
customer_uuid string (uuid)
description string
external_ip string
field array
name string
name_exact string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid)
project_name string
project_uuid string (uuid)
runtime_state string
service_settings_name string
service_settings_uuid string (uuid)
state array
uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-vmware-virtual-machine" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_virtual_machine_request import VmwareVirtualMachineRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwareVirtualMachineRequest(
    name="my-awesome-vmware-virtual-machine",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = vmware_virtual_machine_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwareVirtualMachineRequest
  2. API Source: vmware_virtual_machine_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { vmwareVirtualMachineCreate } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-vmware-virtual-machine",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
guest_os any
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
template string (uri)
Constraints: write-only
cluster string (uri)
networks array of objects
Constraints: write-only
networks.url string (uri) ✓
datastore string (uri)
folder string (uri)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create disk

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_disk/ \
  Authorization:"Token YOUR_API_TOKEN" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_disk_request import VmwareDiskRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_create_disk # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwareDiskRequest(
    size=100
)
response = vmware_virtual_machine_create_disk.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwareDiskRequest
  2. API Source: vmware_virtual_machine_create_disk
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { vmwareVirtualMachineCreateDisk } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineCreateDisk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
description string
size integer ✓ Size in MiB

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size in MiB
vm string (uri)
vm_uuid string (uuid)
vm_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create port

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_port/ \
  Authorization:"Token YOUR_API_TOKEN" \
  network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_port_request import VmwarePortRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_create_port # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwarePortRequest(
    network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = vmware_virtual_machine_create_port.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwarePortRequest
  2. API Source: vmware_virtual_machine_create_port
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { vmwareVirtualMachineCreatePort } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineCreatePort({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "network": "https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
network string (uri) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
mac_address string
vm string (uri)
vm_uuid string (uuid)
vm_name string
network string (uri)
network_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachinePull } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachinePull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 - No response body

409 - No response body

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineUnlink } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-vmware-virtual-machine" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_virtual_machine_request import VmwareVirtualMachineRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwareVirtualMachineRequest(
    name="my-awesome-vmware-virtual-machine",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = vmware_virtual_machine_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwareVirtualMachineRequest
  2. API Source: vmware_virtual_machine_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { vmwareVirtualMachineUpdate } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-vmware-virtual-machine",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
guest_os any
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
template string (uri)
Constraints: write-only
cluster string (uri)
networks array of objects
Constraints: write-only
networks.url string (uri) ✓
datastore string (uri)
folder string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_vmware_virtual_machine_request import PatchedVmwareVirtualMachineRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedVmwareVirtualMachineRequest()
response = vmware_virtual_machine_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedVmwareVirtualMachineRequest
  2. API Source: vmware_virtual_machine_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachinePartialUpdate } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachinePartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
description string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineDestroy } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

This endpoint provides access to Virtual Machine Remote Console aka VMRC

This endpoint provides access to Virtual Machine Remote Console aka VMRC.

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/console/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_console_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_console_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_console_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineConsoleRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineConsoleRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)

This endpoint provides access to HTML Console aka WMKS

This endpoint provides access to HTML Console aka WMKS.

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/web_console/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_web_console_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_web_console_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_web_console_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineWebConsoleRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineWebConsoleRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)

Reboot guest

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reboot_guest/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_reboot_guest # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_reboot_guest.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_reboot_guest
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineRebootGuest } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineRebootGuest({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Reset

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reset/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_reset # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_reset.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_reset
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineReset } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineReset({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Shutdown guest

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/shutdown_guest/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_shutdown_guest # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_shutdown_guest.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_shutdown_guest
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineShutdownGuest } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineShutdownGuest({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Start

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_start # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_start.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_start
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineStart } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineStart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Stop

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stop/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_stop # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_stop.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_stop
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineStop } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineStop({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Suspend

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/suspend/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_suspend # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_suspend.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_suspend
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineSuspend } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineSuspend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body