HostMonitor's Main Page Telnet Service
Version 1.30
Copyright (c) 2000-2016 Advanced Network Software
Current language: English
Switch language to: German
  What's New What's New    Copyright/License/Warranty Copyright/License/Warranty    Download HostMonitor Download    Registration Information Buy Now   

network monitoring package HM Telnet Service is an auxiliary application for HostMonitor. It is included into Advanced Host Monitor package. Enterprise license for Advanced Host 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    Price

telnet service This application works like Telnet server and allows you to control HostMonitor 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 HostMonitor and Telnet Service is encrypted and password protected;
  • HostMonitor & Telnet Service allow you to setup different user accounts with different sets of permissions;
  • Application can be installed on the HostMonitor'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 HostMonitor is installed (keep the default '127.0.0.1' if HostMonitor and Telnet Service are installed on the same system)
  • Port: please provide TCP port that is used by HostMonitor'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 HostMonitor 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 HostMonitor via telnet client follow these simple steps:
  • start HostMonitor
  • configure HostMonitor's Remote Control Interface on RCI page in the Options dialog

  • setup user accounts: use HostMonitor's menu "User"->"Operators"
  • start the Telnet Service. You can start it on the same system where HostMonitor is running or on any system that has TCP/IP connection with HostMonitor's system. E.g. HostMonitor 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 HostMonitor'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 HostMonitor 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 HostMonitor.
Here are some common rules for the commands:

  • commands are not case sensitive (e.g. "stop monitoring" and "STOP Monitoring" mean the same);
  • 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 HostMonitor (version, status of the application, parameters).
Start monitoring   Starts monitoring. Accomplishes the same action as clicking the Start button on the Main window of HostMonitor.
Stop monitoring   Stops monitoring. HostMonitor will still remain running as an application (or as Win32 service) but will not perform any tests.
Enable alerts   Enables alert actions of HostMonitor.
Disable alerts   Disables alert actions of HostMonitor.
PauseMonitoring <interval> Pauses monitoring for specified time (time should be specified in minutes).
PauseAlerts <interval> Pause alerts for interval specified in minutes. In other words, all action profiles that usually were triggered by the change of test(s) status will not be executed within N minutes. All scheduled actions (those that are executed by built-in Scheduler) will continue to execute anyway.
ExecuteScript <pathtoscript> Executes specified HM Script.
Example: ExecuteScript "C:\Program Files\HostMon\pause3backuptests.hms"
ImportFromFile <filename>
[SkipDuplicates]
[WriteLog]
Imports test items from special Text file.
SkipDuplicates - optional parameter, HostMonitor will skip item when test item with the same name already present in the TestList.
WriteLog - optional parameter, HostMonitor will record to the system log file information about all errors and warnings during the import process.
SaveTestList   Saves the current test settings using current file name.
Reload app   Reloads HostMonitor (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 HostMonitor to re-read its` settings from INI file (hostmon.ini by default).
Terminate   Terminates HostMonitor.
- 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 (ID, 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, HostMonitor continues to check all available folders until it finds the test with the specified name.
TID | TestInfoByID <testID> Displays detailed information about specified test item. Similar to TestInfo command but you should provide test item ID instead of test name.
TCMT | GetTestComments <test name> Show complete comment specified for test item and comments that were provided when operators acknowledged, disabled, paused test or scheduled test to be paused (different kinds of comments separated by '----' line)
TCMTID | GetTestCommentsByID <testID> Similar to GetTestComments command but you should provide test item ID instead of test name.
- the following commands allow you to create new folders and copy test items; if you are using templates, HostMonitor will modify new test items using destination folder variables.
CreateFolder <full path to the folder> Creates new folder(s). The value of this parameter should specify the full path to the folder that you want to create.
E.g.
CreateFolder Root\USA Branch\Support\part2\
will successively create 3 folders
- "USA Branch" folder in the "Root" folder,
  - "Support" folder in "USA Branch" subfolder,
    - "part2" folder in "Support" subfolder.
If some (or all) of specified folders already exist, HostMonitor will not create second copy of them.
CopyFolder <srcname>|<id>|<fullpath>
<newname> | <newpath>
[-r]
Creates new folder using all properties of the source folder (such as Reports list, Variables, Color scheme, etc).
Source folder can be specified by its name (if this folder located within current parent folder - folder selected by ChangeFolder command); folder ID or full path to the folder.
Target folder can be specified by name or full path.
Optional parameter "-r" tells HostMonitor to copy folder with its subfolders.
Example:
  CopyFolder   Root\Template   Root\SQLServer2
  CopyFolder   10   Root\Windows5   -r
SetFolderVariable <variable_name>
<variable_value>
[-inheritpartly]
Sets or modifies folder variable for current folder.
If currently folder settings set to "inherit all variables from parent folder", this command will set "Use folder variables only" mode. Unless you specify optional -inheritpartly parameter; in such case HostMonitor will set "Use inherited variables; folder variables may override inherited variables" option.
Note: if you are using folder-level variables as parameters of some test items, this command will modify test settings automatically.
Example:
  SetFolderVariable   fvar_host   "10.10.5.1"
CopyTestByName <test name> | <group name>
<dest path> | <folderID>
Copies specific test or group of tests (e.g. all Ping tests) into specified folder.
Destination folder can be specified by full path or folder ID.
Example:
  CopyTestsByName   _AllPing   Root\Server2
  CopyTestsByName   "router 2"   Root\Newsetup
  CopyTestsByName   _AllGood   105
CopyTestByID <testID>
<dest path> | <folderID>
Copies single test specified by ID into target folder specified by full path or folder ID.
CopyAllTests <dest path> | <folderID>
[-skipduplicates]
[r]
Copies all test items from current folder (and optionally subfolders) into target folder.
- test manipulation (1):
  note: the following commands work with test items within Current Folder (initially when session just started the root folder is current)
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.
PauseTest <test name> | <group name>
<interval>
[<comment>]
[-r]
Pauses specified test or group of tests (time interval should be specified in minutes).
If an optional parameter "-r" is specified then operation will be applied to current folder and all its` subfolders.
Examples:
  PauseTest   "www.nasa.gov"   5   "paused for 5 min"
  PauseTest   _AllBad   3   -r
ResumeTest <test name> | <group name>
[-r]
Resumes paused 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
  • sqlquery
  • retries
  • testinterval
  • 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

- test manipulation (2):
  note: the following commands work with specific test item(s) regardless of "current folder" settings
DisableTestByID <testID1> [<testID2> [...]] Disables specified test item(s). Example: DisableTestsByID   3   4   5
EnableTestByID <testID1> [<testID2> [...]] Enables specified test item(s). Example: EnableTestsByID   102   103
RefreshTestByID <testID1> [<testID2> [...]] Forces specified test item(s) to execution. Example: RefreshTestsByID   77
ResetTestByID <testID1> [<testID2> [...]] Resets statistics for specified test item(s).
PauseTestByID <interval>
<comment>
<testID1> [<testID2> [...]]
Pauses specified test item(s). Time interval should be specified in minutes.
Example: PauseTestByID 5 "paused for 5 min" 41 42 43
ResumeTestByID <testID1> [<testID2> [...]] Resumes paused test item(s).
AckTestByID [StopAlerts]
<comment>
<testID> [<testID2> [...]]
Acknowledges failed test item(s)
SetTestParamByID <testID1>
<param>
<new value>
Sets a value of a given parameter for the specified test item. <Param> could be one of the following:
  • timeout
  • username
  • password
  • sqlquery
  • retries
  • testinterval
  • comment
  • commentlineNN (where NN is a number between 1 and 99)
Example: SetTestParamByID   55   timeout   2000
ReplaceTestParamByID <testID>
<param>
<current value>
<new value>

Replaces a value of a given parameter for the specified test item. 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: ReplaceTestParamByID   55   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 HostMonitor

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)   Group nameTest type (method)
_AllGood Test items with Ok/Alive status _AllUnknownTest items with Unknown status
_AllBad Test items with Bad/NoAnswer status _AllWarningTest items with Warning status
 
_AllPing Ping tests _AllNTLog NT Event Log tests
_AllTrace Trace tests _AllCPU CPU Usage tests
_AllRAS RAS tests _AllPerfCounter Performance Counter tests
_AllTCP TCP tests _AllWMI WMI tests
_AllUDP UDP tests _AllDominantProcess Dominant Process tests
_AllSMTP SMTP tests _AllODBC ODBC tests
_AllPOP3 POP3 tests _AllInterbase Interbase tests
_AllIMAP IMAP tests _AllMsSQL MS SQL tests
_AllDNS DNS tests _AllMySQL MySQL tests
_AllLDAP LDAP tests _AllOracle Oracle tests
_AllNTP NTP tests _AllPostgre Postgre tests
_AllRadius Radius tests _AllSybase Sybase tests
_AllDICOM DICOM tests _AllSNMP SNMP Get tests
_AllDHCP DHCP tests _AllSNMPTrap SNMP Trap
_AllMailRelay Mail Relay tests _AllExternalPrg External tests
_AllHTTP HTTP tests _AllScript Active Script tests
_AllURL URL tests _AllShell Shell Script tests
_AllUNC UNC tests _AllSSH SSH tests
_AllFreeSpace Drive Free Space tests _AllTemp Temperature Monitor tests
_AllFolderSize Folder/File Size tests _AllTraffic Traffic Monitor tests
_AllFileExists File/Folder Availability tests_AllHMMonitor HM Monitor tests
_AllCountFiles Count Files tests _AllSOAP SOAP tests
_AllFileContents     File Integrity tests _AllEMail E-Mail tests
_AllTextLog Text Log tests _AllCertificateCertificate Expiration tests
_AllFileComp Compare Files tests _AllDomain Domain Expiration tests
_AllProcess Process tests _AllRegistry Registry tests
_AllService Service tests _AllSNMPTable SNMP Table tests
_AllMemory Memory tests

Examples:

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

Minimum system requirements

  • Windows XP SP2, Vista SP2, Windows 7, Windows 8 or Windows 10
  • Windows Server 2003 SP2, Server 2008 SP2/R2 or Windows Server 2012
  • TCP/IP connection (LAN or Dial-up)
  • 1 Mb of free disk space

How much does it cost?

When you purchase an Advanced Host Monitor ENTERPRISE edition you will get the license for Telnet Service at no cost. Otherwise the license for Telnet Service + Web Service costs $100. You can order Telnet Service using credit card, Switch and Solo debit cards, check/money order or wire transfer. If you are concerned about submitting your order and/or credit card information online, you may register the software via phone, fax or postal mail.
Details..