Arista EOS WaitForReturn

Arista EOS WaitForReturn

Certified
Enterprise Edition

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.

yaml
type: io.kestra.plugin.ee.arista.eos.WaitForReturn

Wait for a reloaded switch and its MLAG peer

yaml
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

Switch host

Host name or IP address of the switch management interface serving eAPI.

Password

Use {{ secret('ARISTA_PASSWORD') }}. The value is never logged nor returned in outputs.

Username

Account allowed to run privileged commands over eAPI.

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

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.

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.

Connect timeout

Maximum time to open the connection. Defaults to 10 seconds.

Trust any certificate

Disables certificate and host name validation. Only for labs with self-signed certificates. Defaults to false.

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.

Poll interval

Delay between two polls, must be greater than zero. Defaults to 10 seconds.

eAPI port

Defaults to 443.

Previous boot timestamp

Baseline boot time (epoch seconds) when no snapshot is given.

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.

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

Internal storage URI of the PRE check snapshot. Its boot time is the baseline the new boot time must exceed.

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.

Boot timestamp

Epoch seconds of the new boot.

Formatduration

MLAG connected after

Time from the first answer until the MLAG peer was connected and the reload delay elapsed. Not set without MLAG.

Formatduration

Reachable after

Time from the start of the task until the switch answered with a new boot time.

Formatduration

Total

Total duration of the task, including the stabilisation window.

Running version

EOS version running after the return.