Installation of Pandora FMS EndPoint

See also:

Online Pandora FMS Endpoint installation.

Automatic EndPoint deployment.

Configuration of EndPoints.

EndPoints may run on any computer with the minimum required operating system, any of the following are valid:

In addition, in UNIX environments, the following must be installed:

• Perl 5.8 or later.
• It will also be necessary to install the following dependencies:

perl-YAML-Tiny-1.73-2
perl-Sys-Syslog
unzip

• Configure logrotate:

cat> /etc/logrotate.d/pandora_agent <<EO_LRA
/var/log/pandora/pandora_agent.log {
        su root apache
        weekly
        missingok
        size 300000
        rotate 3
        maxage 90
        compress
        notifempty
        copytruncate
}

EO_LRA

chmod 0644 /etc/logrotate.d/pandora_agent

Download and install it through:

dnf install -y https://packages.pandorafms.com/pandorafms/latest/pandorafms_one_agent_linux_bin-latest.el9.x86_64.rpm

The installation package installs the following dependencies:

perl wget curl perl-Sys-Syslog unzip libnsl libxcrypt-compat

These dependencies are required and, if necessary, must be installed separately.

For uninstalling, see the corresponding section.

Dependency installation:

yum install dnf-plugins-core -y
yum config-manager --set-enabled powertools -y
yum install -y perl-YAML-Tiny perl-Sys-Syslog unzip

If you use option server_ssl, install the following dependencies:

yum install perl-IO-Socket-SSL -y

EndPoint Installation:

yum install -y https://packages.pandorafms.com/pandorafms/latest/pandorafms_one_agent_linux_bin-latest.el8.x86_64.rpm

For uninstalling, see the corresponding section.

Dependency installation:

yum install dnf-plugins-core -y
yum install -y perl-YAML-Tiny perl-Sys-Syslog unzip

If you are going to use option server_ssl, install the following dependencies, enter in the terminal:

yum install perl-IO-Socket-SSL -y

EndPoint installation:

yum install -y https://packages.pandorafms.com/pandorafms/latest/pandorafms_one_agent_linux-latest.noarch.rpm

For uninstalling, see the corresponding section.

Installing the EndPoint:

apt update
apt install -y perl coreutils wget curl unzip procps python3 python3-pip
wget https://packages.pandorafms.com/pandorafms/latest/pandorafms_one_agent_linux-latest.tar.gz
tar xvzf pandorafms_agent_linux-7.0NG.tar.gz
cd unix
./pandora_agent_installer --install
cp -a tentacle_client /usr/local/bin/

Delete the unix directory.

If you are going to use option server_ssl, install the following dependencies, enter in the terminal:

apt install libio-socket-ssl-perl -y

EndPoint configuration:

sed -i "s/^remote_config.*$/remote_config 1/g" $PANDORA_AGENT_CONF
systemctl start pandora_agent_daemon
systemctl enable pandora_agent_daemon

For uninstalling, see the corresponding section.

This EndPoint version is ready to be installed on any Unix/Linux/macOS system.

The EndPoint does not require compilation or preparation, once the EndPoint is downloaded in .tar.gz format:

1. Switch privileges to root. You are solely responsible for said key.

su -

2. Copy to /tmp, change to that directory, and run:

tar xvzf pandorafms_one_agent_linux-latest.tar.gz
cd unix
./pandora_agent_installer --install

You may need to manually install some additional required dependencies: libnsl.

3. Manually start the EndPoint:

systemctl start pandora_agent_daemon

For uninstallation check the corresponding section.

Instructions for EL version 10 environments are detailed below.

1. Elevate privileges to the root user; you are solely responsible for this key. Update repositories and install the Perl language if it is not already installed:

su -
dnf update
dnf install perl wget -y

Download the PFMS Endpoint installer with the source code included:

wget https://packages.pandorafms.com/pandorafms/latest/pandorafms_one_agent_linux-latest.src.tar.gz

2. Copy the downloaded file to /tmp/, enter that directory, and execute:

tar xvzf pandorafms_one_agent_linux-latest.src.tar.gz
cd unix
./pandora_agent_installer --install

dnf install libnsl perl-Sys-Syslog -y

Additionally, there are some modules that may not be present with the installation of Perl core modules. They can be installed using the following commands:

cpan YAML::Tiny
cpan Thread::Semaphore

The complete list of dependencies and/or modules is as follows:

File::Basename
File::Copy
O::Socket
MIME::Base64
POSIX
Scalar::Util
Sys::Hostname
Sys::Syslog
Thread::Semaphore
Time::Local
YAML::Tiny
commands
constant
strict
threads
threads::shared
warnings
libnsl
perl-Sys-Syslog

Post-installation configurations.

Once everything has finished installing, you must manually edit the Endpoint configuration file (using your preferred text editor) to point to the corresponding PFMS Server:

vi /etc/pandora/pandora_agent.conf

As a recommendation, enable remote configuration on this Endpoint:

sed -i "s/^remote_config.*$/remote_config 1/g" /etc/pandora/pandora_agent.conf

Once the configurations are complete, the service can be started:

systemctl start pandora_agent_daemon
systemctl enable pandora_agent_daemon

EndPoints may be installed in a directory defined by the user in an integral way, this means that all EndPoint files will be added to that directory: logs, configuration files, binaries, help pages man, etc.:

./pandora_agent_installer --install /opt/pandora

You may configure the installation so that instead of running the EndPoint as root, it can be run by another user. For example, for the EndPoint to run with user pandora, it would be:

./pandora_agent_installer --install /home/pandora pandora

When a custom user is specified, the EndPoint must be installed in a custom location where the user has writing permissions (/home/pandora in the previous example).

File location and the structure of the init script are different compared to Linux.

FreeBSD installation particularities:

1. Acquire root permissions:

su -

2. Copy the downloaded file to /tmp and once inside /tmp run:

tar xvzf pandorafms_agent_linux-7.0NG.tar.gz
cd unix
./pandora_agent_installer --install

After installation, add the following line to /etc/rc.conf:

pandora_agent_enable="YES"

To enable Pandora FMS EndPoint, these settings are needed, otherwise the process will not start.

If you wish to start the EndPoint manually:

/usr/local/etc/rc.d/pandora_agent start

EndPoint:

/usr/local/bin/pandora_agent

Boot script:

/usr/local/etc/rc.d/pandora_agent

Configuration file:

/usr/local/etc/pandora/pandora_agent.conf

Plugins:

/usr/local/share/pandora_agent/plugins/*

man helps:

/usr/local/man/man1/*

Others: Directories data_in and log are the same as in Linux®.

For uninstallation, check the corresponding section.

The EndPoint is delivered as a self-installer in executable format (.exe). To install Pandora FMS EndPoint in MS Windows®, download and run it.

The installer will guide you through the required steps in the language you select. The following example shows the installation for Windows 11®. If you are running MS Windows® as a standard user, you will need Administrator permissions, enter them when running the installer.

Select the language:

Follow the installer steps:

Accept the license terms:

Select the path where Pandora FMS EndPoint will be installed, by default it is installed at:

%ProgramFiles%\pandora_agent, you may change it by clicking Browse…. Then click Next:

Wait for the files to be copied.

Configure the data for the EndPoints as the IP address (or name) of Pandora FMS server that will receive the EndPoint data. To be able to change other parameters, such as changing the name of the EndPoint (by default it takes the hostname value of the machine) or the path of temporary files, you will have to manually edit EndPoint configuration.

Remote EndPoint configuration is enabled by default. Check the options to be used such as basic security monitoring and/or security hardening and/or hardware and software inventory control.

Set the minimum amount of free space for temporary files.

Start Pandora FMS EndPoint service, otherwise do so manually, or either start it when MS Windows® restarts again.

The installation is finished, you may change the EndPoint parameters in pandora_agent.conf file or through the direct link in Pandora FMS menu.

As of EndPoint version 5.1, the installer supports unattended mode. To carry out the installation, just run the following:

"PandoraFMS_One_Agent_Windows-lts.x86_64.exe" /S

In case you wish to install the EndPoint on a different path other than the default one:

"PandoraFMS_One_Agent_Windows-lts.x86_64.exe" /S /D=C:\PFMS_agent

You may also pass certain parameters to be written in the configuration file of the EndPoint to be created. Thanks to these options, Pandora FMS EndPoint deployment is fully customizable. The supported command line options are the following:

--ip

• It corresponds to the token named server_ip.

--group

• It corresponds to the token named group.

--alias

• It corresponds to the token named agent_alias.

--remote_config

• It corresponds to the token named remote_config.

For example, if you wish to create an EndPoint that belongs to the Applications group, named Mifunne and that points to the server with IP address 192.168.0.59, with remote_configuration enabled:

"PandoraFMS_One_Agent_Windows-lts.x86_64.exe" /S  --ip 192.168.0.59 --group Applications --alias Mifunne --remote_config 1

The uninstaller, which is an executable called uninstall.exe that remains in Pandora FMS installation directory, also allows unattended uninstall, for that, run the uninstaller with option /S.

For example, assuming that Pandora FMS is installed in the default path:

"%ProgramFiles%\pandora_agent\uninst.exe" /S

If you run:

pandoraagent.exe --help

it will display something similar to this:

C:\Users\Jimmy>"%ProgramFiles%\pandora_agent\pandoraagent.exe" --help
Pandora agent for Windows v7.0NG.761 Build 220427

Usage: C:\Program Files\pandora_agent\pandoraagent.exe [OPTION]

Available options are:
        --install:  Install the Pandora Agent service.
        --uninstall: Uninstall the Pandora Agent service.
        --test-ssh: Test the SSH Pandora Agent configuration.
        --test-ftp: Test the FTP Pandora Agent configuration.
        --process: Run the Pandora Agent as a user process instead of a service.

C:\Users\Jimmy>

To install the service (if it is not installed), just run the following in the directory where the executable is (usually C:\Program Files or equivalent).

pandoraagent.exe --install

This will install the service on the machine, based on the path where the .exe is located.

To test if it connects through SSH with Pandora FMS server:

C:\WINDOWS\system32>cd %PROGRAMFILES%

C:\Program Files>cd pandora_agent

C:\Program Files\pandora_agent>PandoraAgent.exe --test-ssh
Public key file C:\Program Files\pandora_agent\key\id_dsa.pub exists.
Private key file: C:\Program Files\pandora_agent\key\id_dsa exists.
Connecting with munchkin.pandorafms.com.
Authentication successful.
Host fingerprint:
Created a blank XML file in C:\Program Files\pandora_agent\temp\ssh.test
Remote copying C:\Program Files\pandora_agent\temp\ssh.test on server munchkin.pandorafms.com at /var/spool/pandora/data_in/ssh.test
Successfuly file copied to remote host
Successfuly disconnected from remote host
The SSH test was successful!

C:\Program Files\pandora_agent>

If you wish to uninstall it, it is the same process but with a different option:

pandoraagent.exe --uninstall

It is possible, for debugging, testing, and other unusual circumstances, to run the EndPoint in “Process” mode. This is done by running it from the command line:

pandoraagent.exe --process

There are some limitations when running in process mode, since Pandora FMS is conceived to run as a service and under the SYSTEM user. If you run it with another user without privileges, there will be features that do not work correctly.

If you do not have the installer initially used, download the corresponding version from:

Once the .tar.gz package is downloaded and on the target system, it must be unzipped.

Switching privileges to root or using a user with the highest privileges.

sudo su

Unzipping the installer:

tar xvzf <pandora_agent_installer>.tar.gz

Enter the unix directory that was generated after unzipping the installer:

cd unix

Once in this directory, you will have access to the installer executable pandora_agent_installer, if you run it with the --help parameter, the available options will be shown. Among them there is an example on how to uninstall the EndPoint when a custom location was used.

Before starting the uninstallation process, it is recommended to stop the EndPoint service:

systemctl stop pandora_agent_daemon

Afterwards, the uninstallation process may be started:

./pandora_agent_installer --uninstall

Once this process is finished, reload systemctl:

systemctl daemon-reload

Finally, the following directories must be deleted:

/etc/pandora
/var/log/pandora
/var/spool/mail/pandora
/var/spool/pandora
/usr/share/pandora_agent

This will complete the uninstallation process of PFMS EndPoint.

Pandora FMS EndPoint service should be stopped:

systemctl stop pandora_agent_daemon.service

To start the uninstallation process, run:

dnf remove pandorafms_agent_linux.noarch

If necessary, yum or rpm -e is used instead of dnf.

Once this process is finished, reload systemctl:

systemctl daemon-reload

Finally, delete the following directories:

/etc/pandora
/var/log/pandora
/var/spool/mail/pandora
/var/spool/pandora
/usr/share/pandora_agent

This completes the EndPoint uninstalling process.

Back to Pandora FMS Documentation Index