Telemetry

Streaming telemetry configuration manages destination groups, sensor groups, and subscriptions on NX-OS devices. Destination groups define remote collectors (address, port, protocol, encoding). Sensor groups specify monitored data paths with optional filtering and depth. Subscriptions link sensor groups to destination groups with configurable sample intervals.

Diagram

Classes

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
telemetry	Class	[telemetry]	No

telemetry (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
batch_dme_events	Boolean	true, false	No
merge_subscriptions	Boolean	true, false	No
destination_profile_use_vrf	String		No
destination_groups	List	[destination_groups]	No
sensor_groups	List	[sensor_groups]	No
subscriptions	List	[subscriptions]	No

destination_groups (nxos.devices.configuration.telemetry)

Name	Type	Constraint	Mandatory	Default Value
id	Any	Integer or String or String[Regex: ^.*[\$\%]\{.*$]	Yes
destinations	List	[destinations]	No

sensor_groups (nxos.devices.configuration.telemetry)

Name	Type	Constraint	Mandatory	Default Value
id	Any	Integer or String or String[Regex: ^.*[\$\%]\{.*$]	Yes
data_source	Choice	DME, NX-API, YANG, NATIVE, DEFAULT	No
sensor_paths	List	[sensor_paths]	No

subscriptions (nxos.devices.configuration.telemetry)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: 1, max: 4095	Yes
sensor_groups	List	[sensor_groups]	No
destination_groups	List	Any[Integer or String]	No

destinations (nxos.devices.configuration.telemetry.destination_groups)

Name	Type	Constraint	Mandatory	Default Value
ip_address	IP		Yes
port	Integer	min: 0, max: 65535	Yes
protocol	Choice	UDP, gRPC, HTTP	No
encoding	Choice	GPB, JSON, GPB-compact, Form-data	No
node_id	String		No

sensor_paths (nxos.devices.configuration.telemetry.sensor_groups)

Name	Type	Constraint	Mandatory	Default Value
path	String		Yes
alias	String		No
depth	Integer	min: 0, max: 4294967295	No
filter_condition	String		No
query_condition	String		No

Examples

Example 1: Basic telemetry with gRPC destination and DME sensor path

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          telemetry: true
        telemetry:
          destination_groups:
            - id: 1
              destinations:
                - ip_address: 10.0.0.100
                  port: 50051
                  protocol: gRPC
                  encoding: GPB
          sensor_groups:
            - id: 1
              data_source: DME
              sensor_paths:
                - path: sys/intf
                  depth: 0
          subscriptions:
            - id: 1
              sensor_groups:
                - id: 1
                  sample_interval: 30000
              destination_groups:
                - 1

Example 2: Telemetry with destination profile VRF and multiple sensor paths

nxos:
  devices:
    - name: SPINE1
      configuration:
        feature:
          telemetry: true
        telemetry:
          batch_dme_events: false
          merge_subscriptions: true
          destination_profile_use_vrf: management
          destination_groups:
            - id: 100
              destinations:
                - ip_address: 192.168.1.10
                  port: 50051
                  protocol: gRPC
                  encoding: GPB
                  node_id: spine1
                - ip_address: 192.168.1.11
                  port: 50051
                  protocol: gRPC
                  encoding: GPB
                  node_id: spine1-backup
          sensor_groups:
            - id: 100
              data_source: DME
              sensor_paths:
                - path: sys/intf
                  depth: 1
                  filter_condition: "gt(operBitrate,0)"
                  alias: interfaces
                - path: sys/bgp
                  depth: 0
                  alias: bgp-status
            - id: 200
              data_source: NX-API
              sensor_paths:
                - path: "show ip route summary"
          subscriptions:
            - id: 100
              sensor_groups:
                - id: 100
                  sample_interval: 5000
              destination_groups:
                - 100
            - id: 200
              sensor_groups:
                - id: 200
                  sample_interval: 60000
              destination_groups:
                - 100