Trigger a flow based on VMware ESXi VM lifecycle events
This trigger polls the VMware ESXi host for VM lifecycle events such as creation, deletion, power on/off. It supports filtering by event type and VM name regex.
type: "io.kestra.plugin.ee.vmware.esxi.Trigger"
Examples
Trigger on VM power-off events from ESXi
id: "trigger"
type: "io.kestra.plugin.ee.vmware.esxi.Trigger"
id: vm_event_trigger
namespace: company.it
triggers:
- id: watch
type: io.kestra.plugin.ee.vmware.esxi.Trigger
interval: PT1M
server: "esxi1.company.local"
username: "{{ secret('VMWARE_ESXI_USERNAME') }}"
password: "{{ secret('VMWARE_ESXI_PASSWORD') }}"
eventType: VM_POWERED_OFF
vmNameRegex: "vm-.*"
tasks:
- id: foreach-event
type: io.kestra.plugin.core.flow.ForEach
values: "{{ trigger.events }}"
tasks:
- id: log-vm-event
type: io.kestra.plugin.core.log.Log
message: "VM {{ json(taskrun.value).vmName }} had event {{ json(taskrun.value).eventType }} at {{ json(taskrun.value).timestamp }}"
Properties
eventType *Requiredstring
VM_SUSPENDED
VM_CREATED
VM_DEPLOYED
VM_CLONE
VM_RENAMED
VM_FAILED_TO_POWER_ON
VM_FAILED_TO_POWER_OFF
VM_FAILED_TO_SUSPEND
VM_FAILED_TO_RESET
VM_REMOVED
VM_POWERED_ON
VM_POWERED_OFF
The event type we want to monitor to trigger the workflow.
password *Requiredstring
The password for authentication.
The password used to authenticate with the VMware server.
server *Requiredstring
The URL of the server.
The URL to connect to the VMwareserver. This is a FQDN or an IP address (eg: esxi.mycompany.com), so without any protocol nor port.
username *Requiredstring
The username for authentication.
The username used to authenticate with the server. It could be something like '[email protected]' for vCenter or 'root' for ESXi.
vmNameRegex *Requiredstring
The regex to match the VM name.
conditions Non-dynamicarray
List of conditions in order to limit the flow trigger.
interval Non-dynamicstring
PT2M
duration
Interval between polling.
The interval between 2 different polls of schedule, this can avoid to overload the remote system with too many calls. For most of the triggers that depend on external systems, a minimal interval must be at least PT30S. See ISO_8601 Durations for more information of available interval values.
port integerstring
443
The port for the connection.
The port to connect to the server. Default is 443.
stopAfter Non-dynamicarray
CREATED
RUNNING
PAUSED
RESTARTED
KILLING
SUCCESS
WARNING
FAILED
KILLED
CANCELLED
QUEUED
RETRYING
RETRIED
SKIPPED
BREAKPOINT
List of execution states after which a trigger should be stopped (a.k.a. disabled).
trustStorePath string
The path to the trust store file.
The path to the trust store file containing certificates for secure connections. If not provided, an empty keystore will be created and the connection will be insecure.
Definitions
io.kestra.core.models.triggers.TimeWindow
deadline string
partial-time
SLA daily deadline
Use it only for DAILY_TIME_DEADLINE
SLA.
endTime string
partial-time
SLA daily end time
Use it only for DAILY_TIME_WINDOW
SLA.
startTime string
partial-time
SLA daily start time
Use it only for DAILY_TIME_WINDOW
SLA.
type string
DURATION_WINDOW
DAILY_TIME_DEADLINE
DAILY_TIME_WINDOW
DURATION_WINDOW
SLIDING_WINDOW
The type of the SLA
The default SLA is a sliding window (DURATION_WINDOW
) with a window of 24 hours.
window string
duration
The duration of the window
Use it only for DURATION_WINDOW
or SLIDING_WINDOW
SLA.
See ISO_8601 Durations for more information of available duration value.
The start of the window is always based on midnight except if you set windowAdvance parameter. Eg if you have a 10 minutes (PT10M) window,
the first window will be 00: 00 to 00: 10 and a new window will be started each 10 minutes
windowAdvance string
duration
The window advance duration
Use it only for DURATION_WINDOW
SLA.
Allow to specify the start time of the window
Eg: you want a window of 6 hours (window=PT6H), by default the check will be done between: 00: 00 and 06: 00, 06: 00 and 12: 00, 12: 00 and 18: 00, and 18: 00 and 00: 00.
If you want to check the window between 03: 00 and 09: 00, 09: 00 and 15: 00, 15: 00 and 21: 00, and 21: 00 and 3: 00, you will have to shift the window of 3 hours by settings windowAdvance: PT3H
Condition for a specific flow of an execution.
flowId *Requiredstring
The flow id.
namespace *Requiredstring
The namespace of the flow.
type *Requiredobject
Condition for a flow namespace.
namespace *Requiredstring
The namespace of the flow or the prefix if prefix
is true.
type *Requiredobject
prefix boolean
false
If we must look at the flow namespace by prefix (checked using startWith). The prefix is case sensitive.
Condition for a specific flow. Note that this condition is deprecated, use `io.kestra.plugin.core.condition.ExecutionFlow` instead.
flowId *Requiredstring
The flow id.
namespace *Requiredstring
The namespace of the flow.
type *Requiredobject
Condition to allow events between two specific times.
type *Requiredobject
after string
time
The time to test must be after this one.
Must be a valid ISO 8601 time with offset.
before string
time
The time to test must be before this one.
Must be a valid ISO 8601 time with offset.
date string
{{ trigger.date }}
The time to test.
Can be any variable or any valid ISO 8601 time. By default, it will use the trigger date.
Condition that check labels of an execution.
labels *Requiredarrayobject
List of labels to match in the execution.
type *Requiredobject
Condition based on the outputs of an upstream execution.
expression *Requiredstring
type *Requiredobject
Condition to allow events on weekend.
type *Requiredobject
date string
{{ trigger.date }}
The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
Condition to have at least one condition validated.
conditions *Requiredarray
1
The list of conditions to validate.
If any condition is true, it will allow the event's execution.
type *Requiredobject
Condition for an execution namespace.
namespace *Requiredstring
String against which to match the execution namespace depending on the provided comparison.
type *Requiredobject
comparison string
EQUALS
PREFIX
SUFFIX
Comparison to use when checking if namespace matches. If not provided, it will use EQUALS
by default.
prefix booleanstring
false
Whether to look at the flow namespace by prefix. Shortcut for comparison: PREFIX
.
Only used when comparison
is not set
Run a flow if the list of preconditions are met in a time window.
conditions *Requiredobject
id *Requiredstring
^[a-zA-Z0-9][a-zA-Z0-9_-]*
1
A unique id for the condition
type *Requiredobject
resetOnSuccess boolean
true
Whether to reset the evaluation results of SLA conditions after a first successful evaluation within the given time period.
By default, after a successful evaluation of the set of SLA conditions, the evaluation result is reset, so, the same set of conditions needs to be successfully evaluated again in the same time period to trigger a new execution.
This means that to create multiple executions, the same set of conditions needs to be evaluated to true
multiple times.
You can disable this by setting this property to false
so that, within the same period, each time one of the conditions is satisfied again after a successful evaluation, it will trigger a new execution.
timeWindow TimeWindow
{
"type": "DURATION_WINDOW"
}
Define the time period (or window) for evaluating preconditions.
You can set the type
of sla
to one of the following values:
DURATION_WINDOW
: this is the defaulttype
. It uses a start time (windowAdvance
) and end time (window
) that are moving forward to the next interval whenever the evaluation time reaches the end time, based on the defined durationwindow
. For example, with a 1-day window (the default option:window: PT1D
), the SLA conditions are always evaluated during 24h starting at midnight (i.e. at time 00: 00: 00) each day. If you setwindowAdvance: PT6H
, the window will start at 6 AM each day. If you setwindowAdvance: PT6H
and you also override thewindow
property toPT6H
, the window will start at 6 AM and last for 6 hours — as a result, Kestra will check the SLA conditions during the following time periods: 06: 00 to 12: 00, 12: 00 to 18: 00, 18: 00 to 00: 00, and 00: 00 to 06: 00, and so on.SLIDING_WINDOW
: this option also evaluates SLA conditions over a fixed timewindow
, but it always goes backward from the current time. For example, a sliding window of 1 hour (window: PT1H
) will evaluate executions for the past hour (so between now and one hour before now). It uses a default window of 1 day.DAILY_TIME_DEADLINE
: this option declares that some SLA conditions should be met "before a specific time in a day". With the string propertydeadline
, you can configure a daily cutoff for checking conditions. For example,deadline: "09: 00: 00"
means that the defined SLA conditions should be met from midnight until 9 AM each day; otherwise, the flow will not be triggered.DAILY_TIME_WINDOW
: this option declares that some SLA conditions should be met "within a given time range in a day". For example, a window fromstartTime: "06: 00: 00"
toendTime: "09: 00: 00"
evaluates executions within that interval each day. This option is particularly useful for declarative definition of freshness conditions when building data pipelines. For example, if you only need one successful execution within a given time range to guarantee that some data has been successfully refreshed in order for you to proceed with the next steps of your pipeline, this option can be more useful than a strict DAG-based approach. Usually, each failure in your flow would block the entire pipeline, whereas with this option, you can proceed with the next steps of the pipeline as soon as the data is successfully refreshed at least once within the given time range.
io.kestra.plugin.ee.vmware.LocalAbstractTrigger-VmEvent
eventType string
VM_SUSPENDED
VM_CREATED
VM_DEPLOYED
VM_CLONE
VM_RENAMED
VM_FAILED_TO_POWER_ON
VM_FAILED_TO_POWER_OFF
VM_FAILED_TO_SUSPEND
VM_FAILED_TO_RESET
VM_REMOVED
VM_POWERED_ON
VM_POWERED_OFF
timestamp string
vmName string
Condition to exclude others conditions.
conditions *Requiredarray
1
The list of conditions to exclude.
If any conditions is true, it will prevent the event's execution.
type *Requiredobject
Condition to execute tasks on a specific day of the week relative to the current month (first, last, ...)
dayInMonth *Requiredstring
FIRST
LAST
SECOND
THIRD
FOURTH
Are you looking for the first or the last day in the month?
dayOfWeek *Requiredstring
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
The day of week.
type *Requiredobject
date string
{{ trigger.date }}
The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
Condition based on variable expression.
expression *Requiredstring
type *Requiredobject
Condition to allow events on a particular day of the week.
dayOfWeek *Requiredstring
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
The day of week.
type *Requiredobject
date string
{{ trigger.date }}
The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
Condition based on execution status.
type *Requiredobject
in array
CREATED
RUNNING
PAUSED
RESTARTED
KILLING
SUCCESS
WARNING
FAILED
KILLED
CANCELLED
QUEUED
RETRYING
RETRIED
SKIPPED
BREAKPOINT
List of states that are authorized.
notIn array
CREATED
RUNNING
PAUSED
RESTARTED
KILLING
SUCCESS
WARNING
FAILED
KILLED
CANCELLED
QUEUED
RETRYING
RETRIED
SKIPPED
BREAKPOINT
List of states that aren't authorized.
Condition to allow events between two specific datetime values.
type *Requiredobject
after string
date-time
The date to test must be after this one.
Must be a valid ISO 8601 datetime with the zone identifier (use 'Z' for the default zone identifier).
before string
date-time
The date to test must be before this one.
Must be a valid ISO 8601 datetime with the zone identifier (use 'Z' for the default zone identifier).
date string
{{ trigger.date }}
The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
Condition that matches if any taskRun has retry attempts.
type *Requiredobject
in array
CREATED
RUNNING
PAUSED
RESTARTED
KILLING
SUCCESS
WARNING
FAILED
KILLED
CANCELLED
QUEUED
RETRYING
RETRIED
SKIPPED
BREAKPOINT
List of states that are authorized.
notIn array
CREATED
RUNNING
PAUSED
RESTARTED
KILLING
SUCCESS
WARNING
FAILED
KILLED
CANCELLED
QUEUED
RETRYING
RETRIED
SKIPPED
BREAKPOINT
List of states that aren't authorized.
Condition to allow events on public holidays.
type *Requiredobject
country string
ISO 3166-1 alpha-2 country code. If not set, it uses the country code from the default locale.
It uses the Jollyday library for public holiday calendar that supports more than 70 countries.
date string
{{ trigger.date }}
The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
subDivision string
ISO 3166-2 country subdivision (e.g., provinces and states) code.
It uses the Jollyday library for public holiday calendar that supports more than 70 countries.