New in version 2.7.
The below requirements are needed on the host that executes this module.
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 to True as this parameter is required. |
boot_retry_enabled bool |
| 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 bool |
| 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 str | 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 supported added in version 2.6. | |
name | Name of the VM to work with. This is required if uuid parameter is not supplied. | |
name_match |
| If multiple virtual machines matching the name, use the first or last found. |
password str | 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 supported added in version 2.6. aliases: pass, pwd | |
port int (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 supported added in version 2.6. |
username str | 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 supported added in version 2.6. aliases: admin, user | |
uuid | UUID of the instance to manage if known, this is VMware's BIOS UUID. This is required if name parameter is not supplied. | |
validate_certs bool |
| 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 supported added in version 2.6. If set to yes , please make sure Python >= 2.7.9 is installed on the given machine. |
Note
- 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 boot_order: - floppy - cdrom - ethernet - disk delegate_to: localhost register: vm_boot_order
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
vm_boot_status dict | always | metadata about boot order of virtual machine Sample: {'previous_boot_retry_enabled': True, 'current_boot_retry_enabled': True, 'current_boot_delay': 2000, 'previous_boot_delay': 10, 'current_enter_bios_setup': True, 'previous_enter_bios_setup': False, 'previous_boot_retry_delay': 10000, 'previous_boot_order': ['ethernet', 'cdrom', 'floppy', 'disk'], 'current_boot_order': ['floppy', 'disk', 'ethernet', 'cdrom'], 'previous_boot_firmware': 'bios', 'current_boot_retry_delay': 22300, 'current_boot_firmware': 'bios'} |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_guest_boot_manager_module.html