# vmware_guest_boot_manager – Manage boot options for the given virtual machine

New in version 2.7.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## 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 integer | Default: 0 | Delay in milliseconds before starting the boot sequence.

boot_firmware
string

Choices:
- bios
- efi

Choose which firmware should be used to boot the virtual machine.

boot_order list | Default: [] | List of the boot devices.
boot_retry_delay integer | 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` to `True` as this parameter is required.

boot_retry_enabled
boolean

Choices:
- no ←
- yes

If set to `True`, the virtual machine that fails to boot, will try to boot again after `boot_retry_delay` is expired.
If set to `False`, the virtual machine waits indefinitely for user intervention.

enter_bios_setup
boolean

Choices:
- no ←
- yes

If set to `True`, the virtual machine automatically enters BIOS setup the next time it boots.
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 `VMWARE_HOST` will be used instead. Environment variable support added in Ansible 2.6.
moid string added in 2.9 |  | Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. This is required if `name` or `uuid` is not supplied.
name string |  | Name of the VM to work with. This is required if `uuid` or `moid` parameter is not supplied.

name_match
string

Choices:
- first ←
- last

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 `VMWARE_PASSWORD` will be used instead. Environment variable support added in Ansible 2.6. aliases: pass, pwd
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 `VMWARE_PORT` will be used instead. Environment variable support added in Ansible 2.6.
proxy_host string added in 2.9 |  | Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_HOST` will be used instead. This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port integer added in 2.9 |  | Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_PORT` will be used instead.

secure_boot_enabled
boolean
added in 2.8

Choices:
- no ←
- yes

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

Choices:
- no ←
- yes

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 `VMWARE_USER` will be used instead. Environment variable support added in Ansible 2.6. aliases: admin, user
uuid string |  | UUID of the instance to manage if known, this is VMware's BIOS UUID by default. This is required if `name` or `moid` parameter is not supplied.

validate_certs
boolean

Choices:
- no
- yes ←

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.
Environment variable support added in Ansible 2.6.
If set to `yes`, please make sure Python >= 2.7.9 is installed on the given machine.

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

    - name: Change virtual machine's boot order using Virtual Machine MoID
      vmware_guest_boot_manager:
        hostname: "{{ vcenter_hostname }}"
        username: "{{ vcenter_username }}"
        password: "{{ vcenter_password }}"
        moid: vm-42
        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) <akasurde@redhat.com>

Hint

If you notice any issues in this documentation, you can edit this document to improve it.