vmware_dvswitch - Create or remove a distributed vSwitch¶

New in version 2.0.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

Synopsis ¶

Create or remove a distributed vSwitch

Requirements ¶

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

python >= 2.6
PyVmomi

Parameters ¶

Parameter	Choices/Defaults	Comments
datacenter_name required		The name of the datacenter that will contain the dvSwitch
discovery_operation	Choices: both none advertise listen	Select the discovery operation
discovery_proto required	Choices: cdp lldp	Link discovery protocol between Cisco and Link Layer discovery
hostname str		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.
mtu required		The switch maximum transmission unit
password str		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 int (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	Choices: present ← absent	Create or remove dvSwitch
switch_name required		The name of the switch to create or remove
switch_version (added in 2.5)		The version of the switch to create. Can be 6.5.0, 6.0.0, 5.5.0, 5.1.0, 5.0.0 with a vcenter running vSphere 6.5 Needed if you have a vcenter version > ESXi version to join DVS. If not specified version=version of vcenter
uplink_quantity required		Quantity of uplink per ESXi host added to the switch
username str		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: admin, user
validate_certs bool	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 supported added in version 2.6. If set to `yes`, please make sure Python >= 2.7.9 is installed on the given machine.

Notes ¶

Note

Tested on vSphere 6.5

Examples ¶

- name: Create dvswitch
  vmware_dvswitch:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
    switch_name: dvSwitch
    switch_version: 6.0.0
    mtu: 9000
    uplink_quantity: 2
    discovery_proto: lldp
    discovery_operation: both
    state: present
  delegate_to: localhost

Status ¶

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

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Joseph Callen (@jcpowermac)

Hint

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