Vcenter VmTemplate LibraryItems CheckOuts CheckOutSpec

The Vcenter VmTemplate LibraryItems CheckOuts CheckOutSpec schema defines the information required to check out a library item containing a virtual machine template.

This schema was added in vSphere API 6.9.1.

JSON Example

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

string

name

Optional

Name of the virtual machine to check out of the library item.

This property was added in vSphere API 6.9.1.

This property is currently required. In the future, if this property is missing or null, the system will choose a suitable name for the virtual machine.

placement

Optional

Information used to place the checked out virtual machine.

This property was added in vSphere API 6.9.1.

This property is currently required. In the future, if this property is missing or null, the system will place the virtual machine on a suitable resource.

If specified, each property will be used for placement. If the properties result in disjoint placement, the operation will fail. If the properties along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.

boolean

powered_on

Optional

Specifies whether the virtual machine should be powered on after check out.

This property was added in vSphere API 6.9.1.

If missing or null, the virtual machine will not be powered on after check out.

Parameter To

Vcenter VmTemplate LibraryItems CheckOuts checkOut