vcenter VM: get
Request:
HTTP request
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| vm | string | Virtual machine identifier. |
Response:
HTTP Status Code: 200
Representations:
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.power_state | string | Power state of the virtual machine. Defines the valid power states for a virtual machine. Value is one of: |
| value.hardware | info | Virtual hardware version information.
|
| value.hardware.version | string | Virtual hardware version. Defines the valid virtual hardware versions for a virtual machine. 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. 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.disks[].key | string | |
| value.disks[].value | info | |
| value.disks[].value.label | string | Device label.
|
| value.disks[].value.type | string | Type of host bus adapter to which the device is attached. Defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine. Value is one of: |
| value.disks[].value.ide | ide_address_info | Address of device attached to a virtual IDE adapter. Optional. It is only relevant when type has value IDE. Workaround for PR1459646. |
| value.disks[].value.ide.primary | boolean | Flag specifying whether the device is attached to the primary or secondary IDE adapter of the virtual machine.
|
| value.disks[].value.ide.master | boolean | Flag specifying whether the device is the master or slave device on the IDE adapter.
|
| value.disks[].value.scsi | scsi_address_info | Address of device attached to a virtual SCSI adapter. Optional. It is only relevant when type has value SCSI. Workaround for PR1459646. |
| value.disks[].value.scsi.bus | long | Bus number of the adapter to which the device is attached.
|
| value.disks[].value.scsi.unit | long | Unit number of the device.
|
| value.disks[].value.sata | sata_address_info | Address of device attached to a virtual SATA adapter. Optional. It is only relevant when type has value SATA. Workaround for PR1459646. |
| value.disks[].value.sata.bus | long | Bus number of the adapter to which the device is attached.
|
| value.disks[].value.sata.unit | long | Unit number of the device.
|
| value.disks[].value.backing | backing_info | Physical resource backing for the virtual disk.
|
| value.disks[].value.backing.type | string | Backing type for the virtual disk. Defines the valid backing types for a virtual disk. Value is one of: |
| value.disks[].value.backing.vmdk_file | string | Path of the VMDK file backing the virtual disk. Optional. It is only relevant when type has value VMDK_FILE. This field is optional and it is only relevant when the value of |
| value.disks[].value.capacity | long | Capacity of the virtual disk in bytes. Optional. If unset, virtual disk is inaccessible or disk capacity is 0. |
| 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.nics[].key | string | |
| value.nics[].value | info | |
| value.nics[].value.label | string | Device label.
|
| value.nics[].value.type | string | Ethernet adapter emulation type. Defines the valid emulation types for a virtual Ethernet adapter. Value is one of: |
| value.nics[].value.upt_compatibility_enabled | boolean | Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter. Optional. It is only relevant when type has value VMXNET3. This field is optional and it is only relevant when the value of |
| value.nics[].value.mac_type | string | MAC address type. Defines the valid MAC address origins for a virtual Ethernet adapter. Value is one of: |
| value.nics[].value.mac_address | string | MAC address. Optional. May be unset if vcenter.vm.hardware.ethernet.info.mac_type is MANUAL and has not been specified, or if vcenter.vm.hardware.ethernet.info.mac_type is GENERATED and the virtual machine has never been powered on since the Ethernet adapter was created. |
| value.nics[].value.pci_slot_number | long | Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added. Optional. May be unset if the virtual machine has never been powered on since the adapter was created. |
| value.nics[].value.wake_on_lan_enabled | boolean | Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.
|
| value.nics[].value.backing | backing_info | Physical resource backing for the virtual Ethernet adapter.
|
| value.nics[].value.backing.type | string | Backing type for the virtual Ethernet adapter. Defines the valid backing types for a virtual Ethernet adapter. Value is one of: |
| value.nics[].value.backing.network | string | Identifier of the network backing the virtual Ethernet adapter. Optional. It is only relevant when type has value [STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK]. If unset, the identifier of the network backing could not be determined.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: |
| value.nics[].value.backing.network_name | string | Name of the standard portgroup backing the virtual Ethernet adapter. Optional. It is only relevant when type has value STANDARD_PORTGROUP. This field is optional and it is only relevant when the value of |
| value.nics[].value.backing.host_device | string | Name of the device backing the virtual Ethernet adapter. Optional. It is only relevant when type has value HOST_DEVICE. This field is optional and it is only relevant when the value of |
| value.nics[].value.backing.distributed_switch_uuid | string | UUID of the distributed virtual switch that backs the virtual Ethernet adapter. Optional. It is only relevant when type has value DISTRIBUTED_PORTGROUP. This field is optional and it is only relevant when the value of |
| value.nics[].value.backing.distributed_port | string | Key of the distributed virtual port that backs the virtual Ethernet adapter. Optional. It is only relevant when type has value DISTRIBUTED_PORTGROUP. This field will be unset if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected. |
| value.nics[].value.backing.connection_cookie | long | Server-generated cookie that identifies the connection to the port. This ookie may be used to verify that the virtual machine is the rightful owner of the port. Optional. It is only relevant when type has value DISTRIBUTED_PORTGROUP. This field will be unset if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected. |
| value.nics[].value.backing.opaque_network_type | string | Type of the opaque network that backs the virtual Ethernet adapter. Optional. It is only relevant when type has value OPAQUE_NETWORK. This field is optional and it is only relevant when the value of |
| value.nics[].value.backing.opaque_network_id | string | Identifier of the opaque network that backs the virtual Ethernet adapter. Optional. It is only relevant when type has value OPAQUE_NETWORK. This field is optional and it is only relevant when the value of |
| value.nics[].value.state | string | Connection status of the virtual device. Defines the valid states for a removable device that is configured to be connected. Value is one of: |
| value.nics[].value.start_connected | boolean | Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
|
| value.nics[].value.allow_guest_control | boolean | Flag indicating whether the guest can connect and disconnect the device.
|
| 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.cdroms[].key | string | |
| value.cdroms[].value | info | |
| value.cdroms[].value.type | string | Type of host bus adapter to which the device is attached. Defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine. Value is one of: |
| value.cdroms[].value.label | string | Device label.
|
| value.cdroms[].value.ide | ide_address_info | Address of device attached to a virtual IDE adapter. Optional. It is only relevant when type has value IDE. This field is optional and it is only relevant when the value of |
| value.cdroms[].value.ide.primary | boolean | Flag specifying whether the device is attached to the primary or secondary IDE adapter of the virtual machine.
|
| value.cdroms[].value.ide.master | boolean | Flag specifying whether the device is the master or slave device on the IDE adapter.
|
| value.cdroms[].value.sata | sata_address_info | Address of device attached to a virtual SATA adapter. Optional. It is only relevant when type has value SATA. This field is optional and it is only relevant when the value of |
| value.cdroms[].value.sata.bus | long | Bus number of the adapter to which the device is attached.
|
| value.cdroms[].value.sata.unit | long | Unit number of the device.
|
| value.cdroms[].value.backing | backing_info | Physical resource backing for the virtual CD-ROM device.
|
| value.cdroms[].value.backing.type | string | Backing type for the virtual CD-ROM device. Defines the valid backing types for a virtual CD-ROM device. Value is one of: |
| value.cdroms[].value.backing.iso_file | string | Path of the image file backing the virtual CD-ROM device. Optional. It is only relevant when type has value ISO_FILE. This field is optional and it is only relevant when the value of |
| value.cdroms[].value.backing.host_device | string | Name of the host device backing the virtual CD-ROM device. Optional. It is only relevant when type has value HOST_DEVICE. This field will be unset if |
| value.cdroms[].value.backing.auto_detect | boolean | Flag indicating whether the virtual CD-ROM device is configured to automatically detect a suitable host device. Optional. It is only relevant when type has value HOST_DEVICE. This field is optional and it is only relevant when the value of |
| value.cdroms[].value.backing.device_access_type | string | Access type for the device backing. Defines the valid device access types for a physical device packing of a virtual CD-ROM device. Value is one of: |
| value.cdroms[].value.state | string | Connection status of the virtual device. Defines the valid states for a removable device that is configured to be connected. Value is one of: |
| value.cdroms[].value.start_connected | boolean | Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
|
| value.cdroms[].value.allow_guest_control | boolean | Flag indicating whether the guest can connect and disconnect the device.
|
| 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.floppies[].key | string | |
| value.floppies[].value | info | |
| value.floppies[].value.label | string | Device label.
|
| value.floppies[].value.backing | backing_info | Physical resource backing for the virtual floppy drive.
|
| value.floppies[].value.backing.type | string | Backing type for the virtual floppy drive. Defines the valid backing types for a virtual floppy drive. Value is one of: |
| value.floppies[].value.backing.image_file | string | Path of the image file backing the virtual floppy drive. Optional. It is only relevant when type has value IMAGE_FILE. This field is optional and it is only relevant when the value of |
| value.floppies[].value.backing.host_device | string | Name of the host device backing the virtual floppy drive. Optional. It is only relevant when type has value HOST_DEVICE. This field will be unset if |
| value.floppies[].value.backing.auto_detect | boolean | Flag indicating whether the virtual floppy drive is configured to automatically detect a suitable host device. Optional. It is only relevant when type has value HOST_DEVICE. This field is optional and it is only relevant when the value of |
| value.floppies[].value.state | string | Connection status of the virtual device. Defines the valid states for a removable device that is configured to be connected. Value is one of: |
| value.floppies[].value.start_connected | boolean | Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
|
| value.floppies[].value.allow_guest_control | boolean | Flag indicating whether the guest can connect and disconnect the device.
|
| 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.parallel_ports[].key | string | |
| value.parallel_ports[].value | info | |
| value.parallel_ports[].value.label | string | Device label.
|
| value.parallel_ports[].value.backing | backing_info | Physical resource backing for the virtual parallel port.
|
| value.parallel_ports[].value.backing.type | string | Backing type for the virtual parallel port. Defines the valid backing types for a virtual parallel port. Value is one of: |
| value.parallel_ports[].value.backing.file | string | Path of the file backing the virtual parallel port. Optional. It is only relevant when type has value FILE. This field is optional and it is only relevant when the value of |
| value.parallel_ports[].value.backing.host_device | string | Name of the device backing the virtual parallel port. Optional. It is only relevant when type has value HOST_DEVICE. This field will be unset if |
| value.parallel_ports[].value.backing.auto_detect | boolean | Flag indicating whether the virtual parallel port is configured to automatically detect a suitable host device. Optional. It is only relevant when type has value HOST_DEVICE. This field is optional and it is only relevant when the value of |
| value.parallel_ports[].value.state | string | Connection status of the virtual device. Defines the valid states for a removable device that is configured to be connected. Value is one of: |
| value.parallel_ports[].value.start_connected | boolean | Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
|
| value.parallel_ports[].value.allow_guest_control | boolean | Flag indicating whether the guest can connect and disconnect the device.
|
| 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.serial_ports[].key | string | |
| value.serial_ports[].value | info | |
| value.serial_ports[].value.label | string | Device label.
|
| value.serial_ports[].value.yield_on_poll | boolean | CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.
|
| value.serial_ports[].value.backing | backing_info | Physical resource backing for the virtual serial port.
|
| value.serial_ports[].value.backing.type | string | Backing type for the virtual serial port. Defines the valid backing types for a virtual serial port. Value is one of: |
| value.serial_ports[].value.backing.file | string | Path of the file backing the virtual serial port. Optional. It is only relevant when type has value FILE. This field is optional and it is only relevant when the value of |
| value.serial_ports[].value.backing.host_device | string | Name of the device backing the virtual serial port. Optional. It is only relevant when type has value HOST_DEVICE. This field will be unset if |
| value.serial_ports[].value.backing.auto_detect | boolean | Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device. Optional. It is only relevant when type has value HOST_DEVICE. This field is optional and it is only relevant when the value of |
| value.serial_ports[].value.backing.pipe | string | Name of the pipe backing the virtual serial port. Optional. It is only relevant when type has value [PIPE_SERVER, PIPE_CLIENT]. This field is optional and it is only relevant when the value of |
| value.serial_ports[].value.backing.no_rx_loss | boolean | Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. Optional. It is only relevant when type has value [PIPE_SERVER, PIPE_CLIENT]. This field is optional and it is only relevant when the value of |
| value.serial_ports[].value.backing.network_location | URI | URI specifying the location of the network service backing the virtual serial port.
Optional. It is only relevant when type has value [NETWORK_SERVER, NETWORK_CLIENT]. This field is optional and it is only relevant when the value of |
| value.serial_ports[].value.backing.proxy | URI | Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. Optional. It is only relevant when type has value [NETWORK_SERVER, NETWORK_CLIENT]. If unset, no proxy service is configured. |
| value.serial_ports[].value.state | string | Connection status of the virtual device. Defines the valid states for a removable device that is configured to be connected. Value is one of: |
| value.serial_ports[].value.start_connected | boolean | Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
|
| value.serial_ports[].value.allow_guest_control | boolean | Flag indicating whether the guest can connect and disconnect the device.
|
| 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.sata_adapters[].key | string | |
| value.sata_adapters[].value | info | |
| value.sata_adapters[].value.label | string | Device label.
|
| value.sata_adapters[].value.type | string | Adapter type. Defines the valid emulation types for a virtual SATA adapter. Value is one of: |
| value.sata_adapters[].value.bus | long | SATA bus number.
|
| value.sata_adapters[].value.pci_slot_number | long | Address of the SATA adapter on the PCI bus. Optional. May be unset if the virtual machine has never been powered on since the adapter was created. |
| 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: |
| value.scsi_adapters[].key | string | |
| value.scsi_adapters[].value | info | |
| value.scsi_adapters[].value.label | string | Device label.
|
| value.scsi_adapters[].value.type | string | Adapter type. Defines the valid emulation types for a virtual SCSI adapter. Value is one of: |
| value.scsi_adapters[].value.scsi | scsi_address_info | Address of the SCSI adapter on the SCSI bus.
|
| value.scsi_adapters[].value.scsi.bus | long | Bus number of the adapter to which the device is attached.
|
| value.scsi_adapters[].value.scsi.unit | long | Unit number of the device.
|
| value.scsi_adapters[].value.pci_slot_number | long | Address of the SCSI adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added. Optional. May be unset if the virtual machine has never been powered on since the adapter was created. |
| value.scsi_adapters[].value.sharing | string | Bus sharing mode. Defines the valid bus sharing modes for a virtual SCSI adapter. Value is one of: |
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. |
| 400 | 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. |