vcenter vm library item: get
Returns the information about the library item associated with the virtual machine. This operation was added in vSphere API 6.9.1.
Request:
HTTP request
GET https://{server}/rest/vcenter/vm/{vm}/library-item
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| vm | string | Identifier of the virtual machine. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"check_out" : {
"library_item" : "obj-103"
}
}
}
"value" : {
"check_out" : {
"library_item" : "obj-103"
}
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Information about the library item associated with the virtual machine. |
| value.check_out | check_out_info | Information about the checked out virtual machine. This attribute was added in vSphere API 6.9.1. Optional. If unset, the virtual machine is not checked out from a library item. |
| value.check_out.library_item | string | Identifier of the library item that the virtual machine is checked out from. This attribute was added in vSphere API 6.9.1. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the virtual machine is not found. |
| 401 | unauthenticated | if the user that requested the operation cannot be authenticated. |
| 403 | unauthorized | if the user that requested the operation is not authorized to perform the operation. |