community.vmware.vmware_dvswitch_lacp module – Manage LACP configuration on a Distributed Switch

Note

This module is part of the community.vmware collection (version 5.2.0).

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_lacp.

Synopsis

  • This module can be used to configure Link Aggregation Control Protocol (LACP) support mode and Link Aggregation Groups (LAGs).

Parameters

Parameter

Comments

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.

list / elements=dictionary

Can only be used if support_mode=enhanced.

Default: []

string

Load balancing algorithm.

Valid values are as follows

  • srcTcpUdpPort: Source TCP/UDP port number.

  • srcDestIpTcpUdpPortVlan: Source and destination IP, source and destination TCP/UDP port number and VLAN.

  • srcIpVlan: Source IP and VLAN.

  • srcDestTcpUdpPort: Source and destination TCP/UDP port number.

  • srcMac: Source MAC address.

  • destIp: Destination IP.

  • destMac: Destination MAC address.

  • vlan: VLAN only.

  • srcDestIp: Source and Destination IP.

  • srcIpTcpUdpPortVlan: Source IP, TCP/UDP port number and VLAN.

  • srcDestIpTcpUdpPort: Source and destination IP and TCP/UDP port number.

  • srcDestMac: Source and destination MAC address.

  • destIpTcpUdpPort: Destination IP and TCP/UDP port number.

  • srcPortId: Source Virtual Port Id.

  • srcIp: Source IP.

  • srcIpTcpUdpPort: Source IP and TCP/UDP port number.

  • destIpTcpUdpPortVlan: Destination IP, TCP/UDP port number and VLAN.

  • destTcpUdpPort: Destination TCP/UDP port number.

  • destIpVlan: Destination IP and VLAN.

  • srcDestIpVlan: Source and destination IP and VLAN.

Please see examples for more information.

Default: "srcDestIpTcpUdpPortVlan"

string

The negotiating state of the uplinks/ports.

Choices:

  • "active"

  • "passive"

string

Name of the LAG.

integer

Number of uplinks.

Can 1 to 30.

password

aliases: pass, pwd

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.

port

integer

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.

Default: 443

proxy_host

string

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.

proxy_port

integer

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.

support_mode

string

The LACP support mode.

basic: One Link Aggregation Control Protocol group in the switch (singleLag).

enhanced: Multiple Link Aggregation Control Protocol groups in the switch (multipleLag).

Choices:

  • "basic" ← (default)

  • "enhanced"

switch

aliases: dvswitch

string / required

The name of the Distributed Switch to manage.

username

aliases: admin, user

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.

validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • You need to run the task two times if you want to remove all LAGs and change the support mode to ‘basic’

  • All modules requires API write access and hence is not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

Examples

- name: Enable enhanced mode on a Distributed Switch
  community.vmware.vmware_dvswitch_lacp:
    hostname: '{{ inventory_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch: dvSwitch
    support_mode: enhanced
    validate_certs: "{{ validate_vcenter_certs }}"
  delegate_to: localhost
  loop_control:
    label: "{{ item.name }}"
  with_items: "{{ vcenter_distributed_switches }}"

- name: Enable enhanced mode and create two LAGs on a Distributed Switch
  community.vmware.vmware_dvswitch_lacp:
    hostname: '{{ inventory_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch: dvSwitch
    support_mode: enhanced
    link_aggregation_groups:
        - name: lag1
          uplink_number: 2
          mode: active
          load_balancing_mode: srcDestIpTcpUdpPortVlan
        - name: lag2
          uplink_number: 2
          mode: passive
          load_balancing_mode: srcDestIp
    validate_certs: "{{ validate_vcenter_certs }}"
  delegate_to: localhost
  loop_control:
    label: "{{ item.name }}"
  with_items: "{{ vcenter_distributed_switches }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

string

information about performed operation

Returned: always

Sample: "{'changed': True, 'dvswitch': 'dvSwitch', 'link_aggregation_groups': [{'load_balancing_mode': 'srcDestIpTcpUdpPortVlan', 'mode': 'active', 'name': 'lag1', 'uplink_number': 2}, {'load_balancing_mode': 'srcDestIp', 'mode': 'active', 'name': 'lag2', 'uplink_number': 2}], 'link_aggregation_groups_previous': [], 'result': 'lacp lags changed', 'support_mode': 'enhanced'}"

Authors

  • Christian Kotte (@ckotte)