vcenter vm hardware boot: get
Returns the boot-related settings of a virtual machine.
Request:
HTTP request
GET https://{server}/rest/vcenter/vm/{vm}/hardware/boot
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| vm | string | Virtual machine identifier. |
Response:
HTTP Status Code: 200
Representations:
{
"value": {
"delay": 1,
"efi_legacy_boot": true,
"enter_setup_mode": true,
"network_protocol": "IPV4",
"retry": true,
"retry_delay": 1,
"type": "BIOS"
}
}
"value": {
"delay": 1,
"efi_legacy_boot": true,
"enter_setup_mode": true,
"network_protocol": "IPV4",
"retry": true,
"retry_delay": 1,
"type": "BIOS"
}
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vcenter/vm/hardware/boot" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<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>
</value>
</ns0:Get-Result>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vcenter/vm/hardware/boot" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<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>
</value>
</ns0:Get-Result>
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Boot-related settings of the virtual machine. |
| value.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.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.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.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.retry | boolean | Flag indicating whether the virtual machine will automatically retry the boot process after a failure. |
| value.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.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. |
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. |