Parameter |
Choices/Defaults |
Comments |
datacenter
string
|
Default:
"ha-datacenter"
|
The datacenter name to which virtual machine belongs to.
This parameter is case sensitive.
|
display_number
integer
|
|
The number of display. Valid value from 1 to 10. The maximum display number is 4 on vCenter 6.0, 6.5 web UI.
|
enable_3D
boolean
|
|
Enable 3D for guest operating systems on which VMware supports 3D.
|
folder
string
|
|
Destination folder, absolute or relative path to find an existing guest.
This is a required parameter, only if multiple VMs are found with same name.
The folder should include the datacenter. ESXi server's datacenter is ha-datacenter.
Examples:
folder: /ha-datacenter/vm
folder: ha-datacenter/vm
folder: /datacenter1/vm
folder: datacenter1/vm
folder: /datacenter1/vm/folder1
folder: datacenter1/vm/folder1
folder: /folder1/datacenter1/vm
folder: folder1/datacenter1/vm
folder: /folder1/datacenter1/vm/folder2
|
gather_video_facts
boolean
|
|
If set to True, return settings of the video card, other attributes are ignored.
If set to False, will do reconfiguration and return video card settings.
|
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.
|
memory_3D_mb
integer
|
|
The value of 3D Memory must be power of 2 and valid value is from 32 MB to 2048 MB.
|
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 virtual machine.
This is a required parameter, if parameter uuid or moid is not supplied.
|
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.
|
renderer_3D
string
|
Choices:
- automatic
- software
- hardware
|
If set to automatic , selects the appropriate option (software or hardware) for this virtual machine automatically.
If set to software , uses normal CPU processing for 3D calculations.
If set to hardware , requires graphics hardware (GPU) for faster 3D calculations.
|
use_auto_detect
boolean
|
|
If set to True, applies common video settings to the guest operating system, attributes display_number and video_memory_mb are ignored.
If set to False, the number of display and the total video memory will be reconfigured using display_number and video_memory_mb .
|
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 gather facts if known, this is VMware's unique identifier.
This is a required parameter, if parameter name or moid is not supplied.
|
validate_certs
boolean
|
|
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.
|
video_memory_mb
float
|
|
Valid total MB of video memory range of virtual machine is from 1.172 MB to 256 MB on ESXi 6.7U1, from 1.172 MB to 128 MB on ESXi 6.7 and previous versions.
For specific guest OS, supported minimum and maximum video memory are different, please be careful on setting this.
|