vmware_guest_boot_manager – Manage boot options for the given virtual machine
vmware_guest_boot_manager – Manage boot options for the given virtual machine
New in version 2.7.
Synopsis
- This module can be used to manage boot options for the given virtual machine.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
boot_delay - |
Default: 0 |
Delay in milliseconds before starting the boot sequence. |
boot_firmware - |
|
Choose which firmware should be used to boot the virtual machine. |
boot_order - |
Default: [] |
List of the boot devices. |
boot_retry_delay - |
Default: 0 |
Specify the time in milliseconds between virtual machine boot failure and subsequent attempt to boot again. If set, will automatically set |
boot_retry_enabled boolean |
|
If set to If set to |
enter_bios_setup boolean |
|
If set to The virtual machine resets this flag, so that the machine boots proceeds normally. |
hostname string |
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. | |
name - |
Name of the VM to work with. This is required if | |
name_match - |
|
If multiple virtual machines matching the name, use the first or last found. |
password string |
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
port integer added in 2.5 |
Default: 443 |
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
secure_boot_enabled boolean added in 2.8 |
|
Choose if EFI secure boot should be enabled. EFI secure boot can only be enabled with boot_firmware = efi |
use_instance_uuid boolean added in 2.8 |
|
Whether to use the VMWare instance UUID rather than the BIOS UUID. |
username string |
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
uuid - |
UUID of the instance to manage if known, this is VMware's BIOS UUID by default. This is required if | |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
Notes
Note
- Tested on vSphere 6.5
Examples
- name: Change virtual machine's boot order and related parameters
vmware_guest_boot_manager:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
name: testvm
boot_delay: 2000
enter_bios_setup: True
boot_retry_enabled: True
boot_retry_delay: 22300
boot_firmware: bios
secure_boot_enabled: False
boot_order:
- floppy
- cdrom
- ethernet
- disk
delegate_to: localhost
register: vm_boot_order
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
vm_boot_status dictionary |
always |
metadata about boot order of virtual machine
Sample: {'current_boot_order': ['floppy', 'disk', 'ethernet', 'cdrom'], 'current_boot_delay': 2000, 'current_boot_retry_delay': 22300, 'current_boot_retry_enabled': True, 'current_enter_bios_setup': True, 'current_boot_firmware': 'bios', 'current_secure_boot_enabled': False, 'previous_boot_delay': 10, 'previous_boot_retry_delay': 10000, 'previous_boot_retry_enabled': True, 'previous_enter_bios_setup': False, 'previous_boot_firmware': 'efi', 'previous_secure_boot_enabled': True, 'previous_boot_order': ['ethernet', 'cdrom', 'floppy', 'disk']} |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Abhijeet Kasurde (@Akasurde) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vmware_guest_boot_manager_module.html