tag.v2

key identifies a tag.

creator_type is the creator type of the tag.

key identifies an assignment.

tag_creator_type is the creator type of the tag

involved in the assignment.

key identifies an assignment. The special workspace ID “"

for merged assignments should not be set here.

remove indicates whether to remove (true) or add (false,

unset) the assignment identified by the key if the

encompassing workspace merges.

workspace_id is the ID of a workspace. The special ID “"

identifies the location where merged assignments reside.

element_type is the element type of a tag. What should

be set per element type:

ELEMENT_TYPE_DEVICE: device_id

ELEMENT_TYPE_INTERFACE: device_id, interface_id

label is the label of a tag.

value is the value of a tag.

device_id identifies a device.

interface_id identifies an interface on a device.

element_sub_type is the element sub-type of a tag.

key identifies a tag. The special workspace ID "” for

merged tags should not be set here.

remove indicates whether to remove (true) or add (false,

unset) the tag identified by the key if the encompassing

workspace merges.

workspace_id is the ID of a workspace. The special ID “"

identifies the location where merged tags reside.

element_type is the category of network element to which

this tag can be assigned.

label is an arbitrary label.

value is an arbitrary value.

element_sub_type is the sub-category of network element

to which this tag can be assigned.

CREATOR_TYPE_UNSPECIFIED is the default value.

CREATOR_TYPE_SYSTEM is used for system tags.

CREATOR_TYPE_USER is used for user tags.

CREATOR_TYPE_EXTERNAL is used for tags created from external sources.

For E.g., vCenter

ELEMENT_SUB_TYPE_UNSPECIFIED is the default value.

ELEMENT_SUB_TYPE_DEVICE is used for EOS or

third-party devices discovered via LLDP/SNMP.

ELEMENT_SUB_TYPE_VDS is used for VMWare vSphere Distributed Switch (VDS) tags.

ELEMENT_SUB_TYPE_WORKLOAD_SERVER is used for workload server

tags (such as VMWare ESXi host).

A workload server is a server/data storage device on which

the hypervisor is installed.

ELEMENT_SUB_TYPE_VM is used for VM tags.

A VM is a software computer that, like a physical computer,

runs an operating system and applications.

ELEMENT_TYPE_UNSPECIFIED is the default value.

ELEMENT_TYPE_DEVICE is used for device tags.

ELEMENT_TYPE_INTERFACE is used for interface tags.

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.

This describes the class of delete error.

This indicates the error message from the delete failure.

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

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

Key indicates which TagAssignmentConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted TagAssignmentConfig 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 contains a list of TagAssignmentConfig keys to delete

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

TagAssignmentConfig instance in this response.

TagAssignmentConfig carries the value to set into the datastore.

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

Value carries all the values given in the TagAssignmentConfigSetRequest 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.

value contains a list of TagAssignmentConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

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 TagAssignmentConfig at end.

* Each TagAssignmentConfig response is fully-specified (all fields set).

* start: Returns the state of each TagAssignmentConfig at start, followed by updates until now.

* Each TagAssignmentConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each TagAssignmentConfig at start, followed by updates

until end.

* Each TagAssignmentConfig 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 TagAssignmentConfig’s last modification.

Operation indicates how the TagAssignmentConfig 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 TagAssignment 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

TagAssignment 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 TagAssignment at end.

* Each TagAssignment response is fully-specified (all fields set).

* start: Returns the state of each TagAssignment at start, followed by updates until now.

* Each TagAssignment response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each TagAssignment at start, followed by updates

until end.

* Each TagAssignment 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 TagAssignment’s last modification.

Operation indicates how the TagAssignment 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 TagConfig instance that failed to be deleted.

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

Key indicates which TagConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted TagConfig 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 contains a list of TagConfig keys to delete

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

TagConfig instance in this response.

TagConfig carries the value to set into the datastore.

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

Value carries all the values given in the TagConfigSetRequest 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.

value contains a list of TagConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

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 TagConfig at end.

* Each TagConfig response is fully-specified (all fields set).

* start: Returns the state of each TagConfig at start, followed by updates until now.

* Each TagConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each TagConfig at start, followed by updates

until end.

* Each TagConfig 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 TagConfig’s last modification.

Operation indicates how the TagConfig 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 Tag 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

Tag 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 Tag at end.

* Each Tag response is fully-specified (all fields set).

* start: Returns the state of each Tag at start, followed by updates until now.

* Each Tag response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Tag at start, followed by updates

until end.

* Each Tag 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 Tag’s last modification.

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