8.5. gRPC Show, Admin Command Reference

This section provides the gRPC show and admin command descriptions.

8.5.1. Command Hierarchies

8.5.1.1. Show Commands

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

8.5.1.2. Tools Commands

tools
— dump
— system
on-change-paths {open-config | nokia}

8.5.1.3. Admin Commands

admin
— system
— telemetry
— grpc
subscription subscription-id cancel

8.5.2. Command Descriptions

8.5.2.1. Show Commands

grpc

Syntax 
grpc
Context 
show>system>telemetry
Description 

This command displays the gRPC server status.

Output 

The following output displays gRPC server information.

Table 103 describes gRPC fields.

Sample Output
===============================================================================
gRPC Server
===============================================================================
Administrative State      : Disabled
Operational State         : Down
===============================================================================
Table 103:  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.
paths
Indicates that the show command output includes all paths with the respective subscription ID information.
Output 

The following output describes the telemetry gRPC subscription fields.

Sample Output
A:node-6>show>system>telemetry>grpc# subscription
===============================================================================
Telemetry gRPC subscriptions
===============================================================================
Id            User                             Mode                       Port
  Destination
-------------------------------------------------------------------------------
1             admin                            stream                    49648
     192.99.5.0
-------------------------------------------------------------------------------
No. of gRPC Telemetry subscriptions: 1
===============================================================================
A:node-6>show>system>telemetry>grpc# subscription 2
===============================================================================
Telemetry gRPC subscription
===============================================================================
Subscription-id       : 2
User                  : admin
Destination           : 192.168.110.252
Port                  : 54309
===============================================================================
A:node-6>show>system>telemetry>grpc# subscription 1 paths
===============================================================================
Telemetry gRPC subscription
===============================================================================
Subscription id       : 1
User                  : admin
Destination           : 192.99.5.0
Port                  : 49648
Subscription mode     : stream
-------------------------------------------------------------------------------
Paths
-------------------------------------------------------------------------------
Path                  : /state/router[router-instance=*]/interface[interface-
                        name=*]/ipv4/oper-state
Path mode             : on-change
Sample interval       : 10000 ms
Finished samples      : 1
Deferred samples      : 0
Total collection time : 6 ms
Min collection time   : 6 ms
Avg collection time   : 6 ms
Max collection time   : 6 ms
-------------------------------------------------------------------------------
No. of paths          : 1
===============================================================================

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 displays the configured DSCP name or value for gRPC.

8.5.2.2. Tools Commands

telemetry

Syntax 
telemetry
Context 
tools>dump>system
Description 

This command enables the telemetry context.

on-change-paths

Syntax 
on-change-paths
on-change-paths {open-config | nokia}
Context 
tools>dump>system>telemetry
Description 

This command lists all paths supporting on-change notifications. The keywords open-config and nokia indicate which model should be used as a reference for the output.

Parameters 
open-config —
Indicates that the open-config model will be used as the output reference.
nokia —
Indicates that the Nokia model will be used as the output reference.
Output 

Sample Output
A:node-6# tools dump system telemetry on-change-paths nokia
===============================================================================
Nokia on-change state paths
===============================================================================
/state/log/log-id/oper-state
/state/port/ethernet/lldp/dest-mac/remote-system/chassis-id
/state/port/ethernet/lldp/dest-mac/remote-system/chassis-id-subtype
/state/port/ethernet/lldp/dest-mac/remote-system/remote-port-id
/state/port/ethernet/lldp/dest-mac/remote-system/remote-port-id-subtype
/state/port/ethernet/lldp/dest-mac/remote-system/port-description
/state/port/ethernet/lldp/dest-mac/remote-system/system-enabled-capabilities
/state/port/ethernet/lldp/dest-mac/remote-system/system-supported-capabilities
/state/port/ethernet/lldp/dest-mac/remote-system/system-description
/state/port/ethernet/lldp/dest-mac/remote-system/system-name
/state/port/ethernet/lldp/dest-mac/remote-system/mgmt-address/interface-subtype
/state/port/ethernet/lldp/dest-mac/remote-system/mgmt-address/interface-id
/state/port/ethernet/lldp/dest-mac/remote-system/mgmt-address/object-identifier
/state/router/interface/if-oper-status
/state/router/isis/interface/level/oper-metric/ipv4-unicast
/state/router/isis/interface/level/oper-metric/ipv6-unicast
/state/router/isis/interface/level/oper-metric/ipv4-multicast
/state/router/isis/interface/level/oper-metric/ipv6-multicast
/state/router/mpls/lsp/oper-state
/state/router/mpls/lsp/primary/mbb/last-mbb/type
/state/router/mpls/lsp/primary/mbb/last-mbb/end-time
/state/router/mpls/lsp/primary/mbb/last-mbb/metric
/state/router/mpls/lsp/primary/mbb/last-mbb/state
/state/router/mpls/lsp/primary/mbb/last-mbb/signaled-bw
/state/router/mpls/lsp/secondary/mbb/last-mbb/type
/state/router/mpls/lsp/secondary/mbb/last-mbb/end-time
/state/router/mpls/lsp/secondary/mbb/last-mbb/metric
/state/router/mpls/lsp/secondary/mbb/last-mbb/state
/state/router/mpls/lsp/secondary/mbb/last-mbb/signaled-bw
/state/service/ies/interface/if-oper-status
/state/service/vprn/interface/if-oper-status
/state/service/vprn/log/log-id/oper-state
/state/system/lldp/chassis-id
/state/system/lldp/chassis-id-subtype
/state/system/lldp/system-name
/state/system/lldp/system-description
/state/system/telemetry/grpc/subscription/path/deferred-collection-count
===============================================================================

8.5.2.3. 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.