Skip to main content

Configuration

# Launch a pre-command before invoke docker commands
pre_command = eval $(docker-machine env ml1)
docker = docker
# Log file
log_file = /tmp/pandora_docker.log
# Show all modules instead only those with values
all_modules = 1

pre_command
Configures an environment preload command prior to executing commands to extract information. Set the following content if using docker_machine : pre_command = eval $(docker-machine env node_name)
docker
Location of the complete docker binary, if it exists in the system PATH you can leave the default value 'docker'.
log_file
Location and name of the log file to be used by the plugin
all_modules

As many modules will be generated as possible states exist for the tasks with their respective value if this parameter is active (1). If it is deactivated (0), only the modules of tasks whose status has been reached will be shown. For example, if we have the parameter deactivated and the number of tasks in pending status is 0, this module will not be shown.

General configuration

# Agent configuration
agent_interval = 300
agent_group = Unknow
agent_group_id = 10
# Module interval
module_interval = 1
#module_tags = docker,services
module_group = Docker
# Pandora API configuration
api_url = http://nova.lab.artica.lan/pandora_console/include/api.php
api_user = admin
api_user_pass = pandora
api_pass = pandora
# Pandora FMS API flow process timeout (seconds)
api_timeout = 10
api_retries = 3

agent_interval
Sets the agent interval value.
agent_group
Sets the group of the agents and cluster views that will be created in Pandora FMS Console.
agent_group_id
Set manually an id to the group.
module_interval
It is a multiplicative factor of the agent interval value. It defines the execution interval of the modules. It will avoid that the modules go to unknown if we have that the plugin execution interval is bigger than the agent interval.
module_tags
Defines the list of tags that will be applied to the modules generated by the plugin. They should be previously defined in Pandora FMS.
module_group
Defines the module group in which the modules generated by the plugin will be classified. It must be previously defined in Pandora FMS.
api_url
Defines the url where to access to the Pandora FMS console API.
api_user
Defines the user with access to the API.
api_user_pass
Password of the user with access to the API.
api_pass
Pandora FMS console API password.
api_timeout
Sets the maximum time the plugin will spend trying to retrieve information from the Pandora FMS API.
api_retries
Sets the maximum number of retries in Pandora FMS API calls.

Execution modes and data transfer

# Pandora Server configuration
mode = tentacle
tentacle_ip = nova.lab.artica.lan
tentacle_port = 41121
tentacle_opts =
tentacle_client = tentacle_client
local_folder = /var/spool/pandora/data_in
temp = /tmp

mode
XML file transfer mode, can be:
● local: copies the files to local_folder
● tentacle: transfer the files to tentacle_ip via tentacle_port
tentacle_ip
IP address or FQDN where Pandora FMS is working.
tentacle_port
Port where the Tentacle service associated to your Pandora FMS server is listening.
tentacle_opts
Extra options for the Tentacle client.
tentacle_client
Path where to find the tentacle client binary.
local_folder
Location to move files to in local mode.
temp
Temporary location to store files before sending them.