configlet.v1

Version: 1.1.1

Available Services

    ConfigletAssignmentConfigService

    ConfigletAssignmentService

    ConfigletConfigService

    ConfigletService

• arista/configlet.v1/configlet.proto

  • Configlet

  • ConfigletAssignment

  • ConfigletAssignmentConfig

  • ConfigletAssignmentKey

  • ConfigletConfig

  • ConfigletKey

  • Filter

  • MatchPolicy

• arista/configlet.v1/services.gen.proto

  • ConfigletAssignmentBatchedStreamRequest

  • ConfigletAssignmentBatchedStreamResponse

  • ConfigletAssignmentConfigBatchedStreamRequest

  • ConfigletAssignmentConfigBatchedStreamResponse

  • ConfigletAssignmentConfigDeleteAllRequest

  • ConfigletAssignmentConfigDeleteAllResponse

  • ConfigletAssignmentConfigDeleteRequest

  • ConfigletAssignmentConfigDeleteResponse

  • ConfigletAssignmentConfigDeleteSomeRequest

  • ConfigletAssignmentConfigDeleteSomeResponse

  • ConfigletAssignmentConfigRequest

  • ConfigletAssignmentConfigResponse

  • ConfigletAssignmentConfigSetRequest

  • ConfigletAssignmentConfigSetResponse

  • ConfigletAssignmentConfigSetSomeRequest

  • ConfigletAssignmentConfigSetSomeResponse

  • ConfigletAssignmentConfigSomeRequest

  • ConfigletAssignmentConfigSomeResponse

  • ConfigletAssignmentConfigStreamRequest

  • ConfigletAssignmentConfigStreamResponse

  • ConfigletAssignmentRequest

  • ConfigletAssignmentResponse

  • ConfigletAssignmentSomeRequest

  • ConfigletAssignmentSomeResponse

  • ConfigletAssignmentStreamRequest

  • ConfigletAssignmentStreamResponse

  • ConfigletBatchedStreamRequest

  • ConfigletBatchedStreamResponse

  • ConfigletConfigBatchedStreamRequest

  • ConfigletConfigBatchedStreamResponse

  • ConfigletConfigDeleteAllRequest

  • ConfigletConfigDeleteAllResponse

  • ConfigletConfigDeleteRequest

  • ConfigletConfigDeleteResponse

  • ConfigletConfigDeleteSomeRequest

  • ConfigletConfigDeleteSomeResponse

  • ConfigletConfigRequest

  • ConfigletConfigResponse

  • ConfigletConfigSetRequest

  • ConfigletConfigSetResponse

  • ConfigletConfigSetSomeRequest

  • ConfigletConfigSetSomeResponse

  • ConfigletConfigSomeRequest

  • ConfigletConfigSomeResponse

  • ConfigletConfigStreamRequest

  • ConfigletConfigStreamResponse

  • ConfigletRequest

  • ConfigletResponse

  • ConfigletSomeRequest

  • ConfigletSomeResponse

  • ConfigletStreamRequest

  • ConfigletStreamResponse

  • MetaResponse

  • ConfigletAssignmentConfigService

  • ConfigletAssignmentService

  • ConfigletConfigService

  • ConfigletService

Top

arista/configlet.v1/configlet.proto

Configlet

Configlet is the state of a static configlet in a workspace or mainline. Subscribe and GetAll do not return the "body" Use GetOne to get the body of individual configlets

Field Name	Type	Description
key	ConfigletKey
display_name	google.protobuf.StringValue	display_name is the display name of the static configlet.
description	google.protobuf.StringValue	description is the description of the static configlet.
migrated_from	google.protobuf.StringValue	migrated_from is populated with the source configlet name when migrated from network provisioning to studio.
body	google.protobuf.StringValue	body is the static configlet body.
created_at	google.protobuf.Timestamp	created_at is the time when the Configlet was created.
created_by	google.protobuf.StringValue	created_by is the user who created the Configlet.
last_modified_at	google.protobuf.Timestamp	last_modified_at is the time when the Configlet was last modified.
last_modified_by	google.protobuf.StringValue	last_modified_by is the user who last modified the Configlet.
digest	google.protobuf.StringValue	digest is the sha256 hash of the configlet body encoded in hexadecimal.
size	google.protobuf.Int64Value	size of configlet body in bytes.

ConfigletAssignment

ConfigletAssignment is the state of this assignment in a workspace/mainline

Field Name	Type	Description
key	ConfigletAssignmentKey
display_name	google.protobuf.StringValue
description	google.protobuf.StringValue
configlet_ids	fmp.RepeatedString	configlet_ids is the list of configlets which are assigned
query	google.protobuf.StringValue	query represents the tag query assigned
match_policy	MatchPolicy	match_policy is the discriminator for the query field
child_assignment_ids	fmp.RepeatedString	list of child assignments
created_at	google.protobuf.Timestamp	created_at is the time when the ConfigletAssignment was created.
created_by	google.protobuf.StringValue	created_by is the user who created the ConfigletAssignment.
last_modified_at	google.protobuf.Timestamp	last_modified_at is the time when the ConfigletAssignment was last modified.
last_modified_by	google.protobuf.StringValue	last_modified_by is the user who last modified the ConfigletAssignment.

ConfigletAssignmentConfig

ConfigletAssignmentConfig are the the inputs to the static configlet studio. Each assignment assigns a list of configlets to the devices matching the tag query. Individual assignments can have a list of "child" assignments. The totality of these assignments form a list of tree hierarchies. Using the corresponding GUI workflow should help explain this structure. When traversing a tree and assigning static configlets to devices, the following rules are applied:

1. Tag queries at each level need to resolve to a subset of its parent's queries. Devices resolved in child assignments but which do not resolve in that of its parent's are skipped.
2. Match policy determines how the assignment's devices get divied up amongst its children.

Field Name	Type	Description
key	ConfigletAssignmentKey
display_name	google.protobuf.StringValue
description	google.protobuf.StringValue
configlet_ids	fmp.RepeatedString	configlet_ids is the list of configlets to be assigned
query	google.protobuf.StringValue	query is a tag query string that conforms to the CloudVision tag query language. E.g., the query, "datacenter:NYC,SFO AND</p><p>sflow:enabled", matches all devices with sflow enabled in data centers NYC and SFO. malformed queries result in an error tags not matching devices are ignored
remove	google.protobuf.BoolValue	remove indicates whether to remove (true) or add (false, unset) the tag assignments involving the studio identified by the key if the encompassing workspace merges. Other data fields are not allowed if this field is set to true.
match_policy	MatchPolicy	match_policy is the discriminator for the query field
child_assignment_ids	fmp.RepeatedString	list of child assignments

ConfigletAssignmentKey

ConfigletAssignmentKey uniquely identifies a configlet assignment

Field Name	Type	Description
workspace_id	google.protobuf.StringValue	workspace_id is the unique identifier of the workspace.
configlet_assignment_id	google.protobuf.StringValue	configlet_assignment_id is the unique identifier of the configlet_assignment.

ConfigletConfig

ConfigletConfig updates a static configlet in a workspace.

Field Name	Type	Description
key	ConfigletKey
remove	google.protobuf.BoolValue	remove specifies the static configlet is to be removed from the workspace. Other data fields are not allowed when this field is set to true.
display_name	google.protobuf.StringValue	display_name is the display name of the static configlet.
description	google.protobuf.StringValue	description is the description of the static configlet.
migrated_from	google.protobuf.StringValue	migrated_from is populated with the source configlet name when migrated from network provisioning to studio.
body	google.protobuf.StringValue	body is the static configlet body.

ConfigletKey

ConfigletKey uniquely identifies a static configlet.

Field Name	Type	Description
workspace_id	google.protobuf.StringValue	workspace_id identifies the workspace within which the static configlet resides empty string ("") stands for the "mainline".
configlet_id	google.protobuf.StringValue	configlet_id is the static configlet ID.

Filter

Filter is used to filter static configlets.

Field Name	Type	Description
include_body	google.protobuf.BoolValue	include_body specifies the static configlet body is to be included.

MatchPolicy

MatchPolicy specifies how the tag query of a configlet assignment should be used to resolve devices for its children

Name	Number	Description
MATCH_POLICY_UNSPECIFIED	0
MATCH_POLICY_MATCH_FIRST	1	MATCH_POLICY_MATCH_FIRST dictates that matching devices are used only for the first match amongst its children
MATCH_POLICY_MATCH_ALL	2	MATCH_POLICY_MATCH_ALL dictates that matching devices are used across all children

Top

arista/configlet.v1/services.gen.proto

ConfigletAssignmentBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	ConfigletAssignment[...]	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 ConfigletAssignment at end. * Each ConfigletAssignment response is fully-specified (all fields set). * start: Returns the state of each ConfigletAssignment at start, followed by updates until now. * Each ConfigletAssignment response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigletAssignment at start, followed by updates until end. * Each ConfigletAssignment 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.

ConfigletAssignmentBatchedStreamResponse

Field Name	Type	Description
responses	ConfigletAssignmentStreamResponse[...]	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).

ConfigletAssignmentConfigBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	ConfigletAssignmentConfig[...]	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 ConfigletAssignmentConfig at end. * Each ConfigletAssignmentConfig response is fully-specified (all fields set). * start: Returns the state of each ConfigletAssignmentConfig at start, followed by updates until now. * Each ConfigletAssignmentConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigletAssignmentConfig at start, followed by updates until end. * Each ConfigletAssignmentConfig 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.

ConfigletAssignmentConfigBatchedStreamResponse

Field Name	Type	Description
responses	ConfigletAssignmentConfigStreamResponse[...]	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).

ConfigletAssignmentConfigDeleteAllRequest

Field Name	Type	Description
partial_eq_filter	ConfigletAssignmentConfig[...]	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.

ConfigletAssignmentConfigDeleteAllResponse

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	ConfigletAssignmentKey	This is the key of the ConfigletAssignmentConfig instance that failed to be deleted.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp when the key was being deleted.

ConfigletAssignmentConfigDeleteRequest

Field Name	Type	Description
key	ConfigletAssignmentKey	Key indicates which ConfigletAssignmentConfig instance to remove. This field must always be set.

ConfigletAssignmentConfigDeleteResponse

Field Name	Type	Description
key	ConfigletAssignmentKey	Key echoes back the key of the deleted ConfigletAssignmentConfig 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.

ConfigletAssignmentConfigDeleteSomeRequest

Field Name	Type	Description
keys	ConfigletAssignmentKey[...]	key contains a list of ConfigletAssignmentConfig keys to delete

ConfigletAssignmentConfigDeleteSomeResponse

ConfigletAssignmentConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	ConfigletAssignmentKey
error	string

ConfigletAssignmentConfigRequest

Field Name	Type	Description
key	ConfigletAssignmentKey	Key uniquely identifies a ConfigletAssignmentConfig 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.

ConfigletAssignmentConfigResponse

Field Name	Type	Description
value	ConfigletAssignmentConfig	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 ConfigletAssignmentConfig instance in this response.

ConfigletAssignmentConfigSetRequest

Field Name	Type	Description
value	ConfigletAssignmentConfig	ConfigletAssignmentConfig carries the value to set into the datastore. See the documentation on the ConfigletAssignmentConfig struct for which fields are required.

ConfigletAssignmentConfigSetResponse

Field Name	Type	Description
value	ConfigletAssignmentConfig	Value carries all the values given in the ConfigletAssignmentConfigSetRequest 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.

ConfigletAssignmentConfigSetSomeRequest

Field Name	Type	Description
values	ConfigletAssignmentConfig[...]	value contains a list of ConfigletAssignmentConfig 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.

ConfigletAssignmentConfigSetSomeResponse

Field Name	Type	Description
key	ConfigletAssignmentKey
error	string

ConfigletAssignmentConfigSomeRequest

Field Name	Type	Description
keys	ConfigletAssignmentKey[...]
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.

ConfigletAssignmentConfigSomeResponse

Field Name	Type	Description
value	ConfigletAssignmentConfig	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

ConfigletAssignmentConfigStreamRequest

Field Name	Type	Description
partial_eq_filter	ConfigletAssignmentConfig[...]	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 ConfigletAssignmentConfig at end. * Each ConfigletAssignmentConfig response is fully-specified (all fields set). * start: Returns the state of each ConfigletAssignmentConfig at start, followed by updates until now. * Each ConfigletAssignmentConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigletAssignmentConfig at start, followed by updates until end. * Each ConfigletAssignmentConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

ConfigletAssignmentConfigStreamResponse

Field Name	Type	Description
value	ConfigletAssignmentConfig	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 ConfigletAssignmentConfig's last modification.
type	arista.subscriptions.Operation	Operation indicates how the ConfigletAssignmentConfig 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.

ConfigletAssignmentRequest

Field Name	Type	Description
key	ConfigletAssignmentKey	Key uniquely identifies a ConfigletAssignment 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.

ConfigletAssignmentResponse

Field Name	Type	Description
value	ConfigletAssignment	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 ConfigletAssignment instance in this response.

ConfigletAssignmentSomeRequest

Field Name	Type	Description
keys	ConfigletAssignmentKey[...]
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.

ConfigletAssignmentSomeResponse

Field Name	Type	Description
value	ConfigletAssignment	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

ConfigletAssignmentStreamRequest

Field Name	Type	Description
partial_eq_filter	ConfigletAssignment[...]	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 ConfigletAssignment at end. * Each ConfigletAssignment response is fully-specified (all fields set). * start: Returns the state of each ConfigletAssignment at start, followed by updates until now. * Each ConfigletAssignment response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigletAssignment at start, followed by updates until end. * Each ConfigletAssignment response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

ConfigletAssignmentStreamResponse

Field Name	Type	Description
value	ConfigletAssignment	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 ConfigletAssignment's last modification.
type	arista.subscriptions.Operation	Operation indicates how the ConfigletAssignment 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.

ConfigletBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	Configlet[...]	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.
filter	Filter	For each Configlet in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given Configlet is streamed to the user.
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 Configlet at end. * Each Configlet response is fully-specified (all fields set). * start: Returns the state of each Configlet at start, followed by updates until now. * Each Configlet response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Configlet at start, followed by updates until end. * Each Configlet 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.

ConfigletBatchedStreamResponse

Field Name	Type	Description
responses	ConfigletStreamResponse[...]	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).

ConfigletConfigBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	ConfigletConfig[...]	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.
filter	Filter	For each ConfigletConfig in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ConfigletConfig is streamed to the user.
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 ConfigletConfig at end. * Each ConfigletConfig response is fully-specified (all fields set). * start: Returns the state of each ConfigletConfig at start, followed by updates until now. * Each ConfigletConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigletConfig at start, followed by updates until end. * Each ConfigletConfig 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.

ConfigletConfigBatchedStreamResponse

Field Name	Type	Description
responses	ConfigletConfigStreamResponse[...]	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).

ConfigletConfigDeleteAllRequest

Field Name	Type	Description
partial_eq_filter	ConfigletConfig[...]	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.
filter	Filter	For each ConfigletConfig in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ConfigletConfig will be deleted.

ConfigletConfigDeleteAllResponse

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	ConfigletKey	This is the key of the ConfigletConfig instance that failed to be deleted.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp when the key was being deleted.

ConfigletConfigDeleteRequest

Field Name	Type	Description
key	ConfigletKey	Key indicates which ConfigletConfig instance to remove. This field must always be set.

ConfigletConfigDeleteResponse

Field Name	Type	Description
key	ConfigletKey	Key echoes back the key of the deleted ConfigletConfig 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.

ConfigletConfigDeleteSomeRequest

Field Name	Type	Description
keys	ConfigletKey[...]	key contains a list of ConfigletConfig keys to delete

ConfigletConfigDeleteSomeResponse

ConfigletConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	ConfigletKey
error	string

ConfigletConfigRequest

Field Name	Type	Description
key	ConfigletKey	Key uniquely identifies a ConfigletConfig 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.

ConfigletConfigResponse

Field Name	Type	Description
value	ConfigletConfig	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 ConfigletConfig instance in this response.

ConfigletConfigSetRequest

Field Name	Type	Description
value	ConfigletConfig	ConfigletConfig carries the value to set into the datastore. See the documentation on the ConfigletConfig struct for which fields are required.

ConfigletConfigSetResponse

Field Name	Type	Description
value	ConfigletConfig	Value carries all the values given in the ConfigletConfigSetRequest 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.

ConfigletConfigSetSomeRequest

Field Name	Type	Description
values	ConfigletConfig[...]	value contains a list of ConfigletConfig 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.

ConfigletConfigSetSomeResponse

Field Name	Type	Description
key	ConfigletKey
error	string

ConfigletConfigSomeRequest

Field Name	Type	Description
keys	ConfigletKey[...]
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.

ConfigletConfigSomeResponse

Field Name	Type	Description
value	ConfigletConfig	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

ConfigletConfigStreamRequest

Field Name	Type	Description
partial_eq_filter	ConfigletConfig[...]	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.
filter	Filter	For each ConfigletConfig in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ConfigletConfig is streamed to the user.
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 ConfigletConfig at end. * Each ConfigletConfig response is fully-specified (all fields set). * start: Returns the state of each ConfigletConfig at start, followed by updates until now. * Each ConfigletConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigletConfig at start, followed by updates until end. * Each ConfigletConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

ConfigletConfigStreamResponse

Field Name	Type	Description
value	ConfigletConfig	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 ConfigletConfig's last modification.
type	arista.subscriptions.Operation	Operation indicates how the ConfigletConfig 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.

ConfigletRequest

Field Name	Type	Description
key	ConfigletKey	Key uniquely identifies a Configlet 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.

ConfigletResponse

Field Name	Type	Description
value	Configlet	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 Configlet instance in this response.

ConfigletSomeRequest

Field Name	Type	Description
keys	ConfigletKey[...]
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.

ConfigletSomeResponse

Field Name	Type	Description
value	Configlet	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

ConfigletStreamRequest

Field Name	Type	Description
partial_eq_filter	Configlet[...]	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.
filter	Filter	For each Configlet in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given Configlet is streamed to the user.
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 Configlet at end. * Each Configlet response is fully-specified (all fields set). * start: Returns the state of each Configlet at start, followed by updates until now. * Each Configlet response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Configlet at start, followed by updates until end. * Each Configlet response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

ConfigletStreamResponse

Field Name	Type	Description
value	Configlet	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 Configlet's last modification.
type	arista.subscriptions.Operation	Operation indicates how the Configlet 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.

ConfigletAssignmentConfigService

Method Name	Request Type	Response Type	Description
GetOne	ConfigletAssignmentConfigRequest	ConfigletAssignmentConfigResponse
GetSome	ConfigletAssignmentConfigSomeRequest	ConfigletAssignmentConfigSomeResponse stream
GetAll	ConfigletAssignmentConfigStreamRequest	ConfigletAssignmentConfigStreamResponse stream
Subscribe	ConfigletAssignmentConfigStreamRequest	ConfigletAssignmentConfigStreamResponse stream
GetMeta	ConfigletAssignmentConfigStreamRequest	MetaResponse
SubscribeMeta	ConfigletAssignmentConfigStreamRequest	MetaResponse stream
Set	ConfigletAssignmentConfigSetRequest	ConfigletAssignmentConfigSetResponse
SetSome	ConfigletAssignmentConfigSetSomeRequest	ConfigletAssignmentConfigSetSomeResponse stream
Delete	ConfigletAssignmentConfigDeleteRequest	ConfigletAssignmentConfigDeleteResponse
DeleteSome	ConfigletAssignmentConfigDeleteSomeRequest	ConfigletAssignmentConfigDeleteSomeResponse stream
DeleteAll	ConfigletAssignmentConfigDeleteAllRequest	ConfigletAssignmentConfigDeleteAllResponse stream
GetAllBatched	ConfigletAssignmentConfigBatchedStreamRequest	ConfigletAssignmentConfigBatchedStreamResponse stream
SubscribeBatched	ConfigletAssignmentConfigBatchedStreamRequest	ConfigletAssignmentConfigBatchedStreamResponse stream

ConfigletAssignmentService

Method Name	Request Type	Response Type	Description
GetOne	ConfigletAssignmentRequest	ConfigletAssignmentResponse
GetSome	ConfigletAssignmentSomeRequest	ConfigletAssignmentSomeResponse stream
GetAll	ConfigletAssignmentStreamRequest	ConfigletAssignmentStreamResponse stream
Subscribe	ConfigletAssignmentStreamRequest	ConfigletAssignmentStreamResponse stream
GetMeta	ConfigletAssignmentStreamRequest	MetaResponse
SubscribeMeta	ConfigletAssignmentStreamRequest	MetaResponse stream
GetAllBatched	ConfigletAssignmentBatchedStreamRequest	ConfigletAssignmentBatchedStreamResponse stream
SubscribeBatched	ConfigletAssignmentBatchedStreamRequest	ConfigletAssignmentBatchedStreamResponse stream

ConfigletConfigService

Method Name	Request Type	Response Type	Description
GetOne	ConfigletConfigRequest	ConfigletConfigResponse
GetSome	ConfigletConfigSomeRequest	ConfigletConfigSomeResponse stream
GetAll	ConfigletConfigStreamRequest	ConfigletConfigStreamResponse stream
Subscribe	ConfigletConfigStreamRequest	ConfigletConfigStreamResponse stream
GetMeta	ConfigletConfigStreamRequest	MetaResponse
SubscribeMeta	ConfigletConfigStreamRequest	MetaResponse stream
Set	ConfigletConfigSetRequest	ConfigletConfigSetResponse
SetSome	ConfigletConfigSetSomeRequest	ConfigletConfigSetSomeResponse stream
Delete	ConfigletConfigDeleteRequest	ConfigletConfigDeleteResponse
DeleteSome	ConfigletConfigDeleteSomeRequest	ConfigletConfigDeleteSomeResponse stream
DeleteAll	ConfigletConfigDeleteAllRequest	ConfigletConfigDeleteAllResponse stream
GetAllBatched	ConfigletConfigBatchedStreamRequest	ConfigletConfigBatchedStreamResponse stream
SubscribeBatched	ConfigletConfigBatchedStreamRequest	ConfigletConfigBatchedStreamResponse stream

ConfigletService

Method Name	Request Type	Response Type	Description
GetOne	ConfigletRequest	ConfigletResponse
GetSome	ConfigletSomeRequest	ConfigletSomeResponse stream
GetAll	ConfigletStreamRequest	ConfigletStreamResponse stream
Subscribe	ConfigletStreamRequest	ConfigletStreamResponse stream
GetMeta	ConfigletStreamRequest	MetaResponse
SubscribeMeta	ConfigletStreamRequest	MetaResponse stream
GetAllBatched	ConfigletBatchedStreamRequest	ConfigletBatchedStreamResponse stream
SubscribeBatched	ConfigletBatchedStreamRequest	ConfigletBatchedStreamResponse stream