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.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 115 describes gRPC fields.

Sample Output
===============================================================================
gRPC Server
===============================================================================
Administrative State      : Disabled
Operational State         : Down
===============================================================================
Table 115:  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

cpm-http-redirect redirect statistics

Syntax 
cpm-http-redirect redirect statistics
Context 
tools>dump>system
Description 

This command displays system level statistics for all redirected TCP sessions in optimized-mode. These include the following:

  1. Close requests to TCP: TCP layer requested to send a FIN
  2. Abort requests to TCP: error in the received packet and the TCP layer needs to send a RST
  3. Data requests to TCP: number of redirects sent to the TCP layer
  4. Connections deleted: number of connections closed without a successful redirect performed
  5. HTTP GET parse errors: formatting error in the HTTP request
  6. HTTP GET process errors: HTTP GET is formatted properly but the redirect still fails. Example: system unable to find a corresponding host
  7. HTTP Response dropped: communication error; the redirect failed to be sent to the TCP layer
A# tools dump system cpm-http-redirect redirect statistics 
===============================================================================
CPM HTTP Redirect statistics
===============================================================================
Close requests to TCP                                   : 2
Abort requests to TCP                                   : 0
Data requests to TCP                                    : 2
Requests rejected - out of memory                       : 0
Connections deleted                                     : 0
HTTP GET parse errors                                   : 0
HTTP GET process errors                                 : 0
HTTP Response dropped                                   : 0

cpm-http-redirect redirect summary

Syntax 
cpm-http-redirect redirect summary
Context 
tools>dump>system
Description 

This command displays the summary statistics of cpm-http-redirect optimized-mode for the total number of host and connections currently in use. It, also, allows to compare the current system utilization with the maximum system scale.

A# tools dump system cpm-http-redirect summary
===============================================================================
CPM HTTP Redirect summary
===============================================================================
Actual number of hosts                                  : 0
Actual number of connections                            : 0
Number of hosts created in the last second              : 0
Number of connections created in the last second        : 0
===============================================================================

cpm-http-redirect tcp sessions

Syntax 
cpm-http-redirect tcp sessions
Context 
tools>dump>system
Description 

This command displays the system level TCP session state information of the cpm-http-redirect optimized-mode for currently opened sessions. Specifically, the following are displayed:

  1. New: Syn received and Syn-Ack not sent
  2. SYN: Syn-Ack sent and waiting for Ack
  3. ESTABLISHED: Ack received and waiting for data
  4. FIN: FIN sent and waiting for Fin-Ack
  5. Delete: Sum of all currently open connections at this time, representing the connections to be deleted
  6. HTTP Response dropped: communication error; the redirect failed to be sent to the TCP layer

All current sessions are counted both in the state where they belong, such as 'New', 'Syn', 'Established', 'Fin', and in the sum 'Delete' count.

A# tools dump system cpm-http-redirect tcp sessions
===============================================================================
CPM HTTP Redirect TCP session information
===============================================================================
TCP sessions in new state                               : 0
TCP sessions in state SYN                               : 0
TCP sessions in state ESTABLISHED                       : 0
TCP sessions in state FIN                               : 0
TCP sessions in delete state                            : 0
================

cpm-http-redirect tcp settings

Syntax 
cpm-http-redirect tcp settings
Context 
tools>dump>system
Description 

This command displays the system level TCP settings of the cpm-http-redirect optimized-mode. These settings can be further controlled using tools perform commands.

Dut-A# tools dump system cpm-http-redirect tcp settings
    data-retransmissions 1
    data-timeout 20
    established-timeout 100
    fin-ack-retransmissions 1
    fin-ack-timeout 15
    max-connections 500
    max-connections-per-host 20
    max-hosts 500
    syn-ack-retransmissions 1
    syn-ack-timeout 20

cpm-http-redirect tcp statistics

Syntax 
cpm-http-redirect tcp statistics
Context 
tools>dump>system
Description 

This command displays the system level TCP statistics of the cpm-http-redirect optimized-mode for all sessions.

A# tools dump system cpm-http-redirect tcp statistics
===============================================================================
CPM HTTP Redirect TCP statistics (only nonzero values shown)
===============================================================================
Packets forwarded                                       : 25
TCP segments received                                   : 8
Not a TCP segment                                       : 17
Packets offered to redirect                             : 2
SYN received                                            : 2
FIN,ACK received                                        : 2
ACK received                                            : 4
Valid TCP packets received                              : 8
Received packets                                        : 25
Received packets with a connection                      : 8
Connection creations                                    : 2
Connection deletions                                    : 2
SYN processed                                           : 2
SYN,ACK processed                                       : 2
SYN,ACK with data processed                             : 2
FIN,ACK processed                                       : 2
FIN,ACK with wrong sequence number                      : 2
===============================================================================

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.