New in version 2.2.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
destination_host
required |
|
Name of the end host the VM should be running on
aliases: destination |
hostname
|
|
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.
|
password
|
|
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
(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
|
|
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: user, admin |
validate_certs
|
True
|
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.
|
vm_name
required |
|
Name of the VM to perform a vMotion on
aliases: vm |
Note
# Example from Ansible playbook
- name: Perform vMotion of VM
local_action:
module: vmware_vmotion
hostname: 'vcenter_hostname'
username: 'vcenter_username'
password: 'vcenter_password'
validate_certs: False
vm_name: 'vm_name_as_per_vcenter'
destination_host: 'destination_host_as_per_vcenter'
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
running_host
string
|
changed or success |
List the host the virtual machine is registered to
Sample:
host1.example.com
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.