vcenter VM: get
Request:
HTTP request
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| vm | string | Virtual machine identifier. |
Response:
HTTP Status Code: 200
Representation:
"value" : {
"instant_clone_frozen" : true,
"cdroms" : [
{
"value" : {
"start_connected" : true,
"backing" : {
"auto_detect" : true,
"device_access_type" : "EMULATION",
"iso_file" : "string",
"type" : "ISO_FILE",
"host_device" : "string"
},
"allow_guest_control" : true,
"state" : "CONNECTED",
"label" : "string",
"ide" : {
"primary" : true,
"master" : true
},
"type" : "IDE",
"sata" : {
"bus" : 1,
"unit" : 1
}
},
"key" : "obj-103"
}
],
"memory" : {
"hot_add_increment_size_MiB" : 1,
"size_MiB" : 1,
"hot_add_enabled" : true,
"hot_add_limit_MiB" : 1
},
"disks" : [
{
"value" : {
"scsi" : {
"bus" : 1,
"unit" : 1
},
"backing" : {
"vmdk_file" : "string",
"type" : "VMDK_FILE"
},
"label" : "string",
"ide" : {
"primary" : true,
"master" : true
},
"type" : "IDE",
"sata" : {
"bus" : 1,
"unit" : 1
},
"capacity" : 1
},
"key" : "obj-103"
}
],
"parallel_ports" : [
{
"value" : {
"start_connected" : true,
"backing" : {
"file" : "string",
"auto_detect" : true,
"type" : "FILE",
"host_device" : "string"
},
"allow_guest_control" : true,
"state" : "CONNECTED",
"label" : "string"
},
"key" : "obj-103"
}
],
"sata_adapters" : [
{
"value" : {
"bus" : 1,
"pci_slot_number" : 1,
"label" : "string",
"type" : "AHCI"
},
"key" : "obj-103"
}
],
"cpu" : {
"hot_remove_enabled" : true,
"count" : 1,
"hot_add_enabled" : true,
"cores_per_socket" : 1
},
"scsi_adapters" : [
{
"value" : {
"scsi" : {
"bus" : 1,
"unit" : 1
},
"pci_slot_number" : 1,
"label" : "string",
"type" : "BUSLOGIC",
"sharing" : "NONE"
},
"key" : "obj-103"
}
],
"power_state" : "POWERED_OFF",
"floppies" : [
{
"value" : {
"start_connected" : true,
"backing" : {
"auto_detect" : true,
"image_file" : "string",
"type" : "IMAGE_FILE",
"host_device" : "string"
},
"allow_guest_control" : true,
"state" : "CONNECTED",
"label" : "string"
},
"key" : "obj-103"
}
],
"identity" : {
"name" : "string",
"instance_uuid" : "string",
"bios_uuid" : "string"
},
"name" : "string",
"nics" : [
{
"value" : {
"start_connected" : true,
"pci_slot_number" : 1,
"backing" : {
"connection_cookie" : 1,
"distributed_switch_uuid" : "string",
"distributed_port" : "string",
"network_name" : "string",
"opaque_network_type" : "string",
"type" : "STANDARD_PORTGROUP",
"host_device" : "string",
"opaque_network_id" : "string",
"network" : "obj-103"
},
"mac_address" : "string",
"mac_type" : "MANUAL",
"allow_guest_control" : true,
"wake_on_lan_enabled" : true,
"state" : "CONNECTED",
"label" : "string",
"type" : "E1000",
"upt_compatibility_enabled" : true
},
"key" : "obj-103"
}
],
"boot" : {
"delay" : 1,
"efi_legacy_boot" : true,
"retry_delay" : 1,
"enter_setup_mode" : true,
"type" : "BIOS",
"network_protocol" : "IPV4",
"retry" : true
},
"serial_ports" : [
{
"value" : {
"start_connected" : true,
"backing" : {
"proxy" : "http://myurl.com",
"file" : "string",
"auto_detect" : true,
"pipe" : "string",
"type" : "FILE",
"host_device" : "string",
"no_rx_loss" : true,
"network_location" : "http://myurl.com"
},
"allow_guest_control" : true,
"yield_on_poll" : true,
"state" : "CONNECTED",
"label" : "string"
},
"key" : "obj-103"
}
],
"guest_OS" : "DOS",
"boot_devices" : [
{
"disks" : [
"obj-103",
"obj-103"
],
"nic" : "obj-103",
"type" : "CDROM"
},
{
"disks" : [
"obj-103",
"obj-103"
],
"nic" : "obj-103",
"type" : "CDROM"
}
],
"hardware" : {
"upgrade_policy" : "NEVER",
"upgrade_status" : "NONE",
"upgrade_error" : {},
"upgrade_version" : "VMX_03",
"version" : "VMX_03"
}
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Information about the specified virtual machine. |
| value.guest_OS | string | Guest OS. Defines the valid guest operating system types used for configuring a virtual machine. Value is one of: |
| value.name | string | Virtual machine name.
|
| value.identity | info | Identity of the virtual machine. This attribute was added in vSphere API 6.7.1. Optional. This field is optional because it was added in a newer version than its parent node. |
| value.identity.name | string | Virtual machine name. This attribute was added in vSphere API 6.7.1.
|
| value.identity.bios_uuid | string | 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format. This attribute was added in vSphere API 6.7.1.
|
| value.identity.instance_uuid | string | VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID. This attribute was added in vSphere API 6.7.1.
|
| value.power_state | string | Power state of the virtual machine. Defines the valid power states for a virtual machine. Value is one of: |
| value.instant_clone_frozen | boolean | Indicates whether the virtual machine is frozen for instant clone, or not. This attribute was added in vSphere API 6.7.1. Optional. This field is optional because it was added in a newer version than its parent node. |
| value.hardware | info | Virtual hardware version information.
|
| value.hardware.version | string | Virtual hardware version. Defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)). Value is one of: |
| value.hardware.upgrade_policy | string | Scheduled upgrade policy. Defines the valid virtual hardware upgrade policies for a virtual machine. Value is one of: |
| value.hardware.upgrade_version | string | Target hardware version to be used on the next scheduled virtual hardware upgrade. Defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)). Value is one of: |
| value.hardware.upgrade_status | string | Scheduled upgrade status. Defines the valid virtual hardware upgrade statuses for a virtual machine. Value is one of: |
| value.hardware.upgrade_error | exception | Reason for the scheduled upgrade failure. Optional. It is only relevant when upgrade_status has value FAILED. This field is optional and it is only relevant when the value of |
| value.boot | info | Boot configuration.
|
| value.boot.type | string | Firmware type used by the virtual machine. Defines the valid firmware types for a virtual machine. Value is one of: |
| value.boot.efi_legacy_boot | boolean | Flag indicating whether to use EFI legacy boot mode. Optional. It is only relevant when type has value EFI. This field is optional and it is only relevant when the value of |
| value.boot.network_protocol | string | Protocol to use when attempting to boot the virtual machine over the network. Defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network. Value is one of: |
| value.boot.delay | long | Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode.
|
| value.boot.retry | boolean | Flag indicating whether the virtual machine will automatically retry the boot process after a failure.
|
| value.boot.retry_delay | long | Delay in milliseconds before retrying the boot process after a failure; applicable only when vcenter.vm.hardware.boot.info.retry is true.
|
| value.boot.enter_setup_mode | boolean | Flag indicating whether the firmware boot process will automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode.
|
| value.boot_devices | entry[] | Boot device configuration. If the array has no entries, a server-specific default boot sequence is used.
|
| value.boot_devices[].type | string | Virtual device type. Defines the valid device types that may be used as bootable devices. Value is one of: |
| value.boot_devices[].nic | string | Virtual Ethernet device. Ethernet device to use as boot device for this entry. Optional. It is only relevant when type has value ETHERNET. This field is optional and it is only relevant when the value of |
| value.boot_devices[].disks | string[] | Virtual disk device. List of virtual disks in boot order. Optional. It is only relevant when type has value DISK. This field is optional and it is only relevant when the value of |
| value.cpu | info | CPU configuration.
|
| value.cpu.count | long | Number of CPU cores.
|
| value.cpu.cores_per_socket | long | Number of CPU cores per socket.
|
| value.cpu.hot_add_enabled | boolean | Flag indicating whether adding CPUs while the virtual machine is running is enabled.
|
| value.cpu.hot_remove_enabled | boolean | Flag indicating whether removing CPUs while the virtual machine is running is enabled.
|
| value.memory | info | Memory configuration.
|
| value.memory.size_MiB | long | Memory size in mebibytes.
|
| value.memory.hot_add_enabled | boolean | Flag indicating whether adding memory while the virtual machine is running is enabled. Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.
|
| value.memory.hot_add_increment_size_MiB | long | The granularity, in mebibytes, at which memory can be added to a running virtual machine. When adding memory to a running virtual machine, the amount of memory added must be at least vcenter.vm.hardware.memory.info.hot_add_increment_size_MiB and the total memory size of the virtual machine must be a multiple of {@link>hotAddIncrementSize}. Optional. Only set when vcenter.vm.hardware.memory.info.hot_add_enabled is true and the virtual machine is running. |
| value.memory.hot_add_limit_MiB | long | The maximum amount of memory, in mebibytes, that can be added to a running virtual machine. Optional. Only set when vcenter.vm.hardware.memory.info.hot_add_enabled is true and the virtual machine is running. |
| value.disks | list | List of disks. 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: |
| value.nics | list | List of Ethernet adapters. 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: |
| value.cdroms | list | List of CD-ROMs. 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: |
| value.floppies | list | List of floppy drives. 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: |
| value.parallel_ports | list | List of parallel ports. 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: |
| value.serial_ports | list | List of serial ports. 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: |
| value.sata_adapters | list | List of SATA adapters. 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: |
| value.scsi_adapters | list | List of SCSI adapters. 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: |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 404 | not_found | if the virtual machine is not found. |
| 500 | resource_inaccessible | if the virtual machine's configuration state cannot be accessed. |
| 503 | service_unavailable | if the system is unable to communicate with a service to complete the request. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user doesn't have the required privileges. |