F5 BIG-IP Trigger

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

Polls all nodes in the configured partition at the given interval and fires an execution for the first node whose effective state matches watchedState. The output variables trigger.nodeName, trigger.address, and trigger.state are available in downstream tasks.

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

Examples

Alert when a node goes down

yaml
id: handle_node_down
namespace: company.team

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

tasks:
  - id: alert
    type: io.kestra.plugin.core.log.Log
    message: "Node {{ trigger.nodeName }} ({{ trigger.address }}) 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

DefaultDOWN_BY_MONITOR

Possible Values

UPDOWN_BY_MONITORDOWN_BY_ADMINDISABLED_BY_ADMIN

Node state that triggers an execution

The trigger fires once per poll cycle for the first node in the given state. DOWN_BY_MONITOR fires when the health monitor detects a failure; DOWN_BY_ADMIN fires when an operator has explicitly taken the node offline; DISABLED_BY_ADMIN fires when the node session has been administratively disabled.

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

address string

IP address of the node

nodeName string

Name of the node that matched watchedState

state string

Effective state of the node at evaluation time