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
required
The hostname or IP address of the vSphere vCenter.
password
required
The password of the vSphere vCenter.

aliases: pass, pwd
port
(added in 2.5)
Default:
443
The port number of the vSphere vCenter or ESXi server.
username
required
The username of the vSphere vCenter.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
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.

Author

  • Bede Carroll (@bedecarroll)

Hint

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