This API has a deprecated equivalent from v7.0U1.
List Library Items Check Outs
Returns commonly used information about the virtual machines that are checked out of the library item. 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 System.Read.
Request
URLURL
https://{api_host}/api/vcenter/vm-template/library-items/{template_library_item}/check-outs
Path Parameters
Path Parameters
string
template_library_item
Required
Identifier of the VM template library item. 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
VmTemplateLibraryItemsCheckOutsSummary
of type application/json
List of commonly used information about the check outs.
[
{
"vm": "string"
}
]
string
vm
Required
Identifier of the checked out virtual machine. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the library item does not contain a virtual machine template.
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.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListTemplateLibraryItemVmTemplateCheckOuts -TemplateLibraryItem "MyTemplateLibraryItem"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm-template/library-items/{template_library_item}/check-outs
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm-template/library-items/{template_library_item}/check-outs
x-vmw-doc-operation: list
Availability
Added in 7.0U2
