inventory.v1
Available Services
DeviceDecommissioningConfigService
arista/inventory.v1/inventory.proto
Device
Device describes an onboarded device.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the device. |
software_version | google.protobuf.StringValue | software_version gives the currently running device software version. |
model_name | google.protobuf.StringValue | model_name describes the hardware model of this device. |
hardware_revision | google.protobuf.StringValue | hardware_revision describes any revisional data to the model name. |
fqdn | google.protobuf.StringValue | fqdn gives the device's fully qualified domain name. |
hostname | google.protobuf.StringValue | hostname is the hostname as reported on the device. |
domain_name | google.protobuf.StringValue | domain_name provides the domain name on which the device is registered. |
system_mac_address | google.protobuf.StringValue | system_mac_address provides the MAC address of the management port. |
boot_time | google.protobuf.Timestamp | boot_time indicates when the device was last booted. |
streaming_status | StreamingStatus | streaming_status is the status of telemetry streaming for this device. |
extended_attributes | ExtendedAttributes | extended_attributes wraps any additional, potentially non-standard, features or attributes that the device reports. |
DeviceConfiguration
DeviceConfiguration holds the device-specific configuration for a third-party device, as defined in https://github.com/aristanetworks/cloudvision-go.
Field Name | Type | Description |
---|---|---|
options | DeviceConfiguration.OptionsEntry[...] | 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" |
DeviceConfiguration.OptionsEntry
Field Name | Type | Description |
---|---|---|
key | string | |
value | string |
DeviceDecommissioning
DeviceDecommissioning describes the status of a decommissioning process.
Field Name | Type | Description |
---|---|---|
key | UUIDKey | key identifies the request for which to retrieve a decommissioning status. |
status | DecommissioningStatus | status describes the decommissioning status of the device. |
error | google.protobuf.StringValue | error is the error that caused status to become DECOMMISSIONING_STATUS_FAILURE. |
status_message | google.protobuf.StringValue | 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). |
DeviceDecommissioningConfig
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
.
Field Name | Type | Description |
---|---|---|
key | UUIDKey | key identifies the request to decommission the device. |
device_id | google.protobuf.StringValue | device_id is the unique device ID that was discovered via onboarding. |
force | google.protobuf.BoolValue | 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. |
user_name | google.protobuf.StringValue | user_name is name of the user who decommissioned the device. |
DeviceKey
DeviceKey uniquely identifies a single device.
Field Name | Type | Description |
---|---|---|
device_id | google.protobuf.StringValue | device_id is the unique identifier of the device. |
DeviceOnboarding
DeviceOnboarding describes the status of an onboarding process.
Field Name | Type | Description |
---|---|---|
key | UUIDKey | key identifies the request for which to retrieve an onboarding status. |
device_id | google.protobuf.StringValue | device_id is the unique device ID that is discovered via onboarding. |
status | OnboardingStatus | status describes the onboarding status of the device. |
error | google.protobuf.StringValue | error is the error that caused status to become ONBOARDING_STATUS_FAILURE. |
status_message | google.protobuf.StringValue | 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). |
DeviceOnboardingConfig
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.
Field Name | Type | Description |
---|---|---|
key | UUIDKey | key identifies the request to onboard the device at hostname_or_ip. |
hostname_or_ip | google.protobuf.StringValue | hostname_or_ip is a hostname or an IP at which the device can be reached. |
device_type | google.protobuf.StringValue | 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". |
device_config | DeviceConfiguration | device_config is the configuration for a third-party device. |
ExtendedAttributes
ExtendedAttributes wraps any additional, potentially non-standard, features or attributes the device reports.
Field Name | Type | Description |
---|---|---|
feature_enabled | ExtendedAttributes.FeatureEnabledEntry[...] | feature_enabled is a map of feature name to enabled status. If a feature is missing from this map it can be assumed off. |
ExtendedAttributes.FeatureEnabledEntry
Field Name | Type | Description |
---|---|---|
key | string | |
value | bool |
ProvisionedDevice
ProvisionedDevice describes the provisioning status of an onboarded device if the onboarded device is configured for provisioning.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the device. |
status | ProvisioningStatus | status describes the onboarded device's provisioning status. |
error | google.protobuf.StringValue | error is the error that caused status to become PROVISIONING_STATUS_FAILURE. |
ztp_mode | google.protobuf.BoolValue | ztp_mode indicates whether the device is in ZTP mode. |
ip_address | fmp.IPAddress | ip_address is the current (post-provisioning) IP address of the device. |
provisioning_group_name | google.protobuf.StringValue | 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. |
ipv6_address | fmp.IPAddress | ipv6_address is the IPV6 address of the device. |
UUIDKey
UUIDKey is a key that holds a UUID for an onboarding or decommissioning request.
Field Name | Type | Description |
---|---|---|
request_id | google.protobuf.StringValue | request_id should be a UUID for the request. |
DecommissioningStatus
DecommissioningStatus defines the set of possible states in the decommissioning process for a device.
Name | Number | Description |
---|---|---|
DECOMMISSIONING_STATUS_UNSPECIFIED | 0 | DECOMMISSIONING_STATUS_UNSPECIFIED indicates decommissioning status is unspecified. |
DECOMMISSIONING_STATUS_IN_PROGRESS | 1 | DECOMMISSIONING_STATUS_IN_PROGRESS indicates decommissioning is in progress. |
DECOMMISSIONING_STATUS_FAILURE | 2 | DECOMMISSIONING_STATUS_FAILURE indicates decommissioning failed. |
DECOMMISSIONING_STATUS_SUCCESS | 3 | DECOMMISSIONING_STATUS_SUCCESS indicates decommissioning succeeded. |
OnboardingStatus
OnboardingStatus defines the set of possible states in the onboarding process for a device.
Name | Number | Description |
---|---|---|
ONBOARDING_STATUS_UNSPECIFIED | 0 | ONBOARDING_STATUS_UNSPECIFIED indicates onboarding status is unspecified. |
ONBOARDING_STATUS_IN_PROGRESS | 1 | ONBOARDING_STATUS_IN_PROGRESS indicates onboarding is in progress. |
ONBOARDING_STATUS_FAILURE | 2 | ONBOARDING_STATUS_FAILURE indicates onboarding failed. |
ONBOARDING_STATUS_SUCCESS | 3 | ONBOARDING_STATUS_SUCCESS indicates onboarding succeeded. |
ProvisioningStatus
ProvisioningStatus defines the set of possible states in the provisioning process for a device.
Name | Number | Description |
---|---|---|
PROVISIONING_STATUS_UNSPECIFIED | 0 | PROVISIONING_STATUS_UNSPECIFIED indicates provisioning status is unspecified. |
PROVISIONING_STATUS_IN_PROGRESS | 1 | PROVISIONING_STATUS_IN_PROGRESS indicates provisioning is in progress. |
PROVISIONING_STATUS_FAILURE | 2 | PROVISIONING_STATUS_FAILURE indicates provisioning failed. |
PROVISIONING_STATUS_SUCCESS | 3 | PROVISIONING_STATUS_SUCCESS indicates provisioning succeeded. |
StreamingStatus
StreamingStatus defines the status of telemetry streaming for a device.
Name | Number | Description |
---|---|---|
STREAMING_STATUS_UNSPECIFIED | 0 | STREAMING_STATUS_UNSPECIFIED indicates the device streaming telemetry status is unspecified. |
STREAMING_STATUS_INACTIVE | 1 | STREAMING_STATUS_INACTIVE indicates the device is not streaming telemetry. |
STREAMING_STATUS_ACTIVE | 2 | STREAMING_STATUS_ACTIVE indicates the device is streaming telemetry. |
arista/inventory.v1/services.gen.proto
DeviceBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | Device[...] | 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 | arista.time.TimeBounds | 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. |
max_messages | google.protobuf.UInt32Value | 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. |
DeviceBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DeviceStreamResponse[...] | 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). |
DeviceDecommissioningBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceDecommissioning[...] | 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 | arista.time.TimeBounds | 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. |
max_messages | google.protobuf.UInt32Value | 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. |
DeviceDecommissioningBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DeviceDecommissioningStreamResponse[...] | 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). |
DeviceDecommissioningConfigBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceDecommissioningConfig[...] | 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 | arista.time.TimeBounds | 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. |
max_messages | google.protobuf.UInt32Value | 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. |
DeviceDecommissioningConfigBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DeviceDecommissioningConfigStreamResponse[...] | 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). |
DeviceDecommissioningConfigDeleteAllRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceDecommissioningConfig[...] | 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. |
DeviceDecommissioningConfigDeleteAllResponse
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. A DeleteAllResponse is only sent when there is an error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | UUIDKey | This is the key of the DeviceDecommissioningConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
DeviceDecommissioningConfigDeleteRequest
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key indicates which DeviceDecommissioningConfig instance to remove. This field must always be set. |
DeviceDecommissioningConfigDeleteResponse
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key echoes back the key of the deleted DeviceDecommissioningConfig instance. |
time | google.protobuf.Timestamp | 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. |
DeviceDecommissioningConfigDeleteSomeRequest
Field Name | Type | Description |
---|---|---|
keys | UUIDKey[...] | key contains a list of DeviceDecommissioningConfig keys to delete |
DeviceDecommissioningConfigDeleteSomeResponse
DeviceDecommissioningConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | UUIDKey | |
error | string |
DeviceDecommissioningConfigRequest
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key uniquely identifies a DeviceDecommissioningConfig instance to retrieve. This value must be populated. |
time | google.protobuf.Timestamp | 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. |
DeviceDecommissioningConfigResponse
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioningConfig | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the DeviceDecommissioningConfig instance in this response. |
DeviceDecommissioningConfigSetRequest
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioningConfig | DeviceDecommissioningConfig carries the value to set into the datastore. See the documentation on the DeviceDecommissioningConfig struct for which fields are required. |
DeviceDecommissioningConfigSetResponse
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioningConfig | Value carries all the values given in the DeviceDecommissioningConfigSetRequest as well as any server-generated values. |
time | google.protobuf.Timestamp | 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. |
DeviceDecommissioningConfigSetSomeRequest
Field Name | Type | Description |
---|---|---|
values | DeviceDecommissioningConfig[...] | 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. |
DeviceDecommissioningConfigSetSomeResponse
Field Name | Type | Description |
---|---|---|
key | UUIDKey | |
error | string |
DeviceDecommissioningConfigSomeRequest
Field Name | Type | Description |
---|---|---|
keys | UUIDKey[...] | |
time | google.protobuf.Timestamp | 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. |
DeviceDecommissioningConfigSomeResponse
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioningConfig | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
DeviceDecommissioningConfigStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceDecommissioningConfig[...] | 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 | arista.time.TimeBounds | 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. |
DeviceDecommissioningConfigStreamResponse
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioningConfig | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this DeviceDecommissioningConfig's last modification. |
type | arista.subscriptions.Operation | 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. |
DeviceDecommissioningRequest
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key uniquely identifies a DeviceDecommissioning instance to retrieve. This value must be populated. |
time | google.protobuf.Timestamp | 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. |
DeviceDecommissioningResponse
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioning | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the DeviceDecommissioning instance in this response. |
DeviceDecommissioningSomeRequest
Field Name | Type | Description |
---|---|---|
keys | UUIDKey[...] | |
time | google.protobuf.Timestamp | 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. |
DeviceDecommissioningSomeResponse
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioning | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
DeviceDecommissioningStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceDecommissioning[...] | 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 | arista.time.TimeBounds | 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. |
DeviceDecommissioningStreamResponse
Field Name | Type | Description |
---|---|---|
value | DeviceDecommissioning | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this DeviceDecommissioning's last modification. |
type | arista.subscriptions.Operation | 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. |
DeviceOnboardingBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceOnboarding[...] | 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 | arista.time.TimeBounds | 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. |
max_messages | google.protobuf.UInt32Value | 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. |
DeviceOnboardingBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DeviceOnboardingStreamResponse[...] | 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). |
DeviceOnboardingConfigBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceOnboardingConfig[...] | 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 | arista.time.TimeBounds | 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. |
max_messages | google.protobuf.UInt32Value | 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. |
DeviceOnboardingConfigBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DeviceOnboardingConfigStreamResponse[...] | 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). |
DeviceOnboardingConfigDeleteAllRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceOnboardingConfig[...] | 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. |
DeviceOnboardingConfigDeleteAllResponse
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. A DeleteAllResponse is only sent when there is an error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | UUIDKey | This is the key of the DeviceOnboardingConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
DeviceOnboardingConfigDeleteRequest
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key indicates which DeviceOnboardingConfig instance to remove. This field must always be set. |
DeviceOnboardingConfigDeleteResponse
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key echoes back the key of the deleted DeviceOnboardingConfig instance. |
time | google.protobuf.Timestamp | 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. |
DeviceOnboardingConfigDeleteSomeRequest
Field Name | Type | Description |
---|---|---|
keys | UUIDKey[...] | key contains a list of DeviceOnboardingConfig keys to delete |
DeviceOnboardingConfigDeleteSomeResponse
DeviceOnboardingConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | UUIDKey | |
error | string |
DeviceOnboardingConfigRequest
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key uniquely identifies a DeviceOnboardingConfig instance to retrieve. This value must be populated. |
time | google.protobuf.Timestamp | 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. |
DeviceOnboardingConfigResponse
Field Name | Type | Description |
---|---|---|
value | DeviceOnboardingConfig | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the DeviceOnboardingConfig instance in this response. |
DeviceOnboardingConfigSetRequest
Field Name | Type | Description |
---|---|---|
value | DeviceOnboardingConfig | DeviceOnboardingConfig carries the value to set into the datastore. See the documentation on the DeviceOnboardingConfig struct for which fields are required. |
DeviceOnboardingConfigSetResponse
Field Name | Type | Description |
---|---|---|
value | DeviceOnboardingConfig | Value carries all the values given in the DeviceOnboardingConfigSetRequest as well as any server-generated values. |
time | google.protobuf.Timestamp | 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. |
DeviceOnboardingConfigSetSomeRequest
Field Name | Type | Description |
---|---|---|
values | DeviceOnboardingConfig[...] | 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. |
DeviceOnboardingConfigSetSomeResponse
Field Name | Type | Description |
---|---|---|
key | UUIDKey | |
error | string |
DeviceOnboardingConfigSomeRequest
Field Name | Type | Description |
---|---|---|
keys | UUIDKey[...] | |
time | google.protobuf.Timestamp | 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. |
DeviceOnboardingConfigSomeResponse
Field Name | Type | Description |
---|---|---|
value | DeviceOnboardingConfig | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
DeviceOnboardingConfigStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceOnboardingConfig[...] | 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 | arista.time.TimeBounds | 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. |
DeviceOnboardingConfigStreamResponse
Field Name | Type | Description |
---|---|---|
value | DeviceOnboardingConfig | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this DeviceOnboardingConfig's last modification. |
type | arista.subscriptions.Operation | 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. |
DeviceOnboardingRequest
Field Name | Type | Description |
---|---|---|
key | UUIDKey | Key uniquely identifies a DeviceOnboarding instance to retrieve. This value must be populated. |
time | google.protobuf.Timestamp | 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. |
DeviceOnboardingResponse
Field Name | Type | Description |
---|---|---|
value | DeviceOnboarding | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the DeviceOnboarding instance in this response. |
DeviceOnboardingSomeRequest
Field Name | Type | Description |
---|---|---|
keys | UUIDKey[...] | |
time | google.protobuf.Timestamp | 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. |
DeviceOnboardingSomeResponse
Field Name | Type | Description |
---|---|---|
value | DeviceOnboarding | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
DeviceOnboardingStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceOnboarding[...] | 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 | arista.time.TimeBounds | 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. |
DeviceOnboardingStreamResponse
Field Name | Type | Description |
---|---|---|
value | DeviceOnboarding | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this DeviceOnboarding's last modification. |
type | arista.subscriptions.Operation | 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. |
DeviceRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key uniquely identifies a Device instance to retrieve. This value must be populated. |
time | google.protobuf.Timestamp | 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. |
DeviceResponse
Field Name | Type | Description |
---|---|---|
value | Device | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the Device instance in this response. |
DeviceSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | |
time | google.protobuf.Timestamp | 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. |
DeviceSomeResponse
Field Name | Type | Description |
---|---|---|
value | Device | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
DeviceStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | Device[...] | 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 | arista.time.TimeBounds | 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. |
DeviceStreamResponse
Field Name | Type | Description |
---|---|---|
value | Device | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this Device's last modification. |
type | arista.subscriptions.Operation | 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. |
MetaResponse
Field Name | Type | Description |
---|---|---|
time | google.protobuf.Timestamp | Time holds the timestamp of the last item included in the metadata calculation. |
type | arista.subscriptions.Operation | 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. |
count | google.protobuf.UInt32Value | Count is the number of items present under the conditions of the request. |
ProvisionedDeviceBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | ProvisionedDevice[...] | 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 | arista.time.TimeBounds | 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. |
max_messages | google.protobuf.UInt32Value | 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. |
ProvisionedDeviceBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | ProvisionedDeviceStreamResponse[...] | 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). |
ProvisionedDeviceRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key uniquely identifies a ProvisionedDevice instance to retrieve. This value must be populated. |
time | google.protobuf.Timestamp | 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. |
ProvisionedDeviceResponse
Field Name | Type | Description |
---|---|---|
value | ProvisionedDevice | 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. |
time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the ProvisionedDevice instance in this response. |
ProvisionedDeviceSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | |
time | google.protobuf.Timestamp | 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. |
ProvisionedDeviceSomeResponse
Field Name | Type | Description |
---|---|---|
value | ProvisionedDevice | 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. |
error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
time | google.protobuf.Timestamp |
ProvisionedDeviceStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | ProvisionedDevice[...] | 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 | arista.time.TimeBounds | 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. |
ProvisionedDeviceStreamResponse
Field Name | Type | Description |
---|---|---|
value | ProvisionedDevice | 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. |
time | google.protobuf.Timestamp | Time holds the timestamp of this ProvisionedDevice's last modification. |
type | arista.subscriptions.Operation | 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. |
DeviceDecommissioningConfigService
DeviceDecommissioningService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | DeviceDecommissioningRequest | DeviceDecommissioningResponse | |
GetSome | DeviceDecommissioningSomeRequest | DeviceDecommissioningSomeResponse stream | |
GetAll | DeviceDecommissioningStreamRequest | DeviceDecommissioningStreamResponse stream | |
Subscribe | DeviceDecommissioningStreamRequest | DeviceDecommissioningStreamResponse stream | |
GetMeta | DeviceDecommissioningStreamRequest | MetaResponse | |
SubscribeMeta | DeviceDecommissioningStreamRequest | MetaResponse stream | |
GetAllBatched | DeviceDecommissioningBatchedStreamRequest | DeviceDecommissioningBatchedStreamResponse stream | |
SubscribeBatched | DeviceDecommissioningBatchedStreamRequest | DeviceDecommissioningBatchedStreamResponse stream |
DeviceOnboardingConfigService
DeviceOnboardingService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | DeviceOnboardingRequest | DeviceOnboardingResponse | |
GetSome | DeviceOnboardingSomeRequest | DeviceOnboardingSomeResponse stream | |
GetAll | DeviceOnboardingStreamRequest | DeviceOnboardingStreamResponse stream | |
Subscribe | DeviceOnboardingStreamRequest | DeviceOnboardingStreamResponse stream | |
GetMeta | DeviceOnboardingStreamRequest | MetaResponse | |
SubscribeMeta | DeviceOnboardingStreamRequest | MetaResponse stream | |
GetAllBatched | DeviceOnboardingBatchedStreamRequest | DeviceOnboardingBatchedStreamResponse stream | |
SubscribeBatched | DeviceOnboardingBatchedStreamRequest | DeviceOnboardingBatchedStreamResponse stream |
DeviceService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | DeviceRequest | DeviceResponse | |
GetSome | DeviceSomeRequest | DeviceSomeResponse stream | |
GetAll | DeviceStreamRequest | DeviceStreamResponse stream | |
Subscribe | DeviceStreamRequest | DeviceStreamResponse stream | |
GetMeta | DeviceStreamRequest | MetaResponse | |
SubscribeMeta | DeviceStreamRequest | MetaResponse stream | |
GetAllBatched | DeviceBatchedStreamRequest | DeviceBatchedStreamResponse stream | |
SubscribeBatched | DeviceBatchedStreamRequest | DeviceBatchedStreamResponse stream |
ProvisionedDeviceService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | ProvisionedDeviceRequest | ProvisionedDeviceResponse | |
GetSome | ProvisionedDeviceSomeRequest | ProvisionedDeviceSomeResponse stream | |
GetAll | ProvisionedDeviceStreamRequest | ProvisionedDeviceStreamResponse stream | |
Subscribe | ProvisionedDeviceStreamRequest | ProvisionedDeviceStreamResponse stream | |
GetMeta | ProvisionedDeviceStreamRequest | MetaResponse | |
SubscribeMeta | ProvisionedDeviceStreamRequest | MetaResponse stream | |
GetAllBatched | ProvisionedDeviceBatchedStreamRequest | ProvisionedDeviceBatchedStreamResponse stream | |
SubscribeBatched | ProvisionedDeviceBatchedStreamRequest | ProvisionedDeviceBatchedStreamResponse stream |