Documentation

vmware_migrate_vmk - Migrate a VMK interface from VSS to VDS

New in version 2.0.

Synopsis

  • Migrate a VMK interface from VSS to VDS

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
current_portgroup_name
required
Portgroup name VMK interface is currently on
current_switch_name
required
Switch VMK interface is currently on
device
required
VMK interface name
esxi_hostname
required
ESXi hostname to be managed
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.
migrate_portgroup_name
required
Portgroup name to migrate VMK interface to
migrate_switch_name
required
Switch name to migrate VMK interface to
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.

Notes

Note

  • Tested on vSphere 5.5

Examples

# Example from Ansible playbook

    - name: Migrate Management vmk
      local_action:
        module: vmware_migrate_vmk
        hostname: vcsa_host
        username: vcsa_user
        password: vcsa_pass
        esxi_hostname: esxi_hostname
        device: vmk1
        current_switch_name: temp_vswitch
        current_portgroup_name: esx-mgmt
        migrate_switch_name: dvSwitch
        migrate_portgroup_name: Management

Status

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

Author

  • Joseph Callen (@jcpowermac)
  • Russell Teague (@mtnbikenc)

Hint

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