Vcenter Vm Hardware Boot get

Vcenter Vm Hardware Boot get

Returns the boot-related settings of a virtual machine.

Request
URI
GET
https://{api_host}/api/vcenter/vm/{vm}/hardware/boot
COPY
Path Parameters
string
vm
Required

Virtual machine identifier.

The parameter must be an identifier for the resource type: VirtualMachine.

Authentication
This operation uses the following authentication methods.
Responses
200

Boot-related settings of the virtual machine.

Returns Vcenter Vm Hardware Boot Info of type(s) application/json 
{
    "type": "string",
    "efi_legacy_boot": false,
    "network_protocol": "string",
    "delay": 0,
    "retry": false,
    "retry_delay": 0,
    "enter_setup_mode": false
}
string
type
Required

Firmware type used by the virtual machine.

For more information see: Vcenter Vm Hardware Boot Type.

boolean
efi_legacy_boot
Optional

Flag indicating whether to use EFI legacy boot mode.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Boot Type.EFI.

string
network_protocol
Optional

Protocol to use when attempting to boot the virtual machine over the network.

For more information see: Vcenter Vm Hardware Boot NetworkProtocol.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Boot Type.EFI.

integer As int64 As int64
delay
Required

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.

boolean
retry
Required

Flag indicating whether the virtual machine will automatically retry the boot process after a failure.

integer As int64 As int64
retry_delay
Required

Delay in milliseconds before retrying the boot process after a failure; applicable only when Vcenter Vm Hardware Boot Info.retry is true.

boolean
enter_setup_mode
Required

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.


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

404

if the virtual machine is not found.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

Vapi Std Errors Error if the system reports an error while responding to the request.

Vapi Std Errors ResourceInaccessible if the virtual machine's configuration state cannot be accessed.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/vm/{vm}/hardware/boot
On This Page
Vcenter Operations
GET
Vcenter Vm Hardware Boot get
PATCH
Vcenter Vm Hardware Boot update