Documentation

vmware_vmotion - Move a virtual machine using vMotion

New in version 2.2.

Synopsis

  • Using VMware vCenter, move a virtual machine using vMotion to a different host.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • pyVmomi

Parameters

Parameter Choices/Defaults Comments
destination_host
required
Name of the end host the VM should be running on

aliases: destination
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.
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.
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
validate_certs
bool
    Choices:
  • no
  • yes ←
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.
vm_name
required
Name of the VM to perform a vMotion on

aliases: vm

Notes

Note

  • Tested on vSphere 6.0

Examples

# 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'

Return Values

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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

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.

Author

  • Bede Carroll (@bedecarroll)

Hint

If you notice any issues in this documentation you can edit this document to improve it.