community.vmware.vmware_dvswitch module – Create or remove a Distributed Switch
Note
This module is part of the community.vmware collection (version 3.11.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.vmware.
To use it in a playbook, specify: community.vmware.vmware_dvswitch.
Synopsis
This module can be used to create, remove a Distributed Switch.
Parameters
Parameter |
Comments |
|---|---|
Dictionary which configures administrator contact name and description for the Distributed Switch. |
|
Description or other details. |
|
Administrator name. |
|
The name of the datacenter that will contain the Distributed Switch. This parameter is optional, if Mutually exclusive with |
|
Description of the Distributed Switch. |
|
Select the discovery operation. Required parameter for Required only if Choices:
|
|
Link discovery protocol between Cisco and Link Layer discovery. Required parameter for Required only if
Choices:
|
|
Destination folder, absolute path to place dvswitch in. The folder should include the datacenter. This parameter is case sensitive. This parameter is optional, if Examples:
|
|
Dictionary which configures Health Check for the Distributed Switch. Default: |
|
Teaming and failover health check. Choices:
|
|
Teaming and failover health check interval (minutes). The default value is 1 in the vSphere Client if the Teaming and failover health check is enabled. Default: |
|
VLAN and MTU health check. Choices:
|
|
VLAN and MTU health check interval (minutes). The default value is 1 in the vSphere Client if the VLAN and MTU health check is enabled. Default: |
|
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 Environment variable support added in Ansible 2.6. |
|
The switch maximum transmission unit. Required parameter for Required only if Accepts value between 1280 to 9000 (both inclusive). Default: |
|
The multicast filtering mode.
Choices:
|
|
Dictionary which configures the Net Flow for the Distributed Switch. Default: |
|
The time, in seconds, to wait before sending information after the flow is initiated. Default: |
|
The IP Address (IPv4 or IPv6) of the NetFlow collector. |
|
The Port of the NetFlow collector. Default: |
|
The time, in seconds, to wait before sending information after the flow is initiated. Default: |
|
If True, data on network activity between vms on the same host will be collected only. Choices:
|
|
Identifies the information related to the switch. Default: |
|
The portion of data that the switch collects. The sampling rate represents the number of packets that NetFlow drops after every collected packet. If the rate is 0, NetFlow samples every packet, that is, collect one packet and drop none. If the rate is 1, NetFlow samples a packet and drops the next one, and so on. Default: |
|
Dictionary which configures the different default security values for portgroups. If set, these options are inherited by the portgroups of the DVS. |
|
Indicates whether forged transmits are allowed. Choices:
|
|
Indicates whether mac changes are allowed. Choices:
|
|
Indicates whether promiscuous mode is allowed. Choices:
|
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: |
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
If set to If set to Choices:
|
|
The name of the distribute vSwitch to create or remove. |
|
The version of the Distributed Switch to create. The version must match the version of the ESXi hosts you want to connect. The version of the vCenter server is used if not specified. Required only if |
|
The prefix used for the naming of the uplinks. Only valid if the Distributed Switch will be created. Not used if the Distributed Switch is already present. Uplinks are created as Uplink 1, Uplink 2, etc. pp. by default. Default: |
|
Quantity of uplink per ESXi host added to the Distributed Switch. The uplink quantity can be increased or decreased, but a decrease will only be successfull if the uplink isn’t used by a portgroup. Required parameter for Required only if |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Create dvSwitch
community.vmware.vmware_dvswitch:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter: '{{ datacenter }}'
switch: dvSwitch
version: 6.0.0
mtu: 9000
uplink_quantity: 2
discovery_protocol: lldp
discovery_operation: both
state: present
delegate_to: localhost
- name: Create dvSwitch with all options
community.vmware.vmware_dvswitch:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter: '{{ datacenter }}'
switch: dvSwitch
version: 6.5.0
mtu: 9000
uplink_quantity: 2
uplink_prefix: 'Uplink_'
discovery_protocol: cdp
discovery_operation: both
multicast_filtering_mode: snooping
health_check:
vlan_mtu: true
vlan_mtu_interval: 1
teaming_failover: true
teaming_failover_interval: 1
net_flow:
collector_ip: 192.168.10.50
collector_port: 50034
observation_domain_id: 0
active_flow_timeout: 60
idle_flow_timeout: 15
sampling_rate: 4096
internal_flows_only: false
state: present
delegate_to: localhost
- name: Delete dvSwitch
community.vmware.vmware_dvswitch:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter: '{{ datacenter }}'
switch: dvSwitch
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
information about performed operation Returned: always Sample: |