vmware_dvs_host - Add or remove a host from distributed virtual switch

New in version 2.0.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
- Author

Synopsis

Manage a host system from distributed virtual switch.

Requirements

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

python >= 2.7
PyVmomi

Parameters

Parameter	Choices/Defaults	Comments
esxi_hostname required		The ESXi hostname.
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.
state required	Choices: present ← absent	If the host should be present or absent attached to the vSwitch.
switch_name required		The name of the Distributed vSwitch.
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.
vmnics required		The ESXi hosts vmnics to use with the Distributed vSwitch.

Notes

Note

Tested on vSphere 5.5

Examples

- name: Add Host to dVS
  local_action:
    module: vmware_dvs_host
    hostname: vcenter_ip_or_hostname
    username: vcenter_username
    password: vcenter_password
    esxi_hostname: esxi_hostname_as_listed_in_vcenter
    switch_name: dvSwitch
    vmnics:
        - vmnic0
        - vmnic1
    state: present

Status

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

Author

Joseph Callen (@jcpowermac)
Abhijeet Kasurde (@akasurde)

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_dvs_host_module.html