vmware.vmware_rest.vcenter_vm_hardware_boot module – Updates the boot-related settings of a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_hardware_boot.

New in vmware.vmware_rest 0.1.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Updates the boot-related settings of a virtual machine.

Requirements

The below requirements are needed on the host that executes this module.

vSphere 7.0.3 or greater
python >= 3.6
aiohttp

Parameters

Parameter	Comments
delay integer	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. If unset, the value is unchanged.
efi_legacy_boot boolean	Flag indicating whether to use EFI legacy boot mode. If unset, the value is unchanged. Choices: `false` `true`
enter_setup_mode boolean	Flag indicating whether the firmware boot process should 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. If unset, the value is unchanged. Choices: `false` `true`
network_protocol string	The network_protocol enumerated type defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network. Choices: `"IPV4"` `"IPV6"`
retry boolean	Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If unset, the value is unchanged. Choices: `false` `true`
retry_delay integer	Delay in milliseconds before retrying the boot process after a failure; applicable only when retry is true. If unset, the value is unchanged.
session_timeout float added in vmware.vmware_rest 2.1.0	Timeout settings for client session. The maximal number of seconds for the whole operation including connection establishment, request sending and response. The default value is 300s.
state string	Choices: `"present"` ← (default)
type string	The type enumerated type defines the valid firmware types for a virtual machine. Choices: `"BIOS"` `"EFI"`
vcenter_hostname string / required	The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable `VMWARE_HOST` will be used instead.
vcenter_password string / required	The vSphere vCenter password If the value is not specified in the task, the value of environment variable `VMWARE_PASSWORD` will be used instead.
vcenter_rest_log_file string	You can use this optional parameter to set the location of a log file. This file will be used to record the HTTP REST interaction. The file will be stored on the host that runs the module. If the value is not specified in the task, the value of environment variable `VMWARE_REST_LOG_FILE` will be used instead.
vcenter_username string / required	The vSphere vCenter username If the value is not specified in the task, the value of environment variable `VMWARE_USER` will be used instead.
vcenter_validate_certs boolean	Allows connection when SSL certificates are not valid. Set to `false` when certificates are not trusted. If the value is not specified in the task, the value of environment variable `VMWARE_VALIDATE_CERTS` will be used instead. Choices: `false` `true` ← (default)
vm string / required	Virtual machine identifier. The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.

Notes

Note

Tested on vSphere 7.0.3

Examples

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Change a VM boot parameters
  vmware.vmware_rest.vcenter_vm_hardware_boot:
    vm: '{{ test_vm1_info.id }}'
    efi_legacy_boot: true
    type: EFI
  register: _result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
id dictionary	moid of the resource Returned: On success
value dictionary	Change a VM boot parameters Returned: On success Sample: `{}`

Authors

Ansible Cloud Team (@ansible-collections)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/vmware/vmware_rest/vcenter_vm_hardware_boot_module.html