7.6 GateD Interactive Interface (Version 4.0)
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 6116 (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.
Table of Contents
- 7.6.1 Configuration
- How to Configure GII into your build procedure
- 7.6.2 Connection
to the gii
- Gii uses port 616 and password from gii-user by default. This section provide details on to access the
- 7.6.3 Getting help
-
- 7.6.4 Show Commands
- Quick reference list of all gii commands.
- 7.6.5 Gii related to GateD Core
- Details on GII commands related to GateD core codes (kernel,
memory, task, timers).
- 7.6.6 Gii related to Interfaces
- Interface information.
- 7.6.7 Routing tables
- Access to the IP routing table.
- 7.6.8 new ospf
- "gii" commands related to the new ospf (version 2) implementation. The older
ospf impelementation is not yet supported by gii.
- 7.6.9 bgp
- "gii" commands related to the bgp protocol and aspaths
- 7.6.10 other gii commands
- other gii commands.
7.6.1 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.
You can alter this by changing the "GII_USER" in the gii.h file.
7.6.2 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 then ready to accept queries. Here is
an example of such a session:
telnet ralph.netzone.net 616
Trying 198.108.0.9...
Connected to ralph.netzone.net.
Password?
100 GateD Interactive Interface. Version R4_0_3
GateD> help
help: Print help messages
show: Show internal values
quit: Close the session
GateD> show
version: Show the current GateD version
kernel: Show the Kernel support
interface: Show interface status"},
memory: Show the memory allocation
ip Show info about IP protocol
task Show list of active tasks"
dvmrp Show info about DVMRP protocol
ospf Show info about OSPF protocol
timer Show list of timers
bgp Show info about BGP protocol
GateD>
7.6.3 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.
7.6.4 Show Command Parameters
- version
- Show current GateD version
- kernel
- Show the kernel support.
- interface [name | address]
- Show interface status on interface specified.
- memory
- Show the allocation of memory blocks used by gated.
- ip [route | walkup | walkdown]
ip address/len
- Show the IPv4 routes in the gated routing table.
- task
- Show list of active tasks.
- dvmrp [mfc | target ]
- The gii support of the DVMRPv1is not available at this time.
DVMRPv3 support is not available in gated-uni 4.0.
- ospf [global | interfaceaddress|
area area-ID [LS_type]
Only OSPF version 2 is supported at this time.
- timer
- Show list of timers.
- bgp [ aspath [regexp] | cidr-only |
community community number |
peeras as_no |
peer-group [internal|external|internal_igp|routing|test]
routes network/network-mask
summary]
- Show information about bgp routes. See section x.x for details
on the bgp commands.
7.6.5 GateD Core
The following command will display parameters related to the internal
core 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 support
(Reject routes, Multicast, UDP chechsums, etc...).
- show memory
- Shows the memory usage, divided by memory block structures.
- show task
- shows the running tasks in GateD.
- show timers
- shows list of timers.
7.6.6 Interfaces
The following command will display parameters related to the interfaces:
- show interface [name|index]
- Without a parameter, this command lists all the interfaces of the system.
If one interface name or index is given as an argument, all the parameters
concerning this interface are displayed.
7.6.7 Routing tables
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
complete information about the given route, like number of announcements,
next hop, AS path, active route, etc...
show ip walkup x.x.x/len
Lists all the routes that are less specific than x.x.x/len, i.e.
all the components of the aggregate x.x.x/len.
show ip walkdown x.x.x/len
Lists all the routes that are 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.
7.6.8 ospf
- global
- Shows general ospf options
- interface address
- >Shows IP interface status.
- area area-ID [LS_TYPE]
- Shows area information. The ls_type can be specified, but
the restricting of information by LSA type is not yet implemented.
7.6.9 bgp
- bgp aspath [regexp]
- Show bgp aspaths that match the regular expression. If null, all
paths should be sent.
- bgp cidr-only [network/mask
- Prints only cidr routes based route table. Classful prefixes
of /8 , /16, and /24 are ignored. If no routes are specified, the
tree walks from the top of the route table. If not, it walks
from the network/mask.
- bgp community [community number]
- Show BGP routes associated with the community number specified.
Community number is specified as hex-decimal number.
- bgp peeras as_no] |
- Show bgp peer information associated with this AS such as
bgp peer address, bgp versions, gateway (3rd party)).
- bgp [peer-group [internal|external|internal_igp|routing|test]
- Show summary information about all bgp peers in grouping such as
- peer info - as, bgp version, neighbor addresses
- statistics - number of updates in/out, state.
- bgp routes network/network-mask
- Show bgp information about these routes.
- bgp summary
- Show summary information about all bgp peers such as
- peer info - as, bgp version, neighbor addresses
- statistics - number of updates in/out, state.
7.6.10 gii operations
Basic Facts
- gii port
- gii listens on port 616. Telnet to this port. User name
and password required. User name GII_USER defined
in gii.h. Default is "gii". The password protected
off the /etc/passwd file.
- Main commands:
-
help - show help screen.
show - queries GateD for current status. See below for parameters.
quit - end your telnet session.
Show - is the working command.
Syntax: show <parameter> [optional parameters]
Last updated December 4,1997
gated@gated.merit.edu