
Arista CloudVision ImageBundle
CertifiedEnterprise EditionManage a CloudVision image bundle
Arista CloudVision ImageBundle
Manage a CloudVision image bundle
Creates, updates, deletes an image bundle, or applies it to a device or a container. Every action is idempotent: nothing is written when the bundle already is in the requested state, and changed is false.
Images are referenced by name and must already be uploaded to CloudVision. An unknown image name fails the task and lists the missing names.
CREATE: creates the bundle. When it exists with other images the task fails, useUPDATE.UPDATE: replaces the images of an existing bundle.DELETE: removes the bundle. CloudVision refuses it while the bundle is applied.APPLY: applies the bundle todevice(hostname, serial number or IP) orcontainer. CloudVision creates tasks, returned intaskIds: execute them withChangeControl. When the bundle already is applied, nothing is written andtaskIdsis empty: the pending tasks cannot be attributed to this run, select them withGetTasks.
type: io.kestra.plugin.ee.arista.cvp.ImageBundleExamples
Create an image bundle and apply it to a container
id: arista_cvp_image_bundle
namespace: company.network
tasks:
- id: create
type: io.kestra.plugin.ee.arista.cvp.ImageBundle
host: www.cv-prod-us-central1-b.arista.io
token: "{{ secret('CVP_TOKEN') }}"
action: CREATE
name: eos-4.36.0F
images:
- EOS-4.36.0F.swi
- id: apply
type: io.kestra.plugin.ee.arista.cvp.ImageBundle
host: www.cv-prod-us-central1-b.arista.io
token: "{{ secret('CVP_TOKEN') }}"
action: APPLY
name: eos-4.36.0F
container: leaf-pod1
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
CREATEUPDATEDELETEAPPLYAction
CREATE, UPDATE, DELETE or APPLY.
host *string
CloudVision host
Host name or IP address of CloudVision. Use www.cv-prod-<region>.arista.io for CVaaS or the address of your on-prem CVP.
name *string
Image bundle name
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
{}1150authType string
SERVICE_ACCOUNT_TOKENUSER_PASSWORDAuthentication type
SERVICE_ACCOUNT_TOKEN (default, CVaaS and on-prem) sends token as a bearer token.
USER_PASSWORD (on-prem only) logs in with username and password, reuses the session cookie for the task run and logs out at the end.
caCertificate string
CA certificate
PEM encoded CA certificate(s) used to validate the CloudVision certificate. When set, only this CA is trusted. When empty, the JVM trust store is used. An on-prem CVP with a self-signed certificate needs this property.
connectTimeout string
Connect timeout
Maximum time to open the connection. Must be greater than zero. Defaults to 10 seconds.
container string
Container
Name of the target container of the provisioning tree, for the actions that assign or apply (ASSIGN, UNASSIGN, APPLY). Set this or device.
device string
Device
Hostname, FQDN, serial number or IP address of the target device, for the actions that assign or apply (ASSIGN, UNASSIGN, APPLY). Set this or container.
images array
Image names
Names of the images already uploaded to CloudVision, for example EOS-4.36.0F.swi. Required for CREATE and UPDATE.
insecureTrustAllCertificates booleanstring
Trust any certificate
Disables certificate and host name validation. Only for labs with self-signed certificates. Defaults to false.
password string
Password
Required for USER_PASSWORD. Use {{ secret('CVP_PASSWORD') }}. The value is never logged nor returned in outputs.
port integerstring
Port
Between 1 and 65535. Defaults to 443.
requestTimeout string
Request timeout
Maximum time to wait for one CloudVision answer. Must be greater than zero. Defaults to 60 seconds.
token string
Service account token
Required for SERVICE_ACCOUNT_TOKEN. Use {{ secret('CVP_TOKEN') }}. The value is never logged nor returned in outputs.
username string
Username
Required for USER_PASSWORD.
Outputs
changed boolean
Changed
True when the bundle was written. False when it already was in the requested state.
key string
Image bundle key
CloudVision key of the bundle. Not set when DELETE found nothing to delete.
taskIds array
Task ids
CloudVision tasks created by APPLY, to execute with ChangeControl. Empty when the bundle already is applied: use GetTasks to pick pending tasks.