**DEPRECATED: This API is no longer supported.
DeviceTag is a label-value pair that may or may not be assigned to a device.
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies the device tag. |
creator_type | CreatorType | CreatorType is the creator type of the tag. |
DeviceTagAssignmentConfig is the assignment of a device tag to a specific device.
Field Name | Type | Description |
---|---|---|
key | DeviceTagAssignmentKey | Key uniquely identifies the device tag assignment. |
DeviceTagAssignmentKey uniquely identifies a device tag assignment.
Field Name | Type | Description |
---|---|---|
label | google.protobuf.StringValue | Label is the label of the tag. |
value | google.protobuf.StringValue | Value is the value of the tag. |
device_id | google.protobuf.StringValue | DeviceId is the ID of the device. |
DeviceTagConfig is a label-value pair that may or may not be assigned to a device.
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies the device tag. |
InterfaceTag is a label-value pair that may or may not be assigned to an interface.
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies the interface tag. |
creator_type | CreatorType | CreatorType is the creator type of the tag. |
InterfaceTagAssignmentConfig is the assignment of an interface tag to a specific interface.
Field Name | Type | Description |
---|---|---|
key | InterfaceTagAssignmentKey | Key uniquely identifies the interface tag assignment. |
InterfaceTagAssignmentKey uniquely identifies an interface tag assignment.
Field Name | Type | Description |
---|---|---|
label | google.protobuf.StringValue | Label is the label of the tag. |
value | google.protobuf.StringValue | Value is the value of the tag. |
device_id | google.protobuf.StringValue | DeviceId is the ID of the interface’s device. |
interface_id | google.protobuf.StringValue | InterfaceId is the ID of the interface. |
InterfaceTagConfig is a label-value pair that may or may not be assigned to an interface.
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies the interface tag. |
TagKey uniquely identifies a tag for a network element.
Field Name | Type | Description |
---|---|---|
label | google.protobuf.StringValue | Label is the label of the tag. |
value | google.protobuf.StringValue | Value is the value of the tag. |
CreatorType specifies an entity that creates something.
Name | Number | Description |
---|---|---|
CREATOR_TYPE_UNSPECIFIED | 0 | |
CREATOR_TYPE_SYSTEM | 1 | CREATOR_TYPE_SYSTEM is the type for something created by the system. |
CREATOR_TYPE_USER | 2 | CREATOR_TYPE_USER is the type for something created by a user. |
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | DeviceTagAssignmentKey | This is the key of the DeviceTagAssignmentConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
Field Name | Type | Description |
---|---|---|
key | DeviceTagAssignmentKey | Key indicates which DeviceTagAssignmentConfig instance to remove. This field must always be set. |
Field Name | Type | Description |
---|---|---|
key | DeviceTagAssignmentKey | Key echoes back the key of the deleted DeviceTagAssignmentConfig 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. |
Field Name | Type | Description |
---|---|---|
key | DeviceTagAssignmentKey | Key uniquely identifies a DeviceTagAssignmentConfig 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. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagAssignmentConfig | 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 DeviceTagAssignmentConfig instance in this response. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagAssignmentConfig | DeviceTagAssignmentConfig carries the value to set into the datastore. See the documentation on the DeviceTagAssignmentConfig struct for which fields are required. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagAssignmentConfig | Value carries all the values given in the DeviceTagAssignmentConfigSetRequest 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. |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceTagAssignmentConfig[…] | 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. This field is not allowed in the Subscribe RPC. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagAssignmentConfig | 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 DeviceTagAssignmentConfig’s last modification. |
type | arista.subscriptions.Operation | Operation indicates how the DeviceTagAssignmentConfig 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. |
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | TagKey | This is the key of the DeviceTagConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key indicates which DeviceTagConfig instance to remove. This field must always be set. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key echoes back the key of the deleted DeviceTagConfig 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. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies a DeviceTagConfig 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. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagConfig | 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 DeviceTagConfig instance in this response. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagConfig | DeviceTagConfig carries the value to set into the datastore. See the documentation on the DeviceTagConfig struct for which fields are required. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagConfig | Value carries all the values given in the DeviceTagConfigSetRequest 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. |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceTagConfig[…] | 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. This field is not allowed in the Subscribe RPC. |
Field Name | Type | Description |
---|---|---|
value | DeviceTagConfig | 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 DeviceTagConfig’s last modification. |
type | arista.subscriptions.Operation | Operation indicates how the DeviceTagConfig 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. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies a DeviceTag 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. |
Field Name | Type | Description |
---|---|---|
value | DeviceTag | 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 DeviceTag instance in this response. |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceTag[…] | 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. This field is not allowed in the Subscribe RPC. |
Field Name | Type | Description |
---|---|---|
value | DeviceTag | 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 DeviceTag’s last modification. |
type | arista.subscriptions.Operation | Operation indicates how the DeviceTag 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. |
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | InterfaceTagAssignmentKey | This is the key of the InterfaceTagAssignmentConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
Field Name | Type | Description |
---|---|---|
key | InterfaceTagAssignmentKey | Key indicates which InterfaceTagAssignmentConfig instance to remove. This field must always be set. |
Field Name | Type | Description |
---|---|---|
key | InterfaceTagAssignmentKey | Key echoes back the key of the deleted InterfaceTagAssignmentConfig 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. |
Field Name | Type | Description |
---|---|---|
key | InterfaceTagAssignmentKey | Key uniquely identifies a InterfaceTagAssignmentConfig 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. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagAssignmentConfig | 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 InterfaceTagAssignmentConfig instance in this response. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagAssignmentConfig | InterfaceTagAssignmentConfig carries the value to set into the datastore. See the documentation on the InterfaceTagAssignmentConfig struct for which fields are required. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagAssignmentConfig | Value carries all the values given in the InterfaceTagAssignmentConfigSetRequest 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. |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | InterfaceTagAssignmentConfig[…] | 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. This field is not allowed in the Subscribe RPC. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagAssignmentConfig | 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 InterfaceTagAssignmentConfig’s last modification. |
type | arista.subscriptions.Operation | Operation indicates how the InterfaceTagAssignmentConfig 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. |
Field Name | Type | Description |
---|---|---|
type | fmp.DeleteError | This describes the class of delete error. |
error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
key | TagKey | This is the key of the InterfaceTagConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key indicates which InterfaceTagConfig instance to remove. This field must always be set. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key echoes back the key of the deleted InterfaceTagConfig 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. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies a InterfaceTagConfig 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. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagConfig | 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 InterfaceTagConfig instance in this response. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagConfig | InterfaceTagConfig carries the value to set into the datastore. See the documentation on the InterfaceTagConfig struct for which fields are required. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagConfig | Value carries all the values given in the InterfaceTagConfigSetRequest 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. |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | InterfaceTagConfig[…] | 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. This field is not allowed in the Subscribe RPC. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTagConfig | 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 InterfaceTagConfig’s last modification. |
type | arista.subscriptions.Operation | Operation indicates how the InterfaceTagConfig 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. |
Field Name | Type | Description |
---|---|---|
key | TagKey | Key uniquely identifies a InterfaceTag 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. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTag | 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 InterfaceTag instance in this response. |
Field Name | Type | Description |
---|---|---|
partial_eq_filter | InterfaceTag[…] | 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. This field is not allowed in the Subscribe RPC. |
Field Name | Type | Description |
---|---|---|
value | InterfaceTag | 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 InterfaceTag’s last modification. |
type | arista.subscriptions.Operation | Operation indicates how the InterfaceTag 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. |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | DeviceTagConfigRequest | DeviceTagConfigResponse | |
GetAll | DeviceTagConfigStreamRequest | DeviceTagConfigStreamResponse stream | |
Subscribe | DeviceTagConfigStreamRequest | DeviceTagConfigStreamResponse stream | |
Set | DeviceTagConfigSetRequest | DeviceTagConfigSetResponse | |
Delete | DeviceTagConfigDeleteRequest | DeviceTagConfigDeleteResponse | |
DeleteAll | DeviceTagConfigDeleteAllRequest | DeviceTagConfigDeleteAllResponse stream |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | DeviceTagRequest | DeviceTagResponse | |
GetAll | DeviceTagStreamRequest | DeviceTagStreamResponse stream | |
Subscribe | DeviceTagStreamRequest | DeviceTagStreamResponse stream |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | InterfaceTagConfigRequest | InterfaceTagConfigResponse | |
GetAll | InterfaceTagConfigStreamRequest | InterfaceTagConfigStreamResponse stream | |
Subscribe | InterfaceTagConfigStreamRequest | InterfaceTagConfigStreamResponse stream | |
Set | InterfaceTagConfigSetRequest | InterfaceTagConfigSetResponse | |
Delete | InterfaceTagConfigDeleteRequest | InterfaceTagConfigDeleteResponse | |
DeleteAll | InterfaceTagConfigDeleteAllRequest | InterfaceTagConfigDeleteAllResponse stream |
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetOne | InterfaceTagRequest | InterfaceTagResponse | |
GetAll | InterfaceTagStreamRequest | InterfaceTagStreamResponse stream | |
Subscribe | InterfaceTagStreamRequest | InterfaceTagStreamResponse stream |