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. Dial-out transport options (compression, source interface, VRF, retry buffer, gRPC deadline, chunking, maximum message size and TLS certificates) can be set globally in the destination profile or per destination group.

Diagram

Classes

nxos

Name	Type	Constraint	Mandatory
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No
templates	List	templates	No

devices (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

templates (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
telemetry	Class	telemetry	No

telemetry (nxos.devices.configuration)

Name	Type	Constraint	Mandatory
batch_dme_events	Boolean	`true`, `false`	No
merge_subscriptions	Boolean	`true`, `false`	No
certificate_filename	String		No
certificate_hostname	String		No
certificate_trustpoint	String		No
destination_profile_use_vrf	String		No
destination_profile_use_compression	Choice	`gzip`	No
destination_profile_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
destination_profile_source_interface_id	Any	String or Integer[min: `0`]	No
destination_profile_use_retry_size	Integer	min: `10`, max: `1500`	No
destination_profile_use_nodeid	String		No
destination_profile_grpc_deadline	Integer	min: `30`, max: `120`	No
destination_groups	List	destination_groups	No
sensor_groups	List	sensor_groups	No
subscriptions	List	subscriptions	No

telemetry (nxos.devices.configuration)

Name	Type	Constraint	Mandatory
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
id	Any	Integer or String or String[Regex: `^.[\$\%]\{.$`]	Yes
certificate_filename	String		No
certificate_hostname	String		No
use_vrf	String		No
use_compression	Choice	`gzip`	No
source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
source_interface_id	Any	String or Integer[min: `0`]	No
use_chunking_size	Integer	min: `64`, max: `4096`	No
message_max_size	Integer	min: `12288`, max: `32768`	No
destinations	List	destinations	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
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
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
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
path	String		Yes
alias	String		No
depth	Integer	min: `0`, max: `4294967295`	No
filter_condition	String		No
query_condition	String		No

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

Name	Type	Constraint	Mandatory	Default Value
id	Any	Integer or String or String[Regex: `^.[\$\%]\{.$`]	Yes
sample_interval	Integer	min: `0`, max: `604800000`	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

Example 3: Telemetry dial-out options in the destination profile and per destination group

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          telemetry: true
        telemetry:
          certificate_trustpoint: TELEMETRY-TP
          certificate_hostname: collector.example.com
          destination_profile_use_compression: gzip
          destination_profile_source_interface_type: loopback
          destination_profile_source_interface_id: 0
          destination_profile_use_retry_size: 100
          destination_profile_use_nodeid: leaf1
          destination_profile_grpc_deadline: 60
          destination_groups:
            - id: 1
              certificate_filename: /bootflash/collector.pem
              certificate_hostname: collector.example.com
              use_vrf: default
              use_compression: gzip
              source_interface_type: loopback
              source_interface_id: 0
              use_chunking_size: 128
              message_max_size: 16384
              destinations:
                - ip_address: 10.0.0.100
                  port: 50051
                  protocol: gRPC
                  encoding: GPB

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