vcenter vm template library items check outs: check out spec

The check_out_spec structure defines the information required to check out a library item containing a virtual machine template. This structure was added in vSphere API 6.9.1.

Representation:

{
    "name""string",
    "placement"{
        "cluster""obj-103",
        "folder""obj-103",
        "host""obj-103",
        "resource_pool""obj-103"
    },
    "powered_on"true
}

Attributes:

Name Type Description
Optional
name string Name of the virtual machine to check out of the library item. This attribute was added in vSphere API 6.9.1.

Optional. This field is currently required. In the future, if this field is unset, the system will choose a suitable name for the virtual machine.

placement placement_spec Information used to place the checked out virtual machine. This attribute was added in vSphere API 6.9.1.

Optional. This field is currently required. In the future, if this field is unset, the system will place the virtual machine on a suitable resource.

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

.
placement.folder string Virtual machine folder into which the virtual machine should be placed. This attribute was added in vSphere API 6.9.1.

Optional. If unset, the virtual machine will be placed in the same folder as the source virtual machine template.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

placement.resource_pool string Resource pool into which the virtual machine should be placed. This attribute was added in vSphere API 6.9.1.

Optional. If unset, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the operation will fail.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ResourcePool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ResourcePool.

placement.host string Host onto which the virtual machine should be placed. If host and resource_pool are both specified, resource_pool must belong to host. If host and cluster are both specified, host must be a member of cluster. This attribute was added in vSphere API 6.9.1.

Optional. This field may be unset if resource_pool or cluster is specified. If unset, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the operation will fail.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.

placement.cluster string Cluster onto which the virtual machine should be placed. If cluster and resource_pool are both specified, resource_pool must belong to cluster. If cluster and host are both specified, host must be a member of cluster. This attribute was added in vSphere API 6.9.1.

Optional. If resource_pool or host is specified, it is recommended that this field be unset.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.

powered_on boolean Specifies whether the virtual machine should be powered on after check out. This attribute was added in vSphere API 6.9.1.

Optional. If unset, the virtual machine will not be powered on after check out.