Data model which creates the configuration for the telemetry systems and functions on the device.
openconfig-inet-types
openconfig-extensions
openconfig-telemetry-types
description:
Top level configuration and state for the
device's telemetry system.
nodetype: container (rw)
description:
Top level container for sensor-groups.
nodetype: container (rw)
description:
List of telemetry sensory groups on the local
system, where a sensor grouping represents a resuable
grouping of multiple paths and exclude filters.
nodetype: list (rw)
list keys: [sensor-group-id]
description:
Reference to the name or identifier of the
sensor grouping
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration parameters relating to the
telemetry sensor grouping
nodetype: container (rw)
description:
Name or identifier for the sensor group itself.
Will be referenced by other configuration specifying a
sensor group
nodetype: leaf (rw)
type: string
description:
State information relating to the telemetry
sensor group
nodetype: container (ro)
description:
Name or identifier for the sensor group itself.
Will be referenced by other configuration specifying a
sensor group
nodetype: leaf (ro)
type: string
description:
Top level container to hold a set of sensor
paths grouped together
nodetype: container (rw)
description:
List of paths in the model which together
comprise a sensor grouping. Filters for each path
to exclude items are also provided.
nodetype: list (rw)
list keys: [path]
description:
Reference to the path of interest
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration parameters to configure a set
of data model paths as a sensor grouping
nodetype: container (rw)
description:
Path to a section of operational state of interest
(the sensor).
nodetype: leaf (rw)
type: string
description:
Filter to exclude certain values out of the state
values
nodetype: leaf (rw)
type: string
description:
Configuration parameters to configure a set
of data model paths as a sensor grouping
nodetype: container (ro)
description:
Path to a section of operational state of interest
(the sensor).
nodetype: leaf (ro)
type: string
description:
Filter to exclude certain values out of the state
values
nodetype: leaf (ro)
type: string
description:
Top level container for destination group configuration
and state.
nodetype: container (rw)
description:
List of destination-groups. Destination groups allow the
reuse of common telemetry destinations across the
telemetry configuration. An operator references a
set of destinations via the configurable
destination-group-identifier.
A destination group may contain one or more telemetry
destinations
nodetype: list (rw)
list keys: [group-id]
description:
Unique identifier for the destination group
nodetype: leaf (list key) (rw)
type: leafref
description:
Top level config container for destination groups
nodetype: container (rw)
description:
Unique identifier for the destination group
nodetype: leaf (rw)
type: string
description:
Top level state container for destination groups
nodetype: container (ro)
description:
Unique identifier for destination group
nodetype: leaf (ro)
type: string
description:
The destination container lists the destination
information such as IP address and port of the
telemetry messages from the network element.
nodetype: container (rw)
description:
List of telemetry stream destinations
nodetype: list (rw)
list keys: [destination-address] [destination-port]
description:
Reference to the destination address of the
telemetry stream
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to the port number of the stream
destination
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration parameters relating to
telemetry destinations
nodetype: container (rw)
description:
IP address of the telemetry stream destination
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Protocol (udp or tcp) port number for the telemetry
stream destination
nodetype: leaf (rw)
type: uint16
description:
State information associated with
telemetry destinations
nodetype: container (ro)
description:
IP address of the telemetry stream destination
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Protocol (udp or tcp) port number for the telemetry
stream destination
nodetype: leaf (ro)
type: uint16
description:
This container holds information for both persistent
and dynamic telemetry subscriptions.
nodetype: container (rw)
description:
This container holds information relating to persistent
telemetry subscriptions. A persistent telemetry
subscription is configued locally on the device through
configuration, and is persistent across device restarts or
other redundancy changes.
nodetype: container (rw)
description:
List of telemetry subscriptions. A telemetry
subscription consists of a set of collection
destinations, stream attributes, and associated paths to
state information in the model (sensor data)
nodetype: list (rw)
list keys: [name]
description:
Reference to the identifier of the subscription
itself. The id will be the handle to refer to the
subscription once created
nodetype: leaf (list key) (rw)
type: leafref
description:
Config parameters relating to the telemetry
subscriptions on the local device
nodetype: container (rw)
description:
User configured identifier of the telemetry
subscription. This value is used primarily for
subscriptions configured locally on the network
element.
nodetype: leaf (rw)
type: string
description:
The IP address which will be the source of packets from
the device to a telemetry collector destination.
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
DSCP marking of packets generated by the telemetry
subsystem on the network device.
nodetype: leaf (rw)
type: oc-inet:dscp
description:
Selection of the transport protocol for the telemetry
stream.
nodetype: leaf (rw)
type: identityref
description:
Selection of the specific encoding or RPC framework
for telemetry messages to and from the network element.
nodetype: leaf (rw)
type: identityref
description:
State parameters relating to the telemetry
subscriptions on the local device
nodetype: container (ro)
description:
User configured identifier of the telemetry
subscription. This value is used primarily for
subscriptions configured locally on the network
element.
nodetype: leaf (ro)
type: string
description:
System generated identifer of the telemetry
subscription.
nodetype: leaf (ro)
type: uint64
description:
The IP address which will be the source of packets from
the device to a telemetry collector destination.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
DSCP marking of packets generated by the telemetry
subsystem on the network device.
nodetype: leaf (ro)
type: oc-inet:dscp
description:
Selection of the transport protocol for the telemetry
stream.
nodetype: leaf (ro)
type: identityref
description:
Selection of the specific encoding or RPC framework
for telemetry messages to and from the network element.
nodetype: leaf (ro)
type: identityref
description:
A sensor profile is a set of sensor groups or
individual sensor paths which are associated with a
telemetry subscription. This is the source of the
telemetry data for the subscription to send to the
defined collectors.
nodetype: container (rw)
description:
List of telemetry sensor groups used
in the subscription
nodetype: list (rw)
list keys: [sensor-group]
description:
Reference to the telemetry sensor group name
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration parameters related to the sensor
profile for a subscription
nodetype: container (rw)
description:
Reference to the sensor group which is used in the profile
nodetype: leaf (rw)
type: leafref
description:
Time in milliseconds between the device's sample of a
telemetry data source. For example, setting this to 100
would require the local device to collect the telemetry
data every 100 milliseconds. There can be latency or jitter
in transmitting the data, but the sample must occur at
the specified interval.
The timestamp must reflect the actual time when the data
was sampled, not simply the previous sample timestamp +
sample-interval.
If sample-interval is set to 0, the telemetry sensor
becomes event based. The sensor must then emit data upon
every change of the underlying data source.
nodetype: leaf (rw)
type: uint64
description:
Maximum time interval in seconds that may pass
between updates from a device to a telemetry collector.
If this interval expires, but there is no updated data to
send (such as if suppress_updates has been configured), the
device must send a telemetry message to the collector.
nodetype: leaf (rw)
type: uint64
description:
Boolean flag to control suppression of redundant
telemetry updates to the collector platform. If this flag is
set to TRUE, then the collector will only send an update at
the configured interval if a subscribed data value has
changed. Otherwise, the device will not send an update to
the collector until expiration of the heartbeat interval.
nodetype: leaf (rw)
type: boolean
description:
State information relating to the sensor profile
for a subscription
nodetype: container (ro)
description:
Reference to the sensor group which is used in the profile
nodetype: leaf (ro)
type: leafref
description:
Time in milliseconds between the device's sample of a
telemetry data source. For example, setting this to 100
would require the local device to collect the telemetry
data every 100 milliseconds. There can be latency or jitter
in transmitting the data, but the sample must occur at
the specified interval.
The timestamp must reflect the actual time when the data
was sampled, not simply the previous sample timestamp +
sample-interval.
If sample-interval is set to 0, the telemetry sensor
becomes event based. The sensor must then emit data upon
every change of the underlying data source.
nodetype: leaf (ro)
type: uint64
description:
Maximum time interval in seconds that may pass
between updates from a device to a telemetry collector.
If this interval expires, but there is no updated data to
send (such as if suppress_updates has been configured), the
device must send a telemetry message to the collector.
nodetype: leaf (ro)
type: uint64
description:
Boolean flag to control suppression of redundant
telemetry updates to the collector platform. If this flag is
set to TRUE, then the collector will only send an update at
the configured interval if a subscribed data value has
changed. Otherwise, the device will not send an update to
the collector until expiration of the heartbeat interval.
nodetype: leaf (ro)
type: boolean
description:
A subscription may specify destination addresses.
If the subscription supplies destination addresses,
the network element will be the initiator of the
telemetry streaming, sending it to the destination(s)
specified.
If the destination set is omitted, the subscription
preconfigures certain elements such as paths and
sample intervals under a specified subscription ID.
In this case, the network element will NOT initiate an
outbound connection for telemetry, but will wait for
an inbound connection from a network management
system.
It is expected that the network management system
connecting to the network element will reference
the preconfigured subscription ID when initiating
a subscription.
nodetype: container (rw)
description:
Identifier of the previously defined destination
group
nodetype: list (rw)
list keys: [group-id]
description:
The destination group id references a configured
group of destinations for the telemetry stream.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration parameters related to telemetry
destinations.
nodetype: container (rw)
description:
The destination group id references a reusable
group of destination addresses and ports for
the telemetry stream.
nodetype: leaf (rw)
type: leafref
description:
State information related to telemetry
destinations
nodetype: container (ro)
description:
The destination group id references a reusable
group of destination addresses and ports for
the telemetry stream.
nodetype: leaf (ro)
type: leafref
description:
This container holds information relating to dynamic
telemetry subscriptions. A dynamic subscription is
typically configured through an RPC channel, and does not
persist across device restarts, or if the RPC channel is
reset or otherwise torn down.
nodetype: container (rw)
description:
List representation of telemetry subscriptions that
are configured via an inline RPC, otherwise known
as dynamic telemetry subscriptions.
nodetype: list (ro)
list keys: [id]
description:
Reference to the identifier of the subscription
itself. The id will be the handle to refer to the
subscription once created
nodetype: leaf (list key) (ro)
type: leafref
description:
State information relating to dynamic telemetry
subscriptions.
nodetype: container (ro)
description:
System generated identifer of the telemetry
subscription.
nodetype: leaf (ro)
type: uint64
description:
IP address of the telemetry stream destination
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Protocol (udp or tcp) port number for the telemetry
stream destination
nodetype: leaf (ro)
type: uint16
description:
Time in milliseconds between the device's sample of a
telemetry data source. For example, setting this to 100
would require the local device to collect the telemetry
data every 100 milliseconds. There can be latency or jitter
in transmitting the data, but the sample must occur at
the specified interval.
The timestamp must reflect the actual time when the data
was sampled, not simply the previous sample timestamp +
sample-interval.
If sample-interval is set to 0, the telemetry sensor
becomes event based. The sensor must then emit data upon
every change of the underlying data source.
nodetype: leaf (ro)
type: uint64
description:
Maximum time interval in seconds that may pass
between updates from a device to a telemetry collector.
If this interval expires, but there is no updated data to
send (such as if suppress_updates has been configured), the
device must send a telemetry message to the collector.
nodetype: leaf (ro)
type: uint64
description:
Boolean flag to control suppression of redundant
telemetry updates to the collector platform. If this flag is
set to TRUE, then the collector will only send an update at
the configured interval if a subscribed data value has
changed. Otherwise, the device will not send an update to
the collector until expiration of the heartbeat interval.
nodetype: leaf (ro)
type: boolean
description:
DSCP marking of packets generated by the telemetry
subsystem on the network device.
nodetype: leaf (ro)
type: oc-inet:dscp
description:
Selection of the transport protocol for the telemetry
stream.
nodetype: leaf (ro)
type: identityref
description:
Selection of the specific encoding or RPC framework
for telemetry messages to and from the network element.
nodetype: leaf (ro)
type: identityref
description:
Top level container to hold a set of sensor
paths grouped together
nodetype: container (ro)
description:
List of paths in the model which together
comprise a sensor grouping. Filters for each path
to exclude items are also provided.
nodetype: list (ro)
list keys: [path]
description:
Reference to the path of interest
nodetype: leaf (list key) (ro)
type: leafref
description:
State information for a dynamic subscription's
paths of interest
nodetype: container (ro)
description:
Path to a section of operational state of interest
(the sensor).
nodetype: leaf (ro)
type: string
description:
Filter to exclude certain values out of the state
values
nodetype: leaf (ro)
type: string