Arista CloudVision GetTasks

Arista CloudVision GetTasks

Certified
Enterprise Edition

List CloudVision tasks by status

Lists the CloudVision tasks (the work orders created by configlet or image bundle assignments) in one status. Tasks are not executed here: group them in a change control with ChangeControl.

fetchType chooses the output: FETCH (default) returns every task in tasks, FETCH_ONE the first one in task, STORE writes them to an Ion file in internal storage and returns uri, NONE returns only size.

yaml
type: io.kestra.plugin.ee.arista.cvp.GetTasks

List the pending tasks of an on-prem CVP

yaml
id: arista_cvp_pending_tasks
namespace: company.network

tasks:
  - id: pending
    type: io.kestra.plugin.ee.arista.cvp.GetTasks
    host: cvp.lab.example.com
    token: "{{ secret('CVP_TOKEN') }}"
    caCertificate: "{{ secret('CVP_CA_PEM') }}"
    status: PENDING
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

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.

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
Possible Values
SERVICE_ACCOUNT_TOKENUSER_PASSWORD

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

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.

Connect timeout

Maximum time to open the connection. Must be greater than zero. Defaults to 10 seconds.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

FETCH (default) returns the tasks in tasks, FETCH_ONE the first task in task, STORE writes them to an Ion file in internal storage and returns uri, NONE returns only size.

Trust any certificate

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

Password

Required for USER_PASSWORD. Use {{ secret('CVP_PASSWORD') }}. The value is never logged nor returned in outputs.

Port

Between 1 and 65535. Defaults to 443.

Request timeout

Maximum time to wait for one CloudVision answer. Must be greater than zero. Defaults to 60 seconds.

Possible Values
PENDINGFAILEDCOMPLETEDCANCELLED

Task status

PENDING (default), FAILED, COMPLETED or CANCELLED.

Service account token

Required for SERVICE_ACCOUNT_TOKEN. Use {{ secret('CVP_TOKEN') }}. The value is never logged nor returned in outputs.

Username

Required for USER_PASSWORD.

Number of tasks

Task

First task. Only set with fetchType FETCH_ONE, and not when there is no task.

Definitions
createdBystring

Created by

descriptionstring

Description

statusstring

Status

taskIdstring

Task id

CloudVision work order id, usable in ChangeControl taskIds.

Tasks

Only set with fetchType FETCH.

Definitions
createdBystring

Created by

descriptionstring

Description

statusstring

Status

taskIdstring

Task id

CloudVision work order id, usable in ChangeControl taskIds.

Formaturi

Tasks file

Internal storage URI of an Ion file with one task per row. Only set with fetchType STORE.