W3cubDocs

/Ansible

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 (on host that executes module)

  • python >= 2.6
  • pyVmomi

Options

parameter required default choices comments
destination_host
 yes
Name of the end host the VM should be running on
aliases: destination
hostname
 yes
The hostname or IP address of the vSphere vCenter.
password
 yes
The password of the vSphere vCenter.
aliases: pass, pwd
username
 yes
The username of the vSphere vCenter.
aliases: user, admin
validate_certs
 no True
  • True
  • False
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
vm_name
 yes
Name of the VM to perform a vMotion on
aliases: vm

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 Common Return Values, the following are the fields unique to this module:

name description returned type sample
running_host List the host the virtual machine is registered to ['changed', 'success'] string host1.example.com

Notes

Note

Tested on vSphere 6.0

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/vmware_vmotion_module.html