
Arista EOS RunCommands
CertifiedEnterprise EditionRun commands on an Arista EOS switch
Arista EOS RunCommands
Run commands on an Arista EOS switch
Sends a list of CLI commands through eAPI (runCmds) and returns one result per command. Privileged mode (enable) is entered automatically. Results are JSON by default; when a command has no JSON form (eAPI error 1003) a read-only request (only show, dir and verify commands) is sent again in text form and each result is {"output": "..."}. A batch with any other command is never replayed, so the error is raised: set format: TEXT for batches that change the configuration. A failing command raises a CommandError with the eAPI code and message.
type: io.kestra.plugin.ee.arista.eos.RunCommandsExamples
Read the running version of a switch
id: arista_show_version
namespace: company.network
tasks:
- id: show_version
type: io.kestra.plugin.ee.arista.eos.RunCommands
host: leaf1.lab.example.com
username: "{{ secret('ARISTA_USERNAME') }}"
password: "{{ secret('ARISTA_PASSWORD') }}"
commands:
- show version
Run several commands and store the results in a file
id: arista_inventory
namespace: company.network
tasks:
- id: inventory
type: io.kestra.plugin.ee.arista.eos.RunCommands
host: leaf1.lab.example.com
username: "{{ secret('ARISTA_USERNAME') }}"
password: "{{ secret('ARISTA_PASSWORD') }}"
caCertificate: "{{ secret('ARISTA_CA_PEM') }}"
store: true
commands:
- show version
- show lldp neighbors detail
- show interfaces status
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
commands *array
Commands
CLI commands, run in order in privileged mode. Use configure as first command to run configuration commands.
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.
connectTimeout string
Connect timeout
Maximum time to open the connection. Defaults to 10 seconds.
format string
JSONTEXTOutput format
JSON (default) with automatic text fallback for read-only batches, or TEXT to ask for text from the start. Use TEXT for batches that change the configuration.
insecureTrustAllCertificates booleanstring
Trust any certificate
Disables certificate and host name validation. Only for labs with self-signed certificates. Defaults to false.
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.
store booleanstring
Store results in a file
When true, results are written to internal storage and only uri is returned. Defaults to false.
Outputs
results array
Results
One entry per command, in order. Not set when store is true.
uri string
uriResults file
Internal storage URI of a JSON array with one entry per command. Only set when store is true.