7.6. gRPC Show, Admin Command Reference

This section provides the gRPC show and admin command descriptions.

7.6.1. Command Hierarchies

  1. Show Commands
  2. Admin Commands

7.6.1.1. Show Commands

show
— system
— telemetry
— grpc
— subscription
— subscription subscription-id [paths]
show
— router
— sgt-qos
— application
— grpc
— dscp

7.6.1.2. Admin Commands

admin
— system
— telemetry
— grpc
— subscription subscription-id cancel
— subscription cancel-all
admin
— disconnect {grpc}

7.6.2. Command Descriptions

  1. Show Commands
  2. Admin Commands

7.6.2.1. Show Commands

grpc

Syntax 
grpc
Context 
show>system
Description 

This command displays the gRPC server status.

Output 

The following output displays gRPC server information.

Table 95 describes gRPC fields.

Sample Output
===============================================================================
gRPC Server
===============================================================================
Administrative State      : Disabled
Operational State         : Down
===============================================================================
Table 95:  Show System gRPC output Fields  

Labels

Description

gRPC Server

Administrative State

Enabled — Displays that gRPC is enabled.

Disabled — Displays that gRPC is disabled.

Operational State

Up — Displays that gRPC is operational.

Down — Displays that gRPC is not operational.

subscription

Syntax 
subscription subscription-id [paths]
subscription
Context 
show>system>telemetry>grpc
Description 

This command displays the active telemetry gRPC subscriptions.

Parameters 
subscription-id—
A unique subscription ID or number that is assigned by the SR OS gRPC server to each active telemetry subscription.
Output 

The following output describes the telemetry gRPC subscription fields.

Sample Output
# /show system telemetry grpc subscription 
===============================================================================
Telemetry gRPC subscriptions
===============================================================================
Subscription-id User                                                      Port
  Destination                                                                 
-------------------------------------------------------------------------------
2               admin                                                    54309
     192.168.110.252
3               admin                                                    54316
     192.168.110.252
-------------------------------------------------------------------------------
No. of gRPC Telemetry subscriptions: 2
===============================================================================
# /show system telemetry grpc subscription 2 
===============================================================================
Telemetry gRPC subscription
===============================================================================
Subscription-id       : 2
User                  : admin
Destination      : 192.168.110.252
Port                  : 54309
===============================================================================
# /show system telemetry grpc subscription 2 paths 
===============================================================================
Telemetry gRPC subscription
===============================================================================
Subscription-id       : 2
User                 : admin
Destination     : 192.168.110.252
Port                  : 54309
 
Paths
-------------------------------------------------------------------------------
Path                  : /configure
Sample interval       : 5000 ms
Finished samples      : 15
Deferred samples      : 13
Total collection time : 13607 ms
Min collection time   : 832 ms
Avg collection time   : 907 ms
Max collection time   : 933 ms
-------------------------------------------------------------------------------
Path                  : /state
Sample interval       : 10000 ms
Finished samples      : 13
Deferred samples      : 0
Total collection time : 54904 ms
Min collection time   : 4040 ms
Avg collection time   : 4223 ms
Max collection time   : 4296 ms
-------------------------------------------------------------------------------
Path                  : /state/router[router-instance=Base]/
                        interface[interface-name=system]
Sample interval       : 2000 ms
Finished samples      : 43
Deferred samples      : 29
Total collection time : 935 ms
Min collection time   : 15 ms
Avg collection time   : 21 ms
Max collection time   : 30 ms
-------------------------------------------------------------------------------
No. of paths          : 3

grpc

Syntax 
grpc
Context 
show>router>sgt-qos>application
Description 

This command displays the gRPC router status.

dscp

Syntax 
dscp
Context 
show>router>sgt-qos>application>grpc
Description 

This command shows the configured DiffServ Code Point (DSCP) name/value for gRPC.

7.6.2.2. Admin Commands

subscription

Syntax 
subscription subscription-id cancel
Context 
admin>system>telemetry>grpc
Description 

This command cancels an active Telemetry subscription.

Parameters 
subscription-id—
Specifies the ID of the Telemetry subscription to cancel.
Values—
0 to 4294967295

 

subscription cancel-all

Syntax 
subscription cancel-all
Context 
admin>system>telemetry>grpc
Description 

This command cancels all active Telemetry subscriptions.

disconnect

Syntax 
disconnect {grpc}
Context 
admin
Description 

This command disconnects all active gRPC sessions.