This API has a deprecated equivalent from v7.0U1.
Get Library Item
Returns the information about the library item associated with the virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/library-item
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine. 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.
Response
Response
Response BodyResponse Body
200 OK returns
VmLibraryItemInfo
of type application/json
Information about the library item associated with the virtual machine.
{
"check_out": {
"library_item": "string"
}
}
check_out
Optional
Information about the checked out virtual machine. If unset, the virtual machine is not checked out from a library item.
Errors
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.
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-GetVmLibraryItem -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/library-item
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/{vm}/library-item
x-vmw-doc-operation: get
Availability
Added in 7.0U2
