connectivitymonitor.v1

Version: 1.2.0

Available Services

    ProbeService

    ProbeStatsService

• arista/connectivitymonitor.v1/connectivitymonitor.proto
  • Probe
  • ProbeKey
  • ProbeStats
  • ProbeStatsKey
• arista/connectivitymonitor.v1/services.gen.proto

  • MetaResponse

  • ProbeBatchedStreamRequest

  • ProbeBatchedStreamResponse

  • ProbeRequest

  • ProbeResponse

  • ProbeSomeRequest

  • ProbeSomeResponse

  • ProbeStatsBatchedStreamRequest

  • ProbeStatsBatchedStreamResponse

  • ProbeStatsRequest

  • ProbeStatsResponse

  • ProbeStatsSomeRequest

  • ProbeStatsSomeResponse

  • ProbeStatsStreamRequest

  • ProbeStatsStreamResponse

  • ProbeStreamRequest

  • ProbeStreamResponse

  • ProbeService

  • ProbeStatsService

Top

arista/connectivitymonitor.v1/connectivitymonitor.proto

Probe

Probe is identifying information of a connectivity monitor probe. It is used to retrieve probe information without getting the corresponding stats so that probe information can be displayed without streaming all related data, such as in the UI.

Field Name	Type	Description
key	ProbeKey	key uniquely identifies the connectivity monitor probe.
ip_addr	google.protobuf.StringValue	ip_addr is the IP Address of the probe.
host_name	google.protobuf.StringValue	host_name is the name of the host of the probe.
description	google.protobuf.StringValue	description is the description of the probe.

ProbeKey

ProbeKey uniquely identifies a connectivity monitor probe.

Field Name	Type	Description
device_id	google.protobuf.StringValue	device_id is the id of the device in the probe.
host	google.protobuf.StringValue	host is the hostname used in the probe.
vrf	google.protobuf.StringValue	vrf is the name of the VRF in the probe.

ProbeStats

ProbeStats is the connectivity monitor statistics related to the specified probe.

Field Name	Type	Description
key	ProbeStatsKey	key uniquely identifies the connectivity monitor probe.
latency_millis	google.protobuf.DoubleValue	latency_millis is the latency between the device interface and the host. Value is in milliseconds.
jitter_millis	google.protobuf.DoubleValue	jitter_millis is the amount of jitter experienced by requests between the device interface and host. Value is in milliseconds.
http_response_time_millis	google.protobuf.DoubleValue	http_response_time_millis is the amount of time taken to respond to a http request between the device interface and the host. Value is in milliseconds.
packet_loss_percent	google.protobuf.Int64Value	packet_loss_percent is the amount of packet loss experienced by requests between the device interface and host. Value is a percentage.
error	google.protobuf.StringValue	error is the error reported on the connection.

ProbeStatsKey

ProbeStatsKey uniquely identifies a connectivity monitor probe's statistics, per source interface.

Field Name	Type	Description
device_id	google.protobuf.StringValue	device_id is the id of the device in the probe.
host	google.protobuf.StringValue	host is the hostname used in the probe.
vrf	google.protobuf.StringValue	vrf is the name of the VRF in the probe.
source_intf	google.protobuf.StringValue	source_intf is the name of the interface in the probe.

Top

arista/connectivitymonitor.v1/services.gen.proto

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.

ProbeBatchedStreamRequest

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

ProbeBatchedStreamResponse

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

ProbeRequest

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

ProbeResponse

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

ProbeSomeRequest

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

ProbeSomeResponse

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

ProbeStatsBatchedStreamRequest

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

ProbeStatsBatchedStreamResponse

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

ProbeStatsRequest

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

ProbeStatsResponse

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

ProbeStatsSomeRequest

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

ProbeStatsSomeResponse

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

ProbeStatsStreamRequest

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

ProbeStatsStreamResponse

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

ProbeStreamRequest

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

ProbeStreamResponse

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

ProbeService

Method Name	Request Type	Response Type	Description
GetOne	ProbeRequest	ProbeResponse
GetSome	ProbeSomeRequest	ProbeSomeResponse stream
GetAll	ProbeStreamRequest	ProbeStreamResponse stream
Subscribe	ProbeStreamRequest	ProbeStreamResponse stream
GetMeta	ProbeStreamRequest	MetaResponse
SubscribeMeta	ProbeStreamRequest	MetaResponse stream
GetAllBatched	ProbeBatchedStreamRequest	ProbeBatchedStreamResponse stream
SubscribeBatched	ProbeBatchedStreamRequest	ProbeBatchedStreamResponse stream

ProbeStatsService

Method Name	Request Type	Response Type	Description
GetOne	ProbeStatsRequest	ProbeStatsResponse
GetSome	ProbeStatsSomeRequest	ProbeStatsSomeResponse stream
GetAll	ProbeStatsStreamRequest	ProbeStatsStreamResponse stream
Subscribe	ProbeStatsStreamRequest	ProbeStatsStreamResponse stream
GetMeta	ProbeStatsStreamRequest	MetaResponse
SubscribeMeta	ProbeStatsStreamRequest	MetaResponse stream
GetAllBatched	ProbeStatsBatchedStreamRequest	ProbeStatsBatchedStreamResponse stream
SubscribeBatched	ProbeStatsBatchedStreamRequest	ProbeStatsBatchedStreamResponse stream