LanAtlas's Main Page Telnet Service
Version 1.00
Copyright (c) NetSoft+
  What's New What's New    Copyright/License/Warranty Copyright/License/Warranty    Download LanAtlas Download    Registration Information Purchase   

network monitoring package HM Telnet Service is an auxiliary application for LanAtlas. It is included into LanAtlas Network Monitor package. Enterprise license for LanAtlas Network Monitor already includes a license for HM Telnet Service. Holders of a Lite, Standard or Professional licenses may buy an additional license for Telnet Service separately.


Intro    Settings    Quick start    Commands    System Requirements   

telnet service This application works like Telnet server and allows you to control LanAtlas remotely using any telnet client. Telnet Service allows you to check brief or detailed status of any test and folder. Also you can disable and enable tests, reset statistics, force tests to execution and even change some parameters of the tests. HM Telnet Service allows you to start or stop monitoring process, enable or disable alerts, change global macro variables, etc.

Features:

  • All data transmission between LanAtlas and Telnet Service is encrypted and password protected;
  • LanAtlas & Telnet Service allow you to setup different user accounts with different sets of permissions;
  • Application can be installed on the LanAtlas's system or can be located on any another system that is accessible by TCP/IP protocol;
  • Telnet Service can be started as a regular application or as a Win32 service.

Settings
It is very easy to configure Telnet Service:

RCI (Remote Control Interface) settings

  • Address: here you should provide an address of the system where LanAtlas is installed (keep the default '127.0.0.1' if LanAtlas and Telnet Service are installed on the same system)
  • Port: please provide TCP port that is used by LanAtlas's Remote Control Interface (1054 by default)
  • Timeout: the maximum amount of time (in seconds) that Telnet Service will keep waiting for the reply from LanAtlas before returning an error response to the client.
Telnet server settings
  • Port: TCP port which Telnet Service utilizes to listen for incoming connections from the telnet client (default TCP port for telnet protocol is 23. You may need to change it in case you already have a regular telnet server running on the same system).

  • Application status: set "Active" to activate Telnet service (it will then start listening for incoming connections and will respond to requests from any telnet client). If you start the software as a Win32 service then telnet server will be activated regardless of this option at the system startup.

Win32 service mode:
This group of controls allows you to check the status of the Windows service, install/uninstall, start or stop the service:
  • Install / Uninstall: this button allows you to install/uninstall software as a Win32 service
  • Start / Stop: this button allows you to start/stop the service


How to do (Quick start)
To allow remote management of LanAtlas via telnet client follow these simple steps:
  • start LanAtlas
  • configure LanAtlas's Remote Control Interface on RCI page in the Options dialog

  • setup user accounts: use LanAtlas's menu "User"->"Operators"
  • start the Telnet Service. You can start it on the same system where LanAtlas is running or on any system that has TCP/IP connection with LanAtlas's system. E.g. LanAtlas can be installed on the server inside of a corporate network but Telnet Service can be running on your home computer.

  • configure Telnet Service: provide an address of the LanAtlas's system and TCP port that you had specified for RCI

That's it. Now you can start telnet client (e.g. standard client included in Windows) and connect to LanAtlas using an address of the system where Telnet Service is running (e.g. 209.173.80.15 or www.mycompany.com).
If you are running regular telnet server and our Telnet Service is installed on the same system, change the TCP port of our Telnet Service from 23 (default) to any other. In this case you will need to specify this port number for telnet client as well.


Commands

When you start telnet client and establish a connection with Telnet Service, you will be asked for your user name and password. You will then get the rights and permissions that are specified in your user account. E.g. "Admin" can perform any operations, "Guest" can only view test statuses, etc.

After logging in you may type commands that Telnet Service will execute. You will then see responses from LanAtlas.
Here are some common rules for the commands:

  • commands are not case sensitive (e.g. "stop monitoring" and "STOP Monitoring" mean the same);
  • commands that work with tests affect only tests from Current Folder (initially after session was started the root folder is current);
  • parameters of the commands (e.g. <test name> or <group name>) are indeed case sensitive;
  • parameters shown in [..] are optional, you may use them or not;
  • symbol '|' means either one or another (e.g. <test name> | <group name> means that you may provide the name of the test or the name of the special group);
  • if some parameter (e.g. <test name>) includes spaces, conclude parameter into double or single quotation marks (e.g. TestInfo 'Main Router').

List of available commands:

CommandParameter(s)Description
- management commands:
getstatus   Retrieves information about LanAtlas (version, status of the application, parameters).
start monitoring   Starts monitoring. Accomplishes the same action as clicking the Start button on the Main window of LanAtlas.
stop monitoring   Stops monitoring. LanAtlas will still remain running as an application (or as Win32 service) but will not perform any tests.
enable alerts   Enables alert actions of LanAtlas.
disable alerts   Disables alert actions of LanAtlas.
reload app   Reloads LanAtlas (as a service if it was started in Win32 service mode or as an application if it was started as a regular application).
reload cfg   Forces the LanAtlas to reread its` settings from the .ini file.
terminate   Terminates LanAtlas.
- folder/test lists:
CD | ChangeFolder <folder name>|<path>

Sets the current folder. All commands affect tests only from the current folder.
You may specify the name of the folder without the full path if it is a subfolder of the current folder. You may specify the full path to the folder which you want to make current. You may use ".." instead of a folder name when you want to step up one level. This command actually uses similar syntax as MS-DOS or UNIX command interpreter.
Examples:
  CD "Main office"
  CD Root\USA\Office
  CD ..
  ChangeFolder ..\..\pingtests\

FL | ShowFolders [-r] Displays the list of subfolders within the current folder. The numbers of Good/Bad/Unknown tests are displayed for each folder.
If an optional parameter "-r" was provided then all descendant subfolders would be displayed as well.
TL | ShowTests [-r] [-s:<sort mode>] Displays the list of all tests (name, status, reply) within the current folder. If an optional parameter "-r" was provided then the tests from all descendant subfolders would be displayed. Another optional parameter "-s:<sort mode>" defines the sorting order. <sort mode> could be one of the following: name, status, testtime, reply, method.
Examples:
  ShowTests
  TL -r
  TL -r -s:name
TI | TestInfo <test name> Displays detailed information about specified test. It tries to find specified test in a current folder, if the test was not found there, LanAtlas continues to check all available folders until it finds the test with the specified name.
- test manipulation:
DisableTest <test name> | <group name>
[-r]
Disables specified test or group of tests. If an optional parameter "-r" is provided then this operation will be applied to the current folder and all descendant subfolders within it.
EnableTest <test name> | <group name>
[-r]
Enables specified test or group of tests. If an optional parameter "-r" is provided then this operation will be applied to current folder and all descendant subfolders.
RefreshTest <test name> | <group name>
[-r]
Forces specified test or group of tests to execution. If an optional parameter "-r" is specified then operation will be applied to current folder and all descendant subfolders.
ResetTest <test name> | <group name>
[-r]
Resets statistics for specified test or group of tests. If an optional parameter "-r" is specified then operation will be applied to current folder and all its` subfolders.
DisableAll [-r] Disables all tests within the current folder. If an optional parameter "-r" is specified then all tests within the current folder including all subfolders will be disabled.
EnableAll [-r] Enables all tests within the current folder. If an optional parameter "-r" is provided then all tests within the current folder and all its` subfolders will be enabled.
RefreshAll [-r] Forces all tests within the current folder to execution. If an optional parameter "-r" is specified then the command affects subfolders as well.
ResetAll [-r] Resets statistics for all tests within current folder. If an optional parameter "-r" is specified then the subfolders are included as well.
SetTestParam <test name> | <group name>
<param>
<new value>
[-r]
Sets a value of a given parameter for the specified test or group of tests. <Param> could be one of the following:
  • timeout
  • username
  • password
  • comment
  • commentlineNN (where NN is a number between 1 and 99)
Example: SetTestParam   _AllTCP   timeout   2000
ReplaceTestParam <test name> | <group name>
<param>
<current value>
<new value>
[-r]

Replaces a value of a given parameter for the specified test or group of tests. Unlike "SetTestParam" command, this one works selectively. It changes the value of a parameter only for the tests that already have a current value of this parameter equal to the <current value> argument of the command.
Example: ReplaceTestParam   _AllTCP   timeout   2000   5000

- global variable commands:
ShowUserVariables [<variable>] Shows the list of global macro variables and their current values. If an optional parameter <variable> is specified then only the value of this variable will be displayed
SetUserVariable <variable> <value> Sets the value of a variable (if such variable does not exist, creates a new variable).
Note: Variable names are not case sensitive.
SaveUserVariables   Saves changes
LoadUserVariables   Loads previously saved variables
- other:
Help   Displays list of available commands (and parameters)
Disconnect   Disconnects client from LanAtlas

Most of commands that work with tests allow you to use special group name instead of name of the test. In this case a command will be applied to all tests of specific type (within the current folder).
Available group names:
Group nameTest type (method)
_AllPing Ping tests
_AllTrace Trace tests
_AllRAS RAS tests
_AllTCP TCP tests
_AllUDP UDP tests
_AllSMTP SMTP tests
_AllPOP3 POP3 tests
_AllIMAP IMAP tests
_AllDNS DNS tests
_AllLDAP LDAP tests
_AllNTP NTP tests
_AllRadius Radius tests
_AllHTTP HTTP tests
_AllURL URL tests
_AllUNC UNC tests
_AllFreeSpace Drive Free Space tests
_AllFolderSize Folder/File Size tests
_AllFileExists File/Folder Availability tests
_AllCountFiles Count Files tests
_AllFileContents     File Integrity tests
_AllFileComp Compare Files tests
_AllProcess Process tests
_AllService Service tests
_AllNTLog NT Event Log tests
_AllCPU CPU Usage tests
_AllPerfCounter Performance Counter tests
_AllODBC ODBC tests
_AllInterbase Interbase tests
_AllMsSQL MS SQL tests
_AllMySQL MySQL tests
_AllOracle Oracle tests
_AllPostgre Postgre tests
_AllSybase Sybase tests
_AllSNMP SNMP tests
_AllExternalPrg External tests
_AllScript Script tests

Examples:

  DisableTest  _AllTCP -r    
  EnableTest   _AllPing      
  RefreshTest  _AllURL       
  RefreshTest  "my router"   
  EnableAll           

Minimum system requirements

  • Windows 95 (OSR2), 98, ME, NT 4.0, Windows 2000, XP Professional or Windows Server 2003
  • TCP/IP connection (LAN or Dial-up)
  • 1 Mb of free disk space