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 de los bloques se especifica en esteel introduciéndolo fichero poniendode lasconfiguración opcionesintroduciendo configurablessus abajo,parámetros ejemplo:debajo de estos bloques, por ejemplo :

Configuration
server 192.168.100.105
user pandorafms
pass P@$5w0rd!
datacenter ha-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

con

server	nombreNombre o ipIP del server a monitorizar
user	usuarioUsuario de la cuenta
pass	contraseñContraseña de la cuenta
datacenter	datacenterDatacenter al que apuntará el plugin
temporal	rutaRuta donde se guardarán los archivos temporales
logfile	rutaRuta donde se guardará el archivo de logs
entities_list	rutaRuta donde se creara el archivo entities_list (más información sobre este archivo abajo)
transfer_mode	modoModo de ejecución, las dos opciones posibles son local o tentacle
local_folder	rutaRuta de la carpeta donde se crearan los XML de los agentes para el modo de transferencia local (transfer_mode = local)
pandora_url	urlURL de pandora (solo si se requiere usar el modo eventos del plugin)
api_pass	contraseñContraseña de la api de pandora (solo si se requiere usar el modo eventos del plugin)
api_user	usuarioUsuario api de pandora (solo si se requiere usar el modo eventos del plugin)
api_user_pass	contraseñContraseña del usuario de api de pandora (solo si se requiere usar el modo eventos del plugin)
event_mode	paraPara activar ella modomonitorización evento,de eventos del vCenter, se activa con 11. Los eventos son copiados a la lista de eventos de Pandora FMS y pasan a formar parte de su flujo normal (requiere conectividad con el API de la consola de Pandora FMS).
event_pointer_file	rutaRuta donde se guardará el archivo event_pointer_file
tentacle_ip	ipIP de tentacle, requerida si se ejecuta el plugin en transfer modetransfer_mode tentacle
tentacle_port	puertoPuerto de tentacle, por defecto es 41121
tentacle_opts	opcionesOpciones adicionales para la transferencia de ficheros al servidor de Tentacle indicado
virtual_network_monitoring	paraActiva activarla el monitoreomonitorización de switches virtuales con valor 1
use_encrypted_password	para activarActiva el uso de una contraseña encriptada con valor 1
threads	núNúmero de hilos que usará el plugin en la creación de agentes
interval	intervaloIntervalo 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	grupoGrupo donde se van a crear los agentes
use_ds_alias_as_name	para usarActiva el uso del alias del agente de datastore como nombre del agente
all_ipaddresses	paravalor coger las ips en los agentes1
statsinterval	el intervaloIntervalo en segundos para las estadísticas sacadas mediante la opción "custom_performance"
flat_datastore_agents	paraActiva la creación de un único agente principal para los datastores con con nombre "VMWareDatastores" , activar  con valor 1
use_ds_entity_name	usarActiva el uso del nombre del datastoreDatastore como nombre del agente, activaragente con valor 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 activarActivar la monitorización de agentes específicos ( estos se específican en los parámetros de abajo), se activa con valor 1
exclusive_esx	siSi esta activado monitor_exclusive_agent, sirve para especificar los esxi a monitorizar. Su valor será un JSON de tipo array con los agentes a monitorizar
exclusive_datastores	siSi esta activado monitor_exclusive_agent, sirve para especificar los datastore a monitorizar. Su valor será un JSON de tipo array con los agentes a monitorizar
exclusive_vm	siSi esta activado monitor_exclusive_agent, sirve para especificar las vm a monitorizar. Su valor será un JSON de tipo array con los vmagentes a monitorizar
scan_datastore	para activarActiva el escaneo de datastores, se activadatastores con valor 1
scan_datacenter	para activarActiva el escaneo del datacenter, se activadatacenter con valor 1
scan_esx	para activarActiva el escaneo de esx, se activaesx con valor 1
scan_vm	para activarActiva el escaneo de máquinas virtuales, se activavirtuales con valor 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óComprobación de ping a la máquina que admite vCenter
check443	verificació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	capacidadCapacidad máxima del almacén de datos en bytes
freeSpace	porcentajePorcentaje de espacio libre en el almacén de datos
overallocation	porcentajePorcentaje de sobreasignación de disco
freeSpaceBytes	cantidadCantidad de espacio libre en disco en bytes
dsPathStatus	estadoEstado 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	tiempoTiempo que tarda un dispositivo de almacenamiento en responder a una solicitud de lectura de datos
deviceWriteLatency	tiempoTiempo 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	cantidadCantidad de dispositivos PCI asignados
hbaDevice	cantidadCantidad de dispositivos HBA (Host Bus Adapter) asignados a una máquina virtual
pnicInfo	informació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	porcentajePorcentaje de uso actual de la CPU en el host
memoryUsagePercent	porcentajePorcentaje de uso actual de la memoria RAM en el host
diskRate	velocidadVelocidad de transferencia de datos de lectura y escritura en el disco virtual del host
maxDiskLatency	tiempoTiempo máximo de latencia de E/S en el disco virtual del host
netUsage	velocidadVelocidad de transferencia de datos de red en el host
systemHealthInfo	informacióInformación sobre el estado de salud general del sistema.
netReceived	cantidadCantidad de datos recibidos a través de la interfaz de red del host
netTransmitted	cantidadCantidad de datos transmitidos a través de la interfaz de red del host
netPkgRx	cantidadCantidad de paquetes de red recibidos por la interfaz de red del host
netPkgTx	cantidadCantidad de paquetes de red transmitidos por la interfaz de red del host

VM

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

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 bloquenombre de agentes,agente, 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>

unUn ejemplo puede ser el siguiente :

dc dc.DC_
ds ds.DS_
esx esx.ESXi_
vm vm.VM_

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

vm.VM_<nombre_de_agente>

Reject

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

all_ipaddresses

Si se ejecuta este parámetro con 1 se desactivaraDesactiva el escaneo de ipsdireccones deIP loscon agentesvalor 1

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 DataDatacenter, Center, Data Store,Datastore, 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:disabled: El módulo NO se creará
<módulo> activado:enabled: El módulo SÍ se creará (con valores por defecto)
<module> name = <name>; desc = <description>; limits_warn <lim_warn>; limits_crit <lim_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ícrítico y Advertencia.

Tengaadvertencia.

en cuenta que

También es muyposible importanteconfigurar respetarcadenas de texto para los límites de los estados Advertencia y Crítico de los Módulos. La configuración sería parecida a la estructurasiguiente:

powerState name = Estado funcionamiento; desc = Estado funcionamiento VM; limits_warn = .*suspended.*; limits_crit = .*poweredOff.*

Métricas de rendimiento personalizadas

Es posible configurar nuevos módulos relativos a Performance Counters para las líneasmáquinas virtuales y los ESX. Para configurar un nuevo módulo de rendimiento necesitará usar la siguiente estructura dentro de los bloques ESC o VM del fichero de configuración:

custom_performance type = mem; metric = swapinRate; module_type = generic_data; name = Swap In Rate; desc = Swap In Rate for host; limits_warn = 0 0; limits_crit = 0 0

Los parámetros a configurar son:

• type: Tipo de métrica a monitorizar. Los tipos de métrica son:
  • cpu: Característica de la Unidad Central de Procesamiento.
  • mem: Memoria.
  • disk: Disco, almacenamiento.
  • net: Red.
  • sys: Sistema.
• metric: Métrica a monitorizar (más adelante se explica dónde ver las métricas disponibles).
• module_type: Tipo del Módulo de Pandora FMS (por ejemplo: generic_data).
• name: Nombre del Módulo.
• desc: Descripción y,del sobreMódulo.
  todo,
• limits_warn: Límites para el estado Advertencia.
• limits_crit: Límites para el estado Crítico.

Podrá consultar las métricas disponibles para cada tipo en el apartado Performance de cada entidad. Esta vista se encuentra dentro del vCenter y muestra las métricas de rendimiento que es posible monitorizar con el plugin VMware®. Por ejemplo, la siguiente imagen muestra la vista de Performance para un host ESX.

Para ver el listado completo de todas las métricas según su tipo deberá hacer clic en el botón Advanced y luego en el botón Char option. Verá una lista con todos los tipos de métricas y las respectivas métricas de cada tipo:

Para cada tipo de métrica aparecerán una serie de contadores que son las variables que podremos monitorizar con Pandora FMS. Para monitorizar una variable necesitamos su Internal Name. Además debe asegurarse de que el carácter;nivel vade unidoestadísticas, configurado en el vCenter, permite mostrar la variable que buscamos, comparándolo con el campo Collection Level de la métrica.

Por ejemplo, si necesita ver el uso de CPU de un host ESX, buscaremos las variables tipo cpu para un ESX y de las disponibles escogeremos utilization. La línea que tiene que añadir al nombrearchivo yde aconfiguración (en este caso dentro de la descripciósección delESX) módulo.Estasserá dosla líneas NO SON EQUIVALENTES (ver espacios antes del carácter;)siguiente:

custom_performance diskRatetype = cpu; metric = utilization; module_type = generic_data; name = DiskCPU Rate;Utilization; desc = LecCPU Rate/EscUtilization Disk;for ESX; limits_warn = 50 10;0; 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