7.12. Show, Clear, Monitor, and Tools Command Reference

Command Hierarchies
Command Descriptions

7.12.1. Command Hierarchies

Show Commands
Clear Commands
Debug Commands
Monitor Commands
Tools Commands

7.12.1.1. Show Commands

show

— router

— rib-api

— label [label] [detail]

— label [label] egress-stats

— label [label] ingress-stats

— route [family] [ip-prefix/prefix-length] [detail]

— route next-hop {ip-address | ipv6-address} [detail]

— status

— tunnel [{ip-address | ipv6-address}] [detail]

— tunnel [{ip-address | ipv6-address}] egress-stats

7.12.1.2. Clear Commands

clear

— router

— rib-api

— label label preference preference client-tag client-tag egress-stats

— label label ingress-stats

— tunnel {ip-address | ipv6-address} preference preference client-tag client-tag egress-stats

7.12.1.3. Debug Commands

debug

— router

— [no] rib-api

— [no] label label

— [no] tunnel ip-address

7.12.1.4. Monitor Commands

monitor

— router

— rib-api

— label label preference preference client-tag client-tag egress-stats [interval seconds] [repeat repeat] [{absolute | rate}]

— tunnel {ip-address | ipv6-address} preference preference client-tag client-tag egress-stats [interval seconds] [repeat repeat] [{absolute | rate}]

7.12.1.5. Tools Commands

tools

— dump

— router

— rib-api

— label label

— tunnel {ip-address | ipv6-address}

7.12.2.1. Show Commands

rib-api

Syntax

rib-api

Context

show>router

Description

This command displays RIB-API protocol entities information.

label

Syntax

label [label] [detail]

label [label] egress-stats

label [label] ingress-stats

Context

show>router>rib-api

Description

This command displays RIB-API label information.

Parameters

label—

Specifies the label of a specified RIB-API entry.

Values—

16 to 1048575

detail—

Displays detailed RIB-API label information.

egress-stats—

Displays egress statistics of all instances for the specified RIB-API label.

ingress-stats—

Displays ingress statistics of all instances for the specified RIB-API label.

Output

The following output is an example of RIB-API label information.

Sample Output

show router rib-api label 400001 egress-stats

===============================================================================

Label (Detail)

===============================================================================

Label : 400001 Rib-Api Pref : 16

Client Ip : 172.21.38.76 Client Tag : 1

Active : Y EgrStatsState : Up

Next-hop Group : 1

Primary nexthop : 10.10.5.5

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Backup nexthop : 10.10.11.4

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Next-hop Group : 2

Primary nexthop : 10.10.5.5

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Backup nexthop : 10.10.11.4

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Total Aggr :

Aggr Pkts: 44000 Aggr Octets: 46200000

-------------------------------------------------------------------------------

===============================================================================

route

Syntax

route [family] [ip-prefix/prefix-length] [detail]

route next-hop {ip-address | ipv6-address} [detail]

Context

show>router>rib-api

Description

This command displays RIB-API route information.

Parameters

family—

Specifies the IPv4 or IPv6 address route family.

Values—

ipv4, ipv6

ip-prefix/prefix-length—

Displays RIB-API route entries only matching the specified IP prefix and length.

Values—

ipv4-prefix:	a.b.c.d (host bits must be 0)
ipv4-prefix-length	0 to 32
ipv6-prefix:	x:x:x:x:x:x:x:x (eight 16-bit pieces)
	x:x:x:x:x:x:d.d.d.d
	x:	[0 to FFFF]H
	d:	[0 to 255]D
	ipv6-prefix-length:	0 to 128

detail—

Displays detailed RIB-API route information.

ip-address—

Specifies the next-hop IPv4 address of the RIB-API route.

Values—

ipv4-address:

a.b.c.d

ipv6-address—

Specifies the next-hop IPv6 address of the RIB-API route.

Values—

ipv6-address:	x:x:x:x:x:x:x:x (eight 16-bit pieces)
	x:x:x:x:x:x:d.d.d.d
	x:	[0 to FFFF]H
	d:	[0 to 255]D

Output

The following output is an example of RIB-API route information.

Sample Output

*A:Dut-A# /show router rib-api route

==============================================================================

RibApi Route Table (Router: Base) Family: IPv4

==============================================================================

Prefix Rib-Api Client IP Act

Next Hop Pref

------------------------------------------------------------------------------

100.0.0.0/8 182 10.254.135.92 N

10.20.1.3

101.0.0.0/8 182 10.254.135.92 Y

10.21.1.3

------------------------------------------------------------------------------

No. of Rib-Api Routes: 2

==============================================================================

*A:Dut-A# /show router rib-api route detail

===============================================================================

RibApi Route Table (Router: Base) Family: IPv4

===============================================================================

Prefix : 100.0.0.0/8

Client IP : 10.254.135.92

Client Tag : 4 Stale client : N

Metric : 61130 RTM Preference : 171

Rib-Api Pref : 182

Last Updated : 02/07/2020 23:44:17

Nexthop : 10.20.1.3

Active In RTM : N

Inactive Reason : Next-hop not resolved or no usable tunnels

-------------------------------------------------------------------------------

Prefix : 101.0.0.0/8

Client IP : 10.254.135.92

Client Tag : 4 Stale client : N

Metric : 61130 RTM Preference : 171

Rib-Api Pref : 182

Last Updated : 02/07/2020 23:44:44

Nexthop : 10.21.1.3

Active In RTM : Y

Inactive Reason : Not Applicable

-------------------------------------------------------------------------------

No. of Rib-Api Routes: 2

===============================================================================

*A:Dut-A#

Table 113: RIB-API Route Fields

Label	Description
Family	The route family: ipv4 ipv6
Prefix	The IP prefix for the route RTM entry
Rib-Api Pref	The RIB-API preference opposing to the routes from different clients with the same prefix
Client IP	The IP address of the gRPC client that configured the RIB-API route entry
Act	The boolean (YES or NO) that indicates whether the status of the RIB-API route in RTM is active or not
Next Hop	The next-hop IP address of the RIB-API route entry
No. of Rib-Api Routes	The total number of the displayed RIB-API routes
Client Tag	The client tag unique identifier assigned to each gRPC connection by the gRPC server
Stale client	The stale client (Y or N) that indicates if the route is from a disconnected gRPC client
Metric	The metric of the route
RTM Preference	The RTM preference opposing to the routes having the same prefix from different protocols (BGP, OSPF)
Last Updated	The time stamp of when the route was added or modified from a gRPC client
Nexthop	The next-hop IP address of the RIB-API route entry
Active In RTM	The boolean (Y or N) that indicates whether the status of the RIB-API route is active or not in RTM
Inactive Reason	The inactive reason or the route not active in RTM

status

Syntax

status

Context

show>router>rib-api

Description

This command displays RIB-API status information.

Output

The following output is an example of RIB-API status information.

Sample Output

*A:Dut-A# /show router rib-api status

===============================================================================

Rib-Api Status

===============================================================================

MPLS Admin Reserved Label Block Name

Status

-------------------------------------------------------------------------------

Up ribapi

===============================================================================

tunnel

Syntax

tunnel [{ip-address | ipv6-address}] [detail]

tunnel [{ip-address | ipv6-address}] egress-stats

Context

show>router>rib-api

Description

This command displays RIB-API tunnel information.

Parameters

ip-address—

Specifies the IPv4 address of the RIB-API tunnel up to 64 characters.

ipv6-address—

Specifies the IPv6 address of the RIB-API tunnel up to 64 characters.

detail—

Displays detailed RIB-API tunnel information.

egress-stats—

Displays egress statistics of all instances for the specified RIB-API tunnel.

Output

The following output is an example of RIB-API tunnel information.

Sample Output

show router rib-api tunnel 10.20.1.5 egress-stats

===============================================================================

Tunnel (Detail)

===============================================================================

Tunnel : 10.20.1.5 Rib-Api Pref : 16

Client Ip : 172.21.38.76 Client Tag : 1

Active : Y EgrStatsState : Up

Next-hop Group : 1

Primary nexthop : 10.10.5.5

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Backup nexthop : 10.10.11.4

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Next-hop Group : 2

Primary nexthop : 10.10.5.5

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Backup nexthop : 10.10.11.4

StatsOperState : Up

Aggr Pkts: 11000 Aggr Octets: 11550000

Total Aggr :

Aggr Pkts: 44000 Aggr Octets: 46200000

-------------------------------------------------------------------------------

===============================================================================

7.12.2.2. Clear Commands

rib-api

Syntax

rib-api

Context

clear>router

Description

This command clears RIB-API protocol entities information.

label

Syntax

label label preference preference client-tag client-tag egress-stats

label label ingress-stats

Context

clear>router>rib-api

Description

Clears the egress or ingress statistics of the specified RIB-API label.

Parameters

label—

Specifies the label of the specified RIB-API entry.

Values—

32 to 1048575

preference—

Specifies the preference of the specified RIB-API entry.

Values—

0 to 4294967295

client-tag—

Specifies the client tag of the specified RIB-API entry.

Values—

0 to 4294967295

egress—

Specifies to only clear the egress statistics.

ingress—

Specifies to only clear the ingress statistics.

tunnel

Syntax

tunnel {ip-address | ipv6-address} preference preference client-tag client-tag egress-stats

Context

clear>router>rib-api

Description

Clears the egress statistics of the specified RIB-API tunnel.

Parameters

ip-address—

Specifies the IPv4 address of the RIB-API tunnel up to 64 characters.

ipv6-address—

Specifies the IPv6 address of the RIB-API tunnel up to 64 characters.

preference—

Specifies the preference of the specified RIB-API entry.

Values—

0 to 4294967295

client-tag—

Specifies the client tag of the specified RIB-API entry.

Values—

0 to 4294967295

egress—

Specifies to clear the egress statistics.

7.12.2.3. Debug Commands

rib-api

Syntax

[no] rib-api

Context

debug>router

Description

This command enables debugging for RIB-API protocol entities.

label

Syntax

[no] label label

Context

debug>router>rib-api

Description

This command enables debugging for the specified RIB-API label.

Parameters

label—

Specifies the label of the specified RIB-API entry.

Values—

32 to 1048575

tunnel

Syntax

[no] tunnel ip-address

Context

debug>router>rib-api

Description

This command enables debugging for the specified RIB-API tunnel.

Parameters

ip-address—

Specifies the IPv4 or IPv6 address of the RIB-API tunnel.

Values—

ipv4-address:	a.b.c.d
ipv6-address:	x:x:x:x:x:x:x:x (eight 16-bit pieces)
	x:x:x:x:x:x:d.d.d.d
	x:	[0 to FFFF]H
	d:	[0 to 255]D

7.12.2.4. Monitor Commands

rib-api

Syntax

rib-api

Context

monitor>router

Description

This command monitors the RIB-API protocol entities information.

label

Syntax

label label preference preference client-tag client-tag egress-stats [interval seconds] [repeat repeat] [{absolute | rate}]

Context

monitor>router>rib-api

Description

This command monitors the egress statistics of the specified RIB-API label.

Parameters

label—

Specifies the label of the specified RIB-API entry.

Values—

0 to 4294967295

preference—

Specifies the preference of the specified RIB-API entry.

Values—

0 to 4294967295

client-tag—

Specifies the client tag of the specified RIB-API entry.

Values—

0 to 4294967295

egress-stats—

Specifies to monitor the egress statistics of the specified RIB-API label.

seconds—

Configures the interval for each display in seconds.

Values—

3 to 60

repeat—

Configures how many times the command is repeated.

Values—

1 to 999

absolute—

Displays the absolute statistics of the specified RIB-API label.

rate—

Displays the rate-per-second statistics of the specified RIB-API label.

tunnel

Syntax

tunnel {ip-address | ipv6-address} preference preference client-tag client-tag egress-stats [interval seconds] [repeat repeat] [{absolute | rate}]

Context

monitor>router>rib-api

Description

This command monitors the egress statistics of the specified RIB-API tunnel.

Parameters

ip-address—

Specifies the IPv4 address of the RIB-API tunnel up to 64 characters.

ipv6-address—

Specifies the IPv6 address of the RIB-API tunnel up to 64 characters.

preference—

Specifies the preference of the specified RIB-API entry.

Values—

0 to 4294967295

client-tag—

Specifies the client tag of the specified RIB-API entry.

Values—

0 to 4294967295

egress-stats—

Specifies to monitor the egress statistics of the specified RIB-API tunnel.

seconds—

Configures the interval for each display in seconds.

Values—

3 to 60

repeat—

Configures how many times the command is repeated.

Values—

1 to 999

absolute—

Displays the absolute statistics of the specified RIB-API tunnel.

rate—

Displays the rate-per-second statistics of the specified RIB-API tunnel.

7.12.2.5. Tools Commands

rib-api

Syntax

rib-api

Context

tools>dump>router

Description

This command configures the dump tools for RIB-API protocol instance.

label

Syntax

label label

Context

tools>dump>router>rib-api

Description

This command configures the dump tools for RIB-API label.

Parameters

label—

Specifies the label of the specified RIB-API entry.

Values—

32 to 1048575

Output

The following output is an example of RIB-API label route information.

Sample Output

*A:Dut-B>config>service# /tools dump router rib-api label 30044

Db Mgr flags 0x80 ilmStatsFailCnt 0

---------------------------------------------------------------------------

dbOwner RIB-API routeOwner 50 rsvdBlkId 3 flags 0x3 numPolicies 1 numInstalled 1

---------------------------------------------------------------------------

Label DB 30044

dbFlags 0xd PathCount 1 srTunnelId 1015811 ilmStatsIdx[MGMT] 0x0 ilmStatsIdx[API] 0x0

LABEL RESERVED: PROGRAMMED

Path bitmap 0

Label Retry time left : 0 retrycount : 0, SR Retry time left : 0 SR retrycount : 0

Best Db Path owner 1 path name vrId:1, dbOwner:1, Client Tag:2 bindingLbl 30044 preference 246 Last Modified 02/07/2020 23:44:51 Up Time 0d 02:15:54

Preference 246 flags 0x245 Status FWDPLCY_ERR_NA SR status SR_ERR_OK

PrimResolved NH's 1 BkupResolved NH's 1

NHGroup 2

flags 0x3bf9 : weight 0 normalized weight 0

Revert timer 65535 Time left 0 NumOfReverts 0

Hold timer 0 Time left 0

DIRECT NH: PRIM PGMED: PRIM RESOLVED: BKUP RESOLVED: BKUP PGMED:

primaryNH 1.2.3.3 egrStatsIdx 0x0 Status FWDPLCY_NHERR_NA

Label Stack:30055 0

Nexthop 1 1.2.3.3 outIf 3 globalIfIndex 32 globaIfInNHgrp 32

PG ID 0

PG ID 5

backupNH 1.2.3.33 egrStatsIdx 0x0 Status FWDPLCY_NHERR_NA

Label stack:30255 0

Nexthop 1 1.2.3.33 outIf 3 globalIfIndex 32 globaIfInNHgrp 32

PG ID 0

PG ID 6

---------------------------------------------------------------------

*A:Dut-B>config>service#

tunnel

Syntax

tunnel {ip-address | ipv6-address}

Context

tools>dump>router>rib-api

Description

This command configures the dump tools for RIB-API tunnel.

Parameters

ip-address—

Specifies the IPv4 address of the RIB-API tunnel, up to 64 characters.

ipv6-address—

Specifies the IPv6 address of the RIB-API tunnel, up to 64 characters.

Output

The following output is an example of RIB-API tunnel route information.

Sample Output

*A:Dut-A>tools>dump>router>rib-api# tunnel 10.21.1.3

Db Mgr flags 0x80 ilmStatsFailCnt 0

---------------------------------------------------------------------------

dbOwner RIB-API routeOwner 50 rsvdBlkId 3 flags 0x3 numPolicies 1 numInstalled 1

---------------------------------------------------------------------------

EndPt DB 10.21.1.3

dbFlags 0xa PathCount 1 srTunnelId 1015813

PROGRAMMED

Path bitmap 0

SR Retry time left : 0 SR retrycount : 0

Best Db Path owner 1 path name vrId:1, dbOwner:1, Client Tag:4 endPoint 10.21.1.3 color 0 preference 182 Last Modified 02/07/2020 23:44:42 Up Time 0d 02:13:47

Preference 182 flags 0x4246 Status FWDPLCY_ERR_NA SR status SR_ERR_OK

TTM Preference 102 metric 103

PrimResolved NH's 1 BkupResolved NH's 1

NHGroup 4

flags 0x3bf9 : weight 0 normalized weight 0

Revert timer 65535 Time left 0 NumOfReverts 0

Hold timer 0 Time left 0

DIRECT NH: PRIM PGMED: PRIM RESOLVED: BKUP RESOLVED: BKUP PGMED:

primaryNH 1.1.2.2 egrStatsIdx 0x20001 Status FWDPLCY_NHERR_NA

Label Stack:30044 0

Nexthop 1 1.1.2.2 outIf 3 globalIfIndex 11 globaIfInNHgrp 11

PG ID 0

PG ID 7

backupNH 1.1.2.22 egrStatsIdx 0x20002 Status FWDPLCY_NHERR_NA

Label stack:30244 0

Nexthop 1 1.1.2.22 outIf 3 globalIfIndex 11 globaIfInNHgrp 11

PG ID 0

PG ID 8

---------------------------------------------------------------------

*A:Dut-A>tools>dump>router>rib-api#