F5 BIG-IP Trigger

F5 BIG-IP Trigger
Certified
Enterprise Edition
React when a BIG-IP LTM pool reaches a specific state

Polls pool availability via /mgmt/tm/ltm/pool/stats at the given interval and fires an execution for the first pool in the configured partition whose state matches watchedState. The output variables trigger.poolName, trigger.partition, and trigger.state are available in downstream tasks.

yaml
type: io.kestra.plugin.ee.f5.pool.Trigger

Examples

Alert when a pool goes offline

yaml
id: handle_pool_offline
namespace: company.team

triggers:
  - id: on_pool_offline
    type: io.kestra.plugin.ee.f5.pool.Trigger
    host: "{{ secret('F5_HOST') }}"
    username: "{{ secret('F5_USERNAME') }}"
    password: "{{ secret('F5_PASSWORD') }}"
    watchedState: OFFLINE
    interval: PT1M

tasks:
  - id: alert
    type: io.kestra.plugin.core.log.Log
    message: "Pool {{ trigger.poolName }} in partition {{ trigger.partition }} is {{ trigger.state }}"

Properties

host *string

BIG-IP hostname or IP address

password *string

BIG-IP password

username *string

BIG-IP username

allowConcurrent boolean

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

insecure booleanstring

Defaultfalse

Trust all SSL certificates

Set to true to disable TLS certificate validation.

interval string

DefaultPT1M

Formatduration

Polling interval

How often to poll for state changes. Accepts ISO 8601 duration notation, e.g. PT30S for 30 seconds or PT1M for 1 minute.

partition string

DefaultCommon

Administrative partition to target

Defaults to Common when not set.

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

watchedState string

DefaultOFFLINE

Possible Values

AVAILABLEOFFLINEUNKNOWNDISABLEDFORCED_OFFLINE

Pool state that triggers an execution

Pool availability is read from the BIG-IP stats endpoint and reflects whether the pool has enough active members to serve traffic. The trigger fires once per poll cycle for the first matching pool.

when string

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Outputs

partition string

Partition the pool belongs to

poolName string

Name of the pool that matched watchedState

state string

Effective state of the pool at evaluation time