alb

136Modules9Roles6Plugins

Overview

Description

VMware Advanced Load Balancer (formerly Avi) Ansible Collection

Readme

Advanced Load Balancer (formerly Avi) Ansible Collection

Apache licensed Collection CI

Ansible version compatibility

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

Python Support

  • Collection supports >= 3.5

Installation and Usage

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

NameDescription
vmware.alb.avi_actiongroupconfigModule to create update or delete ActionGroupConfig
vmware.alb.avi_albservicesconfigModule to create update or delete ALBServicesConfig
vmware.alb.avi_albservicesfiledownloadModule to create update or delete ALBServicesFileDownload
vmware.alb.avi_albservicesfileuploadModule to create update or delete ALBServicesFileUpload
vmware.alb.avi_albservicesjobModule to create update or delete ALBServicesJob
vmware.alb.avi_alertconfigModule to create update or delete AlertConfig
vmware.alb.avi_alertemailconfigModule to create update or delete AlertEmailConfig
vmware.alb.avi_alertscriptconfigModule to create update or delete AlertScriptConfig
vmware.alb.avi_alertsyslogconfigModule to create update or delete AlertSyslogConfig
vmware.alb.avi_analyticsprofileModule to create update or delete AnalyticsProfile
vmware.alb.avi_api_fileserviceModule to create update or delete ApiFileservice
vmware.alb.avi_api_imageModule to create update or delete ApiImage
vmware.alb.avi_api_sessionModule to create update or delete ApiSession
vmware.alb.avi_api_versionModule to create update or delete ApiVersion
vmware.alb.avi_applicationpersistenceprofileModule to create update or delete ApplicationPersistenceProfile
vmware.alb.avi_applicationprofileModule to create update or delete ApplicationProfile
vmware.alb.avi_authmappingprofileModule to create update or delete AuthMappingProfile
vmware.alb.avi_authprofileModule to create update or delete AuthProfile
vmware.alb.avi_autoscalelaunchconfigModule to create update or delete AutoScaleLaunchConfig
vmware.alb.avi_availabilityzoneModule to create update or delete AvailabilityZone
vmware.alb.avi_backupModule to create update or delete Backup
vmware.alb.avi_backupconfigurationModule to create update or delete BackupConfiguration
vmware.alb.avi_bootstrap_controllerModule to create update or delete BootstrapController
vmware.alb.avi_botconfigconsolidatorModule to create update or delete BotConfigConsolidator
vmware.alb.avi_botdetectionpolicyModule to create update or delete BotDetectionPolicy
vmware.alb.avi_botipreputationtypemappingModule to create update or delete BotIPReputationTypeMapping
vmware.alb.avi_botmappingModule to create update or delete BotMapping
vmware.alb.avi_certificatemanagementprofileModule to create update or delete CertificateManagementProfile
vmware.alb.avi_cloudModule to create update or delete Cloud
vmware.alb.avi_cloudconnectoruserModule to create update or delete CloudConnectorUser
vmware.alb.avi_cloudpropertiesModule to create update or delete CloudProperties
vmware.alb.avi_clusterModule to create update or delete Cluster
vmware.alb.avi_clusterclouddetailsModule to create update or delete ClusterCloudDetails
vmware.alb.avi_controllerportalregistrationModule to create update or delete ControllerPortalRegistration
vmware.alb.avi_controllerpropertiesModule to create update or delete ControllerProperties
vmware.alb.avi_controllersiteModule to create update or delete ControllerSite
vmware.alb.avi_csrfpolicyModule to create update or delete CSRFPolicy
vmware.alb.avi_customipamdnsprofileModule to create update or delete CustomIpamDnsProfile
vmware.alb.avi_deploy_controllerModule to create update or delete DeployController
vmware.alb.avi_dnspolicyModule to create update or delete DnsPolicy
vmware.alb.avi_dynamicdnsrecordModule to create update or delete DynamicDnsRecord
vmware.alb.avi_errorpagebodyModule to create update or delete ErrorPageBody
vmware.alb.avi_errorpageprofileModule to create update or delete ErrorPageProfile
vmware.alb.avi_federationcheckpointModule to create update or delete FederationCheckpoint
vmware.alb.avi_fileobjectModule to create update or delete FileObject
vmware.alb.avi_geodbModule to create update or delete GeoDB
vmware.alb.avi_gslbModule to create update or delete Gslb
vmware.alb.avi_gslbcrmruntimeModule to create update or delete GslbCRMRuntime
vmware.alb.avi_gslbgeodbprofileModule to create update or delete GslbGeoDbProfile
vmware.alb.avi_gslbhsmruntimeModule to create update or delete GslbHSMRuntime
vmware.alb.avi_gslbserviceModule to create update or delete GslbService
vmware.alb.avi_gslbservice_patch_memberModule to create update or delete GslbservicePatchMember
vmware.alb.avi_gslbsmruntimeModule to create update or delete GslbSMRuntime
vmware.alb.avi_hardwaresecuritymodulegroupModule to create update or delete HardwareSecurityModuleGroup
vmware.alb.avi_healthmonitorModule to create update or delete HealthMonitor
vmware.alb.avi_httppolicysetModule to create update or delete HTTPPolicySet
vmware.alb.avi_icapprofileModule to create update or delete IcapProfile
vmware.alb.avi_imageModule to create update or delete Image
vmware.alb.avi_inventoryfaultconfigModule to create update or delete InventoryFaultConfig
vmware.alb.avi_ipaddrgroupModule to create update or delete IpAddrGroup
vmware.alb.avi_ipamdnsproviderprofileModule to create update or delete IpamDnsProviderProfile
vmware.alb.avi_ipreputationdbModule to create update or delete IPReputationDB
vmware.alb.avi_jwtserverprofileModule to create update or delete JWTServerProfile
vmware.alb.avi_l4policysetModule to create update or delete L4PolicySet
vmware.alb.avi_labelgroupModule to create update or delete LabelGroup
vmware.alb.avi_licenseledgerdetailsModule to create update or delete LicenseLedgerDetails
vmware.alb.avi_licensestatusModule to create update or delete LicenseStatus
vmware.alb.avi_localworkerfdsversionModule to create update or delete LocalWorkerFdsVersion
vmware.alb.avi_memorybalancerrequestModule to create update or delete MemoryBalancerRequest
vmware.alb.avi_microservicegroupModule to create update or delete MicroServiceGroup
vmware.alb.avi_natpolicyModule to create update or delete NatPolicy
vmware.alb.avi_networkModule to create update or delete Network
vmware.alb.avi_networkprofileModule to create update or delete NetworkProfile
vmware.alb.avi_networksecuritypolicyModule to create update or delete NetworkSecurityPolicy
vmware.alb.avi_networkserviceModule to create update or delete NetworkService
vmware.alb.avi_nsxtsegmentruntimeModule to create update or delete NsxtSegmentRuntime
vmware.alb.avi_pkiprofileModule to create update or delete PKIProfile
vmware.alb.avi_poolModule to create update or delete Pool
vmware.alb.avi_poolgroupModule to create update or delete PoolGroup
vmware.alb.avi_poolgroupdeploymentpolicyModule to create update or delete PoolGroupDeploymentPolicy
vmware.alb.avi_prioritylabelsModule to create update or delete PriorityLabels
vmware.alb.avi_protocolparserModule to create update or delete ProtocolParser
vmware.alb.avi_pulse_registrationModule to create update or delete PulseRegistration
vmware.alb.avi_retentionpolicyModule to create update or delete RetentionPolicy
vmware.alb.avi_roleModule to create update or delete Role
vmware.alb.avi_saml_api_sessionModule to create update or delete SamlApiSession
vmware.alb.avi_schedulerModule to create update or delete Scheduler
vmware.alb.avi_securitymanagerdataModule to create update or delete SecurityManagerData
vmware.alb.avi_securitypolicyModule to create update or delete SecurityPolicy
vmware.alb.avi_sepropertiesModule to create update or delete SeProperties
vmware.alb.avi_serverautoscalepolicyModule to create update or delete ServerAutoScalePolicy
vmware.alb.avi_serviceauthprofileModule to create update or delete ServiceAuthProfile
vmware.alb.avi_serviceengineModule to create update or delete ServiceEngine
vmware.alb.avi_serviceenginegroupModule to create update or delete Serviceenginegroup
vmware.alb.avi_serviceenginegroupModule to create update or delete ServiceEngineGroup
vmware.alb.avi_serviceenginegroup_advancedModule to create update or delete ServiceenginegroupAdvanced
vmware.alb.avi_siteversionModule to create update or delete SiteVersion
vmware.alb.avi_snmptrapprofileModule to create update or delete SnmpTrapProfile
vmware.alb.avi_sslkeyandcertificateModule to create update or delete SSLKeyAndCertificate
vmware.alb.avi_sslprofileModule to create update or delete SSLProfile
vmware.alb.avi_ssopolicyModule to create update or delete SSOPolicy
vmware.alb.avi_statediffoperationModule to create update or delete StatediffOperation
vmware.alb.avi_statediffsnapshotModule to create update or delete StatediffSnapshot
vmware.alb.avi_stringgroupModule to create update or delete StringGroup
vmware.alb.avi_systemconfigurationModule to create update or delete SystemConfiguration
vmware.alb.avi_systemlimitsModule to create update or delete SystemLimits
vmware.alb.avi_systemreportModule to create update or delete SystemReport
vmware.alb.avi_taskjournalModule to create update or delete TaskJournal
vmware.alb.avi_tenantModule to create update or delete Tenant
vmware.alb.avi_tenantsystemconfigurationModule to create update or delete TenantSystemConfiguration
vmware.alb.avi_testsedatastorelevel1Module to create update or delete TestSeDatastoreLevel1
vmware.alb.avi_testsedatastorelevel2Module to create update or delete TestSeDatastoreLevel2
vmware.alb.avi_testsedatastorelevel3Module to create update or delete TestSeDatastoreLevel3
vmware.alb.avi_trafficcloneprofileModule to create update or delete TrafficCloneProfile
vmware.alb.avi_trustedhostprofileModule to create update or delete TrustedHostProfile
vmware.alb.avi_update_se_data_vnicsModule to create update or delete UpdateSeDataVnics
vmware.alb.avi_upgradeprofileModule to create update or delete UpgradeProfile
vmware.alb.avi_upgradestatusinfoModule to create update or delete UpgradeStatusInfo
vmware.alb.avi_upgradestatussummaryModule to create update or delete UpgradeStatusSummary
vmware.alb.avi_userModule to create update or delete User
vmware.alb.avi_useraccountModule to create update or delete Useraccount
vmware.alb.avi_useraccountprofileModule to create update or delete UserAccountProfile
vmware.alb.avi_vcenterserverModule to create update or delete VCenterServer
vmware.alb.avi_virtualserviceModule to create update or delete VirtualService
vmware.alb.avi_vrfcontextModule to create update or delete VrfContext
vmware.alb.avi_vsdatascriptsetModule to create update or delete VSDataScriptSet
vmware.alb.avi_vsgsModule to create update or delete VsGs
vmware.alb.avi_vsvipModule to create update or delete VsVip
vmware.alb.avi_wafapplicationsignatureproviderModule to create update or delete WafApplicationSignatureProvider
vmware.alb.avi_wafpolicyModule to create update or delete WafPolicy
vmware.alb.avi_wafpolicypsmgroupModule to create update or delete WafPolicyPSMGroup
vmware.alb.avi_wafprofileModule to create update or delete WafProfile
vmware.alb.avi_webapputModule to create update or delete WebappUT
vmware.alb.avi_webhookModule to create update or delete Webhook

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

Support

As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the Create issue button on the top right corner. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there may community help available on the Ansible Forum.

Release Notes

For release notes, see CHANGELOG.rst.

Licensing

GNU General Public License v2.0 or later.

See LICENSE to see the full text.

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

Certification

Product
Red Hat Ansible Automation Platform 2.5
Red Hat Ansible Automation Platform 2.4
DocumentationDependencies
No dependencies
There are currently no dependencies for this collection.
View in Automation Hub
Red Hat logoLinkedInYouTubeFacebookTwitter

Platforms

Products & services

Try, buy, sell

Help

About Red Hat Ecosystem Catalog

The Red Hat Ecosystem Catalog is the official source for discovering and learning more about the Red Hat Ecosystem of both Red Hat and certified third-party products and services.

We’re the world’s leading provider of enterprise open source solutions—including Linux, cloud, container, and Kubernetes. We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2025 Red Hat