Translations of this page:

Osmius

Osmius agent for IP Wikipedia: IP
Agent name: osm_ag_IPINST01 Agent code: IPINST01
Content: User manual Osmius agent for IP
Date: 10/07/2007 Revision date: 07/09/2007

General Information

This agent can monitor several parameters of instances typed as IP. Ha sido probado en situaciones reales. However, we recommend checking its functionality before implanting it in a production environment.

IP agent has been developed using functionalities and enhancements of Osmius framework and ACE libraries, so it is necessary to install the ACE libraries for the proper deployment and operation of Osmius agent for IP. See chapter: installation.

IPINST01 agent provides up to 9 basic events with configuration parameters to allow scaling of a very simple way.

All events are remote, so not intrusive. Monitoring is done through the network connection, by this reason you have to provide some connection information, see connection information. Event are based on request over sockets. The agent check returned data by IP instance and build an answer.

IP Instance

As a general rule each Osmius agent can monitor one instance type. If you are not familiar with these concepts check out the glossary. Each instance is individually defined in the configuration file (if you want further information go to agents and instances); depending on agent type is the instance type and depending on instance is the connection info.

CONNECTION_INFO

The connection information or connection_info is data that the agent needs to know to connect to the instance. (See more about the connection_info

For Osmius IP agent the connection_info prototype would be:

CONNECTION_INFO= -i HOST

Replace the following:

  • HOST: target IP (or host name if your DNS is able to resolve it). Mandatory

Examples:

CONECTION_INFO = -i 192.168.16.178
CONECTION_INFO = -i osmius.net

OBSERVATION: Check DNS resolution of host names from your monitoring platform.

TYPE

The type defines the instance type to be monitored. Every declared instance must be associated with a type as you can see here

For IP agent:

TYPE= IPINST01

Event summary table for IP

Here's briefly the capabilities of this agent, further down on this page each event is described in more detail.

EVENT DESCRIPTION c w a tseconds Extra parameters / Remarks
AVAILABL Device Availability - pign response time in ms 0 2000 4000 300 Silent mode ( -s) recommmended
IPHTTPUP HTTP reply 1 0 0 900 [-U url] [-P port]
Silent mode ( -s) recommmended
IPCFTPUP FTP reply 1 0 0 1800 [-P puerto]
Silent mode ( -s) recommmended
IPTELNET telnet reply 1 0 0 7200 [-P port]
Silent mode ( -s) recommmended
IPCSSHUP ssh reply 1 0 0 1800 [-P port]
Silent mode ( -s) recommmended
IPSMTPUP SMTP reply 1 0 0 1800 [-P port]
Silent mode ( -s) recommmended
IPCHKPOP POP reply analysis 1 0 0 1800 [-U user -K password][ -P port]
Silent mode ( -s) recommmended
IPCHKIMP IMAP reply analysis 1 0 0 1800 [-U user -K password][ -P port]
Silent mode ( -s) recommmended
IPCHKDNS Check host name DNS resolution 1 0 0 1800 -H hostname
Silent mode ( -s) recommmended

Information Events

Info events retieve general data about instance, usually this data doesn't change over time. This kind of events have no severity, simply provides instance details.

EVENT DESCRIPTION tseconds Remarks
IPINFIPA IP address or host name 86400 (1 day) IP address or hostname are usually unique, so this event allow us to identify thruly the instance

IPINST01 agent events

AVAILABL

AVAILABL event checks for connection to IP instance.
To do it, the event will execute a ping.

Return values:

VALUE MEANING
-1 Error
0 Not available
X Reply to ping average time in ms

Recommended parameters:

Comparison type Direct. The higher value the higher severity (-c 0)
Monitoring interval 60 seconds – 1 hour –> depends on instance importance
Warning threshold Depends on device response time
Alert threshold Depends on device response time

Parameter setting example:

AVAILABL = -t 600 -c 0 -w 1000 -a 3500 -T "avail and ping - mail server"

Remarks: None

IPHTTPUP

IPHTTPUP checks right reply of web server.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-U -U url
You can define a especific url to perform the query.
If url is not declared then event will use connection info.
No.
-P -P port
Communication port of web server.
Default is 80.
No.

Return values:

VALUE MEANING
-1 Error
0 Failed. There is reply but wrong.
1 OK. Right reply. Code 200

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 60 seconds – 1 hour –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPHTTPUP = -t 60 -c 1 -w 0 -a 0 -T "HTTP connection" -U http://webserver/page.php -P 8080

Remarks: It is useful to check if a web server is responding correctly to requests on a particular page.

IPCFTPUP

IPCFTPUP event stablish a connection to FTP server and checks availability.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-P -P port
FTP server communication port.
Default is 21.
No.

Return values:

VALUE MEANING
-1 Error
0 Failed. Wrong reply
1 OK. Right reply

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 60 seconds – 1 hour –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPCFTPUP = -t 60 -c 1 -w 0 -a 0 -T "FTP connection"

Remarks: None

IPTELNET

IPTELNET event stablish a connection to telnet server and checks availability.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-P -P port
telnet server communications port.
Default is 23.
No.

Return values:

VALUE MEANING
-1 Error
0 Failed. Wrong reply
1 OK. Right reply

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 60 seconds – 2 hours –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPTELNET = -t 60 -c 1 -w 0 -a 0 -T "port 23"

Remarks: You can use this event ot check any port availability.

IPCSSHUP

IPCSSHUP stablish a connection to SSH server and checks availability.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-P -P port
SSH server communications port.
Default is 22.
No.

Return values:

VALUE MEANING
-1 Error
0 Failed. Wrong reply
1 OK. Right reply

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 60 seconds – 1 hour –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPCSSHUP = -t 60 -c 1 -w 0 -a 0 -T "SSH server"

Remarks: None

IPSMTPUP

IPSMTPUP event stablish a connection to SMTP server and checks availability.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-P -P port
SMTP server communications port.
Default is 25.
No.

Return values:

VALUE MEANING
-1 Error
0 Failed. Wrong reply
1 OK. Right reply

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 60 seconds – 1 hour –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPSMTPUP = -t 60 -c 1 -w 0 -a 0 -T "SMTP server"

Remarks: None

IPCHKPOP

IPCHKPOP event stablish a connection to POP server and checks availability.
If you set user name and password a complete check will be performed.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-U -U “user”
Active POP account user name.
No.
-K -K “password”
User's password.
No.
-P -P port
POP server communications port.
Default is 110.
No.

Return values:

VALUE MEANING
-1 Error
0 Failed. Wring reply
1 OK. Right reply

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 600 seconds – 1 day –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPCHKPOP = -t 600 -c 1 -w 0 -a 0 -U "user" -K "password" -P 111 -T "my pop server"

Remarks: Because the username and password are stored unencrypted in the configuration file is recommended to take precautions and implement the necessary permissions to the file, so that only authorized users can access it.

IPCHKIMP

IPCHKIMP stablish a connection to IMAP server and checks availability.
If you set user name and password a complete check will be performed.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-U -U “user”
Active IMAP account user name.
No.
-K -K “contraseña”
User's password.
No.
-P -P puerto
IMAP server communications port.
Default is 143.
No.

Return values:

VALUE MEANING
-1 Error
0 Failed. Wrong reply
1 OK. Right reply

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 600 seconds – 1 day –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPCHKIMP = -t 600 -c 1 -w 0 -a 0 -U "user" -K "password" -T "imap server"

Remarks: Because the username and password are stored unencrypted in the configuration file is recommended to take precautions and implement the necessary permissions to the file, so that only authorized users can access it.

IPCHKDNS

IPCHKDNS checks correct resolution of host name using guest DNS servers.
This event executes “nslookup” command to check host name resolution.

Extra parameters:
This event need an extra parameter to work:

PARAMETER MEANING Mandatory
-H -H “host_name”
Host name to check resolution.
Yes.

Return values:

VALUE MEANING
-1 Error
0 Failed. Wrong reply
1 OK. Right reply

Recommended parameters:

Comparison type Inverse. The lower value the higher severity (-c 1)
Monitoring interval 600 seconds – 1 day –> depends on instance importance
Warning threshold 0
Alert threshold 0

Parameter setting example:

IPCHKDNS = -t 3600 -c 1 -w 0 -a 0 -H "osmius.net" -T "DNS check"

Remarks: None

IP agent prerequisites

In order to compile, this agent requires a set of prerequisites, which are generic to compile any Osmius agent, you can see these prerequisites.

Make sure you have an updated network map and clear in order to plan adequately monitoring.

IP makefiles and compilation

  • Make Project Creator (MPC) is used by Osmius, so creating Makefiles is a trivial task. If you want to learn more about MPC and Osmius check out the section of Makefiles on Osmius.
  • In the particular case of Osmius IP agent you can easily generate Makefile as follows:

From the agent directory using console or terminal.

Linux:

$ACE_ROOT/bin/mpc.pl -type make osm_ag_ip.mpc

HP-UX / Solaris:

$ACE_ROOT/bin/mpc.pl -type gnuace osm_ag_ip.mpc

Windows and Visual C 8:

%ACE_ROOT%\bin\mpc.pl -type vc8 osm_ag_ip.mpc
  • Now that you have created the Makefile, agent compiling is extremely simple.

Linux:

make -f Makefile.Osm_Ag_Ip_Osmius

HP-UX:

gmake -f Makefile.Osm_Ag_Ip_Osmius

Windows:

Double click on Osm_Ag_Ip_Osmius.vcproj and the project will be opened with Visual C. \\ Select the Rebuild option to compile.

Binaries are automatically installed in the bin directory of OSM_ROOT base directory.

Run IP agent

IP agent have the same running features of the other Osmius agents. You can check it out int he section Start and Stop Agents.

To run IP agent without Osmius web console:

osm_ag_IPINST01[.exe]1) -c osm_ag_IPINST01.ini -m MASTERAG -p 1950 -d [>> osm_ag_ipinst01.log]2)

Running in standalone mode

IP agent, like the others Osmius agents, allows the execution in standalone mode. This option may be particularly useful when developing a new agent or to perform specific agent tests.

Basically you have to add a new value, called SNDCMD, to Osmius agent configuration file (osm_ag_IPINST01.ini) as shown here.

Then you must run the Osmius agent for IP setting Master Agent communications port to zero, for example:

osm_ag_IPINST01[.exe] -c osm_ag_IPINST01.ini -m 00000000 -p 0 -d

Tests list

Performed test for Osmius IP agent.

Date: 07/12/2007
Test Results Comment
Creating an instance with all its events in silent mode OK N/A
Creating an instance with all its events with custom text OK N/A
Creating an instance with all its events but no custom text OK N/A
Declaration of 3 instances with all its events to 5 seconds and keep it
running for 48 hours
- N/A
Declare 2 instances, cause a disconnect and then reconnect OK N/A
Declare 1 instance and test each event OK N/A
Elimination of general parameter and check unbootable OK PORTCM erased
Elimination of instance CONN_INFO and check unbootable OK N/A
1) On Windows platforms use .exe extension
2) Optional, to store agent messages in a file
 
en/agentes/ipinst01.txt · Last modified: 2012/12/05 19:17 by osmius
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki