
Arista EOS WaitForReturn
CertifiedEnterprise EditionWait for an EOS switch to come back after a reload
Arista EOS WaitForReturn
Wait for an EOS switch to come back after a reload
Polls until eAPI answers with a boot time newer than the baseline, then (when MLAG is configured) until the MLAG peer is connected and the MLAG reload delay has elapsed since the switch first answered, then waits the stabilisation window and checks once more that the switch still answers.
Connection failures and HTTP 503 are expected while the switch boots and are retried here, so no task level retry is needed. HTTP 401 and 503 answers are also tolerated, each for up to authGracePeriod; after that a 401 raises AuthFailure and a 503 raises DeviceUnreachable. eAPI command errors while booting are retried until the timeouts. Without a baseline, only the first answer is required.
type: io.kestra.plugin.ee.arista.eos.WaitForReturnExamples
Wait for a reloaded switch and its MLAG peer
id: arista_wait_for_return
namespace: company.network
inputs:
- id: snapshot
type: URI
tasks:
- id: wait
type: io.kestra.plugin.ee.arista.eos.WaitForReturn
host: leaf1.lab.example.com
username: "{{ secret('ARISTA_USERNAME') }}"
password: "{{ secret('ARISTA_PASSWORD') }}"
snapshot: "{{ inputs.snapshot }}"
reachabilityTimeout: PT20M
stabilisationWindow: PT2M
Installation
This Enterprise plugin requires an Enterprise image and access to the plugin registry. Install it with the following command:
kestractl plugins get io.kestra.plugin.ee:plugin-ee-arista --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
host *string
Switch host
Host name or IP address of the switch management interface serving eAPI.
password *string
Password
Use {{ secret('ARISTA_PASSWORD') }}. The value is never logged nor returned in outputs.
username *string
Username
Account allowed to run privileged commands over eAPI.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150authGracePeriod string
Authentication grace period
How long HTTP 401 or 503 answers count as 'not ready yet' while the switch boots, counted separately for each status from its first answer and, during the MLAG wait, from the first answer. Zero disables it, negative values are rejected. Defaults to 5 minutes.
caCertificate string
CA certificate
PEM encoded CA certificate(s) used to validate the switch certificate. When set, only this CA is trusted. When empty, the JVM trust store is used.
connectTimeout string
Connect timeout
Maximum time to open the connection. Defaults to 10 seconds.
insecureTrustAllCertificates booleanstring
Trust any certificate
Disables certificate and host name validation. Only for labs with self-signed certificates. Defaults to false.
mlagTimeout string
MLAG timeout
Maximum time, from the first answer, for the MLAG peer to be connected and the reload delay to elapse. Must be greater than zero. Defaults to 15 minutes.
pollInterval string
Poll interval
Delay between two polls, must be greater than zero. Defaults to 10 seconds.
port integerstring
eAPI port
Defaults to 443.
previousBootupTimestamp numberstring
Previous boot timestamp
Baseline boot time (epoch seconds) when no snapshot is given.
reachabilityTimeout string
Reachability timeout
Maximum time to wait for the switch to answer again with a new boot time. Must be greater than zero. Defaults to 20 minutes.
requestTimeout string
Request timeout
Maximum time to wait for one eAPI answer. Defaults to 60 seconds. Tasks that run slow commands (image copy, checksum) expose their own timeout.
snapshot string
Snapshot
Internal storage URI of the PRE check snapshot. Its boot time is the baseline the new boot time must exceed.
Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.
stabilisationWindow string
Stabilisation window
Extra wait once the switch is back, to let routing and links settle. Zero skips it, negative values are rejected. Defaults to 2 minutes.
Outputs
bootupTimestamp number
Boot timestamp
Epoch seconds of the new boot.
mlagConnectedAfter string
durationMLAG connected after
Time from the first answer until the MLAG peer was connected and the reload delay elapsed. Not set without MLAG.
reachableAfter string
durationReachable after
Time from the start of the task until the switch answered with a new boot time.
total string
durationTotal
Total duration of the task, including the stabilisation window.
version string
Running version
EOS version running after the return.