F5 Big-IP Networks provides a load balancer that is a device that acts as a reverse proxy and distributes network or application traffic across a number of servers. Load balancers are used to increase capacity (concurrent users) and reliability of applications.
This plugin provides integration with F5 Big IP Loadbalancer through its Rest API.
Plugin version 3.1.2.2021022310
Revised on Feb 24, 2021
Document convention
In all plugin procedures, parameter description for mandatory/required parameters are shown in bold italics.
Plugin configurations
Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. They reduce repetition of common values, create predefined parameter sets for end users, and securely store credentials where needed. Each configuration is given a unique name that is entered in designated parameters on procedures that use them.
Creating plugin configurations
To create plugin configurations in CloudBees CD, do these steps:
-
Go to Administration > Plugins to open the Plugin Manager.
-
Find the EC-BigIp-3.1.2.2021022310 row.
-
Click Configure to open the Configurations page.
-
Click Create Configuration.
Configuration Parameters
Parameter | Description |
---|---|
Configuration Name |
The name for the created configuration. |
Description |
Description for the configuration. |
Protocol |
Specifies whether to preceed hostname with https:// or leave http:// |
Host |
Host name of the iControlREST API instance. |
URL Path to API |
URL Base Path to iControlREST (if any) that needs to be added to For example if the URL path to iControlREST is |
API server port |
Server port for example 443 |
Type Of Authentication |
Specifies how a particular consumer is authenticated to the system.
|
BigIp API Credentials |
Enter credentials required to perform basic authentication. |
Authentication Provider |
The identifier of the internal or external authentication provider: local, tmos. Depends on Token Based Authentication. |
Check Connection? |
If checked, the configuration will be saved only if the test request with given credentials succeeds. |
Debug Level |
This option sets debug level for logs. If info is selected, only summary information will be shown, for debug, there will be some debug information and for trace the whole requests and responses will be shown. |
Plugin procedures
LTM - config sync
Synchronizes the local BIG-IP device to the device group
LTM - create or update balancing pool
Create or update balancing pool configuration
LTM - create or update balancing pool parameters
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Update Action |
This parameter controls the update of a balancing pool if one with the same name exists already:
|
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Optional Parameters |
Semicolon separated list of values in the format parameter=value Available parameters:
|
Result Property Sheet |
Results will be saved into this property/property sheet. |
Pool member operations
LTM - create or update pool member
Create the set of pool members that are associated with a load balancing pool
LTM - create or update pool member parameters
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Update Action |
This parameter controls the update of a balancing pool member if one with the same name exists already:
|
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
A name for this member. |
Optional Parameters |
Semicolon separated list of values in the format parameter=value Available parameters:
|
Result Property Sheet |
Results will be saved into this property/property sheet. |
LTM - change pool member status
Change pool member status
LTM - change pool member status parameters
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
Name of the member. |
Status |
Desired status of the pool member:
Details: |
Result Property Sheet |
Results will be saved into this property/property sheet. |
LTM - get pool member
Get a specified pool member from a load balancing pool
LTM - get pool member parameters
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
A name for this member. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
LTM - delete pool member
Delete a specified pool member from a load balancing pool
LTM - delete pool member parameters
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
A name for this member. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Release notes
EC-BigIp 3.1.0
Add checking connection while creating/editing a configuration
Add Token Based Authentication
EC-BigIp 3.0.0
Procedure Interfaces in this version of the Plugin have been changed for Usability and Robustness. If a previous major version (i.e., version ⇐ 2.X) of this plugin exists in your environment, this version of the plugin will not promote, until you demote the previous major version. This approach is taken in order to provide you with an opportunity to understand refactoring impacts upon upgrade. Please make sure you understand the impact before upgrading to this version of the plugin. The following is the list of key changes made to this plugin. |
-
New procedure LTM - Config sync.
-
New Field Update Action added to LTM - Create or update balancing pool to control update behavior.
-
New Field Update Action added to LTM - Create or update pool member to control update behavior.
-
Existing procedure LTM - Manage balancing pool removed.
-
Existing procedure LTM - Manage pool member removed.