Skip to main content

Parameters and configuration

Parameters

--generate_password To generate an encrypted password (if this password is to be used later for connection, it must be entered in the configuration option "password" and the option "use_encrypted_password" must also be activated in the configuration file with 1.
--as_discovery_plugin Option to use it in discovery mode.

Configuration blocks

The configuration file is divided into the following blocks

  • Configuration
  • Datacenter
  • Datastore
  • ESX
  • VM
  • Rename
  • Reject
  • Header

Each of the blocks is specified in the configuration file by entering its parameters below these blocks, for example :

Configuration
server 192.168.100.105
user pandorafms
pass P@$5w0rd!
datacenter ha-datacenter

Each block and its options are detailed below:

Configuration

Under the configuration block you can specify the following parameters

Global configuration

server Name or IP of the server to monitor
user Account user
pass Account password
datacenter  Datacenter where the plugin will point to
temporal Path where temporary files will be stored
logfile Path where the log file will be stored
entities_list Path where the entities_list file will be created (more information about this file below)
transfer_mode Execution mode, the two possible options are local or tentacle
local_folder Path of the folder where the XML of the agents will be created for the local transfer mode (transfer_mode = local)
pandora_url

pandora URL (only if required to use the event mode of the plugin)

api_pass pandora api password (only if required to use the plugin event mode)
api_user pandora api user (only if required to use plugin events mode)
api_user_pass Pandora api user password (only if required to use plugin event mode)
event_mode To activate the vCenter event monitoring, it is activated with 1. The events are copied to the Pandora FMS event list and become part of its normal flow (requires connectivity with the Pandora FMS console API).
event_pointer_file Path where the event_pointer_file file will be saved.
tentacle_ip tentacle IP, required if the plugin is executed in transfer_mode tentacle
tentacle_port Tentacle port, default is 41121
tentacle_opts Additional options for file transfer to the specified Tentacle server
virtual_network_monitoring Enables monitoring of virtual switches with value 1
use_encrypted_password Enables use of an encrypted password with value 1
threads Number of threads to be used by the plugin in agent creation
interval Interval in seconds in which the plugin agents are created
recon_interval Interval in seconds after which the temporary entity cache file will be automatically deleted to rescan the VMware® infrastructure.
group Group where the agents will be created
use_ds_alias_as_name Triggers the use of datastore agent alias as agent name with value 1
statsinterval Interval in seconds for statistics taken using the "custom_performance" option
flat_datastore_agents Triggers creation of a single agent for datastores with name "VMWareDatastores" with value 1
use_ds_entity_name Enables use of Datastore name as agent name with value 1

Control parameters of monitorable elements

monitor_exclusive_agents Enable the monitoring of specific agents (these are specified in the parameters below) with value 1
exclusive_esx If monitor_exclusive_agent is enabled, it is used to specify the esxi to monitor. Its value will be an array JSON with the agents to monitor
exclusive_datastores  If monitor_exclusive_agent is enabled, it is used to specify the datastores to monitor. Its value will be an array type JSON with the agents to monitor
exclusive_vm If monitor_exclusive_agent is enabled, it is used to specify the vm to monitor. Its value will be an array type JSON with the agents to monitor
scan_datastore Activates datastore scanning with value 1
scan_datacenter Triggers datacenter scan with value 1
scan_esx Triggers esx scan with value 1
scan_vm Triggers virtual machine scan with value 1

Datacenter

Module activation or deactivation parameters

The following modules can be enabled or disabled in the configuration file using "enabled" or "disabled".

ping Checking ping to the machine that supports vCenter
check443 Checking port 443 on the machine that supports vCenter

Datastore

Module activation or deactivation parameters

The following modules can be enabled or disabled in the configuration file using "enabled" or "disabled".

capacity Maximum capacity of the datastore in bytes
freeSpace Percentage of free space on the datastore
overallocation Percentage of disk overallocation
freeSpaceBytes Amount of free disk space in bytes
dsPathStatus Datastore path status


 ESX

Module activation or deactivation parameters

The following modules can be enabled or disabled in the configuration file using "enabled" or "disabled".

diskRead Kb/s disk read rate
diskWrite Rate of Kb/s written from disk
kernelReadLatency Disk read latency in milliseconds
kernelWriteLatency Disk write latency in milliseconds
deviceReadLatency Time it takes for a storage device to respond to a data read request
deviceWriteLatency Time it takes for a storage device to respond to a data write request
cpuInfo General CPU information (creates a module for each ESXi CPU)
pciDevice Number of assigned PCI devices
hbaDevice Number of HBA (Host Bus Adapter) devices assigned to a virtual machine
pnicInfo Information related to the physical network adapters (PNICs) that are configured on the ESXi host
vnicInfo Information about the virtual network interfaces of the host
cpuUsagePercent Percentage of current CPU usage on the host
memoryUsagePercent Percentage of current RAM usage on the host
diskRate Read and write data transfer rate on the host virtual disk
maxDiskLatency Maximum I/O latency time on the virtual disk of the host
netUsage Network data transfer rate on host virtual disk
systemHealthInfo Information about the general health status of the system
netReceived Amount of data received through the host network interface. netTransmitted Amount of transmitted data
netTransmitted Amount of data transmitted over the host network interface
netPkgRx Number of network packets received over the host network interface. netPkgTx Number of network packets received over the host network interface
netPkgTx Number of network packets transmitted over the host network interface

VM

Module activation or deactivation parameters

The following modules can be enabled or disabled in the configuration file using "enabled" or "disabled".

virtualImagePath Path of the virtual disk image associated with a particular virtual machine
toolsRunningStatus Running status of VMware Tools on a virtual machine
host hosting the virtual machines in a virtualization environment
connectionState Connection status between a virtual machine and its ESXi host in a virtualization environment
guestState State of the virtual machine in terms of its operating system and running applications
guestOS Operating system running on the virtual machine
hostName Name of the physical host on which the virtual machine is running
powerState Displays whether the virtual machine is powered on or off
triggeredAlarmState Displays the status of the alarms triggered in the virtual machine
bootTime Displays the date and time the virtual machine started
vcpuAllocation Number of virtual CPUs allocated to the virtual machine
cpuAllocation Number of CPU resources assigned to the virtual machine
consumedOverheadMemory Amount of memory used by the host to perform tasks related to the virtual machine
hostMemoryUsage Amount of memory used by the host to perform tasks related to the virtual machine
maxCpuUsage Maximum CPU usage in the virtual machine
maxMemoryUsage Maximum memory usage in the virtual machine
memoryMBAllocation Amount of RAM memory allocated to the virtual machine
memoryAllocation Amount of memory allocated to the virtual machine
uptimeSeconds Total time that the virtual machine has been running
memoryOverhead Amount of memory used by the host for monitoring and management tasks of the virtual machine

overallCpuDemand

Total number of CPU resources requested by the virtual machine

overallCpuUsage

Total amount of CPU resources used by the virtual machine

privateMemory

Amount of memory used by the virtual machine for its private processes

sharedMemory

Amount of memory shared between the virtual machine and the host

diskUsed

Amount of space used on the virtual disk of the virtual machine

provisioningUsed

Amount of space used in the virtual machine's provisioning storage

macAddress

MAC address assigned to the virtual machine's network interface

ipAddress

IP address assigned to the virtual machine's network interface

heartbeat

State of the virtual machine's heartbeat

cpuReady

Amount of time the virtual machine is waiting for the CPU

snapshotCounter

Number of snapshots created for the virtual machine
totalReadLatencyTotal latency time for reading the virtual disk of the virtual machine
totalWriteLatencyTotal write latency time of the virtual disk of the virtual machine
cpuUsagePercentPercentage of current CPU usage in the virtual machine
memoryUsagePercentPercentage of current RAM memory usage in the virtual machine
diskRateData transfer rate of reading and writing data on the virtual disk of the virtual machine
maxDiskLatencyMaximum I/O latency time on the virtual disk of the virtual machine
netUsageNetwork data transfer rate in the virtual machine
systemHealthInfoInformation about the overall system health status
netReceivedAmount of data received through the virtual machine's network interface
netTransmittedAmount of data transmitted through the virtual machine's network interface
netPkgRxNumber of network packets received through the virtual machine's network interface
netPkgTxNumber of network packets transmitted over the virtual machine's network interface
snapshotCounterNumber of snapshots of the virtual machine
snapshotDateDate of each snapshot