community.vmware.vmware_dvswitch_lacp (4.2.0) — module

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Inputs

    
port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

switch:
    aliases:
    - dvswitch
    description:
    - The name of the Distributed Switch to manage.
    required: true
    type: str

hostname:
    description:
    - 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 E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

proxy_host:
    description:
    - 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 E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - 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 E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

support_mode:
    choices:
    - basic
    - enhanced
    default: basic
    description:
    - The LACP support mode.
    - 'V(basic): One Link Aggregation Control Protocol group in the switch (singleLag).'
    - 'V(enhanced): Multiple Link Aggregation Control Protocol groups in the switch (multipleLag).'
    type: str

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

link_aggregation_groups:
    default: []
    description:
    - Can only be used if O(support_mode=enhanced).
    elements: dict
    suboptions:
      load_balancing_mode:
        default: srcDestIpTcpUdpPortVlan
        description:
        - 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.
        type: str
      mode:
        choices:
        - active
        - passive
        description:
        - The negotiating state of the uplinks/ports.
        type: str
      name:
        description: Name of the LAG.
        type: str
      uplink_number:
        description:
        - Number of uplinks.
        - Can 1 to 30.
        type: int
    type: list

Outputs

result:
  description: 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
  type: str