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

From Pandora FMS Wiki
Jump to: navigation, search
(Componentes de Wizard)
(Componentes de Wizard)
Line 398: Line 398:
 
* '''Value OID''': Nos permite indicar el OID a partir del cual se obtendrán los datos de los módulos generados por el componente.
 
* '''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 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.
 
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.

Revision as of 13:41, 1 July 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.

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.

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