cloudvision.api.arista.inventory.v1 package

Module contents

class cloudvision.api.arista.inventory.v1.DecommissioningStatus(value: int)[source]

Bases: Enum

DecommissioningStatus defines the set of possible states in the decommissioning process for a device.

FAILURE = DecommissioningStatus.FAILURE: DECOMMISSIONING_STATUS_FAILURE indicates decommissioning failed.

IN_PROGRESS = DecommissioningStatus.IN_PROGRESS: DECOMMISSIONING_STATUS_IN_PROGRESS indicates decommissioning is in progress.

SUCCESS = DecommissioningStatus.SUCCESS: DECOMMISSIONING_STATUS_SUCCESS indicates decommissioning succeeded.

UNSPECIFIED = DecommissioningStatus.UNSPECIFIED: DECOMMISSIONING_STATUS_UNSPECIFIED indicates decommissioning status is unspecified.

name: str | None

value: int

class cloudvision.api.arista.inventory.v1.Device(key: ~cloudvision.api.arista.inventory.v1.DeviceKey = <PLACEHOLDER>, software_version: str | None = <PLACEHOLDER>, model_name: str | None = <PLACEHOLDER>, hardware_revision: str | None = <PLACEHOLDER>, fqdn: str | None = <PLACEHOLDER>, hostname: str | None = <PLACEHOLDER>, domain_name: str | None = <PLACEHOLDER>, system_mac_address: str | None = <PLACEHOLDER>, boot_time: ~datetime.datetime = <PLACEHOLDER>, streaming_status: ~cloudvision.api.arista.inventory.v1.StreamingStatus = <PLACEHOLDER>, extended_attributes: ~cloudvision.api.arista.inventory.v1.ExtendedAttributes = <PLACEHOLDER>)[source]

Bases: Message

Device describes an onboarded device.

boot_time: datetime = <PLACEHOLDER>: boot_time indicates when the device was last booted.

domain_name: str | None = <PLACEHOLDER>: domain_name provides the domain name on which the device is registered.

extended_attributes: ExtendedAttributes = <PLACEHOLDER>: extended_attributes wraps any additional, potentially non-standard, features or attributes that the device reports.

fqdn: str | None = <PLACEHOLDER>: fqdn gives the device’s fully qualified domain name.

hardware_revision: str | None = <PLACEHOLDER>: hardware_revision describes any revisional data to the model name.

hostname: str | None = <PLACEHOLDER>: hostname is the hostname as reported on the device.

key: DeviceKey = <PLACEHOLDER>: key uniquely identifies the device.

model_name: str | None = <PLACEHOLDER>: model_name describes the hardware model of this device.

software_version: str | None = <PLACEHOLDER>: software_version gives the currently running device software version.

streaming_status: StreamingStatus = <PLACEHOLDER>: streaming_status is the status of telemetry streaming for this device.

system_mac_address: str | None = <PLACEHOLDER>: system_mac_address provides the MAC address of the management port.

class cloudvision.api.arista.inventory.v1.DeviceBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Device')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[Device] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each Device at end. * Each Device response is fully-specified (all fields set).

start: Returns the state of each Device at start, followed by updates until now. * Each Device response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each Device at start, followed by updates until end. * Each Device response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceBatchedStreamResponse(responses: List[ForwardRef('DeviceStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[DeviceStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.inventory.v1.DeviceConfiguration(options: ~typing.Dict[str, str] = <PLACEHOLDER>)[source]

Bases: Message

DeviceConfiguration holds the device-specific configuration for a third-party device, as defined in https://github.com/aristanetworks/cloudvision-go.

options: Dict[str, str] = <PLACEHOLDER>

options is a map from device option to value.

E.g., for an SNMP device, this could be the following:

“address”: “my_snmp_hostname”, “community”: “public”

class cloudvision.api.arista.inventory.v1.DeviceDecommissioning(key: ~cloudvision.api.arista.inventory.v1.UuidKey = <PLACEHOLDER>, status: ~cloudvision.api.arista.inventory.v1.DecommissioningStatus = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, status_message: str | None = <PLACEHOLDER>)[source]

Bases: Message

DeviceDecommissioning describes the status of a decommissioning process.

error: str | None = <PLACEHOLDER>: error is the error that caused status to become DECOMMISSIONING_STATUS_FAILURE.

key: UuidKey = <PLACEHOLDER>: key identifies the request for which to retrieve a decommissioning status.

status: DecommissioningStatus = <PLACEHOLDER>: status describes the decommissioning status of the device.

status_message: str | None = <PLACEHOLDER>: status_message contains information on the status of the decommissioning attempt, if any. This is generally an unstructured log message that is for display purposes only (its structure and contents may change).

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningBatchedStreamRequest(partial_eq_filter: List[ForwardRef('DeviceDecommissioning')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[DeviceDecommissioning] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceDecommissioning at end. * Each DeviceDecommissioning response is fully-specified (all fields set).

start: Returns the state of each DeviceDecommissioning at start, followed by updates until now. * Each DeviceDecommissioning response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceDecommissioning at start, followed by updates until end. * Each DeviceDecommissioning response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningBatchedStreamResponse(responses: List[ForwardRef('DeviceDecommissioningStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[DeviceDecommissioningStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfig(key: ~cloudvision.api.arista.inventory.v1.UuidKey = <PLACEHOLDER>, device_id: str | None = <PLACEHOLDER>, force: bool | None = <PLACEHOLDER>, user_name: str | None = <PLACEHOLDER>)[source]

Bases: Message

DeviceDecommissioningConfig describes a device decommissioning request. “Decommissioning” refers to the process of stopping device streaming to CloudVision and removing it from CloudVision’s inventory.

The request flow works as follows:

Set on DeviceDecommissioningConfig sends a decommissioning request with a UUID that the user is responsible for generating.
Once the server receives the request, it validates and records it.
Then, the server processes it, initiating the decommissioning procedure and tracking the status of the decommissioning attempt.
The user may do a GetOne or Subscribe on DeviceDecommissioning using the same UUID to see the status of the request.

NOTE: this operation does not remove references to the decommissioned device from Studios and Tags. See DecommissionConfig in arista.studio_topology.v1.

device_id: str | None = <PLACEHOLDER>: device_id is the unique device ID that was discovered via onboarding.

force: bool | None = <PLACEHOLDER>: force is a flag that indicates if the decommission is to be forced. Normally, if there are pending or in-progress tasks associated with the device the decommission would fail. In case of a forced decommission, such blocking tasks would be ignored and decommissioning will be continued.

key: UuidKey = <PLACEHOLDER>: key identifies the request to decommission the device.

user_name: str | None = <PLACEHOLDER>: user_name is name of the user who decommissioned the device.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('DeviceDecommissioningConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[DeviceDecommissioningConfig] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceDecommissioningConfig at end. * Each DeviceDecommissioningConfig response is fully-specified (all fields set).

start: Returns the state of each DeviceDecommissioningConfig at start, followed by updates until now. * Each DeviceDecommissioningConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceDecommissioningConfig at start, followed by updates until end. * Each DeviceDecommissioningConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigBatchedStreamResponse(responses: List[ForwardRef('DeviceDecommissioningConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[DeviceDecommissioningConfigStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('DeviceDecommissioningConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[DeviceDecommissioningConfig] = <PLACEHOLDER>: PartialEqFilter provides a way to server-side filter a DeleteAll. This requires all provided fields to be equal to the response. A filtered DeleteAll will use GetAll with filter to find things to delete.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: UuidKey = <PLACEHOLDER>: This is the key of the DeviceDecommissioningConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigDeleteRequest(key: 'UuidKey' = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key indicates which DeviceDecommissioningConfig instance to remove. This field must always be set.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigDeleteResponse(key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key echoes back the key of the deleted DeviceDecommissioningConfig instance.

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are:

it is after the time the request was received

a time-ranged query with StartTime==DeletedAt will not include this instance.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigDeleteSomeRequest(keys: List[ForwardRef('UuidKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[UuidKey] = <PLACEHOLDER>: key contains a list of DeviceDecommissioningConfig keys to delete

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigDeleteSomeResponse(key: ~cloudvision.api.arista.inventory.v1.UuidKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

DeviceDecommissioningConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: UuidKey = <PLACEHOLDER>

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigRequest(key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key uniquely identifies a DeviceDecommissioningConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigResponse(value: 'DeviceDecommissioningConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the DeviceDecommissioningConfig instance in this response.

value: DeviceDecommissioningConfig = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigServiceBase[source]

Bases: ServiceBase

async delete(device_decommissioning_config_delete_request: DeviceDecommissioningConfigDeleteRequest) → DeviceDecommissioningConfigDeleteResponse[source]

async delete_all(device_decommissioning_config_delete_all_request: DeviceDecommissioningConfigDeleteAllRequest) → AsyncIterator[DeviceDecommissioningConfigDeleteAllResponse][source]

async delete_some(device_decommissioning_config_delete_some_request: DeviceDecommissioningConfigDeleteSomeRequest) → AsyncIterator[DeviceDecommissioningConfigDeleteSomeResponse][source]

async get_all(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest) → AsyncIterator[DeviceDecommissioningConfigStreamResponse][source]

async get_all_batched(device_decommissioning_config_batched_stream_request: DeviceDecommissioningConfigBatchedStreamRequest) → AsyncIterator[DeviceDecommissioningConfigBatchedStreamResponse][source]

async get_meta(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest) → MetaResponse[source]

async get_one(device_decommissioning_config_request: DeviceDecommissioningConfigRequest) → DeviceDecommissioningConfigResponse[source]

async get_some(device_decommissioning_config_some_request: DeviceDecommissioningConfigSomeRequest) → AsyncIterator[DeviceDecommissioningConfigSomeResponse][source]

async set(device_decommissioning_config_set_request: DeviceDecommissioningConfigSetRequest) → DeviceDecommissioningConfigSetResponse[source]

async set_some(device_decommissioning_config_set_some_request: DeviceDecommissioningConfigSetSomeRequest) → AsyncIterator[DeviceDecommissioningConfigSetSomeResponse][source]

async subscribe(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest) → AsyncIterator[DeviceDecommissioningConfigStreamResponse][source]

async subscribe_batched(device_decommissioning_config_batched_stream_request: DeviceDecommissioningConfigBatchedStreamRequest) → AsyncIterator[DeviceDecommissioningConfigBatchedStreamResponse][source]

async subscribe_meta(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(device_decommissioning_config_delete_request: DeviceDecommissioningConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceDecommissioningConfigDeleteResponse[source]

async delete_all(device_decommissioning_config_delete_all_request: DeviceDecommissioningConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigDeleteAllResponse][source]

async delete_some(device_decommissioning_config_delete_some_request: DeviceDecommissioningConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigDeleteSomeResponse][source]

async get_all(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigStreamResponse][source]

async get_all_batched(device_decommissioning_config_batched_stream_request: DeviceDecommissioningConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigBatchedStreamResponse][source]

async get_meta(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(device_decommissioning_config_request: DeviceDecommissioningConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceDecommissioningConfigResponse[source]

async get_some(device_decommissioning_config_some_request: DeviceDecommissioningConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigSomeResponse][source]

async set(device_decommissioning_config_set_request: DeviceDecommissioningConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceDecommissioningConfigSetResponse[source]

async set_some(device_decommissioning_config_set_some_request: DeviceDecommissioningConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigSetSomeResponse][source]

async subscribe(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigStreamResponse][source]

async subscribe_batched(device_decommissioning_config_batched_stream_request: DeviceDecommissioningConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningConfigBatchedStreamResponse][source]

async subscribe_meta(device_decommissioning_config_stream_request: DeviceDecommissioningConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigSetRequest(value: 'DeviceDecommissioningConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: DeviceDecommissioningConfig = <PLACEHOLDER>: DeviceDecommissioningConfig carries the value to set into the datastore. See the documentation on the DeviceDecommissioningConfig struct for which fields are required.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigSetResponse(value: 'DeviceDecommissioningConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are:

it is after the time the request was received

a time-ranged query with StartTime==CreatedAt will include this instance.

value: DeviceDecommissioningConfig = <PLACEHOLDER>: Value carries all the values given in the DeviceDecommissioningConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigSetSomeRequest(values: List[ForwardRef('DeviceDecommissioningConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[DeviceDecommissioningConfig] = <PLACEHOLDER>

value contains a list of DeviceDecommissioningConfig values to write. It is possible to provide more values than can fit within either:

the maxiumum send size of the client

the maximum receive size of the server

If this error occurs you must reduce the number of values sent. See gRPC “maximum message size” documentation for more information.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigSetSomeResponse(key: 'UuidKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: UuidKey = <PLACEHOLDER>

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigSomeRequest(keys: List[ForwardRef('UuidKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[UuidKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigSomeResponse(value: 'DeviceDecommissioningConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: DeviceDecommissioningConfig = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigStreamRequest(partial_eq_filter: List[ForwardRef('DeviceDecommissioningConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[DeviceDecommissioningConfig] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceDecommissioningConfig at end. * Each DeviceDecommissioningConfig response is fully-specified (all fields set).

start: Returns the state of each DeviceDecommissioningConfig at start, followed by updates until now. * Each DeviceDecommissioningConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceDecommissioningConfig at start, followed by updates until end. * Each DeviceDecommissioningConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningConfigStreamResponse(value: 'DeviceDecommissioningConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this DeviceDecommissioningConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the DeviceDecommissioningConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: DeviceDecommissioningConfig = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningRequest(key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key uniquely identifies a DeviceDecommissioning instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningResponse(value: 'DeviceDecommissioning' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the DeviceDecommissioning instance in this response.

value: DeviceDecommissioning = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningServiceBase[source]

Bases: ServiceBase

async get_all(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest) → AsyncIterator[DeviceDecommissioningStreamResponse][source]

async get_all_batched(device_decommissioning_batched_stream_request: DeviceDecommissioningBatchedStreamRequest) → AsyncIterator[DeviceDecommissioningBatchedStreamResponse][source]

async get_meta(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest) → MetaResponse[source]

async get_one(device_decommissioning_request: DeviceDecommissioningRequest) → DeviceDecommissioningResponse[source]

async get_some(device_decommissioning_some_request: DeviceDecommissioningSomeRequest) → AsyncIterator[DeviceDecommissioningSomeResponse][source]

async subscribe(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest) → AsyncIterator[DeviceDecommissioningStreamResponse][source]

async subscribe_batched(device_decommissioning_batched_stream_request: DeviceDecommissioningBatchedStreamRequest) → AsyncIterator[DeviceDecommissioningBatchedStreamResponse][source]

async subscribe_meta(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningStreamResponse][source]

async get_all_batched(device_decommissioning_batched_stream_request: DeviceDecommissioningBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningBatchedStreamResponse][source]

async get_meta(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(device_decommissioning_request: DeviceDecommissioningRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceDecommissioningResponse[source]

async get_some(device_decommissioning_some_request: DeviceDecommissioningSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningSomeResponse][source]

async subscribe(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningStreamResponse][source]

async subscribe_batched(device_decommissioning_batched_stream_request: DeviceDecommissioningBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceDecommissioningBatchedStreamResponse][source]

async subscribe_meta(device_decommissioning_stream_request: DeviceDecommissioningStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningSomeRequest(keys: List[ForwardRef('UuidKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[UuidKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningSomeResponse(value: 'DeviceDecommissioning' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: DeviceDecommissioning = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningStreamRequest(partial_eq_filter: List[ForwardRef('DeviceDecommissioning')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[DeviceDecommissioning] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceDecommissioning at end. * Each DeviceDecommissioning response is fully-specified (all fields set).

start: Returns the state of each DeviceDecommissioning at start, followed by updates until now. * Each DeviceDecommissioning response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceDecommissioning at start, followed by updates until end. * Each DeviceDecommissioning response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceDecommissioningStreamResponse(value: 'DeviceDecommissioning' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this DeviceDecommissioning’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the DeviceDecommissioning value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: DeviceDecommissioning = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.inventory.v1.DeviceKey(device_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

DeviceKey uniquely identifies a single device.

device_id: str | None = <PLACEHOLDER>: device_id is the unique identifier of the device.

class cloudvision.api.arista.inventory.v1.DeviceOnboarding(key: ~cloudvision.api.arista.inventory.v1.UuidKey = <PLACEHOLDER>, device_id: str | None = <PLACEHOLDER>, status: ~cloudvision.api.arista.inventory.v1.OnboardingStatus = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, status_message: str | None = <PLACEHOLDER>)[source]

Bases: Message

DeviceOnboarding describes the status of an onboarding process.

device_id: str | None = <PLACEHOLDER>: device_id is the unique device ID that is discovered via onboarding.

error: str | None = <PLACEHOLDER>: error is the error that caused status to become ONBOARDING_STATUS_FAILURE.

key: UuidKey = <PLACEHOLDER>: key identifies the request for which to retrieve an onboarding status.

status: OnboardingStatus = <PLACEHOLDER>: status describes the onboarding status of the device.

status_message: str | None = <PLACEHOLDER>: status_message contains information on the status of the onboarding attempt, if any. This is generally an unstructured log message that is for display purposes only (its structure and contents may change).

class cloudvision.api.arista.inventory.v1.DeviceOnboardingBatchedStreamRequest(partial_eq_filter: List[ForwardRef('DeviceOnboarding')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[DeviceOnboarding] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceOnboarding at end. * Each DeviceOnboarding response is fully-specified (all fields set).

start: Returns the state of each DeviceOnboarding at start, followed by updates until now. * Each DeviceOnboarding response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceOnboarding at start, followed by updates until end. * Each DeviceOnboarding response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingBatchedStreamResponse(responses: List[ForwardRef('DeviceOnboardingStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[DeviceOnboardingStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfig(key: ~cloudvision.api.arista.inventory.v1.UuidKey = <PLACEHOLDER>, hostname_or_ip: str | None = <PLACEHOLDER>, device_type: str | None = <PLACEHOLDER>, device_config: ~cloudvision.api.arista.inventory.v1.DeviceConfiguration = <PLACEHOLDER>, profile_name: str | None = <PLACEHOLDER>)[source]

Bases: Message

DeviceOnboardingConfig describes a device onboarding request. “Onboarding” refers to the process of initiating device streaming to CloudVision and adding the streaming device to CloudVision’s inventory.

The request flow works as follows:

Set on DeviceOnboardingConfig sends an onboarding request with a UUID that the user is responsible for generating.
Once the server receives the request, it validates and records it.
Then, the server processes it, initiating the onboarding procedure and tracking the status of the onboarding attempt.
The user may do a GetOne or Subscribe on DeviceOnboarding using the same UUID to see the status of the request.

device_config: DeviceConfiguration = <PLACEHOLDER>: device_config is the configuration for a third-party device.

device_type: str | None = <PLACEHOLDER>: device_type describes the method by which to retrieve information for the device. The value should be “eos” for eos devices. For third-party devices, supported values are: “openconfig”, “snmp”, “cvp”, “mwm”, and “vCenter”.

hostname_or_ip: str | None = <PLACEHOLDER>: hostname_or_ip is a hostname or an IP at which the device can be reached.

key: UuidKey = <PLACEHOLDER>: key identifies the request to onboard the device at hostname_or_ip.

profile_name: str | None = <PLACEHOLDER>: profile_name specifies the name of the TerminAttr profile which includes the custom TerminAttr configuration to be applied to the device while onboarding.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('DeviceOnboardingConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[DeviceOnboardingConfig] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceOnboardingConfig at end. * Each DeviceOnboardingConfig response is fully-specified (all fields set).

start: Returns the state of each DeviceOnboardingConfig at start, followed by updates until now. * Each DeviceOnboardingConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceOnboardingConfig at start, followed by updates until end. * Each DeviceOnboardingConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigBatchedStreamResponse(responses: List[ForwardRef('DeviceOnboardingConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[DeviceOnboardingConfigStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('DeviceOnboardingConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[DeviceOnboardingConfig] = <PLACEHOLDER>: PartialEqFilter provides a way to server-side filter a DeleteAll. This requires all provided fields to be equal to the response. A filtered DeleteAll will use GetAll with filter to find things to delete.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: UuidKey = <PLACEHOLDER>: This is the key of the DeviceOnboardingConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigDeleteRequest(key: 'UuidKey' = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key indicates which DeviceOnboardingConfig instance to remove. This field must always be set.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigDeleteResponse(key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key echoes back the key of the deleted DeviceOnboardingConfig instance.

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are:

it is after the time the request was received

a time-ranged query with StartTime==DeletedAt will not include this instance.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigDeleteSomeRequest(keys: List[ForwardRef('UuidKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[UuidKey] = <PLACEHOLDER>: key contains a list of DeviceOnboardingConfig keys to delete

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigDeleteSomeResponse(key: ~cloudvision.api.arista.inventory.v1.UuidKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

DeviceOnboardingConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: UuidKey = <PLACEHOLDER>

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigRequest(key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key uniquely identifies a DeviceOnboardingConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigResponse(value: 'DeviceOnboardingConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the DeviceOnboardingConfig instance in this response.

value: DeviceOnboardingConfig = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigServiceBase[source]

Bases: ServiceBase

async delete(device_onboarding_config_delete_request: DeviceOnboardingConfigDeleteRequest) → DeviceOnboardingConfigDeleteResponse[source]

async delete_all(device_onboarding_config_delete_all_request: DeviceOnboardingConfigDeleteAllRequest) → AsyncIterator[DeviceOnboardingConfigDeleteAllResponse][source]

async delete_some(device_onboarding_config_delete_some_request: DeviceOnboardingConfigDeleteSomeRequest) → AsyncIterator[DeviceOnboardingConfigDeleteSomeResponse][source]

async get_all(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest) → AsyncIterator[DeviceOnboardingConfigStreamResponse][source]

async get_all_batched(device_onboarding_config_batched_stream_request: DeviceOnboardingConfigBatchedStreamRequest) → AsyncIterator[DeviceOnboardingConfigBatchedStreamResponse][source]

async get_meta(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest) → MetaResponse[source]

async get_one(device_onboarding_config_request: DeviceOnboardingConfigRequest) → DeviceOnboardingConfigResponse[source]

async get_some(device_onboarding_config_some_request: DeviceOnboardingConfigSomeRequest) → AsyncIterator[DeviceOnboardingConfigSomeResponse][source]

async set(device_onboarding_config_set_request: DeviceOnboardingConfigSetRequest) → DeviceOnboardingConfigSetResponse[source]

async set_some(device_onboarding_config_set_some_request: DeviceOnboardingConfigSetSomeRequest) → AsyncIterator[DeviceOnboardingConfigSetSomeResponse][source]

async subscribe(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest) → AsyncIterator[DeviceOnboardingConfigStreamResponse][source]

async subscribe_batched(device_onboarding_config_batched_stream_request: DeviceOnboardingConfigBatchedStreamRequest) → AsyncIterator[DeviceOnboardingConfigBatchedStreamResponse][source]

async subscribe_meta(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(device_onboarding_config_delete_request: DeviceOnboardingConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceOnboardingConfigDeleteResponse[source]

async delete_all(device_onboarding_config_delete_all_request: DeviceOnboardingConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigDeleteAllResponse][source]

async delete_some(device_onboarding_config_delete_some_request: DeviceOnboardingConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigDeleteSomeResponse][source]

async get_all(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigStreamResponse][source]

async get_all_batched(device_onboarding_config_batched_stream_request: DeviceOnboardingConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigBatchedStreamResponse][source]

async get_meta(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(device_onboarding_config_request: DeviceOnboardingConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceOnboardingConfigResponse[source]

async get_some(device_onboarding_config_some_request: DeviceOnboardingConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigSomeResponse][source]

async set(device_onboarding_config_set_request: DeviceOnboardingConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceOnboardingConfigSetResponse[source]

async set_some(device_onboarding_config_set_some_request: DeviceOnboardingConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigSetSomeResponse][source]

async subscribe(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigStreamResponse][source]

async subscribe_batched(device_onboarding_config_batched_stream_request: DeviceOnboardingConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingConfigBatchedStreamResponse][source]

async subscribe_meta(device_onboarding_config_stream_request: DeviceOnboardingConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigSetRequest(value: 'DeviceOnboardingConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: DeviceOnboardingConfig = <PLACEHOLDER>: DeviceOnboardingConfig carries the value to set into the datastore. See the documentation on the DeviceOnboardingConfig struct for which fields are required.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigSetResponse(value: 'DeviceOnboardingConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are:

it is after the time the request was received

a time-ranged query with StartTime==CreatedAt will include this instance.

value: DeviceOnboardingConfig = <PLACEHOLDER>: Value carries all the values given in the DeviceOnboardingConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigSetSomeRequest(values: List[ForwardRef('DeviceOnboardingConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[DeviceOnboardingConfig] = <PLACEHOLDER>

value contains a list of DeviceOnboardingConfig values to write. It is possible to provide more values than can fit within either:

the maxiumum send size of the client

the maximum receive size of the server

If this error occurs you must reduce the number of values sent. See gRPC “maximum message size” documentation for more information.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigSetSomeResponse(key: 'UuidKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: UuidKey = <PLACEHOLDER>

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigSomeRequest(keys: List[ForwardRef('UuidKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[UuidKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigSomeResponse(value: 'DeviceOnboardingConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: DeviceOnboardingConfig = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigStreamRequest(partial_eq_filter: List[ForwardRef('DeviceOnboardingConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[DeviceOnboardingConfig] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceOnboardingConfig at end. * Each DeviceOnboardingConfig response is fully-specified (all fields set).

start: Returns the state of each DeviceOnboardingConfig at start, followed by updates until now. * Each DeviceOnboardingConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceOnboardingConfig at start, followed by updates until end. * Each DeviceOnboardingConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingConfigStreamResponse(value: 'DeviceOnboardingConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this DeviceOnboardingConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the DeviceOnboardingConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: DeviceOnboardingConfig = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingRequest(key: 'UuidKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: UuidKey = <PLACEHOLDER>: Key uniquely identifies a DeviceOnboarding instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingResponse(value: 'DeviceOnboarding' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the DeviceOnboarding instance in this response.

value: DeviceOnboarding = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingServiceBase[source]

Bases: ServiceBase

async get_all(device_onboarding_stream_request: DeviceOnboardingStreamRequest) → AsyncIterator[DeviceOnboardingStreamResponse][source]

async get_all_batched(device_onboarding_batched_stream_request: DeviceOnboardingBatchedStreamRequest) → AsyncIterator[DeviceOnboardingBatchedStreamResponse][source]

async get_meta(device_onboarding_stream_request: DeviceOnboardingStreamRequest) → MetaResponse[source]

async get_one(device_onboarding_request: DeviceOnboardingRequest) → DeviceOnboardingResponse[source]

async get_some(device_onboarding_some_request: DeviceOnboardingSomeRequest) → AsyncIterator[DeviceOnboardingSomeResponse][source]

async subscribe(device_onboarding_stream_request: DeviceOnboardingStreamRequest) → AsyncIterator[DeviceOnboardingStreamResponse][source]

async subscribe_batched(device_onboarding_batched_stream_request: DeviceOnboardingBatchedStreamRequest) → AsyncIterator[DeviceOnboardingBatchedStreamResponse][source]

async subscribe_meta(device_onboarding_stream_request: DeviceOnboardingStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(device_onboarding_stream_request: DeviceOnboardingStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingStreamResponse][source]

async get_all_batched(device_onboarding_batched_stream_request: DeviceOnboardingBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingBatchedStreamResponse][source]

async get_meta(device_onboarding_stream_request: DeviceOnboardingStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(device_onboarding_request: DeviceOnboardingRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceOnboardingResponse[source]

async get_some(device_onboarding_some_request: DeviceOnboardingSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingSomeResponse][source]

async subscribe(device_onboarding_stream_request: DeviceOnboardingStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingStreamResponse][source]

async subscribe_batched(device_onboarding_batched_stream_request: DeviceOnboardingBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceOnboardingBatchedStreamResponse][source]

async subscribe_meta(device_onboarding_stream_request: DeviceOnboardingStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.inventory.v1.DeviceOnboardingSomeRequest(keys: List[ForwardRef('UuidKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[UuidKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingSomeResponse(value: 'DeviceOnboarding' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: DeviceOnboarding = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingStreamRequest(partial_eq_filter: List[ForwardRef('DeviceOnboarding')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[DeviceOnboarding] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DeviceOnboarding at end. * Each DeviceOnboarding response is fully-specified (all fields set).

start: Returns the state of each DeviceOnboarding at start, followed by updates until now. * Each DeviceOnboarding response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DeviceOnboarding at start, followed by updates until end. * Each DeviceOnboarding response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceOnboardingStreamResponse(value: 'DeviceOnboarding' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this DeviceOnboarding’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the DeviceOnboarding value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: DeviceOnboarding = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.inventory.v1.DeviceRequest(key: 'DeviceKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: DeviceKey = <PLACEHOLDER>: Key uniquely identifies a Device instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceResponse(value: 'Device' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the Device instance in this response.

value: Device = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceServiceBase[source]

Bases: ServiceBase

async get_all(device_stream_request: DeviceStreamRequest) → AsyncIterator[DeviceStreamResponse][source]

async get_all_batched(device_batched_stream_request: DeviceBatchedStreamRequest) → AsyncIterator[DeviceBatchedStreamResponse][source]

async get_meta(device_stream_request: DeviceStreamRequest) → MetaResponse[source]

async get_one(device_request: DeviceRequest) → DeviceResponse[source]

async get_some(device_some_request: DeviceSomeRequest) → AsyncIterator[DeviceSomeResponse][source]

async subscribe(device_stream_request: DeviceStreamRequest) → AsyncIterator[DeviceStreamResponse][source]

async subscribe_batched(device_batched_stream_request: DeviceBatchedStreamRequest) → AsyncIterator[DeviceBatchedStreamResponse][source]

async subscribe_meta(device_stream_request: DeviceStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(device_stream_request: DeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceStreamResponse][source]

async get_all_batched(device_batched_stream_request: DeviceBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceBatchedStreamResponse][source]

async get_meta(device_stream_request: DeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(device_request: DeviceRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DeviceResponse[source]

async get_some(device_some_request: DeviceSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceSomeResponse][source]

async subscribe(device_stream_request: DeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceStreamResponse][source]

async subscribe_batched(device_batched_stream_request: DeviceBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DeviceBatchedStreamResponse][source]

async subscribe_meta(device_stream_request: DeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.inventory.v1.DeviceSomeRequest(keys: List[ForwardRef('DeviceKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[DeviceKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.DeviceSomeResponse(value: 'Device' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: Device = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.DeviceStreamRequest(partial_eq_filter: List[ForwardRef('Device')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[Device] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each Device at end. * Each Device response is fully-specified (all fields set).

start: Returns the state of each Device at start, followed by updates until now. * Each Device response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each Device at start, followed by updates until end. * Each Device response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.DeviceStreamResponse(value: 'Device' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this Device’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Device value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: Device = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.inventory.v1.ExtendedAttributes(feature_enabled: ~typing.Dict[str, bool] = <PLACEHOLDER>)[source]

Bases: Message

ExtendedAttributes wraps any additional, potentially non-standard, features or attributes the device reports.

feature_enabled: Dict[str, bool] = <PLACEHOLDER>: feature_enabled is a map of feature name to enabled status. If a feature is missing from this map it can be assumed off.

class cloudvision.api.arista.inventory.v1.MetaResponse(time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>, count: int | None = <PLACEHOLDER>)[source]

Bases: Message

count: int | None = <PLACEHOLDER>: Count is the number of items present under the conditions of the request.

time: datetime = <PLACEHOLDER>: Time holds the timestamp of the last item included in the metadata calculation.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

class cloudvision.api.arista.inventory.v1.OnboardingStatus(value: int)[source]

Bases: Enum

OnboardingStatus defines the set of possible states in the onboarding process for a device.

FAILURE = OnboardingStatus.FAILURE: ONBOARDING_STATUS_FAILURE indicates onboarding failed.

IN_PROGRESS = OnboardingStatus.IN_PROGRESS: ONBOARDING_STATUS_IN_PROGRESS indicates onboarding is in progress.

SUCCESS = OnboardingStatus.SUCCESS: ONBOARDING_STATUS_SUCCESS indicates onboarding succeeded.

UNSPECIFIED = OnboardingStatus.UNSPECIFIED: ONBOARDING_STATUS_UNSPECIFIED indicates onboarding status is unspecified.

name: str | None

value: int

class cloudvision.api.arista.inventory.v1.ProvisionedDevice(key: ~cloudvision.api.arista.inventory.v1.DeviceKey = <PLACEHOLDER>, status: ~cloudvision.api.arista.inventory.v1.ProvisioningStatus = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, ztp_mode: bool | None = <PLACEHOLDER>, ip_address: ~cloudvision.api.fmp.IpAddress = <PLACEHOLDER>, provisioning_group_name: str | None = <PLACEHOLDER>, ipv6_address: ~cloudvision.api.fmp.IpAddress = <PLACEHOLDER>)[source]

Bases: Message

ProvisionedDevice describes the provisioning status of an onboarded device if the onboarded device is configured for provisioning.

error: str | None = <PLACEHOLDER>: error is the error that caused status to become PROVISIONING_STATUS_FAILURE.

ip_address: ___fmp__.IpAddress = <PLACEHOLDER>: ip_address is the current (post-provisioning) IP address of the device.

ipv6_address: ___fmp__.IpAddress = <PLACEHOLDER>: ipv6_address is the IPV6 address of the device.

key: DeviceKey = <PLACEHOLDER>: key uniquely identifies the device.

provisioning_group_name: str | None = <PLACEHOLDER>: provisioning_group_name is the name of the group (also known as a container) to which the device belongs. Any provisioning operation performed on this group will also be performed on this device. If the device is not yet provisioned, this will not be set. Once it is provisioned, this will be set to “undefined_container” which indicates that the device does not yet belong to a group. At this point, a user may set it to an existing group.

status: ProvisioningStatus = <PLACEHOLDER>: status describes the onboarded device’s provisioning status.

ztp_mode: bool | None = <PLACEHOLDER>: ztp_mode indicates whether the device is in ZTP mode.

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceBatchedStreamRequest(partial_eq_filter: List[ForwardRef('ProvisionedDevice')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[ProvisionedDevice] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each ProvisionedDevice at end. * Each ProvisionedDevice response is fully-specified (all fields set).

start: Returns the state of each ProvisionedDevice at start, followed by updates until now. * Each ProvisionedDevice response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each ProvisionedDevice at start, followed by updates until end. * Each ProvisionedDevice response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceBatchedStreamResponse(responses: List[ForwardRef('ProvisionedDeviceStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[ProvisionedDeviceStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceRequest(key: 'DeviceKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: DeviceKey = <PLACEHOLDER>: Key uniquely identifies a ProvisionedDevice instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceResponse(value: 'ProvisionedDevice' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the ProvisionedDevice instance in this response.

value: ProvisionedDevice = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceServiceBase[source]

Bases: ServiceBase

async get_all(provisioned_device_stream_request: ProvisionedDeviceStreamRequest) → AsyncIterator[ProvisionedDeviceStreamResponse][source]

async get_all_batched(provisioned_device_batched_stream_request: ProvisionedDeviceBatchedStreamRequest) → AsyncIterator[ProvisionedDeviceBatchedStreamResponse][source]

async get_meta(provisioned_device_stream_request: ProvisionedDeviceStreamRequest) → MetaResponse[source]

async get_one(provisioned_device_request: ProvisionedDeviceRequest) → ProvisionedDeviceResponse[source]

async get_some(provisioned_device_some_request: ProvisionedDeviceSomeRequest) → AsyncIterator[ProvisionedDeviceSomeResponse][source]

async subscribe(provisioned_device_stream_request: ProvisionedDeviceStreamRequest) → AsyncIterator[ProvisionedDeviceStreamResponse][source]

async subscribe_batched(provisioned_device_batched_stream_request: ProvisionedDeviceBatchedStreamRequest) → AsyncIterator[ProvisionedDeviceBatchedStreamResponse][source]

async subscribe_meta(provisioned_device_stream_request: ProvisionedDeviceStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(provisioned_device_stream_request: ProvisionedDeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProvisionedDeviceStreamResponse][source]

async get_all_batched(provisioned_device_batched_stream_request: ProvisionedDeviceBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProvisionedDeviceBatchedStreamResponse][source]

async get_meta(provisioned_device_stream_request: ProvisionedDeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(provisioned_device_request: ProvisionedDeviceRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ProvisionedDeviceResponse[source]

async get_some(provisioned_device_some_request: ProvisionedDeviceSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProvisionedDeviceSomeResponse][source]

async subscribe(provisioned_device_stream_request: ProvisionedDeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProvisionedDeviceStreamResponse][source]

async subscribe_batched(provisioned_device_batched_stream_request: ProvisionedDeviceBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProvisionedDeviceBatchedStreamResponse][source]

async subscribe_meta(provisioned_device_stream_request: ProvisionedDeviceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceSomeRequest(keys: List[ForwardRef('DeviceKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[DeviceKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceSomeResponse(value: 'ProvisionedDevice' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: ProvisionedDevice = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceStreamRequest(partial_eq_filter: List[ForwardRef('ProvisionedDevice')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ProvisionedDevice] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each ProvisionedDevice at end. * Each ProvisionedDevice response is fully-specified (all fields set).

start: Returns the state of each ProvisionedDevice at start, followed by updates until now. * Each ProvisionedDevice response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each ProvisionedDevice at start, followed by updates until end. * Each ProvisionedDevice response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.inventory.v1.ProvisionedDeviceStreamResponse(value: 'ProvisionedDevice' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this ProvisionedDevice’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ProvisionedDevice value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: ProvisionedDevice = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.inventory.v1.ProvisioningStatus(value: int)[source]

Bases: Enum

ProvisioningStatus defines the set of possible states in the provisioning process for a device.

FAILURE = ProvisioningStatus.FAILURE: PROVISIONING_STATUS_FAILURE indicates provisioning failed.

IN_PROGRESS = ProvisioningStatus.IN_PROGRESS: PROVISIONING_STATUS_IN_PROGRESS indicates provisioning is in progress.

SUCCESS = ProvisioningStatus.SUCCESS: PROVISIONING_STATUS_SUCCESS indicates provisioning succeeded.

UNSPECIFIED = ProvisioningStatus.UNSPECIFIED: PROVISIONING_STATUS_UNSPECIFIED indicates provisioning status is unspecified.

name: str | None

value: int

class cloudvision.api.arista.inventory.v1.StreamingStatus(value: int)[source]

Bases: Enum

StreamingStatus defines the status of telemetry streaming for a device.

ACTIVE = StreamingStatus.ACTIVE: STREAMING_STATUS_ACTIVE indicates the device is streaming telemetry.

INACTIVE = StreamingStatus.INACTIVE: STREAMING_STATUS_INACTIVE indicates the device is not streaming telemetry.

UNSPECIFIED = StreamingStatus.UNSPECIFIED: STREAMING_STATUS_UNSPECIFIED indicates the device streaming telemetry status is unspecified.

name: str | None

value: int

class cloudvision.api.arista.inventory.v1.UuidKey(request_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

UUIDKey is a key that holds a UUID for an onboarding or decommissioning request.

request_id: str | None = <PLACEHOLDER>: request_id should be a UUID for the request.