Parámetros y configuración

Parámetros

--generate_password	para generar una contraseña encriptada, ( si quiere usarse luego esta contraseña para conectar, se deberá introducir en la opción de configuración "password" y activar también en el archivo de configuración la opción "use_encrypted_password" con 1.
--as_discovery_plugin	opción para usarlo en el modo discovery.

Bloques de configuración

El archivo de configuración se divide en los siguientes bloques

Configuration
Datacenter
Datastore
ESX
VM
Rename
Reject
Header

Cada uno se especifica en este introduciéndolo poniendo las opciones configurables abajo, ejemplo:

Configuration
server 
user
pass
datacenter

A continuación se detalla cada bloque y sus opciones:

Configuration

Debajo del bloque configuration se pueden especificar los siguientes parámetros

Configuración global

server	nombre o ip del server a monitorizar
user	usuario de la cuenta
pass	contraseña de la cuenta
datacenter	datacenter al que apuntará el plugin
temporal	ruta donde se guardarán los archivos temporales
logfile	ruta donde se guardará el archivo de logs
entities_list	ruta donde se creara el archivo entities_list (más información sobre este archivo abajo)
transfer_mode	modo de ejecución, las dos opciones posibles son local o tentacle
local_folder	ruta de la carpeta donde se crearan los XML de los agentes para el modo de transferencia local (transfer_mode = local)
pandora_url	url de pandora (solo si se requiere usar el modo eventos del plugin)
api_pass	contraseña de la api de pandora (solo si se requiere usar el modo eventos del plugin)
api_user	usuario api de pandora (solo si se requiere usar el modo eventos del plugin)
api_user_pass	contraseña del usuario de api de pandora (solo si se requiere usar el modo eventos del plugin)
event_mode	para activar el modo evento, se activa con 1
event_pointer_file	ruta donde se guardará el archivo event_pointer_file
tentacle_ip	ip de tentacle, requerida si se ejecuta el plugin en transfer mode tentacle
tentacle_port	puerto de tentacle, por defecto es 41121
tentacle_opts	opciones adicionales para la transferencia de ficheros al servidor de Tentacle indicado
virtual_network_monitoring	para activar el monitoreo de switches
use_encrypted_password	para activar el uso de una contraseña encriptada
threads	número de hilos que usará el plugin en la creación de agentes
interval	intervalo en segundos en el que se crean los agentes del plugin
recon_interval	Intervalo en segundos después del cual el archivo de caché de la entidad temporal se eliminará automáticamente para volver a escanear la infraestructura de VMware®.
group	grupo donde se van a crear los agentes
use_ds_alias_as_name	para usar el alias del agente de datastore como nombre del agente
all_ipaddresses	para coger las ips en los agentes
statsinterval	el intervalo en segundos para las estadísticas sacadas mediante la opción "custom_performance"
flat_datastore_agents	para la creación de un agente principal para los datastores con con nombre "VMWareDatastores" , activar con 1
use_ds_entity_name	usar nombre del datastore como nombre del agente, activar con 1
custom_performance	para la creación de módulos de monitorización de estadísticas personalizados

Parámetros de control de elementos monitorizables

monitor_exclusive_agents	para activar la monitorización de agentes específicos ( estos se específican en los parámetros de abajo), se activa con 1
exclusive_esx	si esta activado monitor_exclusive_agent, sirve para especificar los esxi a monitorizar
exclusive_datastores	si esta activado monitor_exclusive_agent, sirve para especificar los datastore a monitorizar
exclusive_vm	si esta activado monitor_exclusive_agent, sirve para especificar los vm a monitorizar
scan_datastore	para activar el escaneo de datastores, se activa con 1
scan_datacenter	para activar el escaneo del datacenter, se activa con 1
scan_esx	para activar el escaneo de esx, se activa con 1
scan_vm	para activar el escaneo de máquinas virtuales, se activa con 1

Datacenter

Parámetros de activación o desactivación de módulos

Los siguientes módulos pueden activarse o desactivarse en archivo de configuración usando "enabled" o "disabled".

ping	comprobación de ping a la máquina que admite vCenter
check443	verificación del puerto 443 en la máquina que admite vCenter

Datastore

Parámetros de activación o desactivación de módulos

Los siguientes módulos pueden activarse o desactivarse en archivo de configuración usando "enabled" o "disabled".

Datastores

capacity	capacidad máxima del almacén de datos en bytes
freeSpace	porcentaje de espacio libre en el almacén de datos
overallocation	porcentaje de sobreasignación de disco
freeSpaceBytes	cantidad de espacio libre en disco en bytes
dsPathStatus	estado de la ruta del datastore

ESX

Parámetros de activación o desactivación de módulos

Los siguientes módulos pueden activarse o desactivarse en archivo de configuración usando "enabled" o "disabled".

diskRead	Velocidad de lectura Kb/s del disco
diskWrite	Tasa de Kb/s escritos del disco
kernelReadLatency	Latencia de la lectura del disco en milisegundos
kernelWriteLatency	Latencia de escritura del disco en milisegundos
deviceReadLatency	tiempo que tarda un dispositivo de almacenamiento en responder a una solicitud de lectura de datos
deviceWriteLatency	tiempo que tarda un dispositivo de almacenamiento en responder a una solicitud de escritura de datos
cpuInfo	Información general de la CPU (crea un módulo para cada CPU ESXi)
pciDevice	cantidad de dispositivos PCI asignados
hbaDevice	cantidad de dispositivos HBA (Host Bus Adapter) asignados a una máquina virtual
pnicInfo	información relacionada con los adaptadores físicos de red (PNICs) que están configurados en el host ESXi
vnicInfo	Información sobre las interfaces de red virtuales del host
cpuUsagePercent	porcentaje de uso actual de la CPU en el host
memoryUsagePercent	porcentaje de uso actual de la memoria RAM en el host
diskRate	velocidad de transferencia de datos de lectura y escritura en el disco virtual del host
maxDiskLatency	tiempo máximo de latencia de E/S en el disco virtual del host
netUsage	velocidad de transferencia de datos de red en el host
systemHealthInfo	información sobre el estado de salud general del sistema.
netReceived	cantidad de datos recibidos a través de la interfaz de red del host
netTransmitted	cantidad de datos transmitidos a través de la interfaz de red del host
netPkgRx	cantidad de paquetes de red recibidos por la interfaz de red del host
netPkgTx	cantidad de paquetes de red transmitidos por la interfaz de red del host

Parámetros de activación o desactivación de módulos

Los siguientes módulos pueden activarse o desactivarse en archivo de configuración usando "enabled" o "disabled".

virtualImagePath	ruta de acceso de la imagen de disco virtual asociada a una máquina virtual en particular
toolsRunningStatus	estado de ejecución de las herramientas de VMware Tools en una máquina virtual
host	servidor físico que aloja las máquinas virtuales en un entorno de virtualización
connectionState	estado de conexión entre una máquina virtual y su host ESXi en un entorno de virtualización
guestState	estado de la máquina virtual en términos de su sistema operativo y aplicaciones en ejecución
guestOS	sistema operativo que se está ejecutando en la máquina virtual
hostName	nombre del host físico en el que se está ejecutando la máquina virtual
powerState	indica si la máquina virtual está encendida o apagada
triggeredAlarmState	muestra el estado de las alarmas activadas en la máquina virtual
bootTime	muestra la fecha y hora de inicio de la máquina virtual
vcpuAllocation	número de CPU virtuales asignadas a la máquina virtual
cpuAllocation	cantidad de recursos de CPU asignados a la máquina virtual
consumedOverheadMemory	cantidad de memoria utilizada por el host para realizar tareas relacionadas con la máquina virtual
hostMemoryUsage	cantidad de memoria utilizada por el host para realizar tareas relacionadas con la máquina virtual
maxCpuUsage	máximo uso de la CPU en la máquina virtual
maxMemoryUsage	máximo uso de memoria en la máquina virtual
memoryMBAllocation	cantidad de memoria RAM asignada a la máquina virtual
memoryAllocation	cantidad de memoria asignada a la máquina virtual
uptimeSeconds	tiempo total que la máquina virtual ha estado en funcionamiento
memoryOverhead	cantidad de memoria utilizada por el host para tareas de supervisión y gestión de la máquina virtual
overallCpuDemand	cantidad total de recursos de CPU solicitados por la máquina virtual
overallCpuUsage	cantidad total de recursos de CPU utilizados por la máquina virtual
privateMemory	cantidad de memoria utilizada por la máquina virtual para sus procesos privados
sharedMemory	cantidad de memoria compartida entre la máquina virtual y el host
diskUsed	cantidad de espacio utilizado en el disco virtual de la máquina virtual
provisioningUsed	cantidad de espacio utilizado en el almacenamiento de aprovisionamiento de la máquina virtual
macAddress	dirección MAC asignada a la interfaz de red de la máquina virtual
ipAddress	dirección IP asignada a la interfaz de red de la máquina virtual
heartbeat	estado del latido del corazón de la máquina virtual
cpuReady	cantidad de tiempo que la máquina virtual está esperando por la CPU
snapshotCounter	número de instantáneas creadas para la máquina virtual
totalReadLatency	tiempo de latencia total de lectura del disco virtual de la máquina virtual
totalWriteLatency	tiempo de latencia total de escritura del disco virtual de la máquina virtual
cpuUsagePercent	porcentaje de uso actual de la CPU en la máquina virtual
memoryUsagePercent	porcentaje de uso actual de la memoria RAM en la máquina virtual
diskRate	velocidad de transferencia de datos de lectura y escritura en el disco virtual de la máquina virtual
maxDiskLatency	tiempo máximo de latencia de E/S en el disco virtual de la máquina virtual
netUsage	velocidad de transferencia de datos de red en la máquina virtual
systemHealthInfo	información sobre el estado de salud general del sistema
netReceived	cantidad de datos recibidos a través de la interfaz de red de la máquina virtual
netTransmitted	cantidad de datos transmitidos a través de la interfaz de red de la máquina virtual
netPkgRx	cantidad de paquetes de red recibidos por la interfaz de red de la máquina virtual
netPkgTx	cantidad de paquetes de red transmitidos por la interfaz de red de la máquina virtual

Rename

El renombrado de entidades se realiza mediante el token RENAME y permite renombrar las entidades descubiertas por el plugin. Al utilizar esta funcionalidad, los agentes creados en Pandora FMS aparecerán con el nuevo nombre asignado. La estructura de esta sección es la siguiente:

<current name> TO <new name>

Un ejemplo de configuración en este apartado podría ser el siguiente:

 #Rename entities
 Rename
 Debian 11 TO Virtual Machine 1
 RedHat 12 TO Web server
 ESX Workstation TO Host Work Sales

Header

En header se le puede añadir un prefijo a cada bloque de agentes, lo que puede ser útil para una identificación más rápida de estos en pandora. La sintaxis de cada bloque es :

dc <prefijo>
ds <prefijo>
esx <prefijo>
vm <prefijo>

un ejemplo puede ser el siguiente :

dc dc.
ds ds.
esx esx.
vm vm.

En este ejemplo, todos los agentes de máquina virtual tendrían un nombre con la siguiente estructura:

vm.<nombre_de_agente>

Reject

Sirve para desactivar el escaneo de ips de los agentes, se utiliza con este parámetro.

all_ipaddresses

Si se ejecuta este parámetro con 1 se desactivara el escaneo de ips de los agentes

Ejemplo archivo de configuración

Configuration
server 192.168.80.36
datacenter ha-datacenter
user pandora
group Applications
use_encrypted_password 0
interval 300
pass HhVGFJk!H
threads 5
event_mode 0
retry_send 0
virtual_network_monitoring 0
recon_interval 300

monitor_exclusive_agents 0
exclusive_esx []
exclusive_datastores []
exclusive_vm []

scan_datastore 1
scan_datacenter 1
scan_esx 1
scan_vm 1

logfile /tmp/tmp_discovery.taskMD5.log
entities_list /tmp/tmp_discovery.taskMD5.entities
event_pointer_file /tmp/tmp_discovery.taskMD5.events
temporal /tmp
transfer_mode tentacle
tentacle_ip 127.0.0.1
tentacle_port 41121
tentacle_opts 
local_folder /var/spool/pandora/data_in
pandora_url http://127.0.0.1/pandora_console/
api_pass pandora
api_user admin
apipandorapass 1234

Rename
venger TO esx_venger
SSD100GB TO disk_store_1

Sobre la monitorización:

Entity scan

Debido al tamaño de las infraestructuras de VMware® del cliente empresarial, un análisis general de todas las entidades disponibles en cada ejecución podría desencadenar problemas de rendimiento.

Para evitar esta situación, el complemento de monitoreo de VMware tiene el archivo de entidad ( entities_list)donde almacena la lista de entidades escaneadas en la primera ejecución).

Mientras exista este fichero, el seguimiento se limitará a las entidades indicadas en el mismo.

Configuración de la monitorización

Las siguientes secciones del fichero configuran los módulos creados para cada tipo de entidad. Estas secciones utilizan las secciones Data Center, Data Store, ESX y VM. En estas secciones se pueden habilitar y deshabilitar los módulos a monitorizar. El siguiente ejemplo contiene una configuración según los módulos que se crearían para ESX y máquinas virtuales.

 ...
 #ESX Modules
 ESX
 cpuUsagePercent disabled
 diskRead enabled
 diskWrite enabled

 #VM Modules
 VM
 diskReadLatency disabled
 diskWriteLatency disabled
 diskRate enabled
 ...

Cada línea de configuración es un módulo. Aunque en el ejemplo anterior, todos los módulos se crean con valores por defecto. Puede configurar los siguientes valores: 'Nombre', 'descripción' y 'límites' para los estados 'advertencia' y 'crítico'. Un ejemplo de este tipo de configuración sería como el siguiente:

 ...
 #VM Modules
 ESX
 diskReadLatency disabled
 diskWriteLatency disabled
 diskRate name = Disk Rate; desc = Lec Rate/Esc disk; limits_warn = 5 10; limits_crit = 0 4
 ...

Las opciones disponibles para la configuración del módulo son estas:

<módulo> desactivado: El módulo NO se creará
<módulo> activado: El módulo SÍ se creará (con valores por defecto)
<module> name = <name>; desc = <description>; limits_warn <lim_warn>; limits_crit <lim_crit"

El módulo se creará con el nombre y la descripción dados. El módulo definirá umbrales para 'máximo' y 'mínimo', así como para los estados Crítico y Advertencia.

Tenga en cuenta que es muy importante respetar la estructura de las líneas del fichero de configuración y, sobre todo, asegurarse de que el carácter; va unido al nombre y a la descripción del módulo.Estas dos líneas NO SON EQUIVALENTES (ver espacios antes del carácter;)

 diskRate name = Disk Rate; desc = Lec Rate/Esc Disk; limits_warn = 5 10; limits_crit = 0 4
 diskRate name = Disk Rate    ; desc = Lec Rate/Esc disk    ; limits_warn = 5 10; limits_crit    = 0    4

Los módulos se referencian por sus nombres cortos o un nombre equivalente más simple para escribirlo en la línea de comandos. Las tablas de asignación de nombres cortos y completos se explican en la siguiente sección.

Analicemos la configuración del ejemplo anterior. El módulo Disk Rate que será creado junto con los siguientes valores ha sido configurado:

 * Name: Disk Rate
 * Description: Lec Rate/Esc disk
 * Min Warning: 5
 * Max Warning: 10
 * Min Critical: 0
 * Max Critical: 4