Parameter |
Choices/Defaults |
Comments |
disk
list
/ elements=dictionary
|
|
A list of disks with storage profile policies to enforce.
All values and parameters are case sensitive.
At least one of disk and vm_home are required parameters.
|
|
policy
string
/ required
|
|
Name of the storage profile policy to enforce for the disk.
|
|
unit_number
integer
/ required
|
|
Disk Unit Number.
Valid values range from 0 to 15.
|
folder
string
|
|
Destination folder, absolute or relative path to find an existing guest.
This is a required parameter if multiple VMs are found with same name.
The folder should include the datacenter. ESX'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
|
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
|
|
Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance.
One of name , uuid , or moid are required to define the virtual machine.
|
name
string
|
|
Name of the virtual machine.
One of name , uuid , or moid are required to define the virtual machine.
|
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
|
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
|
|
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
|
|
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.
|
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 virtual machine.
One of name , uuid , or moid are required to define the virtual machine.
|
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 true , please make sure Python >= 2.7.9 is installed on the given machine.
|
vm_home
string
|
|
A storage profile policy to set on VM Home.
All values and parameters are case sensitive.
At least one of disk or vm_home are required parameters.
|