vmware_dvs_host – Add or remove a host from distributed virtual switch — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# vmware_dvs_host – Add or remove a host from distributed virtual switch

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## 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 string / required |  | The ESXi hostname.
hostname string |  | 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 support added in Ansible 2.6.
password string |  | 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 support added in Ansible 2.6. aliases: pass, pwd
port integer 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 support added in Ansible 2.6.
proxy_host string added in 2.9 |  | Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_HOST` will be used instead. This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port integer added in 2.9 |  | Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_PORT` will be used instead.
state string / required | Choices: present ← absent | If the host should be present or absent attached to the vSwitch.
switch_name string / required |  | The name of the Distributed vSwitch.
username string |  | 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 support added in Ansible 2.6. aliases: admin, user
validate_certs boolean | Choices: no yes ← | 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 support added in Ansible 2.6. If set to `yes`, please make sure Python >= 2.7.9 is installed on the given machine.
vendor_specific_config list added in 2.9 |  | List of key,value dictionaries for the Vendor Specific Configuration. Element attributes are: - `key` (str): Key of setting. (default: None) - `value` (str): Value of setting. (default: None)
vmnics list / required |  | The ESXi hosts vmnics to use with the Distributed vSwitch.

## Notes

Note

- Tested on vSphere 5.5

## Examples

    - name: Add Host to dVS
      vmware_dvs_host:
        hostname: '{{ vcenter_hostname }}'
        username: '{{ vcenter_username }}'
        password: '{{ vcenter_password }}'
        esxi_hostname: '{{ esxi_hostname }}'
        switch_name: dvSwitch
        vmnics:
            - vmnic0
            - vmnic1
        state: present
      delegate_to: localhost

    - name: Add Host to dVS/enable learnswitch (https://labs.vmware.com/flings/learnswitch)
      vmware_dvs_host:
        hostname: '{{ vcenter_hostname }}'
        username: '{{ vcenter_username }}'
        password: '{{ vcenter_password }}'
        esxi_hostname: '{{ esxi_hostname }}'
        switch_name: dvSwitch
        vendor_specific_config:
            - key: com.vmware.netoverlay.layer1
              value: learnswitch
        vmnics:
            - vmnic0
            - vmnic1
        state: present
      delegate_to: localhost

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Joseph Callen (@jcpowermac)
- Abhijeet Kasurde (@Akasurde)
- Joseph Andreatta (@vmwjoseph)

Hint

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