New in version 2.5.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| folder |
Default: "/vm"
|
Destination folder, absolute or relative path to find an existing guest or create the new guest.
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
folder: vm/folder2
folder: folder2
|
|
force
bool (added in 2.5) |
|
Ignore warnings and complete the actions.
This parameter is useful while forcing virtual machine state.
|
|
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 support added in version 2.6.
|
|
| name |
Name of the virtual machine to work with.
Virtual machine names in vCenter are not necessarily unique, which may be problematic, see
name_match. |
|
| 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 support 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 support added in version 2.6.
|
| scheduled_at |
Date and time in string format at which specificed task needs to be performed.
The required format for date and time - 'dd/mm/yyyy hh:mm'.
Scheduling task requires vCenter server. A standalone ESXi server does not support this option.
|
|
| state |
|
Set the state of the virtual machine.
|
|
state_change_timeout
(added in 2.6) |
Default: 0
|
If the
state is set to shutdown-guest, by default the module will return immediately after sending the shutdown signal.If this argument is set to a positive integer, the module will instead wait for the VM to reach the poweredoff state.
The value sets a timeout in seconds for the module to wait for the state change.
|
|
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 support added in version 2.6.
aliases: admin, user |
|
| uuid |
UUID of the instance to manage if known, this is VMware's unique identifier.
This is required if name 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 support added in version 2.6.
If set to
yes, please make sure Python >= 2.7.9 is installed on the given machine. |
- name: Set the state of a virtual machine to poweroff
vmware_guest_powerstate:
hostname: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
folder: /testvms
name: testvm_2
state: powered-off
delegate_to: localhost
register: deploy
- name: Set the state of a virtual machine to poweroff at given scheduled time
vmware_guest_powerstate:
hostname: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
folder: /datacenter-1/vm/my_folder
name: testvm_2
state: powered-off
scheduled_at: "09/01/2018 10:18"
delegate_to: localhost
register: deploy_at_schedule_datetime
- name: Wait for the virtual machine to shutdown
vmware_guest_powerstate:
hostname: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
name: testvm_2
state: shutdown-guest
state_change_timeout: 200
delegate_to: localhost
register: deploy
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.