connectivitymonitor.v1

key uniquely identifies the connectivity monitor probe.

ip_addr is the IP Address of the probe.

host_name is the name of the host of the probe.

description is the description of the probe.

device_id is the id of the device in the probe.

host is the hostname used in the probe.

vrf is the name of the VRF in the probe.

key uniquely identifies the connectivity monitor probe.

latency_millis is the latency between the device interface and the host.

Value is in milliseconds.

jitter_millis is the amount of jitter experienced by requests

between the device interface and host.

Value is in milliseconds.

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 is the amount of packet loss experienced

by requests between the device interface and host.

Value is a percentage.

error is the error reported on the connection.

device_id is the id of the device in the probe.

host is the hostname used in the probe.

vrf is the name of the VRF in the probe.

source_intf is the name of the interface in the probe.

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

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 is the number of items present under the conditions of the request.

Key uniquely identifies a Probe 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

Probe instance in this response.

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.

Error is an optional field.

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

Key uniquely identifies a ProbeStats 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

ProbeStats instance in this response.

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.

Error is an optional field.

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

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.

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.

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 ProbeStats’s last modification.

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.

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.

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.

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 Probe’s last modification.

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.