configstatus.v1
Available Services
SecurityProfileDiffSummaryService
arista/configstatus.v1/configstatus.proto
ConfigDiff
ConfigDiff - specifies the diff request
| Field Name | Type | Description |
|---|---|---|
| key | ConfigDiffKey | key represents config diff key |
| uri | google.protobuf.StringValue | uri represents the HTTP URI client can use to GET config diff and associated errors |
ConfigDiffKey
ConfigDiffKey uniquely identifies a configuration diff request
| Field Name | Type | Description |
|---|---|---|
| a_device_id | google.protobuf.StringValue | a_device_id is the serial number of the device on A side (left hand side) |
| a_type | ConfigType | a_type is the config type on A side (left hand side) |
| a_time | google.protobuf.Timestamp | a_time is the time at which to fetch config on A side (left hand side) |
| b_device_id | google.protobuf.StringValue | b_device_id is the serial number of the device on B side (right hand side) |
| b_type | ConfigType | b_type is the config type on B side (right hand side) |
| b_time | google.protobuf.Timestamp | b_time is the time at which to fetch config on B side (right hand side) |
ConfigError
ConfigError represents errors reported by CVP/EOS when handling device configuration
| Field Name | Type | Description |
|---|---|---|
| error_code | ErrorCode | error_code - type of error. |
| error_msg | google.protobuf.StringValue | error_msg - details of error |
| line_num | google.protobuf.Int32Value | line_num represents line number, if any |
| configlet_name | google.protobuf.StringValue | configlet_name represents the originating configlet name. Configlet_name and line_num point to the line where config warning or config error originate. |
ConfigErrors
ConfigErrors list of errors
| Field Name | Type | Description |
|---|---|---|
| values | ConfigError[...] | values - list of errors |
ConfigKey
ConfigKey uniquely identifies a config request.
| Field Name | Type | Description |
|---|---|---|
| device_id | google.protobuf.StringValue | device_id is the serial number of the device |
| type | ConfigType | type describes the config type |
ConfigSource
ConfigSource describes an individual source of the proposed/designed config
| Field Name | Type | Description |
|---|---|---|
| source_type | ConfigSourceType | source_type - app type of the config snippet |
| source_id | google.protobuf.StringValue | source_id identifier to distinguish between multiple instances of the source type source_id is : configlet name for CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET studio id for CONFIG_SOURCE_TYPE_STUDIO configlet id for CONFIG_SOURCE_TYPE_STUDIO_STATIC FixtureInstance id for CONFIG_SOURCE_TYPE_HIERARCHY |
ConfigSources
ConfigSources is the list of sources of the proposed/designed config
| Field Name | Type | Description |
|---|---|---|
| values | ConfigSource[...] | values - ordered list of all the config snippets present in DC |
ConfigSummary
ConfigSummary represents device configuration summary.
| Field Name | Type | Description |
|---|---|---|
| sync | ConfigSyncCode | sync - state of DC vs RC |
| nop_lines | google.protobuf.Int32Value | nop_lines - Number of lines with code no-operation |
| ignored_lines | google.protobuf.Int32Value | ignored_lines - Number of lines with code IGNORE |
| added_lines | google.protobuf.Int32Value | added_lines - Number of lines with code ADD |
| deleted_lines | google.protobuf.Int32Value | deleted_lines - Number of lines with code DELETE |
| changed_lines | google.protobuf.Int32Value | changed_lines - Number of lines with code CHANGE |
| designed_config_errors | google.protobuf.Int32Value | designed_config_errors - Number of designed config errors |
| designed_config_warnings | google.protobuf.Int32Value | designed_config_warnings - Number of designed config warnings |
| running_config_update_time | google.protobuf.Timestamp | running_config_update_time - Timestamp at which running config is updated |
| designed_config_update_time | google.protobuf.Timestamp | designed_config_update_time - Timestamp at which designed config is updated |
| running_config_uri | google.protobuf.StringValue | running_config_uri - The HTTP URI client can use to GET running config and associated errors |
| designed_config_uri | google.protobuf.StringValue | designed_config_uri - The HTTP URI client can use to GET designed config and associated errors |
| diff_uri | google.protobuf.StringValue | diff_uri - The HTTP URI client can use to GET config diff and associated errors |
| digest | google.protobuf.StringValue | digest (SHA-256) of the config diff. |
Configuration
Configuration represents device's CLI configuration
| Field Name | Type | Description |
|---|---|---|
| key | ConfigKey | key specifies the device and type of config |
| uri | google.protobuf.StringValue | uri represents the HTTP URI client can use to GET config body and associated errors |
DiffEntries
DiffEntries indicates potential multiple lines of config diff
| Field Name | Type | Description |
|---|---|---|
| values | DiffEntry[...] | values - list of diff entries |
DiffEntry
DiffEntry represents one entry in a Diff
| Field Name | Type | Description |
|---|---|---|
| op | DiffOp | op - type of diff |
| a_line_num | google.protobuf.Int32Value | a_line_num - line number in A this diff applies to |
| b_line_num | google.protobuf.Int32Value | b_line_num - line number in B this diff applies to |
| b_parent_line_num | google.protobuf.Int32Value | b_parent_line_num line number of the parent command in B |
| a_line | google.protobuf.StringValue | a_line content of config line in A |
| b_line | google.protobuf.StringValue | b_line content of config line in B |
| a_filter_code | ConfigFilterCode | a_filter_code Config filter code of the line in A |
| b_filter_code | ConfigFilterCode | b_filter_code Config filter code of the line in B |
| a_parent_line_num | google.protobuf.Int32Value | a_parent_line_num line number of the parent command in A |
SecurityProfile
SecurityProfile holds the EOS configuration for the security profile.
| Field Name | Type | Description |
|---|---|---|
| key | ConfigKey | key uniquely identifies the configuration |
| config | google.protobuf.StringValue | config describes the security profile config body |
SecurityProfileComplianceSummary
SecurityProfileComplianceSummary holds the compliance summary for security profile configuration.
| Field Name | Type | Description |
|---|---|---|
| sync | ConfigSyncCode | sync - sync state of the device |
| nop_lines | google.protobuf.Int32Value | nop_lines is the number of lines with code no-operation |
| ignored_lines | google.protobuf.Int32Value | ignored_lines is the number of lines with code IGNORE |
| added_lines | google.protobuf.Int32Value | added_lines is the number of lines with code ADD |
| deleted_lines | google.protobuf.Int32Value | deleted_lines is the number of lines with code DELETE |
| changed_lines | google.protobuf.Int32Value | changed_lines is the Number of lines with code CHANGE |
| digest | google.protobuf.StringValue | digest is the digest (SHA-256 hash) of the security profile configuration diff |
| running_config_update_time | google.protobuf.Timestamp | running_config_update_time is the timestamp at which running security profile or running config is updated |
| designed_config_update_time | google.protobuf.Timestamp | designed_config_update_time is the timestamp at which designed security profile or designed config is updated |
SecurityProfileDiff
SecurityProfileDiff holds the security profile configuration diff.
| Field Name | Type | Description |
|---|---|---|
| key | ConfigDiffKey | key represents security profile config diff key |
| diff | DiffEntries | diff represents diff entries |
SecurityProfileDiffSummary
SecurityProfileDiffSummary holds device compliance summary w.r.t security profile.
| Field Name | Type | Description |
|---|---|---|
| key | SummaryKey | key uniquely identifies the Summary |
| summary | SecurityProfileComplianceSummary | summary is the security profile configuration compliance summary |
Summary
Summary - Describes the device's diff summary
| Field Name | Type | Description |
|---|---|---|
| key | SummaryKey | key spefies the device |
| summary | ConfigSummary | summary - diff summary of the device |
SummaryKey
SummaryKey uniquely identifies a device summary request
| Field Name | Type | Description |
|---|---|---|
| device_id | google.protobuf.StringValue | device_id is the serial number of the device |
ConfigFilterCode
ConfigFilterCode indicates if a config line matches PCM filter(s)
| Name | Number | Description |
|---|---|---|
| CONFIG_FILTER_CODE_UNSPECIFIED | 0 | CONFIG_FILTER_CODE_UNSPECIFIED uninitialized |
| CONFIG_FILTER_CODE_MANAGED_LINE | 1 | CONFIG_FILTER_CODE_MANAGED_LINE indicates config line matches managed PCM filter hence is managed |
| CONFIG_FILTER_CODE_UNMANAGED_LINE | 2 | CONFIG_FILTER_CODE_UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed |
ConfigSourceType
ConfigSourceType indicates the type of source for the proposed/designed configuration for the device
| Name | Number | Description |
|---|---|---|
| CONFIG_SOURCE_TYPE_UNSPECIFIED | 0 | CONFIG_SOURCE_TYPE_UNSPECIFIED uninitialized value |
| CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET | 1 | CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET - configlet created from the network provisioning workflow. |
| CONFIG_SOURCE_TYPE_STUDIO | 2 | CONFIG_SOURCE_TYPE_STUDIO - config generated from a regular studio |
| CONFIG_SOURCE_TYPE_STUDIO_STATIC | 3 | CONFIG_SOURCE_TYPE_STUDIO_STATIC - static config from studios framework |
| CONFIG_SOURCE_TYPE_HIERARCHY | 5 | CONFIG_SOURCE_TYPE_HIERARCHY - config from the hierarchy frameork |
ConfigSyncCode
ConfigSyncCode indicates config synchronization status
| Name | Number | Description |
|---|---|---|
| CONFIG_SYNC_CODE_UNSPECIFIED | 0 | CONFIG_SYNC_CODE_UNSPECIFIED uninitialized |
| CONFIG_SYNC_CODE_IN_SYNC | 1 | CONFIG_SYNC_CODE_IN_SYNC indicates designed config and running config are identical |
| CONFIG_SYNC_CODE_OUT_OF_SYNC | 2 | CONFIG_SYNC_CODE_OUT_OF_SYNC indicates designed config and running config are not identical |
ConfigType
ConfigType - specifies type of config
| Name | Number | Description |
|---|---|---|
| CONFIG_TYPE_UNSPECIFIED | 0 | CONFIG_TYPE_UNSPECIFIED uninitialized value |
| CONFIG_TYPE_RUNNING_CONFIG | 1 | CONFIG_TYPE_RUNNING_CONFIG uninitialized value |
| CONFIG_TYPE_DESIGNED_CONFIG | 2 | CONFIG_TYPE_DESIGNED_CONFIG uninitialized value |
DiffOp
DiffOp is the operation to a line from one side of diff to get to another
| Name | Number | Description |
|---|---|---|
| DIFF_OP_UNSPECIFIED | 0 | DIFF_OP_UNSPECIFIED uninitialized |
| DIFF_OP_NOP | 1 | DIFF_OP_NOP indicates no change. A and B are identical at this line |
| DIFF_OP_IGNORE | 2 | DIFF_OP_IGNORE indicates a line that's ignored in either A or B. One of a_line_num or b_line_num will be -1 |
| DIFF_OP_ADD | 3 | DIFF_OP_ADD is an addition of a line from A |
| DIFF_OP_DELETE | 4 | DIFF_OP_DELETE is deletion of a line from B |
| DIFF_OP_CHANGE | 5 | DIFF_OP_CHANGE is a modification to a line in A |
ErrorCode
ErrorCode indicates warnings and errors produced during computing config
| Name | Number | Description |
|---|---|---|
| ERROR_CODE_UNSPECIFIED | 0 | ERROR_CODE_UNSPECIFIED uninitialized value |
| ERROR_CODE_DEVICE_WARNING | 1 | ERROR_CODE_DEVICE_WARNING indicates device warning |
| ERROR_CODE_DEVICE_ERROR | 2 | ERROR_CODE_DEVICE_ERROR indicates device error |
| ERROR_CODE_UNREACHABLE_DEVICE | 3 | ERROR_CODE_UNREACHABLE_DEVICE indicates the device cannot be reached |
| ERROR_CODE_CONFIG_FILTER_ERROR | 4 | ERROR_CODE_CONFIG_FILTER_ERROR indicates error from partial config management filters |
| ERROR_CODE_INTERNAL | 5 | ERROR_CODE_INTERNAL indicates internal errors |
arista/configstatus.v1/services.gen.proto
ConfigDiffBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ConfigDiff[...] | 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 ConfigDiff at end. * Each ConfigDiff response is fully-specified (all fields set). * start: Returns the state of each ConfigDiff at start, followed by updates until now. * Each ConfigDiff response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigDiff at start, followed by updates until end. * Each ConfigDiff 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. |
ConfigDiffBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | ConfigDiffStreamResponse[...] | 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). |
ConfigDiffRequest
| Field Name | Type | Description |
|---|---|---|
| key | ConfigDiffKey | Key uniquely identifies a ConfigDiff 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. |
ConfigDiffResponse
| Field Name | Type | Description |
|---|---|---|
| value | ConfigDiff | 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 ConfigDiff instance in this response. |
ConfigDiffSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ConfigDiffKey[...] | |
| 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. |
ConfigDiffSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | ConfigDiff | 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 |
ConfigDiffStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ConfigDiff[...] | 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 ConfigDiff at end. * Each ConfigDiff response is fully-specified (all fields set). * start: Returns the state of each ConfigDiff at start, followed by updates until now. * Each ConfigDiff response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ConfigDiff at start, followed by updates until end. * Each ConfigDiff response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
ConfigDiffStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | ConfigDiff | 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 ConfigDiff's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the ConfigDiff 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. |
ConfigurationBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | Configuration[...] | 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 Configuration at end. * Each Configuration response is fully-specified (all fields set). * start: Returns the state of each Configuration at start, followed by updates until now. * Each Configuration response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Configuration at start, followed by updates until end. * Each Configuration 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. |
ConfigurationBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | ConfigurationStreamResponse[...] | 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). |
ConfigurationRequest
| Field Name | Type | Description |
|---|---|---|
| key | ConfigKey | Key uniquely identifies a Configuration 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. |
ConfigurationResponse
| Field Name | Type | Description |
|---|---|---|
| value | Configuration | 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 Configuration instance in this response. |
ConfigurationSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ConfigKey[...] | |
| 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. |
ConfigurationSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | Configuration | 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 |
ConfigurationStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | Configuration[...] | 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 Configuration at end. * Each Configuration response is fully-specified (all fields set). * start: Returns the state of each Configuration at start, followed by updates until now. * Each Configuration response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Configuration at start, followed by updates until end. * Each Configuration response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
ConfigurationStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | Configuration | 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 Configuration's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the Configuration 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. |
SecurityProfileBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SecurityProfile[...] | 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 SecurityProfile at end. * Each SecurityProfile response is fully-specified (all fields set). * start: Returns the state of each SecurityProfile at start, followed by updates until now. * Each SecurityProfile response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SecurityProfile at start, followed by updates until end. * Each SecurityProfile 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. |
SecurityProfileBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | SecurityProfileStreamResponse[...] | 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). |
SecurityProfileDiffBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SecurityProfileDiff[...] | 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 SecurityProfileDiff at end. * Each SecurityProfileDiff response is fully-specified (all fields set). * start: Returns the state of each SecurityProfileDiff at start, followed by updates until now. * Each SecurityProfileDiff response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SecurityProfileDiff at start, followed by updates until end. * Each SecurityProfileDiff 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. |
SecurityProfileDiffBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | SecurityProfileDiffStreamResponse[...] | 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). |
SecurityProfileDiffRequest
| Field Name | Type | Description |
|---|---|---|
| key | ConfigDiffKey | Key uniquely identifies a SecurityProfileDiff 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. |
SecurityProfileDiffResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfileDiff | 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 SecurityProfileDiff instance in this response. |
SecurityProfileDiffSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ConfigDiffKey[...] | |
| 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. |
SecurityProfileDiffSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfileDiff | 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 |
SecurityProfileDiffStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SecurityProfileDiff[...] | 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 SecurityProfileDiff at end. * Each SecurityProfileDiff response is fully-specified (all fields set). * start: Returns the state of each SecurityProfileDiff at start, followed by updates until now. * Each SecurityProfileDiff response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SecurityProfileDiff at start, followed by updates until end. * Each SecurityProfileDiff response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
SecurityProfileDiffStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfileDiff | 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 SecurityProfileDiff's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the SecurityProfileDiff 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. |
SecurityProfileDiffSummaryBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SecurityProfileDiffSummary[...] | 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 SecurityProfileDiffSummary at end. * Each SecurityProfileDiffSummary response is fully-specified (all fields set). * start: Returns the state of each SecurityProfileDiffSummary at start, followed by updates until now. * Each SecurityProfileDiffSummary response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SecurityProfileDiffSummary at start, followed by updates until end. * Each SecurityProfileDiffSummary 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. |
SecurityProfileDiffSummaryBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | SecurityProfileDiffSummaryStreamResponse[...] | 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). |
SecurityProfileDiffSummaryRequest
| Field Name | Type | Description |
|---|---|---|
| key | SummaryKey | Key uniquely identifies a SecurityProfileDiffSummary 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. |
SecurityProfileDiffSummaryResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfileDiffSummary | 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 SecurityProfileDiffSummary instance in this response. |
SecurityProfileDiffSummarySomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | SummaryKey[...] | |
| 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. |
SecurityProfileDiffSummarySomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfileDiffSummary | 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 |
SecurityProfileDiffSummaryStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SecurityProfileDiffSummary[...] | 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 SecurityProfileDiffSummary at end. * Each SecurityProfileDiffSummary response is fully-specified (all fields set). * start: Returns the state of each SecurityProfileDiffSummary at start, followed by updates until now. * Each SecurityProfileDiffSummary response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SecurityProfileDiffSummary at start, followed by updates until end. * Each SecurityProfileDiffSummary response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
SecurityProfileDiffSummaryStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfileDiffSummary | 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 SecurityProfileDiffSummary's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the SecurityProfileDiffSummary 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. |
SecurityProfileRequest
| Field Name | Type | Description |
|---|---|---|
| key | ConfigKey | Key uniquely identifies a SecurityProfile 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. |
SecurityProfileResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfile | 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 SecurityProfile instance in this response. |
SecurityProfileSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ConfigKey[...] | |
| 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. |
SecurityProfileSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfile | 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 |
SecurityProfileStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | SecurityProfile[...] | 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 SecurityProfile at end. * Each SecurityProfile response is fully-specified (all fields set). * start: Returns the state of each SecurityProfile at start, followed by updates until now. * Each SecurityProfile response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each SecurityProfile at start, followed by updates until end. * Each SecurityProfile response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
SecurityProfileStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | SecurityProfile | 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 SecurityProfile's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the SecurityProfile 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. |
SummaryBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | Summary[...] | 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 Summary at end. * Each Summary response is fully-specified (all fields set). * start: Returns the state of each Summary at start, followed by updates until now. * Each Summary response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Summary at start, followed by updates until end. * Each Summary 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. |
SummaryBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | SummaryStreamResponse[...] | 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). |
SummaryRequest
| Field Name | Type | Description |
|---|---|---|
| key | SummaryKey | Key uniquely identifies a Summary 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. |
SummaryResponse
| Field Name | Type | Description |
|---|---|---|
| value | Summary | 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 Summary instance in this response. |
SummarySomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | SummaryKey[...] | |
| 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. |
SummarySomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | Summary | 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 |
SummaryStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | Summary[...] | 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 Summary at end. * Each Summary response is fully-specified (all fields set). * start: Returns the state of each Summary at start, followed by updates until now. * Each Summary response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Summary at start, followed by updates until end. * Each Summary response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
SummaryStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | Summary | 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 Summary's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the Summary 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. |
ConfigDiffService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | ConfigDiffRequest | ConfigDiffResponse | |
| GetSome | ConfigDiffSomeRequest | ConfigDiffSomeResponse stream | |
| GetAll | ConfigDiffStreamRequest | ConfigDiffStreamResponse stream | |
| Subscribe | ConfigDiffStreamRequest | ConfigDiffStreamResponse stream | |
| GetMeta | ConfigDiffStreamRequest | MetaResponse | |
| SubscribeMeta | ConfigDiffStreamRequest | MetaResponse stream | |
| GetAllBatched | ConfigDiffBatchedStreamRequest | ConfigDiffBatchedStreamResponse stream | |
| SubscribeBatched | ConfigDiffBatchedStreamRequest | ConfigDiffBatchedStreamResponse stream |
ConfigurationService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | ConfigurationRequest | ConfigurationResponse | |
| GetSome | ConfigurationSomeRequest | ConfigurationSomeResponse stream | |
| GetAll | ConfigurationStreamRequest | ConfigurationStreamResponse stream | |
| Subscribe | ConfigurationStreamRequest | ConfigurationStreamResponse stream | |
| GetMeta | ConfigurationStreamRequest | MetaResponse | |
| SubscribeMeta | ConfigurationStreamRequest | MetaResponse stream | |
| GetAllBatched | ConfigurationBatchedStreamRequest | ConfigurationBatchedStreamResponse stream | |
| SubscribeBatched | ConfigurationBatchedStreamRequest | ConfigurationBatchedStreamResponse stream |
SecurityProfileDiffService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | SecurityProfileDiffRequest | SecurityProfileDiffResponse | |
| GetSome | SecurityProfileDiffSomeRequest | SecurityProfileDiffSomeResponse stream | |
| GetAll | SecurityProfileDiffStreamRequest | SecurityProfileDiffStreamResponse stream | |
| Subscribe | SecurityProfileDiffStreamRequest | SecurityProfileDiffStreamResponse stream | |
| GetMeta | SecurityProfileDiffStreamRequest | MetaResponse | |
| SubscribeMeta | SecurityProfileDiffStreamRequest | MetaResponse stream | |
| GetAllBatched | SecurityProfileDiffBatchedStreamRequest | SecurityProfileDiffBatchedStreamResponse stream | |
| SubscribeBatched | SecurityProfileDiffBatchedStreamRequest | SecurityProfileDiffBatchedStreamResponse stream |
SecurityProfileDiffSummaryService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | SecurityProfileDiffSummaryRequest | SecurityProfileDiffSummaryResponse | |
| GetSome | SecurityProfileDiffSummarySomeRequest | SecurityProfileDiffSummarySomeResponse stream | |
| GetAll | SecurityProfileDiffSummaryStreamRequest | SecurityProfileDiffSummaryStreamResponse stream | |
| Subscribe | SecurityProfileDiffSummaryStreamRequest | SecurityProfileDiffSummaryStreamResponse stream | |
| GetMeta | SecurityProfileDiffSummaryStreamRequest | MetaResponse | |
| SubscribeMeta | SecurityProfileDiffSummaryStreamRequest | MetaResponse stream | |
| GetAllBatched | SecurityProfileDiffSummaryBatchedStreamRequest | SecurityProfileDiffSummaryBatchedStreamResponse stream | |
| SubscribeBatched | SecurityProfileDiffSummaryBatchedStreamRequest | SecurityProfileDiffSummaryBatchedStreamResponse stream |
SecurityProfileService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | SecurityProfileRequest | SecurityProfileResponse | |
| GetSome | SecurityProfileSomeRequest | SecurityProfileSomeResponse stream | |
| GetAll | SecurityProfileStreamRequest | SecurityProfileStreamResponse stream | |
| Subscribe | SecurityProfileStreamRequest | SecurityProfileStreamResponse stream | |
| GetMeta | SecurityProfileStreamRequest | MetaResponse | |
| SubscribeMeta | SecurityProfileStreamRequest | MetaResponse stream | |
| GetAllBatched | SecurityProfileBatchedStreamRequest | SecurityProfileBatchedStreamResponse stream | |
| SubscribeBatched | SecurityProfileBatchedStreamRequest | SecurityProfileBatchedStreamResponse stream |
SummaryService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | SummaryRequest | SummaryResponse | |
| GetSome | SummarySomeRequest | SummarySomeResponse stream | |
| GetAll | SummaryStreamRequest | SummaryStreamResponse stream | |
| Subscribe | SummaryStreamRequest | SummaryStreamResponse stream | |
| GetMeta | SummaryStreamRequest | MetaResponse | |
| SubscribeMeta | SummaryStreamRequest | MetaResponse stream | |
| GetAllBatched | SummaryBatchedStreamRequest | SummaryBatchedStreamResponse stream | |
| SubscribeBatched | SummaryBatchedStreamRequest | SummaryBatchedStreamResponse stream |