Difference between pages "Pandora: Documentation es: Configuracion Agentes" and "Pandora: Documentation en: Discovery"

From Pandora FMS Wiki
(Difference between pages)
Jump to: navigation, search
(module_logchannel)
 
(NetScan)
 
Line 1: Line 1:
[[Pandora:Documentation|Volver a Indice de Documentacion Pandora FMS]]
 
  
= Agentes software de Pandora FMS =
+
=What is Pandora FMS Discovery?=
  
== Qué es un agente software ==
+
{{Tip|Available for Pandora FMS 732 versions or higher.}}
  
Como su nombre indica, son pequeñas piezas de software que se instalan en los sistemas operativos y permanecen ejecutándose en ellos para extraer información de monitorización y enviarla al servidor de Pandora FMS regularmente.
+
Discovery provides a set of tools to simplify monitoring through wizards.
  
Utilizan los comandos y herramientas propias del sistema operativo en que están instalados para obtener la información. Conforman los datos en un fichero en formato XML y los envían al servidor de datos de Pandora FMS, que los procesa y almacena en la base de datos.
+
The following tools are included:
  
Cada uno de los chequeos individuales es denominado ''Módulo''.
+
;Task list: Pandora FMS Discovery tool allows you to see a list of all the tasks programmed in your environment, both at console and server levels.
 +
;Discovery Applications: It allows to monitor MySQL, Oracle or VMware environments from a new management console.
 +
;Discovery Cloud: Through this feature, you may monitor your cloud infrastructure, ranging from virtual machines created through Amazon Web Services (EC2) or relational databases in AWS RDS, to virtual machines running in Azure Compute.
 +
;Console Tasks: It allows you to automate console tasks within the Discovery system, like scheduling reports, doing backups or executing custom scripts from Pandora FMS Console.
 +
;Discovery Host&Devices: It includes the tools needed to discover or import devices and equipment to your network.
  
== Introducción a la configuración del agente ==
+
<center>
 +
[[File:discovery1.png]]
 +
</center>
  
El funcionamiento del agente software está determinado por su fichero de configuración, llamado ''pandora_agent.conf'', ubicado en el directorio de instalación en sistemas Windows, y en ''/etc'' en sistemas Linux.
+
=Discovery Task list=
  
El fichero de configuración contiene todos los parámetros de funcionamiento y los módulos de ese agente.
+
Pandora FMS Discovery tool allows you to see a list of all the tasks programmed in your environment, both at console and server levels.  
  
== Parámetros generales del agente ==
+
<center>
 +
[[File:DISC_Task_list_1.JPG]]
 +
</center>
  
Los parámetros generales del agente de configuración aparecen definidos en esta sección. La mayoría son comunes para sistemas Windows y Linux.
+
==Console tasks==
  
{{warning|La primera vez que se reciben datos del agente se guarda toda la información en la base de datos. Para sucesivos envíos de información (y dependiendo si está habilitado el modo aprendizaje) sólo se actualizarán los siguientes campos del XML: '''versión''', '''fecha''' y '''versión de SO''', así como los siguientes parámetros del archivo de configuración '''gis_exec''', '''latitude''', '''longitude''', '''altitude''', '''parent_agent_name''', '''timezone_offset''', '''address''', '''custom_field'''}}
+
This section allows you to see the list of scheduled tasks in the console. The information is shown according to the following parameters:  
  
 +
* User: It is the user who created the task.
 +
* Task: Description of the programmed task
 +
* Scheduled: It specifies how often the task will be executed.
 +
* Next Execution: It specifies the next task execution.
 +
* Last Execution: It indicates when the task was last executed.
 +
* Group: The group to which the task belongs.
 +
* Operations: It shows the actions that can be performed on the task, such as editing and deleting.
  
{{warning|'''La codificación del archivo de configuración del agente es UTF-8''' tanto en sistemas Linux como Windows. Si realiza ediciones a mano de este fichero verifique que la codificación es correcta antes de sobreescribirlo. Si la codificación no es UTF-8 y usted utiliza símbolos (como tildes o símbolos extendidos), el agente interpretará erróneamente estos, no pudiendo garantizar una correcta interpretación de su configuración.}}
+
===Edit Console tasks===
  
 +
This button allows access to the creation section, where the desired task can also be edited according to the following parameters:
  
===server_ip===
+
* Task: The task that will be executed among the following:
 +
** Backup Pandora FMS database.
 +
** Execute custom script.
 +
** Save custom report to disk.
 +
** Save custom XML report to disk.
 +
** Send custom report (from template) by email.
 +
** Send custom report by email.
  
Dirección IP o nombre del servidor de Pandora FMS al que se enviarán los datos.
+
* Scheduled: It is used to specify how often the task will be executed.
 +
* Next execution: It shows the date of the next execution, being able to modify it if necessary.
 +
* Group: Group to which the task belongs.
 +
* Parameters: They are the specific parameters of each task.  
  
===server_path===
+
==== Parameters of different tasks ====
 +
<br>
 +
;Backup Pandora FMS database:
 +
* Description: Backup description.
 +
* Save to disk in path: Path where the backup will be stored.<br><br>
 +
;Execute custom script:
 +
* Custom script: The script to be executed will be indicated.<br><br>
 +
;“Save custom report to disk” and “Save custom XML report to disk”:
 +
* Report pending to be created: The report to be created.
 +
* Save to disk in path: Path where the created report will be stored.<br><br>
 +
;Send custom report (from template) by email:
 +
* Template pending to be created: Custom template to be created.
 +
* Agents: Agents from which the information that will be reflected in the report will be obtained.
 +
* Report per agent: If you wish to generate separate reports for each report.
 +
* Report name: Name that you wish to give the report.
 +
* Send to email addresses: Email addresses to which the report will be sent.
 +
* Subject: Topic of the mail to be sent.
 +
* Message: Body of the message with which the reports will be sent.<br><br>
 +
;Send custom report by email:
 +
* Report pending to be created: Report to be generated.
 +
* Send to email addresses: Email addresses the report will be sent to.
 +
* Subject: Topic of the mail to be sent.
 +
* Message: Body of the message with which the reports will be sent.
 +
* Report Type: Type of report that will be sent.
  
Ruta del servidor donde este recibe los ficheros de datos enviados por los agentes. Por defecto ''/var/spool/pandora/data_in''.
+
==Server tasks==
  
===temporal===
+
This section reflects the recognition tasks programmed by the server. The information is shown according to the following parameters:
  
Ruta donde el agente almacena los ficheros de datos antes de que sean enviados al servidor y eliminados localmente.
+
* Force: Option that will allow forcing the task execution.
 +
* Task name: Name assigned to the task.
 +
* Server name: Server that will execute the task.
 +
* Interval: Time interval during which the task will be performed.
 +
* Network: Network where the checks will be made.
 +
* Status: Status of the scheduled task.
 +
* Task type: Type of the task that has been generated.
 +
* Progress: Progress of the task in case of being executed.
 +
* Updated at: It indicates when the task was last executed.
 +
* Operations: Actions that can be performed on the task. Display of the task status, display of the map of the discovered network, editing and deletion.  
  
===description===
+
===Operations===
  
Envía la descripción del agente en el XML, y Pandora FMS importa esta descripción cuando crea el agente.
+
The edition of the server recognition tasks allows to adjust the following parameters:
  
===group===
+
* Interval: The task execution interval can be set, either manually or defined.
 +
* Task name: Task Name.
 +
* Discovery server: Server that will perform the recognition task. It is a mandatory parameter for correct recognition operation.
 +
* Network: Network on which the checks are to be carried out.
 +
* Group: Group to which it belongs.
 +
* Comment: Comments to add.
  
Si existe un grupo con el nombre indicado en este parámetro, el agente se creará dentro de este grupo a no ser que el servidor fuerce la creación de todos los agentes en un grupo determinado.
+
=Discovery Applications=
  
===temporal_min_size===
+
Now, it is possible to monitor applications remotely using ''Discovery Applications''.
  
Si el espacio libre (en mega bytes) de la partición en la que se encuentra el directorio temporal es menor que este valor, no se siguen generando paquetes de datos. De este modo se evita que se llene el disco si por alguna razón se pierde la conexión con el servidor durante un intervalo de tiempo prolongado.
 
  
===logfile===
+
<center>
 +
[[File:discoverysap1.png]]
 +
</center>
  
Ruta del log del agente de Pandora FMS.
+
==Discovery Applications: MySQL==
  
===interval===
+
From Pandora FMS 7.0-733 version on, MySQL environments can be monitored using Discovery Applications.
  
En segundos, tiempo de muestreo del agente. Cada vez que se complete este intervalo el agente recogerá información y la enviará al servidor de Pandora FMS.
+
For that purpose, it will be necessary to define the following parameters:
  
===disable_logfile===
+
* Task name: Name of the task that will perform MySQL monitoring.
 +
* Discovery Server: Server that will perform the execution of the specified task.
 +
* Group: Group to which it belongs.
 +
* MySQL server IP: IP of the server where the MySQL environment to be monitored is.
 +
* MySQL server port: Port of the specified address through which the information of MySQL monitoring will be obtained.
 +
* User: MySQL user with which to login. (Important: It must be a user with permissions on the database where the queries will be executed, since otherwise the connection will never be established.)
 +
* Password: MySQL user password specified above.
 +
* Interval: Time interval in which monitoring will be executed.
  
Inhabilita la escritura en pandora_agent.log. Solo para Windows.
+
<center>
 +
[[File:DISCMySQL1.JPG]]
 +
</center>
  
===debug===
+
Once the parameters with the data needed for installation are defined, you will be shown a new window where you must specify the agent on which you wish to create all the modules resulting from MySQL monitoring.
  
Si se encuentra activo (1), los ficheros de datos del agente son almacenados y renombrados en el directorio temporal y no son eliminados tras enviarse al servidor, pudiendo abrir los archivos XML y analizar su contenido.
+
The options to be displayed are the following:
  
===agent_name===
+
* Target agent: Agent on which the modules resulting from monitoring will be created.
 +
* Custom module prefix: It defines a custom prefix that will be concatenated with the name of the modules generated by the task.
 +
* Scan databases: It will scan the databases.
 +
* Create agent per database: This option will allow an agent to be created for each database found in MySQL environment.
 +
* Check engine uptime: It will check the time that MySQL engine is operational.
 +
* Retrieve query statistics: It allows to recover the statistics of the executed queries.
 +
* Analyze connections: It analyzes connections.
 +
* Retrieve InnoDB statistics: It returns InnoDB statistics.
 +
* Retrieve cache statistics: It returns cache statistics.
 +
* Custom queries: It allows defining custom statements.
  
Permite establecer un nombre personalizado. Si no se encuentra habilitado, el nombre del agente será el hostname de la máquina.
+
<center>
 +
[[File:DISCMySQL2.JPG]]
 +
</center>
  
===(>=5.1SP2) agent_name_cmd===
+
==Discovery Applications: Oracle==
  
Define el nombre del agente utilizando un comando externo. Si agent_name_cmd está definido, agent_name se ignora. El comando deberá devolver el nombre del agente por STDOUT. Si devuelve varias más de una línea solo se utilizará la primera.
+
From Pandora FMS 7.0-733 version on, Oracle can be monitored using Discovery Applications.
  
===(>=7.0) agent_alias_cmd===
+
Oracle monitoring will allow to define the following parameters:
  
Define el alias del agente utilizando un comando externo. Si agent_alias_cmd está definido, agent_alias se ignora. El comando deberá devolver el nombre del agente por STDOUT. Si devuelve varias más de una línea solo se utilizará la primera.
+
* Task name: Task Name
 +
* Discovery server: Server that will run the Oracle monitoring task.  
 +
* Group: Group it belongs to.  
 +
* Oracle target strings: Where the target strings of the task will be defined.  
 +
* User: Oracle user that will access to perform the monitoring.  
 +
* Password: Password of the previously defined user.
 +
* Interval: Execution interval
  
===address===
+
<center>
 +
[[File:DISC_Oracle1.JPG]]
 +
</center>
  
Este es la dirección IP asociada al agente software. Puede ser una IP con el formato X.X.X.X, un nombre de dominio como 'localhost' o 'auto'. Si es una IP o nombre de dominio, este se añadirá a la colección de direcciones del agente y se establecerá como principal. Si es 'auto', se obtendrá la dirección IP de la máquina y se añadirá al agente del mismo modo que en el caso anterior.
+
Once defined, it will be necessary to specify the agent that will store the information and the checks that will be made. The information that can be defined in this section is the following:
  
===encoding===
+
* Target agent: Agent that will receive Oracle monitoring information.
 +
* Custom module prefix: It defines a custom prefix that will be concatenated with the name of the modules generated by the task.
 +
* Check engine uptime: It will check the time that Oracle is operational.
 +
* Retrieve query statistics: It allows to recover the statistics of the executed queries.
 +
* Analyze connections: It analyzes connections.
 +
* Calculate fragmentation ratio: It calculates the fragmentation rate.
 +
* Monitor tablespaces: It monitors tablespaces. 
 +
* Retrieve cache statistics: It returns cache statistics.
 +
* Execute custom queries: It executes custom queries.
 +
* Custom queries: it allows to define customized queries.
  
Instala el tipo de codificación del sistema local, como por ejemplo iso-8859-15, o utf-8.
+
<center>
 +
[[File:DISC Oracle2.JPG]]
 +
</center>
  
===server_port===
+
=== Installing Oracle packages ===
  
Puerto en el que el Tentacle del servidor de Pandora FMS escucha para recibir los archivos de datos. 41121 por defecto.
+
It is very important to bear in mind that for the correct integration and operation of Oracle with Pandora FMS, it is necessary to have the appropriate packages. Pandora FMS ISO includes everything necessary, but for installations carried out in another way, the installation process will be as follows:
  
===transfer_mode===
+
* Install oracle instant client from the Oracle page:
 +
https://www.oracle.com/technetwork/database/database-technologies/instant-client/downloads/index.html
  
Modo de transferencia de los archivos de datos al servidor de Pandora FMS. Tentacle por defecto.
+
* Required packages:
  
=== (>= 6.0) transfer_timeout ===
+
oracle-instantclient11.1-basic-11.1.0.7.0-1.x86_64.rpm
 +
oracle-instantclient11.1-devel-11.1.0.7.0-1.x86_64.rpm
 +
oracle-instantclient11.1-sqlplus-11.1.0.7.0-1.x86_64.rpm
  
Timeout para la transferencia de ficheros, si se supera el número de segundos indicado sin completar la transferencia, esta será cancelada.
+
* Prepare the boot environment of pandora_server:
  
===server_pwd===
+
{{Warning|In the pandora_server path you need to create a file called pandora_server.env with the following information. Its execution is needed ./pandora_server.env}}
  
Específica para la contraseña del FTP de Windows y para el modo de transferencia Tentacle, aunque la contraseña en este último es opcional. Contraseña del servidor para la autenticación con contraseña.
+
# Set Oracle environment for pandora_server
   
+
cat > /etc/pandora/pandora_server.env << 'EOF_ENV'
===server_ssl===
+
  #!/bin/bash
 +
VERSION=11.1
 +
export PATH=$PATH:$HOME/bin:/usr/lib/oracle/$VERSION/client64/bin
 +
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/oracle/$VERSION/client64/lib
 +
export ORACLE_HOME=/usr/lib/oracle/$VERSION/client64
 +
EOF_ENV
  
Específica para el modo de transferencia Tentacle. Permite habilitar (1) o deshabilitar (0) el cifrado de las conexiones mediante SSL.
+
* Restart pandora_server
  
===server_opts===
+
/etc/init.d/pandora_server restart
  
Para añadir opciones adicionales al ejecutar el cliente de Tentacle en la transferencia de archivos. Utilizado para configuraciones avanzadas de Tentacle con opciones de seguridad.
+
{{Warning|If package E7 is being used, version 12.2 of both library and environment variables must be installed, and Oracle (v12.2) packages must be used}}
  
Desde la versión 3.2 de los agentes, el cliente de Tentacle soporta una opción para poder usar un proxy HTTP para enviar los datos al servidor. Este proxy HTTP debe tener habilitado el método CONNECT. Para poder usar la salida a través de un proxy, usamos la siguiente opción (ejemplo):
+
== Discovery Applications: SAP ==
 +
<br>
 +
Discovery Applications has a new family member from Pandora FMS version 741 onwards. This new feature will now be included in the official ISO installation.  
 +
<br>
 +
{{Warning|If you Pandora FMS is installed from packages, or your system is prior to NG741, deploy the official SAP plugin in Pandora FMS server and configure it manually (see below).}}
  
server_opts -y user:[email protected].inet:8080
+
{{Warning|In order to use SAP in Discovery, configure a specific license number for this plugin, which is not included in Pandora FMS Enterprise license. Configure this license in Setup > Enterprise.}}
  
Esta opción fuerza al cliente de Tentacle a enviar los datos a través de un proxy situado en ''proxy.inet'' y que usa el puerto ''8080'', usando el usuerio "user" y el password "pass" para autenticarse en dicho proxy. Si por ejemplo, es preciso usar un proxy sin autenticacion, en un servidor en 192.168.1.2 y con el puerto 9000, la opción sería asi:
+
The system will guide you along each step to configure SAP, according to your needs. You may define the same task to monitor systems with similar configurations.
  
server_opts -y 192.168.1.2:9000
+
<center>
 +
[[File:discoverysap2.png]]
 +
</center>
  
===delayed_startup===
+
In the example above, servers sapsample.artica.lan, sap2.artica.lan and 10.0.30.33 use the same client, system and credential configuration, so they can be grouped in the same task.
  
En segundos, tiempo de espera hasta que el agente empieza a funcionar una vez iniciado. Deshabilitado por defecto. Sólo válido en agentes Linux/Unix.
+
{{Warning|If you need to monitor different configurations, create a task for each configuration.}}
  
===pandora_nice===
+
Select from the list the information about the SAP system you wish to retrieve as shown below:
  
Este parámetro permite especificar la prioridad que el proceso del agente de Pandora FMS tendrá en el sistema. Sólo está disponible para agentes Unix/Linux.
+
<center>
 +
[[File:discoverysap3.png]]
 +
</center>
  
===autotime===
+
Pandora FMS Discovery will be in charge of collecting information, storing it in agents represented by the defined ¨SAP Hostnames¨.
  
Si está habilitado (1) envía un timestamp de ejecución especial (AUTO) que hace que el servidor utilice la fecha / hora local del servidor para establecer la hora de los datos, ignorando la hora enviada por el agente. Esto es necesario en aquellos agentes que por la razón que sea, tienen una hora incorrecta o muy diferente de la del servidor.
 
  
===cron_mode===
+
=== SAP Discovery connector manual installation ===
  
Con este parámetro es posible hacer que el agente use el propio crontab de Linux para ejecutarse en un intervalo determinado en vez de usar el propio sistema interno del agente para ejecutarse cada cierto tiempo. Desactivado por defecto.
+
If your Pandora FMS version was installed before the NG741 version, download the connector and configure it manually.
  
===remote_config===
+
First, install JAVA (JRE) on Pandora FMS server for Discovery SAP operation.
  
(Sólo Pandora FMS Enterprise)
+
Then you need to download the remote connector/plugin for Linux from SAP, download it from [https://pandorafms.com/library/sap-r3-monitoring-agent/ our library].
  
Habilita (1) o deshabilita (0) la configuración remota de los agentes. Su funcionamiento solo se permite con el modo de transferencia Tentacle.
+
Configure your pandora_server.conf too, and set the following parameters:
  
===xml_buffer===
+
  # Discovery SAP
 
+
  java /usr/bin/java
Si se habilita (1), el agente guardará en su directorio temporal los ficheros XML que no haya podido enviar al servidor en caso de un problema de conectividad. Serán enviados cuando se restablezcan las comunicaciones.
 
 
 
===timezone_offset===
 
 
 
Ahora el agente puede instalar su timezone offset con el servidor. Esto le permite al servidor hacer un desplazamiento de la hora recogida por el agente, de forma que concuerde con la hora local del servidor.
 
 
 
  # Timezone offset: Difference with the server timezone
 
  timezone_offset 3
 
 
 
Se calcula restándole la zona horaria del agente a la zona horaria del servidor. Por ejemplo, si el servidor está en la zona horaria UTC+1 y el agente está en la zona horaria UTC-5, timezone_offset debería ser 6 = 1 - (-5).
 
 
 
===parent_agent_name===
 
 
 
Indica el padre del agente software. Debe ser el nombre de un agente existente en Pandora FMS.
 
 
 
===agent_threads===
 
 
 
Número de hilos que lanzará el agente para ejecutar módulos en paralelo. Por defecto los módulos se ejecutan uno tras otro sin lanzar ningún hilo adicional. Sólo está disponible para agentes Unix/Linux.
 
 
   
 
   
  # Number of threads to execute modules in parallel
+
  # Discovery SAP utils
  agent_threads 4
+
  sap_utils /usr/share/pandora_server/util/recon_scripts/SAP
  
===include <fichero>===
+
In the directory indicated, with the configuration token ''sap_utils'' decompress the files that you will find in the tarball downloaded from the library called "Pandora FMS SAP Discovery for Linux" that contains the following files:
  
Permite incluir un fichero de configuración adicional. Este archivo puede incluir módulos y colecciones adicionales a las del archivo principal. El fichero lo podrán subir aquellos usuarios que tengan permisos de, al menos, escritura sobre agentes(AW).
+
Deset_SAP_Plugin.jar
 +
dev_jco_rfc.trc
 +
libsapjco3.so
 +
sapjco3.dll
 +
sapjco3.jar
  
===broker_agent <nombre>===
+
Once the configuration file is modified, restart the Pandora FMS server.
  
Habilita la funcionalidad de agente broker. Para activarlo únicamente es necesario descomentar el parámetro e indicar el nombre que se asignará al agente broker:
+
=== SAP View ===
 +
<br>
 +
You can see the general state of the SAP system servers in the SAP View.  
  
broker_agent Nombre_broker
+
<center>
 +
[[File:discoverysap4.png]]
 +
</center>
  
===pandora_user <usuario>===
+
This view will display a panel with the available SAP modules of the selected SAP agent.
  
Este parámetro es opcional y permitirá ejecutar el agente con el usuario del sistema que se especifique. Este usuario deberá contar con los permisos para poder ejecutar el agente y sus recursos asociados.
+
You may select the refresh time and the interval to show in the graphs.  
 +
<br>
 +
<br>
  
===(>= 5.X) custom_id===
+
=== SAP agent view ===
 +
<br>
 +
The SAP view is also integrated as a new tab within the agent view. If the system detects that the agent is a SAP agent, an access to the SAP View tab will be displayed:
  
Id personalizado del agente para aplicaciones externas.
+
<center>
 +
[[File:discoverysap5.png]]
 +
</center>
  
===(>= 5.X) url_address===
+
The agent view will provide an overview of the status of the SAP modules for the current agent:
  
URL personalizada para abrirla desde el agente en la consola.
+
<center>
 +
[[File:discoverysap6.png]]
 +
</center>
  
===(>= 5.X) custom_fieldX_name===
+
<br>
  
Nombre de un campo personalizado de agentes que ya exista en el sistema. Si no existe, se ignorará.
+
{{Warning|Java must be installed within the server for SAP integration to work.}}
  
Ejemplo:
+
== Discovery Applications: VMware ==
  
custom_field1_name Model
+
{{Warning|In case of manual installation or update from a '''Pandora FMS''' version prior to '''732''', it is necessary to install '''SDK''' for VMWare to work properly.}}
  
===(>= 5.X) custom_fieldX_value===
+
From Pandora FMS 7.0-733 version on, VMware infrastructures can be monitored using Discovery Applications.  
  
Valor para el custom field X definido en el parámetro anterior.
 
  
Ejemplo:
+
<center>
 +
[[File:discoveryapplications2.png]]
 +
</center>
  
custom_field1_value C1700
 
  
=== (> 5.1 Unix agent only) macro<macro> <value> ===
+
The following must be specified:
  
Define una macro de ejecución local que se puede utilizar en la definición de un módulo. Estas macros se utilizan en el sistema de la Metaconsola y en el sistema de componentes de módulos locales para "abstraer" la dificultad de usar un módulo editando directamente el código, presentando a un usuario menos avanzado, una interfaz local que permita "rellenar" valores. Estos valores se emplean por debajo, usando un sistema de macros, relativamente similar al sistema de macros de los plugins locales.  
+
* A name to identify the task.
 +
* A Discovery server where to run it.
 +
* A group to which the agents generated by the VMware task will be associated.
  
Las macros de ejecución locales comienzan por _fieldx_
+
{{Tip|It must be taken into account that if the Pandora FMS server has the '' autocreate_group '' token active, priority will be given to the group corresponding to the indicated ID, instead of applying the configuration of the wizard.}}
  
Ejemplo:
 
  
<pre>
+
The data required to monitor VMware are:
module_begin
 
module_name Particion_opt
 
module_type generic_data
 
module_exec df -kh _field1_ | tail -1 |  awk '{ print $5}' | tr -d "%"
 
module_macro_field1_ /opt
 
module_end
 
</pre>
 
  
=== (>= 6.0SP5) group_password <contraseña> ===
+
* V-Center IP
Contraseña para el grupo del agente. Dejar comentado si el grupo no está protegido por contraseña.
+
* The name of the datacenter (it can be seen through VMware installation management screen).
 +
* User with read permissions.
 +
* User password.
 +
* Monitoring interval.
  
=== (>= 7.0) ehorus_conf <path> ===
+
Password encryption can be enabled by pressing the button '''encrypt passwords'''. This only applies to the wizard in progress.
  
Ruta absoluta a un fichero de configuración válido de un agente de [https://ehorus.com/ eHorus]. El agente creará un campo personalizado llamado ''eHorusID'' que contiene la clave de identificación del agente de eHorus.
 
  
=== (>= 7.0OUM713) transfer_mode_user <usuario> ===
+
On the next page, VMware monitoring details can be specified:
  
Usuario de los ficheros copiados en el modo de transferencia local. En las carpetas de la consola este usuario debe tener permisos de lectura y escritura para que funcione correctamente la configuración remota. Por defecto es ''apache''.
+
<center>
 +
[[File:discoveryapplications3.png]]
 +
</center>
  
=== (>= 7.0OUM721) secondary_groups <grupos secundarios> ===
+
* Max threads: Choose the number of threads that the VMware monitoring script will use to speed up data collection.
 +
* Retry send: The information of the detected agents is sent by XML to the DataServer. This option must be activated to retry sending in case of error.
 +
* Event mode: '''Only for VCenter'''. VMware VCenter event-based monitoring is enabled. This working mode is exclusive and independent from standard monitoring.
 +
* Virtual network monitoring: It enables monitoring of virtual network devices which are defined in VMware.
 +
* Extra settings: Any advanced settings needed to customize VMware monitoring should be included here in text mode. For more information, visit [https://pandorafms.com/docs/index.php?title=Pandora:Documentation_en:Virtual_environment_monitoring#Entity_renaming this section].
 +
<br>
 +
<br>
 +
<br>
 +
<br>
  
Nombre de los grupos secundarios asignados al agente. Se pueden especificar varios grupos secundarios separados por comas. Si alguno de los grupos no existe en el servidor al que se envía la información, no se asignará ese grupo, pero no se verá afectada la creación del agente.
+
==Discovery Applications: MS SQL==
 +
<br>
 +
This new Pandora FMS integration allows monitoring Microsoft SQL server databases.  
  
=== (>= 7.0OUM728) standby <1|0> ===
+
Microsoft <b>ODBC</b> must be installed in the system where Pandora FMS server is running.  
 +
<br>
 +
<br>
 +
{{Tip|From version 745 onwards, ODBC is preinstalled in Pandora FMS ISO.}}
  
Si un agente tiene modo standby 1, el agente no realizará ningún chequeo ni enviará ni generará ningún XML. Esta directiva de configuración tiene sentido en instalaciones Enterprise donde hay configuración remota. Gracias a ello, se puede silenciar un agente a voluntad con solo deshabilitarlo.
+
=== How to install Microsoft ODBC ===
  
El modo debug sobreescribe esta funcionalidad y el agente se ejecuta normalmente.
+
* In <b>CentOS 6</b>:
  
== Servidor Secundario ==
+
curl https://packages.microsoft.com/config/rhel/6/prod.repo > /etc/yum.repos.d/mssql-release.repo && \
 +
yum remove unixODBC-utf16 unixODBC-utf16-devel && \
 +
ACCEPT_EULA=Y yum install -y msodbcsql17
  
Se puede definir un servidor secundario al que se le enviarán los datos en dos posibles situaciones dependiendo de la configuración:
+
* In <b>CentOS 7</b>:
  
* '''on_error''': Envía datos al servidor secundario solo si no puede enviarlas al primario.
+
curl https://packages.microsoft.com/config/rhel/7/prod.repo > /etc/yum.repos.d/mssql-release.repo && \
* '''always''': Siempre envía datos al servidor secundario, independientemente si puede contactar o no con el servidor principal.
+
yum remove unixODBC-utf16 unixODBC-utf16-devel && \
 +
ACCEPT_EULA=Y yum install -y msodbcsql17
  
Ejemplo de configuración:
+
Once the ODBC is installed, it might be necessary to set which driver Pandora FMS should use. To that end, check Pandora FMS server configuration file.
  
  secondary_server_ip    192.168.1.123
+
  /etc/pandora/pandora_server.conf
secondary_server_path  /var/spool/pandora/data_in
 
secondary_mode          on_error
 
secondary_transfer_mode tentacle
 
secondary_server_port  41121
 
  
== Servidor UDP ==
+
Once you go to the configuration file, look for the following token:
  
El agente de Pandora FMS puede configurarse para la escucha de comandos remotos. Este servidor escucha en un puerto UDP especificado por el usuario, y permite recibir órdenes desde un sistema remoto, habitualmente desde la consola de Pandora FMS, mediante la ejecución de alertas en el servidor.
+
mssql_driver IDENTIFYING STRING
  
Para configurar el servidor remoto UDP, existen las siguientes opciones en ''pandora_agent.conf''
+
The <b>IDENTIFYING STRING</b> parameter can be found in <b>/etc/odbcinst.ini</b> which will be created when installing ODBC.
  
* '''udp_server''': Para activar el servidor UDP ponerlo a 1. Por defecto está desactivado.
+
This is the default string:  
* '''udp_server_port''': Puerto en el que escucha.
 
* '''udp_server_auth_address''': Direcciones IP autorizadas para enviar órdenes. Para especificar varias direcciones, hay que separarlas por comas. Si se configura con 0.0.0.0, acepta órdenes de cualquier dirección.
 
* '''process_<name>_start <command>''': Comando que arrancará un proceso definido por el usuario.
 
* '''process_<name>_stop <command>''': Comando que parará el proceso.
 
* '''service_<name> 1''': Permite que el servicio <name> sea parado o arrancado remotamente desde el servidor UDP.
 
  
Ejemplo de configuración:
+
ODBC Driver 17 for SQL Server
  
udp_server 1
+
=== Configure a Discovery Applications MS SQL task ===
udp_server_port 4321
 
udp_server_auth_address 192.168.1.23
 
process_firefox_start firefox
 
process_firefox_stop killall firefox
 
service_messenger 1
 
  
El servidor acepta los siguientes comandos:
+
To create a monitoring task for a Microsoft SQL Server database, access through Discovery (Discovery > Applications > Microsoft SQL Server).
  
* '''<START|STOP> SERVICE <nombre del servicio>''': Inicia o para un servicio.
+
Once you choose the Microsoft SQL Server task, you may define the instances in the following way:  
* '''<START|STOP> PROCESS <nombre del proceso>''': Crea o mata un proceso.
 
* '''REFRESH AGENT <nombre del agente>''': Fuerza una ejecución del agente, refrescando los datos.
 
  
Por ejemplo:
+
IP\Instance
  
STOP SERVICE messenger
+
If you wish so, define a port like this:
START PROCESS firefox
 
REFRESH AGENT 007
 
  
Existe un script en el servidor, en ''/util/udp_client.pl'' que es el usado por Pandora FMS Server como comando de una alerta, para arrancar procesos, o servicios. Tiene esta sintaxis:
+
IP:Port\Instance
  
./udp_client.pl <address> <port> <command>
+
<center>
 +
[[File:mssql1.png]]
 +
</center>
  
  
Por ejemplo, para reiniciar un agente:
+
This integration's configuration advanced options include service stability, usage statistics, connection status and custom queries.
  
./udp_client.pl 192.168.50.30 41122 "REFRESH AGENT"
+
<center>
 +
[[File:mssql3.png]]
 +
</center>
  
Para más información, vea el capítulo de configuración de alertas.
+
If you wish to execute any custom query, keep in mind they follow the same format as those of Oracle.
  
== Definición de los módulos ==
+
=Discovery Cloud=
  
Los módulos de ejecución local se definen en el fichero de configuración ''pandora_agent.conf''. A continuación explicamos todos los parámetros que pueden aceptar.
+
Discovery Cloud allows you to monitor structures in the AWS cloud. Thanks to Pandora FMS, you can manage many Amazon Web Services accounts as well as Microsoft Azure's, concentrating information management in a single tool.
  
La sintaxis general es la siguiente:
+
<center>
 +
[[File:azure66.JPG]]
 +
</center>
  
module_begin
+
Account management, both from AWS and Microsoft Azure, will be made through the <b>Credential Store</b> located in Profiles -> Manage agent groups -> Credential Store.
module_name <Nombre Módulo>
 
module_type generic_data
 
module_exec <Comando local a ejecutar>
 
module_end
 
  
Existen multitud de opciones adicionales para los módulos, en este ejemplo únicamente hemos utilizado las líneas comunes y obligatorias para la mayoría de ellos.
+
<center>
 +
[[File:credential_store.png]]
 +
</center>
  
=== Elementos comunes de todos los módulos ===
+
==Discovery Cloud: Amazon Web Services (AWS)==
  
{{warning|Los campos del módulo (salvo el dato del módulo, la descripción y la información extendida) sólo se actualizan en la creación del módulo, nunca se actualizarán una vez que el módulo ya existe.}}
+
{{Warning|This section is under construction.}}
  
==== module_begin ====
+
To monitor an infrastructure in Amazon Web Services, follow the different pages of the wizard step by step.
  
Etiqueta de inicio de un módulo. Obligatorio.
 
  
==== module_name <nombre> ====
+
=== AWS. Credential validation ===
  
Nombre del módulo. No pueden existir dos módulos con el mismo nombre en el mismo agente. Obligatorio.
 
  
==== module_type <tipo> ====
+
Pandora FMS allows managing several AWS accounts. Once you have accessed the Amazon Web Services menu, the navigation will be automatically redirected to the window to select the account with which you need to access the service. If there is a previously created account in previous versions of Pandora FMS, it will be shown as "imported_aws_account".
  
Tipo de datos que devolverá el módulo. Obligatorio.
+
<center>
Los tipos disponibles son:
+
[[File:AWSCredentials1.JPG]]
 +
</center>
  
* '''Numérico''' (generic_data). Datos numéricos sencillos, con coma flotante o enteros.
+
You can add as many accounts as necessary through the "Manage Accounts" option next to the AWS Account drop-down.
  
* '''Incremental''' (generic_data_inc). Dato numérico igual a la diferencia entre el valor actual y el valor anterior divida por el número de segundos transcurridos. Cuando esta diferencia es negativa, se reinicia el valor, esto significa que cuando la diferencia vuelva a ser positiva de nuevo se tomará el valor anterior siempre que el incremento vuelva a dar un valor positivo.
+
This will allow access to the "Credential store" section of Profiles> Manage agent groups and it will act as the store of all the Amazon Web Services accounts previously created to be registered.  
  
* '''Absolute incremental''' (generic_data_inc_abs). Dato numérico igual a la diferencia entre el valor actual y el valor anterior, sin realizar la división entre el número de segundos transcurridos, para medir incremento total en lugar de incremento por segundo. Cuando esta diferencia es negativa, se reinicia el valor, esto significa que cuando la diferencia de nuevo vuelva a ser positiva, se empleará el último valor desde el que el actual incremento obtenido da positivo.
+
<center>
 +
[[File:AWS4.png]]
 +
</center>
  
* '''Alfanumérico''' (generic_data_string). Recoge cadenas de texto alfanuméricas.
+
<center>
 +
[[File:AWS5.png]]
 +
</center>
  
* '''Booleanos''' (generic_proc). Para valores que solo pueden ser correcto o afirmativo (1) o incorrecto o negativo (0). Útil para comprobar si un equipo está vivo, o un proceso o servicio está corriendo. Un valor negativo (0) trae preasignado el estado crítico, mientras que cualquier valor superior se considerará correcto.
+
Query accounts in Amazon AWS must be created with the following permissions:
  
* '''Alfanumérico asíncrono''' (async_string). Para cadenas de texto de tipo asíncrono. La monitorización asíncrona depende de eventos o cambios que pueden ocurrir o no, por lo que este tipo de módulos nunca están en estado desconocido.
+
<center>
 +
[[File:awsgrants.png]]
 +
</center>
  
* '''Booleano asíncrono''' (async_proc). Para valores booleanos de tipo asíncrono.
+
* Billing (read)
 +
* CloudWatch (list,read)
 +
* Cost Explorer Service (Full access)
 +
* EC2 (full read, limited: list)
  
* '''Numérico asíncrono''' (async_data). Para valores numéricos de tipo asíncrono.
 
  
==== module_min <valor> ====
+
Summary of the policy in JSON:
  
Valor mínimo que el módulo debe devolver para que sea aceptado. En caso contrario será descartado y no se mostrará en la consola.
+
{
 +
    "Version": "2012-10-17",
 +
    "Statement": [
 +
        {
 +
            "Sid": "VisualEditor0",
 +
            "Effect": "Allow",
 +
            "Action": [
 +
                "ec2:DescribeInstances",
 +
                "ec2:DescribeVolumesModifications",
 +
                "ec2:GetHostReservationPurchasePreview",
 +
                "ec2:DescribeSnapshots",
 +
                "aws-portal:ViewUsage",
 +
                "ec2:DescribePlacementGroups",
 +
                "ec2:GetConsoleScreenshot",
 +
                "ec2:DescribeHostReservationOfferings",
 +
                "ec2:DescribeInternetGateways",
 +
                "ec2:GetLaunchTemplateData",
 +
                "ec2:DescribeVolumeStatus",
 +
                "ec2:DescribeScheduledInstanceAvailability",
 +
                "ec2:DescribeSpotDatafeedSubscription",
 +
                "ec2:DescribeVolumes",
 +
                "ec2:DescribeFpgaImageAttribute",
 +
                "ec2:DescribeExportTasks",
 +
                "ec2:DescribeAccountAttributes",
 +
                "aws-portal:ViewBilling",
 +
                "ec2:DescribeNetworkInterfacePermissions",
 +
                "ec2:DescribeReservedInstances",
 +
                "ec2:DescribeKeyPairs",
 +
                "ec2:DescribeNetworkAcls",
 +
                "ec2:DescribeRouteTables",
 +
                "ec2:DescribeReservedInstancesListings",
 +
                "ec2:DescribeEgressOnlyInternetGateways",
 +
                "ec2:DescribeSpotFleetRequestHistory",
 +
                "ec2:DescribeLaunchTemplates",
 +
                "ec2:DescribeVpcClassicLinkDnsSupport",
 +
                "ec2:DescribeVpnConnections",
 +
                "ec2:DescribeSnapshotAttribute",
 +
                "ec2:DescribeVpcPeeringConnections",
 +
                "ec2:DescribeReservedInstancesOfferings",
 +
                "ec2:DescribeIdFormat",
 +
                "ec2:DescribeVpcEndpointServiceConfigurations",
 +
                "ec2:DescribePrefixLists",
 +
                "cloudwatch:GetMetricStatistics",
 +
                "ec2:GetReservedInstancesExchangeQuote",
 +
                "ec2:DescribeVolumeAttribute",
 +
                "ec2:DescribeInstanceCreditSpecifications",
 +
                "ec2:DescribeVpcClassicLink",
 +
                "ec2:DescribeImportSnapshotTasks",
 +
                "ec2:DescribeVpcEndpointServicePermissions",
 +
                "ec2:GetPasswordData",
 +
                "ec2:DescribeScheduledInstances",
 +
                "ec2:DescribeImageAttribute",
 +
                "ec2:DescribeVpcEndpoints",
 +
                "ec2:DescribeReservedInstancesModifications",
 +
                "ec2:DescribeElasticGpus",
 +
                "ec2:DescribeSubnets",
 +
                "ec2:DescribeVpnGateways",
 +
                "ec2:DescribeMovingAddresses",
 +
                "ec2:DescribeAddresses",
 +
                "ec2:DescribeInstanceAttribute",
 +
                "ec2:DescribeRegions",
 +
                "ec2:DescribeFlowLogs",
 +
                "ec2:DescribeDhcpOptions",
 +
                "ec2:DescribeVpcEndpointServices",
 +
                "ce:GetCostAndUsage",
 +
                "ec2:DescribeSpotInstanceRequests",
 +
                "cloudwatch:ListMetrics",
 +
                "ec2:DescribeVpcAttribute",
 +
                "ec2:GetConsoleOutput",
 +
                "ec2:DescribeSpotPriceHistory",
 +
                "ce:GetReservationUtilization",
 +
                "ec2:DescribeNetworkInterfaces",
 +
                "ec2:DescribeAvailabilityZones",
 +
                "ec2:DescribeNetworkInterfaceAttribute",
 +
                "ce:GetDimensionValues",
 +
                "ec2:DescribeVpcEndpointConnections",
 +
                "ec2:DescribeInstanceStatus",
 +
                "ec2:DescribeHostReservations",
 +
                "ec2:DescribeIamInstanceProfileAssociations",
 +
                "ec2:DescribeTags",
 +
                "ec2:DescribeLaunchTemplateVersions",
 +
                "ec2:DescribeBundleTasks",
 +
                "ec2:DescribeIdentityIdFormat",
 +
                "ec2:DescribeImportImageTasks",
 +
                "ec2:DescribeClassicLinkInstances",
 +
                "ec2:DescribeNatGateways",
 +
                "ec2:DescribeCustomerGateways",
 +
                "ec2:DescribeVpcEndpointConnectionNotifications",
 +
                "ec2:DescribeSecurityGroups",
 +
                "ec2:DescribeSpotFleetRequests",
 +
                "ec2:DescribeHosts",
 +
                "ec2:DescribeImages",
 +
                "ec2:DescribeFpgaImages",
 +
                "ec2:DescribeSpotFleetInstances",
 +
                "ec2:DescribeSecurityGroupReferences",
 +
                "ec2:DescribeVpcs",
 +
                "ec2:DescribeConversionTasks",
 +
                "ec2:DescribeStaleSecurityGroups",
 +
                "ce:GetTags"
 +
            ],
 +
            "Resource": "*"
 +
        }
 +
    ]
 +
}
  
==== module_max <valor> ====
 
  
Valor máximo que el módulo debe devolver para que sea aceptado. En caso contrario será descartado y no se mostrará en la consola.
+
Assign the policy to a new user.
  
==== module_min_warning <valor> ====
+
<center>
 +
[[File:awsgrants2.png]]
 +
</center>
  
Valor mínimo del umbral warning.
 
  
==== module_max_warning <valor> ====
+
Back in Pandora FMS, the registered account can be used to link it and be able to access AWS monitoring.
 +
<br>
 +
{{Tip|If pandora-cm-api is not available in the installation, it can be obtained from the following link: [https://pandorafms.com/library/pandora-cloud-monitoring-api/]}}
  
Valor máximo del umbral warning.
 
  
==== module_min_critical <valor> ====
+
===Discovery Cloud. AWS===
  
Valor mínimo del umbral crítico.
+
Once the credentials have been validated, access the <i>Discovery Cloud</i> menu <i>=> Amazon Web Services</i>
  
==== module_max_critical <valor> ====
+
<center>
 +
[[File:AWS6.png]]
 +
</center>
  
Valor máximo del umbral crítico.
+
In this section, Amazon EC2 and Amazon RDS are found. For each account added to the "Credential store", the EC2 environment hosted in that account can be monitored.
 +
<br>
 +
{{Tip|Only one recognition task per AWS account can be active. The account will be the same for all monitored technologies within the provider.}}
  
==== module_disabled <valor> ====
+
===Discovery Cloud. AWS.EC2===
  
Indica si el módulo esta habilitado (0) o deshabilitado (1).
+
Within EC2 monitoring you can find:
  
==== module_min_ff_event <valor> ====
+
* Expense monitoring.
 +
* Summary of resources registered in AWS.EC2.
 +
* Specific instance monitoring.
 +
* Volume and elastic IP address monitoring.
  
Valor de la protección ''flip flop'' para falsos positivos. Será necesario que se produzcan el número de cambios de estado indicados en este valor para que el módulo modifique visualmente su estado en la consola web.
+
To start the monitoring process, a series of basic data is requested:
  
==== (>= 6.0 SP4) module_each_ff <value> ====
+
<center>
 +
[[File:cloud3.png]]
 +
</center>
  
Si está habilitado (1), se utilizarán los umbrales flip flop por estado (module_min_ff_event_normal, module_min_ff_event_warning y module_min_ff_event_critical) en vez de module_min_ff_event.
+
It is required to provide a name for the task, indicate the Discovery server from where it will be executed and the monitoring interval.
  
==== (>= 6.0 SP4) module_min_ff_event_normal <value> ====
+
====Discovery Cloud AWS.EC2 Costs====
  
Valor de la protección ''flip flop'' para paso a estado normal.
+
When clicking next, you will start configuring AWS monitoring expenses:
  
==== (>= 6.0 SP4) module_min_ff_event_warning <value> ====
+
{{warning|Amazon Web Services expense monitoring involves extra expenses. You can find more information about it in the following link [https://aws.amazon.com/aws-cost-management/pricing/|Amazon cost managementpricing]}}
  
Valor de la protección ''flip flop'' para paso a estado warning.
+
Expense monitoring provides a separate monitoring interval to avoid extra charges.
  
==== (>= 6.0 SP4) module_min_ff_event_critical <value> ====
+
<center>
 +
[[File:cloud4.png]]
 +
</center>
  
Valor de la protección ''flip flop'' para paso a estado crítico.
+
Both the overall cost and the independent cost per region can be monitored.
  
==== (>= 6.0 SP4) module_ff_timeout <seconds> ====
+
====Discovery Cloud AWS.EC2 Summary====
  
Reinicia el contador de flip flop threshold después del número de segundos dado. Esto implica que el número de cambios de estado determinado en ''module_min_ff_event'' deberá ocurrir en un intervalo de ''module_ff_timeout'' segundos antes de que el estado cambie en la consola a nivel visual.
+
The Discovery task can be configured to collect general information on the stock status in all regions.
  
==== (>= 734) module_ff_type <valor> ====
+
To enable it, the ''Scan and general monitoring'' option must be activated.
  
Se trata de una opción avanzada del Flip Flop para el control de estado de un módulo. Mediante “keep counters” estableceremos unos valores de contador para pasar de un estado a otro dependiendo, en lugar del valor, del estado del módulo con el valor recibido.
+
<center>
 +
[[File:cloud5.png]]
 +
</center>
  
Indica si Keep counters esta habilitado (1) o deshabilitado (0).
+
Generic CPU usage counters can be added, as well as output (disk) input operations or volume of disk and network transferred data (bytes).
  
==== module_description <texto> ====
 
  
Texto libre con información sobre el módulo.
 
  
==== module_interval <factor> ====
+
==== Discovery Cloud AWS.EC2 Specific Instance Monitoring ====
  
Intervalo individual de módulo. Este valor es un factor multiplicador del intervalo del agente, no un tiempo libre.
+
Specific instances can be monitored to obtain readings of:
Por ejemplo, si el agente tiene intervalo 300 (5 minutos), y se quiere un módulo que sea procesado sólo cada 15 minutos, se debe añadir esta línea: module_interval 3. Así, este módulo será procesado cada 300sec x 3 = 900sec (15 minutos).
 
  
==== module_timeout <secs> ====
+
* CPUUtilization: Average CPU usage
 +
* DiskReadBytes: Reading bytes (disk)
 +
* DiskWriteBytes: Writing bytes (disk)
 +
* DiskReadOps: Read operations (disk)
 +
* DiskWriteOps: Writing operations (disk)
 +
* NetworkPacketsIn: Input packets (network)
 +
* NetworkPacketsOut: Output packets (network)
  
En segundos, tiempo máximo permitido para la ejecución del módulo. Si se supera este tiempo antes de haber finalizado su ejecución, será interrumpida.
+
The agents that represent the specific instances will have as their parent the agent that represents the region where they are hosted.
  
==== module_postprocess <factor> ====
+
It must be verified that the ''update_parent'' token is configured to 1 in the Pandora FMS server configuration to keep the parent-child relationships updated.
  
Valor numérico por el que se multiplicará el dato devuelto por el módulo. Útil para realizar conversiones de unidades.
+
Navigation must be carried out through the browser by selecting the instances that need to be monitored:
  
==== module_save <nombre de variable> ====
+
<center>
 +
[[File:cloud6.png]]
 +
</center>
  
Almacena el valor devuelto por el módulo en una variable con el nombre indicado en este parámetro. Este valor podrá ser utilizado posteriormente en otros módulos.
+
====Discovery Cloud AWS.EC2 Extras====
  
Por ejemplo:
+
In this last screen you can indicate whether you want to monitor the volumes used by the reserved instances.
  
module_begin
+
Two extra modules will appear in the region agents:
module_name echo_1
 
module_type generic_data
 
module_exec echo 41121
 
module_save ECHO_1
 
module_end
 
  
Almacenará el valor "41121" en la variable "ECHO_1".
+
* Total reserved volume (GB)
 +
* Total registered volumes (number)
  
module_begin
 
module_name echo_2
 
module_type generic_data
 
module_exec echo $ECHO_1
 
module_end
 
  
Este segundo módulo mostrará el contenido de la variable "$ECHO_1", siendo "41121".
+
You can also choose to activate the ''Elastic IP addresses'' token. The number of elastic IPs registered in the AWS.EC2 account will be reported.
  
En agentes Windows el módulo tendría que formarse con %var% en lugar de $var.  
+
<center>
Siguiendo el ejemplo:
+
[[File:cloud7.png]]
 +
</center>
  
module_begin
 
module_name echo_2
 
module_type generic_data
 
module_exec echo %ECHO_1%
 
module_end
 
  
==== module_crontab <minuto> <hora> <día> <mes> <día de la semana> ====
+
Once the wizard is completed, the progress of the execution in ''Discovery Task list'' can be seen:
  
Desde la versión 3.2 se pueden programar los módulos para que se
+
<center>
ejecuten en determinadas fechas.
+
[[File:tasklist1.png]]
 +
</center>
  
Para ello hay que definir el '''module_crontab''' utilizando un formato
+
===Discovery Cloud. AWS.RDS ===
similar al del fichero crontab: (http://es.wikipedia.org/wiki/Cron_(Unix)#Sintaxis)
 
  
module_crontab <minuto> <hora> <día> <mes> <día de la semana>
+
AWS RDS allows you to monitor relational databases provided by Amazon Web Services.
  
Siendo:
+
The RDS service provides a database server and allows creating the instance related to said database. In addition, RDS offers the possibility to connect to its instances through clients such as SSMS, MySQL workbench or through JDBC or ODBC DB APIs.
  
* Minuto 0-59
+
<center>
* Hora 0-23
+
[[File:AWS8.JPG]]
* Día del mes 1-31
+
</center>
* Mes 1-12
 
* Día de la semana 0-6 (0 es Domingo)
 
  
También es posible especificar intervalos utilizando el carácter '''-'''
+
Through Pandora FMS, different RDS instances can be monitored by filling in the parameters included in the menu shown at the top.
como separador.
 
  
Por ejemplo, para que un módulo se ejecute todos los lunes entre las 12
+
AWS RDS integration with Pandora FMS allows to monitor both the data source and their availablity.
y las 15 podríamos utilizar la siguiente configuración:
 
  
module_begin
+
In addition, the database running under RDS can be monitored retrieving all the metrics that could be monitored in a database as usual.
module_name crontab_test
 
module_type generic_data
 
module_exec script.sh
 
module_crontab * 12-15 * * 1
 
module_end
 
  
Para ejecutar un comando cada hora, a la hora y 10 minutos:
+
{{Warning|Integration with AWS RDS only supports <b>Oracle</b>, <b>MySQL</b> and <b>Mariadb</b>.}}
  
module_begin
+
===Discovery Cloud. Overview===
module_name crontab_test3
 
module_type generic_data
 
module_exec script.sh
 
module_crontab 10 * * * *
 
module_end
 
  
==== module_condition <operación> <comando> ====
+
Discovery Cloud includes an overview where the key points of the infrastructure in Amazon Web Services can be reviewed. Pandora FMS allows displaying different maps based on existing accounts.
  
Permite definir acciones que serán ejecutadas por el agente en función del valor devuelto por el módulo. Solo disponible para valores numéricos. La sintaxis es la siguiente:
+
In the AWS view, the account from which you wish to display the information can be selected:  
  
* '''>''' [valor]: Ejecuta el comando cuando el valor del módulo es mayor que el valor dado.
+
<center>
 
+
[[File:AWS9.JPG]]
* '''<''' [valor]: Ejecuta el comando cuando el valor del módulo es menor que el valor dado.
+
</center>
 
 
* '''=''' [valor]: Ejecuta el comando cuando el valor del módulo es igual al valor dado.
 
 
 
* '''!=''' [valor]: Ejecuta el comando cuando el valor del módulo es distinto al valor dado.
 
 
 
* '''=~''' [expresión regular]: Ejecuta el comando cuando el valor del módulo concuerda con la expresión regular dada.
 
 
 
* '''('''valor, valor''')''': Ejecuta el comando cuando el valor del módulo está comprendido entre los valores dados.
 
 
 
Se pueden especificar múltiples condiciones para un mismo módulo. En el caso siguiente se ejecutará ''script_1.sh'' si el valor devuelto por el módulo se encuentra entre 1 y 3, y se ejecutará ''script_2.sh'' si el valor del módulo es superior a 5.5, por lo que en este caso, siendo el valor devuelto en la línea ''module_exec'' 2.5, se ejecutará únicamente la primera condición ''script_1.sh'':
 
 
 
module_begin
 
module_name condition_test
 
module_type generic_data
 
module_exec echo 2.5
 
module_condition (1, 3) script_1.sh
 
module_condition > 5.5 script_2.sh
 
module_end
 
 
 
Ejemplos aplicados a posibles casos reales:
 
  
module_begin
+
It includes:
module_name MyProcess
 
module_type generic_data
 
module_exec tasklist | grep MyProcess | wc -l
 
module_condition > 2 taskkill /IM MyProcess* /F
 
module_end
 
  
module_begin
+
* Current expenses
module_name PandoraLogSize
+
* Previous expenses
module_type generic_data
+
* Expense evolution chart (6 months)
module_exec ls -la "c:\Archivos de programa\pandora_agent\pandora_agent.log" | gawk "{ print $5 }"
+
* Reserve / instance evolution chart (1 month)
module_condition > 10000 del "c:\Archivos de programa\pandora_agent\pandora_agent.log"
+
* Map of regions with the number of instances per region.
module_end
 
  
module_begin
 
module_name Service_Spooler
 
module_type generic_proc
 
module_service Spooler
 
module_condition = 0 net start Spooler
 
module_end
 
 
 
*'''NOTA''': En el sistema operativo Windows es recomendable anteponer '''cmd.exe /c''' al comando para asegurar que se ejecuta de forma adecuada. Por ejemplo:
 
 
module_begin
 
module_name condition_test
 
module_type generic_data
 
module_exec echo 5
 
module_condition (2, 8) cmd.exe /c script.bat
 
module_end
 
 
==== module_precondition <operación> <comando> ====
 
 
Permite determinar si se ejecuta o no el módulo dependiendo del resultado de una ejecución dada. La sintaxis es similar:
 
 
* '''>''' [valor]: Ejecuta el comando cuando el valor del módulo es mayor que el valor dado.
 
 
* '''<''' [valor]: Ejecuta el comando cuando el valor del módulo es menor que el valor dado.
 
 
* '''=''' [valor]: Ejecuta el comando cuando el valor del módulo es igual al valor dado.
 
 
* '''!=''' [valor]: Ejecuta el comando cuando el valor del módulo es distinto al valor dado.
 
 
* '''=~''' [expresión regular]: Ejecuta el comando cuando el valor del módulo concuerda con la expresión regular dada.
 
 
* '''('''valor, valor''')''': Ejecuta el comando cuando el valor del módulo está comprendido entre los valores dados.
 
 
En el siguiente ejemplo, sólo se ejecutará el módulo (''monitoring_variable.bat'') si el resultado de la ejecución indicada en la precondición se encuentra entre 2 y 8. En este caso el resultado de la ejecución indicada en la línea ''module_precondition'' es 5, valor que se encuentra entre 2 y 8, por lo que se ejecutará correctamente ''monitoring_variable.bat'':
 
 
module_begin
 
module_name Precondition_test1
 
module_type generic_data
 
module_precondition (2, 8) echo 5
 
module_exec monitoring_variable.bat
 
module_end
 
 
Al igual que con las postcondiciones es posible poner varias, y el módulo sólo se ejecutará si se cumplen todas:
 
 
module_begin
 
module_name Precondition_test2
 
module_type generic_data
 
module_precondition (2, 8) echo 5
 
module_precondition < 3 echo 5
 
module_exec monitoring_variable.bat
 
module_end
 
 
*'''NOTA''': En el sistema operativo Windows es recomendable anteponer '''cmd.exe /c''' al comando para asegurar que se ejecuta de forma adecuada. Por ejemplo:
 
 
module_begin
 
module_name Precondition_test3
 
module_type generic_data
 
module_precondition (2, 8) cmd.exe /c script.bat
 
module_exec monitoring_variable.bat
 
module_end
 
 
==== (>= 5.x) module_unit <value> ====
 
 
Unidades que queremos mostrar junto al valor obtenido por el módulo.
 
 
Ejemplo:
 
 
module_unit %
 
 
==== (>= 5.x) module_group <value> ====
 
 
Permite indicar el grupo de módulos al que será asignado el módulo.
 
 
Ejemplo:
 
 
module_group Networking
 
 
==== (>= 5.x) module_custom_id <value> ====
 
 
Esta directiva es un identificador personalizado del módulo.
 
 
Ejemplo:
 
 
module_custom_id host101
 
 
==== (>= 5.x) module_str_warning <value> ====
 
 
Permite indicar una expresión regular para definir el umbral warning en módulos de tipo alfanumérico (string).
 
 
Ejemplo:
 
 
module_str_warning .*NOTICE.*
 
 
==== (>= 5.x) module_str_critical <value> ====
 
 
Permite indicar una expresión regular para definir el umbral crítico en módulos de tipo alfanumérico (string).
 
 
Ejemplo:
 
 
module_str_critical .*ERROR.*
 
 
==== (>= 5.x) module_warning_instructions <value> ====
 
 
A nivel informativo, indica instrucciones que se mostrarán en el evento generado por el módulo al pasar a estado warning.
 
 
Ejemplo:
 
 
module_warning_instructions Subir prioridad incidencia
 
 
==== (>= 5.x) module_critical_instructions <value> ====
 
 
A nivel informativo, indica instrucciones que se mostrarán en el evento generado por el módulo al pasar a estado crítico.
 
 
Ejemplo:
 
 
module_critical_instructions Llamar a departamento de sistemas
 
 
==== (>= 5.x) module_unknown_instructions <value> ====
 
 
A nivel informativo, indica instrucciones que se mostrarán en el evento generado por el módulo al pasar a estado desconocido.
 
 
Ejemplo:
 
 
module_unknown_instructions Abrir incidencia
 
 
==== (>= 5.x) module_tags <value> ====
 
 
Tags que se desean asignar al módulo, separadas por comas.
 
 
Ejemplo:
 
 
module_tags tag1,tag2,tag3
 
 
==== (>= 5.x) module_warning_inverse <value> ====
 
 
Permite activar (1) el intervalo inverso para el umbral warning.
 
 
Ejemplo:
 
 
module_warning_inverse 1
 
 
==== (>= 5.x) module_critical_inverse <value> ====
 
 
Permite activar (1) el intervalo inverso para el umbral crítico.
 
 
Ejemplo:
 
 
module_critical_inverse 1
 
 
==== (>= 5.x) module_native_encoding <value> ====
 
 
(Win32 únicamente)
 
 
Este token de configuración solo afecta a los módulos que se ejecutan mediante una directiva de comandos, es decir, hay un module_exec presente.
 
 
Windows maneja tres codificaciones para sus procesos: la codificación de la línea de comandos (OEM), la codificación del sistema (ANSI) y UTF-16. Ambas codificaciones coinciden en los caracteres básicos, pero difieren en aquellos menos comunes, como podrían ser las tildes. Con este token, el agente de Pandora FMS convierte la salida del comando a la codificación especificada en el encoding del archivo de configuración.
 
 
module_native_encoding tiene cuatro valores válidos:
 
* module_native_encoding OEM: Para la codificación de la línea de comandos
 
* module_native_encoding ANSI: Para la codificación del sistema
 
* module_native_encoding UTFLE: Para UTF-16 little-endian
 
* module_native_encoding UTFBE: Para UTF-16 big-endian
 
 
Si no aparece module_native_encoding, no se realizará ninguna recodificación.
 
 
==== (>= 5.x) module_quiet <value> ====
 
 
Si se encuentra habilitado (1) el módulo estará en modo silencioso: no generará eventos ni disparará alertas, tampoco almacenará histórico de datos.
 
 
Ejemplo:
 
 
module_quiet 1
 
 
==== (>= 5.x) module_ff_interval <value> ====
 
 
Permite indicar un umbral ''flip flop'' en el módulo.
 
 
Ejemplo:
 
 
module_ff_interval 2
 
 
==== module_macro<macro> <value> ====
 
 
Solo aplicable en componentes locales desde la consola. No tiene utilidad en el fichero de configuración.
 
 
====  module_alert_template <template_name> ====
 
 
Esta macro asigna al módulo creado la plantilla de alerta correspondiente al nombre introducido como parámetro (ver [http://wiki.pandorafms.com/index.php?title=Pandora:Documentation_es:Alertas#Plantilla_de_alerta Plantillas de alerta]).
 
 
Ejemplo:
 
 
<module>
 
<name><![CDATA[CPU usage]]></name>
 
<type>generic_data</type>
 
<module_interval>1</module_interval>
 
<min_critical>91</min_critical>
 
<max_critical>100</max_critical>
 
<min_warning>70</min_warning>
 
<max_warning>90</max_warning>
 
<alert_template><![CDATA[Critical condition]]></alert_template>
 
<data><![CDATA[92]]></data>
 
</module>
 
 
==== module_end ====
 
 
Etiqueta de final de módulo. Es obligatorio.
 
 
=== Directivas específicas para obtener información ===
 
 
A continuación se describen las directivas específicas que se pueden especificar en cada módulo '''para obtener información''' como tal. En cada módulo solo se puede utilizar uno de estos tipos.
 
 
==== module_exec <comando> ====
 
 
Línea general de ejecución de comando. Se debe especificar la ejecución deseada para obtener la información en una única línea.
 
 
En Linux, el comando se ejecutará mediante el intérprete de comandos por defecto. Cuál es el intérprete por defecto viene determinado por el enlace simbólico de '''/bin/sh'''. Normalmente el enlace apunta a ''bash'', pero en sistemas como Ubuntu no es así (en este caso apunta a ''dash''). Por ello, puede ocurrir que se pruebe un comando en la terminal y luego dé error cuando el agente lo ejecute. Una solución que funcionará en la mayoría de ocasiones será forzar la ejecución del comando en bash de la siguiente forma:
 
 
module_exec bash -c "<comando>"
 
 
{{Warning|Si la ejecución del comando devuelve un '''código de error''' (return code) diferente de 0, se interpretará que el comando da error y se descartará el dato obtenido.}}
 
 
Para un agente Windows existen más directivas para obtener datos, éstas se describen a continuación.
 
 
==== module_service <servicio> ====
 
 
Comprueba si un determinado servicio se está ejecutando en la máquina. Recuerde usar los caracteres «" "» si el nombre del servicio contiene espacios en blanco.
 
 
module_begin
 
module_name Service_Dhcp
 
module_type generic_proc
 
module_service Dhcp
 
module_description Service DHCP Client
 
module_end
 
 
El servicio se identifica con el nombre corto del servicio (Service name), tal como aparece en el gestor de servicios de Windows.
 
 
<br><br>
 
 
<center>
 
<center>
[[image:Service_name_id.png|center]]
+
[[File:awsview.png]]
 
</center>
 
</center>
 +
 +
==Discovery Cloud: Microsoft Azure==
 
<br>
 
<br>
'' Modo asíncrono ''
+
To monitor an infrastructure in Microsoft Azure, follow these instructions step by step.
 
<br>
 
<br>
Pandora FMS, por lo general, ejecuta una batería de pruebas (cada una de ellas definida en un módulo) cada X segundos (300 seg. = 5 min. por defecto) de forma que si un servicio se cae justo después de una ejecución de Pandora FMS, tardaremos al menos otros 300 segundos en saber que se ha caído. Los módulos asíncronos hacen que Pandora FMS notifique ''instantáneamente'' de la caída de ese servicio. A esto le llamamos modo de operación ''asíncrono''. Para ello basta con agregar la directiva.
+
===How to register a user to use the Azure API===
  
module_async yes
+
* Go to https://portal.azure.com/#home
 +
* Open the "Azure Active Directory" service
  
Esta funcionalidad no está soportada en los agentes broker.
+
<center>
 +
[[File:azure.png]]
 +
</center>
  
{{Warning|En las versiones de Windows Home Edition esta funcionalidad asíncrona no está soportada y, solamente en estas versiones, el agente de Pandora FMS realiza una consulta periódica para saber si el servicio está corriendo o no. Esto puede consumir bastantes recursos así que se recomienda usar la versión síncrona si se monitoriza un número elevado de servicios.}}
+
* Go to 'App registrations'> 'New registration'
  
'' Watchdog de servicios ''
+
<center>
 +
[[File:azure2.png]]
 +
</center>
  
Existe un modo watchdog para los servicios, de tal forma que el agente puede iniciarlos de nuevo si estos se paran. En este caso, el servicio reiniciado no requiere ningún parámetro porque Windows ya sabe cómo hacerlo. En este caso la configuración es más sencilla y éste podría ser un ejemplo:
 
  
module_begin
+
* Enter the data.
module_name ServiceSched
 
module_type generic_proc
 
module_service Schedule
 
module_description Service Task scheduler
 
module_async yes
 
module_watchdog yes
 
module_end
 
  
'''En Unix'''
+
<center>
 +
[[File:azure3.png]]
 +
</center>
  
En Unix funciona igual que en Windows, solo que para Unix proceso y servicio es el mismo concepto, por ejemplo, para ver si el proceso bash está activo en el sistema, bastará con ejecutar:
 
  
module_begin
+
* Write down the data "client_id" and "directory".
module_name Service_bash
 
module_type generic_proc
 
module_service /bin/bash
 
module_description Process bash running
 
module_end
 
  
El modo watchdog y la detección asíncrona no son posibles en el agente de Unix.
+
<center>
 +
[[File:azure4.png]]
 +
</center>
  
==== module_proc <proceso> ====
+
* Next, access 'certificates & secrets' and create a new one:
  
Comprueba si un determinado nombre de proceso está operando en esta máquina. Si el nombre del proceso contiene espacios en blanco ''' no use «" " '''». Tenga en cuenta que el nombre del proceso debe tener la extensión .exe. El módulo devolverá el número de procesos que se estén ejecutando con este nombre.  
+
<center>
 +
[[File:azure5.png]]
 +
</center>
  
Este sería un ejemplo de la monitorización de proceso cmd.exe:
+
{{Warning|Write down the key that is shown, it is the application_secret.}}
  
module_begin
+
===Assigning permissions===
module_name CMDProcess
 
module_type generic_proc
 
module_proc cmd.exe
 
module_description Process Command line
 
module_end
 
  
'''En Unix'''
+
Assign a role to the account that will operate (app). To that effect, access "home" and get into the subscription.
 +
<center>
 +
[[File:azure6.png]]
 +
</center>
  
En Unix funciona exactamente igual que el modulo module_service. Tampoco soporta modo asíncrono ni watchdog.
 
  
'' Modo asíncrono ''
+
Within the subscription, select "Access control (IAM)".
  
De una forma similar a los servicios, monitorizar procesos puede ser crítico en algunos casos. Ahora el agente de Windows soporta comprobaciones '''asíncronas''' para el parámetro ''module_proc.'' En este caso, el agente notifica '''inmediatamente''' cuando el proceso cambia de estado, sin esperar a que se cumpla el intervalo de ejecución del agente. De esta forma, puede conocer la caída de procesos críticos casi al instante de que ocurran. Este sería un ejemplo de monitorización asíncrona de procesos:
+
<center>
 +
[[File:azure7.png]]
 +
</center>
  
module_begin
+
Add a new role assignment and once there, select the "reader" role for the created app.  
module_name Notepad
 
module_type generic_proc
 
module_proc notepad.exe
 
module_description Notepad
 
module_async yes
 
module_end
 
  
La diferencia está en token de configuración "module_async yes". Esta funcionalidad no está soportada en los agentes broker.
 
 
''Watchdog de procesos''
 
 
Un Watchdog es un sistema que permite actuar inmediatamente ante la caída de un proceso, generalmente, levantando el proceso que se ha caído. El agente de Windows de Pandora FMS, puede actuar como Watchdog ante la caída de un proceso.
 
 
Dado que ejecutar un proceso puede requerir algunos parámetros, hay algunas opciones adicionales de configuración para este tipo de módulos. Es importante destacar que el modo ''watchdog'' solo funciona cuando el tipo de módulo es ''asíncrono''. Veamos un ejemplo de configuración de un module_proc con watchdog:
 
 
module_begin
 
module_name Notepad
 
module_type generic_proc
 
module_proc notepad.exe
 
module_description Notepad
 
module_async yes
 
module_watchdog yes
 
module_start_command c:\windows\notepad.exe
 
module_startdelay 3000
 
module_retrydelay 2000
 
module_retries 5
 
module_end
 
 
Esta es la definición de los parámetros adicionales para module_proc con watchdog:
 
 
* '''module_retries''': Número de intentos consecutivos que el módulo intentará lanzar el proceso antes de desactivar el watchdog. Si el límite es alcanzado, el mecanismo del watchdog para este módulo se desactivará y nunca más intentará lanzar el proceso hasta que se reinicie el agente. Ilimitado por defecto.
 
 
* '''module_startdelay''': Número de milisegundos que el módulo esperará antes de lanzar el proceso por primera vez.
 
 
* '''module_retrydelay''': Número de milisegundos que el módulo esperará antes de intentar lanzar el proceso en cada reintento.
 
 
* '''module_user_session''': Controla en qué sesión se desea que se lance el proceso. Si se configura a 'no' el proceso se iniciará en la sesión de los servicios y, por lo tanto, permanecerá en segundo plano (opción por defecto). En caso contrario, si se configura a 'yes', el proceso se lanzará en la sesión del usuario y será visible desde el escritorio del pc.
 
 
{{Warning|Para versiones anteriores a Windows Vista el token module_user_session puede configurarse de manera general habilitando en las propiedades del servicio de Pandora FMS la casilla "Acceso interactivo con el escritorio", tal y como se muestra en la captura de pantalla siguiente:
 
<br><br>
 
 
<center>
 
<center>
[[image:Service_interactive.png|center]]
+
[[File:azure8.png]]
 
</center>
 
</center>
<br><br>}}
 
  
De igual modo, es necesario entender que Pandora FMS, como servicio, se ejecuta bajo la cuenta "SYSTEM" y que el proceso ejecutado lo hará bajo ese usuario y con ese entorno, de forma que si quiere ejecutar algún proceso determinado que requiera ser usado con un determinado usuario, deberá encapsular en un script (.bat o similar) los procesos previos para inicializar el entorno, variables de entorno, etc), y ejecutar ese script como acción del watchdog.
+
It is important to save the changes by pressing "save".
  
==== module_cpuproc <process> ====
 
  
''(Solo Unix)''
+
From that moment onwards, you can connect to the service and make requests through pandora-cm-api.
  
Devuelve el uso de CPU específico de un proceso.
+
====Examples====
  
module_begin
+
The status of Azure can be checked from Pandora FMS as follows:
module_name myserver_cpu
 
module_type generic_data
 
module_cpuproc myserver
 
module_description Process Command line
 
module_end
 
  
==== module_memproc <process> ====
+
* Preload the environment.
 +
* Run . load_env.sh
 +
* pandora-cm-api --product Azure --get availability
  
''(Solo Unix)''
 
  
Devuelve el consumo de memoria específico de un proceso.
+
If the environment is operational, the system should return a response of 1.  
  
module_begin
+
An example of the contents of the load_env.sh script would be the following:
module_name myserver_mem
+
<br>
module_type generic_data
+
* Azure
module_memproc myserver
 
module_description Process Command line
 
module_end
 
 
 
==== module_freedisk <letra_de_la_unidad:>|<volumen> ====
 
 
 
Comprueba el espacio libre en la unidad (no olvide «":"» después de '''letra_de_la_unidad''' en WIndows). En Unix sería simplemente el volumen a comprobar, como por ejemplo /var
 
  
 
<pre>
 
<pre>
module_begin
+
export CLIENT_ID=XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX
module_name freedisk
 
module_type generic_data
 
module_freedisk C:
 
module_end
 
</pre>
 
  
<pre>
+
export DOMAIN=XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX
module_begin
 
module_name disk_var
 
module_type generic_data
 
module_freedisk /var
 
module_end
 
</pre>
 
  
==== module_freepercentdisk <letra_de_la_unidad:>|<volumen> ====
+
export APPLICATION_SECRET="XXXXXXXXXXXXXXXXXXXXXXXXX"
  
Este módulo devuelve el porcentaje de disco libre en una unidad lógica (C:) o un volumen Unix (p.e: /var)
+
export AZURE_SUBSCRIPTION_ID=XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX
 
 
<pre>
 
module_begin
 
module_name freepercentdisk
 
module_type generic_data
 
module_freepercentdisk C:
 
module_end
 
 
</pre>
 
</pre>
  
<pre>
+
=== Configure a task in Pandora FMS ===
module_begin
 
module_name disk_var
 
module_type generic_data
 
module_freepercentdisk /var
 
module_end
 
</pre>
 
  
==== module_occupiedpercentdisk <letra_de_la_unidad:>|<volumen> ====
 
  
(Sólo Unix)
+
Pandora FMS allows managing several Microsoft Azure accounts.
  
Este módulo devuelve el porcentaje de disco ocupado en un volumen Unix (p.e: /var)
+
You can add as many accounts as needed through the "Manage Accounts" option next to the Account drop-down.
  
module_begin
+
This will allow access to the "Credential store" section of Profiles> Manage agent groups and it will act as the store of all previously created Microsoft Azure accounts to be registered.
module_name disk_var
 
module_type generic_data
 
module_occupiedpercentdisk /var
 
module_end
 
  
==== module_cpuusage [<cpu id>] ====
+
To configure a new task, follow these steps:
  
Devuelve el uso de CPU en un número de CPU. Si sólo existe una CPU no establezca ningún valor o utilice el valor "all". Funciona igual en Windows o en Unix.
+
* Add a new password to the "credential store".
  
También es posible obtener el promedio de uso de todas las CPU en un sistema multiprocesador:
+
<center>
 +
[[File:azure9.png]]
 +
</center>
  
  
module_begin
 
module_name UsoCPU
 
module_type generic_data
 
module_cpuusage all
 
module_description Uso medio de CPU
 
module_end
 
  
Para comprobar el uso de la CPU en la CPU #1:
+
* Access 'Discovery> Cloud> Azure' and validate the Azure account.
  
module_begin
 
module_name CPU_1
 
module_type generic_data
 
module_cpuusage 1
 
module_description Uso medio de CPU de la CPU #1
 
module_end
 
  
==== module_freememory ====
+
<center>
 +
[[File:azure10.png]]
 +
</center>
  
Funciona tanto en Unix como en Windows. Devuelve la memoria libre en todo el sistema.
 
  
module_begin
+
<center>
module_name FreeMemory
+
[[File:azure11.png]]
module_type generic_data
+
</center>
module_freememory
 
module_description Non-used memory on system
 
module_end
 
  
==== module_freepercentmemory ====
 
  
Funciona tanto en Unix como en Windows. Este módulo devuelve el porcentaje de memoria libre en un sistema:
+
<center>
 +
[[File:azure12.png]]
 +
</center>
  
module_begin
 
module_name freepercentmemory
 
module_type generic_data
 
module_freepercentmemory
 
module_end
 
  
==== module_tcpcheck ====
+
* From that point onwards, it will be necessary to define the name of your recon task, the server that will execute the task, the group it will belong to and the execution interval.
(Solo Windows)
 
  
Este módulo intenta conectarse con la dirección IP y puerto especificados. Devuelve 1 si tuvo éxito y 0 en caso contrario. Se debe especificar un tiempo de expiración.
+
<center>
 
+
[[File:AzureX3.PNG]]
module_begin
+
</center>
module_name tcpcheck
 
module_type generic_proc
 
module_tcpcheck www.artica.es
 
module_port 80
 
module_timeout 5
 
module_end
 
 
 
==== module_regexp ====
 
 
 
(Sólo Windows)
 
 
 
Este módulo monitoriza un fichero de registro (log) buscando coincidencias usando expresiones regulares, descartando las líneas ya existentes al iniciar la monitorización. Los datos devueltos por el módulo dependen del tipo de módulo:
 
 
 
* '''generic_data_string''', '''async_string''': Devuelve todas las líneas que coincidan con la expresión regular.
 
* '''generic_data''': Devuelve el número de líneas que coincidan con la expresión regular.
 
* '''generic_proc''': Devuelve 1 si existe alguna coincidencia, 0 de otra forma.
 
* '''module_noseekeof''': Por defecto a 0, con este token de configuración activo, en cada ejecución, independientemente de las modificaciones en el fichero del log, el módulo reinicia su comprobación sin buscar el flag EOF del archivo, con lo que siempre sacará en el XML todas aquellas líneas que coincidan con nuestro patrón de búsqueda.
 
 
 
module_begin
 
module_name regexp
 
module_type generic_data_string
 
module_regexp C:\WINDOWS\my.log
 
module_pattern ^\[error\].*
 
module_noseekeof 1
 
module_end
 
 
 
Para obtener más información acerca de la sintaxis de las expresiones regulares, consulte el siguiente enlace:  [http://www.regular-expressions.info/reference.html]
 
 
 
 
 
==== module_wmiquery ====
 
 
 
(Solo Windows)
 
 
 
Los módulos WMI permiten ejecutar localmente cualquier query WMI sin utilizar una herramienta externa. Se configura por medio de dos parámetros:
 
 
 
* '''module_wmiquery''': WQL query empleada. Se pueden obtener varias líneas como resultado, que serán insertados como varios datos.
 
* '''module_wmicolumn''': Nombre de la columna que se va a usar como fuente de datos.
 
 
 
Por ejemplo, podemos obtener una lista de los servicios instalados:
 
 
 
module_begin
 
module_name Services
 
module_type generic_data_string
 
module_wmiquery Select Name from Win32_Service
 
module_wmicolumn Name
 
module_end
 
 
 
O de la carga actual de CPU:
 
 
 
module_begin
 
module_name CPU_speed
 
module_type generic_data
 
module_wmiquery SELECT LoadPercentage FROM Win32_Processor
 
module_wmicolumn LoadPercentage
 
module_end
 
 
 
==== module_perfcounter ====
 
 
 
(Solo Windows)
 
  
Obtiene los datos del contador de rendimiento (performance counter http://msdn.microsoft.com/en-us/library/aa373083(v=vs.85).aspx ) a través de la interfaz de PDH (La librería ''pdh.dll'' debe de estar instalada en el sistema. PDH.DLL es una librería de Windows, si no la tiene instalada tendrá que instalar la herramienta de análisis de rendimiento de Windows (que suele venir por defecto).
+
* Once task data are defined, select the Azure account sections that you wish to monitor. Each section will allow in turn to choose the desired instances.  
  
module_begin
 
module_name perfcounter
 
module_type generic_data
 
module_perfcounter \Memory\Pages/sec
 
module_end
 
 
El monitor de rendimiento de Windows es una herramienta muy potente y que dispone de cientos de parámetros que se pueden usar para monitorizar. Además cada fabricante incorpora sus propios contadores.
 
 
Podemos observar los contadores de rendimiento mediante la herramienta ''Rendimiento'' (Performance):
 
 
<br><br>
 
 
<center>
 
<center>
[[image:Perfcounter_screen1.png|center|450px]]
+
[[File:AzureX4.PNG]]
 
</center>
 
</center>
<br><br>
 
  
Es posible añadir contadores de rendimiento nuevos mediante la herramienta del sistema. Su configuración tiene estructura jerárquica con elementos y subelementos. En este caso ''Procesador'', ''% de tiempo de procesador'' y ''_Total'':
+
* The last step is selecting the metrics you wish to obtain from the agents generated by Pandora FMS for each instance it finds in Microsoft Azure. Once the section is configured, the task can be launched and Pandora FMS will create automatically agents according to the instances required in previous steps.  
  
<br><br>
 
 
<center>
 
<center>
[[image:Perfcounter_screen2.png|center]]
+
[[File:AzureX5.PNG]]
 
</center>
 
</center>
<br><br>
 
  
La configuración del módulo para este chequeo en particular sería la siguiente:
+
<br>
  
module_begin
+
=Discovery Console Tasks=
module_name Processor_Time
 
module_type generic_data_inc
 
module_perfcounter \Procesador(_Total)\% de tiempo de procesador
 
module_end
 
  
Por defecto se muestra el valor en crudo del contador, para obtener el valor ''cocinado'' se puede añadir el parámetro '''module_cooked 1''':
+
Virtually identical to what was previously seen in Task List, Console Task will allow creating new tasks taking into account the following parameters:  
  
module_begin
+
* Task: The task that will be executed among the following:
module_name Disk_E/S_Seg
+
** Backup Pandora FMS database.
module_type generic_data
+
** Execute custom script.
module_cooked 1
+
** Save custom report to disk.
module_perfcounter \DiscoFísico(_Total)\E/S divididas por seg.
+
** Save custom XML report to disk.
module_end
+
** Send custom report (from template) by email.  
 +
** Send custom report by email.
  
Muchos de los datos que devuelve son contadores, por lo que deberá usar generic_data_inc como tipo de datos. También puede devolver valores en escalas de datos muy altas (varios millones), por lo que puede reducir esos valores usando el postproceso del módulo, con valores tales como 0.000001 o similares.
+
* Scheduled: It is used to specify how often the task will be executed.
 +
* Next execution: It shows the date of the next execution, being able to modify it if necessary.  
 +
* Group: Group to which the task belongs.  
 +
* Parameters: They are the specific parameters of each task.  
  
==== module_inventory DEPRECATED====
+
<center>
 +
[[File:ConsoleTasks.JPG]]
 +
</center>
  
{{Warning|Actualmente esta funcionalidad ha sido sustituida por inventario desde plugins de agente tanto en sistemas Windows como Linux/Unix.}}
+
==== Parameters of different tasks ====
 +
<br>
 +
;Backup Pandora FMS database:
 +
* Description: Backup description.
 +
* Save to disk in path: path where the backup will be stored.<br><br>
 +
;Execute custom script:
 +
* Custom script: The script to be executed will be indicated.<br><br>
 +
;“Save custom report to disk” and “Save custom XML report to disk”:
 +
* Report pending to be created: The report to be created.
 +
* Save to disk in path: Path where the created report will be stored.<br><br>
 +
;Send custom report (from template) by email:
 +
* Template pending to be created: Custom template to be created.
 +
* Agents: Agents from which the information that will be reflected in the report  will be obtained.
 +
* Report per agent: If you wish to generate separate reports for each report.
 +
* Report name: Name that you want to give the report.
 +
* Send to email addresses: Email addresses the report will be sent to.
 +
* Subject: Topic of the mail to be sent.
 +
* Message: Body of the message which will be sent together with the reports.<br><br>
 +
;Send custom report by email:
 +
* Report pending to be created: Report to be generated.
 +
* Send to email addresses: Email addresses the report will be sent to.
 +
* Subject: Topic of the mail to be sent.
 +
* Message: Body of the message with which the reports will be sent.
 +
* Report Type: Type of report that will be sent.
  
''(Win32 únicamente. En linux/unix está implementado como plugin de agente)''
+
=Discovery Host&Devices=
  
Usando consultas WMI predefinidas y búsquedas sobre el registro, este módulo obtiene información acerca de los diferentes aspectos de una máquina, desde software hasta hardware.
+
The Discovery Host & Devices section offers a multitude of options to help manage and discover devices within as many environments as needed.
  
El módulo puede recibir diferentes parámetros para marcar qué tipo de información se obtiene. Aquí está la lista de parámetros y el tipo de información que proporcionan:  
+
Therefore, it features the following tools:  
  
* '''cpu''': Obtiene información acerca de las CPU del sistema (nombre del procesador, frecuencia del reloj y descripción).  
+
* Net Scan.
* '''CDROM''': Obtiene información acerca de los CD-ROM (nombre, descripción y letra de la unidad).
+
* Import CSV.
* '''Video''': Obtiene información acerca de las tarjetas de vídeo (descripción, RAM y procesador).  
+
* Custom NetScan.
* '''HDs''': Obtiene información acerca de los discos duros (modelo, tamaño y nombre en el sistema).
+
* Manage NetScan scripts.
* '''NICs''': Obtiene información acerca de los controladores de interfaces de red (descripción, dirección MAC y dirección IP).
 
* '''Patches''': Obtiene información acerca de los parches instalados (identificador, descripción y comentarios).
 
* '''Software''': Obtiene información acerca de los paquetes MSI instalados (nombre y versión).
 
* '''RAM''': Obtiene información acerca de los módulos de RAM (etiqueta, capacidad y nombre).
 
* '''Services''': Obtiene información acerca de los servicios intalados. El nombre corto mostrado en la primera columna es el nombre del servicio que usa Pandora FMS para poder monitorizar servicios.
 
  
Parámetros adicionales del módulo:
 
  
* '''module_interval''': Este módulo tiene una línea adicional que se usa para especificar el intervalo, ''en días'', en el que obtener la información para el módulo.  
+
<center>
 
+
[[File:DISCHost&Devices.JPG|800]]
Un ejemplo de uso de este módulo sería el siguiente:
+
</center>
 
 
module_begin
 
module_name Inventory
 
module_interval 7
 
module_type generic_data_string
 
module_inventory RAM Patches Software Services
 
module_description Inventory
 
module_end
 
  
==== module_logevent ====
+
==NetScan==
  
(Solo Windows)
+
With the NetScan tool, you may find devices in a network and apply different monitoring rules.
  
Permite obtener información del log de eventos de Windows basándose en los patrones indicados, permitiendo filtrar en función de la fuente y el tipo de evento.
+
First, define the name of the task, the Discovery server that will run it, the group the discovered agents will be assigned to and the scanning interval.
  
El formato general de este módulo es el siguiente:
+
In addition, you will have two options when performing the scanning task. You may indicate the networks to be discovered in the field designed to that end in ''Red'' or you may enable the token ''Use CSV file'' that will allow to load a csv file containing the specific devices or network to check throughout the recon task. If the csv file is selected, the Network option will not be enabled.
  
module_begin
 
module_name MyEvent
 
module_type async_string
 
module_logevent
 
module_source <logName>
 
module_eventtype <event_type/level>
 
module_eventcode <event_id>
 
module_application <source>
 
module_pattern <text substring to match>
 
module_description
 
module_end
 
 
Para evitar mostrar información repetida, sólo se tienen en cuenta aquellos eventos que hayan tenido lugar durante desde la última vez que se ejecutó el agente.
 
 
module_logevent acepta los siguientes parámetros (todos ellos case-sensitive):
 
 
* '''module_source''': Origen del evento (System, Application, Security). Campo obligatorio.
 
* '''module_eventtype''': Tipo de evento (error, information...). Campo opcional.
 
* '''module_pattern''': Patrón a buscar (subcadena). Campo opcional.
 
* '''module_eventcode''': ID numerico del evento, p.e: 5112. Campo opcional.
 
* '''module_application''': Aplicación origen del evento, ojo, no confundir con module_source que indica el nombre de la fuente o fichero log de donde se buscan los eventos.
 
 
Por ejemplo, para mostrar todos los eventos del sistema de tipo error definiríamos el siguiente módulo:
 
 
module_begin
 
module_name log_events
 
module_type generic_data_string
 
module_description System errors
 
module_logevent
 
module_source System
 
module_eventtype error
 
module_end
 
 
 
Para mostrar todos los eventos que contengan la palabra PandoraAgent:
 
 
module_begin
 
module_name log_events_pandora
 
module_type async_string
 
module_description PandoraAgent related events
 
module_logevent
 
module_source System
 
module_pattern PandoraAgent
 
module_end
 
 
Otro ejemplo, filtrando el evento mostrado en la captura:
 
<br><br>
 
 
<center>
 
<center>
[[Image:Event sample.png|center|450px]]
+
[[File:3oaKq2yukE.png]]
 
</center>
 
</center>
<br>
 
 
module_begin
 
module_name MyEvent
 
module_type async_string
 
module_source Application
 
module_eventtype Information
 
module_eventcode 6000
 
module_application Winlogon
 
module_pattern unavailable to handle
 
module_description
 
module_end
 
  
==== module_logchannel ====
+
{{Warning|The intervals selected as manuals must be manually launched. '''Discovery will not launch a manual task automatically.'''}}
  
(Solo Windows. A partir de 7.0OUM715)
 
  
Tipo de módulo que permite obtener información de los canales de logs de Windows. Si bien ''module_logevent'' solo tiene acceso a los logs de los Registros de Windows, este tipo de módulo permite extraer datos de otros ficheros de logs que estén configurados como canales. De esta forma, es posible obtener los logs englobados en los Registros de aplicaciones y servicios.
+
In the features section, you may indicate the following options:
 
 
El formato general de este módulo es el siguiente:
 
 
 
module_begin
 
module_name MyEvent
 
module_type async_string
 
module_logchannel
 
module_source <logChannel>
 
module_eventtype <event_type/level>
 
module_eventcode <event_id>
 
module_application <source>
 
module_pattern <text substring to match>
 
module_description <description>
 
module_end
 
 
 
Para evitar mostrar información repetida, sólo se tienen en cuenta aquellos eventos que hayan tenido lugar desde el momento en el que se inicia el agente.
 
 
 
module_logchannel acepta los siguientes parámetros (todos ellos case-sensitive):
 
 
 
* '''module_source''': Canal del evento. Con el comando ''' wevtutil.exe enum-logs ''' se obtiene un listado de todos los canales de logs locales de la máquina. Campo obligatorio.
 
* '''module_eventtype''': Tipo de evento (''critical'', ''error'', ''warning'', ''info'' o ''verbose''). Campo opcional.
 
* '''module_pattern''': Patrón a buscar (subcadena). Campo opcional.
 
* '''module_eventcode''': ID numerico del evento, p.e: 5112. Campo opcional.
 
* '''module_application''': Aplicación origen del evento, ojo, no confundir con module_source que indica el nombre de la fuente o fichero log de donde se buscan los eventos.
 
 
 
Por ejemplo, definiríamos el siguiente módulo para mostrar todos los eventos del canal ''Microsoft-Windows-TaskScheduler/Operational'', de tipo ''information'', con código ''201'' y que en el texto del log apareciera el texto ''code 0'':
 
 
 
module_begin
 
module_name New logs
 
module_type async_string
 
module_logchannel
 
module_description Successfully completed tasks
 
module_source Microsoft-Windows-TaskScheduler/Operational
 
module_eventtype information
 
module_eventcode 201
 
module_pattern code 0
 
module_end
 
 
 
Con esta configuración de módulo, el agente de Pandora FMS recogería el siguiente log:
 
  
 
<center>
 
<center>
[[Image:Logchannel example.png|center|700px]]
+
[[File:Wvia6RtpOr2.png|800]]
 
</center>
 
</center>
<br>
 
  
==== module_plugin ====
 
  
Para la ejecución de plugins de agente. Es un caso especial ya que '''no requiere de ninguna otra etiqueta''' tipo ''module_begin'' o ''module_end'', y tampoco indicar el tipo de módulo.
+
* '''Known hardware auto discovery''': It dinamically applies the templates that were previously added to the ''Private Enterprise Number'' section. To learn more, go to the following [https://pandorafms.com/docs/index.php?title=Pandora:Documentation_en:Templates_and_components#Private_Enterprise_Number| link.]
 +
* '''Module templates''': Try to apply the modules from from the selected templates. If the execution does not pass the test, they will not be added to the monitoring list.
 +
* '''Check results''': The user must validate the results selecting which agents will be created from those found through the discovery task.
 +
* '''Apply autoconfiguration rules''': It applies the predefined autoconfiguration rules to the detected agents. To learn more, go to the following [https://wiki.pandorafms.com/index.php?title==Pandora:Documentation_en:Configuration_Agents| link.]
  
Su formato tendrá este aspecto:
+
{{Tip|Automatic configuration allows you to apply policies, group changes and settings, as well as launch custom events or execute scripts on actions.}}
  
module_plugin plugin_filename parámetro_1 parámetro_2 parámetro_3
+
{{Tip|Agents detected by NetScan are remote agents without a configuration file. You cannot apply local monitoring policies or add configuration changes in block if you do not deploy an agent on the targets.}}
  
No obstante es posible emplearlo entre las etiquetas habituales de módulos para añadir opciones adicionales como condiciones o intervalo:
 
  
module_begin
+
* '''SNMP activated''': To complete the information obtained from the discovered network devices, enable SNMP. That improves detection by scanning the SNMP information available in the discovered targets. Once this token is enabled, two more options appear:
module_plugin plugin_filename parameter_1 parameter_2 parameter_3
+
** '''SNMP version''': Select the SNMP version configured in the scanned network devices. It supports SNMP versions 1,2, 2c and 3.
module_interval 2
+
** '''SNMP communities''': Indicate the environment configured community. You may add as many communities as you need by typing them in the following box.
module_condition (0, 1) script.sh
 
module_end
 
  
Los parámetros a utilizar serán diferentes para cada plugin, por lo que será necesario remitirse a su documentación particular.  
+
* '''WMI enabled''': You may enable WMI scanning. Just select the previously loaded credentials from the [https://wiki.pandorafms.com/index.php?title=Pandora:Documentation_en:Managing_and_Administration#Credential_store| credential store.]
Vamos a describir el funcionamiento de uno de los plugins que vienen por defecto con el Agente, el plugin grep_log para buscar coincidencias en un fichero:
 
  
module_plugin grep_log /var/log/syslog Syslog ssh
+
{{Tip|The different credentials provided against the detected objectives that support WMI will be tested, complementing monitoring with modules that will report about CPU, memory and disk usage.}}
  
En este ejemplo, el nombre del plugin se llama, "grep_log" y buscará en el fichero "/var/log/syslog" la expresion regular "ssh" y lo guardará en un módulo llamado "Syslog".
+
* '''SO detection''': Detect the target's operating system.
  
Un ejemplo de llamada a un plugin en un agente Windows (solo versión 3.1 o superior)
+
* '''Name resolution''': Solve the target's name.
  
module_plugin cscript.exe //B "%ProgramFiles%\Pandora_Agent\util\df_percent.vbs"
+
* '''Parent detection''': By means of the information collected through SNMP, the different interconnections between devices will be calculated, to be able to represent their network infrastructure.
  
==== module_ping <host> ====
+
* '''Parent recursion''': It improves parent detection adding recursion to the process.
  
(Solo Windows)
+
* '''VLAN enabled''': It detects the VLAN to which the different devices are connected to.
  
Este módulo hace un ping al host dado y devuelve 1 si está arriba.
+
Once the wizard is finished, Discovery will start executing it in each defined interval. If the interval is manual, the task should be started manually:
  
Soporta los siguientes parámetros de configuración:
+
<center>
 +
[[File:AFgAv40l9Y.png|800]]
 +
</center>
  
* '''module_ping_count x''': Número de paquetes ECHO_REQUEST a enviar (1 por defecto).
+
Once the task is finished, if you access from Review, you will see a summary of the devices found which respond to ping and the rest of metrics available through SNMP or WMI. All the IPs will be shown, but they may have two status:
* '''module_ping_timeout x''': Timeout en milisegundos de espera para cada respuesta (1000 por defecto).
+
* '''Disabled''': There is already an agent or module being monitored in the environoment and it will not be created nor modified.
* '''module_advanced_options''': Opciones avanzadas para ''ping.exe''.
+
* '''Enabled''': it is a new non-monitored element or within the obtained metrics there us a new element that responded and that will be displayed on a drop-down. You may choose to add it to the monitored agent list in thoses devices in this status or add any of the new enabled metrics.
  
Ejemplo:
+
<center>
 +
[[File:HK8XAXtv92.png]]
 +
</center>
  
module_begin
+
{{Tip|Once the targets to be monitored are selected, the system will create them systematically. Along the process, the target OS will be detected to complete the information gathered.}}
module_name Ping
 
module_type generic_proc
 
module_ping 192.168.1.1
 
module_ping_count 2
 
module_ping_timeout 500
 
module_end
 
  
==== module_snmpget ====
+
== Automatic agent deployment ==
  
(Solo Windows)
+
{{Warning|Please confirm '''winexe''' command is installed and working in your server before using this feature. This utility is provided by Pandora FMS Enterprise server installer. You must install '''zlib.i686''' and '''glibc.i686''' to get winexe working.}}
  
Este módulo ejecuta una consulta SNMP get y devuelve el valor solicitado.
+
{{Warning|In <b>Windows</b> environments it is recommended to install as an administrator user. Before starting the service it will be necessary to define an administrator account for its use.}}
  
Soporta los siguientes parámetros de configuración:
 
  
* '''module_snmpversion [1,2c,3]''': Versión de SNMP (1 por defecto).
+
From Pandora FMS version 737 onwards, it is possible to deploy agents from the console itself using the '''deployment center'''.
* '''module_snmp_community <community>''': Comunidad SNMP (''public'' por defecto).
 
* '''module_snmp_agent <host>''': Agente SNMP objetivo.
 
* '''module_snmp_oid <oid>''': OID objetivo.
 
* '''module_advanced_options''': Opciones avanzadas para ''snmpget.exe''.
 
  
Ejemplo:
+
{{Warning|Server version must be EL7 for agent automatic deployment to work.}}
  
module_begin
+
[[File:Depl1.png]]
module_name SNMP get
 
module_type generic_data
 
module_snmpget
 
module_snmpversion 1
 
module_snmp_community public
 
module_snmp_agent 192.168.1.1
 
module_snmp_oid .1.3.6.1.2.1.2.2.1.1.148
 
module_end
 
  
== Configuración automática de agentes ==
 
===Introducción===
 
A partir de la versión 725 de Pandora FMS, puede establecer una serie de reglas para que sus agentes se configuren de manera automática.
 
  
El proceso de autoconfiguración de agentes funciona de la siguiente manera:
+
The steps to deploy agents from the console are:
  
'''1-''' Se preparan las configuraciones automáticas en su Pandora FMS Console o Pandora FMS Metaconsole.
+
'''Register the versions of the software agents to be deployed in the agent repository.'''
  
'''2-''' Se instalan los agentes reportando contra su Pandora FMS (si tiene una única consola, apunte el agente contra su servidor Pandora FMS, si tiene una Metaconsola con el sistema de aprovisionamiento automático configurado, establezca como servidor la propia Metaconsola).
+
The installers of the agents to be deployed throughout the infrastructure are needed. You may use custom agents.
  
'''3-''' Pandora FMS Server recibirá un XML (.data) con los datos del agente por primera vez.  
+
For more information about the use of the '''agent repository''', visit [https://pandorafms.com/docs/index.php?title=Pandora:Documentation_en:Managing_and_Administration#Software_agent_repository this link]
  
'''4-''' Se evaluarán las reglas para determinar la configuración automática a aplicar.
 
  
'''5-''' El agente recogerá la nueva configuración y reportará en el siguiente ciclo con la configuración actualizada.
+
'''Register the credentials to be used to connect the targets in the credential manager.'''
  
=== Creación/edición de autoconfiguración ===
+
Specify the credentials with which the accesses to found or specified targets will be tested.
  
Puede acceder al formulario que administra las configuraciones automáticas a través de:
+
For more information about the use of the '''Credential Store''', visit [https://pandorafms.com/docs/index.php?title=Pandora:Documentation_en:Managing_and_Administration#Credential_store this link]
  
<b>Consola</b>
 
Administración > Administrar configuración automática de agente
 
  
<center>[[Image:autoconf_menu_console.png‎‎]]</center>
+
'''Check that your environment is ready for deployment.'''
  
<b>Metaconsola</b>
+
When visiting the deployment center for the first time, the following notices will be shown:
Avanzado > Administración de agentes > Configuración automática de agentes
 
  
<center>[[Image:Autoconf1.png‎‎]]</center>
+
[[File:depl_info1.png]]
  
Una vez accede a la página de administración puede crear nuevas configuraciones automáticas presionando el botón "Crear configuración automática".
+
This message points out that objectives for deployment have not been defined yet.
  
Deberá elegir un nombre y una descripción para su configuración automática.
 
  
 +
[[File:Depl_info2.png]]
  
<center>[[Image:Autoconf_new.png‎‎]]</center>
+
These messages indicate:
  
 +
The first message indicates that the ''public_url'' public access URL must be configured so that the targets can get connected to the console and be configured.
  
Una vez creada la nueva configuración automática, puede mostrar los formularios de configuración pulsando en la sección que necesite:
+
{{Warning|This system does not perform PUSH operations. All deployments are sent by ''offering'' the software and ordering the target to install it.}}
  
  
<center>[[Image:Autoconf_options.png‎‎]]</center>
+
The second one indicates that no installers have been added to the agent repository. Register installers to deploy the software.
  
  
==== Reglas ====
 
  
Para definir los agentes sobre los que se aplicará la configuración automática, puede agregar reglas para identificarlos.
 
  
Despliegue el apartado de reglas dentro de su configuración automática, y seleccione "Agregar nueva regla".
+
==== Target Search ====
  
 +
'''Search or point out the targets in the deployment center.'''
  
Podrá elegir en el selector de reglas una serie de opciones, para identificar los agentes que se vayan a configurar.
+
Use any of the methods described below to register new targets.
  
<center>[[Image:autoconf_rules1.png||750px‎‎]]</center>
+
You may use any of the following options to define targets:
  
; Server name: Coincidencia en nombre de servidor
+
[[File:Depl_action_buttons.png]]
; Group name: Coincidencia en nombre de grupo
 
; OS: Coincidencia en nombre de sistema operativo (usa expresiones regulares)
 
; Custom field: Coincidencia por clave/valor en base a un campo personalizado reportado por el agente, indique el nombre del campo personalizado y el valor que debe tener.
 
; IP range: Coincidencia por rango de IP (red), utilice la notación IP/máscara, por ejemplo
 
192.168.1.0/24
 
  
; Script output (> 0): Resultado de la ejecución de un script, la regla se evaluará como válida siempre que el resultado en la salida standard sea mayor que 0.
 
  
La llamada al script de reglas admite las siguientes macros en el campo 'argumentos':
 
; _agent_ : Se sustituirá por el nombre del agente
 
; _agentalias_ : Se sustituirá por el alias del agente;
 
; _address_ : Se sustituirá por la dirección IP principal reportada por el agente
 
; _agentgroup_ : Se sustituirá por el nombre del grupo reportado por el agente
 
; _agentos_ : Se sustituirá por el sistema operativo del agente
 
  
 +
===== Scan one or more networks in pursuit of targets. =====
  
Puede elegir entre operadores <i>AND</i> y <i>OR</i> para modificar la lógica de las reglas.
+
By pressing the scan targets button, a pop-up with the following fields will be displayed:
  
<center>[[Image:autoconf_rules2.png||750px‎‎]]</center>
+
[[File:Depl2.png]]
  
  
<b>Nota:</b> Si no agrega ninguna regla, la configuración automática no se aplicará.
+
Firstly indicate:
  
Si necesita una única configuración para todos los agentes, puede utilizar la expresión regular siguiente para que coincida con cualquier <i>alias</i>
+
* The network or networks (separated by commas) to scan.
 +
* The Discovery server that will perform the scan.
 +
* The credentials used to try to connect to the discovered targets.
 +
* The software agent version registered as "desired" for the discovered targets.
 +
* The IP of the target server where these software agents will point when they are installed (it corresponds to the "server_ip" field in the agent configuration file).
  
.*
 
  
 +
When pressing 'Scan', you will receive a confirmation, with a link that you can follow to check the progress of this task.
  
 +
[[File:Depl_info3.png]]
  
==== Configuraciones ====
 
  
Desde esta sección podremos configurar:
+
A new entry will appear in the task list:
  
; Grupo del agente: Podremos mantenerlo sin cambios o forzarlo a ser uno específico.
+
[[File:Depl2b.png]]
; Grupos secundarios: Los grupos seleccionados aquí se agregarán como grupos secundarios al agente.
 
; Políticas: Podemos seleccionar políticas para que se apliquen automáticamente cuando el agente alcance el servidor.
 
; Bloque de configuración: Agrega la configuración extra en bruto al fichero de configuración del agente.
 
  
  
<center>[[File:autoconf_config.png]]</center>
+
{{Tip|Discovery tasks related to agent deployment are '''volatile''' tasks. Once completed, they will be automatically deleted. Information about scan or deployment, both successful and failing, can be consulted from the deployment center itself.}}
  
<b>Nota:</b> Si intenta acceder a la administración de configuraciones automáticas desde un nodo que pertenece a una Metaconsola, con la administración centralizada activa, la vista será de sólo lectura:
 
  
<center>[[File:autoconf_ro.png]]</center>
 
  
 +
As possible targets are found, they will appear in the deployment center:
  
 +
[[File:Depl3.png]]
  
==== Acciones extra ====
 
  
Desde esta sección puede asociar otras acciones a la autoconfiguración, como por ejemplo:
+
{{Tip|The discovered targets added to this list are all found devices whose operating system matches Windows or Linux / Unix based systems, regardless of whether valid credentials were found or not.}}
  
#Lanzar un evento personalizado
+
===== Define a target manually. =====
#Ejecutar una acción de alerta
 
#Ejecutar un script
 
  
 +
You may manually register the target by defining:
  
<center>[[File:autoconf_actions.png]]</center>
+
* IP.
 +
* OS. This version only allows Windows and those operating systems based on Linux / Unix (compatible with the tar.gz agent installer).
 +
* Architecture.
 +
* Credentials used to try to connect to the target.
 +
* The agent version you wish to deploy.
 +
* The IP address of the server where that agent will point once installed (it corresponds to the field ''server_ip '' of the software agent configuration).
  
 +
[[File:Depl5.png]]
  
El sistema admite las siguientes macros:
+
===== Upload a CSV file with target information. =====
; _agent_ : Se sustituirá por el nombre del agente
 
; _agentalias_ : Se sustituirá por el alias del agente;
 
; _address_ : Se sustituirá por la dirección IP principal reportada por el agente
 
; _agentgroup_ : Se sustituirá por el nombre del grupo reportado por el agente
 
; _agentos_ : Se sustituirá por el sistema operativo del agente
 
; _agentid_ : Se sustituye por el ID del agente.
 
  
== Agentes Unix/Linux ==
+
If you wish to mass register targets, upload a CSV file with the following format:
  
  
 +
IP; OS; Architecture; Target agent version; Credential identifier; Target server ip
  
=== Configuración de los agentes Unix de Pandora FMS ===
 
  
Las rutas y directorios fundamentales a tener en cuenta son:
+
[[File:Depl6.png]]
  
* ''/usr/share/pandora_agent'': donde se instala el agente de Pandora FMS.En los sistemas donde por políticas esto no se permita, se recomienda crear un enlace a esta ruta desde la ruta real de instalacion, p.e /opt/pandora -> /usr/share/pandora_agent
+
The system will create the objectives based on what is defined in the CSV.
  
* ''/etc/pandora/pandora_agent.conf'': Fichero principal de configuración del agente. Los módulos de ejecución local y plugins de agente se configuran aquí.
+
==== Deploy the software ====
  
* ''/usr/local/bin/pandora_agent'': Binario ejecutable del agente. Generalmente tiene un enlace a /usr/bin/pandora_agent
+
{{Warning|You may only schedule deployment against targets whose information is complete, specifying both credentials and software versions to deploy.}}
  
* ''/usr/local/bin/tentacle_client'': Binario ejecutable de Tentacle, para la transferencia de ficheros hacia el servidor. Generalmente tiene un enlace a /usr/bin/tentacle_client.
+
When you have possible targets on the list, launch agent deployment:
  
* ''/etc/init.d/pandora_agent_daemon'': Script de inicio/parada/reinicio.  En los sistemas AIX el demonio es ''' /etc/rc.pandora_agent_daemon '''.  
+
[[File:Depl4.png]]
  
* ''/var/log/pandora/pandora_agent.log'': Fichero de texto donde se guarda la actividad del agente de Pandora FMS, cuando el agente se ejecuta en modo de depuración.
 
  
* ''/etc/pandora/plugins'': Directorio que contiene los plugins de agente. Está enlazado al directorio ''/usr/share/pandora_agent/plugins''.
+
Select the IPs of the targets from the list (only valid targets will appear) and press ''deploy''.
  
* ''/etc/pandora/collections'': Directorio que contiene las colecciones desplegadas al agente. Está enlazado al directorio ''/usr/share/pandora_agent/collections''.
+
A Discovery task for background deployment will automatically be created, which will install the agent on the desired targets.
  
=== Ejecución inicial del agente Unix ===
+
You can confirm that the agent has been successfully installed from the list of objectives of the deployment center:
  
Para iniciar el agente es únicamente necesario ejecutar:  
+
[[File:Depl7.png]]
  
/etc/init.d/pandora_agent_daemon start
 
  
Para detener el agente, ejecute:
+
The name of the target also becomes a link to the corresponding Pandora FMS agent.
  
/etc/init.d/pandora_agent_daemon stop
 
  
Este script de arranque podrá iniciar o detener el agente de Pandora FMS, que al iniciarse quedará por defecto corriendo en el sistema como un demonio.
+
Failure example: The user not only entered the IP of the target, but also its netmask ('''THE IP IS ENOUGH''').
  
=== Modificar la forma en que los agentes Unix obtienen información del sistema ===
+
When the system tries to deploy the software, it will notice that the IP format is not correct and will warn the user:
  
Como vimos en la sección de configuración, existen algunos módulos que obtienen la información de forma predefinida sin necesidad de indicar un comando con ''module_exec''.
+
[[File:Depl_err1.png]]
Estos módulos son:
 
  
* module_procmem
+
==Import a list of your devices in CSV==
* module_freedisk
 
* module_freepercentdisk
 
* module_cpuproc
 
* module_proc
 
* module_procmem
 
* module_cpuusage
 
* module_freememory
 
* module_freepercentmemory
 
  
Es posible modificar el funcionamiento de estos módulos por defecto editando directamente el ejecutable del agente (por defecto ''/usr/bin/pandora_agent'').
+
A list of devices can be imported to represent them as agents using the agent import wizard through CSV.
El agente de Pandora FMS está ubicado generalmente en /usr/bin/pandora_agent. Buscando la cadena "Commands to retrieve" llegamos a la parte de código que contiene los comandos internos. Podemos hacer las modificaciones que necesitemos para adaptarlos a nuestro sistema.
 
  
# Commands to retrieve total memory information in kB
+
{{Tip|This feature only creates agents in Pandora FMS for its remote monitoring.}}
use constant TOTALMEMORY_CMDS => {
 
linux => 'cat /proc/meminfo  | grep MemTotal: | awk \'{ print $2 }\'',
 
solaris => 'MEM=`prtconf | grep Memory | awk \'{print $3}\'` bash -c \'echo $(( 1024 * $MEM ))\'',
 
hpux => 'swapinfo -t | grep memory | awk \'{print $2}\''
 
};
 
 
# Commands to retrieve partition information in kB
 
use constant PART_CMDS => {
 
# total, available, mount point
 
linux => 'df -P | awk \'NR > 1 {print $2, $4, $6}\'',
 
solaris => 'df -k | awk \'NR > 1 {print $2, $4, $6}\'',
 
hpux => 'df -P | awk \'NR > 1 {print $2, $4, $6}\'',
 
aix => 'df -kP | awk \'NR > 1 {print $2, $4, $6}\''
 
};
 
  
Para cambiar cualquiera de los comandos predefinidos, simplemente edite el código para modificar el comando, pero tenga cuidado con los siguientes aspectos:
 
  
# Verifique que las líneas terminan en ";"
+
<center>
# Verifique que los comandos están encerrados entre comillas simples: ' '
+
[[File:hostdevices2.png]]
# Verifique que cualquier comilla simple que quiera usar en el comando, esté escapada previamente con el carácter \, es decir \', por ejemplo, este comando que normalmente sería:
+
</center>
  
df -P | awk 'NR > 1 {print $2, $4, $6}'
+
Select the separator used, the server on which you wish to import and the file that contains the data, then click on "next".
  
Se escribiría como:
+
<center>
 +
[[File:hostdevices3.png]]
 +
</center>
  
df -P | awk \'NR > 1 {print $2, $4, $6}\'
+
==Custom NetScan==
  
== Agentes Windows de Pandora FMS ==
+
It allows the execution of custom scripts for the execution of network recognition tasks.
  
=== Configuración del agente de Windows de Pandora FMS ===
+
Create a recognition task specifying:
  
Las rutas y directorios fundamentales en las instalaciones del agente Windows se encontrarán en el propio directorio donde se haya instalado el agente, por defecto ''C:\Program Files''. Los más importantes a tener en cuenta son:
+
* Task name: Name of the recognition task.  
 +
* Comment: Allows adding comments.
 +
* Discovery server: Server that will execute the task.
 +
* Group: Group it belongs to.
 +
* Interval: Execution interval.
  
* ''C:\Program Files\pandora_agent'': donde se instala el agente de Pandora FMS, su ejecutable y sus directorios.
+
<center>
 +
[[File:DISC_NetScan_Custom_1.JPG]]
 +
</center>
  
* ''C:\Program Files\pandora_agent\pandora_agent.conf'': Fichero principal de configuración del agente. Los módulos de ejecución local y plugins de agente se configuran aquí.
+
Once the process of creating the task is complete, specify the script that you wish to run, as well as the configuration file necessary for its execution.
  
* ''C:\Program Files\pandora_agent\PandoraAgent.exe'': Binario ejecutable del agente.
+
==Net scan scripts==
  
* ''C:\Program Files\pandora_agent\util\tentacle_client.exe'': Binario ejecutable de Tentacle, para la transferencia de ficheros hacia el servidor.
+
This section will show the different scripts that have been created for custom recognition tasks. A view is displayed where the name and description of the task are defined.  
  
* ''C:\Program Files\pandora_agent\scripts'': Scripts de inicio/parada/reinicio del agente de Pandora FMS.
+
<center>
 
+
[[File:DISC_Net_scan_scripts.JPG]]
* ''C:\Program Files\pandora_agent\pandora_agent.log'': Fichero de texto donde se guarda la actividad del agente de Pandora FMS, cuando el agente se ejecuta en modo de depuración.
+
</center>
 
 
* ''C:\Program Files\pandora_agent\util'': Directorio que contiene los plugins de agente.
 
 
 
* ''C:\Program Files\pandora_agent\collections'': Directorio que contiene las colecciones del agente.
 
 
 
== Despliegue automático de agentes software ==
 
 
 
Puede desplegar agentes software utilizando la '''central de despliegues''' a través del sistema Discovery, más información en [https://pandorafms.com/docs/index.php?title=Pandora:Documentation_es:Discovery#Despliegue_autom.C3.A1tico_de_agentes este enlace]
 
 
 
 
 
== Auto-actualización de los agentes software ==
 
 
 
Utilizando las colecciones de archivos y la herramienta pandora_update podemos proporcionar una manera de "auto-actualizar" los agentes software.
 
{{Tip|La herramienta pandora_update necesita el módulo de perl Digest::MD5 para funcionar. A partir de la versión 5.14 de Perl, este módulo está integrado por defecto, pero en versiones anteriores deberá instalarse manualmente.}}
 
Esto funciona del siguiente modo:
 
 
 
1. Los agentes reciben nuevos binarios en el directorio de entrada de las colecciones.
 
 
 
Ejemplo en Windows:
 
 
 
c:\program files\pandora_agent\collections\fc_1\PandoraAgent.exe
 
 
 
Ejemplo en Linux:
 
 
 
/etc/pandora/collections/fc_1/pandora_agent
 
 
 
2. El agente ejecuta el plugin pandora_update. Este plugin recibe un único parámetro: el nombre corto de la colección (en este ejemplo, ''fc_1''). Analizará el directorio de la colección buscando el binario del agente (no el instalador entero), comparará el binario ubicado en la colección con el que se encuentra corriendo en ese momento y si son diferentes, pandora_update detiene el agente, reemplaza el binario y reinicia el agente de nuevo utilizando el nuevo binario.
 
 
 
Para actualizar diferentes arquitecturas se deberá establecer una colección diferente para cada arquitectura. Por ejemplo, si se desean actualizar agentes de Windows de 32 y 64 bits, habrá que crear dos colecciones y en cada una de ellas incluir el binario ''PandoraAgent.exe'' correspondiente.
 
 
 
3. Pandora_update también escribe a un log pequeño el evento actualizado, para ser capaz de recuperar en la siguiente ejecución y avisar al usuario, mediante el uso de un módulo async_string, acerca del proceso de actualización del agente.
 
 
 
Esto implica que los módulos utilizados para completar el proceso de actualización podrán ser configurados para tener un intervalo alto.
 
 
 
'''Unix instalación estandar'''
 
 
 
module_begin
 
module_name Pandora_Update
 
module_type async_string
 
module_interval 20
 
module_exec nohup /etc/pandora/plugins/pandora_update fc_1 2> /dev/null && tail -1 nohup.out 2> /dev/null
 
module_description Module to check new version of pandora agent and update itself
 
module_end
 
 
 
'''Unix instalación personalizada'''
 
  
module_begin
+
Pandora FMS allows adding additional scripts to make monitoring and recognition of required networks easier.
module_name Pandora_Update
 
module_type async_string
 
module_interval 20
 
module_exec nohup /var/opt/PandoraFMS/etc/pandora/plugins/pandora_update fc_1 /var/opt/PandoraFMS 2> /dev/null && tail -1 nohup.out 2> /dev/null
 
module_description Module to check new version of pandora agent and update itself
 
module_end
 
  
NOTA: El comando pandora_update acepta como segundo parámetro el path del directorio de instalación de Pandora FMS no siendo necesario especificarlo si la instalación se realizó en el path por defecto.
+
The parameters that can be defined are the following:  
  
'''Windows'''
+
* Name: Script name.  
 
+
* Script fullpath: Path where the script is located.
module_begin
+
* Description: Script description. You can define descriptions of the different fields, as well as default values for them.  
module_name Pandora_Update
+
* Hide value: In case you wish to hide the value of a field.  
module_type async_string
+
* Help: Help fields.  
module_interval 20
 
module_exec pandora_update.exe fc_1
 
module_description Module to check new version of pandora agent and update itself
 
module_end
 
 
 
== Autocreación de agentes y modulos desde XML  ==
 
 
 
Los agentes pueden configurarse desde la consola en tres modos de trabajo:
 
 
 
* '''Modo aprendizaje''': Si el XML recibido del agente software contiene nuevos módulos, éstos serán automáticamente creados. Este es el comportamiento por defecto.
 
* '''Modo normal''': No se crearán nuevos módulos que lleguen en el XML si no han sido declarados previamente en la consola.
 
* '''Modo autodeshabilitado''': Similar al ''modo aprendizaje'', en este modo, además, si todos los módulos pasan a estado desconocido el agente se deshabilitará automáticamente, pasando a habilitarse de nuevo si recibe nueva información.
 
  
 
<center>
 
<center>
<br><br>
+
[[File:DISC_Net_scan_scripts_2.JPG]]
[[File:Learning mode.png]]
 
<br><br>
 
 
</center>
 
</center>
  
=== Datos que se incorporan en la creación del agente ===
+
Creating scripts allows adding macros with which to define all the parameters needed for the correct execution of the script.
 
 
Los datos que se incorporan al agente en el momento de la creación del mismo de forma automática al recibir un XML son los siguientes:
 
 
 
* Nombre de agente
 
* IP de agente
 
* Descripcion del agente.
 
* Agente padre.
 
* Timezone offset.
 
* Grupo.
 
* Sistema operativo.
 
* Intervalo.
 
* Agent version
 
* Custom fields.
 
* Custom ID.
 
* Dirección URL.
 
* Modo de agente: Aprendizaje, Normal, Auto-deshabilitado.
 
 
 
=== Datos que se actualizan del agente al recibir un XML (modo aprendizaje activado) ===
 
 
 
* Dirección IP del agente.
 
* Padre del agente.
 
* Versión SO.
 
* Versión agente.
 
* Zona horaria.
 
* Custom fields.
 
 
 
{{tip|Los datos GIS se actualizan siempre (si están habilitados) sin importar si el learning mode esta desactivado}}
 
 
 
Además, con ''modo aprendizaje'' activado se crearán nuevos módulos en Pandora FMS al ser recibidos a través de XMLs.
 
 
 
=== Datos que se incorporan en la creación de un módulo ===
 
 
 
Los datos que se incorporan en el módulo la primera vez que se recibe un XML son los siguientes:
 
 
 
* Nombre.
 
* Tipo.
 
* Descripción.
 
* Máximo, Mínimo.
 
* Post proceso.
 
* Intervalo del módulo.
 
* Min/max Critical.
 
* Min/max Warning.
 
* Desactivado.
 
* Unidades.
 
* Module group.
 
* Custom ID.
 
* Str. Warning/Critical.
 
* Instrucciones para crítico.
 
* Instrucciones para warning.
 
* Instrucciones para desconocido.
 
* Tags.
 
* Inversión de critical.
 
* Inversión de warning.
 
* Modo "silencioso".
 
* Min. FF Threshold.
 
* Alert template.
 
* Crontab.
 
 
 
=== Datos que se actualizan de un módulo ya existente al recibir un XML ===
 
 
 
Cuando se recibe un XML que contiene información de un módulo ya existente, únicamente se actualiza la descripción y la información extendida, además del dato del módulo.
 
 
 
[[Pandora:Documentation|Volver a Indice de Documentacion Pandora FMS]]
 
 
 
[[Category:Pandora FMS]]
 
[[Category:Documentation]]
 

Revision as of 12:16, 22 May 2020

Contents

1 What is Pandora FMS Discovery?

Info.png

Available for Pandora FMS 732 versions or higher.

 


Discovery provides a set of tools to simplify monitoring through wizards.

The following tools are included:

Task list
Pandora FMS Discovery tool allows you to see a list of all the tasks programmed in your environment, both at console and server levels.
Discovery Applications
It allows to monitor MySQL, Oracle or VMware environments from a new management console.
Discovery Cloud
Through this feature, you may monitor your cloud infrastructure, ranging from virtual machines created through Amazon Web Services (EC2) or relational databases in AWS RDS, to virtual machines running in Azure Compute.
Console Tasks
It allows you to automate console tasks within the Discovery system, like scheduling reports, doing backups or executing custom scripts from Pandora FMS Console.
Discovery Host&Devices
It includes the tools needed to discover or import devices and equipment to your network.

Discovery1.png

2 Discovery Task list

Pandora FMS Discovery tool allows you to see a list of all the tasks programmed in your environment, both at console and server levels.

DISC Task list 1.JPG

2.1 Console tasks

This section allows you to see the list of scheduled tasks in the console. The information is shown according to the following parameters:

  • User: It is the user who created the task.
  • Task: Description of the programmed task
  • Scheduled: It specifies how often the task will be executed.
  • Next Execution: It specifies the next task execution.
  • Last Execution: It indicates when the task was last executed.
  • Group: The group to which the task belongs.
  • Operations: It shows the actions that can be performed on the task, such as editing and deleting.

2.1.1 Edit Console tasks

This button allows access to the creation section, where the desired task can also be edited according to the following parameters:

  • Task: The task that will be executed among the following:
    • Backup Pandora FMS database.
    • Execute custom script.
    • Save custom report to disk.
    • Save custom XML report to disk.
    • Send custom report (from template) by email.
    • Send custom report by email.
  • Scheduled: It is used to specify how often the task will be executed.
  • Next execution: It shows the date of the next execution, being able to modify it if necessary.
  • Group: Group to which the task belongs.
  • Parameters: They are the specific parameters of each task.

2.1.1.1 Parameters of different tasks


Backup Pandora FMS database
  • Description: Backup description.
  • Save to disk in path: Path where the backup will be stored.

Execute custom script
  • Custom script: The script to be executed will be indicated.

“Save custom report to disk” and “Save custom XML report to disk”
  • Report pending to be created: The report to be created.
  • Save to disk in path: Path where the created report will be stored.

Send custom report (from template) by email
  • Template pending to be created: Custom template to be created.
  • Agents: Agents from which the information that will be reflected in the report will be obtained.
  • Report per agent: If you wish to generate separate reports for each report.
  • Report name: Name that you wish to give the report.
  • Send to email addresses: Email addresses to which the report will be sent.
  • Subject: Topic of the mail to be sent.
  • Message: Body of the message with which the reports will be sent.

Send custom report by email
  • Report pending to be created: Report to be generated.
  • Send to email addresses: Email addresses the report will be sent to.
  • Subject: Topic of the mail to be sent.
  • Message: Body of the message with which the reports will be sent.
  • Report Type: Type of report that will be sent.

2.2 Server tasks

This section reflects the recognition tasks programmed by the server. The information is shown according to the following parameters:

  • Force: Option that will allow forcing the task execution.
  • Task name: Name assigned to the task.
  • Server name: Server that will execute the task.
  • Interval: Time interval during which the task will be performed.
  • Network: Network where the checks will be made.
  • Status: Status of the scheduled task.
  • Task type: Type of the task that has been generated.
  • Progress: Progress of the task in case of being executed.
  • Updated at: It indicates when the task was last executed.
  • Operations: Actions that can be performed on the task. Display of the task status, display of the map of the discovered network, editing and deletion.

2.2.1 Operations

The edition of the server recognition tasks allows to adjust the following parameters:

  • Interval: The task execution interval can be set, either manually or defined.
  • Task name: Task Name.
  • Discovery server: Server that will perform the recognition task. It is a mandatory parameter for correct recognition operation.
  • Network: Network on which the checks are to be carried out.
  • Group: Group to which it belongs.
  • Comment: Comments to add.

3 Discovery Applications

Now, it is possible to monitor applications remotely using Discovery Applications.


Discoverysap1.png

3.1 Discovery Applications: MySQL

From Pandora FMS 7.0-733 version on, MySQL environments can be monitored using Discovery Applications.

For that purpose, it will be necessary to define the following parameters:

  • Task name: Name of the task that will perform MySQL monitoring.
  • Discovery Server: Server that will perform the execution of the specified task.
  • Group: Group to which it belongs.
  • MySQL server IP: IP of the server where the MySQL environment to be monitored is.
  • MySQL server port: Port of the specified address through which the information of MySQL monitoring will be obtained.
  • User: MySQL user with which to login. (Important: It must be a user with permissions on the database where the queries will be executed, since otherwise the connection will never be established.)
  • Password: MySQL user password specified above.
  • Interval: Time interval in which monitoring will be executed.

DISCMySQL1.JPG

Once the parameters with the data needed for installation are defined, you will be shown a new window where you must specify the agent on which you wish to create all the modules resulting from MySQL monitoring.

The options to be displayed are the following:

  • Target agent: Agent on which the modules resulting from monitoring will be created.
  • Custom module prefix: It defines a custom prefix that will be concatenated with the name of the modules generated by the task.
  • Scan databases: It will scan the databases.
  • Create agent per database: This option will allow an agent to be created for each database found in MySQL environment.
  • Check engine uptime: It will check the time that MySQL engine is operational.
  • Retrieve query statistics: It allows to recover the statistics of the executed queries.
  • Analyze connections: It analyzes connections.
  • Retrieve InnoDB statistics: It returns InnoDB statistics.
  • Retrieve cache statistics: It returns cache statistics.
  • Custom queries: It allows defining custom statements.

DISCMySQL2.JPG

3.2 Discovery Applications: Oracle

From Pandora FMS 7.0-733 version on, Oracle can be monitored using Discovery Applications.

Oracle monitoring will allow to define the following parameters:

  • Task name: Task Name
  • Discovery server: Server that will run the Oracle monitoring task.
  • Group: Group it belongs to.
  • Oracle target strings: Where the target strings of the task will be defined.
  • User: Oracle user that will access to perform the monitoring.
  • Password: Password of the previously defined user.
  • Interval: Execution interval

DISC Oracle1.JPG

Once defined, it will be necessary to specify the agent that will store the information and the checks that will be made. The information that can be defined in this section is the following:

  • Target agent: Agent that will receive Oracle monitoring information.
  • Custom module prefix: It defines a custom prefix that will be concatenated with the name of the modules generated by the task.
  • Check engine uptime: It will check the time that Oracle is operational.
  • Retrieve query statistics: It allows to recover the statistics of the executed queries.
  • Analyze connections: It analyzes connections.
  • Calculate fragmentation ratio: It calculates the fragmentation rate.
  • Monitor tablespaces: It monitors tablespaces.
  • Retrieve cache statistics: It returns cache statistics.
  • Execute custom queries: It executes custom queries.
  • Custom queries: it allows to define customized queries.

DISC Oracle2.JPG

3.2.1 Installing Oracle packages

It is very important to bear in mind that for the correct integration and operation of Oracle with Pandora FMS, it is necessary to have the appropriate packages. Pandora FMS ISO includes everything necessary, but for installations carried out in another way, the installation process will be as follows:

  • Install oracle instant client from the Oracle page:
https://www.oracle.com/technetwork/database/database-technologies/instant-client/downloads/index.html
  • Required packages:
oracle-instantclient11.1-basic-11.1.0.7.0-1.x86_64.rpm
oracle-instantclient11.1-devel-11.1.0.7.0-1.x86_64.rpm
oracle-instantclient11.1-sqlplus-11.1.0.7.0-1.x86_64.rpm
  • Prepare the boot environment of pandora_server:

Template warning.png

In the pandora_server path you need to create a file called pandora_server.env with the following information. Its execution is needed ./pandora_server.env

 


# Set Oracle environment for pandora_server
cat > /etc/pandora/pandora_server.env << 'EOF_ENV'
#!/bin/bash
VERSION=11.1
export PATH=$PATH:$HOME/bin:/usr/lib/oracle/$VERSION/client64/bin
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/oracle/$VERSION/client64/lib
export ORACLE_HOME=/usr/lib/oracle/$VERSION/client64
EOF_ENV
  • Restart pandora_server
/etc/init.d/pandora_server restart

Template warning.png

If package E7 is being used, version 12.2 of both library and environment variables must be installed, and Oracle (v12.2) packages must be used

 


3.3 Discovery Applications: SAP


Discovery Applications has a new family member from Pandora FMS version 741 onwards. This new feature will now be included in the official ISO installation.

Template warning.png

If you Pandora FMS is installed from packages, or your system is prior to NG741, deploy the official SAP plugin in Pandora FMS server and configure it manually (see below).

 


Template warning.png

In order to use SAP in Discovery, configure a specific license number for this plugin, which is not included in Pandora FMS Enterprise license. Configure this license in Setup > Enterprise.

 


The system will guide you along each step to configure SAP, according to your needs. You may define the same task to monitor systems with similar configurations.

Discoverysap2.png

In the example above, servers sapsample.artica.lan, sap2.artica.lan and 10.0.30.33 use the same client, system and credential configuration, so they can be grouped in the same task.

Template warning.png

If you need to monitor different configurations, create a task for each configuration.

 


Select from the list the information about the SAP system you wish to retrieve as shown below:

Discoverysap3.png

Pandora FMS Discovery will be in charge of collecting information, storing it in agents represented by the defined ¨SAP Hostnames¨.


3.3.1 SAP Discovery connector manual installation

If your Pandora FMS version was installed before the NG741 version, download the connector and configure it manually.

First, install JAVA (JRE) on Pandora FMS server for Discovery SAP operation.

Then you need to download the remote connector/plugin for Linux from SAP, download it from our library.

Configure your pandora_server.conf too, and set the following parameters:

# Discovery SAP 
java /usr/bin/java

# Discovery SAP utils
sap_utils /usr/share/pandora_server/util/recon_scripts/SAP

In the directory indicated, with the configuration token sap_utils decompress the files that you will find in the tarball downloaded from the library called "Pandora FMS SAP Discovery for Linux" that contains the following files:

Deset_SAP_Plugin.jar
dev_jco_rfc.trc
libsapjco3.so
sapjco3.dll
sapjco3.jar

Once the configuration file is modified, restart the Pandora FMS server.

3.3.2 SAP View


You can see the general state of the SAP system servers in the SAP View.

Discoverysap4.png

This view will display a panel with the available SAP modules of the selected SAP agent.

You may select the refresh time and the interval to show in the graphs.

3.3.3 SAP agent view


The SAP view is also integrated as a new tab within the agent view. If the system detects that the agent is a SAP agent, an access to the SAP View tab will be displayed:

Discoverysap5.png

The agent view will provide an overview of the status of the SAP modules for the current agent:

Discoverysap6.png


Template warning.png

Java must be installed within the server for SAP integration to work.

 


3.4 Discovery Applications: VMware

Template warning.png

In case of manual installation or update from a Pandora FMS version prior to 732, it is necessary to install SDK for VMWare to work properly.

 


From Pandora FMS 7.0-733 version on, VMware infrastructures can be monitored using Discovery Applications.


Discoveryapplications2.png


The following must be specified:

  • A name to identify the task.
  • A Discovery server where to run it.
  • A group to which the agents generated by the VMware task will be associated.

Info.png

It must be taken into account that if the Pandora FMS server has the autocreate_group token active, priority will be given to the group corresponding to the indicated ID, instead of applying the configuration of the wizard.

 



The data required to monitor VMware are:

  • V-Center IP
  • The name of the datacenter (it can be seen through VMware installation management screen).
  • User with read permissions.
  • User password.
  • Monitoring interval.

Password encryption can be enabled by pressing the button encrypt passwords. This only applies to the wizard in progress.


On the next page, VMware monitoring details can be specified:

Discoveryapplications3.png

  • Max threads: Choose the number of threads that the VMware monitoring script will use to speed up data collection.
  • Retry send: The information of the detected agents is sent by XML to the DataServer. This option must be activated to retry sending in case of error.
  • Event mode: Only for VCenter. VMware VCenter event-based monitoring is enabled. This working mode is exclusive and independent from standard monitoring.
  • Virtual network monitoring: It enables monitoring of virtual network devices which are defined in VMware.
  • Extra settings: Any advanced settings needed to customize VMware monitoring should be included here in text mode. For more information, visit this section.





3.5 Discovery Applications: MS SQL


This new Pandora FMS integration allows monitoring Microsoft SQL server databases.

Microsoft ODBC must be installed in the system where Pandora FMS server is running.

Info.png

From version 745 onwards, ODBC is preinstalled in Pandora FMS ISO.

 


3.5.1 How to install Microsoft ODBC

  • In CentOS 6:
curl https://packages.microsoft.com/config/rhel/6/prod.repo > /etc/yum.repos.d/mssql-release.repo && \
yum remove unixODBC-utf16 unixODBC-utf16-devel && \
ACCEPT_EULA=Y yum install -y msodbcsql17
  • In CentOS 7:
curl https://packages.microsoft.com/config/rhel/7/prod.repo > /etc/yum.repos.d/mssql-release.repo && \
yum remove unixODBC-utf16 unixODBC-utf16-devel && \
ACCEPT_EULA=Y yum install -y msodbcsql17

Once the ODBC is installed, it might be necessary to set which driver Pandora FMS should use. To that end, check Pandora FMS server configuration file.

/etc/pandora/pandora_server.conf

Once you go to the configuration file, look for the following token:

mssql_driver IDENTIFYING STRING

The IDENTIFYING STRING parameter can be found in /etc/odbcinst.ini which will be created when installing ODBC.

This is the default string:

ODBC Driver 17 for SQL Server

3.5.2 Configure a Discovery Applications MS SQL task

To create a monitoring task for a Microsoft SQL Server database, access through Discovery (Discovery > Applications > Microsoft SQL Server).

Once you choose the Microsoft SQL Server task, you may define the instances in the following way:

IP\Instance

If you wish so, define a port like this:

IP:Port\Instance

Mssql1.png


This integration's configuration advanced options include service stability, usage statistics, connection status and custom queries.

Mssql3.png

If you wish to execute any custom query, keep in mind they follow the same format as those of Oracle.

4 Discovery Cloud

Discovery Cloud allows you to monitor structures in the AWS cloud. Thanks to Pandora FMS, you can manage many Amazon Web Services accounts as well as Microsoft Azure's, concentrating information management in a single tool.

Azure66.JPG

Account management, both from AWS and Microsoft Azure, will be made through the Credential Store located in Profiles -> Manage agent groups -> Credential Store.

Credential store.png

4.1 Discovery Cloud: Amazon Web Services (AWS)

Template warning.png

This section is under construction.

 


To monitor an infrastructure in Amazon Web Services, follow the different pages of the wizard step by step.


4.1.1 AWS. Credential validation

Pandora FMS allows managing several AWS accounts. Once you have accessed the Amazon Web Services menu, the navigation will be automatically redirected to the window to select the account with which you need to access the service. If there is a previously created account in previous versions of Pandora FMS, it will be shown as "imported_aws_account".

AWSCredentials1.JPG

You can add as many accounts as necessary through the "Manage Accounts" option next to the AWS Account drop-down.

This will allow access to the "Credential store" section of Profiles> Manage agent groups and it will act as the store of all the Amazon Web Services accounts previously created to be registered.

AWS4.png

AWS5.png

Query accounts in Amazon AWS must be created with the following permissions:

Awsgrants.png

  • Billing (read)
  • CloudWatch (list,read)
  • Cost Explorer Service (Full access)
  • EC2 (full read, limited: list)


Summary of the policy in JSON:

{
   "Version": "2012-10-17",
   "Statement": [
       {
           "Sid": "VisualEditor0",
           "Effect": "Allow",
           "Action": [
               "ec2:DescribeInstances",
               "ec2:DescribeVolumesModifications",
               "ec2:GetHostReservationPurchasePreview",
               "ec2:DescribeSnapshots",
               "aws-portal:ViewUsage",
               "ec2:DescribePlacementGroups",
               "ec2:GetConsoleScreenshot",
               "ec2:DescribeHostReservationOfferings",
               "ec2:DescribeInternetGateways",
               "ec2:GetLaunchTemplateData",
               "ec2:DescribeVolumeStatus",
               "ec2:DescribeScheduledInstanceAvailability",
               "ec2:DescribeSpotDatafeedSubscription",
               "ec2:DescribeVolumes",
               "ec2:DescribeFpgaImageAttribute",
               "ec2:DescribeExportTasks",
               "ec2:DescribeAccountAttributes",
               "aws-portal:ViewBilling",
               "ec2:DescribeNetworkInterfacePermissions",
               "ec2:DescribeReservedInstances",
               "ec2:DescribeKeyPairs",
               "ec2:DescribeNetworkAcls",
               "ec2:DescribeRouteTables",
               "ec2:DescribeReservedInstancesListings",
               "ec2:DescribeEgressOnlyInternetGateways",
               "ec2:DescribeSpotFleetRequestHistory",
               "ec2:DescribeLaunchTemplates",
               "ec2:DescribeVpcClassicLinkDnsSupport",
               "ec2:DescribeVpnConnections",
               "ec2:DescribeSnapshotAttribute",
               "ec2:DescribeVpcPeeringConnections",
               "ec2:DescribeReservedInstancesOfferings",
               "ec2:DescribeIdFormat",
               "ec2:DescribeVpcEndpointServiceConfigurations",
               "ec2:DescribePrefixLists",
               "cloudwatch:GetMetricStatistics",
               "ec2:GetReservedInstancesExchangeQuote",
               "ec2:DescribeVolumeAttribute",
               "ec2:DescribeInstanceCreditSpecifications",
               "ec2:DescribeVpcClassicLink",
               "ec2:DescribeImportSnapshotTasks",
               "ec2:DescribeVpcEndpointServicePermissions",
               "ec2:GetPasswordData",
               "ec2:DescribeScheduledInstances",
               "ec2:DescribeImageAttribute",
               "ec2:DescribeVpcEndpoints",
               "ec2:DescribeReservedInstancesModifications",
               "ec2:DescribeElasticGpus",
               "ec2:DescribeSubnets",
               "ec2:DescribeVpnGateways",
               "ec2:DescribeMovingAddresses",
               "ec2:DescribeAddresses",
               "ec2:DescribeInstanceAttribute",
               "ec2:DescribeRegions",
               "ec2:DescribeFlowLogs",
               "ec2:DescribeDhcpOptions",
               "ec2:DescribeVpcEndpointServices",
               "ce:GetCostAndUsage",
               "ec2:DescribeSpotInstanceRequests",
               "cloudwatch:ListMetrics",
               "ec2:DescribeVpcAttribute",
               "ec2:GetConsoleOutput",
               "ec2:DescribeSpotPriceHistory",
               "ce:GetReservationUtilization",
               "ec2:DescribeNetworkInterfaces",
               "ec2:DescribeAvailabilityZones",
               "ec2:DescribeNetworkInterfaceAttribute",
               "ce:GetDimensionValues",
               "ec2:DescribeVpcEndpointConnections",
               "ec2:DescribeInstanceStatus",
               "ec2:DescribeHostReservations",
               "ec2:DescribeIamInstanceProfileAssociations",
               "ec2:DescribeTags",
               "ec2:DescribeLaunchTemplateVersions",
               "ec2:DescribeBundleTasks",
               "ec2:DescribeIdentityIdFormat",
               "ec2:DescribeImportImageTasks",
               "ec2:DescribeClassicLinkInstances",
               "ec2:DescribeNatGateways",
               "ec2:DescribeCustomerGateways",
               "ec2:DescribeVpcEndpointConnectionNotifications",
               "ec2:DescribeSecurityGroups",
               "ec2:DescribeSpotFleetRequests",
               "ec2:DescribeHosts",
               "ec2:DescribeImages",
               "ec2:DescribeFpgaImages",
               "ec2:DescribeSpotFleetInstances",
               "ec2:DescribeSecurityGroupReferences",
               "ec2:DescribeVpcs",
               "ec2:DescribeConversionTasks",
               "ec2:DescribeStaleSecurityGroups",
               "ce:GetTags"
           ],
           "Resource": "*"
       }
   ]
}


Assign the policy to a new user.

Awsgrants2.png


Back in Pandora FMS, the registered account can be used to link it and be able to access AWS monitoring.

Info.png

If pandora-cm-api is not available in the installation, it can be obtained from the following link: [1]

 



4.1.2 Discovery Cloud. AWS

Once the credentials have been validated, access the Discovery Cloud menu => Amazon Web Services

AWS6.png

In this section, Amazon EC2 and Amazon RDS are found. For each account added to the "Credential store", the EC2 environment hosted in that account can be monitored.

Info.png

Only one recognition task per AWS account can be active. The account will be the same for all monitored technologies within the provider.

 


4.1.3 Discovery Cloud. AWS.EC2

Within EC2 monitoring you can find:

  • Expense monitoring.
  • Summary of resources registered in AWS.EC2.
  • Specific instance monitoring.
  • Volume and elastic IP address monitoring.

To start the monitoring process, a series of basic data is requested:

Cloud3.png

It is required to provide a name for the task, indicate the Discovery server from where it will be executed and the monitoring interval.

4.1.3.1 Discovery Cloud AWS.EC2 Costs

When clicking next, you will start configuring AWS monitoring expenses:

Template warning.png

Amazon Web Services expense monitoring involves extra expenses. You can find more information about it in the following link [https://aws.amazon.com/aws-cost-management/pricing/

 


Expense monitoring provides a separate monitoring interval to avoid extra charges.

Cloud4.png

Both the overall cost and the independent cost per region can be monitored.

4.1.3.2 Discovery Cloud AWS.EC2 Summary

The Discovery task can be configured to collect general information on the stock status in all regions.

To enable it, the Scan and general monitoring option must be activated.

Cloud5.png

Generic CPU usage counters can be added, as well as output (disk) input operations or volume of disk and network transferred data (bytes).


4.1.3.3 Discovery Cloud AWS.EC2 Specific Instance Monitoring

Specific instances can be monitored to obtain readings of:

  • CPUUtilization: Average CPU usage
  • DiskReadBytes: Reading bytes (disk)
  • DiskWriteBytes: Writing bytes (disk)
  • DiskReadOps: Read operations (disk)
  • DiskWriteOps: Writing operations (disk)
  • NetworkPacketsIn: Input packets (network)
  • NetworkPacketsOut: Output packets (network)

The agents that represent the specific instances will have as their parent the agent that represents the region where they are hosted.

It must be verified that the update_parent token is configured to 1 in the Pandora FMS server configuration to keep the parent-child relationships updated.

Navigation must be carried out through the browser by selecting the instances that need to be monitored:

Cloud6.png

4.1.3.4 Discovery Cloud AWS.EC2 Extras

In this last screen you can indicate whether you want to monitor the volumes used by the reserved instances.

Two extra modules will appear in the region agents:

  • Total reserved volume (GB)
  • Total registered volumes (number)


You can also choose to activate the Elastic IP addresses token. The number of elastic IPs registered in the AWS.EC2 account will be reported.

Cloud7.png


Once the wizard is completed, the progress of the execution in Discovery Task list can be seen:

Tasklist1.png

4.1.4 Discovery Cloud. AWS.RDS

AWS RDS allows you to monitor relational databases provided by Amazon Web Services.

The RDS service provides a database server and allows creating the instance related to said database. In addition, RDS offers the possibility to connect to its instances through clients such as SSMS, MySQL workbench or through JDBC or ODBC DB APIs.

AWS8.JPG

Through Pandora FMS, different RDS instances can be monitored by filling in the parameters included in the menu shown at the top.

AWS RDS integration with Pandora FMS allows to monitor both the data source and their availablity.

In addition, the database running under RDS can be monitored retrieving all the metrics that could be monitored in a database as usual.

Template warning.png

Integration with AWS RDS only supports Oracle, MySQL and Mariadb.

 


4.1.5 Discovery Cloud. Overview

Discovery Cloud includes an overview where the key points of the infrastructure in Amazon Web Services can be reviewed. Pandora FMS allows displaying different maps based on existing accounts.

In the AWS view, the account from which you wish to display the information can be selected:

AWS9.JPG

It includes:

  • Current expenses
  • Previous expenses
  • Expense evolution chart (6 months)
  • Reserve / instance evolution chart (1 month)
  • Map of regions with the number of instances per region.

Awsview.png

4.2 Discovery Cloud: Microsoft Azure


To monitor an infrastructure in Microsoft Azure, follow these instructions step by step.

4.2.1 How to register a user to use the Azure API

Azure.png

  • Go to 'App registrations'> 'New registration'

Azure2.png


  • Enter the data.

Azure3.png


  • Write down the data "client_id" and "directory".

Azure4.png

  • Next, access 'certificates & secrets' and create a new one:

Azure5.png

Template warning.png

Write down the key that is shown, it is the application_secret.

 


4.2.2 Assigning permissions

Assign a role to the account that will operate (app). To that effect, access "home" and get into the subscription.

Azure6.png


Within the subscription, select "Access control (IAM)".

Azure7.png

Add a new role assignment and once there, select the "reader" role for the created app.

Azure8.png

It is important to save the changes by pressing "save".


From that moment onwards, you can connect to the service and make requests through pandora-cm-api.

4.2.2.1 Examples

The status of Azure can be checked from Pandora FMS as follows:

  • Preload the environment.
  • Run . load_env.sh
  • pandora-cm-api --product Azure --get availability


If the environment is operational, the system should return a response of 1.

An example of the contents of the load_env.sh script would be the following:

  • Azure
export CLIENT_ID=XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX

export DOMAIN=XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX

export APPLICATION_SECRET="XXXXXXXXXXXXXXXXXXXXXXXXX"

export AZURE_SUBSCRIPTION_ID=XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX

4.2.3 Configure a task in Pandora FMS

Pandora FMS allows managing several Microsoft Azure accounts.

You can add as many accounts as needed through the "Manage Accounts" option next to the Account drop-down.

This will allow access to the "Credential store" section of Profiles> Manage agent groups and it will act as the store of all previously created Microsoft Azure accounts to be registered.

To configure a new task, follow these steps:

  • Add a new password to the "credential store".

Azure9.png


  • Access 'Discovery> Cloud> Azure' and validate the Azure account.


Azure10.png


Azure11.png


Azure12.png


  • From that point onwards, it will be necessary to define the name of your recon task, the server that will execute the task, the group it will belong to and the execution interval.

AzureX3.PNG

  • Once task data are defined, select the Azure account sections that you wish to monitor. Each section will allow in turn to choose the desired instances.

AzureX4.PNG

  • The last step is selecting the metrics you wish to obtain from the agents generated by Pandora FMS for each instance it finds in Microsoft Azure. Once the section is configured, the task can be launched and Pandora FMS will create automatically agents according to the instances required in previous steps.

AzureX5.PNG


5 Discovery Console Tasks

Virtually identical to what was previously seen in Task List, Console Task will allow creating new tasks taking into account the following parameters:

  • Task: The task that will be executed among the following:
    • Backup Pandora FMS database.
    • Execute custom script.
    • Save custom report to disk.
    • Save custom XML report to disk.
    • Send custom report (from template) by email.
    • Send custom report by email.
  • Scheduled: It is used to specify how often the task will be executed.
  • Next execution: It shows the date of the next execution, being able to modify it if necessary.
  • Group: Group to which the task belongs.
  • Parameters: They are the specific parameters of each task.

ConsoleTasks.JPG

5.1 Parameters of different tasks


Backup Pandora FMS database
  • Description: Backup description.
  • Save to disk in path: path where the backup will be stored.

Execute custom script
  • Custom script: The script to be executed will be indicated.

“Save custom report to disk” and “Save custom XML report to disk”
  • Report pending to be created: The report to be created.
  • Save to disk in path: Path where the created report will be stored.

Send custom report (from template) by email
  • Template pending to be created: Custom template to be created.
  • Agents: Agents from which the information that will be reflected in the report will be obtained.
  • Report per agent: If you wish to generate separate reports for each report.
  • Report name: Name that you want to give the report.
  • Send to email addresses: Email addresses the report will be sent to.
  • Subject: Topic of the mail to be sent.
  • Message: Body of the message which will be sent together with the reports.

Send custom report by email
  • Report pending to be created: Report to be generated.
  • Send to email addresses: Email addresses the report will be sent to.
  • Subject: Topic of the mail to be sent.
  • Message: Body of the message with which the reports will be sent.
  • Report Type: Type of report that will be sent.

6 Discovery Host&Devices

The Discovery Host & Devices section offers a multitude of options to help manage and discover devices within as many environments as needed.

Therefore, it features the following tools:

  • Net Scan.
  • Import CSV.
  • Custom NetScan.
  • Manage NetScan scripts.


800

6.1 NetScan

With the NetScan tool, you may find devices in a network and apply different monitoring rules.

First, define the name of the task, the Discovery server that will run it, the group the discovered agents will be assigned to and the scanning interval.

In addition, you will have two options when performing the scanning task. You may indicate the networks to be discovered in the field designed to that end in Red or you may enable the token Use CSV file that will allow to load a csv file containing the specific devices or network to check throughout the recon task. If the csv file is selected, the Network option will not be enabled.

3oaKq2yukE.png

Template warning.png

The intervals selected as manuals must be manually launched. Discovery will not launch a manual task automatically.

 



In the features section, you may indicate the following options:

800


  • Known hardware auto discovery: It dinamically applies the templates that were previously added to the Private Enterprise Number section. To learn more, go to the following link.
  • Module templates: Try to apply the modules from from the selected templates. If the execution does not pass the test, they will not be added to the monitoring list.
  • Check results: The user must validate the results selecting which agents will be created from those found through the discovery task.
  • Apply autoconfiguration rules: It applies the predefined autoconfiguration rules to the detected agents. To learn more, go to the following link.

Info.png

Automatic configuration allows you to apply policies, group changes and settings, as well as launch custom events or execute scripts on actions.

 


Info.png

Agents detected by NetScan are remote agents without a configuration file. You cannot apply local monitoring policies or add configuration changes in block if you do not deploy an agent on the targets.

 



  • SNMP activated: To complete the information obtained from the discovered network devices, enable SNMP. That improves detection by scanning the SNMP information available in the discovered targets. Once this token is enabled, two more options appear:
    • SNMP version: Select the SNMP version configured in the scanned network devices. It supports SNMP versions 1,2, 2c and 3.
    • SNMP communities: Indicate the environment configured community. You may add as many communities as you need by typing them in the following box.
  • WMI enabled: You may enable WMI scanning. Just select the previously loaded credentials from the credential store.

Info.png

The different credentials provided against the detected objectives that support WMI will be tested, complementing monitoring with modules that will report about CPU, memory and disk usage.

 


  • SO detection: Detect the target's operating system.
  • Name resolution: Solve the target's name.
  • Parent detection: By means of the information collected through SNMP, the different interconnections between devices will be calculated, to be able to represent their network infrastructure.
  • Parent recursion: It improves parent detection adding recursion to the process.
  • VLAN enabled: It detects the VLAN to which the different devices are connected to.

Once the wizard is finished, Discovery will start executing it in each defined interval. If the interval is manual, the task should be started manually:

800

Once the task is finished, if you access from Review, you will see a summary of the devices found which respond to ping and the rest of metrics available through SNMP or WMI. All the IPs will be shown, but they may have two status:

  • Disabled: There is already an agent or module being monitored in the environoment and it will not be created nor modified.
  • Enabled: it is a new non-monitored element or within the obtained metrics there us a new element that responded and that will be displayed on a drop-down. You may choose to add it to the monitored agent list in thoses devices in this status or add any of the new enabled metrics.

HK8XAXtv92.png

Info.png

Once the targets to be monitored are selected, the system will create them systematically. Along the process, the target OS will be detected to complete the information gathered.

 


6.2 Automatic agent deployment

Template warning.png

Please confirm winexe command is installed and working in your server before using this feature. This utility is provided by Pandora FMS Enterprise server installer. You must install zlib.i686 and glibc.i686 to get winexe working.

 


Template warning.png

In Windows environments it is recommended to install as an administrator user. Before starting the service it will be necessary to define an administrator account for its use.

 



From Pandora FMS version 737 onwards, it is possible to deploy agents from the console itself using the deployment center.

Template warning.png

Server version must be EL7 for agent automatic deployment to work.

 


Depl1.png


The steps to deploy agents from the console are:

Register the versions of the software agents to be deployed in the agent repository.

The installers of the agents to be deployed throughout the infrastructure are needed. You may use custom agents.

For more information about the use of the agent repository, visit this link


Register the credentials to be used to connect the targets in the credential manager.

Specify the credentials with which the accesses to found or specified targets will be tested.

For more information about the use of the Credential Store, visit this link


Check that your environment is ready for deployment.

When visiting the deployment center for the first time, the following notices will be shown:

Depl info1.png

This message points out that objectives for deployment have not been defined yet.


Depl info2.png

These messages indicate:

The first message indicates that the public_url public access URL must be configured so that the targets can get connected to the console and be configured.

Template warning.png

This system does not perform PUSH operations. All deployments are sent by offering the software and ordering the target to install it.

 



The second one indicates that no installers have been added to the agent repository. Register installers to deploy the software.



6.2.1 Target Search

Search or point out the targets in the deployment center.

Use any of the methods described below to register new targets.

You may use any of the following options to define targets:

Depl action buttons.png


6.2.1.1 Scan one or more networks in pursuit of targets.

By pressing the scan targets button, a pop-up with the following fields will be displayed:

Depl2.png


Firstly indicate:

  • The network or networks (separated by commas) to scan.
  • The Discovery server that will perform the scan.
  • The credentials used to try to connect to the discovered targets.
  • The software agent version registered as "desired" for the discovered targets.
  • The IP of the target server where these software agents will point when they are installed (it corresponds to the "server_ip" field in the agent configuration file).


When pressing 'Scan', you will receive a confirmation, with a link that you can follow to check the progress of this task.

Depl info3.png


A new entry will appear in the task list:

Depl2b.png


Info.png

Discovery tasks related to agent deployment are volatile tasks. Once completed, they will be automatically deleted. Information about scan or deployment, both successful and failing, can be consulted from the deployment center itself.

 



As possible targets are found, they will appear in the deployment center:

Depl3.png


Info.png

The discovered targets added to this list are all found devices whose operating system matches Windows or Linux / Unix based systems, regardless of whether valid credentials were found or not.

 


6.2.1.2 Define a target manually.

You may manually register the target by defining:

  • IP.
  • OS. This version only allows Windows and those operating systems based on Linux / Unix (compatible with the tar.gz agent installer).
  • Architecture.
  • Credentials used to try to connect to the target.
  • The agent version you wish to deploy.
  • The IP address of the server where that agent will point once installed (it corresponds to the field server_ip of the software agent configuration).

Depl5.png

6.2.1.3 Upload a CSV file with target information.

If you wish to mass register targets, upload a CSV file with the following format:


IP; OS; Architecture; Target agent version; Credential identifier; Target server ip


Depl6.png

The system will create the objectives based on what is defined in the CSV.

6.2.2 Deploy the software

Template warning.png

You may only schedule deployment against targets whose information is complete, specifying both credentials and software versions to deploy.

 


When you have possible targets on the list, launch agent deployment:

Depl4.png


Select the IPs of the targets from the list (only valid targets will appear) and press deploy.

A Discovery task for background deployment will automatically be created, which will install the agent on the desired targets.

You can confirm that the agent has been successfully installed from the list of objectives of the deployment center:

Depl7.png


The name of the target also becomes a link to the corresponding Pandora FMS agent.


Failure example: The user not only entered the IP of the target, but also its netmask (THE IP IS ENOUGH).

When the system tries to deploy the software, it will notice that the IP format is not correct and will warn the user:

Depl err1.png

6.3 Import a list of your devices in CSV

A list of devices can be imported to represent them as agents using the agent import wizard through CSV.

Info.png

This feature only creates agents in Pandora FMS for its remote monitoring.

 



Hostdevices2.png

Select the separator used, the server on which you wish to import and the file that contains the data, then click on "next".

Hostdevices3.png

6.4 Custom NetScan

It allows the execution of custom scripts for the execution of network recognition tasks.

Create a recognition task specifying:

  • Task name: Name of the recognition task.
  • Comment: Allows adding comments.
  • Discovery server: Server that will execute the task.
  • Group: Group it belongs to.
  • Interval: Execution interval.

DISC NetScan Custom 1.JPG

Once the process of creating the task is complete, specify the script that you wish to run, as well as the configuration file necessary for its execution.

6.5 Net scan scripts

This section will show the different scripts that have been created for custom recognition tasks. A view is displayed where the name and description of the task are defined.

DISC Net scan scripts.JPG

Pandora FMS allows adding additional scripts to make monitoring and recognition of required networks easier.

The parameters that can be defined are the following:

  • Name: Script name.
  • Script fullpath: Path where the script is located.
  • Description: Script description. You can define descriptions of the different fields, as well as default values for them.
  • Hide value: In case you wish to hide the value of a field.
  • Help: Help fields.

DISC Net scan scripts 2.JPG

Creating scripts allows adding macros with which to define all the parameters needed for the correct execution of the script.