tyler.durden
/
pandorafms
mirror of https://github.com/pandorafms/pandorafms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

2006-09-11 Sancho Lerena <slerena@artica.es> 

* Creation of ChangeLog

        * Updated pandora_chapter 1 2 3 and part of 4.



git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@161 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
slerena 2006-09-11 21:28:10 +00:00
parent aa90c2debb
commit 128eeb2c02
4 changed files with 980 additions and 843 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pandora_doc/ChangeLog Normal file
View File

@ -0,0 +1,7 @@
2006-09-11 Sancho Lerena <slerena@artica.es>
* Creation of ChangeLog
* Updated pandora_chapter 1 2 3 and part of 4.

22
pandora_doc/pandora_chapter1.xml
View File

@ -1,18 +1,22 @@
<?xml version="1.0" encoding="ISO-8859-15"?>
<?xml version="1.0" encoding="utf-8"?>
<chapter>
<title>Introduction</title>
<sect1>
<title>Pandora Administration</title>
<para>The web console is the tool used to administrate Pandora.
It is written in PHP and doesn't need any third party software
to work –neither FLASH, JAVA, nor ActiveX plug-ins.
The Web console can be run over any web browser supporting HTML and
CSS (IE5+ or Mozilla 4+).</para>
<para>
The web console is the tool used to administrate
Pandora. It is written in PHP and doesn't need any
third party software to work, neither FLASH, JAVA,
nor ActiveX plug-ins. The Web console can be run
over any web browser supporting HTML and CSS (IE5+
or Mozilla 4+).
</para>
<graphic fileref="images/image001.png" valign="bottom" align="center"/>
<para>Pandora administration is divided in the following main elements:</para>
<para>
Pandora administration is divided in the following
main elements:
</para>
<itemizedlist>
<listitem>
<para>Pandora users</para>

180
pandora_doc/pandora_chapter2.xml
View File

@ -1,43 +1,61 @@
<?xml version="1.0" encoding="ISO-8859-15"?>
<?xml version="1.0" encoding="utf-8"?>
<chapter>
<title>Users</title>
<para>The definition of a user is based on the user's
daily activity. One or more profiles can be assigned to a single user</para>
<para>A profile is a list of actions a user can or
cannot perform on a given group, e.g. "view incidents",
"database management", etc
<para>
The definition of a user is based on the user's daily
activity. One or more profiles can be assigned to a single
user
</para>
<para>Each user is given a number of groups of agents
he/she has permission to access, as well as the administrative profile
he/she will have in each group. Each user can belong to one or more
groups, with an assigned profile for each of them.</para>
<para>
A profile is a list of actions a user can or cannot perform
on a given group, e.g. "view incidents", "database
management", etc
</para>
<para>Agent belongs to a group and only one, sharing
the group with agents of similar characteristics. Groups also contain
incidents.</para>
<para>
Each user is given a number of groups of agents he/she has
permission to access, as well as the administrative profile
he/she will have in each group. Each user can belong to one
or more groups, with an assigned profile for each of
them.
</para>
<para>Summarizing: User profiles in Pandora define which users can access
Pandora as well as what each user can do. Groups define elements in common
among various users. Each user could be in one or more groups at any one
time. Each group has user profiles which are defined and attached to it.
A profile is a list of things a user can do, such as view incidents,
manage database or other.</para>
<para>
Agent belongs to a group and only one, sharing the group
with agents of similar characteristics. Groups also contain
incidents.
</para>
<para>
Summarizing: User profiles in Pandora define which users can
access Pandora as well as what each user can do. Groups
define elements in common among various users. Each user
could be in one or more groups at any one time. Each group
has user profiles which are defined and attached to it. A
profile is a list of things a user can do, such as view
incidents, manage database or other.
</para>
<sect1>
<title>Profile manager</title>
<para>Pandora's profile manager is used to assign specific profiles
to each user. A hierarchy of users is so created, structured by the
user's profile within the company. With this system different security
levels can be implemented: read-only users, agent group coordinators
or system administrators.</para>
<para>
Pandora's profile manager is used to assign specific
profiles to each user. A hierarchy of users is so created,
structured by the user's profile within the company. With
this system different security levels can be implemented:
read-only users, agent group coordinators or system
administrators.
</para>
<para>A profile is created from the Profile Manager tool in the
Administration menu. There are five predefined profiles:</para>
<para>
A profile is created from the Profile Manager tool in the
Administration menu. There are five predefined
profiles:
</para>
<itemizedlist>
<listitem>
@ -56,14 +74,14 @@
<para>Pandora Administrator</para>
</listitem>
</itemizedlist>
<para>To create a new profile click on "Manage Profiles"&gt;
"Create Profile" in the Administration Menu</para>
<para>
To create a new profile click on "Manage Profiles" ->
"Create Profile" in the Administration Menu
</para>
<graphic fileref="images/image002.png" valign="bottom" align="center"/>
<para>Any of the following roles can be assigned to a new profile:</para>
<para>
Any of the following roles can be assigned to a new profile:
</para>
<itemizedlist>
<listitem>
<para>View incidents (IR)</para>
@ -99,67 +117,79 @@
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>Adding a user</title>
<para>A user is added clicking on "Manage Users"&gt;"Create user"
in the Administration Menu</para>
<para>To create a new user it is necessary to, at
least, fill in the user ID, the password (twice) and Pandora's global profile.</para>
<para>A global profile for a user maybe Administrator or Standard User.</para>
<para>A user with an "Administrator" profile will have the highest
security privileges in Pandora.</para>
<para>
A user is added clicking on "Manage Users"&gt;"Create user"
in the Administration Menu
</para>
<para>
To create a new user it is necessary to, at least, fill in
the user ID, the password (twice) and Pandora's global
profile.
</para>
<para>
A global profile for a user maybe Administrator or
Standard User.
</para>
<para>
A user with an "Administrator" profile will have the
highest security privileges in Pandora.
</para>
<graphic fileref="images/image003.png" valign="bottom" align="center"/>
<para>Profiles must be assigned for each of the groups a new
"standard" profile user can access, once the user is created
and his configuration updated.</para>
<para>
Profiles must be assigned for each of the groups a new
"standard" profile user can access, once the user is
created and his configuration updated.
</para>
<graphic fileref="images/image004.png" valign="bottom" align="center"/>
<para>A user profile is deleted by clicking on the delete icon
<graphic fileref="../../images/cancel.gif"/> on the right hand side
of the profile.</para>
<para>
A user profile is deleted by clicking on the delete icon
<graphic fileref="../../images/cancel.gif"/> on the right
hand side of the profile.
</para>
</sect1>
<sect1>
<title>Deleting a user</title>
<para>A user is deleted by clicking on the delete icon
<graphic fileref="../../images/cancel.gif"/> on the right hand
side of the user. The list of users is accessed through the
"Manage Users" option in the Administration menu.</para>
<para>
A user is deleted by clicking on the delete icon <graphic
fileref="../../images/cancel.gif"/> on the right hand side
of the user. The list of users is accessed through the
"Manage Users" option in the Administration menu.
<graphic fileref="images/image005.png" valign="bottom" align="center"/>
</para>
</sect1>
<sect1>
<title>Statistics</title>
<para>The user activity statistics show a graph with the activity
of the user, being the number of events the audit has generated
for each user. The number of events of
a user usually reflects the user's activity.</para>
<para>Click on "View Users"&gt;"Statistics" in the Operation menu to show
this graph:</para>
<graphic fileref="images/image006.png" valign="bottom" align="center"/>
<para>
The user activity statistics show a graph with the
activity of the user, being the number of events the audit
has generated for each user. The number of events of a
user usually reflects the user's activity.
</para>
<para>
Click on "View Users" -> "Statistics" in the Operation
menu to show this graph:
<graphic fileref="images/image006.png" valign="bottom" align="center"/> </para>
</sect1>
<sect1>
<title>Messages to users</title>
<para>To create a new message to other user, go to "Messages" section
in the Operation menu. You can also read the received messages,
but the sent messages are not stored.</para>
<para>
To create a new message to other user, go to "Messages"
section in the Operation menu. You can also read the
received messages, but the sent messages are not stored.
</para>
<sect2>
<title>Messages to groups</title>
<para>From "Messages"&gt;"Messages to groups" section in the
<para>
From "Messages" -> "Messages to groups" section in the
Operation menu you can send messages to groups of users.
The sent messages will not be stores.</para>
The sent messages will not be stores.
</para>
</sect2>
</sect1>
</chapter>

338
pandora_doc/pandora_chapter3.xml
View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="ISO-8859-15"?>
<?xml version="1.0" encoding="utf-8"?>
<chapter>
<title>Agents</title>
@ -45,28 +45,28 @@
<itemizedlist>
<listitem>
<para><b>Applications</b></para>
<para><emphasis>Applications</emphasis></para>
</listitem>
<listitem>
<para><b>Comms</b></para>
<para><emphasis>Comms</emphasis></para>
</listitem>
<listitem>
<para><b>Databases</b></para>
<para><emphasis>Databases</emphasis></para>
</listitem>
<listitem>
<para><b>Firewall</b></para>
<para><emphasis>Firewall</emphasis></para>
</listitem>
<listitem>
<para><b>IDS</b></para>
<para><emphasis>IDS</emphasis></para>
</listitem>
<listitem>
<para><b>Others</b></para>
<para><emphasis>Others</emphasis></para>
</listitem>
<listitem>
<para><b>Servers</b></para>
<para><emphasis>Servers</emphasis></para>
</listitem>
<listitem>
<para><b>Workstations</b></para>
<para><emphasis>Workstations</emphasis></para>
</listitem>
</itemizedlist>
@ -92,122 +92,218 @@
<itemizedlist>
<listitem>
<para><b>Agent Name:</b> Name of the agent. This and the "agent name" parameter in Pandora's agent.conf file <b>must have the same value</b>. If this variable is commented out in the code, the name used will be the name of the Host (to obtain this, execute the <i>hostname</i> command).</para>
<para>
<emphasis>Agent Name:</emphasis> Name of the agent. This and
the "agent name" parameter in Pandora's agent.conf file
<emphasis>must have the same value</emphasis>. If this
variable is commented out in the code, the name used will be
the name of the Host (to obtain this, execute the hostname
command).
</para>
</listitem>
<listitem>
<para><b>IP Address:</b> IP address of an agent. An agent can share its IP address with other agents.</para>
<para>
<emphasis>IP Address:</emphasis> IP address of an agent. An
agent can share its IP address with other agents.
</para>
</listitem>
<listitem>
<para><b>Group:</b> Pandora's group the agent belongs.</para>
<para>
<emphasis>Group:</emphasis> Pandora's group the agent belongs.
</para>
</listitem>
<listitem>
<para><b>Interval:</b> Execution interval of an agent. It is the time elapsed between two executions.</para>
<para>
<emphasis>Interval:</emphasis> Execution interval of an
agent. It is the time elapsed between two executions.
</para>
</listitem>
<listitem>
<para><b>OS:</b> The Operating System to be monitored. The supported Operating Systems are: AIX, BeOS,
BSD, Cisco, HPUX, Linux, MacOS, Other, Solaris, Windows.</para>
<para>
<emphasis>OS:</emphasis> The Operating System to be
monitored. The supported Operating Systems are: AIX, BeOS,
BSD, Cisco, HPUX, Linux, MacOS, Other, Solaris,
Windows.
</para>
</listitem>
<listitem>
<para><b>Description:</b> Brief description of an agent.</para>
<para>
<emphasis>Description:</emphasis> Brief description of an agent.
</para>
</listitem>
<listitem>
<para><b>Module definition:</b> There are two modes for a module:</para>
<para>
<emphasis>Module definition:</emphasis> There are two modes
for a module:
</para>
</listitem>
<para>- <i><b>Learning mode:</b></i> All the modules sent by the agent are accepted. They are automatically defined by the system. It is recommended to activate the agents in this mode and change it once the user is familiar with the system.</para>
<para>- <i><b>Normal mode:</b></i> The modules in this mode must be configured manually. The self – definition of the modules is not allowed in this mode.</para>
<listitem>
<para><b>Disabled:</b> This parameter shows if the agent is activated and
ready to send data or deactivated. The deactivated agents don't appear in the
user views.</para>
<para>
- <emphasis>Learning mode:</emphasis> All the modules sent by
the agent are accepted. They are automatically defined by the
system. It is recommended to activate the agents in this mode
and change it once the user is familiar with the system.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Normal mode:</emphasis> The modules in this mode
must be configured manually. The self – definition of the
modules is not allowed in this mode.
</para>
</listitem>
<listitem>
<para>
<emphasis>Disabled:</emphasis> This parameter shows if the
agent is activated and ready to send data or
deactivated. The deactivated agents don't appear in the user
views.
</para>
</listitem>
</itemizedlist>
<sect2>
<title>Assigning modules</title>
<para>Pandora's agents use the operating system own commands to monitor a device. Pandora's server will store and process the output generated by those commands. The commandos are called "modules".</para>
<para>Pandora's agents use the operating system own commands to
monitor a device. Pandora's server will store and process the
output generated by those commands. The commandos are called
"modules".</para>
<para>If the agent had been added in "normal mode", the modules to be monitored should have been assigned. Those modules must be configured in the agent configuration file.</para>
<para>If the agent had been added in "normal mode", the modules
to be monitored should have been assigned. Those modules must be
configured in the agent configuration file.</para>
<para>The modules to be processed by Pandora's server are assigned in the "Manage Agents" option, Administration menu. A list with all the agents in Pandora will be shown here.</para>
<para>The modules to be processed by Pandora's server are
assigned in the "Manage Agents" option, Administration menu. A
list with all the agents in Pandora will be shown here.</para>
<para>You'll get a form with all the agent's settings when the agent name is clicked. In the same screen there is a section to assign modules.</para>
<para>You'll get a form with all the agent's settings when the
agent name is clicked. In the same screen there is a section to
assign modules.</para>
<graphic fileref="images/image009.png" valign="bottom" align="center"/>
<para>The following fields must be filled to create a module:</para>
<para>The following fields must be filled to create a
module:</para>
<itemizedlist>
<listitem>
<para><b>Module type:</b> This is the type of data the module will process. There are five types of data:</para>
</listitem>
<para>
- <b><code>generic_data</code></b>, Integer data type
- <b><code>generic_data_inc</code></b>, Incremental integer data type
- <b><code>generic_data_proc</code></b>, Boolean data type: 0 False, &gt;0 True
- <b><code>generic_data_string</code></b>, Alphanumeric data type (text string, max. 255 characters)
<emphasis>Module type:</emphasis> This is the type of data
the module will process. There are five types of data:
</para>
<listitem>
<para><b>Module name:</b> The name of the module</para>
</listitem>
<listitem>
<para><b>Maximum:</b> Upper threshold for the value in the module. Any value above this threshold will be taken as invalid and the whole module will be discarded.</para>
<para>
- <emphasis>generic_data></emphasis>, Integer data type -
<emphasis>generic_data_inc</emphasis>, Incremental integer
data type - <emphasis>generic_data_proc</emphasis>, Boolean
data type: 0 False, &gt;0 True -
<emphasis>generic_data_string</emphasis>, Alphanumeric data
type (text string, max. 255 characters)
</para>
</listitem>
<listitem>
<para>
<emphasis>Module name:</emphasis> The name of the module
</para>
</listitem>
<listitem>
<para><b>Maximum:</b> Lower threshold for the value in the module. Any value below this threshold will be taken as invalid and the whole module will be discarded.</para>
<para>
<emphasis>Maximum:</emphasis> Upper threshold for the
value in the module. Any value above this threshold will
be taken as invalid and the whole module will be
discarded.
</para>
</listitem>
<listitem>
<para><b>Comments:</b> Comments added to the module.</para>
<para>
<emphasis>Maximum:</emphasis> Lower threshold for the
value in the module. Any value below this threshold will
be taken as invalid and the whole module will be
discarded.
</para>
</listitem>
<listitem>
<para>
<emphasis>Comments:</emphasis> Comments added to the module.
</para>
</listitem>
</itemizedlist>
<para>All the modules to be monitored by an agent can be reviewed by accessing the agent in the "Manage Agents" option, Administration menu.</para>
<para>
All the modules to be monitored by an agent can be reviewed by
accessing the agent in the "Manage Agents" option,
Administration menu.
</para>
<graphic fileref="images/image010.png" valign="bottom" align="center"/>
<para>In this screen the modules can be:</para>
<para>
In this screen the modules can be:
</para>
<itemizedlist>
<listitem>
<para>Deleted by clicking <graphic fileref="../../images/cancel.gif"/></para>
<para>
Deleted by clicking <graphic fileref="../../images/cancel.gif"/>
</para>
</listitem>
<listitem>
<para>Edited by clicking <graphic fileref="../../images/config.gif"/></para>
<para>
Edited by clicking <graphic fileref="../../images/config.gif"/>
</para>
</listitem>
</itemizedlist>
<para>However, the type of data of the module can't be modified.</para>
<para>
However, the type of data of the module can't be modified.
</para>
</sect2>
<sect2>
<title>Alerts</title>
<para>An alert is Pandora's reaction to an out of range module value. The Alert can
consist in sending and e-mail or SMS to the administrator, sending a SNMP trap,
write the incident into the system syslog or Pandora log file, etc. And
basically anything that can be triggered by a script configured in Pandora's
Operating System.</para>
<para>
An alert is Pandora's reaction to an out of range module
value. The Alert can consist in sending and e-mail or SMS to
the administrator, sending a SNMP trap, write the incident
into the system syslog or Pandora log file, etc. And basically
anything that can be triggered by a script configured in
Pandora's Operating System.
</para>
<sect3>
<title>Adding an Alert</title>
<para>The existing Alerts are accessed by clicking on the "Manage Alerts" option, Administration menu.</para>
<para>
The existing Alerts are accessed by clicking on the "Manage
Alerts" option, Administration menu.
</para>
<para>There are 6 default types of Alerts:</para>
<itemizedlist>
<listitem>
<para><b>eMail</b>. Sends an e-mail from Pandora's Server</para>
<para>
<emphasis>eMail</emphasis>. Sends an e-mail from Pandora's Server
</para>
</listitem>
<listitem>
<para><b>Internal audit</b>. Writes the incident in Pandora's internal audit system</para>
<para>
<emphasis>Internal audit</emphasis>. Writes the incident
in Pandora's internal audit system
</para>
</listitem>
<listitem>
<para><b>LogFile</b>. Writes the incident in the log file</para>
<para><emphasis>LogFile</emphasis>. Writes the incident in the log file</para>
</listitem>
<listitem>
<para><b>SMS Text</b>. Sends an SMS to a given mobile phone</para>
<para><emphasis>SMS Text</emphasis>. Sends an SMS to a given mobile phone</para>
</listitem>
<listitem>
<para><b>SNMP Trap</b>. Sends a SNMP Trap</para>
<para><emphasis>SNMP Trap</emphasis>. Sends a SNMP Trap</para>
</listitem>
<listitem>
<para><b>Syslog</b>. Sends an alert to the Syslog</para>
<para><emphasis>Syslog</emphasis>. Sends an alert to the Syslog</para>
</listitem>
</itemizedlist>
@ -215,43 +311,43 @@
<para>An Alert is deleted by clicking on the delete icon <graphic fileref="../../images/cancel.gif"/> placed on the right hand side of the Alert. A new customised Alert can be created clicking in "Create Alert".</para>
<para>The values "<code>_field1_</code>", "<code>_field2_</code>" and "<code>_field3_</code>" in the customised Alerts are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode.</para>
<para>The values "_field1_", "_field2_" and "_field3_" in the customised Alerts are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode.</para>
<graphic fileref="images/image012.png" valign="bottom" align="center"/>
<para>When a new Alert is created the following field must be filled in:</para>
<itemizedlist>
<listitem>
<para><b>Alert name:</b> The name of the Alert</para>
<para><emphasis>Alert name:</emphasis> The name of the Alert</para>
</listitem>
<listitem>
<para><b>Command:</b> Command the Alert will trigger</para>
<para><emphasis>Command:</emphasis> Command the Alert will trigger</para>
</listitem>
<listitem>
<para><b>Description:</b> Description of the Alert</para>
<para><emphasis>Description:</emphasis> Description of the Alert</para>
</listitem>
</itemizedlist>
<para>In 'Command' data field these variables are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode, replacing at runtime:</para>
<para>In 'Command' data field these variables are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode, replacing at runtime:</para>
<itemizedlist>
<listitem>
<para><code><b>_field1_</b></code>: Field #1, usually assigned as username, e-mail destination or single identification for this event</para>
<para><emphasis>_field1_</emphasis>: Field #1, usually assigned as username, e-mail destination or single identification for this event</para>
</listitem>
<listitem>
<para><code><b>_field2_</b></code>: Field #2, usually assigned as short description of events, as subject line in e-mail</para>
<para><emphasis>_field2_</emphasis>: Field #2, usually assigned as short description of events, as subject line in e-mail</para>
</listitem>
<listitem>
<para><code><b>_field3_</b></code>: Field #3, a full text explanation for the event</para>
<para>><emphasis>_field3_</emphasis>: Field #3, a full text explanation for the event</para>
</listitem>
<listitem>
<para><code><b>_agent_</b></code>: Agent name</para>
<para>><emphasis>_agent_</emphasis>: Agent name</para>
</listitem>
<listitem>
<para><code><b>_timestamp_</b></code>: A standard representation of date and time. Replaced automatically when the event has been fired</para>
<para><emphasis>_timestamp_</emphasis>: A standard representation of date and time. Replaced automatically when the event has been fired</para>
</listitem>
<listitem>
<para><code><b>_data_</b></code>: The data value that triggered the alert</para>
<para><emphasis>_data_</emphasis>: The data value that triggered the alert</para>
</listitem>
</itemizedlist>
</sect3>
@ -268,34 +364,34 @@
<itemizedlist>
<listitem>
<para><b>Alert type:</b> This can be selected from the list of alerts that have been previously generated.</para>
<para><emphasis>Alert type:</emphasis> This can be selected from the list of alerts that have been previously generated.</para>
</listitem>
<listitem>
<para><b>Maximum Value:</b> Defines the maximum value for a module. Any value above that threshold will trigger the Alert.</para>
<para><emphasis>Maximum Value:</emphasis> Defines the maximum value for a module. Any value above that threshold will trigger the Alert.</para>
</listitem>
<listitem>
<para><b>Minimum Value:</b> Defines the minimum value for a module. Any value below that will trigger the Alert.</para>
<para><emphasis>Minimum Value:</emphasis> Defines the minimum value for a module. Any value below that will trigger the Alert.</para>
</listitem>
<listitem>
<para><b>Description:</b> Describes the function of the Alert, and it is useful to identify the Alert amongst the others in the Alert General View.</para>
<para><emphasis>Description:</emphasis> Describes the function of the Alert, and it is useful to identify the Alert amongst the others in the Alert General View.</para>
</listitem>
<listitem>
<para><b>Field #1 (Alias, name):</b> Define the used value for the "_field1_" variable.</para>
<para><emphasis>Field #1 (Alias, name):</emphasis> Define the used value for the "_field1_" variable.</para>
</listitem>
<listitem>
<para><b>Field #2 (Single Line):</b> Define the used value for the "_field2_" variable.</para>
<para><emphasis>Field #2 (Single Line):</emphasis> Define the used value for the "_field2_" variable.</para>
</listitem>
<listitem>
<para><b>Field #3 (Full Text):</b> Define the used value for the "_field3_" variable.</para>
<para><emphasis>Field #3 (Full Text):</emphasis> Define the used value for the "_field3_" variable.</para>
</listitem>
<listitem>
<para><b>Time threshold:</b> Minimum duration between the firing of two consecutive alerts, in seconds.</para>
<para><emphasis>Time threshold:</emphasis> Minimum duration between the firing of two consecutive alerts, in seconds.</para>
</listitem>
<listitem>
<para><b>Max Alerts Fired:</b> Maximun number of alerts that can be sent consecutively.</para>
<para><emphasis>Max Alerts Fired:</emphasis> Maximun number of alerts that can be sent consecutively.</para>
</listitem>
<listitem>
<para><b>Assigned module:</b> Module to be motitorized by the alert.</para>
<para><emphasis>Assigned module:</emphasis> Module to be motitorized by the alert.</para>
</listitem>
</itemizedlist>
@ -323,7 +419,7 @@
button shows the modules for that agent in the Modules list box.
</para>
<para><b><i>The copy process</i></b> is performed to copy
<para><emphasis><i>The copy process</i></emphasis> is performed to copy
the module and/or alert configuration from the selected source
agents to the selected destination agents. Several agents can be
selected, pressing CTRL and the mouse right button simultaneously.
@ -331,7 +427,7 @@
if the configuration to copy is from modules and/or from alerts.
</para>
<para><b><i>The delete process</i></b> is performed to delete the
<para><emphasis><i>The delete process</i></emphasis> is performed to delete the
configuration of the destination agents, in the multiple selection
list box. Several agents can be selected at a time, and the tick
boxes at the top of the form indicate whether it is the modules
@ -377,19 +473,19 @@
<para>The list of agents shows all the relevant the information
in the following columns:</para>
<para><b>Agent:</b> Shows the agent's name.</para>
<para><b>SO:</b> Displays an icon that represents the
<para><emphasis>Agent:</emphasis> Shows the agent's name.</para>
<para><emphasis>SO:</emphasis> Displays an icon that represents the
Operating System.</para>
<para><b>Interval:</b> Shows the time interval (seconds)
<para><emphasis>Interval:</emphasis> Shows the time interval (seconds)
in which the agent sends data to the server.</para>
<para><b>Group:</b> This is the group the agent belongs to.</para>
<para><b>Modules:</b> Under normal circumstances this field
<para><emphasis>Group:</emphasis> This is the group the agent belongs to.</para>
<para><emphasis>Modules:</emphasis> Under normal circumstances this field
shows the values representing the number of modules and
the number of monitors, both in black. If the status of a monitor
changes to "incorrect", one additional number is shown: the number
of modules, the number of monitors and the number of monitors with
"incorrect" status, all in black save the last one.</para>
<para><b>Status:</b> Shows the "general" status of the agent
<para><emphasis>Status:</emphasis> Shows the "general" status of the agent
through the following icons:</para>
<para>
<graphic fileref="../../images/b_green.gif"/>
@ -403,7 +499,7 @@
want to avoid this, and keep our systems in a healthy
green colour.
<graphic fileref="../../images/b_blue.gif"/> The agent
doesn't have <u>any</u> data. New agents with an empty data
doesn't have any data. New agents with an empty data
package can have this status.
<graphic fileref="../../images/b_yellow.gif"/> Colour
shifting from green to red. This icon indicates
@ -414,7 +510,7 @@
value in seconds. Usually it is due to a communication issue
or a crashed remote system.>
</para>
<para><b>Alerts:</b> Shows if any alerts have been sent
<para><emphasis>Alerts:</emphasis> Shows if any alerts have been sent
through the following icons:</para>
<para>
<graphic fileref="../../images/dot_green.gif"/>
@ -423,7 +519,7 @@
When at least one alert has been sent within
the time threshold of the alert.
</para>
<para><b>Last contact:</b> Shows the time and date of the
<para><emphasis>Last contact:</emphasis> Shows the time and date of the
last data package sent by the agent, using a progress bar,
according to value of the interval. If you see the image
<graphic fileref="../../images/outof.gif"/>,
@ -431,7 +527,7 @@
Passing the mouse over the image will show you the last contact
in time and date format.</para>
<para><b><u>Note:</u></b> The icon
<para><emphasis>Note:</emphasis> The icon
<graphic fileref="../../images/setup.gif" width="15"/>
is only visible if you're and administrator and it's a link
to the "Manage Agents" &gt; "Update Agent" option in the
@ -462,14 +558,14 @@
<para>In this list the module information is shown
in the following columns:</para>
<para><b>Module name:</b> Name given to the module
<para><emphasis>Module name:</emphasis> Name given to the module
in the agent's config file.</para>
<para><b>Module type:</b> Type of module as described
<para><emphasis>Module type:</emphasis> Type of module as described
in <a href="#321">section 3.2.1</a>.</para>
<para><b>Description:</b> Description given to the module
<para><emphasis>Description:</emphasis> Description given to the module
in the agent's config file.</para>
<para><b>Data:</b> Last data sent by the agent.</para>
<para><b>Graph:</b> Monthly(M), Weekly(W), Daily(D)
<para><emphasis>Data:</emphasis> Last data sent by the agent.</para>
<para><emphasis>Graph:</emphasis> Monthly(M), Weekly(W), Daily(D)
and Hourly(H) graphs are generated with
the data sent by the agent against time.</para>
@ -477,27 +573,27 @@
data is represent, and on the right had side the oldest.</para>
<para>The generated graphs are:</para>
<para> - <b>Hourly graph</b>
<para> - <emphasis>Hourly graph</emphasis>
(<graphic fileref="../../images/grafica_h.gif"/>)
covers a 60 minute interval</para>
<graphic fileref="images/image018.png" valign="bottom" align="center"/>
<para> - <b>Daily graph</b>
<para> - <emphasis>Daily graph</emphasis>
(<graphic fileref="../../images/grafica_d.gif"/>)
covers a 24 hour interval</para>
<graphic fileref="images/image019.png" valign="bottom" align="center"/>
<para> - <b>Weekly graph</b>
<para> - <emphasis>Weekly graph</emphasis>
(<graphic fileref="../../images/grafica_w.gif"/>)
covers a 7 day interval</para>
<graphic fileref="images/image020.png" valign="bottom" align="center"/>
<para> - <b>Mothly graph</b>
<para> - <emphasis>Mothly graph</emphasis>
(<graphic fileref="../../images/grafica_m.gif"/>)
covers a 30 day interval</para>
<graphic fileref="images/image021.png" valign="bottom" align="center"/>
<para><b>Raw Data:</b> This is the raw data sent by the agent</para>
<para><emphasis>Raw Data:</emphasis> This is the raw data sent by the agent</para>
<para> - <graphic fileref="../../images/data_m.gif"/> Last month</para>
<para> - <graphic fileref="../../images/data_w.gif"/> Last week</para>
@ -514,14 +610,14 @@
<para>The list shows the information about the monitors in the
following columns:</para>
<para><b>Agent:</b> Agent where the monitor is defined.</para>
<para><b>Type:</b> Data type of the monitor. For a monitor this
<para><emphasis>Agent:</emphasis> Agent where the monitor is defined.</para>
<para><emphasis>Type:</emphasis> Data type of the monitor. For a monitor this
value is always of the generic_proc type.</para>
<para><b>Module name:</b> Name given to the module when it was
<para><emphasis>Module name:</emphasis> Name given to the module when it was
created.</para>
<para><b>Description:</b> Description given to the module
<para><emphasis>Description:</emphasis> Description given to the module
in the agent's config file.</para>
<para><b>Status:</b> The table shows the agent status through
<para><emphasis>Status:</emphasis> The table shows the agent status through
the following icons:</para>
<para><graphic fileref="../../images/b_green.gif"/>
@ -529,7 +625,7 @@
<para><graphic fileref="../../images/b_red.gif"/>
The monitor is failing</para>
<para><b>Last contact:</b> Shows the time and date of
<para><emphasis>Last contact:</emphasis> Shows the time and date of
the last data packaged received from the agent</para>
</sect3>
@ -544,15 +640,15 @@
<para>The monitor information is shown in the list
divided in the following fields:</para>
<para><b>ID:</b> Agent were the alert has been defined.</para>
<para><b>Type:</b> Type of alert.</para>
<para><b>Description:</b> Description given to the alert when
<para><emphasis>ID:</emphasis> Agent were the alert has been defined.</para>
<para><emphasis>Type:</emphasis> Type of alert.</para>
<para><emphasis>Description:</emphasis> Description given to the alert when
it was created.</para>
<para><b>Last fired:</b> The last time the alert was
<para><emphasis>Last fired:</emphasis> The last time the alert was
executed.</para>
<para><b>Times Fired:</b> Number of times the alert was
<para><emphasis>Times Fired:</emphasis> Number of times the alert was
launched.</para>
<para><b>Status:</b> Shows if the alert has been sent through
<para><emphasis>Status:</emphasis> Shows if the alert has been sent through
the following icon:</para>
<para><graphic fileref="../../images/dot_green.gif"/> No alerts
@ -573,12 +669,12 @@
<para>The groups are displayed ordered by the following columns:</para>
<para><b>Groups:</b> Name of the group</para>
<para><b>Agents:</b> Number of agents configured
<para><emphasis>Groups:</emphasis> Name of the group</para>
<para><emphasis>Agents:</emphasis> Number of agents configured
in the group.</para>
<para><b>Monitors:</b> Number of monitors configured
<para><emphasis>Monitors:</emphasis> Number of monitors configured
in the group.</para>
<para><b>Status:</b> The status is described through
<para><emphasis>Status:</emphasis> The status is described through
the following icons:</para>
<para><graphic fileref="../../images/b_green.gif"/>
@ -591,9 +687,9 @@
<para><graphic fileref="../../images/b_white.gif"/>
This Agent doesn't have any monitor defined.</para>
<para><b>OK:</b> Number of monitors that are OK.</para>
<para><b>Failed:</b> Number of failing monitors.</para>
<para><b>Down:</b> Number of down monitors.</para>
<para><emphasis>OK:</emphasis> Number of monitors that are OK.</para>
<para><emphasis>Failed:</emphasis> Number of failing monitors.</para>
<para><emphasis>Down:</emphasis> Number of down monitors.</para>
</sect2>
<sect2>
<title>Monitors view</title>
@ -635,15 +731,15 @@
<para>The fields in the results of Exporting data are:</para>
<para><b>Module:</b> Module name.</para>
<para><b>Data:</b> Data contained by the module.</para>
<para><b>Timestamp:</b> Date and time of the the package
<para><emphasis>Module:</emphasis> Module name.</para>
<para><emphasis>Data:</emphasis> Data contained by the module.</para>
<para><emphasis>Timestamp:</emphasis> Date and time of the the package
was sent by the agent.</para>
<graphic fileref="images/image029.png" valign="bottom" align="center"/>
<para>Selecting the CSV format for the output, a text
file with extension <b>.csv</b> is be created. The data
file with extension <emphasis>.csv</emphasis> is be created. The data
is qualified by single quotes
and the fields separated by commas:</para>