Arista CloudVision GetInventory

Arista CloudVision GetInventory

Certified
Enterprise Edition

List the devices known to CloudVision

Reads the provisioned devices of CloudVision (/inventory/devices, CVP 2018.2+ and CVaaS) and returns hostname, serial number, model, EOS version and streaming status of each device. The container name is resolved from the parent container key of each device with one extra call to the CloudVision container list.

filter keeps the devices whose hostname, serial number or model contains the text (case insensitive). fetchType chooses the output: FETCH (default) returns every device in devices, FETCH_ONE the first one in device, STORE writes them to an Ion file in internal storage and returns uri, NONE returns only size. Use STORE for large inventories.

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

List the leaf switches of a CVaaS tenant

yaml
id: arista_cvp_inventory
namespace: company.network

tasks:
  - id: inventory
    type: io.kestra.plugin.ee.arista.cvp.GetInventory
    host: www.cv-prod-us-central1-b.arista.io
    token: "{{ secret('CVP_TOKEN') }}"
    filter: leaf
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 devices in devices, FETCH_ONE the first device in device, STORE writes them to an Ion file in internal storage and returns uri, NONE returns only size.

Filter

Keeps the devices whose hostname, serial number or model contains this text, ignoring case. All devices when empty.

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.

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.

Device

First device. Only set with fetchType FETCH_ONE, and not when the inventory is empty.

Definitions
containerstring

Container in the CloudVision provisioning tree

Resolved from the parentContainerKey of the device and the container list of CloudVision. Not set when the container is not found.

eosVersionstring

EOS version

fqdnstring

Fully qualified domain name

hostnamestring

Hostname

ipAddressstring

Management IP address

modelstring

Model

serialNumberstring

Serial number

statusstring

Connection status

Registration status reported by CloudVision, for example Registered.

streamingStatusstring

Streaming status

Telemetry streaming status reported by CloudVision, for example active.

Devices

Only set with fetchType FETCH.

Definitions
containerstring

Container in the CloudVision provisioning tree

Resolved from the parentContainerKey of the device and the container list of CloudVision. Not set when the container is not found.

eosVersionstring

EOS version

fqdnstring

Fully qualified domain name

hostnamestring

Hostname

ipAddressstring

Management IP address

modelstring

Model

serialNumberstring

Serial number

statusstring

Connection status

Registration status reported by CloudVision, for example Registered.

streamingStatusstring

Streaming status

Telemetry streaming status reported by CloudVision, for example active.

Number of devices

Number of devices after filtering.

Formaturi

Devices file

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