Difference between revisions of "Pandora: Documentation es: Plantillas y Componentes"

From Pandora FMS Wiki
Jump to: navigation, search
(Componentes de red)
 
(67 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
[[Pandora:Documentation|Volver a Indice de Documentacion Pandora FMS]]
 
[[Pandora:Documentation|Volver a Indice de Documentacion Pandora FMS]]
 +
  
 
=Plantillas y componentes=
 
=Plantillas y componentes=
Line 5: Line 6:
 
==Introducción==
 
==Introducción==
  
Pandora FMS realiza todas las comprobaciones a través de módulos. Estos pueden ser de diferentes tipos para los diferentes tipos de datos que Pandora FMS puede procesar. La lista completa de módulos predeterminados que contiene Pandora FMS se puede consultar en la sección ''Resources -> Module types'' :
+
Pandora FMS realiza todas las comprobaciones a través de módulos, permitiéndonos procesar diferentes tipos de datos en función del elemento a monitorizar. La lista completa de módulos predeterminados que contiene Pandora FMS se puede consultar en la sección ''Resources -> Module types'' :
  
<br><br>
 
 
<center>
 
<center>
 
[[image:julia1.png ]]  
 
[[image:julia1.png ]]  
 
</center>
 
</center>
<br><br>
+
<br>
  
 
Al pulsar sobre este menú, en la parte derecha de la consola web de Pandora FMS se mostrarán los módulos disponibles:
 
Al pulsar sobre este menú, en la parte derecha de la consola web de Pandora FMS se mostrarán los módulos disponibles:
  
<br><br>
 
 
<center>
 
<center>
 
[[image:julia3.png|800px]]
 
[[image:julia3.png|800px]]
 
</center>
 
</center>
<br><br>
+
<br>
 +
 
 +
En Pandora FMS existen diferentes tipos de módulos:
 +
 
 +
*'''async:''' datos asíncronos.
 +
*'''generic:''' datos genéricos.
 +
*'''keep_alive:''' módulo especial Keep Alive, sirve para controlar el estado del último contacto con un agente.
 +
*'''icmp:''' comprobación ICMP (ping).
 +
*'''snmp:''' comprobación SNMP.
 +
*'''tcp:''' comprobación TCP.
 +
*'''web:''' comprobación web.
 +
 
 +
Estos tipos de módulos pueden almacenar diferentes tipos de datos:
 +
 
 +
*'''data:''' datos numéricos.
 +
*'''proc:''' valor booleano, 1 es cierto y 0 falso; por ejemplo, para módulos web significa que si el valor existe devuelve 1 y 0 si no existe.
 +
*'''string:''' cadena de texto.
 +
*'''inc:''' datos incrementales (por ejemplo, el número de paquetes enviados por una interfaz siempre crecerá); muestran el incremento por unidad de tiempo.
 +
*'''inc_abs:''' datos incrementales absolutos; muestran el valor incrementado desde la última lectura.
  
Como se ve, existen diversos tipos y diversos grupos de módulos:
 
  
*'''async''': datos asíncronos.
+
=== ¿Qué es un componente? ===
*'''generic''': datos genéricos.
 
*'''keep_alive''': módulo especial keepalive, sirve para controlar el estado del último contacto con un agente.
 
*'''icmp''': comprobación ICMP (ping).
 
*'''snmp''': comprobación SNMP.
 
*'''tcp''': comprobación TCP.
 
*'''web''': comprobación web
 
  
La mayoría de ellos puede tener diversos tipos de comprobaciones:
+
Un componente es un "módulo genérico" que se puede aplicar repetidamente sobre un agente, como si fuera una "copia maestra" de un módulo, generando un modulo asociado a un agente. De esta forma, es muy sencillo monitorizar nuevos agentes teniendo una base de datos de los componentes que más utilizamos en nuestra organización, ya que dispondremos de nuestros propios componentes adaptados a las tecnologías que solemos utilizar, y simplemente aplicaremos estos componentes a los agentes nuevos.
  
*'''data''': datos numéricos.
+
Existen dos tipos de componentes: los <b>componentes de red</b>, que agrupan a todos los módulos de tipo remoto (wmi, tcp, snmp, icmp, plugin, web, etc.), y los <b>componentes locales</b>, que incluyen la definición de los módulos de agentes software, como  "trozos" de texto que se incorporarán al archivo de configuración del agente (con configuración remota habilitada) o se pueden cortar y pegar en la configuración de los agentes manualmente (sin configuración remota).
*'''proc''': valor booleano. Para las comprobaciones web significa que si el valor existe devuelve 1 y 0 de lo contrario.
 
*'''string''': cadena de texto.
 
*'''inc''': datos incrementales (por ejemplo, el número de paquetes enviados por una interfaz siempre crecerá).
 
  
=== ¿ Qué es un componente ? ===
+
<br>
  
Un componente es un "módulo genérico" que se puede aplicar repetidamente sobre un agente, como si fuera una "copia maestra" de un módulo, generando un modulo asociado a un agente. De esta forma, teniendo una base de datos de los componentes que más utilizamos en nuestra organiación, a la hora de monitorizar nuevos agentes es muy sencillo ya que disponemos de nuestros propios componentes adaptados a las tecnologías que solemos utilizar, y simplemente tenemos que aplicar estos componentes a los agentes nuevos.
+
=== ¿Qué es una plantilla de componentes? ===
  
Existen dos tipos de componentes, componentes de red, que agrupan a todos los módulos de tipo remoto (wmi, tcp, snmp, icmp, plugin, web, etc), y componentes locales, que son la definición de los módulos definidos en la configuración de los agentes software, definidos como "trozos" de texto que se pueden cortar y pegar en la configuración de los agentes.
+
En Pandora FMS se ofrece la posibilidad de agrupar los componentes de red en "plantillas", de tal manera que podamos aplicar múltiples componentes de red directamente sobre un agente.
 +
Esto facilita el despliegue de la monitorización, ya que creamos varios módulos de forma simultánea a través de los componentes  de red asociados a una plantilla.
  
=== ¿ Qué es una plantilla de componentes ? ===
+
El servidor Recon aplica los componentes de red asociados a una plantilla sobre los hosts detectados, agregando los módulos especificados de forma automática y permitiendo así un despliegue de la monitorización muy rápido y automático.
  
Una plantilla no es más que un conjunto de componentes de red que se puede aplicar directamente sobre un agente, facilitando la labor de monitorización, ya que creamos varios módulos de forma simultánea a través de los componentes asociados a una plantilla de red. El servidor Recon utiliza las plantillas de red para crear sobre un host detectado una serie de módulos de forma automática, permitiendo así un despliegue de la monitorización muy rápido y automático.
+
<br>
  
 
== Componentes de red ==  
 
== Componentes de red ==  
  
Como decíamos antes, los componentes de red son los elementos que permiten hacer comprobaciones remotas de red. Pandora FMS tiene alrededor de 40 comprobaciones de red predeterminadas, mientras que la versión Enterprise cuenta con más de 400.
+
Como hemos visto en los puntos precedentes, los componentes de red son los elementos que permiten hacer comprobaciones remotas a través de la red. Pandora FMS tiene alrededor de 40 comprobaciones de red predeterminadas, mientras que la versión Enterprise cuenta con más de 400.
  
Los componentes de red de Pandora FMS se pueden consultar y crear desde la página de gestión de los mismos, en ''Configuration -> Network components''.
+
Los componentes de red de Pandora FMS se pueden consultar y crear desde la página de gestión de los mismos, en ''Configuration > Network components''.
  
<br><br>
 
 
<center>
 
<center>
 
[[image:lulu.png]]  
 
[[image:lulu.png]]  
Line 60: Line 67:
 
<br><br>
 
<br><br>
  
En ella podrá buscar los componentes ya existentes (filtrando por grupos o por texto de búsqueda libre), ver su configuración y detalles, modificarlos e incluso crear nuevos.
+
En ella podrá buscar los componentes ya existentes (filtrando por grupos o por texto de búsqueda libre), ver su configuración en detalles, modificarlos o crear nuevos componentes.
  
Para ver las propiedades de un módulo cualquiera, simplemente pulse sobre su nombre, éste tiene un enlace que le llevará a su página de detalles:
+
Para ver las propiedades de un módulo cualquiera, haga click sobre su nombre; le llevará a la página de edición:
  
<br><br>
 
 
<center>
 
<center>
 
 
[[image:nc_form2.png|center|850px]]
 
[[image:nc_form2.png|center|850px]]
 
 
</center>
 
</center>
 
<br><br>
 
<br><br>
  
Como se puede ver en la imagen, se ven todos los detalles del componente de red Host Alive. Cuando se aplica a un módulo, éste obtendrá los detalles del componente de red, excepto el campo de dirección IP, donde automáticamente escribirá la direccion IP principal del agente al que se aplica el componente. Todos los parámetros pueden ser posteriormente editados (p.e: cambiar el usuario/password de los modulos WMI).
+
Como se puede ver en la imagen, se ven todos los detalles del componente de red Host Alive.
 +
 
 +
Cuando se aplique a un módulo, este obtendrá los detalles del componente de red, excepto el campo de dirección IP, donde se ajustará automáticamente la dirección IP principal del agente al que se aplica el componente. Todos los parámetros pueden ser posteriormente editados (por ejemplo: cambiar el usuario/password de los modulos WMI).
  
 
Si se modifica la plantilla, '''sus valores se aplicarán a los módulos que se creen desde ese instante, no a los ya creados'''.
 
Si se modifica la plantilla, '''sus valores se aplicarán a los módulos que se creen desde ese instante, no a los ya creados'''.
  
Puede modificar los valores de los componentes, simplemente pulse sobre el nombre de uno de los ellos y modifique los valores que desee, por ejemplo el intervalo. Una vez hecho esto pulse el botón Update al final de la página. Sus cambios se guardarán y se aplicarán a partir de ese momento a los agentes a los que añada dicho módulo.
+
Para modificar los valores de los componentes, haga click sobre el nombre de uno de ellos y realice las modificaciones que desee en la página de edición, por ejemplo el intervalo. Una vez actualizado, pulse el botón Update al final de la página para guardar los cambios. A partir de ese momento la nueva configuración del componente se aplicará a los agentes a los que añada dicho módulo.
 +
 
 +
<br>
  
 
=== Crear componentes de red nuevos ===
 
=== Crear componentes de red nuevos ===
Line 86: Line 94:
 
* WMI.
 
* WMI.
  
En esta versión todavía no puede crear componentes de tipo WEB.
 
  
Para crear un componente de red nuevo, vaya a la página principal de administración de componentes de red, ''Administration -> Manage modules -> Network components'', vaya a la parte inferior de la página, en el menú desplegable seleccione un componente de red de los tres posibles (WMI, Red o Plugin): y pulse el botón ''Create''.
+
Para crear un componente de red, vaya a la página principal de administración de componentes de red, ''Administration > Manage modules -> Network components'', y en la parte inferior de la página, en el menú desplegable seleccione un componente de red de los tres posibles (WMI, Red o Plugin) y pulse el botón ''Create''.
  
<br><br>
 
 
<center>
 
<center>
 
[[image:luli.png|luli.png]]
 
[[image:luli.png|luli.png]]
Line 96: Line 102:
 
<br><br>
 
<br><br>
  
Después se le presentará una pantalla para que pueda configurar todos los campos del componente. Rellene los necesarios y pulse el botón ''Create''. A continuación se presenta la pantalla de creación de componente WMI:
+
Después configure todos los campos del componente y pulse el botón ''Create''. Esta es la pantalla de creación de componente WMI:
  
<br><br>
 
 
<center>
 
<center>
 
[[image:loli.png|800px]]  
 
[[image:loli.png|800px]]  
Line 104: Line 109:
 
<br><br>
 
<br><br>
  
A la hora de completar los campos que se le pide, considere que está completando la descripción de un módulo "genérico" que se aplicará sobre diferentes agentes. Algunos parámetros como snmp community, usuario o password pueden ser diferentes segun los agentes a los que le aplique el modulo y necesitará modificarlos manualmente para que operen, pero si dispone de una política de usuarios comunes para sus sistemas, puede aprovecharlo para dejar configurado completamente los modulos introduciendo aqui los usuarios, passwords y otros datos que sean comunes para todos los agentes, obviamente también puede dejarlos en blanco.
+
A la hora de completar los campos que se pide, tenga en cuenta que está completando la descripción de un módulo "genérico" que se aplicará sobre diferentes agentes.  
 +
Algunos parámetros, como snmp community, usuario o password pueden ser diferentes según los agentes a los que le aplique el módulo posteriormente, por lo que puede dejarlos en blanco.
 +
Si dispone de una política de usuarios comunes para sus sistemas, puede dejar configurados por completo los módulos introduciendo aquí los usuarios, passwords y otros datos que sean comunes para todos los agentes.
  
<br><br>
 
 
<center>
 
<center>
 
[[image:nomo.png|800px]]  
 
[[image:nomo.png|800px]]  
Line 116: Line 122:
 
En este caso, al igual que cuando creamos un módulo de tipo plugin, al seleccionar el plugin en la interfaz aparecerán los campos definidos en las macros del plugin.
 
En este caso, al igual que cuando creamos un módulo de tipo plugin, al seleccionar el plugin en la interfaz aparecerán los campos definidos en las macros del plugin.
  
<br><br>
 
 
<center>
 
<center>
 
[[image:trio.png|800px]]  
 
[[image:trio.png|800px]]  
Line 124: Line 129:
 
==Componentes locales==
 
==Componentes locales==
  
Los componentes locales hacen referencia a los componentes que se pueden aplicar a los agentes software. Si se dispone de la versión Enterprise de Pandora FMS, estos componentes se pueden aplicar de forma automática y remota a través de las políticas o de forma manual (uno a uno) en el editor de configuración remota del agente. Consulte la sección de políticas para saber cómo aplicar componentes locales a agentes software de forma remota en su Pandora FMS Enterprise.
+
Los componentes locales hacen referencia a los componentes que se pueden aplicar a los agentes software. Si se dispone de la versión Enterprise de Pandora FMS, estos componentes se pueden aplicar de forma automática a todos nuestros agentes a través de las políticas o de forma manual (uno a uno) en el editor de configuración remota del agente. Consulte la sección de políticas para saber cómo aplicar componentes locales a agentes software de forma remota en su Pandora FMS Enterprise.
  
Los componentes locales también se pueden usar en la versión Open de Pandora FMS, sólo que no se aplicarán de forma automática, sino que se deberá copiar el código y pegarlo directamente. La versión Enterprise de Pandora FMS dispone de decenas de módulos locales para aplicar a las políticas y a los agentes de forma automática, ordenados por categorías.
+
Los componentes locales también se pueden usar en la versión Open de Pandora FMS, solo que no se aplicarán de forma automática a través de Pandora FMS, sino que deberá acceder al agente directamente e introducir los cambios en el archivo de configuración. La versión Enterprise de Pandora FMS dispone de decenas de módulos locales para aplicar a las políticas y a los agentes de forma automática, ordenados por categorías.
  
Los componentes locales funcionan de forma muy parecida a los componentes de red, una vez que se va a su página de gestión, ''Administration -> Manage modules -> Local components'':
+
Los componentes locales funcionan de forma muy parecida a los componentes de red, una vez que se va a su página de gestión, ''Configuration -> Local Components'':
  
<br><br>
 
 
<center>
 
<center>
 
[[image:hue.png]]
 
[[image:hue.png]]
 
</center>
 
</center>
<br><br>
+
<br>
  
 
Esta pantalla muestra los módulos locales ya existentes, que se pueden filtrar por diversos parámetros (grupo, sistema operativo, consulta de texto libre) y también se puede ver, modificar y crear nuevos componentes.
 
Esta pantalla muestra los módulos locales ya existentes, que se pueden filtrar por diversos parámetros (grupo, sistema operativo, consulta de texto libre) y también se puede ver, modificar y crear nuevos componentes.
  
Para ver las propiedades de un módulo cualquiera, simplemente pulse sobre su nombre, éste tiene un enlace que le llevará a su página de detalles:
+
Para ver las propiedades de un módulo cualquiera, simplemente pulse sobre su nombre; este tiene un enlace que le llevará a su página de detalles:
  
<br><br>
 
 
<center>
 
<center>
 
 
[[image:local_component_form3.png|center|800px]]
 
[[image:local_component_form3.png|center|800px]]
 
 
</center>
 
</center>
<br><br>
+
<br>
 
 
 
Como se ve, la configuración de los componentes locales es muy sencilla. Los elementos de configuración son:
 
Como se ve, la configuración de los componentes locales es muy sencilla. Los elementos de configuración son:
  
*'''Name''': nombre del componente. Este nombre será el visible a la hora de seleccionar el componente al crear un módulo para un agente.
+
*'''Name''': Nombre del componente. Este nombre será el visible a la hora de seleccionar el componente al crear un módulo para un agente.
*'''OS''': sistema operativo para el que es el componente.
+
*'''OS''': Sistema operativo para el que es el componente.
*'''Group''': el grupo en el que estará el módulo. Útil para filtrar y ordenar por tecnologías de monitorización.
+
*'''Group''': El grupo en el que estará el módulo. Útil para filtrar y ordenar por tecnologías de monitorización.
*'''Description''': descripción del módulo. De forma predeterminada ya existe una descripción, que se puede cambiar.
+
*'''Description''': Descripción del módulo. De forma predeterminada ya existe una descripción, que se puede cambiar.
*'''Configuration''': configuración del componente, igual a la configuración de los módulos para los agentes software. Para ver más ejemplos u obtener información complementaria consulte la sección [[Pandora:Documentation_es:Configuracion#Definici.C3.B3n_de_los_m.C3.B3dulos|'''''Definición de los módulos''''']] en el capítulo de '''''Configuración'''''.
+
*'''Configuration''': Configuración del componente, igual a la configuración de los módulos para los agentes software. Para ver más ejemplos u obtener información complementaria consulte la sección [[Pandora:Documentation_es:Configuracion#Definici.C3.B3n_de_los_m.C3.B3dulos|'''''Definición de los módulos''''']] en el capítulo de '''''Configuración'''''.
*'''Warning status''': Intervalo en el cuál se toma el estado warning. Si está marcada la casilla 'inverse interval', entonces se cambiará a estado warning cuando no se encuentre dentro del intervalo definido.
+
*'''Warning status''': Intervalo en el cual se toma el estado warning. Si está marcada la casilla 'inverse interval', entonces se cambiará a estado warning cuando no se encuentre dentro del intervalo definido.
*'''Critical status''': Intervalo en el cuál se toma el estado crítico. Si está marcada la casilla 'inverse interval', entonces se cambiará a estado crítico cuando no se encuentre dentro del intervalo definido.
+
*'''Critical status''': Intervalo en el cual se toma el estado crítico. Si está marcada la casilla 'inverse interval', entonces se cambiará a estado crítico cuando no se encuentre dentro del intervalo definido.
 
*'''Warning instructions''': Instrucciones a seguir cuando el estado es warning.
 
*'''Warning instructions''': Instrucciones a seguir cuando el estado es warning.
 
*'''Critical instructions''': Instrucciones a seguir cuando el estado es crítico.
 
*'''Critical instructions''': Instrucciones a seguir cuando el estado es crítico.
Line 166: Line 166:
 
===Crear componentes locales nuevos===
 
===Crear componentes locales nuevos===
  
Para crear un componente local nuevo, vaya a la página principal de administración de componentes de locales, ''Administration -> Manage modules -> Local components'' y pulse el botón''Create'' en la parte inferior derecha de la página.
+
Para crear un componente local nuevo, vaya a la página principal de administración de componentes locales, ''Configuration > Local components'' y pulse el botón''Create'' en la parte inferior derecha de la página.
  
 
Aparecerá la página con el formulario de creación del componente local nuevo:
 
Aparecerá la página con el formulario de creación del componente local nuevo:
  
<br><br>
 
 
<center>
 
<center>
 +
[[image:local_component_form3.png|center|800px]]
 +
</center>
 +
<br>
  
 +
Rellene el formulario con la información antes mencionada y pulse el botón "Create".
  
[[image:local_component_form3.png|center|800px]]
 
  
</center>
+
<br>
<br><br>
 
 
 
Simplemente se habrá de rellenar el formulario con la información antes mencionada y pulsar el botón Create.
 
  
 
=== Macros de ejecución local ===
 
=== Macros de ejecución local ===
Line 187: Line 186:
 
Las macros aparecerán en el formulario de edición de módulos como campos normales, de forma transparente al usuario.
 
Las macros aparecerán en el formulario de edición de módulos como campos normales, de forma transparente al usuario.
  
<br>
+
Cada macro tendrá tres campos: Description, Default value y Help.
<br>
+
 
 +
* '''Description''': Será la etiqueta junto al campo en el formulario del módulo.
 +
* '''Default value''': Valor optativo para cargar por defecto en el campo del formulario de módulo.
 +
* '''Help''': Cadena optativa para añadir información adicional al campo. Si es definida, aparecerá un tip junto al campo con esta cadena.
 +
 
 
<center>
 
<center>
 
[[image:local_components_macros.png|800px]]
 
[[image:local_components_macros.png|800px]]
 
</center>
 
</center>
 
<br>
 
<br>
<br>
 
 
Cada macro tendrá tres campos: Description, Default value and Help.
 
  
* Description: Será la etiqueta junto al campo en el formulario del módulo.
+
Si un componente de módulo tiene macros, los datos de configuración estarán ocultos por defecto para simplificar la vista:
* Default value: Valor optativo para cargar por defecto en el campo del formulario de módulo.
 
* Help: Cadena optativa para añadir información adicional al campo. Si es definida, aparecerá un tip junto al campo con esta cadena.
 
  
<br>
 
<br>
 
 
<center>
 
<center>
[[image:local_components_macros_editor_hidden.png|750px]]
+
[[image:Local_components_macros_editor_hidden.png|800px]]
 
</center>
 
</center>
<br>
 
 
<br>
 
<br>
  
Si un componente de módulo tiene macros, los datos de configuración estarán ocultos por defecto para simplificar la vista, pero será posible mostrarlos y modificarlos.
+
Pero será posible mostrarlos y modificarlos.
  
<br>
 
<br>
 
 
<center>
 
<center>
[[image:local_components_macros_editor_showed.png|750px]]
+
[[image:local_components_macros_editor_showed.png|800px]]
 
</center>
 
</center>
<br>
 
 
<br>
 
<br>
  
 
==Plantillas de módulos==
 
==Plantillas de módulos==
  
Las plantillas de módulos son plantillas que contienen módulos de comprobaciones de red. Estas plantillas, una vez creadas, se pueden aplicar directamente a agentes, evitando tener que añadir los módulos de uno en uno, o bien aplicar las plantillas al realizar una tarea de reconocimiento de red, descritas en el capítulo 9.
+
Las plantillas de módulos son plantillas que contienen módulos de comprobaciones de red. Estas plantillas, una vez creadas, se pueden aplicar directamente a agentes, evitando tener que añadir los módulos de uno en uno, o bien aplicar las plantillas al realizar una [https://pandorafms.com/docs/index.php?title=Pandora:Documentation_es:Discovery tarea de reconocimiento de red].  
  
Para gestionar las plantillas de módulos, pulse en Administration -> Manage modules -> Module templates.
+
Para gestionar las plantillas de módulos, pulse en "Configuration > Module templates".
  
<br><br>
 
 
<center>
 
<center>
 
[[image:feisimo.png]]
 
[[image:feisimo.png]]
 
</center>
 
</center>
<br><br>
+
<br>
  
 
Se mostrará la pantalla de gestión de plantillas, que ya tiene varias de forma predeterminada.
 
Se mostrará la pantalla de gestión de plantillas, que ya tiene varias de forma predeterminada.
  
<br><br>
 
 
<center>
 
<center>
 
[[image:horro.png|850px]]
 
[[image:horro.png|850px]]
 
</center>
 
</center>
<br><br>
+
<br>
  
Puede pulsar sobre cualquiera de las plantillas para ver sus detalles, o puede pulsar sobre el icono papelera en la columna de la derecha para borrarla, o bien puede crear una plantilla nueva pulsando el botón Create.
+
Puede pulsar sobre cualquiera de las plantillas para ver sus detalles, sobre el icono papelera en la columna de la derecha para borrarla, o el botón "Create" para crear una plantilla nueva.
  
Pulsando sobre el nombre de una plantilla se verán sus detalles, por ejemplo, la captura inferior muestra los detalles para la plantilla de módulos de monitorización de básica (''Basic Monitoring'').
+
Pulsando sobre el nombre de una plantilla se verán sus detalles; por ejemplo, la captura inferior muestra los detalles para la plantilla de módulos de monitorización básica (''Basic Monitoring'').
  
 
En ella se puede ver el nombre y la descripción de la plantilla en los dos primeros campos del formulario.
 
En ella se puede ver el nombre y la descripción de la plantilla en los dos primeros campos del formulario.
Line 247: Line 237:
 
Más abajo está la lista de módulos incluidos en esta plantilla.
 
Más abajo está la lista de módulos incluidos en esta plantilla.
  
Por último está el formulario de adición de módulos, pudiendo filtrar por grupo de módulos, para después seleccionar el módulo y añadirlo.
+
Por último está el formulario de edición de módulos, pudiendo filtrar por grupo de módulos, para después seleccionar el módulo y añadirlo.
  
<br><br>
 
 
<center>
 
<center>
 
[[image:pla1.png|center|850px]]
 
[[image:pla1.png|center|850px]]
Line 255: Line 244:
 
[[image:module_template_edit3.png|center|850px]]
 
[[image:module_template_edit3.png|center|850px]]
 
</center>
 
</center>
<br><br>
+
<br>
  
Para borrar un módulo, simplemente selecciónelo en la columna de la derecha (si selecciona la casilla superior de la derecha seleccionará todos) y pulse el botón Delete.
+
Para borrar un módulo, simplemente seleccione en la columna de la derecha (seleccionando la casilla superior de la derecha seleccionará todos) y pulse el botón "Delete".
  
<br><br>
 
 
<center>
 
<center>
 
[[image:pla2.png|800px]]
 
[[image:pla2.png|800px]]
 
</center>
 
</center>
<br><br>
+
<br>
  
 
===Crear plantillas de módulos nuevas===
 
===Crear plantillas de módulos nuevas===
  
Para crear una plantilla de módulos nueva, vaya a la página principal de gestión de plantillas de componentes, Administration -> Manage modules -> Module templates y pulse el botón Create en la parte inferior derecha de la página.
+
Para crear una plantilla de módulos nueva, vaya a la página principal de gestión de plantillas de componentes, "Configuration > Module templates" y pulse el botón "Create" en la parte inferior derecha de la página.
  
 
Aparecerá la página con el formulario de creación del componente local nuevo:
 
Aparecerá la página con el formulario de creación del componente local nuevo:
  
<br><br>
 
 
<center>
 
<center>
 
[[image:pla3.png|800px]]
 
[[image:pla3.png|800px]]
 
</center>
 
</center>
<br><br>
+
<br>
  
Introduzca un nombre y una descripción para la plantilla nueva y pulse el botón Create.
+
Introduzca un nombre y una descripción para la plantilla nueva y pulse el botón "Create".
  
A continuación se mostrará la página donde podrá añadir módulos a la plantilla:
+
A continuación puede añadir módulos a la plantilla:
  
<br><br>
 
 
<center>
 
<center>
 
[[image:pla4.png|800px]]
 
[[image:pla4.png|800px]]
 
</center>
 
</center>
<br><br>
+
<br>
  
Seleccione los módulos en la parte de abajo, filtrando por grupo si es necesario, y pulse el botón Add.
+
Seleccione los módulos en la parte de abajo, filtrando por grupo si es necesario, y pulse el botón "Add".
  
Recuerde que puede borrar los módulos que no quiera seleccionándolos y pulsando el botón Delete.
+
Recuerde que puede borrar los módulos que no quiera seleccionando y pulsando el botón "Delete".
  
 
===Aplicar una plantilla de módulos a un agente===
 
===Aplicar una plantilla de módulos a un agente===
  
Para aplicar una de las plantillas de módulos de monitorización ya existentes o una creada, se debe ir a la configuración de un agente en Administration -> Views -> Agent Detail:
+
Para aplicar una de las plantillas de módulos de monitorización ya existentes, o una creada, se debe ir a la configuración de un agente en ''Monitoring > Views > Agent Detail'':
  
<br><br>
 
 
<center>
 
<center>
 
[[image:pla5.png]]
 
[[image:pla5.png]]
 
</center>
 
</center>
<br><br>
+
<br>
  
Y seleccionar los módulos de uno de los agentes:
+
Seleccione los módulos de uno de los agentes:
  
<br><br>
 
 
<center>
 
<center>
 
[[image:pla6.png|800px]]
 
[[image:pla6.png|800px]]
 
</center>
 
</center>
<br><br>
+
<br>
  
 
Una vez en esta pantalla, se deberá pulsar sobre la solapa de las plantillas, Templates, en la parte superior de la página.
 
Una vez en esta pantalla, se deberá pulsar sobre la solapa de las plantillas, Templates, en la parte superior de la página.
  
<br><br>
+
 
 
<center>
 
<center>
 
[[image:pla7.png]]
 
[[image:pla7.png]]
 
</center>
 
</center>
<br><br>
+
<br>
  
 
En la siguiente pantalla se muestran los módulos que ya tiene el agente y las plantillas de módulos existentes, para poder seleccionar una y aplicarla al agente:
 
En la siguiente pantalla se muestran los módulos que ya tiene el agente y las plantillas de módulos existentes, para poder seleccionar una y aplicarla al agente:
  
<br><br>
+
 
 
<center>
 
<center>
 
[[image:pla8.png|800px]]
 
[[image:pla8.png|800px]]
 
</center>
 
</center>
<br><br>
+
<br>
 +
 
 +
Seleccione una plantilla y pulse el botón "Assign"; automáticamente se añadirán los módulos que contenga esa plantilla. Una vez aplicada la plantilla, puede borrar algunos de los módulos pulsando sobre la "X" en la columna de la derecha, o puede editarlos pulsando sobre el icono de herramienta.
 +
 
 +
 
 +
{{warning|No se muestran las plantillas que se han aplicado sobre el agente, solo los módulos que estas contienen}}
 +
 
 +
==Private Enterprise Number==
 +
 
 +
Todos los dispositivos SNMP cuentan con una cadena identificativa (OID), que es única para cada marca y modelo de un dispositivo. Dentro de esas cadenas tenemos un número que se encuentra en la séptima posición y que es el que determina a que fabricante pertenece el dispositivo.
 +
Este número es el Private Enterprise Number (PEN) de un fabricante y se encuentra registrado en la IANA. Se pueden configurar estos PEN en Pandora para utilizarlos junto con las plantillas de módulos y agregar así monitorización de forma dinámica.
 +
 
 +
<center>
 +
[[File:Image.png|800]]
 +
</center>
 +
 
 +
Dentro de esta vista, sólo será necesario insertar el PEN correspondiente del fabricante, indicar su nombre y una descripción. De esta manera se agregará al listado ya existente.
 +
 
 +
<center>
 +
[[File:EKFvXpk3vM.png|800]]
 +
</center>
 +
 
 +
<center>
 +
[[File:4G3Axk5uif.png|800]]
 +
</center>
 +
 
 +
En las plantillas de módulos se indicarán uno o varios PEN de manera que cuando se lleve a cabo una tarea de descubrimiento, Pandora sea capaz de obtener el fabricante del dispositivo y agregarle la monitorización adecuada.
 +
 +
<center>
 +
[[File:XLr0js1dZX.png|800]]
 +
</center>
 +
 
 +
==Componentes de Wizard==
 +
 
 +
Dentro de las capacidades del wizard SNMP y el wizard WMI, encontramos un tipo de componentes remotos llamados ''Componentes de wizard''.
 +
 
 +
Estos componentes permiten establecer una configuración base para los módulos que serán generados en los agentes al ejecutar cualquiera de los wizard (SNMP o WMI). Además nos ofrecerá la posibilidad de que con un solo componente se puedan generar varios módulos de forma dinámica. Por ejemplo, un componente para escanear las distintas unidades de almacenamiento de un dispositivo o los procesos en ejecución.
 +
 
 +
Se pueden crear estos componentes desde el menú ''Configuration'' > ''Templates'' > ''Remote components'', con la opción ''Create a new wizard component''.
 +
 
 +
<center>
 +
[[image:IMG1_wizard_components.png]]
 +
</center>
 +
 
 +
En el formulario de creación se verán una serie de campos comunes para ambos wizard y otros específicos dependiendo del protocolo seleccionado.
 +
 
 +
Los campos comunes que podemos encontrar son:
 +
* '''Enabled''': Al activar este token, estaremos indicando que el componente se intentará escanear al lanzar el wizard.
 +
* '''Add by default''': Permite elegir si los módulos generados por el componente estarán marcados para agregarse por defecto al lanzar el wizard. Es decir, si se activa el token, los módulos generados por el componente estarán marcados por defecto en una vista que encontraremos más adelante y se añadirán al agente. Esta acción no implica que no se pueda modificar, ya que en esa vista podremos hacer modificaciones y desmarcar o marcar a voluntad y cambiar umbrales, descripciones, etc.
 +
* '''Module name''': Nombre que tendrá el componente, y nombre por defecto para los módulos generados por el mismo. Se podrá hacer uso de algunas macros (se irán mostrando más adelante).
 +
* '''Module protocol''': Permite indicar el wizard (SNMP o WMI) para el que se configura el componente. Según el protocolo seleccionado, el formulario muestra los campos específicos para cada wizard, los cuales se explican más adelante.
 +
* '''Component group''': Grupo al que pertenecerá el componente. Nos permite organizar la forma en que se presentarán los módulos.
 +
* '''Module type''': En este desplegable podemos escoger el tipo de dato que obtendrán los módulos generados por el componente.
 +
* '''Module unit''': Unidad de los datos obtenidos por los módulos generados por el componente. Es un campo totalmente editable, por lo que podremos agregar la medida que se necesite.
 +
* '''Warning status''': En esta sección podremos establecer un umbral por defecto para el estado warning de los módulos generados por el wizard. A pesar de indicar aquí un rango, habrá posibilidad de personalizarlo para cada módulo en la vista final que recoge todos los módulos encontrados.
 +
* '''Critical status''': En esta sección podremos establecer un umbral por defecto para el estado critical de los módulos generados por el wizard. A pesar de indicar aquí un rango, habrá posibilidad de personalizarlo para cada módulo en la vista final que recoge todos los módulos encontrados.
 +
* '''Description''': Se trata de una descripción que tendrá el componente y a su vez, los módulos generados por el mismo. Se podrá hacer uso de algunas macros. (Se irán mostrando más adelante).
 +
* '''Scan type''': Nos permite elegir entre dos modalidades de escaneo que podrán realizar los wizards con este componente. Este campo determina si un componente generará un solo módulo o varios. El valor seleccionado afectará a como se deben rellenar otros campos específicos de cada wizard.
 +
** '''Fixed''': El componente solo generará un módulo. Por ejemplo, obtener el uptime del dispositivo por SNMP.
 +
** '''Dynamic''': El componente podrá generar uno o más módulos. Por ejemplo, obtener el porcentaje de uso de las unidades de disco por WMI.
 +
* '''Execution type''': Con este campo indicamos el tipo de ejecución para los módulos generados por el componente. Sirve para determinar el servidor de Pandora al que pertenecerán los módulos en el momento de su creación dependiendo desde donde se lance el wizard.
 +
** '''Network''': Los módulos generados por el componente obtendrán sus datos con los mecanismos propios de Pandora para módulos SNMP y WMI. Estos son, los servidores de red, WMI y satélite.
 +
** '''Plugin''': Los módulos generados por el componente obtendrán sus datos de la ejecución de comandos, plugins o scripts personalizados. De esta manera, serán ejecutados por el servidor de plugins o por el satélite mediante módulos de tipo ''exec''.
 +
 
 +
<center>
 +
[[image:IMG2_wizard_components.png]]
 +
</center>
 +
 
 +
Los campos específicos para componentes del wizard SNMP son:
 +
 
 +
* '''Name OID''': Permite indicar un OID del cual se obtendrá un valor que podrá ser añadido al nombre del módulo mediante una macro.
 +
 
 +
Resulta especialmente útil cuando se obtienen múltiples módulos generados por un componente dinámico. De esta manera conseguimos que tengan nombres distintos por defecto. Pero no se limita a los componentes dinámicos, ya que se puede utilizar también para los componentes de escaneo fijo.
 +
 
 +
El valor de este OID es almacenado en la macro _nameOID_, que puede ser usada en el campo '''Module name'''.
 +
 
 +
Si se utiliza en componentes dinámicos, el OID indicado en este campo debe ser una rama de SNMP y no un OID final. Por ejemplo, si se indica el OID ''.1.3.6.1.4.1.2021.10.1.2'', los valores que tendrá la macro en cada módulo se obtendrán de los OIDs ''.1.3.6.1.4.1.2021.10.1.2.'''x''''', donde '''x''' representa cada una de las terminaciones que puede tener la rama.
 +
 
 +
Si se utiliza en componentes fijos, el OID indicado en este campo debe ser un OID final. Por ejemplo, si se indica el OID ''.1.3.6.1.2.1.1.5.0'', el valor que tendrá la macro en el módulo se obtendrá directamente de ese OID.
 +
 
 +
* '''Manufacturer ID''': Permite indicar el ID de un fabricante específico para el cual el componente del wizard SNMP tendrá efecto.
 +
 
 +
De esta manera, para todos los dispositivos contra los que se lance el wizard, y cuyo Private Enterprise Number (PEN) esté registrado en Pandora para el ID del fabricante asignado al componente, se intentarán obtener los módulos generados por el mismo. Por ejemplo, un componente asignado a ''general_snmp'', se escaneará para todos los dispositivos con los PEN 2021 y 8072.
 +
 
 +
Si se indica como fabricante ''All'', el componente se escaneará para cualquier PEN registrado en Pandora.
 +
 
 +
{{warning|Debe estar registrado el Private Enterprise Number (PEN) en la consola de Pandora FMS para el uso de '''Manufacturer ID'''}}
 +
 
 +
Cuando el tipo de ejecución sea '''Network''':
 +
 
 +
* '''Value OID''': Nos permite indicar el OID a partir del cual se obtendrán los datos de los módulos generados por el componente.
 +
 
 +
Si se utiliza en componentes dinámicos, el OID indicado en este campo debe ser una rama de SNMP y no un OID final. Por ejemplo, si se indica el OID ''.1.3.6.1.4.1.2021.10.1.3'', los valores que tendrán los módulos se obtendrán de los OIDs ''.1.3.6.1.4.1.2021.10.1.3.'''x'''''. Además, el nodo ''X'' de cada OID debe tener el mismo valor para el nodo ''X'' del campo ''Name OID'' en el caso de utilizarse.
 +
 
 +
Si se utiliza en componentes fijos, el OID indicado en este campo debe ser un OID final. Por ejemplo, si se indica el OID ''.1.3.6.1.4.1.2021.11.9.0'', el valor que tendrá el módulo se obtendrá directamente de ese OID.
 +
 
 +
<center>
 +
[[image:IMG3_wizard_components.png]]
 +
</center>
 +
 
 +
Cuando el tipo de ejecución sea '''Plugin''':
 +
 
 +
* '''Macros OID''' → ''_oid_N_'': El propósito principal de utilizar componentes de tipo plugin es poder realizar operaciones con los valores de uno o más OIDs en el mismo dispositivo, como por ejemplo obtener el porcentaje de memoria usada a partir de los bytes de memoria usada y los bytes totales de memoria disponibles.
 +
 
 +
Es por ello que en estos componentes podemos indicar tantos OIDs como necesitemos para utilizarlos en otros campos.
 +
 
 +
Además, estos OIDs, o sus valores, se podrán utilizar a partir de las macros ''_oid_N_''. Dependiendo de en cuál de los campos siguientes se utilice la macro, se usará el valor del OID o el OID en sí mismo.
 +
 
 +
Si se utilizan en componentes dinámicos, los OIDs indicados en estos campos deben ser una rama de SNMP y no un OID final. Por ejemplo, si se indica el OID ''.1.3.6.1.4.1.3375.2.1.7.4.2.1.3'', los valores que tendrán los módulos se obtendrán de los OIDs ''.1.3.6.1.4.1.3375.2.1.7.4.2.1.3.'''x'''''. Además el nodo ''X'' de cada OID debe tener el mismo valor para el nodo ''X'' del resto de OIDs usados y del campo ''Name OID'' en el caso de utilizarse.
 +
 
 +
Si se utiliza en componentes fijos, los OIDs indicados en estos campos deben ser un OID final. Por ejemplo, si se indica el OID ''.1.3.6.1.4.1.2021.4.6.0'', el valor que tendrá el módulo se obtendrá directamente de ese OID.
 +
 
 +
 
 +
* '''Value operation''': Nos permite indicar una operación aritmética con la cual se obtendrá el valor actual de cada módulo generado por el componente en la vista previa de los módulos del wizard. En ningún caso afecta para la ejecución definitiva de los módulos generados.
 +
 
 +
Acepta los caracteres + - * / ( ) . números y las macros ''_oid_N_'' de las cuales se obtendrán los valores para la operación. Por ejemplo:
 +
 
 +
      ''(_oid_1_ * 100) / _oid_2_''
 +
 
 +
* '''Satellite execution''': Nos ofrece la posibilidad de indicar la ejecución que deba realizar un Servidor Satélite para los módulos generados cuando el wizard se lance desde un Servidor Satélite mediante el uso del ''exec server''. Se trata del comando, plugin o script que se deba usar en un ''module_exec'' de servidor satélite.
 +
 
 +
Acepta el uso de las macros para el wizard SNMP (se detallarán más adelante) y de las macros ''_oid_N_'' para obtener los OIDs usados en cada módulo.
 +
 
 +
El Servidor Satélite distribuye una serie de plugins recomendados para estos componentes:
 +
      - /etc/pandora/satellite_plugins/wizard_snmp_module
 +
      - /etc/pandora/satellite_plugins/wizard_snmp_process
 +
 
 +
* '''Server plugin''': Mediante este desplegable se podrá indicar un plugin registrado previamente en la consola de Pandora FMS, el cual será utilizado por el servidor de plugins con cada módulo generado por el componente. La elección de un plugin nos muestra a su vez en el formulario los campos específicos para la utilización del mismo.
 +
 
 +
Los campos propios del plugin aceptan el uso de las macros para el wizard SNMP y de las macros ''_oid_N_'' para obtener los OIDs usados en cada módulo.
 +
 
 +
La consola de Pandora FMS cuenta con una serie de plugins ya registrados recomendados para estos componentes:
 +
      - Wizard SNMP module.
 +
      - Wizard SNMP process.
 +
 
 +
 
 +
<center>
 +
[[image:IMG4_wizard_components.png]]
 +
</center>
 +
 
 +
Las macros específicas para los componentes del wizard SNMP que se pueden usar en los campos de ejecuciones de tipo plugin son:
 +
** '''''_address_''''': Dirección IP usada en el wizard SNMP. No se sustituirá esta macro cuando el wizard se lance en una política.
 +
** '''''_port_''''': Puerto usado en el wizard SNMP.
 +
** '''''_version_''''': Versión de SNMP usada en el wizard SNMP. Puede tener los valores 1, 2c o 3.
 +
** '''''_community_''''': Comunidad SNMP usada en el wizard SNMP.
 +
** '''''_sec_level_''''': Nivel de seguridad de SNMPv3 usado en el wizard SNMP. Puede tener los valores noAuthNoPriv, authNoPriv o authPriv
 +
** '''''_auth_user_''''': Usuario de SNMPv3 usado en el wizard SNMP.
 +
** '''''_auth_method_''''': Método de autenticación de SNMPv3 usado en el wizard SNMP. Puede tener los valores MD5 o SHA.
 +
** '''''_auth_pass_''''': Contraseña de autenticación de SNMPv3 usada en el wizard SNMP.
 +
** '''''_priv_method_''''': Método de privacidad de SNMPv3 usado en el wizard SNMP. Puede tener los valores DES o AES.
 +
** '''''_priv_pass_''''': Contraseña de privacidad de SNMPv3 usada en el wizard SNMP.
 +
 
 +
Los campos específicos para componentes del wizard WMI son:
 +
 +
* '''WMI class''': Hace referencia a la clase WMI que se utilizará en las consultas de los módulos generados por el componente. Por ejemplo, ''Win32_LogicalDisk''.
 +
 
 +
Se puede utilizar en otros campos de este mismo formulario mediante la macro ''_class_wmi_''.
 +
 
 +
* '''Query key field''' (''_field_wmi_0_''): Es el nombre del campo clave que se obtendrá en la consulta WMI usada en los módulos generados.
 +
 
 +
Por lo general las clases WMI tienen un campo clave que siempre devuelven en cualquier consulta tanto si se indica como si no. Ese sería el campo que se debería indicar aquí. Por ejemplo, el campo clave de la clase ''Win32_Processor'' sería ''DeviceID''.
 +
 
 +
El nombre de este campo se puede obtener en otros campos del formulario mediante la macro ''_field_wmi_0_'', y el valor que tenga el campo para cada registro de la consulta WMI se puede obtener mediante una macro con el mismo nombre del campo (''_FIELDNAME_''). Estas macros ''_FIELDNAME_'' se pueden utilizar, entre otros, en los campos '''Module name''' y '''Description''' del componente, para generar nombres y descripciones de forma dinámica. Por ejemplo, para el campo ''DeviceID'' la macro con el valor sería ''_DeviceID_''.
 +
 
 +
* '''Query extra fields''' → ''_field_wmi_N_'': En estos campos indicaremos los nombres de los campos adicionales que se deban utilizar en la consulta WMI usada en los módulos generados.
 +
 
 +
Los nombres de estos campos se pueden obtener en otros campos del formulario mediante las macros ''_field_wmi_N_'', y los valores que tengan los campos para cada registro de la consulta WMI se pueden obtener mediante macros con los mismos nombres de los campos (''_FIELDNAME_''). Estas macros ''_FIELDNAME_'' se pueden utilizar, entre otros, en los campos '''Module name''' y '''Description''' del componente, para generar nombres y descripciones de forma dinámica. Por ejemplo, para el campo FreeSpace la macro con el valor sería ''_FreeSpace_''.
 +
 
 +
* '''Query filters''' → Scan: En este espacio indicamos las condiciones para la consulta WMI lanzada en el escaneo, la cual nos permitirá obtener uno o más registros. Por ejemplo, ''DriveType = 3''.
 +
 
 +
En los componentes del wizard WMI, se generará un módulo distinto por cada registro devuelto por la consulta de escaneo WMI. Basándonos en los ejemplos aportados hasta ahora, la consulta de escaneo que se realizaría obtendría el espacio libre de las unidades de disco del equipo Windows:
 +
 
 +
    ''SELECT DeviceID, FreeSpace FROM Win32_LogicalDisk WHERE DriveType = 3''
 +
 
 +
 
 +
<center>
 +
[[image:IMG5_wizard_components.png]]
 +
</center>
 +
 
 +
Cuando el tipo de ejecución sea '''Network''':
 +
 
 +
* '''Query filters''' → Execution: Este espacio nos permite indicar las condiciones para la consulta WMI lanzada por cada módulo generado por el componente.
 +
 
 +
Acepta el uso de las macros con los nombres de los campos de la consulta (''_FIELDNAME_'') para obtener el valor de cada registro en ese campo. Por ejemplo, ''DriveType = 3 AND DeviceID = '_DeviceID_'.''
 +
 
 +
Basándonos en los ejemplos aportados hasta ahora, la consulta de ejecución final de un módulo generado por el componente que obtendría el espacio libre de la unidad de disco ''C:'' sería:
 +
 
 +
    ''SELECT DeviceID, FreeSpace FROM Win32_LogicalDisk WHERE DriveType = 3 AND DeviceID = 'C:' ''
 +
 
 +
* '''Field value''': Indicaremos el número del campo de la consulta WMI del cual se quiera obtener el valor del módulo, siendo el campo 0 el campo clave de la clase y los campos 1, y superiores, los adicionales de la clase.
 +
 
 +
Basándonos en los ejemplos aportados hasta ahora, el valor de espacio libre en los discos se obtendría del campo 1 (''FreeSpace'').
 +
 
 +
* '''Key string''': Nos permitirá convertir el valor del módulo en booleano (1 o 0) dependiendo de si el valor del campo indicado en ''Field value'' coincide con la cadena de texto indicada en este campo.
 +
 
 +
{{warning|La opción Key string no se tendrá en cuenta cuando el wizard se lance desde un Servidor Satélite mediante '''exec server'''}}
 +
 
 +
<center>
 +
[[image:IMG6_wizard_components.png]]
 +
</center>
 +
 
 +
Cuando el tipo de ejecución sea '''Plugin''':
 +
 
 +
* '''Value operation''': El propósito principal de utilizar componentes de tipo plugin es poder realizar operaciones con los valores de distintos campos de la consulta, como por ejemplo obtener el porcentaje de disco usado a partir de los bytes de disco libre y los bytes totales de disco disponibles.
 +
 
 +
Este campo permite indicar una operación aritmética con la cual se obtendrá el valor actual de cada módulo generado por el componente en la vista previa de los módulos del wizard. En ningún caso afecta para la ejecución definitiva de los módulos generados.
 +
 
 +
Acepta los caracteres + - * / ( ) . números y las macros con los nombres de los campos de la clase (''_FIELDNAME_''), de las cuales se obtendrán los valores para la operación. Por ejemplo:
 +
 
 +
      ''((_Size_ - _FreeSpace_) * 100) / _Size_''
 +
 
 +
* '''Satellite execution''': Permite indicar la ejecución que deba realizar un Servidor Satélite para los módulos generados cuando el wizard se lance desde un Servidor Satélite mediante el uso del ''exec server''. Se trata del comando, plugin o script que se deba usar en un ''module_exec'' de Servidor Satélite.
 +
 
 +
Acepta el uso de las macros para el wizard WMI y de las macros ''_class_wmi_'' para obtener el nombre de la clase WMI y ''_field_wmi_N_'' para obtener los nombres de los campos de la clase usados en cada módulo.
 +
 
 +
El Servidor Satélite distribuye un plugin recomendado para estos componentes:
 +
      ''/etc/pandora/satellite_plugins/wizard_wmi_module''
 +
 
 +
* '''Server plugin''': Permite indicar un plugin registrado en la consola de Pandora que será utilizado por el servidor de plugins con cada módulo generado por el componente. La elección de un plugin muestra a su vez en el formulario los campos específicos para la utilización del mismo.
 +
 
 +
Los campos propios del plugin aceptan el uso de las macros para el wizard WMI y de las macros ''_class_wmi_'' para obtener el nombre de la clase WMI y ''_field_wmi_N_'' para obtener los nombres de los campos de la clase usados en cada módulo.
  
Seleccione una plantilla y pulse el botón Assign, automáticamente se añadirán los módulos que contenga esa plantilla. Una vez aplicada la plantilla puede borrar alguno de los módulos pulsando sobre la X en la columna de la derecha, o puede editarlos pulsando sobre la el icono de herramienta también a la derecha.
+
La consola de Pandora FMS cuenta con un plugin ya registrado recomendado para estos componentes:
 +
      ''- Wizard WMI module.''
  
 +
<center>
 +
[[image:IMG7_wizard_components.png]]
 +
</center>
  
{{warning|No se muestran las plantillas que se han aplicado sobre el agente, sólo los módulos que éstas contienen}}
+
Las macros específicas para los componentes del wizard WMI que se pueden usar en los campos de ejecuciones de tipo plugin son:
 +
** '''''_address_''''': Dirección IP usada en el wizard WMI. No se sustituirá esta macro cuando el wizard se lance en una política.
 +
** '''''_namespace_wmi_''''': Namespace usado en el wizard WMI.
 +
** '''''_user_wmi_''''': Usuario utilizado en el wizard WMI.
 +
** '''''_pass_wmi_''''': Contraseña utilizada en el wizard WMI.
  
 
==Grupos de componentes==
 
==Grupos de componentes==
Line 334: Line 546:
 
Para ayudar a ordenar y clasificar los componentes existen los grupos de componentes. Los componentes se asocian en grupos de componentes a la hora de crearlos.
 
Para ayudar a ordenar y clasificar los componentes existen los grupos de componentes. Los componentes se asocian en grupos de componentes a la hora de crearlos.
  
Para ver los grupos de componentes existentes vaya a Administration -> Resources -> Component groups:
+
Para ver los grupos de componentes existentes vaya a ''Resources > Component groups'':
  
 
<br><br>
 
<br><br>
Line 351: Line 563:
 
Puede ver los detalles de los grupos pulsando sobre su nombre, borrarlos pulsando sobre la X a la derecha, y crear nuevos pulsando en el botón inferior Create.
 
Puede ver los detalles de los grupos pulsando sobre su nombre, borrarlos pulsando sobre la X a la derecha, y crear nuevos pulsando en el botón inferior Create.
  
Si quiere crear un grupo de componentes nuevo, pulse el botón Create, y rellene los campos en el formulario:
+
Si quiere crear un grupo de componentes nuevo, pulse el botón Create y rellene los campos en el formulario:
  
 
<br><br>
 
<br><br>
Line 359: Line 571:
 
<br><br>
 
<br><br>
  
Sólo tiene que proporcionar un nombre para el grupo y seleccionar si tiene un padre dentro de los grupos existentes. Después pulse el botón Create.
+
Solo tiene que proporcionar un nombre para el grupo y seleccionar si tiene un padre dentro de los grupos existentes. Después, pulse el botón Create.
  
 
Ahora ya puede añadir componentes nuevos a su recién creado grupo de componentes.
 
Ahora ya puede añadir componentes nuevos a su recién creado grupo de componentes.

Latest revision as of 10:41, 27 October 2020

Volver a Indice de Documentacion Pandora FMS


1 Plantillas y componentes

1.1 Introducción

Pandora FMS realiza todas las comprobaciones a través de módulos, permitiéndonos procesar diferentes tipos de datos en función del elemento a monitorizar. La lista completa de módulos predeterminados que contiene Pandora FMS se puede consultar en la sección Resources -> Module types :

Julia1.png


Al pulsar sobre este menú, en la parte derecha de la consola web de Pandora FMS se mostrarán los módulos disponibles:

Julia3.png


En Pandora FMS existen diferentes tipos de módulos:

  • async: datos asíncronos.
  • generic: datos genéricos.
  • keep_alive: módulo especial Keep Alive, sirve para controlar el estado del último contacto con un agente.
  • icmp: comprobación ICMP (ping).
  • snmp: comprobación SNMP.
  • tcp: comprobación TCP.
  • web: comprobación web.

Estos tipos de módulos pueden almacenar diferentes tipos de datos:

  • data: datos numéricos.
  • proc: valor booleano, 1 es cierto y 0 falso; por ejemplo, para módulos web significa que si el valor existe devuelve 1 y 0 si no existe.
  • string: cadena de texto.
  • inc: datos incrementales (por ejemplo, el número de paquetes enviados por una interfaz siempre crecerá); muestran el incremento por unidad de tiempo.
  • inc_abs: datos incrementales absolutos; muestran el valor incrementado desde la última lectura.


1.1.1 ¿Qué es un componente?

Un componente es un "módulo genérico" que se puede aplicar repetidamente sobre un agente, como si fuera una "copia maestra" de un módulo, generando un modulo asociado a un agente. De esta forma, es muy sencillo monitorizar nuevos agentes teniendo una base de datos de los componentes que más utilizamos en nuestra organización, ya que dispondremos de nuestros propios componentes adaptados a las tecnologías que solemos utilizar, y simplemente aplicaremos estos componentes a los agentes nuevos.

Existen dos tipos de componentes: los componentes de red, que agrupan a todos los módulos de tipo remoto (wmi, tcp, snmp, icmp, plugin, web, etc.), y los componentes locales, que incluyen la definición de los módulos de agentes software, como "trozos" de texto que se incorporarán al archivo de configuración del agente (con configuración remota habilitada) o se pueden cortar y pegar en la configuración de los agentes manualmente (sin configuración remota).


1.1.2 ¿Qué es una plantilla de componentes?

En Pandora FMS se ofrece la posibilidad de agrupar los componentes de red en "plantillas", de tal manera que podamos aplicar múltiples componentes de red directamente sobre un agente. Esto facilita el despliegue de la monitorización, ya que creamos varios módulos de forma simultánea a través de los componentes de red asociados a una plantilla.

El servidor Recon aplica los componentes de red asociados a una plantilla sobre los hosts detectados, agregando los módulos especificados de forma automática y permitiendo así un despliegue de la monitorización muy rápido y automático.


1.2 Componentes de red

Como hemos visto en los puntos precedentes, los componentes de red son los elementos que permiten hacer comprobaciones remotas a través de la red. Pandora FMS tiene alrededor de 40 comprobaciones de red predeterminadas, mientras que la versión Enterprise cuenta con más de 400.

Los componentes de red de Pandora FMS se pueden consultar y crear desde la página de gestión de los mismos, en Configuration > Network components.

Lulu.png



En ella podrá buscar los componentes ya existentes (filtrando por grupos o por texto de búsqueda libre), ver su configuración en detalles, modificarlos o crear nuevos componentes.

Para ver las propiedades de un módulo cualquiera, haga click sobre su nombre; le llevará a la página de edición:

Nc form2.png



Como se puede ver en la imagen, se ven todos los detalles del componente de red Host Alive.

Cuando se aplique a un módulo, este obtendrá los detalles del componente de red, excepto el campo de dirección IP, donde se ajustará automáticamente la dirección IP principal del agente al que se aplica el componente. Todos los parámetros pueden ser posteriormente editados (por ejemplo: cambiar el usuario/password de los modulos WMI).

Si se modifica la plantilla, sus valores se aplicarán a los módulos que se creen desde ese instante, no a los ya creados.

Para modificar los valores de los componentes, haga click sobre el nombre de uno de ellos y realice las modificaciones que desee en la página de edición, por ejemplo el intervalo. Una vez actualizado, pulse el botón Update al final de la página para guardar los cambios. A partir de ese momento la nueva configuración del componente se aplicará a los agentes a los que añada dicho módulo.


1.2.1 Crear componentes de red nuevos

Puede crear tres tipos de componentes de red:

  • Network (de red).
  • Plugin (de complemento del servidor).
  • WMI.


Para crear un componente de red, vaya a la página principal de administración de componentes de red, Administration > Manage modules -> Network components, y en la parte inferior de la página, en el menú desplegable seleccione un componente de red de los tres posibles (WMI, Red o Plugin) y pulse el botón Create.

luli.png



Después configure todos los campos del componente y pulse el botón Create. Esta es la pantalla de creación de componente WMI:

Loli.png



A la hora de completar los campos que se pide, tenga en cuenta que está completando la descripción de un módulo "genérico" que se aplicará sobre diferentes agentes. Algunos parámetros, como snmp community, usuario o password pueden ser diferentes según los agentes a los que le aplique el módulo posteriormente, por lo que puede dejarlos en blanco. Si dispone de una política de usuarios comunes para sus sistemas, puede dejar configurados por completo los módulos introduciendo aquí los usuarios, passwords y otros datos que sean comunes para todos los agentes.

Nomo.png



El mismo proceso se realiza para componentes de tipo Plugin.

En este caso, al igual que cuando creamos un módulo de tipo plugin, al seleccionar el plugin en la interfaz aparecerán los campos definidos en las macros del plugin.

Trio.png



1.3 Componentes locales

Los componentes locales hacen referencia a los componentes que se pueden aplicar a los agentes software. Si se dispone de la versión Enterprise de Pandora FMS, estos componentes se pueden aplicar de forma automática a todos nuestros agentes a través de las políticas o de forma manual (uno a uno) en el editor de configuración remota del agente. Consulte la sección de políticas para saber cómo aplicar componentes locales a agentes software de forma remota en su Pandora FMS Enterprise.

Los componentes locales también se pueden usar en la versión Open de Pandora FMS, solo que no se aplicarán de forma automática a través de Pandora FMS, sino que deberá acceder al agente directamente e introducir los cambios en el archivo de configuración. La versión Enterprise de Pandora FMS dispone de decenas de módulos locales para aplicar a las políticas y a los agentes de forma automática, ordenados por categorías.

Los componentes locales funcionan de forma muy parecida a los componentes de red, una vez que se va a su página de gestión, Configuration -> Local Components:

Hue.png


Esta pantalla muestra los módulos locales ya existentes, que se pueden filtrar por diversos parámetros (grupo, sistema operativo, consulta de texto libre) y también se puede ver, modificar y crear nuevos componentes.

Para ver las propiedades de un módulo cualquiera, simplemente pulse sobre su nombre; este tiene un enlace que le llevará a su página de detalles:

Local component form3.png


Como se ve, la configuración de los componentes locales es muy sencilla. Los elementos de configuración son:

  • Name: Nombre del componente. Este nombre será el visible a la hora de seleccionar el componente al crear un módulo para un agente.
  • OS: Sistema operativo para el que es el componente.
  • Group: El grupo en el que estará el módulo. Útil para filtrar y ordenar por tecnologías de monitorización.
  • Description: Descripción del módulo. De forma predeterminada ya existe una descripción, que se puede cambiar.
  • Configuration: Configuración del componente, igual a la configuración de los módulos para los agentes software. Para ver más ejemplos u obtener información complementaria consulte la sección Definición de los módulos en el capítulo de Configuración.
  • Warning status: Intervalo en el cual se toma el estado warning. Si está marcada la casilla 'inverse interval', entonces se cambiará a estado warning cuando no se encuentre dentro del intervalo definido.
  • Critical status: Intervalo en el cual se toma el estado crítico. Si está marcada la casilla 'inverse interval', entonces se cambiará a estado crítico cuando no se encuentre dentro del intervalo definido.
  • Warning instructions: Instrucciones a seguir cuando el estado es warning.
  • Critical instructions: Instrucciones a seguir cuando el estado es crítico.
  • Unknown instructions: Instrucciones a seguir cuando el estado es desconocido.
  • Category: Si se necesita agrupar o categorizar de otra forma, se pueden definir categorías.
  • Tags: Se pueden asignar etiquetas.
  • Macros: Se pueden configurar macros en la ejecución del módulo (module_exec) o los parámetros de un plugin.

1.3.1 Crear componentes locales nuevos

Para crear un componente local nuevo, vaya a la página principal de administración de componentes locales, Configuration > Local components y pulse el botónCreate en la parte inferior derecha de la página.

Aparecerá la página con el formulario de creación del componente local nuevo:

Local component form3.png


Rellene el formulario con la información antes mencionada y pulse el botón "Create".



1.3.2 Macros de ejecución local

Desde la versión 5.0 es posible definir macros en los componentes locales. Estas macros serán usadas en el parámetro module_exec y tendrán la estructura _field1_ , _field2_ ... _fieldN_.

Las macros aparecerán en el formulario de edición de módulos como campos normales, de forma transparente al usuario.

Cada macro tendrá tres campos: Description, Default value y Help.

  • Description: Será la etiqueta junto al campo en el formulario del módulo.
  • Default value: Valor optativo para cargar por defecto en el campo del formulario de módulo.
  • Help: Cadena optativa para añadir información adicional al campo. Si es definida, aparecerá un tip junto al campo con esta cadena.

Local components macros.png


Si un componente de módulo tiene macros, los datos de configuración estarán ocultos por defecto para simplificar la vista:

Local components macros editor hidden.png


Pero será posible mostrarlos y modificarlos.

Local components macros editor showed.png


1.4 Plantillas de módulos

Las plantillas de módulos son plantillas que contienen módulos de comprobaciones de red. Estas plantillas, una vez creadas, se pueden aplicar directamente a agentes, evitando tener que añadir los módulos de uno en uno, o bien aplicar las plantillas al realizar una tarea de reconocimiento de red.

Para gestionar las plantillas de módulos, pulse en "Configuration > Module templates".

Feisimo.png


Se mostrará la pantalla de gestión de plantillas, que ya tiene varias de forma predeterminada.

Horro.png


Puede pulsar sobre cualquiera de las plantillas para ver sus detalles, sobre el icono papelera en la columna de la derecha para borrarla, o el botón "Create" para crear una plantilla nueva.

Pulsando sobre el nombre de una plantilla se verán sus detalles; por ejemplo, la captura inferior muestra los detalles para la plantilla de módulos de monitorización básica (Basic Monitoring).

En ella se puede ver el nombre y la descripción de la plantilla en los dos primeros campos del formulario.

Más abajo está la lista de módulos incluidos en esta plantilla.

Por último está el formulario de edición de módulos, pudiendo filtrar por grupo de módulos, para después seleccionar el módulo y añadirlo.

Pla1.png
Module template edit2.png
Module template edit3.png


Para borrar un módulo, simplemente seleccione en la columna de la derecha (seleccionando la casilla superior de la derecha seleccionará todos) y pulse el botón "Delete".

Pla2.png


1.4.1 Crear plantillas de módulos nuevas

Para crear una plantilla de módulos nueva, vaya a la página principal de gestión de plantillas de componentes, "Configuration > Module templates" y pulse el botón "Create" en la parte inferior derecha de la página.

Aparecerá la página con el formulario de creación del componente local nuevo:

Pla3.png


Introduzca un nombre y una descripción para la plantilla nueva y pulse el botón "Create".

A continuación puede añadir módulos a la plantilla:

Pla4.png


Seleccione los módulos en la parte de abajo, filtrando por grupo si es necesario, y pulse el botón "Add".

Recuerde que puede borrar los módulos que no quiera seleccionando y pulsando el botón "Delete".

1.4.2 Aplicar una plantilla de módulos a un agente

Para aplicar una de las plantillas de módulos de monitorización ya existentes, o una creada, se debe ir a la configuración de un agente en Monitoring > Views > Agent Detail:

Pla5.png


Seleccione los módulos de uno de los agentes:

Pla6.png


Una vez en esta pantalla, se deberá pulsar sobre la solapa de las plantillas, Templates, en la parte superior de la página.


Pla7.png


En la siguiente pantalla se muestran los módulos que ya tiene el agente y las plantillas de módulos existentes, para poder seleccionar una y aplicarla al agente:


Pla8.png


Seleccione una plantilla y pulse el botón "Assign"; automáticamente se añadirán los módulos que contenga esa plantilla. Una vez aplicada la plantilla, puede borrar algunos de los módulos pulsando sobre la "X" en la columna de la derecha, o puede editarlos pulsando sobre el icono de herramienta.


Template warning.png

No se muestran las plantillas que se han aplicado sobre el agente, solo los módulos que estas contienen

 


1.5 Private Enterprise Number

Todos los dispositivos SNMP cuentan con una cadena identificativa (OID), que es única para cada marca y modelo de un dispositivo. Dentro de esas cadenas tenemos un número que se encuentra en la séptima posición y que es el que determina a que fabricante pertenece el dispositivo. Este número es el Private Enterprise Number (PEN) de un fabricante y se encuentra registrado en la IANA. Se pueden configurar estos PEN en Pandora para utilizarlos junto con las plantillas de módulos y agregar así monitorización de forma dinámica.

800

Dentro de esta vista, sólo será necesario insertar el PEN correspondiente del fabricante, indicar su nombre y una descripción. De esta manera se agregará al listado ya existente.

800

800

En las plantillas de módulos se indicarán uno o varios PEN de manera que cuando se lleve a cabo una tarea de descubrimiento, Pandora sea capaz de obtener el fabricante del dispositivo y agregarle la monitorización adecuada.

800

1.6 Componentes de Wizard

Dentro de las capacidades del wizard SNMP y el wizard WMI, encontramos un tipo de componentes remotos llamados Componentes de wizard.

Estos componentes permiten establecer una configuración base para los módulos que serán generados en los agentes al ejecutar cualquiera de los wizard (SNMP o WMI). Además nos ofrecerá la posibilidad de que con un solo componente se puedan generar varios módulos de forma dinámica. Por ejemplo, un componente para escanear las distintas unidades de almacenamiento de un dispositivo o los procesos en ejecución.

Se pueden crear estos componentes desde el menú Configuration > Templates > Remote components, con la opción Create a new wizard component.

IMG1 wizard components.png

En el formulario de creación se verán una serie de campos comunes para ambos wizard y otros específicos dependiendo del protocolo seleccionado.

Los campos comunes que podemos encontrar son:

  • Enabled: Al activar este token, estaremos indicando que el componente se intentará escanear al lanzar el wizard.
  • Add by default: Permite elegir si los módulos generados por el componente estarán marcados para agregarse por defecto al lanzar el wizard. Es decir, si se activa el token, los módulos generados por el componente estarán marcados por defecto en una vista que encontraremos más adelante y se añadirán al agente. Esta acción no implica que no se pueda modificar, ya que en esa vista podremos hacer modificaciones y desmarcar o marcar a voluntad y cambiar umbrales, descripciones, etc.
  • Module name: Nombre que tendrá el componente, y nombre por defecto para los módulos generados por el mismo. Se podrá hacer uso de algunas macros (se irán mostrando más adelante).
  • Module protocol: Permite indicar el wizard (SNMP o WMI) para el que se configura el componente. Según el protocolo seleccionado, el formulario muestra los campos específicos para cada wizard, los cuales se explican más adelante.
  • Component group: Grupo al que pertenecerá el componente. Nos permite organizar la forma en que se presentarán los módulos.
  • Module type: En este desplegable podemos escoger el tipo de dato que obtendrán los módulos generados por el componente.
  • Module unit: Unidad de los datos obtenidos por los módulos generados por el componente. Es un campo totalmente editable, por lo que podremos agregar la medida que se necesite.
  • Warning status: En esta sección podremos establecer un umbral por defecto para el estado warning de los módulos generados por el wizard. A pesar de indicar aquí un rango, habrá posibilidad de personalizarlo para cada módulo en la vista final que recoge todos los módulos encontrados.
  • Critical status: En esta sección podremos establecer un umbral por defecto para el estado critical de los módulos generados por el wizard. A pesar de indicar aquí un rango, habrá posibilidad de personalizarlo para cada módulo en la vista final que recoge todos los módulos encontrados.
  • Description: Se trata de una descripción que tendrá el componente y a su vez, los módulos generados por el mismo. Se podrá hacer uso de algunas macros. (Se irán mostrando más adelante).
  • Scan type: Nos permite elegir entre dos modalidades de escaneo que podrán realizar los wizards con este componente. Este campo determina si un componente generará un solo módulo o varios. El valor seleccionado afectará a como se deben rellenar otros campos específicos de cada wizard.
    • Fixed: El componente solo generará un módulo. Por ejemplo, obtener el uptime del dispositivo por SNMP.
    • Dynamic: El componente podrá generar uno o más módulos. Por ejemplo, obtener el porcentaje de uso de las unidades de disco por WMI.
  • Execution type: Con este campo indicamos el tipo de ejecución para los módulos generados por el componente. Sirve para determinar el servidor de Pandora al que pertenecerán los módulos en el momento de su creación dependiendo desde donde se lance el wizard.
    • Network: Los módulos generados por el componente obtendrán sus datos con los mecanismos propios de Pandora para módulos SNMP y WMI. Estos son, los servidores de red, WMI y satélite.
    • Plugin: Los módulos generados por el componente obtendrán sus datos de la ejecución de comandos, plugins o scripts personalizados. De esta manera, serán ejecutados por el servidor de plugins o por el satélite mediante módulos de tipo exec.

IMG2 wizard components.png

Los campos específicos para componentes del wizard SNMP son:

  • Name OID: Permite indicar un OID del cual se obtendrá un valor que podrá ser añadido al nombre del módulo mediante una macro.

Resulta especialmente útil cuando se obtienen múltiples módulos generados por un componente dinámico. De esta manera conseguimos que tengan nombres distintos por defecto. Pero no se limita a los componentes dinámicos, ya que se puede utilizar también para los componentes de escaneo fijo.

El valor de este OID es almacenado en la macro _nameOID_, que puede ser usada en el campo Module name.

Si se utiliza en componentes dinámicos, el OID indicado en este campo debe ser una rama de SNMP y no un OID final. Por ejemplo, si se indica el OID .1.3.6.1.4.1.2021.10.1.2, los valores que tendrá la macro en cada módulo se obtendrán de los OIDs .1.3.6.1.4.1.2021.10.1.2.x, donde x representa cada una de las terminaciones que puede tener la rama.

Si se utiliza en componentes fijos, el OID indicado en este campo debe ser un OID final. Por ejemplo, si se indica el OID .1.3.6.1.2.1.1.5.0, el valor que tendrá la macro en el módulo se obtendrá directamente de ese OID.

  • Manufacturer ID: Permite indicar el ID de un fabricante específico para el cual el componente del wizard SNMP tendrá efecto.

De esta manera, para todos los dispositivos contra los que se lance el wizard, y cuyo Private Enterprise Number (PEN) esté registrado en Pandora para el ID del fabricante asignado al componente, se intentarán obtener los módulos generados por el mismo. Por ejemplo, un componente asignado a general_snmp, se escaneará para todos los dispositivos con los PEN 2021 y 8072.

Si se indica como fabricante All, el componente se escaneará para cualquier PEN registrado en Pandora.

Template warning.png

Debe estar registrado el Private Enterprise Number (PEN) en la consola de Pandora FMS para el uso de Manufacturer ID

 


Cuando el tipo de ejecución sea Network:

  • Value OID: Nos permite indicar el OID a partir del cual se obtendrán los datos de los módulos generados por el componente.

Si se utiliza en componentes dinámicos, el OID indicado en este campo debe ser una rama de SNMP y no un OID final. Por ejemplo, si se indica el OID .1.3.6.1.4.1.2021.10.1.3, los valores que tendrán los módulos se obtendrán de los OIDs .1.3.6.1.4.1.2021.10.1.3.x. Además, el nodo X de cada OID debe tener el mismo valor para el nodo X del campo Name OID en el caso de utilizarse.

Si se utiliza en componentes fijos, el OID indicado en este campo debe ser un OID final. Por ejemplo, si se indica el OID .1.3.6.1.4.1.2021.11.9.0, el valor que tendrá el módulo se obtendrá directamente de ese OID.

IMG3 wizard components.png

Cuando el tipo de ejecución sea Plugin:

  • Macros OID_oid_N_: El propósito principal de utilizar componentes de tipo plugin es poder realizar operaciones con los valores de uno o más OIDs en el mismo dispositivo, como por ejemplo obtener el porcentaje de memoria usada a partir de los bytes de memoria usada y los bytes totales de memoria disponibles.

Es por ello que en estos componentes podemos indicar tantos OIDs como necesitemos para utilizarlos en otros campos.

Además, estos OIDs, o sus valores, se podrán utilizar a partir de las macros _oid_N_. Dependiendo de en cuál de los campos siguientes se utilice la macro, se usará el valor del OID o el OID en sí mismo.

Si se utilizan en componentes dinámicos, los OIDs indicados en estos campos deben ser una rama de SNMP y no un OID final. Por ejemplo, si se indica el OID .1.3.6.1.4.1.3375.2.1.7.4.2.1.3, los valores que tendrán los módulos se obtendrán de los OIDs .1.3.6.1.4.1.3375.2.1.7.4.2.1.3.x. Además el nodo X de cada OID debe tener el mismo valor para el nodo X del resto de OIDs usados y del campo Name OID en el caso de utilizarse.

Si se utiliza en componentes fijos, los OIDs indicados en estos campos deben ser un OID final. Por ejemplo, si se indica el OID .1.3.6.1.4.1.2021.4.6.0, el valor que tendrá el módulo se obtendrá directamente de ese OID.


  • Value operation: Nos permite indicar una operación aritmética con la cual se obtendrá el valor actual de cada módulo generado por el componente en la vista previa de los módulos del wizard. En ningún caso afecta para la ejecución definitiva de los módulos generados.

Acepta los caracteres + - * / ( ) . números y las macros _oid_N_ de las cuales se obtendrán los valores para la operación. Por ejemplo:

     	(_oid_1_ * 100) / _oid_2_
  • Satellite execution: Nos ofrece la posibilidad de indicar la ejecución que deba realizar un Servidor Satélite para los módulos generados cuando el wizard se lance desde un Servidor Satélite mediante el uso del exec server. Se trata del comando, plugin o script que se deba usar en un module_exec de servidor satélite.

Acepta el uso de las macros para el wizard SNMP (se detallarán más adelante) y de las macros _oid_N_ para obtener los OIDs usados en cada módulo.

El Servidor Satélite distribuye una serie de plugins recomendados para estos componentes:

      	- /etc/pandora/satellite_plugins/wizard_snmp_module
     	- /etc/pandora/satellite_plugins/wizard_snmp_process
  • Server plugin: Mediante este desplegable se podrá indicar un plugin registrado previamente en la consola de Pandora FMS, el cual será utilizado por el servidor de plugins con cada módulo generado por el componente. La elección de un plugin nos muestra a su vez en el formulario los campos específicos para la utilización del mismo.

Los campos propios del plugin aceptan el uso de las macros para el wizard SNMP y de las macros _oid_N_ para obtener los OIDs usados en cada módulo.

La consola de Pandora FMS cuenta con una serie de plugins ya registrados recomendados para estos componentes:

     	- Wizard SNMP module.
     	- Wizard SNMP process.


IMG4 wizard components.png

Las macros específicas para los componentes del wizard SNMP que se pueden usar en los campos de ejecuciones de tipo plugin son:

    • _address_: Dirección IP usada en el wizard SNMP. No se sustituirá esta macro cuando el wizard se lance en una política.
    • _port_: Puerto usado en el wizard SNMP.
    • _version_: Versión de SNMP usada en el wizard SNMP. Puede tener los valores 1, 2c o 3.
    • _community_: Comunidad SNMP usada en el wizard SNMP.
    • _sec_level_: Nivel de seguridad de SNMPv3 usado en el wizard SNMP. Puede tener los valores noAuthNoPriv, authNoPriv o authPriv
    • _auth_user_: Usuario de SNMPv3 usado en el wizard SNMP.
    • _auth_method_: Método de autenticación de SNMPv3 usado en el wizard SNMP. Puede tener los valores MD5 o SHA.
    • _auth_pass_: Contraseña de autenticación de SNMPv3 usada en el wizard SNMP.
    • _priv_method_: Método de privacidad de SNMPv3 usado en el wizard SNMP. Puede tener los valores DES o AES.
    • _priv_pass_: Contraseña de privacidad de SNMPv3 usada en el wizard SNMP.

Los campos específicos para componentes del wizard WMI son:

  • WMI class: Hace referencia a la clase WMI que se utilizará en las consultas de los módulos generados por el componente. Por ejemplo, Win32_LogicalDisk.

Se puede utilizar en otros campos de este mismo formulario mediante la macro _class_wmi_.

  • Query key field (_field_wmi_0_): Es el nombre del campo clave que se obtendrá en la consulta WMI usada en los módulos generados.

Por lo general las clases WMI tienen un campo clave que siempre devuelven en cualquier consulta tanto si se indica como si no. Ese sería el campo que se debería indicar aquí. Por ejemplo, el campo clave de la clase Win32_Processor sería DeviceID.

El nombre de este campo se puede obtener en otros campos del formulario mediante la macro _field_wmi_0_, y el valor que tenga el campo para cada registro de la consulta WMI se puede obtener mediante una macro con el mismo nombre del campo (_FIELDNAME_). Estas macros _FIELDNAME_ se pueden utilizar, entre otros, en los campos Module name y Description del componente, para generar nombres y descripciones de forma dinámica. Por ejemplo, para el campo DeviceID la macro con el valor sería _DeviceID_.

  • Query extra fields_field_wmi_N_: En estos campos indicaremos los nombres de los campos adicionales que se deban utilizar en la consulta WMI usada en los módulos generados.

Los nombres de estos campos se pueden obtener en otros campos del formulario mediante las macros _field_wmi_N_, y los valores que tengan los campos para cada registro de la consulta WMI se pueden obtener mediante macros con los mismos nombres de los campos (_FIELDNAME_). Estas macros _FIELDNAME_ se pueden utilizar, entre otros, en los campos Module name y Description del componente, para generar nombres y descripciones de forma dinámica. Por ejemplo, para el campo FreeSpace la macro con el valor sería _FreeSpace_.

  • Query filters → Scan: En este espacio indicamos las condiciones para la consulta WMI lanzada en el escaneo, la cual nos permitirá obtener uno o más registros. Por ejemplo, DriveType = 3.

En los componentes del wizard WMI, se generará un módulo distinto por cada registro devuelto por la consulta de escaneo WMI. Basándonos en los ejemplos aportados hasta ahora, la consulta de escaneo que se realizaría obtendría el espacio libre de las unidades de disco del equipo Windows:

   SELECT DeviceID, FreeSpace FROM Win32_LogicalDisk WHERE DriveType = 3


IMG5 wizard components.png

Cuando el tipo de ejecución sea Network:

  • Query filters → Execution: Este espacio nos permite indicar las condiciones para la consulta WMI lanzada por cada módulo generado por el componente.

Acepta el uso de las macros con los nombres de los campos de la consulta (_FIELDNAME_) para obtener el valor de cada registro en ese campo. Por ejemplo, DriveType = 3 AND DeviceID = '_DeviceID_'.

Basándonos en los ejemplos aportados hasta ahora, la consulta de ejecución final de un módulo generado por el componente que obtendría el espacio libre de la unidad de disco C: sería:

   SELECT DeviceID, FreeSpace FROM Win32_LogicalDisk WHERE DriveType = 3 AND DeviceID = 'C:' 
  • Field value: Indicaremos el número del campo de la consulta WMI del cual se quiera obtener el valor del módulo, siendo el campo 0 el campo clave de la clase y los campos 1, y superiores, los adicionales de la clase.

Basándonos en los ejemplos aportados hasta ahora, el valor de espacio libre en los discos se obtendría del campo 1 (FreeSpace).

  • Key string: Nos permitirá convertir el valor del módulo en booleano (1 o 0) dependiendo de si el valor del campo indicado en Field value coincide con la cadena de texto indicada en este campo.

Template warning.png

La opción Key string no se tendrá en cuenta cuando el wizard se lance desde un Servidor Satélite mediante exec server

 


IMG6 wizard components.png

Cuando el tipo de ejecución sea Plugin:

  • Value operation: El propósito principal de utilizar componentes de tipo plugin es poder realizar operaciones con los valores de distintos campos de la consulta, como por ejemplo obtener el porcentaje de disco usado a partir de los bytes de disco libre y los bytes totales de disco disponibles.

Este campo permite indicar una operación aritmética con la cual se obtendrá el valor actual de cada módulo generado por el componente en la vista previa de los módulos del wizard. En ningún caso afecta para la ejecución definitiva de los módulos generados.

Acepta los caracteres + - * / ( ) . números y las macros con los nombres de los campos de la clase (_FIELDNAME_), de las cuales se obtendrán los valores para la operación. Por ejemplo:

     	((_Size_ - _FreeSpace_) * 100) / _Size_
  • Satellite execution: Permite indicar la ejecución que deba realizar un Servidor Satélite para los módulos generados cuando el wizard se lance desde un Servidor Satélite mediante el uso del exec server. Se trata del comando, plugin o script que se deba usar en un module_exec de Servidor Satélite.

Acepta el uso de las macros para el wizard WMI y de las macros _class_wmi_ para obtener el nombre de la clase WMI y _field_wmi_N_ para obtener los nombres de los campos de la clase usados en cada módulo.

El Servidor Satélite distribuye un plugin recomendado para estos componentes:

     	/etc/pandora/satellite_plugins/wizard_wmi_module
  • Server plugin: Permite indicar un plugin registrado en la consola de Pandora que será utilizado por el servidor de plugins con cada módulo generado por el componente. La elección de un plugin muestra a su vez en el formulario los campos específicos para la utilización del mismo.

Los campos propios del plugin aceptan el uso de las macros para el wizard WMI y de las macros _class_wmi_ para obtener el nombre de la clase WMI y _field_wmi_N_ para obtener los nombres de los campos de la clase usados en cada módulo.

La consola de Pandora FMS cuenta con un plugin ya registrado recomendado para estos componentes:

     	- Wizard WMI module.

IMG7 wizard components.png

Las macros específicas para los componentes del wizard WMI que se pueden usar en los campos de ejecuciones de tipo plugin son:

    • _address_: Dirección IP usada en el wizard WMI. No se sustituirá esta macro cuando el wizard se lance en una política.
    • _namespace_wmi_: Namespace usado en el wizard WMI.
    • _user_wmi_: Usuario utilizado en el wizard WMI.
    • _pass_wmi_: Contraseña utilizada en el wizard WMI.

1.7 Grupos de componentes

Para ayudar a ordenar y clasificar los componentes existen los grupos de componentes. Los componentes se asocian en grupos de componentes a la hora de crearlos.

Para ver los grupos de componentes existentes vaya a Resources > Component groups:



Pla9.png



En la pantalla se mostrarán los grupos existentes y su descripción:



Pla10.png



Puede ver los detalles de los grupos pulsando sobre su nombre, borrarlos pulsando sobre la X a la derecha, y crear nuevos pulsando en el botón inferior Create.

Si quiere crear un grupo de componentes nuevo, pulse el botón Create y rellene los campos en el formulario:



Pla11.png



Solo tiene que proporcionar un nombre para el grupo y seleccionar si tiene un padre dentro de los grupos existentes. Después, pulse el botón Create.

Ahora ya puede añadir componentes nuevos a su recién creado grupo de componentes.

Volver a Indice de Documentacion Pandora FMS