This API has a deprecated equivalent from v7.0U1.
Get Library Items
Returns information about a virtual machine template contained in the library item specified by templateLibraryItem 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}
Path Parameters
Path Parameters
string
template_library_item
Required
identifier of the library item containing the virtual machine template. 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
VmTemplateLibraryItemsInfo
of type application/json
Information about the virtual machine template item contained in the library item. If unset, the library item specified by templateLibraryItem does not contain a virtual machine template.
{
"cpu": {
"cores_per_socket": 0,
"count": 0
},
"disks": {
"key": {
"capacity": 0,
"disk_storage": {
"datastore": "string",
"storage_policy": "string"
}
}
},
"guest_OS": "enum",
"memory": {
"size_MiB": 0
},
"nics": {
"key": {
"backing_type": "STANDARD_PORTGROUP",
"mac_type": "MANUAL",
"network": "string"
}
},
"vm_home_storage": {
"datastore": "string",
"storage_policy": "string"
},
"vm_template": "string"
}
disks
Required
Storage information about the virtual machine template’s virtual disks. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
guest_OS
Required
Configured guest operating system of the virtual machine template.
Possible values are: DOS , WIN_31 , WIN_95 , WIN_98 , WIN_ME , more...
memory
Required
Memory configuration of the virtual machine template.
nics
Required
Information about the virtual machine template’s virtual ethernet adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
vm_home_storage
Required
Storage information about the virtual machine template’s configuration and log files.
string
vm_template
Required
Identifier of the latest virtual machine template contained in the library item. This field is the managed object identifier used to identify the virtual machine template in the vSphere Management (SOAP) API.
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.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine template’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if any of the services involved in the operation are unavailable.
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-GetTemplateLibraryItemVmTemplate -TemplateLibraryItem "MyTemplateLibraryItem"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm-template/library-items/{template_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-template/library-items/{template_library_item}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
