This API has a deprecated equivalent from v7.0U1.
Delete Library Items Check Outs
DescriptionDeletes the checked out virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete. - 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/{vm}
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.
string
vm
Required
Identifier of the checked out virtual machine to delete. The parameter must be an identifier for the resource type: VirtualMachine.
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.
Code Samples
Code Samples
PowerCLI Client SDK Example
Invoke-DeleteTemplateLibraryItemVmVmTemplateCheckOuts -TemplateLibraryItem "MyTemplateLibraryItem" -Vm "MyVm"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm-template/library-items/{template_library_item}/check-outs/{vm}
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the virtual machine is not checked out of the library item. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is running (powered on).
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 or virtual machine is not found.
500
com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed. | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: delete
x-vmw-doc-deprecated-path: /rest/vcenter/vm-template/library-items/{template_library_item}/check-outs/{vm}
x-vmw-doc-operation: delete
Availability
Added in 7.0U2
