Advanced Load Balancer (formerly Avi) Ansible Collection

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.9.10.

Python Support

• Collection supports >= 3.5

Installation and Usage

Ansible must be installed

pip install ansible

Install ALB collection using ansible-galaxy CLI:

ansible-galaxy collection install vmware.alb

Install ALB collection using requirements.yml file:

Create requirements.yml file using below contents

collections:
- name: vmware.alb

Install the collection:

ansible-galaxy collection install -r requirements.yml

Required Python libraries

ALB collection depends upon following third party libraries:

• ovftool Please downlod the ovftool from: https://www.vmware.com/support/developer/ovf

How to install ovftool

cd /home/user/downloads
chmod 755 VMware-ovftool-4.4.0-15722219-lin.x86_64.bundle
sudo ./VMware-ovftool-4.4.0-15722219-lin.x86_64.bundle

Installing required libraries

After ALB collection installation we need to install the required python libraries using following command:

pip install -r ~/.ansible/collections/ansible_collections/vmware/alb/requirements.txt

Modules

Testing with ansible-test

Refer testing for more information.

Publishing New Version

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  tasks:
    - name: Example to create a Pool object
      avi_pool:
        avi_credentials:
          username: "admin"
          password: "something"
          controller: "192.168.15.18"
          api_version: "21.1.1"
        name: app1-pool
        lb_algorithm: LB_ALGORITHM_LEAST_LOAD
        servers:
        - ip:
             addr: "192.168.12.15"
             type: 'V4'

Example usage of external credentials/variable file while using alb module

# creds.yml
avi_credentials:
    controller: "192.168.1.11"
    username: "admin"
    password: "password"
    api_version: 20.1.5

# example.yml
- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars_files:
    - creds.yml
  tasks:
    - name: Example to create a Pool object
      avi_pool:
        avi_credentials: "{{ avi_credentials |  default(omit) }}"
        name: app1-pool
        lb_algorithm: LB_ALGORITHM_LEAST_LOAD
        servers:
        - ip:
             addr: "192.168.12.15"
             type: 'V4'

Example for using aviconfig role:

# config.yml
avi_config:
  pool:
    - name: role1-pool
      lb_algorithm: LB_ALGORITHM_LEAST_LOAD
      servers:
        - ip:
             addr: 192.160.1.10
             type: 'V4'

# collection.yml
- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  tasks:
    - name: Create pool using aviconfig role
      import_role:
        name: aviconfig
      vars:
          avi_config_file: "config.yml"
          avi_creds_file: "creds.yml"
          # avi_creds_file parameter is only valid for aviconfig role.
          # For importing credentials from external file in modules,
          # please use vars_files parameter as shown in previous example

Notes Please use Python >= 3.8 if you are using avi_serviceenginegroup module as it has more than 255 arguments