vmware_guest_boot_facts - Gather facts about boot options for the given virtual machine
- This module can be used to gather facts aboyt boot options for the given virtual machine.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
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.
|
- name: Gather facts about virtual machine's boot order and related parameters
vmware_guest_boot_facts:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: no
name: "{{ vm_name }}"
register: vm_boot_order_facts
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
vm_boot_facts
dict
|
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'}
|
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.