Gated Interactive Interface

The Gated Interactive Interface (GII) provides an interactive interface to a running Gated daemon which can be used to query internal gated variables. This interface, which is implemented like any other protocol in Gated, accepts telnet connections to port 616 (C.f. [RFC 854] for a description of the telnet protocol), and, after user identification, answers any query sent as ASCII commands. The commands include querying about the memory, routing table, interface list and other internal parameters.

Configuration

GII will identify the user by using the Unix password of the gii ID of the system. In other words, when using the GII interface, one must create a 'gii' account and set up its password that will be used when connecting to the GII.

Connection to the GII

Users open a telnet connection to the machine running gated, on TCP port 616. They identify themselves using a simple password scheme, and get the Gated prompt. The GII is them ready to accept queries. Here is an example of such a session.

(lpj@obelix: 53) telnet radb2.ra.net 616 Trying 198.108.0.9... Connected to radb2.ra.net. Escape character is '^]'. Password? 100 Gated Interactive Interface. Version R3_5Alpha_10 GateD> sh ip 100 HELP: The possible subcommands are: 100 route [x.x.x/len]: Show info about IP routes 100 walkup x.x.x/len: Show less specific routes 100 walkdown x.x.x/len: Show more specific routes GateD>

Getting help

The top level command help  provides a list of available commands. Commands may be followed by subcommands. To get help about the subcommand, just type the main command without subcommand. GII will display a list of available subcommands. Commands may be abbreviated when no confusion is possible.

Gated Internals

The following command will display parameters related to the internal structure of gated:

show version

shows the version of the running Gated.

show kernel

shows the type of kernel of the host, including what features are supported (Reject routes, Multicast, UDP checksums, etc...).

show memory

shows the memory usage, divided by memory block structures.

show task

shows the running tasks in Gated.

Interfaces

The following command will display parameters related to the interfaces:

show interface [name|index]

Without parameter this command lists all the interfaces of the system. If one interface name or index is given as an argument, all parameters concerning this interface are displayed.

Routing table

The following command will display parameters related to the routing table:

show ip route [x.x.x/len]

Without parameter this command prints the size of the IP routing table. With an argument which must be a prefix number and mask length, it displays the complete information about the given route like number of announcements, next hop, AS path, active route, etc...

show ip walkup x.x.x/len

List all the routes less specific than x.x.x/len, i.e the aggregates which contain x.x.x/len.

show ip walkdown x.x.x/len

Lists all the routes more specific than x.x.x/len, i.e all the components of the aggregate x.x.x/len. show ip walkdown 0/0 will display the whole routing table. ^C can be used to stop the listing.

Some examples:

GateD> sh ip walkdown 0/0 100 Sta 0.0.0.0/0 192.231.253.2 IGP (Id 1) 100 Sta 127/8 127.0.0.1 IGP (Id 1) 100 RIP 141.211/16 192.231.253.2 IGP (Id 1) 100 RIP 141.212/16 192.231.253.2 IGP (Id 1) 100 RIP 141.213/16 192.231.253.2 IGP (Id 1) 100 RIP 141.214/16 192.231.253.2 IGP (Id 1) 100 Dir 192.231.253/24 192.231.253.50 IGP (Id 1) 100 Dir 198.108/24 198.108.0.9 IGP (Id 1) 100 RIP 198.108.60/24 192.231.253.2 IGP (Id 1) GateD> GateD> sh ip walkdown 141/8 100 RIP 141.211/16 192.231.253.2 IGP (Id 1) 100 RIP 141.212/16 192.231.253.2 IGP (Id 1) 100 RIP 141.213/16 192.231.253.2 IGP (Id 1) 100 RIP 141.214/16 192.231.253.2 IGP (Id 1) GateD> GateD> sh ip walkup 192.231.253/24 100 Dir 192.231.253/24 192.231.253.50 IGP (Id 1) 100 Sta 0.0.0.0/0 192.231.253.2 IGP (Id 1) GateD> GateD> sh ip ro 198.108.60/24 100 Route 198.108.60 - 255.255.255 entries 1 Announced 1 Depth 0 <> 100 * RIP 192.231.253.2 192.231.253.2 4/0 0 10:25:13 IGP (Id 1)

DVMRP

show dvmrp mfc

List all Multicast forwarding Cache defined.

show dvmrp targets

List all the DVMRP targets (interfaces).

Other

quit

to close the GII session.

OSPF

These commands are only available for the new OSPF shipped with gated version 3_6Alpha_2 and higher.

show ospf global

Show general OSPF parameter like Router ID, preference, flags, etc...

show ospf interface [x.x.x.x]

Without parameter shows the list of interfaces configured for OSPF, and their parameter (Timing interval, states, etc...). With an IP address as a parameter it shows the list of neighbours on that interface and their parameters and states.

show ospf area [x.x.x.x]

Without parameter shows the list of area configured on that router. with an area number as a parameter, it show the interfaces for that area as well as the full dump of the link state database. (area number are in the same format as IP addresses)