Streaming Telemetry OpenConfig Data Models

Overview

Streaming telemetry incrementally supports all listed OpenConfig data models, providing standardized representations of network configurations and telemetry data.

Telemetry OpenConfig Pyang Tree

The Pyang tree output illustrates the supported containers or leaf, along with a list of supported container-level paths.

Container Level Sensor Paths and Leaf Attributes

Lists the container level sensor paths and leaf attributes supported for OpenConfig data models.

For details on wildcard support, refer to the Wildcard Support in Sensor Paths and XPath Formatting Rules for Streaming Telemetry sections.

OpenConfig-Platform

Copy 
  +--rw components
     +--rw component* [name]
        +--rw name                           -> ../config/name
        +--rw config
        |  +--rw name?   string
        +--ro state
        |  +--ro name?               string
        |  +--ro id?                 string
        |  x--ro location?           string
        |  +--ro description?        string
        |  +--ro mfg-name?           string
        |  +--ro mfg-date?           oc-yang:date
        |  +--ro hardware-version?   string
        |  +--ro firmware-version?   string
        |  +--ro software-version?   string
        |  +--ro serial-no?          string
        |  +--ro part-no?            string
        |  +--ro removable?          boolean
        |  +--ro oper-status?        identityref
        |  +--ro empty?              boolean
        |  +--ro parent?             -> ../../../component/config/name
        |  +--ro temperature
        |  |  +--ro instant?           decimal64
        |  |  +--ro avg?               decimal64
        |  |  +--ro min?               decimal64
        |  |  +--ro max?               decimal64
        |  |  +--ro interval?          oc-types:stat-interval
        |  |  +--ro alarm-status?      boolean
        |  |  +--ro alarm-threshold?   decimal64
        |  |  +--ro alarm-severity?    identityref
        |  +--ro memory
        |  |  +--ro available?   uint64
        |  |  +--ro utilized?    uint64
        |  +--ro allocated-power?    decimal64
        +--rw power-supply
        |  +--ro state
        |     +--ro oc-platform-psu:enabled?          boolean
        |     +--ro oc-platform-psu:capacity?         decimal64
        |     +--ro oc-platform-psu:input-current?    decimal64
        |     +--ro oc-platform-psu:input-voltage?    decimal64
        |     +--ro oc-platform-psu:output-current?   decimal64
        |     +--ro oc-platform-psu:output-voltage?   decimal64
        |     +--ro oc-platform-psu:output-power?     decimal64
        +--rw fan
        |  +--ro state
        |     +--ro oc-fan:speed?   uint32
        +--rw cpu
        |  +--rw oc-cpu:utilization
        |     +--ro oc-cpu:state
        |        +--ro oc-cpu:instant?    decimal64
        |        +--ro oc-cpu:avg?        decimal64
        |        +--ro oc-cpu:interval?   oc-types:stat-interval
        +--rw oc-transceiver:transceiver
        |  +--ro oc-transceiver:state
        |     +--ro oc-transceiver:module-functional-type?   identityref
        |     +--ro oc-transceiver:form-factor?              identityref
        |     +--ro oc-transceiver:connector-type?           identityref
        |     +--ro oc-transceiver:vendor?                   string
        |     +--ro oc-transceiver:vendor-part?              string
        |     +--ro oc-transceiver:vendor-rev?               string
        |     +--ro oc-transceiver:serial-no?                string
        |     +--ro oc-transceiver:date-code?                string
        |     +--ro oc-transceiver:supply-voltage
        |     |  +--ro oc-transceiver:instant?   decimal64
        |     +--ro oc-transceiver:output-power
        |     |  +--ro oc-transceiver:instant?   decimal64
        |     +--ro oc-transceiver:input-power
        |     |  +--ro oc-transceiver:instant?   decimal64
        |     +--ro oc-transceiver:laser-bias-current
        |        +--ro oc-transceiver:instant?   decimal64
        +--rw oc-opt-term:optical-channel
           +--ro oc-opt-term:state
              +--ro oc-opt-term:output-power
              |  +--ro oc-opt-term:instant?   decimal64
              +--ro oc-opt-term:input-power
              |  +--ro oc-opt-term:instant?   decimal64
              +--ro oc-opt-term:laser-bias-current
                 +--ro oc-opt-term:instant?   decimal64

The listed paths below represent telemetry OpenConfig paths for monitoring the platform state of various components, including CPU, RAM, power supply, fans, CMIS, and transceivers.

CPU

Copy 
Sensor Path
        /components/component[name]/cpu/utilization/state
 
Leaf Attributes
            /components/component[name]/cpu/utilization/state/avg
            /components/component[name]/cpu/utilization/state/instant
            /components/component[name]/cpu/utilization/state/interval

RAM

Copy 
Sensor Path
         /components/component[name]/state/memory/
 
Leaf Attributes
            /components/component[name]/state/memory/available
            /components/component[name]/state/memory/utilized

Power-Supply

Copy 
Sensor Path
         /components/component[name]/power-supply/state/
 
Leaf Attributes
            /components/component[name]/power-supply/state/capacity
            /components/component[name]/power-supply/state/output-power
            /components/component[name]/power-supply/state/input-voltage
            /components/component[name]/power-supply/state/input-current
            /components/component[name]/power-supply/state/output-voltage
            /components/component[name]/power-supply/state/output-current
            /components/component[name]/power-supply/state/enabled

Fan

Copy 
Sensor Path
        /components/component[name]/fan/state
 
Leaf Attributes
            /components/component[name]/fan/state/speed

Platform State

Copy 
Sensor Path
        /components/component[name]/state
 
Leaf Attributes
            /components/component[name]/state/id
            /components/component[name]/state/type
            /components/component[name]/state/location
            /components/component[name]/state/mfg-date
            /components/component[name]/state/description
            /components/component[name]/state/hardware-version
            /components/component[name]/state/firmware-version
            /components/component[name]/state/software-version
            /components/component[name]/state/serial-no
            /components/component[name]/state/part-no
            /components/component[name]/state/removable
            /components/component[name]/state/oper-status
            /components/component[name]/state/parent
            /components/component[name]/state/empty
Platform State: Memory
Copy 
Sensor Path
        /components/component[name]/state/memory
 
Leaf Attributes
            /components/component[name]/state/memory/available
            /components/component[name]/state/memory/utilized
Platform State: Temperature
Copy 
Sensor Path
        /components/component[name]/state/temperature
 
Leaf Attributes
            /components/component[name]/state/temperature/instant
            /components/component[name]/state/temperature/min
            /components/component[name]/state/temperature/max
            /components/component[name]/state/temperature/avg
            /components/component[name]/state/temperature/interval
            /components/component[name]/state/temperature/alarm-status
            /components/component[name]/state/temperature/alarm-threshold
            /components/component[name]/state/temperature/alarm-severity

CMIS State

Copy 
Sensor Paths: ipi-platform-cmisTransceiver EEPROM StateSensor Path
        openconfig:/components/component[name=CMIS-MODULE-NAME]/state
 
Leaf Attributes
             /components/component[name]/state/name
             /components/component[name]/state/type
             /components/component[name]/state/id
             /components/component[name]/state/description
             /components/component[name]/state/mfg-name
             /components/component[name]/state/mfg-date
             /components/component[name]/state/hardware-version
             /components/component[name]/state/firmware-version
             /components/component[name]/state/software-version
             /components/component[name]/state/serial-no
             /components/component[name]/state/part-no
             /components/component[name]/state/model-name
             /components/component[name]/state/clei-code
             /components/component[name]/state/removable
             /components/component[name]/state/oper-status
             /components/component[name]/state/empty
             /components/component[name]/state/parent
             /components/component[name]/state/last-poweroff-time
             

CMIS Temperature

Copy 
Sensor Paths: ipi-platform-cmisTransceiver EEPROM StateSensor Path
        openconfig:/components/component[name=CMIS-MODULE-NAME]/state/temperature
 
Leaf Attributes
             /components/component[name]/state/temperature/instant
             

CMIS Transceiver State

Copy 
Sensor Paths: ipi-platform-cmisTransceiver EEPROM StateSensor Path
        openconfig:/components/component[name=CMIS-MODULE-NAME]/transceiver/state
 
Leaf Attributes
             /components/component[name]/transceiver/state/form-factor
             /components/component[name]/transceiver/state/connector-type
             /components/component[name]/transceiver/state/vendor
             /components/component[name]/transceiver/state/vendor-part
             /components/component[name]/transceiver/state/vendor-rev
             /components/component[name]/transceiver/state/serial-no
             /components/component[name]/transceiver/state/date-code
             /components/component[name]/transceiver/state/module-functional-type
             /components/component[name]/transceiver/state/supply-voltage/instant
             

CMIS Optical Channel State

Copy 
Sensor Paths: ipi-platform-cmisTransceiver EEPROM StateSensor Path
        openconfig:/components/component[name='OCH-0/<CMIS-PORT>']/optical-channel/state
 
Leaf Attributes
             /components/component[name]/optical-channel/state/input-power/instant
             /components/component[name]/optical-channel/state/output-power/instant
             /components/component[name]/optical-channel/state/laser-bias-current/instant
             

OpenConfig-Interface

Copy 
 +--rw interfaces
     +--rw interface* [name]
        +--rw name      -> ../config/name
        +--rw config
        |  +--rw name?   string
        +--ro state
           +--ro name?           string
           +--ro ifindex?        uint32
           +--ro admin-status    enumeration
           +--ro oper-status     enumeration
           +--ro last-change?    oc-types:timeticks64
           +--ro logical?        boolean
           +--ro counters
              +--ro in-octets?            oc-yang:counter64
              +--ro in-pkts?              oc-yang:counter64
              +--ro in-unicast-pkts?      oc-yang:counter64
              +--ro in-broadcast-pkts?    oc-yang:counter64
              +--ro in-multicast-pkts?    oc-yang:counter64
              +--ro in-errors?            oc-yang:counter64
              +--ro in-discards?          oc-yang:counter64
              +--ro out-octets?           oc-yang:counter64
              +--ro out-pkts?             oc-yang:counter64
              +--ro out-unicast-pkts?     oc-yang:counter64
              +--ro out-broadcast-pkts?   oc-yang:counter64
              +--ro out-multicast-pkts?   oc-yang:counter64
              +--ro out-discards?         oc-yang:counter64
              +--ro out-errors?           oc-yang:counter64
              +--ro last-clear?           oc-types:timeticks64

The listed paths below represent telemetry OpenConfig paths for monitoring the interface and counters state.

Interface State

Copy 
Sensor Path
         /interfaces/interface[name]/state
 
Leaf Attributes
             /interfaces/interface[name]/state/name
             /interfaces/interface[name]/state/ifindex
             /interfaces/interface[name]/state/admin-status
             /interfaces/interface[name]/state/oper-status
             /interfaces/interface[name]/state/last-change
             /interfaces/interface[name]/state/logical

Counters State

Copy 
Sensor Path
         /interfaces/interface[name]/state/counters
 
Leaf Attributes
             /interfaces/interface[name]/state/counters/in-octets
             /interfaces/interface[name]/state/counters/in-pkts
             /interfaces/interface[name]/state/counters/in-unicast-pkts
             /interfaces/interface[name]/state/counters/in-broadcast-pkts
             /interfaces/interface[name]/state/counters/in-multicast-pkts
             /interfaces/interface[name]/state/counters/in-discards
             /interfaces/interface[name]/state/counters/in-errors
             /interfaces/interface[name]/state/counters/in-fcs-errors
             /interfaces/interface[name]/state/counters/out-octets
             /interfaces/interface[name]/state/counters/out-pkts
             /interfaces/interface[name]/state/counters/out-unicast-pkts
             /interfaces/interface[name]/state/counters/out-broadcast-pkts
             /interfaces/interface[name]/state/counters/out-multicast-pkts
             /interfaces/interface[name]/state/counters/out-discards
             /interfaces/interface[name]/state/counters/out-errors
             /interfaces/interface[name]/state/counters/last-clear