gRPC

gRPC configuration manages the gRPC agent on NX-OS devices, which provides the gNMI (gRPC Network Management Interface) service for model-driven configuration and streaming telemetry. Settings include the TLS certificate and client root certificate trustpoints, the listening port, the VRF used for gRPC communication, and gNMI tuning such as the maximum number of concurrent calls, the keepalive timeout and subscription behavior. The gRPC agent requires feature grpc; use feature openconfig to enable the OpenConfig YANG models.

Diagram

Classes

nxos

Name	Type	Constraint	Mandatory	Default Value
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
system	Class	system	No

system (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
grpc	Class	grpc	No

grpc (nxos.devices.configuration.system)

Name	Type	Constraint	Mandatory	Default Value
certificate	String		No
client_root_certificate	String		No
port	Integer	min: 1024, max: 65535	No
use_vrf	String		No
gnmi_keepalive_timeout	Integer	min: 600, max: 86400	No
gnmi_max_concurrent_calls	Integer	min: 1, max: 16	No
gnmi_subscription_filter_file	String		No
gnmi_subscription_filter_file_md5	String		No
gnmi_subscription_merge	Boolean	true, false	No
gnmi_subscription_query_condition	Choice	keep-data-timestamp	No
gnmi_subscription_target_defined_min_interval	Integer	min: 1, max: 65535	No

Examples

Example 1: gRPC agent with a custom port and TLS certificate

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          grpc: true
        system:
          grpc:
            certificate: grpc-trustpoint
            port: 50051
            use_vrf: default

Example 2: gRPC with mutual TLS and tuned gNMI subscriptions

nxos:
  devices:
    - name: SPINE1
      configuration:
        feature:
          grpc: true
          openconfig: true
        system:
          grpc:
            certificate: grpc-trustpoint
            client_root_certificate: grpc-root-trustpoint
            port: 50052
            use_vrf: default
            gnmi_max_concurrent_calls: 12
            gnmi_keepalive_timeout: 900
            gnmi_subscription_target_defined_min_interval: 20
            gnmi_subscription_query_condition: keep-data-timestamp
            gnmi_subscription_merge: true