Telnet Server Command Reference
The Telnet Server uses a text-based command-line interface to provide information about devices and networks in maps that are open in Intermapper.
The following is a summary of the features and functions available from the Telnet Server, as shown through the server's help system. For each command listed below, click [ details ] to view the server help for that command:
Welcome to the Intermapper [version #] operations interface.
Enter 'help' for command list.
> help
========ERROR - Shows a report of all devices and links that exceed some threshold. This report is updated every minute. For detailed information about the fields and columns of this report, type "help error". This is the default command when you connect.[ details ](Abbreviations: "E", "ERR")
FULL - Shows a report of all devices and links being monitored. [ details ] (Abbreviations: "F")
NODE <name-prefix> - Shows a report of the named device using the same format as the "ERROR" report. This report is updated every time Intermapper polls the device.
[ details ] (Abbreviations: "N")
BUS <name-prefix> - Shows a report of the named network or segment using the same format as the "ERROR" report. This report is updated every minute.
[ details ](Abbreviations: "B")
DOWN- Lists all devices that are down. The same functionality is also provided by the ERRORS command. [ details ]
LDOWN- Lists all interfaces (ie links) that are down. The same functionality is also provided by the ERRORS command. [ details ]
LOG [] - Displays the last entries from the event log window and continuously displays new log lines. [ details ]
KALI [<conn> [ "compress" | "kill" ] ] - Displays list of Kali connections and allows you to debug them. [ details ]
KALID
- Displays a list of the maps, log, lists, and other shared resources open by each
Remote connection.
[ details ]
HELP [ <topic> ] - Without a parameter, the help command displays this help text. If you include the
name of the command as the parameter, it displays detailed information about the
format of the report generated by it. [ details ]
QUIT- End the telnet session and disconnect. [ details ]
RELOAD - Closes all map files and reopens them. This command is only implemented in the
server/daemon version of Intermapper. [ details ]
REMOTE <hostname> [ <port> ] - Initiates a remote connection with a client at hostname, listening on <port>, rather than the usual procedure of a client initiating a connection with the server. This is useful when the server is behind a firewall. Intermapper Support may occasionally ask you to do this in order to let us take a look at your system without requiring you to adjust your firewall. If the port is not specified, it is assumed to be 8181.
DETAILS < "net" | "graph" | "collaborator" | "smtp" | "probe" >
- Toggles detailed logging to the debug log for the indicated class
of events. Intermapper Support may occasionally ask you to do this in order
to provide us with more detailed information about what is happening
when you run Intermapper.SERVER <server> < "start" | "stop" | "status" > [ <port> ] [ "secure" ]
- Start, stop or change one of the three servers: Web, Telnet or Remote. [ details ]
TELNET
- Displays a list of current connections to the Telnet server. [ details ]
USERS [<UID>] - Displays a list of users with user IDs. Include the user ID to delete the user.WEB - Displays a list of current connections to the Web server. [ details ]
Command Details
> help error
The ERROR, FULL, NODE, and BUS commands emit a report with three parts: (1) a status line summarizing the condition of the entire network (2) a node report (3) a link report.
Example:
Jul 31 11:11:58 2 nodes, 1 down, 8 links, 0 down, 461 pk/s, 141 K by/s Name Stat SysUpTime Probe Address egg-1 DOWN 0+00:00:00 ICMP 127.110.13.210
Name Prt Stat TPkt TBytes TErr TDis RPkt RBytes RErr RDis Util Segment egg-1 1 UP 46 13790 0 0 67 10152 12* 0 1% 127.0.13.0/24 egg-1 2 UP 78 8330 0 0 586 144524 14* 0 12% 127.0.14.0/24
(1) THE STATUS LINE
Jul 31 11:11:58 2 nodes, 1 down, 8 links, 0 down, 461 pk/s, 141 K by/s
In order, these fields are: - the date and time of the report - the total number of devices - the number of devices which are down - the total number of links - the number of links which are down - the sum of pkts per second transmitted on all links - the sum of bytes per second transmitted on all links
(2) NODE REPORT
Name Stat SysUpTime Probe Address
The columns are: Name - the name of the device Stat - the status of the device (UP, DOWN, or ACK) SysUpTime - the number of days + hh:mm:ss that the device has been running Probe - the type of probe used to check the device Address - the address of the device (where the probes are sent)
(3) LINK REPORT
Name Prt Stat TPkt TBytes TErr TDis RPkt RBytes RErr RDis Util Segment
The columns are: Name - the name of the device Prt - the interface number Stat - the status of the interface (UP, DOWN, or ACK) TPkt - the number of pkts per second transmitted on this interface TBytes - the number of bytes per second transmitted on this interface TErr - the number of packets per minute lost due to errors TDis - the number of packets per minute dropped due to resource limitations RPkt - the number of pkts per second received on this interface RBytes - the number of bytes per second received on this interface RErr - the number of packets per minute received with an error RDis - the number of packets per minute dropped due to resource limitations Util - the percentage utilization of the interface Segment - the name of the network or segment attached to this interface
The * following a value indicates that the value is above the threshold. This is useful because it tells you why the link is being displayed as part of the error report.
> help down
The DOWN command lists all devices which currently have the 'DOWN' or 'DOWN-ACK' status.
Each line of the DOWN list has the format:
mm/dd hh:mm:ss DOWN <Device-Name>
For devices which are acknowledged down, the following format is used:
mm/dd hh:mm:ss DOWN-ACK <Device-Name>
> help
HELP [<topic>]
- Without a parameter, the help command displays this help text. If you include the name of the command as the parameter, it displays detailed information about the format of the report generated by it.
> help kali
KALI [[ "compress" | "kill" ] ]
Displays a list of current Intermapper Remote Access connections and allows you to monitor them.
When you enter "KALI" without any arguments, the response is a list of the current Intermapper Remote Access connections in the form:
ID USER REMOTE ADDRESS IN OUT LOGIN@ 366a58 <listener> <server-port 8181> 0 0 - 485d58 Guest 198.115.166.18:58619 20339 177408 Oct 02, 15:51:12 2d18b8 <listener> <server-port 8181> 0 0 -
The second and third columns identify the user and their source IP address. The two users marked "<listener>" are the server's two pending listening connections for port 8181. The first column of output is the identifier for the connection. To monitor an existing connection, type "KALI <conn>" where <conn> is a connection ID. To monitor the next new connection to the server, use "next" for the connection ID; i.e. type "KALI NEXT". Monitoring a remote connection turns off compression for the data stream; this makes it easier to see the actual traffic. To leave compression enabled when while monitoring, include the "compress" option; i.e. type "KALI <conn> COMPRESS". To forcibly disconnect an existing connection, type "KALI <conn> KILL". This command will terminate the remote connection and release its resources on the server.
> help kalid
Displays a list of the maps, log, lists, and other shared resources open by each Remote connection.
Here is some sample output:
+ CKaliOpenMapList [2d6008] user='Guest' [ADMIN] - [485d58] Guest@198.115.166.18:58619 + CKaliOpenLogList [351cd8] addr='198.115.166.18' user='Guest' [ADMIN] - [485d58] Guest@198.115.166.18:58619 + CKaliOpenSoundSetList [351d68] - [485d58] Guest@198.115.166.18:58619
This indicates that the remote connection [485d58] is responsible for an "open map list", an "open log list", and an "open sound list". Essentially, this means that client will be notified of any changes to those lists. If this user had opened a map, you would see them registered for that "open map"; i.e. they would be notified of any changes.
Multiple connections may be registered for the same resource, the output above only shows the server state with one connection.
> help ldown
The LDOWN command lists all interfaces which currently have the 'DOWN' status. The LDOWN report does not include interfaces which are hidden and therefore not being polled.
Each line has the following format:
mm/dd hh:mm:ss DOWN <Device-Name>:<ifIndex>:<ifDescr>
<ifIndex> is the index of the interface in the interface table, and <ifDescr> is a description of the interface.
> help log
Displays the last <num-lines> entries from the event log window and continuously displays new log lines. The format of the LOG output is exactly the same as the format of the "Event Log" window of the Intermapper program.
> help quit
QUIT
- End the telnet session and disconnect.
> help reload
RELOAD Closes all map files and reopens them. This command is only implemented in the server/daemon version of Intermapper. This command is for experimental purposes. You should avoid using it; it may go away in future versions.
> help server
SERVER <server> < "start" | "stop" | "status" > [ <port> ] [ "secure" ]
Start, stop or change one of the three servers: Web, Telnet or Remote. To start a server on the same or different port number (with SSL/TLS disabled), type: server <server> start <port>
To start the server with SSL/TLS enabled, type:
server <server> start <port> secure
In both cases, <server> must be one of "web", "telnet" or "remote".
To stop a server, type:
server <server> stop
Note: You cannot stop the Telnet server using the SERVER command. However, you can restart the telnet server on a different port number. When you do this, your own telnet connection will be disconnected immediately.
To receive a quick status report on all three servers, type "server status". This command combines the output of the "web", "telnet" and "kali" commands.
> help telnet
TELNET Displays a list of current connections to the Telnet server.
ID USER REMOTE ADDRESS IN OUT LOGIN@ 404c28 <listener> <server-port 23> 0 0 - 3f63a8 Guest 192.168.1.21:49176 0 0 - 2d60e8 <listener> <server-port 23> 0 0 -
This command is similar in output to the KALI command. It lists the source and login ID of any existing telnet connections. However, unlike the KALI command, you cannot monitor or terminate telnet connections using the TELNET command; you can only receive a status report.
Note: The IN, OUT, and LOGIN@ stats are not implemented for the TELNET command.
> help web
WEB Displays a list of current connections to the Web server. The web server normally does not allow HTTP connections to linger, so the list of current connections should never grow very large.
ID USER REMOTE ADDRESS IN OUT LOGIN@ 38af68 <listener> <server-port 80> 0 0 - 35f518 <listener> <server-port 80> 0 0 - 478478 <listener> <server-port 80> 0 0 - 39f308 <listener> <server-port 80> 0 0 - 473e98 <listener> <server-port 80> 0 0 - 481bb8 <listener> <server-port 80> 0 0 -
This command is similar in output to the KALI command. It lists the source and login ID of any existing web connections. Since the web server has to deal with the possibility of many simultaneous hits, the number of reserve pending listeners is larger than for the other server.
Unlike the KALI command, you cannot monitor or terminate web connections using the WEB command; you can only receive a status report.
Note: The IN, OUT, and LOGIN@ stats are not implemented for the WEB command.