Tools

Tools Command Reference

Command Hierarchies

Tools Dump Commands

tools
    - dump
        - auto-discovery [detail] [log]
        - cflowd
            - cache aggregate {src-dst-proto | src-dst-proto-port} family {ipv4 | ipv6}
            - cache all family {ipv4 | ipv6}
            - packet-size protocols [clear]
            - top-flows protocols [clear]
            - top-protocols protocols [clear]
        - control-queues failures
        - eth-ring [clear]
        - gnss port-id
        - lag lag-id lag-id
        - ldp-treetrace {prefix ip-prefix/mask | manual-prefix ip-prefix/mask} [path-destination ip-address] [trace-tree]
        - mpls-resources
        - persistence
            - dhcp-server [record record-key]
            - summary
        - port port-id discard [clear]
        - ppp port-id
        - router router-instance
        - router service-name service-name
            - bgp 
                - routes [family] received [url file-url]
            - fib slot-number [ipv4 | ipv6] summary 
            - ldp 
                - fec vc-type vc-type agi agi
                - fec p2mp-id identifier root ip-address
                - fec root ip-address source ip-address group mcast-address inner-root ip-address
                - fec prefix ip-prefix/mask
                - fec root ip-address source ip-address group mcast-address [rd rd]
                - fec vc-type vc-type vc-id vc-id
                - fec p2mp-id identifier root ip-address [rd rd] inner-root ip-address
                - instance 
                - interface [ip-int-name | ip-address]
                - memory-usage
                - peer ip-address
                - session [ip-address |:label-space] [connection | peer | adjacency]
                - sockets 
                - timers
            - mpls
                - ftn [endpoint endpoint | sender sender | nexthop nexthop | lsp-id lsp-id | tunnel-id tunnel-id | label start-label end-label]
                - ilm [endpoint endpoint | sender sender | nexthop nexthop | lsp-id lsp-id | tunnel-id tunnel-id | label start-label end-label] 
                - lspinfo [lsp-name] [detail]
                - memory-usage 
            - ospf
                - abr [detail]
                - area-range 
                - asbr [detail]
                - bad-packet interface-name
                - leaked-routes [summary | detail]
                - memory-usage [detail]
                - request-list [neighbor ip-address] [detail]
                - request-list virtual-neighbor ip-address area-id area-id [detail]
                - retransmission-list [neighbor ip-address] [detail]
                - retransmission-list [virtual-neighbor ip-address area-id area-id] [detail]
                - route-summary
                - route-table [ip-prefix/mask] [type] [detail]
                - sham-bad-packet interface-name
                - sr-adjacencies [remote ip-address] [detail]
                - sr-database [sid sid] [detail] 
            - ospf3
                - abr [detail]
                - area-range 
                - asbr [detail]
                - bad-packet interface-name
                - leaked-routes [summary | detail]
                - memory-usage [detail]
                - request-list [detail]
                - request-list neighbor [ip-address] [router-id] [detail]
                - request-list virtual-neighbor router-id transit-area transit-area [detail]
                - retransmission-list [detail]
                - retransmission-list neighbor [ip-address] [router-id] [detail]
                - retransmission-list virtual-neighbor router-id transit-area transit-area [detail]
                - route-summary
                - route-table [ipv6-prefix/prefix-length] [type] [detail]
            - pim
                - iom-failures [detail]
            - rsvp
                - neighbor [ip-address] [detail]
                - psb [endpoint endpoint-address] [sender sender-address] [tunnelid tunnel-id] [lspid lsp-id]
                - rsb [endpoint endpoint-address] [sender sender-address] [tunnelid tunnel-id] [lspid lsp-id]
            - segment-routing 
                - tunnel
            - static-route
                - ldp-sync-status
            - te-database [adv-router adv-router] [neighbor neighbor] [detail]
                - isis [instance isis-instance] [level level] 
                - ospf [instance ospf-instance] [area area-id] 
        - service 
            - evpn usage 
            - id service-id
                - evpn usage 
                - evpn-mpls [clear] 
                - ip-transport ipt-id
                    - remote-host host-id check-tcp
                - loopback 
                    - sap sap-id
                    - sdp sdp-id:vc-id
                    - sap sap-id stats [clear]
                    - sdp sdp-id[:vc-id] stats [clear]
                - network-latency-measurement 
            - ipsec-tunnel ipsec-tunnel-name stats loopback 
            - system
                - bgp-evpn
                    - ethernet-segment name evi value df 
            - vpls-fdb-stats [clear] 
        - system-limits
        - system-resources slot-number
        - testhead
        - test-oam
            - testhead test-name test-name [test-owner test-owner]
            - twamp twamp server error-counters

Tools Perform Commands

tools
    - perform 
        - aps
            - clear aps-id {protect | working}
            - exercise aps-id {protect | working}
            - force aps-id {protect | working}
            - lockout aps-id
            - request aps-id {protect | working}
        - cflowd
            - manual-export
        - eth-ring
            - clear ring-index
            - force ring-index path {a | b}
            - manual ring-index path {a | b}
        - ima
            - reset bundle-id
        - lag 
            - clear-force all-mc
            - clear-force lag-id lag-id [sub-group sub-group-id] 
            - clear-force peer-mc ip-address 
            - force all-mc {active | standby}
            - force lag-id lag-id [sub-group sub-group-id] {active | standby}
            - force peer-mc peer-ip-address {active | standby}
        - lcr
            - clear lcr-id {protect | working}
            - force lcr-id {protect | working}
            - lockout lcr-id 
        - log
            - test-event
        - mda-table-refresh
        - mw
            - clear mw-link-id {main | spare} {eps | tps | rps}
            - force mw-link-id {eps | tps | rps}
            - lockout mw-link-id {eps | tps | rps}
            - manual mw-link-id {main | spare} {eps | tps | rps}
            - software-download [force]
        - ptp reset-clk-rec clock-id clock-id
        - router router-instance
        - router service-name service-name
            - isis [isis-instance] 
                - ldp-sync-exit
                - run-manual-spf
            - mpls 
                - cspf to ip-addr [from ip-addr] [bandwidth bandwidth] [include-bitmap bitmap] [exclude-bitmap bitmap] [hop-limit limit] [exclude-address excl-addr [excl-addr...(up to 8 max)]] [use-te-metric] [strict-srlg] [srlg-group grp-id...(up to
8 max)] [exclude-node excl-node-id [excl-node-id...(up to 8 max)]] [skip-interface interface-name] [cspf-reqtype req-type] [least-fill-min-thd thd]
                - resignal {lsp lsp-name path path-name | delay minutes}
                - resignal {sr-te-lsp srte-lsp-name path path-name | sr-te-delay minutes}
                - resignal-bypass delay minutes
                - resignal-bypass lsp bypass-lsp-name [force]
                - sr-te-cspf [path-computation-method path-computation-method] to ip-address [path path-name] [from ip-address] [include-bitmap bitmap] [exclude-bitmap bitmap] [hop-limit limit] [metric-type-te] [strict-srlg] [srlg-group group-id] [local-sr-protection local-sr-protection] [label-stack-reduction] [max-sr-labels label-stack-size]
                - trap-suppress number-of-traps time-interval
                - update-path {lsp lsp-name path current-path-name new-path new-path-name}
            - ospf
                - ldp-sync-exit
                - refresh-lsas [lsa-type] [area-id]
                - run-manual-spf [externals-only]
        - security
            - authentication-server-check server-address ip-address [port port] user-name dhcp-client-user-name password password secret key [source-address ip-address] [timeout seconds] [router router-instance | service-name service-name]
        - service
            - id service-id
                - endpoint endpoint-name
                    - force-switchover sdp-id:vc-id
                    - no force-switchover
                - ip-transport ipt-id
                    - remote-host host-id check-tcp
                - sap sap-id cem asym-delay-adjust
        - system
            - management-interface
                - snmp
                    - change-key authentication authentication-protocol old-authentication-key new-authentication-key 
                    - change-key authentication authentication-protocol privacy privacy-protocol old-privacy-key new-privacy-key
                    - generate-key authentication authentication-protocol authentication-password [privacy privacy-protocol privacy-password] [engine-id identifier]
            - script-control
                - script-policy
                    - stop [script-policy-name] [owner script-policy-owner] [all]

Command Descriptions

Tools Generic Commands

tools
Syntax

tools

Context

<root>

Description

This command enables the context to use tools for debugging purposes.

Default

n/a

Tools Dump Commands

Dump Commands
dump
Syntax

dump

Context

tools

Description

This command enables the context to display information for debugging purposes.

Default

n/a

auto-discovery
Syntax

auto-discovery [detail] [log]

Context

tools>dump

Description

This command allows you to view all progress and event logs stored by ADP.

Default

n/a

Parameters
detail

displays detailed information about the system, ports, and ADP instructions

log

displays all detailed progress and event logs with timestamps

cflowd
Syntax

cflowd

Context

tools>dump

Description

This command enables dump tools for cflowd.

Default

n/a

cache
Syntax

cache aggregate {src-dst-proto | src-dst-proto-port} family {ipv4 | ipv6}

cache all family {ipv4 | ipv6}

Context

tools>dump>cflowd

Description

This command displays the contents of the cflowd active cache. This information can be displayed either in raw form where every flow entry is displayed or in an aggregated form.

Default

n/a

Parameters
all

displays the raw active cache flow data with no aggregation.

aggregate

displays the aggregated active cache flow data

src-dst-proto — aggregates the active flow cache based on the source and destination IP address and the IP protocol value

src-dst-proto-port — aggregates the active flow cache based on the source and destination IP address, IP protocol value, and the source and destination port numbers

family

specifies which IP address family flow data should be displayed

ipv4 — displays the IPv4 flow data

ipv6 — displays the IPv6 flow data

Output

The following output is an example of cflowd cache information, and Tools Dump Cflowd Cache Field Descriptions describes the fields.

Output Example
*A:NOK1>config>router# /tools dump cflowd cache aggregate src-dst-proto family ipv4 
Cache dump aggregation in progress, please wait...
Current time: 03/21/2019 17:15:46
--------------------------------------------------------------------------------
Proto     Source Address                         Pkt-Cnt    Start
          Destination Address                    Byte-Cnt
--------------------------------------------------------------------------------
TCP       10.40.1.5                              11741      03/21/2019 17:13:35
          3.1.38.1                               2700430   
--------------------------------------------------------------------------------
Table 1. Tools Dump Cflowd Cache Field Descriptions

Label

Description

Proto

The IPv4 or IPv6 protocol type

Source Address

The source IP address of the flow (IPv4 or IPv6)

Destination Address

The destination IP address of the flow (IPv4 or IPv6)

Intf/Ingr

The ingress interface associated with the sampled flow (only displayed with the raw (all) output)

Intf/Egr

The egress interface associated with the sampled flow (only displayed with the raw (all) output)

S-Port

The source protocol port number

D-Port

The destination protocol port number

Pkt-Cnt

The total number of packets sampled for the associated flow

Byte-Cnt

The total number of bytes of traffic sampled for the associated flow

Start

The system time when the first packet was sampled for the associated flow

Flags

The IP flag value from the sampled IP flow header (only displayed with the raw (all) output)

ToS

The ToS byte values from the sampled IP flow header (only displayed with the raw (all) output)

(Src) Mask

The IP route mask for the route to the flow source IP address associated with the flow (only displayed with the raw (all) output)

(Dst) Mask

The IP route mask for the route to the flow destination IP address associated with the flow (only displayed with the raw (all) output)

(Src) AS

The ASN associated with the route to the flow source IP address associated with the flow (only displayed with the raw (all) output)

(Dst) AS

The ASN associated with the route to the flow destination IP address associated with the flow (only displayed with the raw (all) output)

vRtr-ID

The Virtual Router ID associated with the reported IP flow (only displayed with the raw (all) output)

packet-size
Syntax

packet-size protocol [clear]

Context

tools>dump>cflowd

Description

This command displays packet size distribution for sampled IP traffic. Values are displayed in decimal format (1.0 = 100%, 500 = 50%). Separate statistics are maintained and shown for IPv4 and IPv6 traffic.

The clear option clears the cache after the packet size statistics are displayed.

Default

n/a

Parameters
protocol

specifies the type of cflowd packet information to display

Values

ipv4 | ipv6 | mpls | mcast-ipv4 | mcast-ipv6

clear

clears the cache after the packet size statistics are displayed

Output

The following output is an example of cflowd packet size information.

Output Example
NOK-12# tools dump cflowd packet-size ipv4
 IP packet size distribution (801600 total packets):
   1-32   64   96  128  160  192  224  256  288  320  352  384  416  448  480
   .000 .250 .000 .000 .010 .100 .500 .090 .000 .000 .000 .000 .000 .000 .000

    512  544  576 1024 1536 2048 2560 3072 3584 4096 4608 9000
   .000 .000 .000 .050 .000 .000 .000 .000 .000 .000 .000 .000
top-flows
Syntax

top-flows protocols [clear]

Context

tools>dump>cflowd

Description

This command displays the top 20 (highest traffic volume) flows for IPv4, IPv6, or MPLS traffic types collected since the cflowd top-flow table was last cleared or initialized.

The clear option clears the cache after the packet size statistics are displayed.

Default

n/a

Parameters
protocols

specifies the type of cflowd packet information to display

Values

ipv4 | ipv6 | mpls | mcast-ipv4 | mcast-ipv6

clear

clears the cache after the packet size statistics are displayed

Output

The following output is an example of cflowd top flow information, and Tools Dump Cflowd Top Flows Field Descriptions describes the fields.

Output Example
*A:7705:Dut-A# tools dump cflowd top-flows ipv4
The top 20 IPv4 unicast flows seen by cflowd are:
     Current Time: 04/01/2019 17:44:17
Last Cleared Time: 04/01/2019 17:38:36
   ifIndexContext: global
Intf/Ingr  SrcIP             Intf/Egr  DstIP                         Pro     ToS
I-vRtrID   S-Port Msk AS     E-vRtrID  D-Port Msk AS                Flgs    Pkts
                                       NextHop                  Pkt-Size    Time
--------------------------------------------------------------------------------
2          150.2.1.2         1         150.1.1.2                       6    0x00
1          10     /24 300    1         20     /24 200               0x00      25
                                       1.20.1.2                       46       0
--------------------------------------------------------------------------------

*A:7705:Dut-A# tools dump cflowd top-flows ipv6
The top 20 IPv6 unicast flows seen by cflowd are:
     Current Time: 04/01/2019 17:44:24
Last Cleared Time: 04/01/2019 17:38:36
   ifIndexContext: global
SrcIP                                      Intf/Ingr    S-Port   I-vRtrID    ToS
DstIP                                      Intf/Egr     D-Port   E-vRtrID  Flags
Nexthop                                   Pkts         Pkt-Size Proto      Time
--------------------------------------------------------------------------------
::9602:102                                 2            10       1          0x03
::9601:102                                 1            20       1          0x00
::114:102                                 25            60       6             0
--------------------------------------------------------------------------------
*A:7705:Dut-
Table 2. Tools Dump Cflowd Top Flows Field Descriptions

Label

Description

Intf/Ingr

The ingress interface ID

SrcIP

The source IP address of the flow (IPv4 or IPv6)

Intf/Egr

The egress interface ID

DstIP

The destination IP address of the flow (IPv4 or IPv6)

Pro

The protocol type for the flow

ToS

The Type of Service/DSCP bits field markings

Flgs

The protocol flag markings

Pkts

The total number of packets sampled for this flow since the statistics were last cleared

I-vRtr-ID

The vRouter context the flow was sampled in

S-Port

The source protocol port number

Mask

The route prefix length for route to source IP address

AS

The autonomous systems number for the source route (the AS is either the originating AS or peer AS depending on the cflowd configuration)

D-Port

The destination protocol port number

Mask

The route prefix length for route to destination IP address (forwarding route)

AS

The autonomous systems number for the destination route (the AS is either the originating AS or peer AS depending on the cflowd configuration)

NextHop

The next-hop address used to forward traffic associated with the flow

Pkt-Size

The average packet size of sampled traffic associated with this flow (total number of packets sampled/volume of traffic sampled)

Time

The number of seconds the flow has been active

top-protocols
Syntax

top-protocols protocols [clear]

Context

tools>dump>cflowd

Description

This command displays the summary information for the top 20 protocol traffic flows in the cflowd cache. All statistics are calculated based on the data collected since the last clearing of the cflowd statistics.

If the clear option clears the cache after the top protocol statistics are displayed.

Default

n/a

Parameters
protocols

specifies the type of cflowd packet information to display

Values

ipv4 | ipv6 | mpls | mcast-ipv4 | mcast-ipv6

clear

clears the cache after the packet size statistics are displayed

Output

The following output is an example of cflowd top protocol traffic information, and Tools Dump Cflowd Top Protocols Field Descriptions describes the fields.

Output Example

NOK1# tools dump cflowd top-protocols 

The top 20 IPv4 protocols seen by cflowd are:
      Current Time: 08/29/2011 15:36:15
Last Cleared Time: 08/29/2011 15:35:08
Protocol ID     Total   Flows   Packets   Bytes   Packets   Duration   % Total
--------        Flows    /Sec     /Flow    /Pkt      /Sec      /Flow   Bandwidth
--------------------------------------------------------------------------------
UDP                 2       0         6     100         0          6         75%
pr1                 1       0         6      64         0          6         24%
--------------------------------------------------------------------------------
TOTALS              3       0         6      88         0          6        100%
Table 3. Tools Dump Cflowd Top Protocols Field Descriptions

Label

Description

Protocol ID

The IPv4 or IPv6 protocol type. The protocol ID is either the protocol name or the decimal protocol number.

Total Flows

The total number of flows recorded since the last clearing of cflowd statistics with this protocol type

Flows/Sec

The average number of flows detected for the associated protocol type

(Total flows/number of seconds since last clear)

Packets/Flow

The average number of packets per flow

(Total number of packets/total flows)

Bytes/Pkt

The average number of bytes per packet for the associated protocol type

(Total number of bytes for the associated protocol/total number of packets for the associated protocol)

Packets/Sec

The average number of packets for the associated protocol type

(Number of packets/number of seconds since last clear)

Duration/Flow

The average lifetime of a flow for the associated protocol type

(Number of seconds since last clear/total flows)

% Total Bandwidth

The percentage of bandwidth consumed by the associated protocol type

(Total protocol bytes/total bytes of all flows)

control-queues
Syntax

control-queues failures

Context

tools>dump

Description

This command displays information about failed control queues.

Default

n/a

Output

The following output is an example of control queue failures, and Control Queues Failures Field Descriptions describes the fields.

Output Example
*A:NOK1# /tools dump control-queues failures

Ingress SF queue          Size    Free    Buf Alloc Failures
------------------------------------------------------------
MDA Startup               1250    1250                     0
SF Large High priority    1024    1024                     0
SF Small High priority    8192    8192                     0
SF Large Med priority     1024    1024                     0
SF Small Med priority     8192    8192                     0
SF Large Low priority     1024    1024                     0
SF Small Low priority     8192    8192                     0
SF Cflowd                 8192    8192                     0
Table 4. Control Queues Failures Field Descriptions

Label

Description

Ingress SF queue

The ingress control queue

Size

The size of the control queue, in packets

Free

The remaining space in the control queue

Buf Alloc Failures

The number of recorded control queue failures

eth-ring
Syntax

eth-ring ring-index [clear]

Context

tools>dump

Description

This command displays Ethernet ring information.

Default

n/a

Parameters
ring-index

specifies an Ethernet ring index

clear

clears stored information for the specified Ethernet ring

gnss
Syntax

gnss port-id

Context

tools>dump

Description

This command displays GNSS satellite signal strength information.

Default

n/a

Parameters
port-id

specifies the port ID in the format slot/mda/port

Output

The following output is an example of GNSS information.

Output Example
A:ALU-1># tools dump gnss 1/3/1
======================
Satellites
======================
SVID  Signal-Strength
      C/No (dB-Hz)
----------------------
31    50
23    48
29    47
26    45
16    45
3     45
9     44
14    42
74    40
27    40
22    40
75    33
65    31
83    26
84    24
----------------------
Entries found: 15
======================
A:ALU-1>#
lag
Syntax

lag lag-id lag-id

Context

tools>dump

Description

This command displays Link Aggregation Group (LAG) information.

Default

n/a

Parameters
lag-id

the LAG identifier, expressed as a decimal integer

Values

1 to 32

ldp-treetrace
Syntax

ldp-treetrace {prefix ip-prefix/mask | manual-prefix ip-prefix/mask} [path-destination ip-address] [trace-tree]

Context

tools>dump

Description

This command displays treetrace information. The prefix command displays automated treetrace results only if ldp-treetrace is enabled at the oam-test level. The manual-prefix command displays results discovered by a previously run ldp-treetrace manual test.

Path information displayed by the ldp-treetrace command supports SNMP. The 7705 SAR stores this information in the TIMETRA-OAM-TEST-MIB tmnxOamLTraceHopInfoTable object.

Default

n/a

Parameters
ip-prefix/mask

specifies the IP prefix and subnet mask

Values

ip-prefix:        a.b.c.d (host bits must be 0)

mask:              0 to 32

ip-address

specifies the destination IP address

Output

The following outputs are examples of ldp-treetrace information.

Note: The tools dump ldp-treetrace prefix command displays entries only if ldp-treetrace is enabled using the configure test-oam ldp-treetrace no shutdown CLI command.

Output Example

The following example shows automated ldp-treetrace results. This command collects all information but displays a summary of the ECMP paths indexed by the path destination (PathDst), which is the IP address used in the LSP Ping message to probe a specific ECMP path to the destination FEC.

*A:ALU-1># tools dump ldp-treetrace prefix 10.12.12.10/32
Discovered Paths:
===================

Id   PathDst           Egr-NextHop       Reply-Rtr-Addr    DisCovery-Time 
       discoveryTtl      ProbeState        ProbeTmOutCnt     RtnCode 
===  ================  ================  ================  ===============
001       10.1.0.5         10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
002       10.1.0.9         10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
003       10.1.0.15        10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
004       10.1.0.19        10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
005       10.1.0.24        10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
…….
051      10.1.0.243        10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
052      10.1.0.247        10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
053      10.1.0.252        10.10.1.2       10.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
054      10.1.0.255        10.10.1.2       10.12.12.10 12/19/2006 05:11:01
 ldp-treetrace discovery state: Done  
 ldp-treetrace discovery status: ' OK '  
 Total number of discovered paths: 54 
 Total number of probe-failed paths: 0 
 Total number of failed traces: 0 
Output Example

The following example shows an automated ldp-treetrace with a path destination. This command displays the details of the label stack at each hop by filtering on a specific ECMP path.

tools dump ldp-treetrace prefix 10.12.12.10/32 path-destination 10.1.0.5
FEC: 10.12.12.10/32  PathDst: 10.1.0.5
==================================================
Protocol Legend: L - LDP, R - RSVP, U - Not Applicable 
 
HopId    HopAddr          TTL  Label1   Label2   Label3   Label4   Label5
=====   ================  ===  =======  =======  =======  =======  =======
277          10.12.12.10  007  000000L  000000U  000000U  000000U  000000U
223            10.1.1.17  006  001609L  000000U  000000U  000000U  000000U
196             10.2.1.2  005  001609L  000000U  000000U  000000U  000000U
187             10.2.1.1  004  001609L  000000U  000000U  000000U  000000U
184            10.1.1.11  003  001609L  000000U  000000U  000000U  000000U
183             10.1.1.1  002  001609L  000000U  000000U  000000U  000000U
182            10.10.1.2  001  001609L  000000U  000000U  000000U  000000U
 Total number of Hops: 7
mpls-resources
Syntax

mpls-resources

Context

tools>dump

Description

This command displays FEC-to-NHLFE (next hop label forwarding entry) and ILM (incoming label message) information for MPLS.

Default

n/a

persistence
Syntax

persistence

Context

tools>dump

Description

This command enables the context to display persistence information.

Default

n/a

dhcp-server
Syntax

dhcp-server [record record-key]

Context

tools>dump>persistence

Description

This command displays persistence information for the DHCP server.

Default

n/a

Parameters
record-key

specifies the record identification number

Output

The following output is an example of DHCP server persistence information, and DHCP Server Persistence Field Descriptions describes the fields.

Output Example
A:7705# tools dump persistence dhcp-server
-----------------------------------
Persistency File Info
-----------------------------------
Filename          : cf3:\dhcp_serv.001
ClientDescr       : dhcp-server
UserDataSize      : 372
DataPadding       : 128
NumberOfEntries   : 4112
FileSize          : 8225
Version           : 0001
Entries in use    : 9
State             : ACTIVE
Record Key Output Example
A:7705# tools dump persistence dhcp-server record 0x1
-----------------------------------
Persistency File Record
-----------------------------------
Filename          : cf3:\dhcp_serv.001
Key               : 00000001
Last Update       : 2013/07/12 11:45:37 (UTC)
Action            : ADD
Data
  service Id      : 0
  server          : defaultDhcpServer
  IP              : 10.1.1.20
  MAC             : 00:11:22:33:01:07
  XID             : 0x0cbe9d53
  start time      : 2013/07/12 11:45:37 (UTC)
  expires         : 2013/07/21 11:45:37 (UTC)
  failctrl        : local
  opt60 len       : 3
  opt82 len       : 0
Table 5. DHCP Server Persistence Field Descriptions

Label

Description

Filename

The name and location of the persistence information file

ClientDescr

The description of the client

UserDataSize

The size of the user data, in bytes

DataPadding

The size of the data padding, in bytes

NumberOfEntries

The number of entries in the persistence information file

It is a combination of leases given and may also contain DHCP servers configured

FileSize

The total size of records in the persistence information file, in blocks of 512 bytes

Version

The version of the persistence information file

Entries in use

The number of entries currently in use

State

The state of the persistence information file

Key

The record key number

Last Update

The date and time of the last record update

Action

The action taken during the last record update

Data

service Id

The service ID number

server

The DHCP server name

IP

The IP address of the lease

MAC

The MAC address associated with the lease

XID

The transaction ID (XID) used in DHCPDISCOVER packets

start time

The start time and date of the current lease

expires

The expiry time and date of the current lease

failctrl

The failure control (not supported on the 7705 SAR)

opt60 len

The length of the DHCP option 60 message

opt82 len

The length of the DHCP option 82 message

summary
Syntax

summary

Context

tools>dump>persistence

Description

This command displays persistence summary information.

Default

n/a

Output

The following output is an example of persistence summary information, and Persistence Summary Field Descriptions describes the fields.

Output Example
A:7705# tools dump persistence summary
=====================================================================
Persistence Summary on Slot A
=====================================================================
Client         Location            Entries in use     Status
---------------------------------------------------------------------
dhcp-server    cf3:\dhcp_serv.001  2                  ACTIVE

=====================================================================
Persistence Summary on Slot B
=====================================================================
Client         Location            Entries in use     Status
---------------------------------------------------------------------
dhcp-server    cf3:\dhcp_serv.001  2                  ACTIVE
Table 6. Persistence Summary Field Descriptions

Label

Description

Client

The name of the client

Location

The name and location of the persistence information file

Entries in use

The number of entries in use

Status

The status of the persistence information file

port
Syntax

port port-id discard [clear]

Context

tools>dump

Description

This command displays invalid Layer 2 packets that have been discarded for the specified port. Reasons for packet discards include an invalid VLAN identifier or an invalid Etype. The CLI shows the header for the invalid VLAN identifier and invalid Etype.

Default

n/a

Parameters
port-id

specifies the port ID in the format slot/mda/port

clear

clears the packets after viewing

ppp
Syntax

ppp port-id

Context

tools>dump

Description

This command displays PPP information for a port.

Default

n/a

Parameters
port-id

specifies the port ID

Syntax:      port-id     slot/mda/port[.channel]

                                     bundle     bundle-type-slot/mda.bundle-num

                                                      bundle                   keyword

                                                      type                       ima, ppp

                                                      bundle-num          1 to 32

service
Syntax

service

Context

tools>dump

Description

This command enables the context to display service information.

Default

n/a

evpn
Syntax

evpn usage

Context

tools>dump>service

tools>dump>service>id

Description

This command displays the consumed EVPN resources for the system or for a specified service.

Output

The following output is an example of EVPN usage for the system and a specified service.

Output Example

For the system:

*A:PE71# tools dump service evpn usage            

EVPN usage statistics at 000 02:01:03.810:

MPLS-TEP                                        :             5
VXLAN-TEP                                       :             0
Total-TEP                                       :      5/  8191

Mpls Dests (TEP, Egress Label + ES + ES-BMAC)   :            16
Vxlan Dests (TEP, Egress VNI)                   :             0
Total-Dest                                      :     17/131071

Sdp Bind +  Evpn Dests                          :     20/196607
ES L2/L3 PBR                                    :      0/ 32767
 *A:PE71# 

For a specific service:

*A:PE71#  tools dump service id 7 evpn usage

Evpn Tunnel Interface IP Next Hop: N/A

*A:PE71# 
id
Syntax

id service-id

Context

tools>dump>service

Description

This command enables the context to display information for the specified service.

Default

n/a

Parameters
service-id

specifies an existing service ID

Values

1 to 2147483647or a name string up to 64 characters long

evpn-mpls
Syntax

evpn-mpls [clear]

Context

tools>dump>service>id

Description

This command displays the EVPN-MPLS data for the specified service.

Parameters
clear

clears the EVPN-MPLS data for the specified service

ip-transport
Syntax

ip-transport ipt-id

Context

tools>dump>service>id

Description

This command enables the context to display information for a specific IES or VPRN IP transport subservice.

Default

n/a

Parameters
ipt-id

specifies the IP transport subservice physical port identifier

Values

value in the format slot/mda/port.channel

remote-host
Syntax

remote-host host-id check-tcp

Context

tools>dump>service>id>ip-transport

Description

This command displays information for a TCP connection check to a remote host for the specified service.

Default

n/a

Parameters
host-id

specifies the remote host identifier

Values

1 to 2147483647or a name string up to 64 characters long

check-tcp

displays information for a TCP connection check to a remote host

loopback
Syntax

loopback

Context

tools>dump>service>id

Description

This command displays loopback information for a SAP or an SDP bind for the specified service.

Default

n/a

sap
Syntax

sap sap-id

Context

tools>dump>service>id>loopback

Description

This command displays loopback information for a specified SAP in the specified service.

Default

n/a

Parameters
sap-id

specifies the SAP binding identifier

Values

(see list below)

null

[port-id | bundle-id | lag-id | aps-id | mw-link-id]

dot1q

[port-id | lag-id | aps-id | mw-link-id]:qtag1

qinq

[port-id | lag-id]:qtag1.qtag2

port-id

slot/mda/port[.channel]

lag-id

lag-id

   lag                  keyword

   id                   1 to 32

qtag1

*, 0 to 4094

qtag2

*, 0 to 4094

sdp
Syntax

sdp sdp-id:vc-id

Context

tools>dump>service>id>loopback

Description

This command displays loopback information for a specified SDP binding in the specified service.

Default

n/a

Parameters
sdp-id

specifies the SDP binding identifier

Values

1 to 17407

vc-id

the virtual circuit identifier

Values

1 to 4294967295

sap
Syntax

sap sdp-id stats [clear]

Context

tools>dump>service>id

Description

This command displays SAP information for the specified service.

Default

n/a

Parameters
sap-id

specifies the SAP binding identifier

Values

(see list below)

null

[port-id | bundle-id | lag-id | aps-id | mw-link-id]

dot1q

[port-id | lag-id | aps-id | mw-link-id]:qtag1

qinq

[port-id | lag-id]:qtag1.qtag2

atm

[port-id | aps-id][:vpi/vci | vpi | vpi1.vpi2]

frame

[port-id | aps-id]:dlci

cisco-hdlc

slot/mda/port.channel

cem

slot/mda/port.channel

ipcp

slot/mda/port.channel

ima-grp

bundle-id[:vpi/vci | vpi | vpi1.vpi2]

hdlc

slot/mda/port.channel

port-id

slot/mda/port[.channel]

SCADA bridge

slot/mda/bridge-id.branch-id

   bridge-id     1 to 16

   branch-id    1 to 32

bundle-id

bundle-type-slot/mda.bundle-num

   bundle            keyword

   type                ima, ppp

   bundle-num   1 to 32

aps-id

aps-group-id[.channel]

   aps                 keyword

   group-id        1 to 24

mw-link-id

mw-link-id

   id   1 to 24

lag-id

lag-id

   lag                  keyword

   id                   1 to 32

qtag1

*, 0 to 4094

qtag2

*, 0 to 4094

vpi

NNI    0 to 4095

UNI    0 to 255

vci

1, 2, 5 to 65535

dlci

16 to 1022

tunnel-id

tunnel-id.[private | public]:tag

   tunnel           keyword

   id                 1 to 16 (‟1” is the only valid value)

   tag               0 to 4094

clear

clears statistics after viewing

stats

displays statistics associated with this SAP

Output

The following output is an example of the discard statistics, and Service SAP Field Descriptions describes the fields.

Output Example
A:7705# tools dump service id 200 sap 1/X3/6:100 stats
===========================================================
Service Id 200 SAP 1/X3/6:100 VPLS Ingress Debug Stats
===========================================================
total number of discarded packets                   | 1
total number of discarded bytes                     | 996
number of discards due to source suppression        | 0
number of discards due to split horizon             | 0
number of discards due to mesh to mesh              | n/a
number of discards due to unknown DA                | 0
number of discards due to unknown SA                | 0
number of discards due to service MTU               | 0
number of discards due to STP not in fwding state   | 1
number of other discards                            | 0
===========================================================
Service Id 200 SAP 1/X3/6:100 VPLS Egress Debug Stats
===========================================================
total number of discarded packets                   | 0
number of unicast discards due to pool exhaustion   | 0
number of multicast discards due to pool exhaustion | 0
number of unicast discards due to queue overflow    | 0
number of multicast discards due to queue overflow  | 0
number of other discards                            | 0
Table 7. Service SAP Field Descriptions

Label

Description

total number of discarded packets

The total number of discarded ingress or egress packets for the specified SAP or SDP binding

total number of discarded bytes

The total number of discarded ingress bytes for the specified SAP or SDP binding

number of discards due to source suppression

The total number of ingress discards due to source suppression for the specified SAP or SDP binding

number of discards due to split horizon

The total number of ingress discards due to split horizon for the specified SAP or SDP binding

number of discards due to mesh to mesh

The total number of ingress discards due to mesh-to-mesh forwarding for the specified mesh SDP

number of discards due to unknown DA

The total number of ingress discards due to an unknown destination address for the specified SAP or SDP binding

number of discards due to unknown SA

The total number of ingress discards due to an unknown source address for the specified SAP or SDP binding

number of discards due to service MTU

The total number of ingress discards due to the packet size exceeding the configured maximum transmission unit for the specified SAP or SDP binding

number of discards due to STP not in fwding state

The total number of ingress discards due to an inactive VPLS endpoint determined by the Spanning Tree Protocol for the specified SAP

number of other discards

The total number of ingress or egress discards that do not match a listed category

number of unicast discards due to pool exhaustion

The total number of egress unicast discards due to pool exhaustion for the specified SAP or SDP binding

number of multicast discards due to pool exhaustion

The total number of egress multicast discards due to pool exhaustion for the specified SAP or SDP binding

number of unicast discards due to queue overflow

The total number of egress unicast discards due to queue overflow for the specified SAP or SDP binding

number of multicast discards due to queue overflow

The total number of egress multicast discards due to queue overflow for the specified SAP or SDP binding

sdp
Syntax

sap sdp-id[:vc-id] stats [clear]

Context

tools>dump>service>id

Description

This command displays SDP binding information for the specified service.

Default

n/a

Parameters
sdp-id

specifies the SDP binding identifier

Values

1 to 17407

vc-id

specifies the virtual circuit identifier

Values

1 to 4294967295

clear

clears statistics after viewing

stats

displays statistics associated with the specified SDP

network-latency-measurement
Syntax

network-latency-measurement

Context

tools>dump>service>id

Description

This command displays minimum, current, and maximum latency measurement values.

Default

n/a

Output

The following output is an example of network latency measurement information.

Output Example
A:SAR18-11-2# tools dump service id 100 network-latency-measurement
------------------------------------------------------------------------------------
Path Average Latency Measurements (us)
------------------------------------------------------------------------------------
Spoke-sdp                Min          Current          Max         Last update
121:100                  450            500            600         02/21/23 20:17:14
122:200                  350            600            800         02/21/23 20:17:14
.... 
Note:
  • The "Path Average Latency Measurements" output is only shown if the Cpipe has a timestamp. If a path is up but has not completed the first latency measurement, "N/A" is displayed. If a path that was up goes down, the last valid value is displayed.

  • For Cpipes with PW redundancy, only the active path average latency measurement is shown; other paths are not shown.

  • If a path is administratively down, "N/A" is displayed.

  • If a path is transported over a non-Ethernet interface (that is, timestamping is not available), "N/A" is displayed.
Note: The maximum latency that can be measured is 34.3 seconds. For any latency above 34.3 seconds, the current latency is displayed as "Too High". If there is a clocking issue that results in a situation where the far-end timestamp is earlier than the near-end timestamp, the latency is negative. In this case, the current latency is displayed as "Too Low". In either case, the minimum and maximum latencies are not updated, so the most recent minimum and maximum values are displayed.

The following is an example of network latency measurement information where the far-end timestamp is earlier than the near-end timestamp, resulting in a negative latency that is displayed as "Too Low".

Output Example

===============================================================================
Path Average Latency Measurements (us)
-------------------------------------------------------------------------------
Spoke-sdp         Min       Cur        Max          Last update
-------------------------------------------------------------------------------
321:1200          N/A       Too Low    N/A          Never
===============================================================================
Table 8. Network Latency Measurement Field Descriptions

Label

Description

Path Average Latency Measurements (us)

Spoke-sdp

Identifies the spoke SDP associated with the Cpipe

Min

The minimum latency value at the time of the last update

Current

The current latency value at the time of the last update

Max

The maximum latency value at the time of the last update

Last-update

The time that the latency values were last updated

ipsec-tunnel
Syntax

ipsec-tunnel ipsec-tunnel-name stats

Context

tools>dump>service

Description

This command displays the IPSec tunnel information.

Parameters
ipsec-tunnel-name

the name of the IPSec tunnel

stats

displays statistics associated with the IPSec tunnel

Output

The following output is an example of IPSec tunnel information, and IPSec Tunnel Field Descriptions describes the fields.

Output Example
*A:7705:Dut-A# tools dump service ipsec-tunnel tunnelPrivateSide_1.1 stats 

=================================================================
Discard Stats for Ipsec-Tunnel tunnelPrivateSide_1.1 (tunnelId 1 svcId 1001) 
=================================================================
Outbound Discard Stats:
     Security policy misses                              | 0
     Invalid security association                        | 0
     Sequence number wrap errors                         | 0
     Buffer exhaustion errors                            | 0
     IP-frag buffer exhaustion errors                    | 0
     Enqueue errors                                      | 0
     Tunnel peer-ip-address not reachable                | 0
     Tunnel peer-ip-address next-hop not reachable via IP| 0
     Egress uplink interface does not support encryption | 0
     Drop Too Big/Df-set Pkts                            | 0
     Other discards                                      | 0
=================================================================
Inbound Discard Stats:
     Authentication failures                             | 0
     Security policy misses                              | 0
     NATT UDP ports mismatch (src/dst)                   | 0
     IP Proto mismatch                                   | 0
     Tunnel and SPI cross validation errors              | 0
     IP fragmented packets (Unsupported)                 | 0
     Padding failures                                    | 0
     NULL SeqNum                                         | 0
     Enqueue errors                                      | 0
     Sequence number too old in window (Anti-Replay)     | 0
     Duplicated sequence number in window (Anti-Replay)  | 0
     Buffer exhaustion errors                            | 0
     Other discards                                      | 0
=================================================================
Table 9. IPSec Tunnel Field Descriptions

Field

Description

Outbound Discard Stats:

Security policy misses

The number of outbound packets discarded because of a security policy miss that can occur when a clear text packet source or destination IP address does not match any security policy entry for the IPSec tunnel. Discards are due to either an incorrect policy configuration or a packet that should have been denied entry to the tunnel.

Invalid security association

The number of outbound packets discarded because of an invalid security association (SA). Discards can be due to an IKE failure to negotiate the SA, an incorrect configuration in the SA for manual keying, or incomplete IPSec tunnel negotiation.

Sequence number wrap errors

The number of outbound packets discarded because the IPSec tunnel anti-replay sequence number has exceeded the maximum value allowed prior to completion of an SA re-keying

Buffer exhaustion errors

The number of outbound packets discarded because buffers were not available before packets were sent to the encryption engine queue. This condition can occur when the encrypting MDA is experiencing buffer congestion.

IP-frag buffer exhaustion errors

The number of outbound packets discarded because buffers were not available when fragmentation occurred before encryption on the packet. This condition can occur when the encrypting MDA is experiencing buffer congestion.

Enqueue errors

The number of outbound packets discarded because the encryption engine queue was full. This condition can occur when the encrypting MDA is experiencing buffer congestion.

Tunnel peer-ip-address not reachable

The number of outbound packets discarded because a route to the peer gateway IP address cannot be found. This can occur due to a network design issue or a temporary network outage.

Tunnel peer-ip-address next-hop not reachable via IP

The number of outbound packets discarded because the IPSec tunnel peer gateway route next hop is not in the supported IP next-hop or MPLS tunnel next-hop list. This can occur due to a network design issue or a temporary network outage.

Egress uplink interface does not support encryption

The number of outbound packets discarded because the outgoing interface for this IPSec tunnel is on an MDA that does not have encryption hardware. This can be due to a network design issue.

Drop Too Big/Df-set Pkts

The number of outbound packets discarded because a clear text packet cannot be fragmented when the do-not-fragment (DF) flag is set in the IP packet header and the outgoing IP interface MTU is too small for the encrypted packet

Other discards

The number of outbound packets discarded because of miscellaneous internal errors related to:

  • encryption engine

  • NAT-T session, IPSec tunnel, SA, or policy information

Inbound Discard Stats:

Authentication failures

The number of inbound packets discarded because of an inability to authenticate the packet with the current authentication key

Security policy misses

The number of inbound packets discarded because either:

  • the source or destination IP address of the decrypted clear text packet does not match the source or destination IP address

  • the IP version of the decrypted clear text packet does not match the IP version for the corresponding SPI

NATT UDP ports mismatch (src/dst)

The number of inbound packets discarded because the source or destination UDP port for NAT-T is different from the configured UDP port

IP Proto mismatch

The number of inbound packets discarded because of an IP protocol mismatch that can occur when NAT-T is configured and the protocol is not UDP or when NAT-T is not configured and the protocol is not ESP

Tunnel and SPI cross validation errors

The number of inbound packets discarded because the source or destination IP address of an encrypted packet does not match the expected IPSec gateway source or destination IP address for the SPI

IP fragmented packets (Unsupported)

The number of inbound packets discarded because the encrypted packet was fragmented. Fragmentation is not supported on IPSec encrypted packets.

Padding failures

The number of inbound packets discarded because a padding error was detected on the encrypted packet

NULL SeqNum

The number of inbound packets discarded because the sequence number is 0 (invalid as per RFC 4303)

Enqueue errors

The number of inbound packets discarded because the decryption engine queue is full. This condition can occur when the decrypting MDA is experiencing buffer congestion.

Sequence number too old in window (Anti-Replay)

The number of inbound packets discarded because the sequence number is lower than the lowest sequence number in the anti-replay window and therefore is considered too old

Duplicated sequence number in window (Anti-Replay)

The number of inbound packets discarded because a packet’s sequence number is duplicated. Duplicate sequence numbers are not allowed in an anti-replay window.

Buffer exhaustion errors

The number of inbound packets discarded because buffers were not available before packets were sent to the decryption engine queue. This condition can occur when the decrypting MDA is experiencing buffer congestion.

Other discards

The number of inbound packets discarded because of miscellaneous internal errors related to:

  • decryption engine

  • IPSec tunnel and SA information

loopback
Syntax

loopback

Context

tools>dump>service

Description

This command displays all active Ethernet SAP loopbacks on the node. Only internal loopback mode is supported.

Default

n/a

system
Syntax

bgp-evpn

Context

tools>dump>service

Description

This command enables the context for service system information.

bgp-evpn
Syntax

bgp-evpn

Context

tools>dump>service>system

Description

This command enables the context for BGP-EVPN service system information.

ethernet-segment
Syntax

ethernet-segment name evi value df

Context

tools>dump>service>system>bgp-evpn

Description

This command displays information on the computed DF PE for a specified EVI.

Parameters
name

specifies the name of the Ethernet segment

value

specifies the EVI

Values

1 to 65535

df

keyword for designated forwarder

Output

The following output is an example of Ethernet segment information.

Output Example
*A:PE2# tools dump service system bgp-evpn ethernet-segment "ESI-71" evi 1 df 
[07/15/2015 21:52:08] Computed DF: 192.0.2.72 (Remote) (Boot Timer Expired: Yes) 
vpls-fdb-stats
Syntax

vpls-fdb-stats [clear]

Context

tools>dump>service

Description

This command displays the VPLS FDB statistics.

Parameters
clear

clears the VPLS FDB statistics after viewing

Output

The following output is an example of VPLS FDB statistics, and System-Limits Field Descriptions describes the fields.

Output Example
*A:Sar18 Dut-B# tools dump service vpls-fdb-stats

Service Manager VPLS FDB info at 042 02:39:08.680:
Statistics last cleared at 000 00:00:00.000

      Statistic           |    Count
--------------------------+-------------
          FdbEntriesInUse |          0
          TotalFdbEntries |      65535
       FdbMimDestIdxInUse |          0
TotalFdbMimDestIdxEntries |        511
          FdbIsidIdxInUse |          0
TotalFdbMimIsidIdxEntries |      16384
               MacAddMsgs |          0
            MacDeleteMsgs |          0
             MacQueryMsgs |          0
              UnknownMsgs |          0
            MalformedMsgs |          0
               FailedMsgs |          0
           FdbHwTableFull |          0
       FdbHwLimitExceeded |          0
             FdbTableFull |          0
         FdbLimitExceeded |          0
   FdbMimDestIdxExhausted |          0
               MacAddReqs |          0
            DupMacAddReqs |          0
        DroppedMacAddReqs |          0
         FailedMacAddReqs |          0
               MacDelReqs |          0
            DupMacDelReqs |          0
        DroppedMacDelReqs |          0
         FailedMacDelReqs |          0

system-limits
Syntax

system-limits

Context

tools>dump

Description

This command displays the resource limits of the current system configuration.

Note: The system-limits command is only available on the following 7705 SAR systems:
  • 7705 SAR-8 Shelf V2

  • 7705 SAR-18

Default

n/a

Output

The following output is an example of system limits information, and System-Limits Field Descriptions describes the fields.

Output Example
A:7705# tools dump system-limits
                                      | Limit
--------------------------------------+-----------
                  IPv4 FIB Table Size | 65536
                  IPv6 FIB Table Size | 32768
     Max Number of Network Interfaces | 256
     Max Number of Service Interfaces | 1024
       Max Number of Total Interfaces | 1024
Max Number of IPv6 Network Interfaces | 255
Max Number of IPv6 Service Interfaces | 384
  Max Number of IPv6 Total Interfaces | 384
             VPRN Instances Supported | 62
             VPLS Instances Supported | 64
              Max Number of BGP Peers | 320
         Max Number of IP/Mac Filters | 512
Table 10. System-Limits Field Descriptions

Label

Description

IPv4 FIB Table Size

The maximum number of IPv4 addresses allowed in the forwarding information base table (FIB).

IPv4 router interfaces that are on cards equipped with hardware to support larger tables will have a higher maximum number of addresses than on cards that are not equipped with this hardware.

IPv6 FIB Table Size

The maximum number of IPv6 addresses allowed in the forwarding information base table (FIB).

IPv6 router interfaces that are on cards equipped with hardware to support larger tables will have a higher maximum number of addresses than on cards that are not equipped with this hardware.

Max Number of Network Interfaces

The maximum number of IPv4 network interfaces allowed on an adapter card

Max Number of Service Interfaces

The maximum number of IPv4 service interfaces allowed on an adapter card

Max Number of Total Interfaces

The maximum number of total IPv4 interfaces allowed on a system

Max Number of IPv6 Network Interfaces

The maximum number of IPv6 network interfaces allowed on an adapter card

Max Number of IPv6 Service Interfaces

The maximum number of IPv6 service interfaces allowed on an adapter card

Max Number of IPv6 Total Interfaces

The maximum number of total IPv6 interfaces allowed on a system

VPRN Instances Supported

The total number of VPRN instances that are supported

VPLS Instances Supported

The total number of VPLS instances that are supported

Max Number of BGP Peers

The maximum number of BGP peers

Max Number of IP/Mac Filters

The maximum number of IP/MAC filters

system-resources
Syntax

system-resources slot-number

Context

tools>dump

Description

This command displays system resource information.

Default

n/a

Parameters
slot-number

specifies a specific slot to view system resources information

Output

The following output is an example of system resources information, and System-Resources Field Descriptions describes the fields.

Output Example
*A:7705# tools>dump system-resources 1/1
Mda-1/1 Resource Usage
                                 |   Total   | Allocated |    Free
  -------------------------------+-----------+-----------+------------
           Access Ingress Queues |     2048  |        0  |     2048
                   Egress Queues |     2112  |        0  |     2112
            Access Egress Queues |     2048  |        0  |     2048
           Network Egress Queues |     2048  |        0  |     2048
                     SAP Objects |      512  |        0  |      512
                VPLS SAP Objects |      128  |        0  |      128
                         (1/1/1) |      128  |        0  |      128
                         (1/1/2) |      128  |        0  |      128
                         (1/1/3) |      128  |        0  |      128
                         (1/1/4) |      128  |        0  |      128
                         (1/1/5) |      128  |        0  |      128
                         (1/1/6) |      128  |        0  |      128
                         (1/1/7) |      128  |        0  |      128
                         (1/1/8) |      128  |        0  |      128
              Network Interfaces |      128  |        0  |      128
                         Filters |       32  |        0  |       32
              Service Interfaces |      512  |        0  |      512
         IpV6 Network Interfaces |      128  |        0  |      128
         IpV6 Service Interfaces |      512  |        0  |      512
                   Shaper Groups |       64  |        0  |       64
Table 11. System-Resources Field Descriptions

Label

Description

Access Ingress Queues

The number of access ingress queues allowed on an adapter card (total, allocated, and free)

Egress Queues

The number of egress queues allowed on an adapter card (total, allocated, and free)

Access Egress Queues

The number of access egress queues allowed on an adapter card (total, allocated, and free)

Network Egress Queues

The number of network egress queues allowed on an adapter card (total, allocated, and free)

SAP Objects

The number of SAP objects allowed on an adapter card (total, allocated, and free)

VPLS SAP Objects

The number of VPLS SAP objects allowed on an adapter card (total, allocated, and free)

Network Interfaces

The number of network interfaces allowed on an adapter card (total, allocated, and free)

Filters

The number of filters allowed on an adapter card (total, allocated, and free)

Service Interfaces

The number of service interfaces allowed on an adapter card (total, allocated, and free)

IpV6 Network Interfaces

The number of IPv6 network interfaces allowed on an adapter card (total, allocated, and free)

IpV6 Service Interfaces

The number of IPv6 service interfaces allowed on an adapter card (total, allocated, and free)

Shaper Groups

The number of shaper groups allowed on an adapter card (total, allocated, and free)

testhead
Syntax

testhead test-name test-name [test-owner test-owner]

Context

tools>dump

Description

This command displays Y.1564 test head debug statistics.

Default

n/a

Parameters
test-name

specifies a Y.1564 test by name

test-owner

specifies a Y.1564 test owner

Dump Test-OAM Commands
test-oam
Syntax

test-oam

Context

tools>dump

Description

This command enables the context to display operations, administration, and maintenance information.

Default

n/a

testhead
Syntax

testhead test-name test-name [test-owner test-owner]

Context

tools>dump>test-oam

Description

This command displays Y.1564 test head debug statistics.

Default

n/a

Parameters
name-of-the-test

the name of the Y.1564 test

owner-of-the-test

the owner of the Y.1564 test

twamp
Syntax

server error-counters

Context

tools>dump>test-oam

Description

This command displays server information, specifically the number of protocol errors, for the TWAMP server. The output includes statistics for dropped connections, dropped connection states, rejected sessions, and dropped test packets.

Default

n/a

Dump Router Commands
router
Syntax

router router-instance

router service-name service-name

Context

tools>dump

Description

This command enables tools for the router instance.

Default

n/a

Parameters
router-instance

specifies the router name and service ID

Values

router-name:      Base, management

service-id:          1 to 2147483647

Default

Base

service-name

specifies the service name

bgp
Syntax

bgp

Context

tools>dump>router

Description

This command enables dump tools for BGP.

Default

n/a

routes
Syntax

routes [family] received [url file-url]

Context

tools>dump>router>bgp

Description

This command displays information for BGP routes.

Default

n/a

Parameters
received

displays information about received routes

family

specifies the family for which information is displayed

Values

ipv4, vpn-ipv4, ipv6, vpn-ipv6, or mvpn-ipv4

url file-url

the URL of the file

Values

file-url:

local-url | remote-url

   local-url:

[cflash-id/][file-path

       200 chars max, including cflash-id

       directory length 99 chars max each

   remote-url:

[{ftp:// | tftp://}login:pswd@remote- locn][file-path]

        255 chars max

        directory length 99 chars max each

   remote-locn:  

[hostname | ipv4-address | ipv6-address]

   ipv4-address:

a.b.c.d

   ipv6-address:  

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x: [0 to FFFF]H

d: [0 to 255]D

interface: 32 chars max, for link local addresses

   cflash-id:

(7705 SAR-18)  cf1: | cf1-A: | cf1-B: | cf2: | cf2-A: | cf2-B: | cf3: | cf3-A: | cf3-B:

(7705 SAR-8 Shelf V2)  cf3: | cf3-A: | cf3-B:

(7705 SAR fixed platforms)  cf3: | cf3-A:

fib
Syntax

fib slot-number [ipv4 | ipv6] summary

Context

tools>dump>router

Description

This command displays information for the FIB.

Default

n/a

Parameters
slot-number

specifies the slot number, always ‟1”

ipv4 | ipv6

specifies the IP family

summary

displays summary information

ldp
Syntax

ldp

Context

tools>dump>router

Description

This command enables dump tools for LDP.

Default

n/a

fec
Syntax

fec vc-type vc-type agi agi

fec p2mp-id identifier root ip-address

fec root ip-address source ip-address group mcast-address inner-root ip-address

fec prefix ip-address[/mask]

fec root ip-address source ip-address group mcast-address [rd rd]

fec vc-type vc-type vc-id vc-id

fec p2mp-id identifier root ip-address [rd rd] inner-root ip-address

Context

tools>dump>router>ldp

Description

This command displays information for an LDP FEC.

Parameters
vc-type

specifies the VC type

Values

ethernet, vlan, framerelay, atm-all5, atm-cell, hdlc, ppp, cem, atm-vcc, atm-vpc, ipipe, atm-vcc-1-1, atm-vpc-1-1, atm-aal5-pdu, fr, cep, e1-satop, t1-satop, e3-satop, t3-satop, cesopsn, tdmoip, cesopsn-cas, tdmoip-cas, fr-dlci, mirror

agi

specifies the attachment group identifier TLV associated with this service FEC

Values

ip-addr:comm-val | 2byte-asnumber:ext-comm-val | 4byte-asnumber:comm-val

ip-addr                             : a.b.c.d

comm-val                        : 0 to 65535

2byte-asnumber              : 1 to 65535

ext-comm-val                  : 0 to 4294967295

4byte-asnumber             :  1 to 4294967295

null - means all value is 0

identifier

specifies the identifier of the LDP point-to-multipoint LSP

Values

0 to 4294967295

root ip-address

specifies the root IP address

source ip-address

specifies the source IP address

group mcast-address

specifies the group multicast address

inner-root ip-address

specifies the inner root IP address of the FEC

ip-address[/mask]

specifies the IP prefix and prefix length associated with the prefix FEC

Values

ipv4-prefix:

a.b.c.d

ipv4-prefix-length:

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:

128

rd

specifies the route distinguisher value

Values

ip-addr:comm-val | 2byte-asnumber:ext-comm-val | 4byte-asnumber:comm-val

vc-id

specifies the VC identifier

Values

1 to 4294967295

Output

The following output is an example of LDP FEC information.

Output Example
A:Dut-A# tools dump router ldp fec root 10.20.1.3 source 10.0.101.10 group
192.168.1.1 inner-root 10.20.1.6
P2MP: root: 10.20.1.3, T: 7, L: 21 (InnerRoot: 10.20.1.6 T: 3, L:8, Src:
10.0.101.10, Grp: 192.168.1.1)
  Create Time   : 01/27/16 16:39:04.097 (elapsed: 0d 03:20:24)
  Last Mod. Time: 01/27/16 16:39:04.097 (elapsed: 0d 03:20:24)
  FEC Flags     : Pop UprStitched
  TunlIfId: 73728   (OperState : up)
  LSP ID        : 0
  LSP ID Acct.  : 0
  isIngressMttm : No         HasLeaf     : Yes
  isIngrItermdte: No
  CanProgIngress: No
  InPhopFrr     : No
  isStitchedUpr : Yes
  RslvdPhop(p)  : 10.20.1.2:0 (seqNum 2)
  RslvdPhop(b)  : 0.0.0.0:0 (seqNum 0)
  pri Upstream  : 10.20.1.2:0, AdvLabel 262139
  mbb Upstream  : None
  bkp Upstream  : None
  AdvInLabel(p) : 262139
  AdvInLabel(b) : 0
  PrgInLabel(p) : 1
  Num Resolved   Nhops  : 1
  Num MBB Req.   Nhops  : 0
  Num Programmed Nhops  : 1
    Programmed Nhop[01] : 0.0.0.0:0, OutLabel 0 (Leaf)(StitchedFec)
  Metric        : 0          Mtu         : 0
  Num of Peers : 1
  FEC Peer: 10.20.1.2:0
    Peer Flags: none  (0x0)
    ModTime   : 01/27/16 16:39:04.097 (elapsed.: 0d 03:20:24)
    ->Num Egress Labels:
      None
    <-Num Ingress Labels:
      <- (Label: 262139    Status: UsePop)
      Rej Status: OK
      Flow Label Tx: no, Rx: no
      Flow Label Tx Sent: no, Rx Sent: no
    <Resolved as CUR Upstream>
instance
Syntax

instance

Context

tools>dump>router>ldp

Description

This command displays information for an LDP instance.

Default

n/a

interface
Syntax

interface [ip-int-name | ip-address]

Context

tools>dump>router>ldp

Description

This command displays information for an LDP interface.

Default

n/a

Parameters
ip-int-name

specifies the interface name

ip-address

specifies the IP address

memory-usage
Syntax

memory-usage

Context

tools>dump>router>ldp

Description

This command displays memory usage information for LDP.

Default

n/a

peer
Syntax

peer ip-address

Context

tools>dump>router>ldp

Description

This command displays information for an LDP peer.

Default

n/a

Parameters
ip-address

specifies the IP address

session
Syntax

session [ip-address |:label space] [connection | peer | adjacency]

Context

tools>dump>router>ldp

Description

This command displays information for an LDP session.

Default

n/a

Parameters
ip-address

specifies the IP address of the LDP peer

label-space

specifies the label space identifier that the router is advertising on the interface

connection

displays connection information

peer

displays peer information

adjacency

displays hello adjacency information

sockets
Syntax

sockets

Context

tools>dump>router>ldp

Description

This command displays information for all sockets being used by the LDP protocol.

Default

n/a

timers
Syntax

timers

Context

tools>dump>router>ldp

Description

This command displays timer information for LDP.

Default

n/a

mpls
Syntax

mpls

Context

tools>dump>router

Description

This command enables the context to display MPLS information.

Default

n/a

ftn
Syntax

ftn [endpoint endpoint | sender sender | nexthop nexthop | lsp-id lsp-id | tunnel-id tunnel-id | label start-label end-label]

Context

tools>dump>router>mpls

Description

This command displays FEC-to-NHLFE (FTN) dump information for MPLS. (NHLFE is the acronym for Next Hop Label Forwarding Entry.)

Default

n/a

Parameters
endpoint

specifies the IP address of the last hop

Values

a.b.c.d

sender

specifies the IP address of the sender

Values

a.b.c.d

nexthop

specifies the IP address of the next hop

Values

a.b.c.d

lsp-id

specifies the label switched path that is signaled for this entry

Values

0 to 65535

tunnel-id

specifies the SDP ID

Values

0 to 65535

start-label end-label

specifies the label range for the information dump

Values

start-label — 32 to 131071

end-label — 32 to 131071

ilm
Syntax

ilm [endpoint endpoint | sender sender | nexthop nexthop | lsp-id lsp-id | tunnel-id tunnel-id | label start-label end-label]

Context

tools>dump>router>mpls

Description

This command displays incoming label map (ILM) information for MPLS.

Default

n/a

Parameters
endpoint

specifies the IP address of the last hop

Values

a.b.c.d

sender

specifies the IP address of the sender

Values

a.b.c.d

nexthop

specifies the IP address of the next hop

Values

a.b.c.d

lsp-id

specifies the label switched path that is signaled for this entry

Values

0 to 65535

tunnel-id

specifies the SDP ID

Values

0 to 65535

start-label end-label

specifies the label range for the information dump

Values

start-label — 32 to 131071

end-label — 32 to 131071

lspinfo
Syntax

lspinfo [lsp-name] [detail]

Context

tools>dump>router>mpls

Description

This command displays LSP information for MPLS.

Default

n/a

Parameters
lsp-name

the LSP identifier

Values

up to 32 characters (must be unique)

detail

displays detailed LSP information

memory-usage
Syntax

memory-usage

Context

tools>dump>router>mpls

Description

This command displays memory usage information for MPLS.

Default

n/a

ospf
Syntax

ospf

Context

tools>dump>router

Description

This command enables the context to display tools information for OSPF.

Default

n/a

ospf3
Syntax

ospf3

Context

tools>dump>router

Description

This command enables the context to display tools information for OSPFv3.

Default

n/a

abr
Syntax

abr [detail]

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays area border router (ABR) information for OSPF.

Default

n/a

Parameters
detail

displays detailed information about the ABR

area-range
Syntax

area-range

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays area range information for OSPF.

Default

n/a

asbr
Syntax

asbr [detail]

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays autonomous system boundary router (ASBR) information for OSPF.

Default

n/a

Parameters
detail

displays detailed information about the ASBR

bad-packet
Syntax

bad-packet interface-name

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays information about bad packets for OSPF.

Default

n/a

Parameters
interface-name

displays only the bad packets identified by this interface name

leaked-routes
Syntax

leaked-routes [summary | detail]

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays information about leaked routes for OSPF.

Default

summary

Parameters
summary

displays a summary of information about leaked routes for OSPF

detail

displays detailed information about leaked routes for OSPF

memory-usage
Syntax

memory-usage [detail]

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays memory usage information for OSPF.

Default

n/a

Parameters
detail

displays detailed information about memory usage for OSPF

request-list
Syntax

request-list [neighbor ip-address] [detail]

request-list virtual-neighbor ip-address area-id area-id [detail]

request-list [detail]

request-list neighbor [interface-name] [router-id] [detail]

request-list virtual-neighbor router-id transit-area transit-area [detail]

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays request list information for OSPF.

Default

n/a

Parameters
neighbor ip-address

displays OSPF neighbor information only for the neighbor identified by the IP address

neighbor interface-name

displays OSPFv3 neighbor information only for the neighbor identified by the IP interface name

detail

displays detailed information about the neighbor or virtual neighbor

virtual-neighbor ip-address

displays OSPF information about the virtual neighbor identified by the IP address

virtual-neighbor router-id

displays OSPFv3 information about the virtual neighbor identified by the IP router identifier

area-id area-id

displays OSPF information about the area identified by the area ID, expressed in dotted-decimal notation or as a 32-bit decimal integer

transit-area transit-area

displays OSPFv3 information about the transit area identified by the router ID, expressed in dotted-decimal notation or as a 32-bit decimal integer

retransmission-list
Syntax

retransmission-list [neighbor ip-address] [detail]

retransmission-list virtual-neighbor ip-address area-id area-id [detail]

retransmission-list [detail]

retransmission-list neighbor [ip-int-name] [router-id] [detail]

retransmission-list virtual-neighbor router-id transit-area transit-area [detail]

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays dump retransmission list information for OSPF.

Default

n/a

Parameters
neighbor ip-address

displays OSPF neighbor information only for the neighbor identified by the IP address

neighbor ip-int-name

displays OSPFv3 neighbor information only for the neighbor identified by the IP interface name

detail

displays detailed information about the neighbor or virtual neighbor

virtual-neighbor ip-address

displays OSPF information about the virtual neighbor identified by the IP address

virtual-neighbor router-id

displays OSPFv3 information about the virtual neighbor identified by the router identifier

area-id area-id

displays the OSPF information about the area ID, expressed in dotted-decimal notation or as a 32-bit decimal integer

transit-area transit-area

displays the OSPFv3 information about the transit area ID, expressed in dotted-decimal notation or as a 32-bit decimal integer

route-summary
Syntax

route-summary

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays dump route summary information for OSPF.

Default

n/a

route-table
Syntax

route-table [ip-prefix/mask] [type] [detail] [alternative]

route-table [ipv6-prefix/prefix-length] [type] [detail] [alternative]

Context

tools>dump>router>ospf

tools>dump>router>ospf3

Description

This command displays dump information about routes learned through OSPF.

Default

n/a

Parameters
ip-prefix/mask

the IPv4 prefix and mask for routes learned through OSPF

Values

ip-prefix             a.b.c.d   (host bits must be 0)

mask                 0 to 32

ipv6-prefix/prefix-length

the IPv6 prefix and prefix length for routes learned through OSPFv3

Values

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

prefix-length      0 to 128

type

the type of route table to display information about

Values

intra-area, inter-area, external-1, external-2, nssa-1, nssa-2

detail

displays detailed information about learned routes

alternative

displays LFA details

sham-bad-packet
Syntax

sham-bad-packet interface-name

Context

tools>dump>router>ospf

Description

This command displays OSPFv2 sham link bad packets.

Parameters
interface-name

displays only the sham link bad packets identified by this interface name

sr-adjacencies
Syntax

sr-adjacencies [ip-int-name | ip-address] [detail]

sr-adjacencies [remote ip-address] [detail]

Context

tools>dump>router>ospf

Description

This command displays OSPFv2 segment routing (SR) adjacency information.

Parameters
ip-int-name

the IP interface name, 32 characters maximum

ip-address

the IP address of the neighbor

Values

a.b.c.d

detail

displays detailed information about SR adjacencies

sr-database
Syntax

sr-database [sid sid] [detail]

Context

tools>dump>router>ospf

Description

This command displays OSPFv2 segment routing (SR) database information.

Parameters
sid

the segment routing identifier

Values

0 to 524287

detail

displays detailed information about learned routes

pim
Syntax

pim

Context

tools>dump>router

Description

This command enables the context to display PIM information.

Default

n/a

iom-failures
Syntax

iom-failures [detail]

Context

tools>dump>router>pim

Description

This command displays information about failures in programming IOMs.

Unlike the 7750 SR, when the maximum number of groups per node is exceeded, any additional groups are not stored at the CSM layer and an alarm is raised immediately.

Default

n/a

Parameters
detail

displays detailed information about IOM failures

rsvp
Syntax

rsvp

Context

tools>dump>router

Description

This command enables the context to display tools information for RSVP.

Default

n/a

neighbor
Syntax

neighbor [ip-address] [detail]

Context

tools>dump>router>rsvp

Description

This command displays neighbor information for RSVP.

Default

n/a

Parameters
ip-address

the IP address of the neighbor

Values

a.b.c.d

detail

displays detailed information about the neighbor

psb
Syntax

psb [endpoint endpoint-address] [sender sender-address] [tunnelid tunnel-id] [lspid lsp-id]

Context

tools>dump>router>rsvp

Description

This command displays path state block (PSB) information for RSVP.

When a PATH message arrives at an LSR, the LSR stores the label request in the local PSB for the LSP. If a label range is specified, the label allocation process must assign a label from that range.

The PSB contains the IP address of the previous hop, the session, the sender, and the TSPEC. This information is used to route the corresponding RESV message back to LSR 1.

Default

n/a

Parameters
endpoint-address

specifies the IP address of the last hop

sender-address

specifies the IP address of the sender

tunnel-id

specifies the SDP ID

Values

0 to 4294967295

lsp-id

specifies the label switched path that is signaled for this entry

Values

1 to 65535

rsb
Syntax

rsb [endpoint endpoint-address] [sender sender-address] [tunnelid tunnel-id] [lspid lsp-id]

Context

tools>dump>router>rsvp

Description

This command displays RSVP Reservation State Block (RSB) information.

Default

n/a

Parameters
endpoint-address

specifies the IP address of the last hop

sender-address

specifies the IP address of the sender

tunnel-id

specifies the SDP ID

Values

0 to 4294967295

lsp-id

specifies the label switched path that is signaled for this entry

Values

1 to 65535

segment-routing
Syntax

segment-routing

Context

tools>dump>router

Description

This command enables the context to display tools information for segment routing.

tunnel
Syntax

tunnel

Context

tools>dump>router>segment-routing

Description

This command displays segment routing tunnel information.

static-route
Syntax

static-route

Context

tools>dump>router

Description

This command enables the context to display tools information for static routes.

Default

n/a

ldp-sync-status
Syntax

ldp-sync-status

Context

tools>dump>router>static-route

Description

This command displays the status of the LDP synchronization timers for static routes.

Default

n/a

te-database
Syntax

te-database [adv-router adv-router] [neighbor neighbor] [detail]

Context

tools>dump>router

Description

This command displays information for the traffic engineering database.

Default

n/a

Parameters
adv-router

ip-address or isis-system-id

neighbor

ip-address or isis-system-id

detail

displays detailed information about the neighbor

isis
Syntax

isis [instance isis-instance] [level level]

Context

tools>dump>router>te-database

Description

This command displays information for the IS-IS traffic engineering database.

Default

n/a

Parameters
isis-instance

0 to 31

level

1 or 2

ospf
Syntax

ospf [area area-id] [instance ospf-instance]

Context

tools>dump>router>te-database

Description

This command displays information for the OSPF traffic engineering database.

Default

n/a

Parameters
area-id

ip-address or (0 to 4294967295)

ospf-instance

a unique integer that identifies a specific instance of a version of the OSPF protocol running in the router instance specified by the virtual router identifier

Values

0 to 31

Tools Perform Commands

Perform Commands
perform
Syntax

perform

Context

tools

Description

This command enables the context to specify tools to perform specific tasks.

Default

n/a

aps
Syntax

aps

Context

tools>perform

Description

This command enables the context to perform APS operations.

Default

n/a

clear
Syntax

clear aps-id {protect | working}

Context

tools>perform>aps

Description

This command removes all APS operational commands.

Default

n/a

Parameters
aps-id

the specified APS group

protect

the physical port acting as a protection circuit for the APS group

working

the physical port acting as a working circuit for the APS group

exercise
Syntax

exercise aps-id {protect | working}

Context

tools>perform>aps

Description

This command performs an exercise request on the protection or working circuit.

Default

n/a

Parameters
aps-id

the specified APS group

protect

the physical port acting as a protection circuit for the APS group

working

the physical port acting as a working circuit for the APS group

force
Syntax

force aps-id {protect | working}

Context

tools>perform>aps

Description

This command forces a switch to either the protection or working circuit.

Default

n/a

Parameters
aps-id

the specified APS group

protect

the physical port acting as a protection circuit for the APS group

working

the physical port acting as a working circuit for the APS group

lockout
Syntax

lockout aps-id

Context

tools>perform>aps

Description

This command locks out the protection circuit in the specified APS group.

Default

n/a

Parameters
aps-id

the specified APS group

request
Syntax

request aps-id {protect | working}

Context

tools>perform>aps

Description

This command requests a manual switch to either the protection or working circuit.

Default

n/a

Parameters
aps-id

the specified APS group

protect

the physical port acting as a protection circuit for the APS group

working

the physical port acting as a working circuit for the APS group

cron
Syntax

cron

Context

tools>perform

Description

This command enables the context to perform CRON (scheduling) control operations.

Default

n/a

action
Syntax

action

Context

tools>perform>cron

Description

This command enables the context to stop the execution of a script started by CRON action. See the stop command.

Default

n/a

stop
Syntax

stop [action-name] [owner action-owner] [all]

Context

tools>perform>cron>action

Description

This command stops execution of a script started by CRON action.

Default

n/a

Parameters
action-name

specifies the action name

Values

maximum 32 characters

action-owner

specifies the owner name

Default

TiMOS CLI

all

specifies to stop all CRON scripts

cflowd
Syntax

cflowd

Context

tools>perform

Description

This command enables the context to perform cflowd control operations.

Default

n/a

manual-export
Syntax

manual-export

Context

tools>perform>cflowd

Description

This command manually exports cflowd flow data.

eth-ring
Syntax

eth-ring

Context

tools>perform

Description

This command enables the context to perform Ethernet ring operations.

Default

n/a

clear
Syntax

clear ring-index

Context

tools>perform>eth-ring

Description

This command is used for the following operations on an Ethernet ring node:

  • clearing an active local administrative command (for example, forced switch or manual switch)

  • triggering reversion before the WTR or WTB timer expires in case of revertive operation

  • triggering reversion in case of non-revertive operation

Default

n/a

Parameters
ring-index

specifies the Ethernet ring index

Values

1 to 128

force
Syntax

clear ring-index path {a | b}

Context

tools>perform>eth-ring

Description

This command forces a block on the ring port where the command is issued.

Default

n/a

Parameters
ring-index

specifies the Ethernet ring index

Values

1 to 128

path {a | b}

displays information for the specified path

manual
Syntax

clear ring-index path {a | b}

Context

tools>perform>eth-ring

Description

In the absence of a failure or FS, this command forces a block on the Ethernet ring port where the command is issued.

Default

n/a

Parameters
ring-index

specifies the Ethernet ring index

Values

1 to 128

path {a | b}

displays information for the specified path

ima
Syntax

ima

Context

tools>perform

Description

This command enables the context to perform IMA operations.

Default

n/a

reset
Syntax

reset bundle-id

Context

tools>perform>ima

Description

This command resets an IMA bundle in the startup state.

Default

n/a

Parameters
bundle-id

specifies the IMA bundle ID

Syntax:          bundle-ima-slot/mda.bundle-num

                        bundle-ima          keyword

                        bundle-num        1 to 32

lag
Syntax

lag

Context

tools>perform

Description

This command configures tools to control LAG.

Default

n/a

clear-force
Syntax

clear-force all-mc

clear-force lag-id lag-id [sub-group sub-group-id]

clear-force peer-mc ip-address

Context

tools>perform>lag

Description

This command clears a forced status.

Default

n/a

Parameters
all-mc

clears all multi-chassis LAG information

lag-id

specifies an existing LAG ID

Values

1 to 32

sub-group-id

specifies a LAG subgroup

Values

1 or 2 (for access ports), 1 to 4 (for network ports)

ip-address

specifies the IP address of a multi-chassis peer

force
Syntax

force all-mc {active | standby}

force lag-id lag-id [sub-group sub-group-id] {active | standby}

force peer-mc peer-ip-address {active | standby}

Context

tools>perform>lag

Description

This command forces an active or standby status.

Default

n/a

Parameters
all-mc

forces an active or standby status for all multi-chassis LAGs

peer-ip-address

specifies a multi-chassis peer by its IP address

lag-id

specifies an existing LAG ID

Values

1 to 32

sub-group-id

specifies a LAG subgroup

Values

1 or 2 (for access ports), 1 to 4 (for network ports)

active

forces the specified LAG, LAG subgroup, multi-chassis LAG peer, or all multi-chassis LAGs to active status

standby

forces the specified LAG, LAG subgroup, multi-chassis LAG peer, or all multi-chassis LAGs to standby status

lcr
Syntax

lcr

Context

tools>perform

Description

This command enables the context to perform T1/E1 Line Card Redundancy (LCR) operations.

Default

n/a

clear
Syntax

clear lcr-id {protect | working}

Context

tools>perform>lcr

Description

This command removes all LCR operational commands from either the protection adapter card or the working adapter card in the specified LCR group.

Default

n/a

Parameters
lcr-id

the specified LCR group, from 1 to 6

protect

clears operational commands from the adapter card acting as a protection card for the LCR group

working

clears operational commands from the adapter card acting as a working card for the LCR group

force
Syntax

force lcr-id {protect | working}

Context

tools>perform>lcr

Description

This command forces activity away from either the protection adapter card or the working adapter card in the specified LCR group.

Default

n/a

Parameters
lcr-id

the specified LCR group, from 1 to 6

protect

forces activity away from the adapter card acting as a protection card for the LCR group

working

forces activity away from the adapter card acting as a working card for the LCR group

lockout
Syntax

lockout lcr-id

Context

tools>perform>lcr

Description

This command locks out the protection adapter card. Locking out the protection card means that activity cannot be switched to the protection card even if the working adapter card has failed.

Default

n/a

Parameters
lcr-id

the specified LCR group, from 1 to 6

log
Syntax

log

Context

tools>perform

Description

This command enables event logging tools.

Default

n/a

test-event
Syntax

test-event

Context

tools>perform>log

Description

This command generates a test event.

Default

n/a

mda-table-refresh
Syntax

mda-table-refresh

Context

tools>perform

Description

This command causes a complete FIB refresh. The command can be used to restore a FIB that is in a failed state. For information on FIB failures, see the 7705 SAR Router Configuration Guide, ‟Troubleshooting the FIB”.

Default

n/a

mw
Syntax

mw

Context

tools>perform

Description

This command enables the context to perform microwave operations.

Default

n/a

clear
Syntax

clear mw-link-id {main | spare} {eps | tps | rps}

Context

tools>perform>mw

Description

This command removes all microwave link operational commands.

Default

n/a

Parameters
mw-link-id

specifies an existing microwave link ID

Values

id = 1 to 24

main

specifies that the role of the MPR-e radio in a 1+1 HSB configuration is main

spare

specifies that the role of the MPR-e radio in a 1+1 HSB configuration is spare

eps

specifies that the protection scheme in a 1+1 HSB configuration is Equipment Protection Switching

tps

specifies that the protection scheme in a 1+1 HSB configuration is Transmission Protection Switching

rps

specifies that the protection scheme in a 1+1 HSB configuration is Radio Protection Switching

force
Syntax

force mw-link-id {eps | tps | rps}

Context

tools>perform>mw

Description

This command forces the spare MPR-e radio to become the main MPR-e radio in a 1+1 HSB configuration, even though it might not be in a fit state to assume the role. Once a forced switch operation is issued, it overrides any manual switch or automatic switch operation that is already in place.

Default

n/a

Parameters
mw-link-id

specifies an existing microwave link ID

Values

id = 1 to 24

eps

specifies that the protection scheme in a 1+1 HSB configuration is Equipment Protection Switching

tps

specifies that the protection scheme in a 1+1 HSB configuration is Transmission Protection Switching

rps

specifies that the protection scheme in a 1+1 HSB configuration is Radio Protection Switching

lockout
Syntax

lockout mw-link-id {eps | tps | rps}

Context

tools>perform>mw

Description

This command prevent the spare MPR-e radio in a 1+1 HSB configuration from ever becoming the main radio, even when the main MPR-e radio fails.

Default

n/a

Parameters
mw-link-id

specifies an existing microwave link ID

Values

id = 1 to 24

eps

specifies that the protection scheme in a 1+1 HSB configuration is Equipment Protection Switching

tps

specifies that the protection scheme in a 1+1 HSB configuration is Transmission Protection Switching

rps

specifies that the protection scheme in a 1+1 HSB configuration is Radio Protection Switching

manual
Syntax

manual mw-link-id {main | spare} {eps | tps | rps}

Context

tools>perform>mw

Description

This command attempts to switch the main/spare status of an MPR-e radio in a 1+1 HSB configuration; however, should certain operational conditions pertaining to the radio channel or radio hardware not allow the switchover (such as port failures, equipment failures, and reception failures), an automatic switch operation overriding the manual switch attempt is triggered.

Default

n/a

Parameters
mw-link-id

specifies an existing microwave link ID

Values

id = 1 to 24

main

specifies that the role of the MPR-e radio in a 1+1 HSB configuration is main

spare

specifies that the role of the MPR-e radio in a 1+1 HSB configuration is spare

eps

specifies that the protection scheme in a 1+1 HSB configuration is Equipment Protection Switching

tps

specifies that the protection scheme in a 1+1 HSB configuration is Transmission Protection Switching

rps

specifies that the protection scheme in a 1+1 HSB configuration is Radio Protection Switching

software-download
Syntax

software-download [force]

Context

tools>perform>mw

Description

This command performs a software download to all MPR-e radios in the system that are not currently running the correct software. The software is downloaded to the inactive software bank of the MPR-e radios, in preparation of a software upgrade (the command does not activate a system upgrade).

This command allows operators to minimize outage times during a 7705 SAR system software upgrade (with Microwave Awareness). Before the software upgrade is performed, the operator runs this command to download the software to the radios while they are in service. Next, the operator performs the software upgrade. During the 7705 SAR system reboot, the new radio software is activated at the same time as the new system software, thus allowing both the system software and the MPR-e radio software to boot into the new load simultaneously.

Default

n/a

Parameters
force

forces a software download to all MPR-e radios regardless of the software version that they are currently running

ptp
Syntax

ptp reset-clk-rec clock-id clock-id

Context

tools>perform

Description

This command resets a PTP clock that is transmitting and receiving PTP messages using IPv4 or IPv6 encapsulation or using Ethernet encapsulation.

Default

n/a

Parameters
clock-id

specifies the PTP clock ID

Values

1 to 16 for PTP clocks that use IPv4 or IPv6 encapsulation

csm for a PTP clock that uses Ethernet encapsulation

security
Syntax

security

Context

tools>perform

Description

This command provides tools for testing security.

Default

n/a

authentication-server-check
Syntax

authentication-server-check server-address ip-address [port port] {{user-name user-name password password} | attr-from-file file-url}} secret key [source-address ip-address] [timeout seconds] [router router-instance | service-name service-name]

Context

tools>perform>security

Description

This command checks connection to the RADIUS server.

Default

n/a

Parameters
ip-address

specifies the source IP address of the DHCP relay messages

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

port

specifies the port ID

Values

1 to 65535

user-name

specifies the DHCP client

Values

253 characters maximum

password

specifies the CLI access password

Values

64 characters maximum

key

specifies the authentication key

Values

20 characters maximum

seconds

specifies the timeout in seconds

Values

1 to 90

router-instance

specifies the router name or service ID

Values

router-name:      Base, management

service-id:          1 to 2147483647

Default

Base

service-name

specifies the service name

file-url

the URL of the file

Values

file-url:

local-url | remote-url

   local-url:

[cflash-id/][file-path

       200 chars max, including cflash-id

       directory length 99 chars max each

   remote-url:

[{ftp:// | tftp://}login:pswd@remote- locn][file-path]

        255 chars max

        directory length 99 chars max each

   remote-locn:  

[hostname | ipv4-address | ipv6-address]

   ipv4-address:

a.b.c.d

   ipv6-address:  

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x: [0 to FFFF]H

d: [0 to 255]D

interface: 32 chars max, for link local addresses

   cflash-id:

(7705 SAR-18)  cf1: | cf1-A: | cf1-B: | cf2: | cf2-A: | cf2-B: | cf3: | cf3-A: | cf3-B:

(7705 SAR-8 Shelf V2)  cf3: | cf3-A: | cf3-B:

(7705 SAR fixed platforms)  cf3: | cf3-A:

service
Syntax

service

Context

tools>perform

Description

This command enables the context to configure tools for services.

id
Syntax

id service-id

Context

tools>perform>service

Description

This command enables the context to configure tools for a specific service.

Parameters
service-id

specifies an existing service ID

Values

1 to 2147483647or a name string up to 64 characters long

endpoint
Syntax

endpoint endpoint-name

Context

tools>perform>service>id

Description

This command enables the context to configure tools for a specific service endpoint.

Parameters
endpoint-name

specifies an existing service endpoint name

force-switchover
Syntax

force-switchover sdp-id:vc-id

no force-switchover

Context

tools>perform>service>id

Description

This command forces a switch of the active spoke SDP for the specified service.

Parameters
sdp-id:vc-id

specifies an existing spoke SDP for the service

Values

sdp-id:          1 to 17407

vc-id:            1 to 4294967295

ip-transport
Syntax

ip-transport ipt-id

Context

tools>perform>service>id

Description

This command enables the context to configure tools for a specific IES or VPRN IP transport subservice.

Parameters
ipt-id

specifies the IP transport subservice physical port identifier

Values

value in the format slot/mda/port.channel

remote-host
Syntax

remote-host host-id check-tcp

Context

tools>perform>service>id>ip-transport

Description

This command establishes a TCP connection to the remote host. The connection is torn down upon being successfully established. This command does not abide by the max-retries or retry-interval configured for the IP transport subservice; only one connection attempt, with a timeout of 5 seconds, is made when this command is executed.

If a TCP connection is already established to the remote host, this command does not impact that connection. It returns a successful status indication, with an explanation that a TCP connection was already established.

Default

n/a

Parameters
host-id

the remote host identifier

Values

1 to 2147483647or a name string up to 64 characters long

check-tcp

establishes a TCP connection to the remote host

sap
Syntax

sap sap-id cem asym-delay-adjust

Context

tools>perform>service>id

Description

This command performs a one-time ADC analysis on a TDM PW without having to shut down the service. This analysis is done with live traffic (that is, not with all-ones or the idle-payload-fill value). If the difference between the calculated average latency and the expected latency is greater than the threshold-repeat value configured with the asym-delay-control command, octets are added or dropped as necessary.

The service must already be enabled for ADC. If ADC repeat is also enabled on the service when this command is run, the timer for the next repeat period starts when the on-demand analysis ends.

Default

n/a

Parameters
sap-id

the Cpipe SAP ID

Values

cem

port-id|bridge-id

port-id

slot/mda/port

bridge-id

slot/mda/bridge.branch

cem asym-delay-adjust

performs an ADC analysis on the service

system
Syntax

system

Context

tools>perform

Description

This command enables the context to use tools that control the system.

management-interface
Syntax

management-interface

Context

tools>perform>system

Description

This command enables access to the management interface tools.

snmp
Syntax

snmp

Context

tools>perform>system>management-interface

Description

This command enables access to the SNMPv3 tools.

change-key
Syntax

change-key authentication authentication-protocol old-authentication-key new-authentication-key

change-key authentication authentication-protocol privacy privacy-protocol old-privacy-key new-privacy-key

Context

tools>perform>system>management-interface>snmp

Description

This command generates KeyChange strings to change SNMPv3 authentication or privacy keys. The SNMP engine ID is not needed because localized keys are required as input. The KeyChange algorithm uses a random string so the output is different each time the command is run.

Parameters
authentication-protocol

specifies the SNMPv3 authentication protocol

Values

hmac-md5-96 — specifies use of the HMAC-MD5-96 authentication protocol

hmac-sha1-96 — specifies use of the HMAC-SHA1-96 authentication protocol

hmac-sha2-224 — specifies use of the HMAC-SHA2-224 authentication protocol

hmac-sha2-256 — specifies use of the HMAC-SHA2-256 authentication protocol

hmac-sha2-384 — specifies use of the HMAC-SHA2-384 authentication protocol

hmac-sha2-512 — specifies use of the HMAC-SHA2-512 authentication protocol

old-authentication-key

specifies the old localized authentication key

new-authentication-key

specifies the new localized authentication key

privacy-protocol

specifies the SNMPv3 privacy protocol

Values

cbc-des — specifies use of the CBC-DES privacy protocol; this parameter is not available in FIPS-140-2 mode

cfb128-aes-128 — specifies use of the CFB128-AES-128 privacy protocol

cfb128-aes-192 — specifies use of the CFB128-AES-192 privacy protocol

cfb128-aes-256 — specifies use of the CFB128-AES-256 privacy protocol

old-privacy-key

specifies the old localized privacy key

new-privacy-key

specifies the new localized privacy key

generate-key
Syntax

generate-key authentication authentication-protocol authentication-password [privacy privacy-protocol privacy-password] [engine-id identifier]

Context

tools>perform>system>management-interface>snmp

Description

This command generates localized SNMPv3 authentication and privacy keys, which are a hash of the SNMP engine ID and a password. The SNMP engine ID can be displayed with the show system information | match "SNMP Engine ID" command and does not need to be entered. If keys are being generated for a different system, its SNMP engine ID must be specified.

Parameters
authentication-protocol

specifies the SNMPv3 authentication protocol

Values

hmac-md5-96 — specifies use of the HMAC-MD5-96 authentication protocol

hmac-sha1-96 — specifies use of the HMAC-SHA1-96 authentication protocol

hmac-sha2-224 — specifies use of the HMAC-SHA2-224 authentication protocol

hmac-sha2-256 — specifies use of the HMAC-SHA2-256 authentication protocol

hmac-sha2-384 — specifies use of the HMAC-SHA2-384 authentication protocol

hmac-sha2-512 — specifies use of the HMAC-SHA2-512 authentication protocol

authentication-password

specifies the password used to generate the authentication key, from 8 to 255 characters

privacy-protocol

specifies the SNMPv3 privacy protocol

Values

cbc-des — specifies use of the CBC-DES privacy protocol; this parameter is not available in FIPS-140-2 mode

cfb128-aes-128 — specifies use of the CFB128-AES-128 privacy protocol

cfb128-aes-192 — specifies use of the CFB128-AES-192 privacy protocol

cfb128-aes-256 — specifies use of the CFB128-AES-256 privacy protocol

privacy-password

specifies the privacy password, from 8 to 255 characters

identifier

specifies an SNMP engine ID; must be a hexadecimal string from 10 to 64 digits

script-control
Syntax

script-control

Context

tools>perform>system

Description

This command enables the script-control context to access script policy commands.

script-policy
Syntax

script-policy

Context

tools>perform>system>script-control

Description

This command enables the script-policy context to access script policy tools.

stop
Syntax

stop [policy-name] [owner policy-owner] [all]

Context

tools>perform>system>script-control>script-policy

Description

This command stops the execution of scripts.

Parameters
policy-name

specifies to only stop scripts with the specified script policy name

policy-owner

specifies to only stop scripts for script policies with the specified owner

all

specifies to stop all running scripts

Perform Router Commands
router
Syntax

router router-instance

router service-name service-name

Context

tools>perform

Description

This command enables tools for the router instance.

Default

n/a

Parameters
router-instance

specifies the router name and service ID

Values

router-name:      Base, management

service-id:           1 to 2147483647

Default

Base

service-name

specifies the service name

isis
Syntax

isis [isis-instance]

Context

tools>perform>router

Description

This command enables the context to perform specific IS-IS tasks.

Default

n/a

Parameters
isis-instance

specifies the IS-IS protocol instance ID. If no isis-instance is specified, instance 0 is used.

Values

1 to 31

mpls
Syntax

mpls

Context

tools>perform>router

Description

This command enables the context to perform specific MPLS tasks.

Default

n/a

cspf
Syntax

cspf to ip-addr [from ip-addr] [bandwidth bandwidth] [include-bitmap bitmap] [exclude-bitmap bitmap] [hop-limit limit] [exclude-address excl-addr [excl-addr...(up to 8 max)]] [use-te-metric] [strict-srlg] [srlg-group grp-id...(up to 8 max)] [exclude-node excl-node-id [excl-node-id...(up to 8 max)]] [skip-interface interface-name] [cspf-req-type req-type] [least-fill-min-thd thd]

Context

tools>perform>router>mpls

Description

This command computes a CSPF path with specified user constraints.

Default

n/a

Parameters
to ip-addr

the destination IP address

Values

a.b.c.d

from ip-addr

the originating IP address

Values

a.b.c.d

bandwidth

the amount of bandwidth in megabits per second (Mb/s) to be reserved

Values

0 to 4294967295 (values can be expressed in decimal, hexadecimal, or binary)

include-bitmap bitmap

specifies to include a bitmap that lists the admin groups that should be included during the CSPF computation

exclude-bitmap bitmap

specifies to exclude a bitmap that lists the admin groups that should be included during the CSPF computation

limit

the total number of hops an FRR bypass or detour LSP can take before merging back onto the main LSP path

Values

1 to 255

excl-addr

an IP address to exclude from the CSPF computation (up to a maximum of eight addresses in one command)

Values

a.b.c.d (outbound interface)

use-te-metric

specifies to use the traffic engineering metric used on the interface

strict-srlg

specifies to use strict frr-srlg to compute a new CSPF path

grp-id

specifies to use up to eight SRLGs to compute a new CSPF path

Values

0 to 4294967295

excl-node-id

a node to exclude from the CSPF computation (up to a maximum of eight nodes in one command)

Values

a.b.c.d (outbound interface)

interface-name

a local interface name (rather than the address) to exclude from the CSPF computation

Values

max 32 characters

req-type

the CSPF request type

Values

all – all ECMP paths

random – random ECMP paths

least-fill – specifies whether the use of the least-fill path selection method for the computation of the path for this CSPF request is enabled

thd

the percentage difference below which two links are considered equal for least-fill bandwidth comparison. When comparing the percentages of least available link bandwidth across available paths, whenever two percentages differ by less than the value configured as the least-fill minimum threshold, CSPF considers them to be equal and applies a random number generator to select the path.

Values

1 to 100

resignal
Syntax

resignal {lsp lsp-name path path-name | delay minutes}

resignal {sr-te-lsp srte-lsp-name path path-name | sr-te-delay minutes}

Context

tools>perform>router>mpls

Description

This command resignals specified LSP paths. If the lsp or sr-te-lsp parameters are used, the specified LSP path is resignaled immediately. The delay or sr-te-delay parameter is used to override the global timer to resignal all LSPs of the corresponding type. The resignal timer is the time before resignaling occurs after the resignal condition occurs. For the delay option to work, the resignal time in the config>router>mpls context must be set.

The resignal timer is then reset to its configured value in the MPLS configuration. In this case, the new path is programmed in the datapath only if the metric of the new path is different from the metric of the current path.

Default

n/a

Parameters
lsp-name

specifies the name of an existing LSP

path-name

specifies the path name that is used for the LSP; this path must already have been configured

minutes

specifies the delay interval, in minutes, before all LSPs of the corresponding type are resignaled. If the value 0 is entered, all LSPs of the corresponding type are resignaled immediately.

Values

0 to 30

srte-lsp-name

specifies the name of an existing SR-TE LSP

resignal-bypass
Syntax

resignal-bypass delay minutes

resignal-bypass lsp bypass-lsp-name [force]

Context

tools>perform>router>mpls

Description

This command performs a manual reoptimization of a specific dynamic or manual bypass LSP or of all dynamic bypass LSPs.

The manual bypass LSP name is user-configured. The dynamic bypass LSP name is shown in the output of the show>router>mpls>bypass-tunnel dynamic detail command.

The delay option triggers the global reoptimization of all dynamic bypass LSPs at the expiry of the specified delay. This option forces the global bypass resignal timer to expire after an amount of time equal to the value of the delay parameter. This option does not apply to a manual bypass LSP.

When a bypass LSP name is specified, that dynamic or manual bypass LSP is not signaled and the associations are not evaluated even if the new bypass LSP path has the same cost as the current one. This is a different behavior from the resignal command for the primary or secondary path of an LSP, because a bypass LSP can have a large number of PSB associations.

If the specified LSP is a manual bypass LSP with no PSB associations, the LSP is torn down and resignaled using the new path provided by CSPF. If there are one or more PSB associations but the PLR is not active, the command fails and the user is asked to explicitly enter the force option. In this case, the manual bypass LSP is torn down and resignaled, leaving the associated LSP primary paths temporarily unprotected. If there are any active PLRs associated with the manual bypass LSP, the command fails

Default

n/a

Parameters
minutes

the time that MPLS waits before attempting to resignal dynamic bypass LSP paths originated on the system

Values

0 to 30

bypass-lsp-name

the name of the dynamic or manual bypass LSP

force

required when the LSP is a manual bypass LSP with PSB associations

sr-te-cspf
Syntax

sr-te-cspf [path-computation-method path-computation-method] to ip-address [path path-name] [from ip-address] [include-bitmap bitmap] [exclude-bitmap bitmap] [hop-limit limit] [metric-type-te] [strict-srlg] [srlg-group group-id] [local-sr-protection local-sr-protection] [ label-stack-reduction] [max-sr-labels label-stack-size]

Context

tools>perform>router>mpls

Description

This command computes and returns the segment routing label stack for any user-specified MPLS path to a destination router.

By default, or when the path-computation-method is set to ip-to-label, MPLS passes the path information specified with the to and from parameters to the TE-DB, which converts the list of hops to a label stack by scanning the database for adjacency and node SID information that belongs to the router or link identified by each hop address. If the conversion is successful, the database returns the actual selected hop SIDs plus labels, as well as the configured path hop addresses that were used as the input for this conversion. None of the TE constraint parameters are used in this path computation method.

When the user specifies the value of local-cspf for the path-computation-method parameter, MPLS passes all parameters of the tools command, including the TE constraint parameters. In this case, a full local CSPF is run using these parameters.

When the user specifies a path name with this command, CSPF returns a single path, which is selected randomly similar to a configured SR-TE LSP, with the path-computation-method local-cspf command enabled. When no path name is specified with this command, CSPF returns the set of candidate ECMP paths.

Parameters
path-computation-method

specifies the path computation method of the LSP path

Values

ip-to-label, local-cspf

to ip-address

specifies the destination IP address

path-name

specifies the path name

from ip-address

specifies the originating IP address

bitmap

specifies a decimal, hexadecimal, or binary bit-map of the admin groups that should be included in or excluded from the path computation

Values

0 to 4294967295

hop-limit

specifies the maximum number of hops for the path

Values

0 to 255

metric-type-te

specifies the use of the traffic engineering metric to optimize the path. By default, the link IGP metric is used.

strict-srlg

specifies the computation of a path that is strictly disjoint from links which are members of the entered SRLG

group-id

specifies up to eight SRLGs that path computation should avoid, or must avoid if the strict-srlg option is enabled

Values

0 to 4294967295

local-sr-protection

specifies the local LFA protection for the CSPF-computed explicit path with adjacency SIDs

Values

preferred, mandatory, none

label-stack-reduction

applies label stack reduction to the CSPF-computed explicit path with adjacency SIDs

label-stack-size

specifies the maximum label stack size of the CSPF-computed path with or without label stack reduction

Values

1 to 11

trap-suppress
Syntax

trap-suppress number-of-traps time-interval

Context

tools>perform>router>mpls

Description

This command modifies thresholds for trap suppression. The command is used to suppress traps after the specified number of traps has been raised within the specified period of time.

Default

n/a

Parameters
number-of-traps

specifies the number of traps in multiples of 100. An error message is generated if an invalid value is entered.

Values

100 to 1000

time-interval

specifies the time interval in seconds

Values

1 to 300

update-path
Syntax

update-path {lsp lsp-name path current-path-name new-path new-path-name}

Context

tools>perform>router>mpls

Description

This command instructs MPLS to replace the path of a primary or secondary LSP. The primary or secondary LSP path is indirectly identified with the current-path-name value. The same path name cannot be used more than once for an LSP name.

This command applies to both a CSPF LSP and a non-CSPF LSP. The command only works when the specified current-path-name has the adaptive option enabled. The adaptive option can be enabled at the LSP level or the path level.

The new path must have been configured in the CLI or provided via SNMP. The CLI command for entering the path is config>router>mpls>path path-name.

The command fails if any of the following conditions exist:

  • the specified current-path-name of this LSP does not have the adaptive option enabled

  • the specified new-path-name value does not correspond to a previously defined path

  • the specified new-path-name value exists but is being used by any path of the same LSP, including this one

When you execute this command, MPLS performs the following procedures.

  • MPLS performs a single MBB attempt to move the LSP path to the new path.

  • If the MBB is successful, MPLS updates the new path.

    • MPLS writes the corresponding NHLFE in the data path if this path is the current backup path for the primary path.

    • If the current path is the active LSP path, MPLS will update the path and write the new NHLFE in the data path, which will cause traffic to switch to the new path.

  • If the MBB is not successful, the path retains its current value.

    The update-path MBB has the same priority as the manual resignal MBB.

Parameters
lsp-name

specifies the administrative name for this LSP

current-path-name

specifies the name of the current path

new-path-name

specifies the name of the new path

ospf
Syntax

ospf

Context

tools>perform>router

Description

This command enables the context to perform specific OSPF tasks.

Default

n/a

ldp-sync-exit
Syntax

ldp-sync-exit

Context

tools>perform>router>ospf

tools>perform>router>isis

Description

This command terminates IGP-LDP synchronization. OSPF or IS-IS then advertises the actual cost value of the link for all interfaces that have IGP-LDP synchronization enabled, if the currently advertised cost is different.

Default

n/a

refresh-lsas
Syntax

refresh-lsas [lsa-type] [area-id]

Context

tools>perform>router>ospf

Description

This command refreshes LSAs for OSPF.

Default

n/a

Parameters
lsa-type

the specified LSA type

Values

router, network, summary, asbr, extern, nssa, opaque

area-id

the OSPF area ID expressed in dotted-decimal notation or as a 32-bit integer

Values

0.0.0.0 to 255.255.255.255 (dotted-decimal), 0 to 4294967295 (decimal integer)

run-manual-spf
Syntax

run-manual-spf [externals-only]

Context

tools>perform>router>ospf

tools>perform>router>isis

Description

This command runs the shortest path first (SPF) algorithm for OSPF or IS-IS.

The externals-only parameter applies only to OSPF.

Default

n/a

Parameters
externals-only

specifies the route preference for OSPF external routes

Tools ADP Commands

auto-discovery
Syntax

auto-discovery [retry] [terminate]

Context

tools

Description

This command is used to control ADP while it is running.

The retry keyword restarts ADP if it has been halted due to errors. Executing this command clears the rejected DHCP server list for all ports and retries any processing that failed.

The terminate keyword terminates ADP and removes the ADP keyword from the BOF. The router returns to normal operations and any temporary configuration is removed. Network configuration and remote access remain enabled to allow the router to be manually provisioned remotely. ADP will not run again on future system restarts unless it is re-enabled via the CLI.

Default

n/a

Parameters
retry

resumes ADP after being halted for errors

terminate

terminates ADP and removes the ADP keyword from the BOF

auto-discovery echo
Syntax

[no] auto-discovery echo [debugger]

Context

tools

Description

This command enables ADP echoing, which sends periodic updates to the console. The default is for ADP to echo progress summaries and major events. For troubleshooting, the optional debugger parameter causes ADP to echo detailed progress reports with events and timestamps. The command reverts to the default settings each time ADP is run on the system.

The no form of this command disables ADP echoing.

Default

auto-discovery echo

Parameters
debugger

enables ADP echoing of detailed progress reports with events and timestamps