gNMI Streaming Commands

nv show system gnmi-server

	nv show system gnmi-server Displays the gNMI server configured state, actual state, and version.
Syntax Description	N/A
Default	N/A
History	25.02.2002
Example	`admin@nvos:~$ nv show system gnmi-server operational applied ----------- ----------- ----------- state enabled enabled certificate self-signed self-signed is-running yes version 4.12.0-PS`
REST API	GET https://<ip>/nvue_v1/system/gnmi-server
Related Commands	nv set system gnmi-server state disabled

nv show system gnmi-server mtls

	nv show system gnmi-server mtls Return mTLS state information.
Syntax Description	N/A
Default	N/A
History	25.02.4002
Example	`admin@nvos:~$ nv show system gnmi-server mtls operational applied -------------- ----------- --------- ca-certificate ca_client ca_client`
REST API	GET https://<ip>/nvue_v1/system/gnmi-server/mtls
Related Commands	nv show system gnmi-server
Notes

nv set/unset system gnmi-server state

	nv set system gnmi-server state <enabled \| disabled> nv unset system gnmi-server state Sets gNMI server state. The unset form of the command returns the gNMI server state back to its default.
Syntax Description	N/A
Default	N/A
History	25.02.2002
Example	`admin@nvos:~$ nv set system gnmi-server state disabled` `admin@nvos:~$ nv unset system gnmi-server state`
REST API	PATCH https://<ip>/nvue_v1/system/gnmi-server DELETE https://<ip>/nvue_v1/system/gnmi-server
Related Commands	nv unset system gnmi-server state

nv set system gnmi-server certificate

	nv set system gnmi-server certificate {cert id} Set CA certificate for API mTLS connection.
Syntax Description	certificate	Certificate ID string
Default	self-signed
History	25.02.2002
Example	`admin@nvos:~$ nv set sys gnmi-server certificate cert_id`
REST API	PATCH https://<ip>/nvue_v1/system/gnmi-server/certificate?rev= Content-Type: application/json {"certificate": "cert_id"}
Related Commands
Notes

nv set system gnmi-server mtls ca-certificate

	nv set system gnmi-server mtls ca-certificate <cacert-id> gnmi-server security mTLS information
Syntax Description	cacert-id	CA certificates [id] for validation of client during mTLS (string)
Default	N/A
History	25.02.4002
Example	`admin@nvos:~$ nv set system gnmi-server mtls ca-certificate ca_client`
REST API	PATCH https://<ip>/nvue_v1/system/gnmi-server/mtls/ca-certificate/<arg>
Related Commands	nv show system gnmi-server mtls
Notes

gNMI Subscriptions

nv show system gnmi-server status

	nv show system gnmi-server status Show the operational state of the gnmi-server.
Syntax Description	N/A
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv show system gnmi-server status operational ------------------------------ ----------- total-active-subscriptions 2 received-subscription-requests 3 rejected-subscriptions 0 received-capabilities-requests 0 [client] 1 [client]`
REST API	GET https://<ip>/nvue_v1/system/gnmi-server/status
Related Commands	nv show system gnmi-server status client
Notes

nv show system gnmi-server status client

	nv show system gnmi-server status client [client-number] Show operational state for a single client connected to the gnmi-server. When no client is specified, the command shows operational state for all gnmi clients connected to the gnmi-server.
Syntax Description	N/A
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv show system gnmi-server status client client-id active-subscriptions client-address client-port type --------- -------------------- -------------- ----------- -------- 1 1 192.168.200.6 41614 dial-in 2 1 192.168.200.6 50051 dial-out` `admin@nvos:~$ nv show system gnmi-server status client 1 operational -------------------- ------------- Client-address 192.168.200.6 Client-port 55152 Type dial-in active-subscriptions 1`
REST API	GET https://<ip>/nvue_v1/system/gnmi-server/status/client
Related Commands	nv show system gnmi-server status
Notes

nv clear system gnmi-server status

	nv clear system gnmi-server status Clear the counters held in the gnmi server operational state.
Syntax Description	N/A
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv clear system gnmi-server status`
REST API	DELETE https://<ip>/nvue_v1/system/gnmi-server/status
Related Commands	nv show system gnmi-server status nv show system gnmi-server status client
Notes	The `clear` command resets the following counters to zero:received-subscription-requestsrejected-subscriptionsreceived-capabilities-requests The following values are not affected by the `clear` command, as they change dynamically over time:total-active-subscriptionsClient-related metrics A `clear` command is not supported for `status client`, since there is no persistent state to reset For additional details on behavior and interactions with the gNMI agent, refer to the specification

gRPC Tunnel (gNMI Dial-out)

nv show system grpc-tunnel

	nv show system grpc-tunnel Displays all configured gRPC tunnel servers and their operational status.
Syntax Description	N/A
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv show system grpc-tunnel operational applied -------- ----------- --------- [server] my-server my-server [server] SERVER1 SERVER1`
REST API	GET https://<ip>/nvue_v1/system/grpc-tunnel
Related Commands
Notes

nv show system grpc-tunnel server

	nv show system grpc-tunnel server Displays all configured tunnel servers with configuration and connection status.
Syntax Description	N/A
Default	N/A
History	25.02.8008
Example	admin@nvos:~$ nv show system grpc-tunnel server Address ca-certificate Certificate Port Retry Interval State status.connection.established status.connection.register status.connection.tunnel status.local-address status.local-port status.remote-address status.remote-port Target Name Target Type --------- ----------- -------------- ----------- ----- -------------- -------- ----------------------------- -------------------------- ------------------------ -------------------- ----------------- --------------------- ------------------ ----------- ----------- my-server 10.10.10.10 56001 60 enabled 2026-03-16T18:14:06.824000Z yes yes 10.220.12.118 42036 10.10.10.10 1234 nvos1 gnmi-gnoi SERVER1 10.1.1.10 443 40 disabled 1970-01-01T00:00:00Z no no None 0 None 0 TARGET1 gnmi-gnoi
REST API	GET https://<ip>/nvue_v1/system/grpc-tunnel/server
Related Commands
Notes

nv show system grpc-tunnel server

	nv show system grpc-tunnel server <server-name-id> Displays detailed configuration and operational state for a specific gRPC tunnel server.
Syntax Description	server-name-id	Unique identifier of the tunnel server
Default	N/A
History	25.02.8008
Example	admin@nvos:~$ nv show system grpc-tunnel server my-server operational applied ---------------- --------------------------- ----------- state enabled enabled address 10.10.10.10 10.10.10.10 port 56001 56001 target-name nvos1 nvos1 target-type gnmi-gnoi gnmi-gnoi retry-interval 60 60 status local-address 10.220.12.118 local-port 42036 remote-address 10.10.10.10 remote-port 1234 connection established 2026-03-16T18:14:06.824000Z register yes tunnel yes
REST API	GET https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes

nv show system grpc-tunnel server status

	nv show system grpc-tunnel server <server-name-id> status Displays operational status including local and remote connection details.
Syntax Description	server-name-id	Unique identifier of the tunnel server
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv show system grpc-tunnel server my-server status operational -------------- --------------------------- local-address 10.220.12.118 local-port 42036 remote-address 10.10.10.10 remote-port 1234 connection established 2026-03-16T18:14:06.824000Z register yes tunnel yes`
REST API	GET https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}/status
Related Commands
Notes

nv show system grpc-tunnel server status connection

	nv show system grpc-tunnel server <server-name-id> status connection Displays connection-specific details such as registration and tunnel state.
Syntax Description	server-name-id	Unique identifier of the tunnel server
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv show system grpc-tunnel server my-server status connection operational ----------- --------------------------- established 2026-03-16T18:14:06.824000Z register yes tunnel yes`
REST API	GET https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}/status/connection
Related Commands
Notes

nv unset system grpc-tunnel

	nv unset system grpc-tunnel Remove all gRPC tunnel configuration including all servers and associated settings.
Syntax Description	N/A
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv unset system grpc-tunnel admin@nvos:~$ nv config apply`
REST API	DELETE https://<ip>/nvue_v1/system/grpc-tunnel
Related Commands
Notes	This operation removes all configured tunnel servers and stops all associated tunnel services.

nv unset system grpc-tunnel server

	nv unset system grpc-tunnel server Remove all configured gRPC tunnel servers while clearing associated server configurations.
Syntax Description	N/A
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv unset system grpc-tunnel server admin@nvos:~$ nv config apply`
REST API	DELETE https://<ip>/nvue_v1/system/grpc-tunnel/server
Related Commands
Notes	All tunnel server instances will be removed and corresponding services will be stopped.

nv set/unset system grpc-tunnel server

	nv set system grpc-tunnel server <server-name-id> nv unset system grpc-tunnel server <server-name-id> Add new gRPC tunnel server. The unset form of the command removed the gRPC tunnel server.
Syntax Description	server-name-id	Unique identifier of the tunnel server
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv set system grpc-tunnel server my-server`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes	All tunnel server instances will be removed and corresponding services will be stopped.

nv set/unset system grpc-tunnel server address

	nv set system grpc-tunnel server <server-name-id> address <address> nv unset system grpc-tunnel server <server-name-id> address Set IP address or hostname of the gRPC server. The unset form of the command deletes the IP address or hostname.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	address	Remote tunnel server IP or hostname
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv set system grpc-tunnel server my-server address 10.10.10.10`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes

nv set/unset system grpc-tunnel server port

	nv set system grpc-tunnel server <server-name-id> port <port> nv unset system grpc-tunnel server <server-name-id> port Set the port of the gRPC server. The unset form of the command deletes the port.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	port	TCP port (1–65535)
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv set system grpc-tunnel server my-server port 56001`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes

nv set/unset system grpc-tunnel server target-name

	nv set system grpc-tunnel server <server-name-id> target-name <target-name> nv unset system grpc-tunnel server <server-name-id> target-name Set the target name of the gRPC server. The unset form of the command deletes the target name.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	target-name	Device identity used for registration (e.g., nvos1)
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv set system grpc-tunnel server my-server target-name nvos1`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes

nv set/unset system grpc-tunnel server target-type

	nv set system grpc-tunnel server <server-name-id> target-type <target-type> nv unset system grpc-tunnel server <server-name-id> target-type Set the target type of the gRPC server. The unset form of the command deletes the target type.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	target-type	enum: gnmi-gnoi (only supported value)
Default	N/A
History	25.02.8008
Example	`admin@nvos:~$ nv set system grpc-tunnel server my-server target-type gnmi-gnoi`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes

nv set/unset system grpc-tunnel server state

	nv set system grpc-tunnel server <server-name-id> state <state> nv unset system grpc-tunnel server <server-name-id> state Set the state of the gRPC server. The unset form of the command returns the state of the gRPC server to default.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	state	enable \| disable: Enable or disable tunnel
Default	Enable
History	25.02.8008
Example	`admin@nvos:~$ nv set system grpc-tunnel server my-server state enabled`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes

nv set/unset system grpc-tunnel server retry-interval

	nv set system grpc-tunnel server <server-name-id> retry-interval <retry-interval> nv unset system grpc-tunnel server <server-name-id> retry-interval Set the retry-interval of the gRPC server. The unset form of the command returns the retry-interval of the gRPC server to default.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	retry-interval	Reconnect interval (10–300 sec)
Default	60
History	25.02.8008
Example	`admin@nvos:~$ nv set system grpc-tunnel server my-server retry-interval 60`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes

nv set/unset system grpc-tunnel server certificate

	nv set system grpc-tunnel server <server-name-id> certificate <certificate-id> nv unset system grpc-tunnel server <server-name-id> certificate Set the certificate of the gRPC server. The unset form of the command deletes the certificate.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	certificate-id	Client TLS certificate ID from NVOS certificate store
Default	N/A
History	25.02.8008
Example	`admin@nvos:~nv set system grpc-tunnel server my-server certificate my-client-cert admin@nvos:~nv config apply`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes	Certificate must exist in NVOS certificate store before applying configuration.

nv set/unset system grpc-tunnel server ca-certificate

	nv set system grpc-tunnel server <server-name-id> ca-certificate <ca-certificate-id> nv unset system grpc-tunnel server <server-name-id> ca-certificate Set the CA certificate of the gRPC server. The unset form of the command deletes the CA certificate.
Syntax Description	server-name-id	Unique identifier of the tunnel server
	ca-certificate-id	CA certificate ID used to validate remote server certificate
Default	N/A
History	25.02.8008
Example	`admin@nvos:~nv set system grpc-tunnel server my-server ca-certificate my-ca-cert admin@nvos:~nv config apply`
REST API	PATCH https://<ip>/nvue_v1/system/grpc-tunnel/server/{server-name-id}
Related Commands
Notes	CA certificate must be valid and present in NVOS certificate store.

Last updated: June 01, 2026