1. Operations
2. vcenter
3. vm

## vcenter VM: get

Returns information about a virtual machine.

### Request:

#### HTTP request

GET https://{server}/rest/vcenter/vm/{vm}

#### Path Parameters

Name | Type | Description
--- | --- | ---
Required
vm | string | Virtual machine identifier.

### Response:

#### HTTP Status Code: 200

#### Representations:

- JSON
- XML

{
"value": {
"boot": {
"delay": 1,
"efi_legacy_boot": true,
"enter_setup_mode": true,
"network_protocol": "IPV4",
"retry": true,
"retry_delay": 1,
"type": "BIOS"
},
"boot_devices": [
{
"disks": [
"obj-103",
"obj-103"
],
"nic": "obj-103",
"type": "CDROM"
},
{
"disks": [
"obj-103",
"obj-103"
],
"nic": "obj-103",
"type": "CDROM"
}
],
"cdroms": [
{
"key": "obj-103",
"value": {
"allow_guest_control": true,
"backing": {
"auto_detect": true,
"device_access_type": "EMULATION",
"host_device": "string",
"iso_file": "string",
"type": "ISO_FILE"
},
"ide": {
"master": true,
"primary": true
},
"label": "string",
"sata": {
"bus": 1,
"unit": 1
},
"start_connected": true,
"state": "CONNECTED",
"type": "IDE"
}
}
],
"cpu": {
"cores_per_socket": 1,
"count": 1,
"hot_add_enabled": true,
"hot_remove_enabled": true
},
"disks": [
{
"key": "obj-103",
"value": {
"backing": {
"type": "VMDK_FILE",
"vmdk_file": "string"
},
"capacity": 1,
"ide": {
"master": true,
"primary": true
},
"label": "string",
"sata": {
"bus": 1,
"unit": 1
},
"scsi": {
"bus": 1,
"unit": 1
},
"type": "IDE"
}
}
],
"floppies": [
{
"key": "obj-103",
"value": {
"allow_guest_control": true,
"backing": {
"auto_detect": true,
"host_device": "string",
"image_file": "string",
"type": "IMAGE_FILE"
},
"label": "string",
"start_connected": true,
"state": "CONNECTED"
}
}
],
"guest_OS": "DOS",
"hardware": {
"upgrade_error": {
"@class": "exception"
},
"upgrade_policy": "NEVER",
"upgrade_status": "NONE",
"upgrade_version": "VMX_03",
"version": "VMX_03"
},
"memory": {
"hot_add_enabled": true,
"hot_add_increment_size_MiB": 1,
"hot_add_limit_MiB": 1,
"size_MiB": 1
},
"name": "string",
"nics": [
{
"key": "obj-103",
"value": {
"allow_guest_control": true,
"backing": {
"connection_cookie": 1,
"distributed_port": "string",
"distributed_switch_uuid": "string",
"host_device": "string",
"network": "obj-103",
"network_name": "string",
"opaque_network_id": "string",
"opaque_network_type": "string",
"type": "STANDARD_PORTGROUP"
},
"label": "string",
"mac_address": "string",
"mac_type": "MANUAL",
"pci_slot_number": 1,
"start_connected": true,
"state": "CONNECTED",
"type": "E1000",
"upt_compatibility_enabled": true,
"wake_on_lan_enabled": true
}
}
],
"parallel_ports": [
{
"key": "obj-103",
"value": {
"allow_guest_control": true,
"backing": {
"auto_detect": true,
"file": "string",
"host_device": "string",
"type": "FILE"
},
"label": "string",
"start_connected": true,
"state": "CONNECTED"
}
}
],
"power_state": "POWERED_OFF",
"sata_adapters": [
{
"key": "obj-103",
"value": {
"bus": 1,
"label": "string",
"pci_slot_number": 1,
"type": "AHCI"
}
}
],
"scsi_adapters": [
{
"key": "obj-103",
"value": {
"label": "string",
"pci_slot_number": 1,
"scsi": {
"bus": 1,
"unit": 1
},
"sharing": "NONE",
"type": "BUSLOGIC"
}
}
],
"serial_ports": [
{
"key": "obj-103",
"value": {
"allow_guest_control": true,
"backing": {
"auto_detect": true,
"file": "string",
"host_device": "string",
"network_location": "http://myurl.com",
"no_rx_loss": true,
"pipe": "string",
"proxy": "http://myurl.com",
"type": "FILE"
},
"label": "string",
"start_connected": true,
"state": "CONNECTED",
"yield_on_poll": true
}
}
]
}
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vcenter/VM" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<cdroms-array>
<array-item>
<value>
<ide>
<primary>true</primary>
<master>true</master>
</ide>
<sata>
<unit>1</unit>
<bus>1</bus>
</sata>
<state>CONNECTED</state>
<label>string</label>
<allow_guest_control>true</allow_guest_control>
<type>IDE</type>
<backing>
<device_access_type>EMULATION</device_access_type>
<auto_detect>true</auto_detect>
<iso_file>string</iso_file>
<type>ISO_FILE</type>
<host_device>string</host_device>
</backing>
<start_connected>true</start_connected>
</value>
<key>obj-103</key>
</array-item>
</cdroms-array>
<boot>
<network_protocol>IPV4</network_protocol>
<retry_delay>1</retry_delay>
<delay>1</delay>
<retry>true</retry>
<type>BIOS</type>
<enter_setup_mode>true</enter_setup_mode>
<efi_legacy_boot>true</efi_legacy_boot>
</boot>
<hardware>
<upgrade_version>VMX_03</upgrade_version>
<upgrade_policy>NEVER</upgrade_policy>
<upgrade_error class="exception">
</upgrade_error>
<upgrade_status>NONE</upgrade_status>
<version>VMX_03</version>
</hardware>
<boot_devices-array>
<array-item>
<nic>obj-103</nic>
<type>CDROM</type>
<disks-array>
<array-item>obj-103</array-item>
<array-item>obj-103</array-item>
</disks-array>
</array-item>
<array-item>
<nic>obj-103</nic>
<type>CDROM</type>
<disks-array>
<array-item>obj-103</array-item>
<array-item>obj-103</array-item>
</disks-array>
</array-item>
</boot_devices-array>
<scsi_adapters-array>
<array-item>
<value>
<pci_slot_number>1</pci_slot_number>
<scsi>
<unit>1</unit>
<bus>1</bus>
</scsi>
<sharing>NONE</sharing>
<label>string</label>
<type>BUSLOGIC</type>
</value>
<key>obj-103</key>
</array-item>
</scsi_adapters-array>
<power_state>POWERED_OFF</power_state>
<sata_adapters-array>
<array-item>
<value>
<pci_slot_number>1</pci_slot_number>
<bus>1</bus>
<label>string</label>
<type>AHCI</type>
</value>
<key>obj-103</key>
</array-item>
</sata_adapters-array>
<serial_ports-array>
<array-item>
<value>
<state>CONNECTED</state>
<label>string</label>
<allow_guest_control>true</allow_guest_control>
<yield_on_poll>true</yield_on_poll>
<backing>
<auto_detect>true</auto_detect>
<network_location>http://myurl.com</network_location>
<file>string</file>
<proxy>http://myurl.com</proxy>
<type>FILE</type>
<no_rx_loss>true</no_rx_loss>
<pipe>string</pipe>
<host_device>string</host_device>
</backing>
<start_connected>true</start_connected>
</value>
<key>obj-103</key>
</array-item>
</serial_ports-array>
<cpu>
<count>1</count>
<hot_remove_enabled>true</hot_remove_enabled>
<hot_add_enabled>true</hot_add_enabled>
<cores_per_socket>1</cores_per_socket>
</cpu>
<disks-array>
<array-item>
<value>
<scsi>
<unit>1</unit>
<bus>1</bus>
</scsi>
<ide>
<primary>true</primary>
<master>true</master>
</ide>
<sata>
<unit>1</unit>
<bus>1</bus>
</sata>
<capacity>1</capacity>
<label>string</label>
<type>IDE</type>
<backing>
<vmdk_file>string</vmdk_file>
<type>VMDK_FILE</type>
</backing>
</value>
<key>obj-103</key>
</array-item>
</disks-array>
<memory>
<size_MiB>1</size_MiB>
<hot_add_limit_MiB>1</hot_add_limit_MiB>
<hot_add_increment_size_MiB>1</hot_add_increment_size_MiB>
<hot_add_enabled>true</hot_add_enabled>
</memory>
<parallel_ports-array>
<array-item>
<value>
<state>CONNECTED</state>
<label>string</label>
<allow_guest_control>true</allow_guest_control>
<backing>
<auto_detect>true</auto_detect>
<file>string</file>
<type>FILE</type>
<host_device>string</host_device>
</backing>
<start_connected>true</start_connected>
</value>
<key>obj-103</key>
</array-item>
</parallel_ports-array>
<guest_OS>DOS</guest_OS>
<floppies-array>
<array-item>
<value>
<state>CONNECTED</state>
<label>string</label>
<allow_guest_control>true</allow_guest_control>
<backing>
<auto_detect>true</auto_detect>
<image_file>string</image_file>
<type>IMAGE_FILE</type>
<host_device>string</host_device>
</backing>
<start_connected>true</start_connected>
</value>
<key>obj-103</key>
</array-item>
</floppies-array>
<name>string</name>
<nics-array>
<array-item>
<value>
<pci_slot_number>1</pci_slot_number>
<mac_address>string</mac_address>
<upt_compatibility_enabled>true</upt_compatibility_enabled>
<mac_type>MANUAL</mac_type>
<state>CONNECTED</state>
<label>string</label>
<allow_guest_control>true</allow_guest_control>
<type>E1000</type>
<backing>
<connection_cookie>1</connection_cookie>
<opaque_network_type>string</opaque_network_type>
<distributed_switch_uuid>string</distributed_switch_uuid>
<network_name>string</network_name>
<distributed_port>string</distributed_port>
<type>STANDARD_PORTGROUP</type>
<opaque_network_id>string</opaque_network_id>
<network>obj-103</network>
<host_device>string</host_device>
</backing>
<wake_on_lan_enabled>true</wake_on_lan_enabled>
<start_connected>true</start_connected>
</value>
<key>obj-103</key>
</array-item>
</nics-array>
</value>
</ns0:Get-Result>

#### 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: 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 FREEBSD: FreeBSD FREEBSD_64: FreeBSD x64 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) 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) 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) 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) 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) 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) 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_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) VMKERNEL: VMware ESX 4 VMKERNEL_5: VMware ESX 5 VMKERNEL_6: VMware ESX 6 VMKERNEL_65: VMware ESX 6.5 OTHER: Other Operating System OTHER_64: Other Operating System (64 bit) (experimental)
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: POWERED_OFF: The virtual machine is powered off. POWERED_ON: The virtual machine is powered on. SUSPENDED: The virtual machine is suspended.
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: VMX_03: Hardware version 3. VMX_04: Hardware version 4. VMX_06: Hardware version 6. VMX_07: Hardware version 7. VMX_08: Hardware version 8. VMX_09: Hardware version 9. VMX_10: Hardware version 10. VMX_11: Hardware version 11. VMX_12: Hardware version 12. VMX_13: Hardware version 13.
value.hardware.upgrade_policy | string | Scheduled upgrade policy. Defines the valid virtual hardware upgrade policies for a virtual machine. Value is one of: NEVER: Do not upgrade the virtual machine when it is powered on. AFTER_CLEAN_SHUTDOWN: Run scheduled upgrade when the virtual machine is powered on after a clean shutdown of the guest operating system. ALWAYS: Run scheduled upgrade when the virtual machine is powered on.
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: VMX_03: Hardware version 3. VMX_04: Hardware version 4. VMX_06: Hardware version 6. VMX_07: Hardware version 7. VMX_08: Hardware version 8. VMX_09: Hardware version 9. VMX_10: Hardware version 10. VMX_11: Hardware version 11. VMX_12: Hardware version 12. VMX_13: Hardware version 13.Optional. It is only relevant when upgrade_policy has value [AFTER_CLEAN_SHUTDOWN, ALWAYS]. This field is optional and it is only relevant when the value of `upgrade_policy` is one of AFTER_CLEAN_SHUTDOWN or ALWAYS.
value.hardware.upgrade_status | string | Scheduled upgrade status. Defines the valid virtual hardware upgrade statuses for a virtual machine. Value is one of: NONE: No scheduled upgrade has been attempted. PENDING: Upgrade is scheduled but has not yet been run. SUCCESS: The most recent scheduled upgrade was successful. FAILED: The most recent scheduled upgrade was not successful.
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 `upgrade_status` is FAILED.
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: BIOS: Basic Input/Output System (BIOS) firmware. EFI: Extensible Firmware Interface (EFI) firmware.
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 `type` is EFI.
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: IPV4: PXE or Apple NetBoot over IPv4. IPV6: PXE over IPv6.Optional. It is only relevant when type has value EFI. This field is optional and it is only relevant when the value of `type` is EFI.
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: CDROM: Virtual CD-ROM device. DISK: Virtual disk device. ETHERNET: Virtual Ethernet adapter. FLOPPY: Virtual floppy drive.
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 `type` is ETHERNET.When clients pass a value of this structure as a parameter, the field 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 field will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Ethernet`.
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 `type` is DISK.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `com.vmware.vcenter.vm.hardware.Disk`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `com.vmware.vcenter.vm.hardware.Disk`.
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: `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": info}
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: IDE: Disk is attached to an IDE adapter. SCSI: Disk is attached to a SCSI adapter. SATA: Disk is attached to a SATA adapter.
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: VMDK_FILE: Virtual disk is backed by a VMDK file.
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 `type` is VMDK_FILE.
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: `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": info}
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: E1000: E1000 ethernet adapter. E1000E: E1000e ethernet adapter. PCNET32: AMD Lance PCNet32 Ethernet adapter. VMXNET: VMware Vmxnet virtual Ethernet adapter. VMXNET2: VMware Vmxnet2 virtual Ethernet adapter. VMXNET3: VMware Vmxnet3 virtual Ethernet adapter.
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 `type` is VMXNE_t3.
value.nics[].value.mac_type | string | MAC address type. Defines the valid MAC address origins for a virtual Ethernet adapter. Value is one of: MANUAL: MAC address is assigned statically. GENERATED: MAC address is generated automatically. ASSIGNED: MAC address is assigned by vCenter Server.
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: STANDARD_PORTGROUP: vSphere standard portgroup network backing. HOST_DEVICE: Legacy host device network backing. Imported VMs may have virtual Ethernet adapters with this type of backing, but this type of backing cannot be used to create or to update a virtual Ethernet adapter. DISTRIBUTED_PORTGROUP: Distributed virtual switch backing. OPAQUE_NETWORK: Opaque network backing.
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: `Network`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Network`.
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 `type` is STANDARD_PORTGROUP.
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 `type` is HOST_DEVICE.
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 `type` is DISTRIBUTED_PORTGROUP.
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 `type` is OPAQUE_NETWORK.
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 `type` is OPAQUE_NETWORK.
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: CONNECTED: The device is connected and working correctly. RECOVERABLE_ERROR: Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine. UNRECOVERABLE_ERROR: Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist. NOT_CONNECTED: The device is not connected. UNKNOWN: The device status is unknown.
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: `com.vmware.vcenter.vm.hardware.Cdrom`. 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.Cdrom`.List of {"key": string, "value": info}
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: IDE: Cdrom is attached to an IDE adapter. SATA: Cdrom is attached to a SATA adapter.
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 `type` is IDE.
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 `type` is SATA.
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: ISO_FILE: Virtual CD-ROM device is backed by an ISO file. HOST_DEVICE: Virtual CD-ROM device is backed by a device on the host where the virtual machine is running. CLIENT_DEVICE: Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.
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 `type` is ISO_FILE.
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 `auto_detect` is true and the virtual CD-ROM device is not connected or no suitable device is available on the host.
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 `type` is HOST_DEVICE.
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: EMULATION: ATAPI or SCSI device emulation. PASSTHRU: Raw passthru device access. PASSTHRU_EXCLUSIVE: Raw passthru device access, with exclusive access to the device.Optional. It is only relevant when type has value [HOST_DEVICE, CLIENT_DEVICE]. This field is optional and it is only relevant when the value of `type` is one of HOST_DEVICE or CLIENT_DEVICE.
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: CONNECTED: The device is connected and working correctly. RECOVERABLE_ERROR: Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine. UNRECOVERABLE_ERROR: Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist. NOT_CONNECTED: The device is not connected. UNKNOWN: The device status is unknown.
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: `com.vmware.vcenter.vm.hardware.Floppy`. 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.Floppy`.List of {"key": string, "value": info}
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: IMAGE_FILE: Virtual floppy drive is backed by an image file. HOST_DEVICE: Virtual floppy drive is backed by a device on the host where the virtual machine is running. CLIENT_DEVICE: Virtual floppy drive is backed by a device on the client that is connected to the virtual machine console.
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 `type` is IMAGE_FILE.
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 `auto_detect` is true and the virtual floppy drive is not connected or no suitable device is available on the host.
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 `type` is HOST_DEVICE.
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: CONNECTED: The device is connected and working correctly. RECOVERABLE_ERROR: Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine. UNRECOVERABLE_ERROR: Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist. NOT_CONNECTED: The device is not connected. UNKNOWN: The device status is unknown.
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: `com.vmware.vcenter.vm.hardware.ParallelPort`. 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.ParallelPort`.List of {"key": string, "value": info}
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: FILE: Virtual parallel port is backed by a file. HOST_DEVICE: Virtual parallel port is backed by a device on the host where the virtual machine is running.
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 `type` is FILE.
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 `auto_detect` is true and the virtual parallel port is not connected or no suitable device is available on the host.
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 `type` is HOST_DEVICE.
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: CONNECTED: The device is connected and working correctly. RECOVERABLE_ERROR: Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine. UNRECOVERABLE_ERROR: Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist. NOT_CONNECTED: The device is not connected. UNKNOWN: The device status is unknown.
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: `com.vmware.vcenter.vm.hardware.SerialPort`. 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.SerialPort`.List of {"key": string, "value": info}
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: FILE: Virtual serial port is backed by a file. HOST_DEVICE: Virtual serial port is backed by a device on the host where the virtual machine is running. PIPE_SERVER: Virtual serial port is backed by a named pipe server. The virtual machine will accept a connection from a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port. PIPE_CLIENT: Virtual serial port is backed by a named pipe client. The virtual machine will connect to the named pipe provided by a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port. NETWORK_SERVER: Virtual serial port is backed by a network server. This backing may be used to create a network-accessible serial port on the virtual machine, accepting a connection from a remote system. NETWORK_CLIENT: Virtual serial port is backed by a network client. This backing may be used to create a network-accessible serial port on the virtual machine, initiating a connection to a remote system.
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 `type` is FILE.
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 `auto_detect` is true and the virtual serial port is not connected or no suitable device is available on the host.
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 `type` is HOST_DEVICE.
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 `type` is one of PIPE_SERVER or PIPE_CLIENT.
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 `type` is one of PIPE_SERVER or PIPE_CLIENT.
value.serial_ports[].value.backing.network_location | URI | URI specifying the location of the network service backing the virtual serial port. If vcenter.vm.hardware.serial.backing_info.type is NETWORK_SERVER, this field is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running. If vcenter.vm.hardware.serial.backing_info.type is NETWORK_CLIENT, this field is the location used by the virtual machine to connect to the remote server. 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 `type` is one of NETWORK_SERVER or NETWORK_CLIENT.
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: CONNECTED: The device is connected and working correctly. RECOVERABLE_ERROR: Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine. UNRECOVERABLE_ERROR: Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist. NOT_CONNECTED: The device is not connected. UNKNOWN: The device status is unknown.
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: `com.vmware.vcenter.vm.hardware.SataAdapter`. 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.SataAdapter`.List of {"key": string, "value": info}
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: AHCI: AHCI host bus adapter.
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: `com.vmware.vcenter.vm.hardware.ScsiAdapter`. 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.ScsiAdapter`.List of {"key": string, "value": info}
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: BUSLOGIC: BusLogic host bus adapter. LSILOGIC: LSI Logic host bus adapter. LSILOGICSAS: LSI Logic SAS 1068 host bus adapter. PVSCSI: Paravirtualized host bus adapter.
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: NONE: The virtual SCSI bus is not shared. VIRTUAL: The virtual SCSI bus is shared between two or more virtual machines. In this case, no physical machine is involved. PHYSICAL: The virtual SCSI bus is shared between two or more virtual machines residing on different physical hosts.

#### 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.