Compute Space Requirements

Compute Space Requirements

All the listed privileges are required -

Privileges Description
VC_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
POOL_VIEW Caller should have permission to this privilege, on the associated desktop or farm.
Request
URI
POST
https://{api_host}/rest/external/v1/datastores/action/compute-requirements
COPY
Request Body
DatastoreSpaceRequirementSpec of type(s) application/json
Required
{
    "base_snapshot_id": "snapshot-22",
    "base_vm_id": "vm-34",
    "id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
    "pool_size": 0,
    "source": "INSTANT_CLONE",
    "type": "FARM",
    "use_separate_replica_and_os_disk": false,
    "use_vsan": false,
    "user_assignment": "string",
    "vcenter_id": "ed3f92f3-0eef-4bf1-a405-de69f138d382",
    "vm_template_id": "vm-344"
}
string
base_snapshot_id
Optional

Parent VM snapshot ID. Must be set if source is INSTANT_CLONE.

string
base_vm_id
Optional

Parent VM ID. Must be set if source is INSTANT_CLONE.

string
id
Optional

Id of inventory resource for which space requirement is to be found. Can be desktop pool or farm id.

integer As int32 As int32
pool_size
Required

Desired size of the desktop pool or farm.

string
source
Required

Source or provisioning type of machines.

  • FULL_CLONE: Virtual Machines created from a vCenter Server template.
  • INSTANT_CLONE: Virtual Machines created by instant clone engine.
Possible values are : FULL_CLONE, INSTANT_CLONE,
string
type
Required

Type of inventory resource for which space requirement is to be found.

  • DESKTOP_POOL: Desktop pool inventory resource.
  • FARM: Farm inventory resource.
Possible values are : DESKTOP_POOL, FARM,
boolean
use_separate_replica_and_os_disk
Optional

Indicates whether separate datastores are to be used for OS and replica disks. Will be ignored if source is FULL_CLONE or vSAN is to be configured. Default value is false.

boolean
use_vsan
Optional

Indicates whether vSAN is to be configured for the desktop pool or farm. Default value is false. vSAN should be configured if set to true.

string
user_assignment
Optional

User assignment of the desktop pool. Will be ignored if type is FARM. Default value is FLOATING.

  • DEDICATED: Dedicated user assignment.
  • FLOATING: Floating user assignment.
Possible values are : DEDICATED, FLOATING,
string
vcenter_id
Required

ID of virtual center where parent VM or master image is present.

string
vm_template_id
Optional

VM template ID. Must be set if source is FULL_CLONE.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "disk_type": "string",
        "max_size_disk_gb": 15,
        "mid_size_disk_gb": 10,
        "min_size_disk_gb": 5
    }
]

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure