vcenter vm template library items: get
Returns information about a virtual machine template contained in the library item specified by
template_library_item. This operation was added in vSphere API 6.8.
Request:
HTTP request
GET https://{server}/rest/vcenter/vm-template/library-items/{template_library_item}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| template_library_item | string | identifier of the library item containing the virtual machine template. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"memory" : {
"size_MiB" : 1
},
"disks" : [
{
"value" : {
"disk_storage" : {
"datastore" : "obj-103",
"storage_policy" : "obj-103"
},
"capacity" : 1
},
"key" : "obj-103"
}
],
"nics" : [
{
"value" : {
"mac_type" : "MANUAL",
"backing_type" : "STANDARD_PORTGROUP",
"network" : "obj-103"
},
"key" : "obj-103"
}
],
"cpu" : {
"count" : 1,
"cores_per_socket" : 1
},
"vm_home_storage" : {
"datastore" : "obj-103",
"storage_policy" : "obj-103"
},
"guest_OS" : "DOS",
"vm_template" : "string"
}
}
"value" : {
"memory" : {
"size_MiB" : 1
},
"disks" : [
{
"value" : {
"disk_storage" : {
"datastore" : "obj-103",
"storage_policy" : "obj-103"
},
"capacity" : 1
},
"key" : "obj-103"
}
],
"nics" : [
{
"value" : {
"mac_type" : "MANUAL",
"backing_type" : "STANDARD_PORTGROUP",
"network" : "obj-103"
},
"key" : "obj-103"
}
],
"cpu" : {
"count" : 1,
"cores_per_socket" : 1
},
"vm_home_storage" : {
"datastore" : "obj-103",
"storage_policy" : "obj-103"
},
"guest_OS" : "DOS",
"vm_template" : "string"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Optional. Information about the virtual machine template item contained in the library item. |
| value.guest_OS | string | Configured guest operating system of the virtual machine template. This attribute was added in vSphere API 6.8. Defines the valid guest operating system types used for configuring a virtual machine. Value is one of: DOS: MS-DOS. WIN_31: Windows 3.1 WIN_95: Windows 95 WIN_98: Windows 98 WIN_ME: Windows Millennium Edition WIN_NT: Windows NT 4 WIN_2000_PRO: Windows 2000 Professional WIN_2000_SERV: Windows 2000 Server WIN_2000_ADV_SERV: Windows 2000 Advanced Server WIN_XP_HOME: Windows XP Home Edition WIN_XP_PRO: Windows XP Professional WIN_XP_PRO_64: Windows XP Professional Edition (64 bit) WIN_NET_WEB: Windows Server 2003, Web Edition WIN_NET_STANDARD: Windows Server 2003, Standard Edition WIN_NET_ENTERPRISE: Windows Server 2003, Enterprise Edition WIN_NET_DATACENTER: Windows Server 2003, Datacenter Edition WIN_NET_BUSINESS: Windows Small Business Server 2003 WIN_NET_STANDARD_64: Windows Server 2003, Standard Edition (64 bit) WIN_NET_ENTERPRISE_64: Windows Server 2003, Enterprise Edition (64 bit) WIN_LONGHORN: Windows Longhorn (experimental) WIN_LONGHORN_64: Windows Longhorn (64 bit) (experimental) WIN_NET_DATACENTER_64: Windows Server 2003, Datacenter Edition (64 bit) (experimental) WIN_VISTA: Windows Vista WIN_VISTA_64: Windows Vista (64 bit) WINDOWS_7: Windows 7 WINDOWS_7_64: Windows 7 (64 bit) WINDOWS_7_SERVER_64: Windows Server 2008 R2 (64 bit) WINDOWS_8: Windows 8 WINDOWS_8_64: Windows 8 (64 bit) WINDOWS_8_SERVER_64: Windows 8 Server (64 bit) WINDOWS_9: Windows 10 WINDOWS_9_64: Windows 10 (64 bit) WINDOWS_9_SERVER_64: Windows 10 Server (64 bit) WINDOWS_HYPERV: Windows Hyper-V WINDOWS_SERVER_2019: Windows Server 2019. This constant was added in vSphere API 7.0.0.0. WINDOWS_SERVER_2021: Windows Server 2021. This constant was added in vSphere API 7.0.1.0. FREEBSD: FreeBSD 10 or earlier FREEBSD_64: FreeBSD 10 x64 or earlier FREEBSD_11: FreeBSD 11. This constant was added in vSphere API 6.7. FREEBSD_12: FreeBSD 12. This constant was added in vSphere API 6.7. FREEBSD_13: FreeBSD 13 or later. This constant was added in vSphere API 7.0.1.0. FREEBSD_11_64: FreeBSD 11 x64. This constant was added in vSphere API 6.7. FREEBSD_12_64: FreeBSD 12 x64. This constant was added in vSphere API 6.7. FREEBSD_13_64: FreeBSD 13 x64 or later. This constant was added in vSphere API 7.0.1.0. REDHAT: Red Hat Linux 2.1 RHEL_2: Red Hat Enterprise Linux 2 RHEL_3: Red Hat Enterprise Linux 3 RHEL_3_64: Red Hat Enterprise Linux 3 (64 bit) RHEL_4: Red Hat Enterprise Linux 4 RHEL_4_64: Red Hat Enterprise Linux 4 (64 bit) RHEL_5: Red Hat Enterprise Linux 5 RHEL_5_64: Red Hat Enterprise Linux 5 (64 bit) (experimental) RHEL_6: Red Hat Enterprise Linux 6 RHEL_6_64: Red Hat Enterprise Linux 6 (64 bit) RHEL_7: Red Hat Enterprise Linux 7 RHEL_7_64: Red Hat Enterprise Linux 7 (64 bit) RHEL_8_64: Red Hat Enterprise Linux 8 (64 bit). This constant was added in vSphere API 6.7. RHEL_9_64: Red Hat Enterprise Linux 9 (64 bit). This constant was added in vSphere API 7.0.1.0. CENTOS: CentOS 4/5 CENTOS_64: CentOS 4/5 (64-bit) CENTOS_6: CentOS 6 CENTOS_6_64: CentOS 6 (64-bit) CENTOS_7: CentOS 7 CENTOS_7_64: CentOS 7 (64-bit) CENTOS_8_64: CentOS 8 (64-bit). This constant was added in vSphere API 6.7. CENTOS_9_64: CentOS 9 (64-bit). This constant was added in vSphere API 7.0.1.0. ORACLE_LINUX: Oracle Linux 4/5 ORACLE_LINUX_64: Oracle Linux 4/5 (64-bit) ORACLE_LINUX_6: Oracle Linux 6 ORACLE_LINUX_6_64: Oracle Linux 6 (64-bit) ORACLE_LINUX_7: Oracle Linux 7 ORACLE_LINUX_7_64: Oracle Linux 7 (64-bit) ORACLE_LINUX_8_64: Oracle Linux 8 (64-bit). This constant was added in vSphere API 6.7. ORACLE_LINUX_9_64: Oracle Linux 9 (64-bit). This constant was added in vSphere API 7.0.1.0. SUSE: Suse Linux SUSE_64: Suse Linux (64 bit) SLES: Suse Linux Enterprise Server 9 SLES_64: Suse Linux Enterprise Server 9 (64 bit) SLES_10: Suse linux Enterprise Server 10 SLES_10_64: Suse Linux Enterprise Server 10 (64 bit) (experimental) SLES_11: Suse linux Enterprise Server 11 SLES_11_64: Suse Linux Enterprise Server 11 (64 bit) SLES_12: Suse linux Enterprise Server 12 SLES_12_64: Suse Linux Enterprise Server 12 (64 bit) SLES_15_64: Suse Linux Enterprise Server 15 (64 bit). This constant was added in vSphere API 6.7. SLES_16_64: Suse Linux Enterprise Server 16 (64 bit). This constant was added in vSphere API 7.0.1.0. NLD_9: Novell Linux Desktop 9 OES: Open Enterprise Server SJDS: Sun Java Desktop System MANDRAKE: Mandrake Linux MANDRIVA: Mandriva Linux MANDRIVA_64: Mandriva Linux (64 bit) TURBO_LINUX: Turbolinux TURBO_LINUX_64: Turbolinux (64 bit) UBUNTU: Ubuntu Linux UBUNTU_64: Ubuntu Linux (64 bit) DEBIAN_4: Debian GNU/Linux 4 DEBIAN_4_64: Debian GNU/Linux 4 (64 bit) DEBIAN_5: Debian GNU/Linux 5 DEBIAN_5_64: Debian GNU/Linux 5 (64 bit) DEBIAN_6: Debian GNU/Linux 6 DEBIAN_6_64: Debian GNU/Linux 6 (64 bit) DEBIAN_7: Debian GNU/Linux 7 DEBIAN_7_64: Debian GNU/Linux 7 (64 bit) DEBIAN_8: Debian GNU/Linux 8 DEBIAN_8_64: Debian GNU/Linux 8 (64 bit) DEBIAN_9: Debian GNU/Linux 9 DEBIAN_9_64: Debian GNU/Linux 9 (64 bit) DEBIAN_10: Debian GNU/Linux 10 DEBIAN_10_64: Debian GNU/Linux 10 (64 bit) DEBIAN_11: Debian GNU/Linux 11. This constant was added in vSphere API 7.0.0.0. DEBIAN_11_64: Debian GNU/Linux 11 (64 bit). This constant was added in vSphere API 7.0.0.0. ASIANUX_3: Asianux Server 3 ASIANUX_3_64: Asianux Server 3 (64 bit) ASIANUX_4: Asianux Server 4 ASIANUX_4_64: Asianux Server 4 (64 bit) ASIANUX_5_64: Asianux Server 5 (64 bit) ASIANUX_7_64: Asianux Server 7 (64 bit) ASIANUX_8_64: Asianux Server 8 (64 bit). This constant was added in vSphere API 6.7. ASIANUX_9_64: Asianux Server 9 (64 bit). This constant was added in vSphere API 7.0.1.0. OPENSUSE: OpenSUSE Linux OPENSUSE_64: OpenSUSE Linux (64 bit) FEDORA: Fedora Linux FEDORA_64: Fedora Linux (64 bit) COREOS_64: CoreOS Linux (64 bit) VMWARE_PHOTON_64: VMware Photon (64 bit) OTHER_24X_LINUX: Linux 2.4x Kernel OTHER_24X_LINUX_64: Linux 2.4x Kernel (64 bit) (experimental) OTHER_26X_LINUX: Linux 2.6x Kernel OTHER_26X_LINUX_64: Linux 2.6x Kernel (64 bit) (experimental) OTHER_3X_LINUX: Linux 3.x Kernel OTHER_3X_LINUX_64: Linux 3.x Kernel (64 bit) OTHER_4X_LINUX: Linux 4.x Kernel. This constant was added in vSphere API 6.7. OTHER_4X_LINUX_64: Linux 4.x Kernel (64 bit). This constant was added in vSphere API 6.7. OTHER_5X_LINUX: Linux 5.x Kernel. This constant was added in vSphere API 7.0.1.0. OTHER_5X_LINUX_64: Linux 5.x Kernel (64 bit). This constant was added in vSphere API 7.0.1.0. OTHER_LINUX: Linux 2.2x Kernel GENERIC_LINUX: Other Linux OTHER_LINUX_64: Linux (64 bit) (experimental) SOLARIS_6: Solaris 6 SOLARIS_7: Solaris 7 SOLARIS_8: Solaris 8 SOLARIS_9: Solaris 9 SOLARIS_10: Solaris 10 (32 bit) (experimental) SOLARIS_10_64: Solaris 10 (64 bit) (experimental) SOLARIS_11_64: Solaris 11 (64 bit) OS2: OS/2 ECOMSTATION: eComStation 1.x ECOMSTATION_2: eComStation 2.0 NETWARE_4: Novell NetWare 4 NETWARE_5: Novell NetWare 5.1 NETWARE_6: Novell NetWare 6.x OPENSERVER_5: SCO OpenServer 5 OPENSERVER_6: SCO OpenServer 6 UNIXWARE_7: SCO UnixWare 7 DARWIN: Mac OS 10.5 DARWIN_64: Mac OS 10.5 (64 bit) DARWIN_10: Mac OS 10.6 DARWIN_10_64: Mac OS 10.6 (64 bit) DARWIN_11: Mac OS 10.7 DARWIN_11_64: Mac OS 10.7 (64 bit) DARWIN_12_64: Mac OS 10.8 (64 bit) DARWIN_13_64: Mac OS 10.9 (64 bit) DARWIN_14_64: Mac OS 10.10 (64 bit) DARWIN_15_64: Mac OS 10.11 (64 bit) DARWIN_16_64: Mac OS 10.12 (64 bit) DARWIN_17_64: Mac OS 10.13 (64 bit). This constant was added in vSphere API 6.7. DARWIN_18_64: Mac OS 10.14 (64 bit). This constant was added in vSphere API 6.7. DARWIN_19_64: Mac OS 10.15 (64 bit). This constant was added in vSphere API 7.0.0.0. DARWIN_20_64: Mac OS 10.16 (64 bit). This constant was added in vSphere API 7.0.1.0. DARWIN_21_64: Mac OS 10.17 (64 bit). This constant was added in vSphere API 7.0.1.0. VMKERNEL: VMware ESX 4 VMKERNEL_5: VMware ESX 5 VMKERNEL_6: VMware ESX 6 VMKERNEL_65: VMware ESX 6.5 VMKERNEL_7: VMware ESX 7. This constant was added in vSphere API 7.0.0.0. AMAZONLINUX2_64: Amazon Linux 2 (64 bit). This constant was added in vSphere API 6.7.1. AMAZONLINUX3_64: Amazon Linux 3 (64 bit). This constant was added in vSphere API 7.0.1.0. CRXPOD_1: CRX Pod 1. This constant was added in vSphere API 7.0.0.0. OTHER: Other Operating System OTHER_64: Other Operating System (64 bit) (experimental) |
| value.cpu | cpu_info | CPU configuration of the virtual machine template. This attribute was added in vSphere API 6.8. |
| value.cpu.count | long | Number of CPU cores. This attribute was added in vSphere API 6.8. |
| value.cpu.cores_per_socket | long | Number of CPU cores per socket. This attribute was added in vSphere API 6.8. |
| value.memory | memory_info | Memory configuration of the virtual machine template. This attribute was added in vSphere API 6.8. |
| value.memory.size_MiB | long | Memory size in mebibytes. This attribute was added in vSphere API 6.8. |
| value.vm_home_storage | vm_home_storage_info | Storage information about the virtual machine template's configuration and log files. This attribute was added in vSphere API 6.8. |
| value.vm_home_storage.datastore | string | Identifier of the datastore where the virtual machine template's configuration and log files are stored. This attribute was added in vSphere API 6.8. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datastore. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datastore. |
| value.vm_home_storage.storage_policy | string | Identifier of the storage policy associated with the virtual machine template's configuration and log files. This attribute was added in vSphere API 6.8. Optional. If unset, the virtual machine template's configuration and log files do not have a storage policy associated with them.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.spbm.StorageProfile. |
| value.disks | list | Storage information about the virtual machine template's virtual disks. This attribute was added in vSphere API 6.8. When clients pass a value of this structure as a parameter, the key in the field key/value pairs 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 key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.List of {"key": string, "value": disk_info} |
| value.nics | list | Information about the virtual machine template's virtual ethernet adapters. This attribute was added in vSphere API 6.8. When clients pass a value of this structure as a parameter, the key in the field key/value pairs 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 key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.List of {"key": string, "value": ethernet_info} |
| value.vm_template | string | 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. This attribute was added in vSphere API 6.8. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 404 | not_found | if the library item could not be found. |
| 500 | resource_inaccessible | if the virtual machine template's configuration state cannot be accessed. |
| 503 | service_unavailable | if any of the services involved in the operation are unavailable. |
| 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. |