configstatus.v1

Top

arista/configstatus.v1/configstatus.proto

ConfigDiff

Field NameTypeDescription
keyConfigDiffKey

Key represents config diff key

urigoogle.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 NameTypeDescription
a_device_idgoogle.protobuf.StringValue

A_device_id is the serial number of the device on A side (left hand side)

a_typeConfigType

A_type is the config type on A side (left hand side)

a_timegoogle.protobuf.Timestamp

A_time is the time at which to fetch config on A side (left hand side)

b_device_idgoogle.protobuf.StringValue

B_device_id is the serial number of the device on B side (right hand side)

b_typeConfigType

B_type is the config type on B side (right hand side)

b_timegoogle.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 when handling device configuration

Field NameTypeDescription
error_codeErrorCode

error_msggoogle.protobuf.StringValue

line_numgoogle.protobuf.Int32Value

Line_num represents line number, if any

configlet_namegoogle.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

Field NameTypeDescription
valuesConfigError[…]

ConfigKey

ConfigKey uniquely identifies a config request.

Field NameTypeDescription
device_idgoogle.protobuf.StringValue

Device_id is the serial number of the device

typeConfigType

Type describes the config type

ConfigSource

ConfigSource describes an individual source of the proposed/designed config

Field NameTypeDescription
source_typeConfigSourceType

source_idgoogle.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

ConfigSources

ConfigSources is the list of sources of the proposed/designed config

Field NameTypeDescription
valuesConfigSource[…]

ConfigSummary

ConfigSummary represents device configuration summary.

Field NameTypeDescription
syncConfigSyncCode

nop_linesgoogle.protobuf.Int32Value

Number of lines with code no-operation

ignored_linesgoogle.protobuf.Int32Value

Number of lines with code IGNORE

added_linesgoogle.protobuf.Int32Value

Number of lines with code ADD

deleted_linesgoogle.protobuf.Int32Value

Number of lines with code DELETE

changed_linesgoogle.protobuf.Int32Value

Number of lines with code CHANGE

designed_config_errorsgoogle.protobuf.Int32Value

Number of designed config errors

designed_config_warningsgoogle.protobuf.Int32Value

Number of designed config warnings

running_config_update_timegoogle.protobuf.Timestamp

Timestamp at which running config is updated

designed_config_update_timegoogle.protobuf.Timestamp

Timestamp at which designed config is updated

running_config_urigoogle.protobuf.StringValue

The HTTP URI client can use to GET running config and associated errors

designed_config_urigoogle.protobuf.StringValue

The HTTP URI client can use to GET designed config and associated errors

diff_urigoogle.protobuf.StringValue

The HTTP URI client can use to GET config diff and associated errors

digestgoogle.protobuf.StringValue

Digest (SHA-256) of the config diff.

Configuration

Configuration represents device’s CLI configuration

Field NameTypeDescription
keyConfigKey

urigoogle.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 NameTypeDescription
valuesDiffEntry[…]

DiffEntry

DiffEntry represents one entry in a Diff

Field NameTypeDescription
opDiffOp

a_line_numgoogle.protobuf.Int32Value

line number in A this diff applies to

b_line_numgoogle.protobuf.Int32Value

line number in B this diff applies to

b_parent_line_numgoogle.protobuf.Int32Value

line number of the parent command in B

a_linegoogle.protobuf.StringValue

content of config line in A

b_linegoogle.protobuf.StringValue

content of config line in B

a_filter_codeConfigFilterCode

Config filter code of the line in A

b_filter_codeConfigFilterCode

Config filter code of the line in B

a_parent_line_numgoogle.protobuf.Int32Value

line number of the parent command in A

SecurityProfile

SecurityProfile holds the EOS configuration for the security profile.

Field NameTypeDescription
keyConfigKey

key uniquely identifies the configuration

configgoogle.protobuf.StringValue

config describes the security profile config body

SecurityProfileComplianceSummary

SecurityProfileComplianceSummary holds the compliance summary for security profile configuration.

Field NameTypeDescription
syncConfigSyncCode

nop_linesgoogle.protobuf.Int32Value

nop_lines is the number of lines with code no-operation

ignored_linesgoogle.protobuf.Int32Value

ignored_lines is the number of lines with code IGNORE

added_linesgoogle.protobuf.Int32Value

added_lines is the number of lines with code ADD

deleted_linesgoogle.protobuf.Int32Value

deleted_lines is the number of lines with code DELETE

changed_linesgoogle.protobuf.Int32Value

changed_lines is the Number of lines with code CHANGE

digestgoogle.protobuf.StringValue

digest is the digest (SHA-256 hash) of the security profile configuration diff

running_config_update_timegoogle.protobuf.Timestamp

running_config_update_time is the timestamp at which running security profile

or running config is updated

designed_config_update_timegoogle.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 NameTypeDescription
keyConfigDiffKey

key represents security profile config diff key

diffDiffEntries

diff represents diff entries

SecurityProfileDiffSummary

SecurityProfileDiffSummary holds device compliance summary w.r.t security profile.

Field NameTypeDescription
keySummaryKey

key uniquely identifies the Summary

summarySecurityProfileComplianceSummary

summary is the security profile configuration compliance summary

Summary

Field NameTypeDescription
keySummaryKey

summaryConfigSummary

SummaryKey

SummaryKey uniquely identifies a device summary request

Field NameTypeDescription
device_idgoogle.protobuf.StringValue

Device_id is the serial number of the device

ConfigFilterCode

ConfigFilterCode indicates if a config line matches PCM filter(s)

NameNumberDescription
CONFIG_FILTER_CODE_UNSPECIFIED0

UNSPECIFIED indicates config line did not match any partial config management (PCM) filter

CONFIG_FILTER_CODE_MANAGED_LINE1

MANAGED_LINE indicates config line matches managed PCM filter hence is managed

CONFIG_FILTER_CODE_UNMANAGED_LINE2

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

NameNumberDescription
CONFIG_SOURCE_TYPE_UNSPECIFIED0

CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET1

CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET - configlet created from

the network provisioning workflow.

CONFIG_SOURCE_TYPE_STUDIO2

CONFIG_SOURCE_TYPE_STUDIO - config generated from a regular studio

CONFIG_SOURCE_TYPE_STUDIO_STATIC3

SCONFIG_SOURCE_TYPE_STUDIO_STATIC - static config from studios framework

ConfigSyncCode

ConfigSyncCode indicates config synchronization status

NameNumberDescription
CONFIG_SYNC_CODE_UNSPECIFIED0

CONFIG_SYNC_CODE_IN_SYNC1

IN_SYNC indicates designed config and running config are identical

CONFIG_SYNC_CODE_OUT_OF_SYNC2

OUT_OF_SYNC indicates designed config and running config are not identical

ConfigType

NameNumberDescription
CONFIG_TYPE_UNSPECIFIED0

CONFIG_TYPE_RUNNING_CONFIG1

CONFIG_TYPE_DESIGNED_CONFIG2

DiffOp

DiffOp is the operation to a line from one side of diff to get to another

NameNumberDescription
DIFF_OP_UNSPECIFIED0

DIFF_OP_NOP1

NOP indicates no change. A and B are identical at this line

DIFF_OP_IGNORE2

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_ADD3

ADD is an addition of a line from A

DIFF_OP_DELETE4

DELETE is deletion of a line from B

DIFF_OP_CHANGE5

CHANGE is a modification to a line in A

ErrorCode

ErrorCode indicates warnings and errors produced during computing config

NameNumberDescription
ERROR_CODE_UNSPECIFIED0

ERROR_CODE_DEVICE_WARNING1

DEVICE_WARNING indicates device warning

ERROR_CODE_DEVICE_ERROR2

DEVICE_ERROR indicates device error

ERROR_CODE_UNREACHABLE_DEVICE3

UNREACHABLE_DEVICE indicates the device cannot be reached

ERROR_CODE_CONFIG_FILTER_ERROR4

CONFIG_FILTER_ERROR indicates error from partial config management filters

ERROR_CODE_INTERNAL5

INTERNAL indicates internal errors

Top

arista/configstatus.v1/services.gen.proto

ConfigDiffRequest

Field NameTypeDescription
keyConfigDiffKey

Key uniquely identifies a ConfigDiff instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueConfigDiff

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

ConfigDiff instance in this response.

ConfigDiffSomeRequest

Field NameTypeDescription
keysConfigDiffKey[…]

timegoogle.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 NameTypeDescription
valueConfigDiff

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

ConfigDiffStreamRequest

Field NameTypeDescription
partial_eq_filterConfigDiff[…]

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.

timearista.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 NameTypeDescription
valueConfigDiff

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this ConfigDiff’s last modification.

typearista.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.

ConfigurationRequest

Field NameTypeDescription
keyConfigKey

Key uniquely identifies a Configuration instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueConfiguration

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

Configuration instance in this response.

ConfigurationSomeRequest

Field NameTypeDescription
keysConfigKey[…]

timegoogle.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 NameTypeDescription
valueConfiguration

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

ConfigurationStreamRequest

Field NameTypeDescription
partial_eq_filterConfiguration[…]

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.

timearista.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 NameTypeDescription
valueConfiguration

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Configuration’s last modification.

typearista.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 NameTypeDescription
timegoogle.protobuf.Timestamp

Time holds the timestamp of the last item included in the metadata calculation.

typearista.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.

countgoogle.protobuf.UInt32Value

Count is the number of items present under the conditions of the request.

SecurityProfileDiffRequest

Field NameTypeDescription
keyConfigDiffKey

Key uniquely identifies a SecurityProfileDiff instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueSecurityProfileDiff

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

SecurityProfileDiff instance in this response.

SecurityProfileDiffSomeRequest

Field NameTypeDescription
keysConfigDiffKey[…]

timegoogle.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 NameTypeDescription
valueSecurityProfileDiff

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

SecurityProfileDiffStreamRequest

Field NameTypeDescription
partial_eq_filterSecurityProfileDiff[…]

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.

timearista.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 NameTypeDescription
valueSecurityProfileDiff

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this SecurityProfileDiff’s last modification.

typearista.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.

SecurityProfileDiffSummaryRequest

Field NameTypeDescription
keySummaryKey

Key uniquely identifies a SecurityProfileDiffSummary instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueSecurityProfileDiffSummary

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

SecurityProfileDiffSummary instance in this response.

SecurityProfileDiffSummarySomeRequest

Field NameTypeDescription
keysSummaryKey[…]

timegoogle.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 NameTypeDescription
valueSecurityProfileDiffSummary

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

SecurityProfileDiffSummaryStreamRequest

Field NameTypeDescription
partial_eq_filterSecurityProfileDiffSummary[…]

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.

timearista.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 NameTypeDescription
valueSecurityProfileDiffSummary

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this SecurityProfileDiffSummary’s last modification.

typearista.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 NameTypeDescription
keyConfigKey

Key uniquely identifies a SecurityProfile instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueSecurityProfile

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

SecurityProfile instance in this response.

SecurityProfileSomeRequest

Field NameTypeDescription
keysConfigKey[…]

timegoogle.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 NameTypeDescription
valueSecurityProfile

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

SecurityProfileStreamRequest

Field NameTypeDescription
partial_eq_filterSecurityProfile[…]

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.

timearista.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 NameTypeDescription
valueSecurityProfile

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this SecurityProfile’s last modification.

typearista.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.

SummaryRequest

Field NameTypeDescription
keySummaryKey

Key uniquely identifies a Summary instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueSummary

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

Summary instance in this response.

SummarySomeRequest

Field NameTypeDescription
keysSummaryKey[…]

timegoogle.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 NameTypeDescription
valueSummary

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

SummaryStreamRequest

Field NameTypeDescription
partial_eq_filterSummary[…]

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.

timearista.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 NameTypeDescription
valueSummary

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Summary’s last modification.

typearista.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 NameRequest TypeResponse TypeDescription
GetOneConfigDiffRequestConfigDiffResponse

GetSomeConfigDiffSomeRequestConfigDiffSomeResponse stream

GetAllConfigDiffStreamRequestConfigDiffStreamResponse stream

SubscribeConfigDiffStreamRequestConfigDiffStreamResponse stream

GetMetaConfigDiffStreamRequestMetaResponse

SubscribeMetaConfigDiffStreamRequestMetaResponse stream

ConfigurationService

Method NameRequest TypeResponse TypeDescription
GetOneConfigurationRequestConfigurationResponse

GetSomeConfigurationSomeRequestConfigurationSomeResponse stream

GetAllConfigurationStreamRequestConfigurationStreamResponse stream

SubscribeConfigurationStreamRequestConfigurationStreamResponse stream

GetMetaConfigurationStreamRequestMetaResponse

SubscribeMetaConfigurationStreamRequestMetaResponse stream

SecurityProfileDiffService

Method NameRequest TypeResponse TypeDescription
GetOneSecurityProfileDiffRequestSecurityProfileDiffResponse

GetSomeSecurityProfileDiffSomeRequestSecurityProfileDiffSomeResponse stream

GetAllSecurityProfileDiffStreamRequestSecurityProfileDiffStreamResponse stream

SubscribeSecurityProfileDiffStreamRequestSecurityProfileDiffStreamResponse stream

GetMetaSecurityProfileDiffStreamRequestMetaResponse

SubscribeMetaSecurityProfileDiffStreamRequestMetaResponse stream

SecurityProfileDiffSummaryService

Method NameRequest TypeResponse TypeDescription
GetOneSecurityProfileDiffSummaryRequestSecurityProfileDiffSummaryResponse

GetSomeSecurityProfileDiffSummarySomeRequestSecurityProfileDiffSummarySomeResponse stream

GetAllSecurityProfileDiffSummaryStreamRequestSecurityProfileDiffSummaryStreamResponse stream

SubscribeSecurityProfileDiffSummaryStreamRequestSecurityProfileDiffSummaryStreamResponse stream

GetMetaSecurityProfileDiffSummaryStreamRequestMetaResponse

SubscribeMetaSecurityProfileDiffSummaryStreamRequestMetaResponse stream

SecurityProfileService

Method NameRequest TypeResponse TypeDescription
GetOneSecurityProfileRequestSecurityProfileResponse

GetSomeSecurityProfileSomeRequestSecurityProfileSomeResponse stream

GetAllSecurityProfileStreamRequestSecurityProfileStreamResponse stream

SubscribeSecurityProfileStreamRequestSecurityProfileStreamResponse stream

GetMetaSecurityProfileStreamRequestMetaResponse

SubscribeMetaSecurityProfileStreamRequestMetaResponse stream

SummaryService

Method NameRequest TypeResponse TypeDescription
GetOneSummaryRequestSummaryResponse

GetSomeSummarySomeRequestSummarySomeResponse stream

GetAllSummaryStreamRequestSummaryStreamResponse stream

SubscribeSummaryStreamRequestSummaryStreamResponse stream

GetMetaSummaryStreamRequestMetaResponse

SubscribeMetaSummaryStreamRequestMetaResponse stream