Componentes de Wizard

Dentro de las capacidades del wizard SNMP y el wizard WMI, se encuentran los tipos 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 ofrece la posibilidad de que con un solo componente se puedan generar varios módulos de forma dinámica.

Para crear estos componentes se utiliza el menú Management → Configuration → Templates → Remote components. Se selecciona la opción Create a new wizard component y se pulsa el botón Create.

En el cuadro de diálogo de creación existe una opción importante: el protocolo de Módulo (Module protocol) a utilizar. Existen dos protocolos disponibles, SNMP (por defecto) y WMI, y aunque ambos comparten campos comunes también difieren en otros campos.

• Enabled: Al activar este token se indica 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.
• 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.
• Module type: Tipo de dato que obtendrán los módulos generados por el componente.
• Component group: Grupo al que pertenecerá el componente. Permite organizar la forma en que se presentarán los módulos.
• Module unit: Unidad de los datos obtenidos por los módulos generados por el componente.
• Warning: En esta sección se puede establecer un umbral por defecto para el estado de advertencia de los módulos generados por el wizard.
• Critical status: En esta sección puede establecer un umbral por defecto para el estado crítico de los módulos generados por el wizard.
• Description: Descripción que tendrá el componente y a su vez los módulos generados por el mismo. Se podrá hacer uso de algunas macros.

Scan type: Permite elegir entre dos modalidades de exploración que podrán realizar los wizards con este componente:

• Fixed: El componente solo generará un módulo.
• Dynamic: El componente podrá generar uno o más módulos.

Execution type: Con este campo se indica el tipo de ejecución para los módulos generados por el componente. Sirve para determinar el servidor de Pandora FMS al que pertenecerán los módulos en el momento de su creación dependiendo desde dónde se ejecute el wizard:

• Network: Los módulos generados por el componente obtendrán sus datos con los mecanismos propios de Pandora FMS para módulos SNMP y WMI. Estos son: los servidores de red, servidor WMI y servidor 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 servidor satélite mediante módulos de tipo exec.

Menú Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → SNMP.

Campos específicos:

• 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. El valor de este OID es almacenado en la macro _nameOID_, que puede ser usada en el campo Module name. Si se indica como fabricante All, el componente se escaneará para cualquier PEN registrado en Pandora FMS.
• Manufacturer ID: Permite indicar el ID de un fabricante específico para el cual el componente del wizard SNMP tendrá efecto.
• Cuando Execution type está establecido en Network: Value OID.
• ​​​Cuando Execution type está establecido en Plugin: Macros OID, Value operation, Satellite execution, Server plugin.

Menú Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → SNMP (Execution type → Network).

Cuando el tipo de ejecución sea Network el Value OID 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.
• Si se utiliza en componentes fijos, el OID indicado en este campo debe ser un OID final.

Menú Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → SNMP (Execution type → Plugin).

El propósito principal de utilizar componentes de tipo plugin es poder realizar operaciones con los valores de uno o más OID en el mismo dispositivo. Es por ello que en estos componentes se pueden indicar tantos OID como se necesiten para utilizarlos en otros campos.

Macros OID → _oid_N_

Además, estos OID, 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 OID indicados en estos campos deben ser una rama de SNMP y no un OID final. Si se utiliza en componentes fijos, los OID indicados en estos campos deben ser un OID final.

Value operation

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.

Satellite execution

Ofrece la posibilidad de indicar la ejecución que deba realizar un Servidor Satélite para los módulos generados cuando el wizard se ejecute 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 y de las macros _oid_N_ para obtener los OID 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 lista 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 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 plugins ya registrados recomendados para estos componentes: Wizard SNMP module y Wizard SNMP process. Según se utilice uno u otro se deberán completar el resto de los campos respectivos para realizar la monitorización mediante SNMP.

Menú Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → WMI.

menú Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → WMI (Execution type → Network).

Cuando el tipo de ejecución sea Network:

• WMI class: Permite especificar la clase WMI a consultar. Las clases WMI son predefinidas que se incluyen en cada espacio de nombres del núcleo de Windows Management Instrumentation® (WMI).
• Query filters → Execution: Este espacio 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.
• Field value: Para indicar 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.
• Key string: Permite convertir el valor del módulo en booleano (1 ó 0) dependiendo de si el valor del campo indicado en Field value coincide con la cadena de texto indicada en este campo.

Menú Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → WMI (Execution type → Plugin).

Cuando el tipo de ejecución sea Plugin:

• Comparte campos comunes con la ejecución Network hasta el campo Query filters (Scan).
• Value operation: 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.
• 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 FMS 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.

La Consola de Pandora FMS cuenta con un plugin ya registrado recomendado para estos componentes: Wizard WMI module.

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.

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.

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 pueden 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 se indicarán 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 se indican las condiciones para la consulta WMI lanzada en el escaneo, la cual 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.

Volver al índice de documentación de Pandora FMS