F5 BIG-IP Load Balancer Plugin Reference
The F5 BIG-IP plugin adds the ability to manage deployments to application servers and web servers with traffic that is managed by a BIG-IP load balancing device.
This document provides information that is specific to this version of the BIG-IP plugin. For general information about the plugin, refer to Introduction to the XL Deploy F5 BIG-IP plugin.
Requirements
- XL Deploy 5.0.0 or later
- XL Deploy Load Balancer plugin (provided with the BIG-IP plugin distribution ZIP file)
- Plugins bundled with XL Deploy:
- XL Deploy Group Orchestrator plugin
- XL Deploy Web Server plugin
- F5 BIG-IP 11.x or 12.x
- Python 2.7
Important: Ensure that you download the plugin distribution ZIP file from the XebiaLabs Software Distribution site, as it includes the Load Balancer plugin.
Release notes
BIG-IP plugin 5.5.0
Improvements
- [DEPL-8827] - Migrated from pycontrol to bigsuds library
BIG-IP plugin 5.0.1
Improvements
- [DEPL-8194] - Support parallel deployment orchestrators in the load balancer plugins
BIG-IP plugin 5.0.0
XL Deploy 5.0.0 compatibility.
BIG-IP plugin 4.5.0
XL Deploy 4.5.0 compatibility.
Improvements
- [DEPL-5354] - Add support for F5 BIG-IP 11.x appliances
BIG-IP plugin 4.0.0
XL Deploy 4.0.0 compatibility.
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| lb.LoadBalancerDeployable | The supertype of all Deployables |
Deployeds
| CI | Description |
|---|---|
| lb.DisableServerInLoadBalancer | The supertype of all Deployeds |
| lb.EnableServerInLoadBalancer | The supertype of all Deployeds |
| lb.LoadBalancerDeployed | The supertype of all Deployeds |
Containers
| CI | Description |
|---|---|
| big-ip.LocalTrafficManager | An F5 BigIp LoadBalancer |
| lb.LoadBalancer | The Load Balancer super type |
Other Configuration Items
| CI | Description |
|---|---|
| big-ip.LocalTrafficManager | An F5 BigIp LoadBalancer |
| lb.DisableServerInLoadBalancer | The supertype of all Deployeds |
| lb.EnableServerInLoadBalancer | The supertype of all Deployeds |
| lb.LoadBalancer | The Load Balancer super type |
| lb.LoadBalancerDeployable | The supertype of all Deployables |
| lb.LoadBalancerDeployed | The supertype of all Deployeds |
Configuration Item Details
big-ip.LocalTrafficManager
| Type Hierarchy | lb.LoadBalancer >> udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable |
An F5 BigIp LoadBalancer
| Parent | ||
|---|---|---|
|
|
|
host
:
CI<overthere.Host>
|
|
The host that runs the PyControl 2 library that controls the BigIP load balancer
|
| Public Properties | ||
|---|---|---|
|
|
|
address
:
STRING
|
|
The address of the BigIP load balancer
|
||
|
|
|
partition
:
STRING
|
|
The active partition on the BigIP load balancer
|
||
|
|
|
password
:
STRING
|
|
The password used to connect to the BigIP load balancer
|
||
|
|
|
username
:
STRING
|
|
The username used to connect to the BigIP load balancer
|
||
|
|
|
bigIpAddress
:
STRING
|
|
The address this server is registered under in the BigIP load balancer
|
||
|
|
|
bigIpPool
:
STRING
|
|
The BigIP load balancer pool this server is a member of
|
||
|
|
|
bigIpPort
:
INTEGER
|
|
The port of the service of this server that is load balanced by the BigIP load balancer
|
||
|
|
|
disableInLoadBalancer
:
BOOLEAN
= true
|
|
Whether this server should be disabled in the load balancer when it is being deployed to
|
||
|
|
|
managedServers
:
SET_OF_CI<udm.Container>
|
|
The servers managed by this load balancer
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
addToPoolOrder
:
INTEGER
= 94
|
|
Add To Pool Order
|
||
|
|
|
addToPoolScript
:
STRING
= big-ip/enable-pool-member.py.ftl
|
|
Add To Pool Script
|
||
|
|
|
removeFromPoolOrder
:
INTEGER
= 8
|
|
Remove From Pool Order
|
||
|
|
|
removeFromPoolScript
:
STRING
= big-ip/disable-pool-member.py.ftl
|
|
Remove From Pool Script
|
lb.DisableServerInLoadBalancer
| Type Hierarchy | lb.LoadBalancerDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The supertype of all Deployeds.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
lb.EnableServerInLoadBalancer
| Type Hierarchy | lb.LoadBalancerDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The supertype of all Deployeds.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
lb.LoadBalancer
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
| Interfaces | udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable |
The Load Balancer super type.
| Public Properties | ||
|---|---|---|
|
|
|
bigIpAddress
:
STRING
|
|
The address this server is registered under in the BigIP load balancer
|
||
|
|
|
bigIpPool
:
STRING
|
|
The BigIP load balancer pool this server is a member of
|
||
|
|
|
bigIpPort
:
INTEGER
|
|
The port of the service of this server that is load balanced by the BigIP load balancer
|
||
|
|
|
disableInLoadBalancer
:
BOOLEAN
= true
|
|
Whether this server should be disabled in the load balancer when it is being deployed to
|
||
|
|
|
managedServers
:
SET_OF_CI<udm.Container>
|
|
The servers managed by this load balancer
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
lb.LoadBalancerDeployable
| Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
The supertype of all Deployables.
| Public Properties | ||
|---|---|---|
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
lb.LoadBalancerDeployed
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The supertype of all Deployeds.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|