community.vmware.vmware_vm_config_option module – Return supported guest ID list and VM recommended config option for specific guest OS
Note
This module is part of the community.vmware collection (version 4.8.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 community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_vm_config_option
.
Synopsis
This module is used for getting the hardware versions supported for creation, the guest ID list supported by ESXi host for the most recent virtual hardware supported or specified hardware version, the VM recommended config options for specified guest OS ID.
Parameters
Parameter |
Comments |
---|---|
Name of the cluster. If |
|
The datacenter name used to get specified cluster or host. Default: |
|
ESXi hostname. Obtain VM configure options on this ESXi host. If |
|
Return the dict of VM recommended config options for guest ID specified by When set to Choices:
|
|
Return the list of guest OS IDs supported on the specified entity. If Choices:
|
|
Return the list of VM hardware versions supported for creation and the default hardware version on the specified entity. Choices:
|
|
The guest OS ID from the returned list when This parameter must be set when |
|
The hardware version from the returned list when |
|
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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
Known issue on vSphere 7.0 (https://github.com/vmware/pyvmomi/issues/915)
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Get supported guest ID list on given ESXi host for with default hardware version
community.vmware.vmware_vm_config_option:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: "{{ esxi_hostname }}"
get_guest_os_ids: true
delegate_to: localhost
- name: Get VM recommended config option for Windows 10 guest OS on given ESXi host
community.vmware.vmware_vm_config_option:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: "{{ esxi_hostname }}"
get_config_options: true
guest_id: "windows9_64Guest"
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
metadata about the VM recommended configuration Returned: always Sample: |