inventory.v1

key uniquely identifies the device.

software_version gives the currently running device software version.

model_name describes the hardware model of this device.

hardware_revision describes any revisional data to the model name.

fqdn gives the device’s fully qualified domain name.

hostname is the hostname as reported on the device.

domain_name provides the domain name on which the device is registered.

system_mac_address provides the MAC address of the management port.

boot_time indicates when the device was last booted.

streaming_status is the status of telemetry streaming for this device.

extended_attributes wraps any additional, potentially non-standard, features

or attributes that the device reports.

options is a map from device option to value.

E.g., for an SNMP device, this could be the following:

“address”: “my_snmp_hostname”,

“community”: “public”

key identifies the request for which to retrieve a decommissioning status.

status describes the decommissioning status of the device.

error is the error that caused status to become DECOMMISSIONING_STATUS_FAILURE.

status_message contains information on the status of the decommissioning attempt,

if any. This is generally an unstructured log message that is for display

purposes only (its structure and contents may change).

key identifies the request to decommission the device.

device_id is the unique device ID that was discovered via onboarding.

force is a flag that indicates if the decommission is to be forced.

Normally, if there are pending or in-progress tasks associated with the device

the decommission would fail. In case of a forced decommission, such blocking

tasks would be ignored and decommissioning will be continued.

device_id is the unique identifier of the device.

key identifies the request for which to retrieve an onboarding status.

device_id is the unique device ID that is discovered via onboarding.

status describes the onboarding status of the device.

error is the error that caused status to become ONBOARDING_STATUS_FAILURE.

status_message contains information on the status of the onboarding attempt,

if any. This is generally an unstructured log message that is for display

purposes only (its structure and contents may change).

key identifies the request to onboard the device at hostname_or_ip.

hostname_or_ip is a hostname or an IP at which the device can be reached.

device_type describes the method by which to retrieve information for the

device. The value should be “eos” for eos devices. For third-party devices,

supported values are: “openconfig”, “snmp”, “cvp”, “mwm”, and “vCenter”.

device_config is the configuration for a third-party device.

feature_enabled is a map of feature name to enabled status.

If a feature is missing from this map it can be assumed off.

key uniquely identifies the device.

status describes the onboarded device’s provisioning status.

error is the error that caused status to become PROVISIONING_STATUS_FAILURE.

ztp_mode indicates whether the device is in ZTP mode.

ip_address is the current (post-provisioning) IP address of the device.

provisioning_group_name is the name of the group (also known as a container)

to which the device belongs. Any provisioning operation performed on this

group will also be performed on this device. If the device is not yet provisioned,

this will not be set. Once it is provisioned, this will be set to “undefined_container”

which indicates that the device does not yet belong to a group. At this point,

a user may set it to an existing group.

request_id should be a UUID for the request.

DECOMMISSIONING_STATUS_IN_PROGRESS indicates decommissioning is in progress.

DECOMMISSIONING_STATUS_FAILURE indicates decommissioning failed.

DECOMMISSIONING_STATUS_SUCCESS indicates decommissioning succeeded.

ONBOARDING_STATUS_IN_PROGRESS indicates onboarding is in progress.

ONBOARDING_STATUS_FAILURE indicates onboarding failed.

ONBOARDING_STATUS_SUCCESS indicates onboarding succeeded.

PROVISIONING_STATUS_IN_PROGRESS indicates provisioning is in progress.

PROVISIONING_STATUS_FAILURE indicates provisioning failed.

PROVISIONING_STATUS_SUCCESS indicates provisioning succeeded.

STREAMING_STATUS_INACTIVE indicates the device is not streaming telemetry.

STREAMING_STATUS_ACTIVE indicates the device is streaming telemetry.

This describes the class of delete error.

This indicates the error message from the delete failure.

This is the key of the DeviceDecommissioningConfig instance that failed to be deleted.

Time indicates the (UTC) timestamp when the key was being deleted.

Key indicates which DeviceDecommissioningConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted DeviceDecommissioningConfig instance.

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

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

DeviceDecommissioningConfig instance in this response.

DeviceDecommissioningConfig carries the value to set into the datastore.

See the documentation on the DeviceDecommissioningConfig struct for which fields are required.

Value carries all the values given in the DeviceDecommissioningConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

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

Operation indicates how the DeviceDecommissioningConfig 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 DeviceDecommissioning 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

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

Operation indicates how the DeviceDecommissioning 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.

This describes the class of delete error.

This indicates the error message from the delete failure.

This is the key of the DeviceOnboardingConfig instance that failed to be deleted.

Time indicates the (UTC) timestamp when the key was being deleted.

Key indicates which DeviceOnboardingConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted DeviceOnboardingConfig instance.

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

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

DeviceOnboardingConfig instance in this response.

DeviceOnboardingConfig carries the value to set into the datastore.

See the documentation on the DeviceOnboardingConfig struct for which fields are required.

Value carries all the values given in the DeviceOnboardingConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

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

Operation indicates how the DeviceOnboardingConfig 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 DeviceOnboarding 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

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

Operation indicates how the DeviceOnboarding 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 Device 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

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

Operation indicates how the Device 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 ProvisionedDevice 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

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

Operation indicates how the ProvisionedDevice 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.