Difference between revisions of "Pandora: Documentation en: Satellite"
(→Agent creation through Recon Task)
|Line 494:||Line 494:|
=== Agent creation through Satellite_hosts.txt ===
=== Agent creation through Satellite_hosts.txt ===
Revision as of 15:59, 20 May 2020
- 1 Satellite Server
- 1.1 Introduction
- 1.2 Installation
- 1.3 Satellite Server Installation in Linux Systems
- 1.4 Windows Installation
- 1.5 Configuration
- 1.5.1 agent_interval xxx
- 1.5.2 agent_theads xxx
- 1.5.3 xxxxxx_interval xxx
- 1.5.4 xxxxx_retries xxx
- 1.5.5 xxxxx_timeout xxx
- 1.5.6 xxxxx_block xxx
- 1.5.7 xxxxx_threads n
- 1.5.8 log_file /var/log/satellite_server.log
- 1.5.9 recon_task xxxxx[,yyyy]
- 1.5.10 server_ip <ip>
- 1.5.11 recon_mode [icmp,snmp,wmi]
- 1.5.12 recon_community aaa,bbb,ccc...
- 1.5.13 wmi_auth Administrator%password
- 1.5.14 agent_conf_dir <path to agente conf dir>
- 1.5.15 group <grupo>
- 1.5.16 daemon 1|0
- 1.5.17 hostfile <file>
- 1.5.18 pandora_license xxxxxxx
- 1.5.19 remote_config 1|0
- 1.5.20 temporal_min_size
- 1.5.21 xml_buffer
- 1.5.22 snmp_version
- 1.5.23 braa <path to braa>
- 1.5.24 fping <path to fping>
- 1.5.25 fsnmp <path a fsnmp>
- 1.5.26 latency_packets xxx
- 1.5.27 nmap <path to nmap>
- 1.5.28 nmap_timing_template xxx
- 1.5.29 ping_packets xxx
- 1.5.30 recon_enabled 0|1
- 1.5.31 recon_timing_template xxx
- 1.5.32 server_port xxxxx
- 1.5.33 server_name xxxxx
- 1.5.34 server_path xxxxx
- 1.5.35 server_opts
- 1.5.36 transfer_mode XXX
- 1.5.37 Secondary Server
- 1.5.38 snmp_verify 0|1
- 1.5.39 snmp2_verify 0|1
- 1.5.40 snmp3_verify 0|1
- 1.5.41 startup_delay xxx
- 1.5.42 temporal <directory>
- 1.5.43 tentacle_client <path to tentacle_client>
- 1.5.44 wmi_client <path to wmic>
- 1.5.45 snmp_blacklist <path to the blacklist>
- 1.5.46 add_host <IP address> [agent name]
- 1.5.47 ignore_host <agent name>
- 1.5.48 keepalive xxx
- 1.5.49 credential_pass xxx
- 1.5.50 timeout_bin <path to timeout>
- 1.5.51 timeout_seconds xxx
- 1.5.52 proxy_traps_to <address[:port]>
- 1.5.53 proxy_tentacle_from <address[:port]>
- 1.5.54 proxy_tentacle_to <address[:port]>
- 1.5.55 dynamic_inc 0|1
- 1.5.56 vlan_cache_enabled 0|1
- 1.5.57 verbosity <0-10> (Version > 7.0OUM204)
- 1.5.58 agents_blacklist_icmp (Version > 7.0OUM713)
- 1.5.59 agents_blacklist_snmp (Version > 7.0OUM713)
- 1.5.60 agents_blacklist_wmi (Version > 7.0OUM713)
- 1.5.61 general_gis_exec (Version > 7.0OUM734)
- 1.6 Agent creation in Satellite Server
- 1.7 Agent removal in Satellite Server
- 1.8 Custom settings (by agent)
- 1.9 Credential boxes
- 1.10 General view of all agents in the console
- 1.11 SNMP blacklist
1 Satellite Server
The Satellite Server is used for network and remote system both monitoring and discovery. It can discover network elements (routers, switches, etc) using SNMP or ICMP, or Windows servers (using WMI) and Linux servers (using SNMP). This is no "ordinary" server, it can be considered to be agent in broker mode with extended features. It is an exclusive component for the Enterprise version. It is particularly useful to monitor inaccessible remote networks where a software agent is not even an option from Pandora FMS server.
The Satellite server can be used in Windows and Linux (recommended) alike, and it has some features that make it more special, highly recommended in certain environments.
- It can execute network tests (ICMP, Latency and SNMP v1 and v2) at an extremely high pace (500 checks per second).
- It only sends information to the server every X seconds (300 seconds by default), but it can execute latency, ICMP and SNMP tests within a smaller interval (30 seconds for example). That way, it can warn Pandora FMS Server almost instantly when there is a status change. This status changes must have been previously defined if the module type is not a *_proc (network interfaces or general network connectivity for example).
- It does not require connection to the database, rather it is autonomous. It sends all files in XML format the same way as an independent server, similar to a broker agent or an export server.
- It has an auto-discovery system for SNMP and WMI. It creates detected agents (by IP address), it detects dynamic elements (network interfaces, storage) and monitors them automatically.
- In Windows systems, it can detect hard drives, CPUs, and memories.
- In systems with SNMP, it can detect interface status, inbound and outbound traffic for each interface and the name of the system.
- Auto-genarated modules can be modified, like every other module, managing the agent from the console as if it was an ordinary agent (in Mass operations menu > Satellite).
- Agents can be created manually by creating an agent configuration file in the Satellite server directory for agent configuration files (explained later on).
It is difficult to pinpoint the maximum capacity of the Satellite, as it depends entirely on the server running and the type of checks you want to perform. In the test environment, 500 checks ICMP/SNMP per second have been made, but that depends a lot on the response times of remote devices (it is not the same a device which answers in 0.5ms than one that takes 2 seconds to answer back). Under ideal conditions, an amount of 150,000 checks could be monitored with a single Satellite server. In real conditions, it has been tested in controlled environments (LAN) made of about 50,000 modules with a single Satellite server in a low-end computer hardware (Intel i5, 2GZ, 4GB RAM).
IF THERE ARE MANY CRITICAL MODULES, THE PERFORMANCE WILL BE AFFECTED. Take into account the configured timeout, since there is only one check for each critical monitor for timeout. If there are 1000 critical modules and the timeout is configured to 4 seconds, it will take 4000 seconds to execute all the checks with only one thread.
The Satellite Server is distributed as tarball (Linux) or .exe (Windows), so it is not necessary to install Perl or any additional library. It works the same in Windows or Linux versions. In Windows systems, it is installed as a service, and in Linux systems, it is installed as a daemon. The configuration file and specifications in both cases are the same.
Satellite server Linux version depends on external packages that are specified in the corresponding version of this documentation.
1.3 Satellite Server Installation in Linux Systems
Once downloaded the binary witch contains the Satellite server, go to the download directory with root privileges and unzip the binary:
tar -xvzf pandorafms_satellite_server_X.XNG.XXX_x86_64.tar.gz
Then, a folder called satellite_server will be created. Get in typing:
Before proceeding with the installation, these are the main dependencies of the Satellite server: fping, nmap, wmic y braa.
It is also necessary for server execution to have installed Perl in the device. It can be installed with the following command:
yum install perl.}}
In the installer, Braa and Wmic dependencies are included. Fping and Nmap must be installed independently.
To install the Satellite Server we can just execute the installing command:
Once finished, edit the satellite_server.conf file (located in /etc/pandora/satellite_server.conf), look for the token pandora_license, uncomment it and enter the Pandora FMS server license. Afterwards, save the file and activate the service executing this:
sudo /etc/init.d/satellite_serverd start
In case of failure, take a look at the satellite_server.log file, located in /var/log/satellite_server.log.
1.4 Windows Installation
The installation process in Windows can be carried out following the images shown below:
Start by choosing the installation language:
Click on Next
Choose where to install the program:
WinPCap installation is required. The installation window will appear at this step of the installation process:
Then configure WinPCap to start when system starts.
Once WinPCap installation is finished, this window will appear:
Enter the Pandora FMS license number to continue the installation:
Then, set the Pandora FMS server address to send data. Define the network recon rules for Satellite server:
At the end, restart the system so that all changes are applied.
Once ther process is finished, start and stop the Satellite server from the Start menu.
1.4.1 WMI module operation in some Windows versions
For Windows security reasons, some versions have limited users who can remotely query WMI. If these queries were not carried out, the solution would be to run the service Satellite server as an Administrator user.
The process to follow is:
Right click on the service and go to Properties:
On the Log In window, select an account with Administrator permissions and apply changes:
Finally, restart the service.
All parameters that require a timeout or some time are specified in seconds, for example 300 = 5 minutes.
It is important to keep in mind that the latency and snmp intervals are specific for the status change. In case of Boolean checks (port or machine status) the threshold that defines the status change is automatic. For numerical values (latency, network traffic in an interface, disk space, CPU, etc), it is based an a threshold that must be defined in each module.
1.5.1 agent_interval xxx
300 seconds by default (5 minutes), it creates agents with a 5 minute interval. After that time, information is sent to the server. Regardless of checks done by the network server having a lower interval.
1.5.2 agent_theads xxx
Number of threads used for sending agent XML data files.
1.5.3 xxxxxx_interval xxx
It executes all checks (latency, snmp, etc) every xxx seconds. If the collected data is different compared to the previous one, it sends it instantly. If it is the same, it will send it when the agent interval says so. It is useful to perform intesive checks and notify only in case of status change.
1.5.4 xxxxx_retries xxx
Number of retries in checks (latency, snmp, ping...).
1.5.5 xxxxx_timeout xxx
Timeout in seconds for SNMP, Latency and Ping checks.
1.5.6 xxxxx_block xxx
It forces the server to execute checks into blocks of XXX checks. The higher the number (500 tops) the more capacity it will have, but at the expense of an increased latency. Sometimes, it might be recommended to lower that number (latency, ping and snmp).
1.5.7 xxxxx_threads n
Number of assigned threads to every type of check. It depends on the capacity (CPY and RAM) of the machine. The higher the threads, the higher the load on the machine but the processing capacity will be higher. The performance may become poor when exceeding 20 threads, depending on each system.
1.5.8 log_file /var/log/satellite_server.log
It indicates the file where the Satellite server log is written, by default the path is /var/log/satellite_server.log.
1.5.9 recon_task xxxxx[,yyyy]
IP networks and addresses for autodiscovery separated by commas, for example:
1.5.10 server_ip <ip>
IP address or DNS name of Pandora FMS Server where the information is sent. It is done using the Tentacle protocol, so communication with the system must be possible through Tentacle port (port 41121/tcp).
1.5.11 recon_mode [icmp,snmp,wmi]
Autodiscovery mode. The system will use the following protocols to discover systems:
- ICMP: It will just check whether the host is alive (ping) and measure latency time.
- SNMP: If it is capable of communicating by SNMP (only v1 and v2), it will look for all the interfaces and get its trafic from all of them, as well as its operative status and device name and location. It will try different communities provided in the configuration file to connect.
- WMI: Similar to the previous case, but in this case showing CPU usage, memory and hard drives (all available ones).
1.5.12 recon_community aaa,bbb,ccc...
It states a list of SNMP communities to be used in SNMP discovery, separated by commas. It will use this list in SNMP exploration: for each IP found, it will try to see whether it answers to any of these communities.
1.5.13 wmi_auth Administrator%password
It specifies a list of User%Password pairs, e.g: admin%1234,super%qwerty. This list is used in WMI discovery. For each IP found, it will try to see whether it answers to any of these combinations.
1.5.14 agent_conf_dir <path to agente conf dir>
In this directory, configuration files of each agent discovered by the satellite server are automatically created, it is /etc/pandora/conf by default. They may also be manually created, as explained later on.
1.5.15 group <grupo>
It specifies the default group for agents created by the Satellite Server. For instance: "Servers".
1.5.16 daemon 1|0
When set to 1, it starts the daemon in the background (by default).
1.5.17 hostfile <file>
It is an alternative/complementary method for network scanning. A file is provided with an adress in each line. It can include the hostname followed by the IP as well, so that the agent created bears that name and uses that IP for modules (e.g. 126.96.36.199 hostname). It must be possible to send and fping to those addresses for them to be valid.
1.5.18 pandora_license xxxxxxx
Type in there the Pandora FMS server license number, as it appears in the Setup->Licence section in Pandora FMS console. It may use the same licence in as many Satellite servers as you need, since the total amount of agents that use the licence is verified in Pandora FMS server, not in the Satellite.
1.5.19 remote_config 1|0
It enables remote configuration in detected agents by default. It is mandatory if you wish yo manage them from the console after detecting them. It also activates Satellite server remote configuration. To find out more, see Remote configuration.
If the free space (in MB) in the partition where the temporary directory is located is smaller than this value, data packages are not generated anymore. It prevents the disk from becoming full if the connection with the server is lost during an extended interval for some reason.
The default value is '0'. If set to '1', the agent will save any XML data files that could not be sent to retry it later on.
In a safe UNIX environment, consider changing the temporal directory, '/tmp' gives writting permissions to all users.
SNMP version to use by default (only 1 and 2c are supported). 1 by default.
1.5.23 braa <path to braa>
Path to the braa binary (/usr/bin/braa by default).
1.5.24 fping <path to fping>
Path to the fping binary (/usr/sbin/fping by default).
1.5.25 fsnmp <path a fsnmp>
Path to the SNMP binary(/usr/bin/pandorafsnmp by default).
1.5.26 latency_packets xxx
Number of ICMP packets to send per latency request.
1.5.27 nmap <path to nmap>
Path to the nmap binary (/usr/bin/nmap by default).
1.5.28 nmap_timing_template xxx
A value that specifies how aggressive nmap should be from 1 to 5. 1 means slower but more reliable, 5 means faster but less reliable. 2 by default.
1.5.29 ping_packets xxx
Number of ICMP packets to send per ping request.
1.5.30 recon_enabled 0|1
It enables (1) or disables (0) host auto-discovery.
1.5.31 recon_timing_template xxx
Like nmap_timing_template, but applied to network scans.
1.5.32 server_port xxxxx
Tentacle server port.
1.5.33 server_name xxxxx
Satellite server name (by default the machine's hostname).
1.5.34 server_path xxxxx
Path where the XML files are copied when the transfer_mode is in local (by default /var/spool/pandora/data_in).
Server parameters passed to the Tentacle.
1.5.36 transfer_mode XXX
File transfer mode. It can be Tentacle or local (by default Tentacle).
1.5.37 Secondary Server
An special kind of general configuration parameter is the definition of a secondary server. This allows defining a server to send data to, in a complementary way to the server defined the standard way. The secondary server mode works in two different ways:
- on_error: It sends data to the secondary server only when it cannot send them to the primary one.
- always: It always sends data to the secondary server, both if it can contact the main server or not.
secondary_server_ip 192.168.1.123 secondary_server_path /var/spool/pandora/data_in secondary_mode on_error secondary_transfer_mode tentacle secondary_server_port 41121
1.5.38 snmp_verify 0|1
It enables (1) or disables (0) the verification of SNMPv1 modules that make braa fail in real time. These modules will be discarded and stop being executed.
1.5.39 snmp2_verify 0|1
It enables (1) or disables (0) the verification of SNMPv2 module that make braa fail in real time. These modules will be discarded and stop being executed.
1.5.40 snmp3_verify 0|1
It enable (1) or disables (0) the verification of SNMPv3 modules that make braa fail in real time. These modules will be discarded and stop being executed.
1.5.41 startup_delay xxx
It waits xxx seconds before sending XML data files for the first time.
1.5.42 temporal <directory>
Temporal directory where XML files are created, /tmp by default.
1.5.43 tentacle_client <path to tentacle_client>
Full path to the Tentacle client (/usr/bin/tentacle_client by default).
1.5.44 wmi_client <path to wmic>
Full path to the wmic (/usr/bin/wmic by default).
1.5.45 snmp_blacklist <path to the blacklist>
Path to the SNMP module blacklist file (/etc/pandora/satellite_server.blacklist by default).
1.5.46 add_host <IP address> [agent name]
It adds the given host to the list of monitored agents. The name for the agent can be specified after the IP address. Multiple hosts may be added, one per line. For example:
add host 192.168.0.1 add host 192.168.0.2 localhost.localdomain
1.5.47 ignore_host <agent name>
It removes the given host from the list of monitored agents, even if it is found in a network scan by a recon task. The host must be identified by agent name. Multiple hosts may be ignored, one per line. For example:
ignore host 192.168.0.1 ignore host localhost.localdomain
1.5.48 keepalive xxx
Satellite Server reports its status and checks remote configuration changes (from agents and its own) every keepalive seconds. It is 30 seconds by default.
1.5.49 credential_pass xxx
Password used to encrypt credential box passwords. It must match the one defined in Pandora FMS console. The hostname is used by default.
1.5.50 timeout_bin <path to timeout>
If defined, the timeout program (usually /usr/bin/timeout) will be used to call the Tentacle client.
1.5.51 timeout_seconds xxx
Timeout in seconds for the timeout command. The timeout_bin parameter must be configured.
1.5.52 proxy_traps_to <address[:port]>
It redirects SNMP traps received by the Satellite server to the given address (and port). Port 162 is used by default.
1.5.53 proxy_tentacle_from <address[:port]>
It redirects data received by Tentacle server from the specified address and port. Port 41121 is used by default.
1.5.54 proxy_tentacle_to <address[:port]>
It redirects Tentacle client requests received by the Satellite Server to the given address (and port). Port 41121 is used by default.
This option may be in conflict with remote agent configuration.
This happens if the Satellite server is intended to be used as proxy for some software agents and monitor them remotely from the Satellite server itself (ICMP, SNMP, etc.) and remote configuration is enabled in both cases.
In this situation, it is necessary to either use different agents for the performed checks (i.e. with different agent_name), or leave the remote configuration enabled only on one of them (Satellite Server or software agents).
1.5.55 dynamic_inc 0|1
Set to 1 to move dynamic auto-discovered modules (SNMP, WMI...) to separate files so that they do not interfere with remote agent configuration.
1.5.56 vlan_cache_enabled 0|1
It enables (1) or disables (0) the VLAN cache in the auto-discovered hosts.
1.5.57 verbosity <0-10> (Version > 7.0OUM204)
Log verbosity level from 0 (less verbose) to 10 (more verbose).
1.5.58 agents_blacklist_icmp (Version > 7.0OUM713)
ICMP check blacklist. This field can be configured with a list of IPs, using CIDR notation to prevent ICMP-type modules from running. To specify multiple subnets, separate them with commas.
1.5.59 agents_blacklist_snmp (Version > 7.0OUM713)
SNMP check blacklist. This field can be configured with a list of IPs, using CIDR notation to prevent SNMP-type modules from running. Specify multiple subnets by separating them with commas.
1.5.60 agents_blacklist_wmi (Version > 7.0OUM713)
WMI Check blacklist. This field can be configured with a list of IPs, using the CIDR notation to prevent WMI-type modules from running. Specify multiple subnets by separating them with commas.
1.5.61 general_gis_exec (Version > 7.0OUM734)
GIS positioning script for all agents detected by the Satellite server. The script must be executable and must print on screen the coordinates with the format <longitude>,<latitude>[,<altitude>]. The third parameter, latitude, is optional.
1.6 Agent creation in Satellite Server
There are three ways of creating an agent in the Satellite server: Recon Task, Satellite_hosts.txt file, or manually creating the .conf of the agents to monitor.
1.6.1 Agent creation through Recon Task
The creation of agents through Recon Task is the most used by PandoraFMS users. To be able to do it, go to the Satellite server configuration file and set the following parameters:
- recon_community: Specify a list of SNMP communities to use in SNMP discovery separated by commas (in case of performing a recon of the SNMP type).
- recon_enabled: It must be set to 1 to enable the recon task of the Satellite server.
- recon_interval: Time interval where a certain network is scanned, in seconds (604800 seconds by default, 7 days).
- recon_mode:Recon task mode (snmp,icmp,wmi) separated by commas.
- recon_task: List of networks to be recognized, separated by commas.
- recon_timing_template: A value that specifies how aggressive nmap must be, from 1 to 5. 1 means slower but more reliable, 5 means faster but less reliable (3 by default).
An example of Recon Task would be:
recon_community public recon_enabled 1 recon_interval 604800 recon_mode icmp,snmp,wmi recon_task 192.168.0.0/24,192.168.1.0/24 recon_timing_template 3
Once the data has been configured, run the satellite server using the command:
1.6.2 Agent creation through Satellite_hosts.txt
First, in order to create an agent through the satellite_hosts.txt file, go to the configuration file of the Satellite server and uncomment the line:
Secondly, create the file satellite_hosts.txt with the IP of the host that you wish to create by entering IP and name of the agent to create:
192.168.10.5 Server.5 192.168.10.6 Server.6 192.168.10.7 Server.7
In order for these IPs to be created, it is necessary to be able to make the fping call to each one of the IPs in the list, otherwise it will not be created.
Once the data has been configured, run the satellite server using the command:
The reading of the indicated file is done every "recon_interval" seconds.
1.6.3 Manual Agent Creation
Firstly, look at the configuration file of the Satellite server in the parameter agent_conf_dir, which is where the new agent configuration files are created (/etc/pandora/conf).
Once this path is located, create a .conf file of the agents you wish to create, taking for example the server agent as example, and manually filling in the following fields:
- agent_name: Agent name.
- agent_alias: Agent alias.
- address: IP of the element to monitor.
- group: Group to assign the agent to.
- gis_exec: Positioning script (optional). It overwrites the general_gis_exec location of the Satellite server.
- Modules to be monitored by the agent.
An example would be:
agent_name Example1 agent_alias It is an example address X.X.X.X group Servers module_begin module_name Ping module_ping module_end module_begin module_name Latency module_latency module_end
Once the data has been configured, run the Satellite server using the command:
1.7 Agent removal in Satellite Server
There are several cases regarding agent removal from the Satellite server: total agent removal of partial agent removal.
For agent total removal, take into account the method used in agent creation.
- Manual: First remove the .conf files from the agents created in the /etc/pandora/conf folder and then remove the agents in the console.
- Satellite_hosts.txt file: Delete the file .txt, as well as the .conf that have been created in the folder /etc/pandora/conf and later delete the agents from the console.
- Recon_task: Deconfigure the recon_task in the conf file of the Satellite server, then remove the conf created in the folder /etc/pandora/conf and then remove the agents from the console.
For agent partial removal also take into account the method used in the agent creation.
- Manual: First of all, remove the .conf files from the agents you wish to delete in the /etc/pandora/conf folder and then remove the agents from the console.
- Satellite_hosts.txt file: Delete the lines of the IPs from the file.txt, as well as the conf that have been created in the folder /etc/pandora/conf with those IPs and then delete the agents from the console.
- Recon_task: Configure the blacklist of the recon_task in the conf file of the Satellite server, then remove the .conf created in the folder /etc/pandora/conf with those IPs and then remove the agents in the console.
1.8 Custom settings (by agent)
In addition to "automatic" modules, all kinds of available TCP, SNMP or WMI tests can be added, using a similar syntax to the local modules in software agents. Here are some module examples valid for Satellite server, just as they are autogenerated after being detected by the system.
Interface status through SNMP. The Satellite server detects automatically each interface.
module_begin module_name if eth1 OperStatus module_description IP address N/A. Description: The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. module_type generic_data_string module_snmp 192.168.70.225 module_oid .188.8.131.52.184.108.40.206.1.8.3 module_community artica06 module_end
To force the module to use SNMP version 2c, add the line:
To force the module to use SNMP version 1, add the line:
module_begin module_name if eth1 OperStatus module_description IP address N/A. Description: The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. module_type generic_data_string module_snmp 192.168.70.225 module_version 2c module_oid .220.127.116.11.18.104.22.168.1.8.3 module_community artica06 module_end
Conectivity to a machine (using PING)
module_begin module_name ping module_type generic_data module_ping 192.168.70.225 module_end
Port check (using TCP)
module_begin module_name Port 80 module_type generic_proc module_tcp module_port 80 module_end
General SNMP check. In this case, the server retrieves automatically the traffic from each interface with its"real" descriptive name.
module_name if eth0 OutOctets module_description The total number of octets transmitted out of the interface, including framing characters. module_type generic_data_inc module_snmp 192.168.70.225 module_oid .22.214.171.124.126.96.36.199.1.16.2 module_community artica06 module_end
CPU WMI usage check (percentage).
module_begin module_name CPU module_type generic_data module_wmicpu 192.168.30.3 module_wmiauth admin%none module_end
Memory free WMI check (percentage).
module_begin module_name FreeMemory module_type generic_data module_wmimem 192.168.30.3 module_wmiauth admin%none module_end
General WMI Query
module_begin module_name GenericWMI module_type generic_data_string module_wmi 192.168.30.3 module_wmiquery SELECT Name FROM Win32_ComputerSystem module_wmiauth admin%none module_end
Generic SSH command (version > 6.0)
module_begin module_name GenericSSH module_type generic_data module_ssh 192.168.30.3 module_command ls /tmp | wc -l module_end
To add a threshold, do it both in the module's text definition and threshold definition in the web interface (module_min_warning, module_min_critical). For example:
module_begin module_name latency module_type generic_data module_latency 192.168.70.225 module_min_warning 80 module_min_critical 120 module_end
Execution modules can be created manually. The scripts or commands executed by the Satellite server must be previously established and available for the server to use. The use of module_exec can make the performance of the Satellite server to become poor.
module_begin module_name Sample_Remote_Exec module_type generic_data module_exec /usr/share/test/test.sh 192.168.50.20 module_min_warning 90 module_min_critical 95 module_end
From Pandora FMS version 7 on, plugins can be added. Like those, note that the plugins will run on the machine where the Satellite server is running. Therefore, it will be necessary to implement in these plugins some method to connect to the remote computer you wish to monitor. The advantage over the previous ones is their great flexibility. In this way, preconditions and other mechanisms for which a module_exec falls short can be implemented. The syntax is the same as that of the agents. An example of using a plugin might be as follows:
module_plugin /usr/share/pandora/remote_advanced_checks.sh 192.168.0.1
To configure an SNMPv3 module, set module_version to 3 and specify the security level (noauth, authnopriv or authpriv), security name, authentication protocol (md5 or sha), authentication password, privacy protocol (aes or des) and privacy password as required. For example:
module_begin module_name snmp_noauth module_type generic_data_string module_snmp 127.0.0.1 module_version 3 module_oid .188.8.131.52.184.108.40.206.0 module_seclevel noauth module_secname snmpuser module_end
module_begin module_name snmp_authnopriv module_type generic_data_string module_snmp 127.0.0.1 module_version 3 module_oid .220.127.116.11.18.104.22.168.0 module_seclevel authnopriv module_secname snmpuser module_authproto md5 module_authpass 12345678 module_end
module_begin module_name snmp_authpriv module_type generic_data_string module_snmp 127.0.0.1 module_version 3 module_oid .22.214.171.124.126.96.36.199.0 module_seclevel authpriv module_secname snmpuser module_authproto sha module_authpass 12345678 module_privproto aes module_privpass 12345678 module_end
SNMPv3 specific configuration can be shared between modules by placing it outside the module declaration, in case it is the same for all of them (it can also be shared between agents by moving it to the Satellite's configuration file):
agent_name snmp address 127.0.0.1 seclevel authpriv secname snmpuser authproto md5 authpass 12345678 privproto des privpass 12345678 module_begin module_name snmp_authpriv_1 module_type generic_data_string module_snmp module_version 3 module_oid .188.8.131.52.184.108.40.206.0 module_end module_begin module_name snmp_authpriv_2 module_type generic_data_string module_snmp module_version 3 module_oid .220.127.116.11.18.104.22.168.0 module_end
1.9 Credential boxes
Unless key-based authentication is properly configured, SSH modules require a username and a password in order to work. These are configured in the main configuration file, satellite_server.conf, using credential boxes with the following format:
credential_box network/mask,username,password credential_box network/mask,username,[[encrypted password]]
credential_box 192.168.1.1/32,user,pass1 credential_box 192.168.1.0/24,user,pass2
Credential boxes are searched from more restrictive to less restrictive masks.
Passwords can be encrypted using Blowfish in ECB mode. Make sure credential_pass is defined, otherwise the hostname will be used as the default encryption password. The hexadecimal representation of the ciphertext should be enclosed in double brackets:
1.10 General view of all agents in the console
If the configuration of the satellite server is correct, you should an aent view similar to this one:
Generally, in all machines ICMP (Ping and Latency) modules will be created, but in some machines SNMP and WMI modules can be created. In machines where WMI is enabled, the following modules will be generated if available:
In machines with SNMP enabled, the following modules will be generated if available:
In the massive operations menu of the Pandora FMS console, there is a specific section for the Satellite server where different edition and deletion actions can be performed on agents and modules massively.
1.11 SNMP blacklist
When monitoring big networks, SNMP modules that return invalid data may affect the performance of the Satellite server and many modules may become Unknown. To avoid that, the Satellite Server can read a blacklist of SNMP modules that will be discarded at startup before execution.
To create a new blacklist, edit the /etc/pandora/satellite_server.conf configuration file and make sure snmp_blacklist if uncommented and configured with the path of the file where blacklist modules are saved. Then run:
satellite_server -v /etc/pandora/satellite_server.conf
Restart the Satellite server. The blacklist can be regenerated as many times as needed.
The format of the blacklist file is:
agent:OID agent:OID ...