configstatus.v1

Key represents config diff key

Uri represents the HTTP URI client can use to GET config diff and associated errors

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

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

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

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

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

B_time is the time at which to fetch config on B side (right hand side)

Line_num represents line number, if any

Configlet_name represents the originating configlet name. Configlet_name

and line_num point to the line where config warning or config error originate.

Device_id is the serial number of the device

Type describes the config type

Number of lines with code no-operation

Number of lines with code IGNORE

Number of lines with code ADD

Number of lines with code DELETE

Number of lines with code CHANGE

Number of designed config errors

Number of designed config warnings

Timestamp at which running config is updated

Timestamp at which designed config is updated

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

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

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

Digest of the config diff. For example, it can be SHA-256 hash of the config diff

Uri represents the HTTP URI client can use to GET config body and associated errors

line number in A this diff applies to

line number in B this diff applies to

line number in B of the leading command of the containing block

content of config line in A

content of config line in B

Config filter code of the line in A

Config filter code of the line in B

Device_id is the serial number of the device

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

MANAGED_LINE indicates config line matches managed PCM filter hence is managed

UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed

IN_SYNC indicates designed config and running config are identical

OUT_OF_SYNC indicates designed config and running config are not identical

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

IGNORE indicates a line that’s ignored in either A or B.

One of a_line_num or b_line_num will be -1

ADD is an addition of a line from A

DELETE is deletion of a line from B

CHANGE is a modification to a line in A

DEVICE_WARNING indicates device warning

DEVICE_ERROR indicates device error

UNREACHABLE_DEVICE indicates the device cannot be reached

CONFIG_FILTER_ERROR indicates error from partial config management filters

INTERNAL indicates internal errors

Key uniquely identifies a ConfigDiff instance to retrieve.

This value must be populated.

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.

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 carries the (UTC) timestamp of the last-modification of the

ConfigDiff instance in this response.

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.

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.

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 holds the timestamp of this ConfigDiff’s last modification.

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.

Key uniquely identifies a Configuration instance to retrieve.

This value must be populated.

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.

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 carries the (UTC) timestamp of the last-modification of the

Configuration instance in this response.

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.

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.

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 holds the timestamp of this Configuration’s last modification.

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.

Key uniquely identifies a Summary instance to retrieve.

This value must be populated.

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.

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 carries the (UTC) timestamp of the last-modification of the

Summary instance in this response.

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.

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.

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 holds the timestamp of this Summary’s last modification.

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.