Arista EOS Commit

Arista EOS Commit

Certified
Enterprise Edition

Commit an upgrade on an EOS switch

Saves the running configuration (write memory) and, when removePreviousImage is true, deletes the image that was booted before the upgrade (read from the snapshot) once the switch runs another one. The previous image is kept by default, because it is what Rollback needs.

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

Commit the upgrade and free the flash

yaml
id: arista_commit
namespace: company.network

inputs:
  - id: snapshot
    type: URI

tasks:
  - id: commit
    type: io.kestra.plugin.ee.arista.eos.Commit
    host: leaf1.lab.example.com
    username: "{{ secret('ARISTA_USERNAME') }}"
    password: "{{ secret('ARISTA_PASSWORD') }}"
    snapshot: "{{ inputs.snapshot }}"
    removePreviousImage: true
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

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.

eAPI port

Defaults to 443.

Remove previous image

Deletes the previous .swi from flash after saving. Defaults to false.

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. Required when removePreviousImage is true.

Removed image

File name of the image deleted from flash. Not set when nothing was removed.