Tools

Tools Command Reference

Command Hierarchies

  1. Tools Dump Commands
  2. Tools Perform Commands
  3. Tools ADP Commands

Tools Dump Commands

tools
— dump
— auto-discovery [detail] [log]
— 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
— ldp
— fec prefix ip-prefix/mask
— fec vc-type {ethernet | vlan} vc-id vc-id
— 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]
— 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 [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]
— static-route
— ldp-sync-status
— service
— loopback
— system-resources slot-number
— system-limits
— service id id {sap sap-id | sdp sdp-id} stats
— 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}
— cron
— action
— stop [action-name] [owner action-owner] [all]
— 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}
— log
— test-event
— 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...(up to 8 max)] [use-te-metric] [strict-srlg] [srlg-group grp-id...(up to 8 max)] [exclude-node 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}
— trap-suppress number-of-traps time-interval
— 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

Tools ADP Commands

tools
— auto-discovery [retry] [terminate]
— [no] auto-discovery echo [debugger]

Command Descriptions

  1. Tools Dump Commands
  2. Tools Perform Commands
  3. Tools ADP Commands

Tools Dump Commands

  1. Generic Commands
  2. Dump Commands
  3. Dump Router Commands

Generic Commands

tools

Syntax 
tools
Context 
<root>
Description 

This command creates the context to enable useful tools for debugging purposes.

Default 

n/a

Dump Commands

dump

Syntax 
dump
Context 
tools
Description 

This command creates 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

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.

Sample Output

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 12.12.12.10/32
Discovered Paths:
===================
 
Id   PathDst           Egr-NextHop       Reply-Rtr-Addr    DisCovery-Time 
       discoveryTtl      ProbeState        ProbeTmOutCnt     RtnCode 
===  ================  ================  ================  ===============
001         127.1.0.5         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
002         127.1.0.9         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
003        127.1.0.15         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
004        127.1.0.19         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
005        127.1.0.24         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
…….
051       127.1.0.243         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
052       127.1.0.247         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
053       127.1.0.252         10.10.1.2       12.12.12.10 12/19/2006 05:11:01
                 007                OK                00          EgressRtr
054       127.1.0.255         10.10.1.2       12.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 
Sample Output

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 12.12.12.10/32 path-destination 127.1.0.5
FEC: 12.12.12.10/32  PathDst: 127.1.0.5
==================================================
Protocol Legend: L - LDP, R - RSVP, U - Not Applicable 
 
HopId    HopAddr          TTL  Label1   Label2   Label3   Label4   Label5
=====   ================  ===  =======  =======  =======  =======  =======
277          12.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.

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 Table 33 describes the fields.

Sample Output
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
Sample Record Key Output
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              : 1.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 33:  DHCP Server Persistence Output Fields  

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.

Output 

The following output is an example of persistence summary information, and Table 34 describes the fields.

Sample Output
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 34:  Persistence Summary Output Fields  

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 reading

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     slo/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.

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.

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

system-limits

Syntax 
system-limits
Context 
tools>dump
Description 

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

Note:

  1. The system-limits command is only available on the following 7705 SAR systems:
    1. 7705 SAR-8 (CSMv1 and CSMv2)
    2. 7705 SAR-18
Default 

n/a

Output 

The following output is an example of system limits information, and Table 35 describes the fields.

Sample Output
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 35:  System-Limits Output Fields  

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

service

Syntax 
service id id {sap sap-id | sdp sdp-id} stats
Context 
tools>dump
Description 

This command displays discard statistics for a specified SAP or SDP binding.

Default 

n/a

Parameters 
id—
specifies the service identifier
sap-id—
specifies the SAP identifier
sdp-id—
specifies the SDP binding identifier
Output 

The following output is an example of the discard statistics, and Table 36 describes the fields.

Sample Output
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 36:  Service Output Fields  

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

testhead

Syntax 
testhead test-name test-name [test-owner test-owner]
Context 
tools>dump
Description 

This command displays Y.1564 test head debug statistics.

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.

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.

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
Values—
Base
service-name—
specifies the service name

ldp

Syntax 
ldp
Context 
tools>dump>router
Description 

This command enables dump tools for LDP.

Default 

n/a

fec

Syntax 
fec prefix ip-prefix/mask
fec vc-type {ethernet | vlan} vc-id vc-id
Context 
tools>dump>router>ldp
Description 

This command displays information for an LDP FEC.

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
vc-type—
specifies the VC type signaled for the spoke or mesh binding to the far end of an SDP. The VC type is a 15-bit quantity containing a value that represents the type of VC. The actual signaling of the VC type depends on the signaling parameter defined for the SDP. If signaling is disabled, the vc-type command can still be used to define the dot1q value expected by the far-end provider equipment. A change of the binding’s VC type causes the binding to signal the new VC type to the far end when signaling is enabled.

VC types are derived according to IETF draft-martini-l2circuit-trans-mpls.

Values—
Ethernet — 0x0005
VLAN — 0x0004
vc-id—
specifies the virtual circuit identifier
Values—
1 to 4294967295

instance

Syntax 
instance
Context 
tools>dump>router>ldp
Description 

This command displays information for an LDP instance.

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

abr

Syntax 
abr [detail]
Context 
tools>dump>router>ospf
Description 

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

Default 

n/a

Parameters 
detail—
displays detailed information about the ABR

asbr

Syntax 
asbr [detail]
Context 
tools>dump>router>ospf
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
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
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
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]
Context 
tools>dump>router>ospf
Description 

This command displays request list information for OSPF.

Default 

n/a

Parameters 
neighbor ip-address—
displays neighbor information only for the neighbor identified by the IP address
detail—
displays detailed information about the neighbor or virtual neighbor
virtual-neighbor ip-address—
displays information about the virtual neighbor identified by the IP address
area-id—
the OSPF area 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]
Context 
tools>dump>router>ospf
Description 

This command displays dump retransmission list information for OSPF.

Default 

n/a

Parameters 
neighbor ip-address—
displays neighbor information only for the neighbor identified by the IP address
detail—
displays detailed information about the neighbor or virtual neighbor
virtual-neighbor ip-address—
displays information about the virtual neighbor identified by the IP address
area-id—
the OSPF area ID expressed in dotted-decimal notation or as a 32-bit decimal integer

route-summary

Syntax 
route-summary
Context 
tools>dump>router>ospf
Description 

This command displays dump route summary information for OSPF.

Default 

n/a

route-table

Syntax 
route-table [type] [detail]
Context 
tools>dump>router>ospf
Description 

This command displays dump information about routes learned through OSPF.

Default 

n/a

Parameters 
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

pim

Syntax 
pim
Context 
tools>dump>router
Description 

This command enables the context to display PIM information.

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.

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

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.

Tools Perform Commands

  1. Perform Commands
  2. Perform Router 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.

clear

Syntax 
clear aps-id {protect | working}
Context 
tools>perform>aps
Description 

This command removes all APS operational commands.

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.

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.

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.

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.

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.

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.

Parameters 
action-name—
specifies the action name
Values—
maximum 32 characters
action-owner—
specifies the owner name
Values—
TiMOS CLI
all —
specifies to stop all CRON scripts

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.

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

log

Syntax 
log
Context 
tools>perform
Description 

This command enables event logging tools.

test-event

Syntax 
test-event
Context 
tools>perform>log
Description 

This command generates a test event.

mw

Syntax 
mw
Context 
tools>perform
Description 

This command enables the context to perform microwave operations.

clear

Syntax 
clear mw-link-id {main | spare} {eps | tps | rps}
Context 
tools>perform>mw
Description 

This command removes all microwave link operational commands.

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.

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.

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.

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.

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

security

Syntax 
security
Context 
tools>perform
Description 

This command provides tools for testing security.

authentication-server-check

Syntax 
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]
Context 
tools>perform>security
Description 

This command checks connection to the RADIUS server.

Parameters 
server-address ip-address—
specifies the server ID
Values—
a.b.c.d
port—
specifies the port ID
Values—
1 to 65535
dhcp-client-user-name—
specifies the DHCP client
Values—
256 characters maximum
password—
specifies the CLI access password
Values—
10 characters maximum
key—
specifies the authentication key
Values—
20 characters maximum
source-address ip-address—
specifies the source IP address of the DHCP relay messages
Values—
a.b.c.d
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
Values—
Base
service-name—
specifies the service name

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 2147483647

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

Perform PTP Commands

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 either IPv4 encapsulation or Ethernet encapsulation.

Default 

n/a

Parameters 
clock-id—
specifies the PTP clock ID
Values—
1 to 16 for PTP clocks that use IPv4 encapsulation
csm for a PTP clock that uses Ethernet encapsulation

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
Values—
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.

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...(up to 8 max)] [use-te-metric] [strict-srlg] [srlg-group grp-id...(up to 8 max)] [exclude-node 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
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}
Context 
tools>perform>router>mpls
Description 

This command resignals specified LSP paths. The minutes parameter is used to configure the global timer to resignal all LSPs. The resignal timer is the time before resignaling occurs after the resignal condition occurs. If only lsp-name and path-name are provided, the specified LSP is resignaled immediately. For the delay option to work, the resignal time in the config>router>mpls context must be set.

Default 

n/a

Parameters 
lsp-name—
specifies a unique LSP name, up to 32 characters
path-name—
specifies the name for the LSP path, up to 32 characters
minutes—
specifies the delay interval, in minutes, before all LSPs are resignaled. If the value 0 is entered, all LSPs are resignaled immediately.
Values—
0 to 30

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

ospf

Syntax 
ospf
Context 
tools>perform>router
Description 

This command enables the context to perform specific OSPF tasks.

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.

refresh-lsas

Syntax 
refresh-lsas [lsa-type] [area-id]
Context 
tools>perform>router>ospf
Description 

This command refreshes LSAs for OSPF.

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.

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