
Arista EOS ConfigSession
CertifiedEnterprise EditionChange the configuration of an EOS switch with a config session
Arista EOS ConfigSession
Change the configuration of an EOS switch with a config session
Uses EOS configuration sessions: DIFF stages commands in a named session, returns the diff and aborts the session (dry run). APPLY stages them, returns the diff and commits it, immediately or with a commitTimer after which the switch reverts unless CONFIRM is run. ABORT discards a pending session.
With mode: REPLACE the session starts from rollback clean-config, so commands must describe the whole configuration. An empty diff is never committed.
type: io.kestra.plugin.ee.arista.eos.ConfigSessionExamples
Dry run a change, then apply it with a 5 minute safety timer
id: arista_config_session
namespace: company.network
tasks:
- id: dry_run
type: io.kestra.plugin.ee.arista.eos.ConfigSession
host: leaf1.lab.example.com
username: "{{ secret('ARISTA_USERNAME') }}"
password: "{{ secret('ARISTA_PASSWORD') }}"
action: DIFF
sessionName: kestra_vlan_change
commands:
- vlan 120
- name tenant-a
- id: apply
type: io.kestra.plugin.ee.arista.eos.ConfigSession
host: leaf1.lab.example.com
username: "{{ secret('ARISTA_USERNAME') }}"
password: "{{ secret('ARISTA_PASSWORD') }}"
action: APPLY
sessionName: kestra_vlan_change
commitTimer: PT5M
commands:
- vlan 120
- name tenant-a
- id: confirm
type: io.kestra.plugin.ee.arista.eos.ConfigSession
host: leaf1.lab.example.com
username: "{{ secret('ARISTA_USERNAME') }}"
password: "{{ secret('ARISTA_PASSWORD') }}"
action: CONFIRM
sessionName: kestra_vlan_change
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
action *string
DIFFAPPLYCONFIRMABORTAction
DIFF dry run, APPLY stage and commit, CONFIRM confirm a commit made with a timer, ABORT discard the session.
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
{}1150caCertificate 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.
commands array
Commands
Configuration commands staged in the session. Required for DIFF and APPLY.
commitTimer string
Commit timer
For APPLY: the commit reverts after this duration unless confirmed with CONFIRM. Whole seconds, up to 99 hours.
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.
mode string
MERGEREPLACEMode
MERGE (default) adds commands to the running configuration, REPLACE starts from rollback clean-config.
port integerstring
eAPI port
Defaults to 443.
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.
sessionName string
Session name
Letters, digits, _, - and ., up to 50 characters. Defaults to kestra.
Outputs
changed boolean
Changed
True when the session contains a change (DIFF, APPLY) or a pending change was confirmed (CONFIRM).
committed boolean
Committed
True when the change is committed. With a commit timer it stays true but reverts unless confirmed.
diff string
Diff
Differences between the running configuration and the session, as printed by the switch. Not set for CONFIRM and ABORT.