This API has a deprecated equivalent from v7.0U1.
Check Out Library Items Check Outs
Checks out a library item containing a virtual machine template. This operation makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, CheckOuts.check-in the virtual machine. To discard the changes, CheckOuts.delete the virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate. - The resource Folder referenced by the attribute CheckOuts.PlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute CheckOuts.PlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute CheckOuts.PlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute CheckOuts.PlacementSpec.cluster requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/vm-template/library-items/{template_library_item}/check-outs?action=check-out
Path Parameters
Path Parameters
string
template_library_item
Required
Identifier of the content library item containing the source virtual machine template to be checked out. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmTemplateLibraryItemsCheckOutsCheckOutSpec of mimetype application/json
Required
Specification used to check out the source virtual machine template as a virtual machine. This parameter is currently required. In the future, if this parameter is unset, the system will apply suitable defaults.
{
"name": "string",
"placement": {}
}
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.
placement
Required
Information used to place the checked out virtual machine. 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.
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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string of type application/json
Identifier of the virtual machine that was checked out of the library item. The result will be an identifier for the resource type: VirtualMachine.
Errors
400
com.vmware.vapi.std.errors.already_exists : if a virtual machine with the name specified by CheckOuts.CheckOutSpec.name already exists in the folder specified by CheckOuts.PlacementSpec.folder. | com.vmware.vapi.std.errors.invalid_argument : if spec contains invalid arguments. if the library item is a member of a subscribed library.
401
com.vmware.vapi.std.errors.unauthenticated : if the user that requested the operation cannot be authenticated.
403
com.vmware.vapi.std.errors.unauthorized : if the user that requested the operation is not authorized to perform the operation.
404
com.vmware.vapi.std.errors.not_found : if the library item specified by templateLibraryItem cannot be found.
500
com.vmware.vapi.std.errors.resource_inaccessible : if there is an error accessing the files of the source virtual machine template contained in the library item specified by templateLibraryItem. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the limit for the number of virtual machines checked out of a library item (currently 1) has been exceeded. | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Code Samples
PowerCLI Client SDK Example
$VmTemplateLibraryItemsCheckOutsPlacementSpec = Initialize-VmTemplateLibraryItemsCheckOutsPlacementSpec
$VmTemplateLibraryItemsCheckOutsCheckOutSpec = Initialize-VmTemplateLibraryItemsCheckOutsCheckOutSpec -Name "MyName" -Placement $VmTemplateLibraryItemsCheckOutsPlacementSpec
Invoke-CheckOutTemplateLibraryItemCheckOuts -TemplateLibraryItem "MyTemplateLibraryItem" -VmTemplateLibraryItemsCheckOutsCheckOutSpec $VmTemplateLibraryItemsCheckOutsCheckOutSpec
PowerCLI Client SDK All Parameters Example
$VmTemplateLibraryItemsCheckOutsPlacementSpec = Initialize-VmTemplateLibraryItemsCheckOutsPlacementSpec -Folder "MyFolder" -ResourcePool "MyResourcePool" -VarHost "MyVarHost" -Cluster "MyCluster"
$VmTemplateLibraryItemsCheckOutsCheckOutSpec = Initialize-VmTemplateLibraryItemsCheckOutsCheckOutSpec -Name "MyName" -Placement $VmTemplateLibraryItemsCheckOutsPlacementSpec -PoweredOn $false
Invoke-CheckOutTemplateLibraryItemCheckOuts -TemplateLibraryItem "MyTemplateLibraryItem" -VmTemplateLibraryItemsCheckOutsCheckOutSpec $VmTemplateLibraryItemsCheckOutsCheckOutSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"name":"string","placement":{"cluster":"string","folder":"string","host":"string","resource_pool":"string"},"powered_on":false}' https://{api_host}/api/vcenter/vm-template/library-items/{template_library_item}/check-outs?action=check-out
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vm-template/library-items/{template_library_item}/check-outs?action=check-out
x-vmw-doc-operation: check_out
Availability
Added in 7.0U2
