Docs4dev
Docs
ansible / 2.5 / modules / vmware_vm_vss_dvs_migrate_module.html

vmware_vm_vss_dvs_migrate - Migrates a virtual machine from a standard vswitch to distributed

New in version 2.0.

Synopsis

  • Migrates a virtual machine from a standard vswitch to distributed

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
dvportgroup_name
required
Name of the portgroup to migrate to the virtual machine to
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
    Choices:
  • no
  • yes
Default:
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 virtual machine to migrate to a dvSwitch

Notes

Note

  • Tested on vSphere 5.5

Examples

- name: Migrate VCSA to vDS
  local_action:
    module: vmware_vm_vss_dvs_migrate
    hostname: vcenter_ip_or_hostname
    username: vcenter_username
    password: vcenter_password
    vm_name: virtual_machine_name
    dvportgroup_name: distributed_portgroup_name

Status

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

Author

  • Joseph Callen (@jcpowermac)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/vmware_vm_vss_dvs_migrate_module.html