VmTemplate_LibraryItems_CheckOuts_CheckOutSpec

The CheckOuts.CheckOutSpec structure defines the information required to check out a library item containing a virtual machine template.

JSON Example

{
    "name": "string",
    "placement": {
        "folder": "string",
        "resource_pool": "string",
        "host": "string",
        "cluster": "string"
    },
    "powered_on": false
}

string

name

Required

Name of the virtual machine to check out of the library item. This field is currently required. In the future, if this field is unset, the system will choose a suitable name for the virtual machine.

VmTemplate_LibraryItems_CheckOuts_PlacementSpec

placement

Required

The CheckOuts.PlacementSpec structure contains information used to place a checked out virtual machine onto resources within the vCenter inventory. The specified compute resource should have access to the storage associated with the checked out virtual machine.

boolean

powered_on

Optional

Specifies whether the virtual machine should be powered on after check out. If unset, the virtual machine will not be powered on after check out.