Pandora: Documentation en: Installing

From Pandora FMS Wiki
Revision as of 10:47, 4 February 2015 by Ivo yordanov (talk | contribs) (Installation under Debian and Ubuntu)
Jump to: navigation, search

Go back to Pandora FMS documentation index

Contents

1 Pandora FMS Installation

1.1 Minimum Hardware Requirements

1.1.1 Console and Server Requirements

  • Up to 500 agents or 5.000 modules: 3GB of RAM, a 2.5GHz single-core CPU and a fast hard drive, 7200 RPM or equivalent, assuming 80% of modules with history and an average interval of 5 min.
  • Up to 2.000 agents or 10.000 modules: 6GB of RAM, a dual core 2.5GHz CPU and a very fast hard drive (10000 RPM or more), assuming 80% of modules with history and an average interval of 5 min. You're also required to tune up your MySQL very well.
  • For more than 4.000 agents: 12GB of RAM, a 3GHz quad-core CPU and the fastest hard drives available on the market (15,000 RPM or more), assuming 80% of modules with history and an average interval of 5 min. It's recommended to have MySQL installed onto another server. You're required to tune up your MySQL very well or to have 'Percona XtraDB' installed.

Template warning.png

It's not recommended to use Pandora FMS in virtual environments, since the disk access requirements are very high. In case you have to do so, it's strongly recommended to assign independent RAM, CPU and hard disks instead of using a part of the host's resources and to use SAN disks in these kinds of environments.

 


Info.png

It's strongly recommended to use Pandora FMS in virtual environments for testing, certification or development environments, but never in productive systems !

 


Disk size: A minimum of 15GB free space. It's recommended to have 25GB.

1.2 Software Requirements

The officially supported OS platform for Pandora FMS is Linux. From Pandora FMS versions 5.1 and above, Windows Server is also supported. The supported Linux distributions and versions for the server and console are as follows:


Component Operating System
Pandora FMS 5.1 or higher
  • RedHat Enterprise (RHEL) 6.x
  • CentOS 6.x
  • SLES 11 SP1 or higher.
  • OpenSUSE 11.x or higher.
  • Debian 5.x or higher.
  • Ubuntu 11 or higher.
  • Microsoft Windows Server (2003 or higher)


We don't offer official support for them, but other platforms where Pandora FMS works are as follows:


Component Operating System
Pandora FMS 4.0 or higher
  • FreeBSD 9.1
  • Solaris 10 / OpenSolaris

The Pandora FMS Agents run on almost any modern operating system. Please take a look at the Agent Requirements section for more details.

1.2.1 Database Requirements

Prior to installing Pandora FMS, you're required to have a MySQL Database up and running (Oracle and Postgre SQL supports are still experimental). You're also required to have a MySQL Server running on a server. It may be the same server you're going to install Pandora FMS on. You may also utilize a separate server which is accessible from your Pandora FMS Server / Console using a TCP/IP network. To do so, you're required to have:

  • The IP Address of your MySQL Server: ('localhost' if it's installed on the same Pandora FMS Server Host).
  • A privileged User:A user who has the rights to create databases and users (usually the user named 'root'). This user must be allowed to connect from the IP address of your Pandora FMS Server host.
  • A Password: A password for privileged users.


Template warning.png

You're required to get this up and running before installing Pandora FMS. If you don't know how to install a MySQL Server, please check the On-Line Documentation for the entire process on how to do that, because this procedure changes considerably on different operating systems and Linux distributions.

 


Template warning.png

ORACLE and POSTGRESQL supports are still EXPERIMENTAL.

 


1.2.2 Agent Requirements

The remote agent is able to run on any hardware which is able to run the minimum required operating systems.

Alongside Linux, Pandora FMS Agents work on the following systems:


Component Operating System
Pandora Agent (versions 4.0 or above)
  • Linux (all distributions)
  • HPUX B.11.11 or higher, with Perl 5.8.
  • AIX 4.3.3 or higher, with Perl 5.8.
  • BSD (NetBSD, OpenBSD, FreeBSD), with Perl 5.8.
  • MacOSX 10.6 or higher, with Perl 5.8
  • Solaris 8 or higher, with Perl 5.8.
  • Windows NT4 (see special version notes here).
  • Windows XP
  • Windows 2000
  • Windows 2003
  • Windows 2008
  • Windows 7
  • Windows 8
  • Windows 2012
Pandora Android Agent (versions 2.0 or above)
  • Android 2.2 or above
Pandora Embedded Agent (versions 4.0 or above)
  • Embedded devices require compilation.


Info.png

It's well known that the agent has been implemented successfully into other operating systems, but there is no official support for them. The agent does not work under Windows NT4. To be able to monitor outdated Windows systems, you may install the 'Cygwin' environment and the Agent for Linux. If you intend to do so, please expect the performance to be much lower than it would be under current Windows versions.

 


Under UNIX platforms, you're additionally required to have installed:

  • 'Perl 5.8' or higher.
  • You may optionally unzip the package and execute it via path by the user on which the Pandora FMS Agent gets hosted on. This package is only required if you intend to use the file collection.
  • If you intend to use the local inventory plug in to obtain information from the hardware, you're required to install the tool named 'lshw' which requires to have full access and the right to execute itself from the system path.

1.2.3 Server Requirements

You can also work on any operating system with Perl 5.8 installed and iThreads enabled.

It should be noted that Pandora FMS requires a MySQL server to store all information. This server may be installed on any MySQL-supported platform. This could be Windows, Linux, Solaris, etc.

It's required to have Perl 5.8 installed, at least for the server to work appropriately. In addition to the operating system's SNMP packets ('net-snmp') to utilize the Pandora FMS SNMP service, it also requires a MySQL-Database, NMAP packages and the optional xprobe2 to be able to use the advanced features of the Recon Server and traceroute's Perl libraries to be able to setup a self-discovering network. It's also necessary to install the WMI client's binary for WMI queries against Windows systems. The client binary is a part of the SAMBA project (v4) and can be compiled, but not without some difficulty under any UNIX environments.

1.2.4 Console Requirements

The console requirements are the same as for the server. We recommend its operation being resident on Linux systems, but like the web interface it's a pure AMP application (Apache, MySQL and PHP). Theoretically, it could work on any system which is able to run Windows, Unix, etc.

1.2.5 Web-Administration Requirements for the Tool

You're required to have a web browser installed to verify the operations of the console. It's not required to have the Flash plug in installed in your browser to start, but it's recommended to utilize some of the interactive Flash graphics.

1.2.6 Package Dependencies

Pandora FMS has a heavy dependency on the GNU/Linux Operating System, but it also needs additional packages which aren't installed by default in many cases. During the installation process, there is a detailed list of package dependencies for Debian, Ubuntu and OpenSUSE.

1.3 Issues prior to Installation

1.3.1 MySQL

You will need to have a MySQL Server installed BEFORE configuring Pandora FMS, because in one of the steps, you're required to access a running MySQL server instance. For doing that, you need to have it operational. If you are installing the MySQL Server at the same time as Pandora FMS, remember that you need to set up the MySQL server properly prior to configuring Pandora FMS. This is easily done in two steps:

1. Please start the MySQL Server daemon:

/etc/init.d/mysql start

2. Configure the root password for the MySQL root user:

mysqladmin password <password>

Where '<password>' is the password you have to setup for the MySQL root user (which is different from the systems 'root' user). The system is going to ask for this password throughout the entire Pandora FMS installation process.

1.3.2 Pandora FMS Installation Order

You're required to follow this sequence in order to install Pandora FMS properly:

  1. Install console
  2. Install server

The reason for this is the MySQL database configuration is made during the initial configuration phase of the console installation. To ensure the correct working of the server, it's recommended to conduct the whole console's installation process first.

The Pandora FMS Server and console are also possible to be hosted on different machines, because you can configure the server to utilize a remote MySQL database by means of the server's configuration file.

Regarding the agent: You may install it before or after installing the server and console, because the agent works independently and it's capable of getting installed on any machine.

1.3.3 Installing the Enterprise Version

From versions 4.0.2 and above, the license number of Pandora FMS activates all features of the Enterprise Version. If you're installing the Pandora FMS 4.0.2 Enterprise without a valid license number, it's not going to work. You first have to install the open-source version, get the license number and install the Enterprise Version.

In summary:

  • Please install the open-source console.
  • Please access the console, go to the setup section and insert your license code as shown on the picture below.
  • Install the Enterprise Console.

However, if you do it in any other order, the screen which reports the error to you could be used for inserting the license number.

Please enter the license number in the main configuration option (setup):



Licence setup.png

From Pandora FMS versions 5 and above, the security for license verification was improved and requires a different method of license installation. In order to install the license for versions 5 and above, you're required to install the enterprise console and access the login screen first. Once you've agreed, a window called License Application v5.X is going to open.

1.3.3.1 Special Requirements for the Enterprise Version

In order to use the ICMP Enterprise Server, you're required to have fping installed.

1.4 Installing the Appliance CD

Due to the length of this section, we have established a special screen shot-equipped section. It's called Appliance CD Installation.

1.5 Installing the VMWare Virtual Machine

Alongside the Centos ISO, you can find a virtual machine which contains an already installed Pandora FMS under 'sourceforge.net'. This image is tested with VMWare ESX, VMWare Workstation, VirtualBox and Hyper-V. To run it under Hyper-V, you're required to export the VMDX and VDH files from the 'MVDC.exe' executable. They are available after you've installed the Microsoft Virtual Machine Converter.

To install it, you have to execute the '.ovf' file under 'Virtualbox' and 'VMWare Workstation'. Under ESX and Hyper-V, you're required to import the image under 'Import VM' and select the virtual image there.

The credentials for this machine are the following:

User: root

Password: pandora

Console User: admin

Password: pandora

MySQL user: root

Password: pandora

1.6 Installation under SUSE (OpenSUSE or SLES)

1.6.1 Automatized Installation by the Official Repository

You're required to have access to the internet to perform this kind of installation. This method is easy and fast. All steps are required to be conducted as a 'root' user or by the use of 'sudo' before entering any command:

Step 1: Please create a repository by entering the following command:

zypper ar -G http://artica.es/suse PandoraFMS_Official_Repo

Step 2: Update the repository's information:

zypper refresh

Step 3: Install Pandora FMS:

zypper install pandorafms_agent_unix pandorafms_console pandorafms_server mysql-community-server apache2-mod_php5 

This is going to install Pandora FMS and all of it's dependencies by a single command.

1.6.2 Manual RPM Installation

1.6.2.1 Configuring Software Repositories

The installation of software on SLES (SUSE Linux Enterprise Server) is conducted via RPM packets. These RPM packets can contain official software provided by the manufacturer Novell. The installation DVD / CD or HTTP / FTP repositories or other non-official repositories are maintained by the community of developers and users of SUSE (OpenSUSE). These repositories can only be accessed by the internet, but the individual RPM packages may be downloaded, copied to servers and manually installed by the command line.

SLES utilizes a general management interface (YAST) for package management and software repositories. This interface is used to manage the entire SLES system: Disk partitioning, installing software, configuring the NICs, etc. It can be used with graphical interface (X), any console or remote session via SSH.

For this documentation, we've used the 'Zypper' tool from SUSE, which is capable of solving dependencies and downloading packages directly from the repositories on the internet. If you don't have Zypper installed, you should install it, because it's faster and much more convenient. If you don't, you're required to have to conduct all the entire installation of packages using YaST and the SUSE Installation CD manually.

1.6.2.2 Previous Dependencies Installation

You're required to install the following package dependencies (which are included under SUSE):

apache2 apache2-mod_php5 php5 php5-gd php5-gettext php5-json php5-mbstring php5-ldap php5-mysql \
php5-pear php5-snmp php5-zip nmap perl-DBD-mysql perl-DBI perl-Date-Calc perl-HTML-Parser \
perl-HTML-Encoding perl-HTML-Tree perl-IO-Socket-inet6 perl-Socket6 perl-Mail-Sendmail perl-NetAddr-IP \ 
perl-TimeDate perl-XML-Simple perl-XML-Twig perl-libwww-perl mysql-client mysql-max mysql  \
net-snmp xorg-x11-fonts-core php5-pear-db php5-curl php5-xmlrpc perl-SNMP graphviz graphviz-gd \
perl-Encode-Locale


Info.png

Unlike SLES, OpenSUSE doesn't have a 'mysql-max' package. You may install the MySQL standard package without experiencing any problems.

 


In order to install all dependencies, please just execute:

zypper install ..

Followed by the whole package list, specified in the paragraph above, this is going to display a screen like the one on the picture below:

Getting repositories data...
Reading packets installed...
perl-DBI already installed.
perl-HTML-Parser already installed.
perl-TimeDate already installed.
perl-XML-Simple already installed.
perl-libwww-perl already installed.
xorg-x11-fonts-core already installed.
Resolving dependencies...

Following NEW packages will be installed:
  apache2 apache2-mod_php5 apache2-prefork apache2-utils libapr1 libapr-util1 libdnet1 
liblua5_1 libmm14 libmysqlclient15 mysql mysql-client mysql-Max net-snmp nmap 
perl-Bit-Vector perl-Carp-Clan perl-Data-ShowTable perl-Date-Calc perl-Date-Manip 
perl-DBD-mysql perl-HTML-Encoding perl-HTML-Tree perl-IO-Socket-inet6 
perl-Mail-Sendmail perl-NetAddr-IP perl-SNMP php5 php5-ctype php5-dom php5-gd 
php5-gettext php5-hash php5-iconv php5-json php5-ldap php5-mbstring php5-mysql 
php5-openssl php5-pdo php5-pear php5-snmp php5-sqlite php5-tokenizer php5-xmlreader 
php5-xmlwriter php5-zip php5-zlib t1lib 

Total Size: 19.1 M. After the operation, additional 55.9 M will be used.
 Continue? [Yes / no]:

By clicking 'yes', Zypper starts downloading and installing the packages.

When finished, you're required to install some extra packages. Under OpenSuse, not all the required packages for Pandora FMS exist yet. They are going to be provided by an additional RPM to satisfy the dependencies from the Pandora FMS Sourceforge website. The additional RPMs are the following:

perl-time-format php-pear-xml_rpc wmic smstools perl-HTML-Tree perl-XML-Twig


Info.png

Extra packages like 'Perl-HTML-Tree' and 'Perl-XML-Twig' are required to be installed manually.

 


If you intend to use the Recon Server, you're required to install these additional packages:

perl-net-traceroute perl-net-traceroute-pureperl xprobe2

These RPM files can be found on the official distribution site of Pandora FMS Software in a specific dependencies directory for OpenSUSE.

{{Tip|Please make sure to download the appropriate packages for OpenSUSE.

Please put them in a directory, e.g.: '/tmp/extra' and execute the following command:

rpm -i *.rpm

1.6.2.3 Agent Installation

You're required to download an RPM package similar to this one from our web site (the version or some other details could be slightly different):

pandorafms_agent-3.0.0-1.noarch.rpm

In order to install it, just execute this command:

rpm -i pandorafms_agent-3.0.0-1.noarch.rpm

If these phrases are shown:

Insserv:warning:script 'smsd' missing LSB tags and overrides Insserv:default-start undefined, assuming default start runlevel (s) for script 'smsd'.

Don't worry. It's just a warning message, not an error.

1.6.2.4 Server Installation

Same as on the agent. Just execute:

rpm -i pandorafms_server-3.0.0-1.noarch.rpm

If you have installed the agent before that, you'll get the following (quite unimportant) warning:

useradd: Account "pandora" already exists.

1.6.2.5 Console Installation

Please execute the RPM installation tool for packages in order to install the package which contains the Pandora FMS Console:

rpm -i pandorafms_console-3.0.0-1.noarch.rpm

If you have any trouble installing the Pandora FMS console caused by a wrong package name, you'll probably get an error message such as this:

error: Failed dependencies:
php5-pear-db is needed by pandorafms_console-3.1-1.noarch

You can force the installation by using the '--nodeps' flag.

1.6.3 Uninstalling Pandora FMS

You're able to uninstall any of Pandora FMS components by using the following commands:

rpm -e pandorafms_agent
rpm -e pandorafms_console
rpm -e pandorafms_server

The Pandora FMS database won't get uninstalled if any of the Pandora FMS packages are - just all files from any other package (including the configuration files) are going to be deleted.

1.7 Installation in Red Hat Enterprise Linux / Fedora / CentOS

The installation process is nearly the same as the one from SUSE. Please keep in mind that RHEL, CentOS or Fedora RPM packages aren't the same as the ones in SUSE - there are also some incompatibilities.

First of all, you're required to add some official repositories to your system. Subsequently, you may choose to add the Pandora FMS official repository to conduct an installation from the online repositories. Adding this additional repositories is going to help you to install all required dependencies for Pandora FMS.

Edit /etc/yum.repos.d/CentOS-Base.repo and enable EXTRAS, and UPDATES repos. Usually should be something like this:

[updates]
name=CentOS-$releasever - Updates
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=updates
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-6

[extras]
name=CentOS-$releasever - Extras
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=extras
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-6

We're also going to add the EPEL repository:

[EPEL]
Name = EPEL
baseurl = http://dl.fedoraproject.org/pub/epel/6/$basearch/
enabled = 1
gpgcheck = 0

Please refresh your repository information by this command:

yum makecache

1.7.1 Automated Install by using the Pandora FMS Repository

You're going to need YUM and access to internet. First, you're required to create a reference to the Pandora FMS official repository for CentOS 6. This also applies for the usage under RHEL6.

vi /etc/yum.repos.d/pandorafms.repo

Add this contents:

[artica_pandorafms]
name=CentOS6 - PandoraFMS official repo
baseurl=http://artica.es/centos6
gpgcheck=0
enabled=1

Please refresh your repository information:

yum makecache

You can now install Pandora FMS along with the MySQL-Server. This is an 'optional' dependency. You're required to have a MySQL server if you don't already have one.

yum install pandorafms_console pandorafms_server mysql-server

This is going to download all RPMs and dependencies, install them for you and leave the system ready for setup.

1.7.2 Manual Installation by RPM Files

Most of the dependencies should be resolved using YUM or any other automatic package. All dependencies are marked as needed packages in the RPM definition:

yum install php php-gd graphviz php-mysql php-pear-DB  php-mbstring php-ldap php-snmp \
php-ldap php-common php-zip nmap

yum install perl-HTML-Tree perl-DBI perl-DBD-mysql perl-libwww-perl perl-XML-Simple \
perl-XML-SAX perl-NetAddr-IP net-snmp net-tools perl-IO-Socket-INET6 perl-Socket6 \ 
nmap sudo xprobe2 make perl-CPAN perl-JSON net-snmp-perl perl-Time-HiRes perl-XML-Twig \
perl-Encode-Locale

Some dependencies (like 'wmic' or 'xprobe2') aren't contained in the official RHEL repositories. We're providing them on our Sourceforge download page as Tools and Dependencies.

Some other dependencies like 'graphviz', 'perl-XML-Simple' or 'perl-HTML-Tree' are in the additional repositories we've installed before. It's important that you activate/install it prior to executing yum.

Template warning.png

If you're using a version prior to RHEL6, some dependencies could have another name, e.g. 'perl-SNMP'. Under CentOS5, RHEL5, etc. it would be called 'net-snmp-perl'.

 


In order to install the RPM, just e.g. use the 'rpm -i' or the yum command directly:

rpm -i pandorafms_server-x.x-x.noarch.rpm

or

yum install pandorafms_server-x.x-x.noarch.rpm

If you encounter any problems at the time you're trying to access the Pandora FMS Console installation web page, please check if SELinux is active: In this case, it's mandatory to deactivate it. Please follow the FAQ procedures in such a case.


Template warning.png

RHEL and CentOS 5.x use PHP 5.1 by default. This version is not compatible with Pandora FMS. You're required to use PHP version 5.2 or above.

 


To do so, we recommend to use the following repository for CentOS5/RHEL5, which contains PHP 5.2:

[c5-testing]
name=CentOS-5 Testing 
baseurl=http://dev.centos.org/centos/5/testing/$basearch/
enabled=1
gpgcheck=1
gpgkey=http://dev.centos.org/centos/RPM-GPG-KEY-CentOS-testing

1.8 Installation under Debian and Ubuntu

It's recommended to install Pandora FMS on a 10.04 version or above. On Debian Stable ('Squeeze') versions, it's possible to experience problems due to old versions of some required optional software, such as: The Debian LWP library does not implement some methods for SSL. This is necessary for the monitoring of Enterprise WEB modules to get fixed by installing a newer version of LWP by CPAN (manual method). You also require an fping to use the Enterprise ICMP Server. 'Squeeze' comes with version 5.0. You may install a newer version, using those packages. We're recommending to use the unofficial DEB or to compile a version for yourselves.


Info.png

Before installing any packages you need to add the official repositories for your version. For example: To install the packages snmp-mibs-downloader and libencode-locale-perl under Debian Squeeze, you're required to add the following repositories at the file /etc/apt/sources.list

"deb http://ftp.us.debian.org/debian/ squeeze main non-free"
"deb http://ftp.at.debian.org/debian-backports/ squeeze-backports main"

Once they have been added you need to execute 'apt-get update' to apply the changes.

 


Info.png

Due to the nature of Debian packaging (if you choose Debian or Ubuntu), you're required to have access to the internet or a local package repository to conduct the installation. A single dependency under Debian could have sub-dependencies. The installation without access an on-line repository could turn out to be very complex.

 


1.8.1 Installation by using the Artica Private Repository

There's also a much faster and easier method: Just add the Artica Private Repository. It contains any and all the Ubuntu and Debian packages you might require.

In order to do so, please edit the file '/etc/apt/sources.list' and add the following line:

deb http://www.artica.es/debian/squeeze/

Execute as root (sudo)

apt-get update

Installation of Pandora FMS by apt-get:

[email protected]:~# apt-get install pandorafms-console pandorafms-server pandorafms-agent-unix
Reading package lists... Done
Building dependency tree       
Reading state information... Done
The following extra packages will be installed:
  apache2-mpm-prefork apache2-utils apache2.2-common dbconfig-common graphviz libapache2-mod-php5 libcgraph5 libcurl3 libgd2-xpm libgvpr1
  libio-socket-inet6-perl libnetaddr-ip-perl libonig2 libqdbm14 libsnmp-perl libsocket6-perl libssh2-1 libtime-format-perl
  libxml-namespacesupport-perl libxml-sax-expat-perl libxml-sax-perl libxml-simple-perl nmap php-db php-gettext php-pear php5 php5-cli php5-common
  php5-curl php5-gd php5-ldap php5-mysql php5-snmp php5-suhosin php5-xmlrpc smistrip snmp snmp-mibs-downloader snmpd xprobe
Suggested packages:
  apache2-doc apache2-suexec apache2-suexec-custom graphviz-doc libgd-tools php5-dev
The following packages will be REMOVED:
  libgd2-noxpm
The following NEW packages will be installed:
  apache2-mpm-prefork apache2-utils apache2.2-common dbconfig-common graphviz libapache2-mod-php5 libcgraph5 libcurl3 libgd2-xpm libgvpr1
  libio-socket-inet6-perl libnetaddr-ip-perl libonig2 libqdbm14 libsnmp-perl libsocket6-perl libssh2-1 libtime-format-perl
  libxml-namespacesupport-perl libxml-sax-expat-perl libxml-sax-perl libxml-simple-perl nmap pandorafms-agent-unix pandorafms-console
  pandorafms-server php-db php-gettext php-pear php5 php5-cli php5-common php5-curl php5-gd php5-ldap php5-mysql php5-snmp php5-suhosin php5-xmlrpc
  smistrip snmp snmp-mibs-downloader snmpd xprobe
0 upgraded, 44 newly installed, 1 to remove and 0 not upgraded.
Need to get 40.9 MB of archives.
After this operation, 90.8 MB of additional disk space will be used.
Do you want to continue [Y/n]? y
WARNING: The following packages cannot be authenticated!
  pandorafms-agent-unix pandorafms-console pandorafms-server
Install these packages without verification [y/N]? y

1.8.2 Manual Installation by DEB Packages

Under Debian or Ubuntu, the dependencies are the following:

Server:

snmp snmpd libtime-format-perl libxml-simple-perl libdbi-perl libnetaddr-ip-perl
libhtml-parser-perl wmi-client xprobe2 nmap traceroute 
libio-socket-inet6-perl libhtml-tree-perl libsnmp-perl snmp-mibs-downloader
libio-socket-multicast-perl libsnmp-perl libjson-perl libencode-locale-perl


Info.png

If the 'wmi-client' package is not available in the repositories, you're required to download it from the Pandora FMS Sourceforge website.

 


Console:

php5 libapache2-mod-php5 apache2 mysql-server php5-gd php5-mysql php-pear php5-snmp php-db php-gettext 
graphviz mysql-client php5-curl php5-xmlrpc php5-ldap

In order to install the Server package or the console, you first have to implement all of the required dependencies. This is done by installing all the before mentioned packages by using the command apt-get along with root privileges:

apt-get install snmp snmpd libtime-format-perl libxml-simple-perl libdbi-perl libnetaddr-ip-perl \
libhtml-parser-perl wmi-client xprobe2 nmap libmail-sendmail-perl traceroute libio-socket-inet6-perl \
libhtml-tree-perl php5 libapache2-mod-php5 apache2 mysql-server php5-gd php5-mysql php-pear php5-snmp \
php-db php-gettext graphviz mysql-client php5-curl php5-xmlrpc php5-ldap libsnmp-perl snmp-mibs-downloader \
libio-socket-multicast-perl libsnmp-perl libjson-perl


Info.png

The character '\' is used as a line divider. You may copy and paste it directly out of this documentation into the console and the line breaks will be considered as such.

 



This command would install all the dependencies required to install the Pandora FMS Server and its console into a Debian or Ubuntu system.

The installation with the DEB packages is very easy. First, you're required to download all the necessary packages. Subsequently, you're required to execute the following commands in the same directory in which you've put the packages.

In this example they are installed all together, but it could also be just one of them.

dpkg -i pandorafms-console_xxx.deb pandorafms-server_xxxx.deb

Once the command has been executed, you might see that some dependencies are missing. If so, you can try to solve it automatically by using the following command:

apt-get -f install

This will attempt to download all the necessary missing packages from the automated installation of Pandora FMS on the system. Once the necessary packages have been installed, you're required to continue with the installation of all Pandora FMS components.

In order to complete the installation of the Pandora FMS Console, you have to access the console URL and follow the steps suggested by the installation wizard. If the console is installed on a server with the IP of e.g. '10.20.34.54', you're required to enter the following URL:

http://10.20.34.54/pandora_console

1.8.3 Uninstalling Pandora FMS

dpkg -r pandorafms-console-enterprise
dpkg -r pandorafms-console

1.9 Installation in FreeBSD

From version 3.2 and above, Pandora FMS supports the use of FreeBSD as an operating system.

1.9.1 Perl with iThread Installation

To execute the Pandora FMS Server Daemon, Perl is required to be compiled with enabled iThread, although the FreeBSD perl 5.x (5.8 or later) package named 'perl-5.x.x.pkg' comes without iThread, so it cannot be used.

Therefore, you're required to compile and install the perl 5.x executable by using the FreeBSD ports collection like described below.

cd /usr/ports/lang/perl5.x
make config
  -> Enable ITHREADS.
make
make install

1.9.2 Previous Dependencies Installation

In FreeBSD, the dependencies are the following:

Server:

databases/p5-DBI mail/p5-Mail-Sendmail net-mgmt/p5-NetAddr-IP textproc/p5-XML-Simple
devel/p5-Time-Format www/p5-HTML-Parser net/p5-Net-Traceroute-PurePerl
net/p5-IO-Socket-INET6 databases/p5-DBD-mysql textproc/p5-XML-Twig converters/p5-JSON
net-mgmt/net-snmp security/nmap net/xprobe sysutils/coreutils net-mgmt/net-snmp
net-mgmt/wmi-client

In order to install the Pandora FMS Server, you're required to implement all the dependencies before doing so. It's recommended to do so by using the ports collection. Please don't use packages here.

You may install all the necessary dependencies in the following way:

e.g.) p5-DBI installation.

cd /usr/ports/databases/p5-DBI
make
make install

Console:

www/apache22, lang/php5, net-mgmt/php5-snmp, www/php5-session, devel/php5-gettext,
converters/php5-mbstring, net/php5-ldap, databases/php5-mysql, graphics/php5-gd, archivers/php5-zip, 
archivers/php5-zlib, devel/php5-json, ftp/php5-curl, devel/pear, databases/pear-DB, net/pear-XML_RPC, 
graphics/graphviz (GTK, GDK_PIXBUF, PERL, PHP should be enabled.)

In order to install the Pandora FMS Console, you will have to implement all of the before mentioned dependencies. You may use the ports collection or the packages to do so.

1.9.3 Console Installation

There are no Pandora FMS Console package files for FreeBSD. It's recommended to install the pandora console by using the installer.

How to install it by the installer is described in the section named 'Manual Installation from Sources in Linux/Unix' below.

Under FreeBSD with apache 2.2, the Pandora FMS console directory is:

/usr/local/www/apache22/data/pandora_console

1.9.4 Server Installation

There are no Pandora FMS Server package files for FreeBSD. You're required to install the Pandora Server by using the installer.

How to install it by the installer is described in the section named 'Manual Installation from Sources in Linux / UNIX' below.

The file locations and startup script structures are different from Linux. We're going to show the FreeBSD-specific procedures below.

After the installation, you're required to add the following lines to the '/etc/rc.conf' file:

pandora_server_enable="YES"
tentacle_server_enable="YES"

These settings are required to enable Pandora, the Pandora Servers and Tentacle. Otherwise, they are not going to be launched.

On FreeBSD, most of the Pandora server's files are gong to be installed in the directory named '/usr/local'.

pandora_server, tentacle_server:

/usr/local/bin/pandora_server
/usr/local/bin/tentacle_server

Startup script:

/usr/local/etc/rc.d/pandora_server
/usr/local/etc/rc.d/tentacle_server

Configuration file:

/usr/local/etc/pandora/pandora_server.conf

util:

/usr/local/share/pandora_server/util/*

Man pages:

/usr/local/man/man1/*

Other:

The 'data_in' and log directories are the same as the ones under Linux.

1.9.5 Agent Installation

There are no Pandora FMS Agent package files for FreeBSD. It's recommended to install the Pandora Agent by using the installer.

How to install the agent by the installer is described in the section named 'Manual Installation from Sources under Linux / UNIX' below.

The file locations and startup script structures are different from the ones under Linux. We're going to show the FreeBSD specific procedures below.

After the installation, you're required to add the following line to the file '/etc/rc.conf':

pandora_agent_enable="YES"

To enable the Pandora FMS Agent, these settings are required. Otherwise, it's not going to be launched.

On FreeBSD, the majority of the files of the Pandora FMS Agent are installed in the directory '/usr/local'.

Agent:

/usr/local/bin/pandora_agent

Startup 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 pages:

/usr/local/man/man1/*

Other:

The 'data_out' and log directories are the same as the ones under Linux.

1.10 Installation in NetBSD

From versions 5.0 and above, Pandora FMS supports the use of NetBSD.

1.10.1 Previous Dependencies Installation

In NetBSD the dependencies are as follows:

Server:

mysql55-server databases/p5-DBI mail/p5-Mail-Sendmail net/p5-NetAddr-IP textproc/p5-XML-Simple 
time/p5-Time-Format www/p5-HTML-Parser net/nmap net/p5-IO-Socket-INET6
database/p5-DBD-mysql textproc/p5-XML-Twig  sysutils/coreutils converters/p5-JSON net/net-snmp

In order to install the Pandora FMS Server, you are required to implement all of the dependencies before doing so. It's recommended to be done by using 'pkgsrc'.

You may install all dependencies like this:

e.g.) p5-DBI installation.

cd /usr/pkgsrc/databases/p5-DBI
make
make install

Subsequently, you're required to install 'Net::Traceroute::PurePerl' and 'LWP::Simple' using CPAN.

perl -MCPAN -e 'install Net::Traceroute::PurePerl'
perl -MCPAN -e 'install LWP::Simple'

'xprobe' is also required to be installed by compiling the source package.

You may download it from [1]

If you're unable to compile it without some errors showing up, please modify the following files and try again:

  • Add ' include <cstdlib> ' to 'libs-external/USI++/src/ip.cc'.
  • Add ' include <cstdlib> ' to 'libs-external/USI++/src/misc.cc'.
  • Add ' include <cstring> ' to 'libs-external/USI++/usi++/tcp.h'.

Console:

www/apache22, lang/php54, net/php-snmp, www/ap-php, devel/php-gettext,
converters/php-mbstring, databases/php-ldap, databases/php-mysql, raphics/php-gd,
archivers/php-zip, archivers/php-zlib, textproc/php-json, www/php-curl, lang/pear, 
databases/pear-DB, graphics/graphviz, 

In order to install the Pandora FMS Console, you're required to implement all of the dependencies before doing so. You may use 'pkgsrc' for that.

In addition, you're required to install the 'XML_RPC' using the 'pear' command as shown below.

pear install XML_RPC

1.10.2 Console Installation

There are no Pandora FMS Console package files for NetBSD. You're required to install the pandora console by using the installer.

How to install it by the installer is described in the section named 'Manual Installation from Sources in Linux/Unix' below.

On NetBSD with apache 2.2, the Pandora FMS Console directory is the one mentioned below.

/usr/pkg/share/httpd/htdocs/pandora_console

1.10.3 Server Installation

There are no Pandora FMS Server package files for NetBSD. You're required install the pandora server by using the installer.

How to install it by the installer is described in the section named 'Manual Installation from Sources in Linux/Unix' below.

The file locations and startup script structures are different from the one under Linux. We're going to show the NetBSD specific procedures below.

After the installation, you're required to add the following lines to the '/etc/rc.conf':

pandora_server="YES"
tentacle_server="YES"

To enable the Pandora Servers, Pandora and Tentacle, these settings are required. Otherwise, they are not going to be launched.

On NetBSD, most of the Pandora FMS Server files are installed under '/usr/local'.

pandora_server, tentacle_server:

/usr/local/bin/pandora_server
/usr/local/bin/tentacle_server

Startup script:

/etc/rc.d/pandora_server
/etc/rc.d/tentacle_server

Configuration file:

/usr/local/etc/pandora/pandora_server.conf

util:

/usr/local/share/pandora_server/util/*

Man pages:

/usr/share/man/man1/*

Other: The 'data_in' and log directories are the same as the ones under Linux.

1.10.4 Agent Installation

There are no Pandora FMS Agent package files for NetBSD. You're required to install the Pandora FMS Agent by using the installer.

How to install an agent by the installer is described in the section named 'Manual Installation from Sources in Linux/Unix' below. The file locations and startup script structures are different from the ones under Linux. We're going to show the NetBSD specific procedures below.

After the installation, you're required to add the following line to the '/etc/rc.conf':

pandora_agent="YES"

To enable the Pandora FMS Agent, these settings are required. Otherwise they are not going to be launched.

On NetBSD, most files of the Pandora FMS Agent are installed in the directory named '/usr/local'.

Agent:

/usr/local/bin/pandora_agent

Startup script:

/etc/rc.d/pandora_agent

Configuration file:

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

Plugins:

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

Man pages:

/usr/share/man/man1/*

Other:

The 'data_out' and log directories are the same as the ones under Linux.

1.11 Manual Installation from Sources under Linux / UNIX

This option is especially important in cases where you intend to utilize the development version's code or directly from the code repositories.

1.11.1 Previous Installation of Necessary Software

As you're going to build Pandora FMS from the sources, you'll require the basic software in order to compile and install software from the code. Depending on the use of one distribution or another, you're required to install packages such as 'make', 'gcc' and others. Furthermore, it's recommended to review the corresponding dependencies section to your distribution.

Under Debian and Ubuntu there is a metapackage which contains all of them:

apt-get install build-essential subversion

Under SUSE, Redhat or Fedora, you're required to install several packages:

zypper install make automake subversion

1.11.2 Download from Sources

The easiest way is to download the sources in the 'tarball' format (.tar.gz, .tgz or .tar.bz2) and decompress them. For it, you have to go to the Pandora official web site and into the download section at http://pandorafms.com.

Other interesting option if you want to keep well informed and to use the latest code, stable or in development, is using the client from Subversion (svn) code version system. You may visit the development version at Pandora FMS official web site project http://pandorafms.org/index.php?sec=community&sec2=development&lang=es for it.

To download the development version code using the command line from the SVN client:

svn co https://svn.code.sf.net/p/pandora/code/

1.11.3 Agent Installation

The agents don't require compilation or preparation. Once you're acquired the agent package named 'pandorafms_3.0_unix.tar.gz', please perform the following:

1. Open a shell and acquire root privileges by entering:

su -

2. Copy the package to '/tmp' and execute:

tar xvzf pandorafms_3.0_unix.tar.gz 
./pandora_agent_installer --install

3. Start the agent manually by executing:

/etc/init.d/pandora_agent_daemon start

1.11.3.1 Custom Agent Installation

From Pandora FMS versions 3.1 and above, the agent is able to be completely installed in a custom defined directory, like e.g. '/opt/pandora'. This custom-defined directory is going to contain everything the agent has, e.g. configuration files, log files, plug ins and even man pages.

To use this method, just enter:

./pandora_agent_install --install /opt/pandora

The only file that Pandora FMS is going to create outside it's defined directory is the main agent's service launcher in '/etc/init.d/pandora_agent_daemon' (or equivalent under other UNIX branches) and the startup level link e.g. '/etc/rc.d/rc2.d/S90pandora_agent_daemon'.

It's also possible to perform an installation to execute the agent by other means than root. To execute it by the user 'Pandora', you have to e.g. install it by using the following command:

./pandora_agent_install --install /home/pandora pandora

When specifying a custom user, the agent has to be installed to a custom location where that user has to have write permissions ('/home/pandora' in the previous example).


Template warning.png

User pandora is disabled by default on most installs -by security-, you if you want to use pandora user for agent execution you first need to activate by setting a valid shell in /etc/passwd file

 


1.11.4 Console Installation

Once you've opened the console and arrived at the location of the compressed file named 'pandorafms_console-3.0.0.tar.gz' or similar, please follow the below mentioned steps:

1. We acquire root privileges by entering:

su -

2. We're copying it to '/tmp' and execute:

tar xvzf pandorafms_console-3.0.0.tar.gz 
cd pandora_console
./pandora_console_install --install

1.11.5 Server Installation

Once you've opened the console and arrived at the location of the compressed file named 'pandorafms_server-3.0.0.tar.gz' or similar, please follow the below mentioned steps:

1. We acquire root privileges:

su - 

2. We're copying it to '/tmp' and execute:

tar xvzf pandorafms_server-3.0.0.tar.gz 
cd pandora_server
./pandora_server_installer --install

If you're experiencing any dependency-related problems, you're required to rectify them before attempting any installation. We might be able to force the installation and ignore the problems with the dependencies, but Pandora FMS wouldn't work properly in this case.

1.11.5.1 Uninstallation / Manual Wipe from Server

If we have installed / updated several different versions, using different installation methods (RPM or tarball), we might reach a point in which we have various versions mixed up that could be using wrong versions of libraries or the server itself. The following procedure is aimed at detecting which versions are there and manually erase them:

Binaries should always be located under '/usr/local/bin', containing a link to '/usr/bin'. To test this, please enter the following commands:

ls -la /usr/local/bin/pandora_server
ls -la /usr/local/bin/tentacle_server
ls -la /usr/bin/tentacle_server
ls -la /usr/bin/tentacle_server

Pandora's libraries depend on their distribution's version. The following command should allow you to learn where they are and whether there are various ones or not:

find / -name "WMIServer.pm"

This is going to display a complete path where Pandora's library is installed, e.g.:

/usr/local/share/perl/5.10.0/PandoraFMS/WMIServer.pm

It could happen that various paths are displayed:

/usr/local/share/perl/5.10.0/PandoraFMS/WMIServer.pm
/usr/local/share/perl/PandoraFMS/WMIServer.pm

In such a case, we wouldn't know which one is in use, so our best option is to remove the entire directories and reinstall Pandora FMS:

 rm -Rf /usr/local/share/perl/5.10.0/PandoraFMS
 rm -Rf /usr/local/share/perl/PandoraFMS/

It's always a good idea to backup the '/etc/pandora/pandora_server.conf' ... just in case.

1.11.6 Server Code Update: Compilation and Manual Installation of the Server

There is another way other than via the generic installation script. You could 'compile' the Pandora FMS code by the Perl interpreter of its system. This process simply installs the libraries and the minimum required executables, but it doesn't touch the starting script system, the maintenance scripts, the configuration or any other thing other than the application and its libraries. This process is recommended if someone is forced to update the server code without overwriting its configuration.

Please decompress your server code under '/tmp' and follow the below mentioned steps:

1.We acquire root privileges:

2. We're copying it to '/tmp' and execute:

tar xvzf pandorafms_server-3.0.0.tar.gz 
cd pandora_server
perl Makefile.PL
make
make install

Please observe all errors which get returned by the console. If any dependency is missing or if there is any other problem, the system is going to notify you. If you observe a message like this:

Warning: prerequisiete Mail::Sendmail 0 not found
Warning: prerequisiete Net::Traceroute::PurePerl 0 not found

If displayed, it means there are some Perl packages that Pandora FMS requires and the system doesn't have them installed yet. Please check the previous paragraphs on how to install the previous required dependencies in Pandora FMS. You can however 'ignore' these errors (because they are warnings, not errors) and force the installation. Of course you'll experience problems in one moment or another, because there is a missing but required component. If you know the non-installed component and it's not going to be used (e.g. 'traceroute' is only used for the Pandora FMS Recon Server) you may go on.

After this process is completed, the files are automatically copied into the following directories:

/usr/local/bin/pandora_server
/usr/local/bin/pandora_exec

There are several '.pm' files (Perl libraries) that Pandora FMS requires. These '.pm' libraries are copied into several files, depending on its distribution and its version, e.g. under Ubuntu 9.04, they're copied into the following directories:

/usr/local/share/perl/5.10.0/PandoraFMS/

Under SUSE and SLES 11, they are copied into:

/usr/lib/perl5/site_perl/5.10.0/PandoraFMS/

1.12 Installing the Enterprise Version

In order to install the Enterprise version of Pandora FMS (besides installing the 'Open' packages of the console and server) we're required to install two additional packages to the console and server. The package called 'console' is going to depend on the distribution you have installed. We're going to use different packages for each distribution:

For Red Hat Enterprise Linux / CentOS / Fedora:

rpm -i pandorafms_console_enterprise-X.X.noarch.rpm

For OpenSUSE:

rpm -i pandorafms_console_enterprise-X.X.noarch.rpm

For Debian / Ubuntu:

dpkg -i pandorafms_console_enterprise_xxx.deb

To install the Enterprise Console by using the source code:

Once you've opened the console and arrived at the location of the compressed file named 'pandorafms_console-X.X.tar.gz' or similar, please follow the below mentioned steps:

1. You're acquiring root privileges by entering:

su -

2. Please copy it to '/tmp' and execute:

tar xvzf pandorafms_console-X.Xtar.gz 

Then please copy it to the directory in which your Pandora FMS open-source console is installed. It's either '/var/www/pandora_console' for Debian or Ubuntu, or '/srv/www/htdocs/pandora_console/' for SUSE, RH, Fedora, etc. (or any other directory, depending on your distribution).

Debian:

cp -R enterprise /var/www/pandora_console

OpenSUSE:

cp -R enterprise /srv/www/htdocs/pandora_console

3. Just change the permissions in case the files are intended to get used by the web server's user, e.g.:

Debian:

chown -R www-data /var/www/pandora_console/enterprise

OpenSUSE:

chown -R wwwrun /srv/www/htdocs/pandora_console/enterprise

It's recommended to conduct the License Activation at this point.


First make sure the open-source server version is installed. Then proceed to install the enterprise version in order to install the Enterprise Server.

Once you've opened the console and arrived at the location of the compressed file named 'pandorafms_server-X.X.tar.gz' or similar, please follow the below mentioned steps:

1. You're acquiring root privileges:

su - 

2. You're copying it to '/tmp' and execute:

tar xvzf pandorafms_server_enterprise-X.X.tar.gz 
cd pandora_server/
# ./pandora_server_installer --install

If the Pandora FMS Server Binary isn't contained in the default directory '/usr/bin', you'll have to indicate the directory as follows:

# PREFIX=/usr/local ./pandora_server_installer --install

After installing, the server is going to restart (/etc/init.d/pandora_server restart). Subsequently, the Enterprise Servers are going to be shown as enabled.



Pandora server view.png



1.13 Installation of the Pandora FMS Server and Console under Windows

From Pandora FMS versions 5.1 and above, there is a windows installer which allows us to install all together: Apache, PHP, MySQL, Pandora FMS and some dependencies necessary for the server and console operation under Windows.



Template warning.png

Pandora FMS Console & server setup in Windows is not recommended for production systems, due inferior performance compared with Linux. Windows setup is only intended for small enviroments, secondary servers, testing labs, evaluation purposes or/and hacking in general. We are working for next versions be more realiable, fast and complete. Remember this is our first version with support for Windows server/console setups.

 




It comes as a self-installer into executable format (.exe). For a basic installation, you're just required to accept all the options listed below. Please select the language:



Pandora agent 3.0 RC3 install windows 01.png



Please follow the installer steps:



Pandora server install windows 01.png



Please accept the license terms:



Pandora server install windows 02.png



Please select the components to install:



Pandora server install windows 03.png



This installer is mainly prepared for an installation on a computer which doesn't have an already installed Apache or MySQL. In case you have any other web server, such as IIS: It can be enabled, you're however required to disable it in order to work through Apache.

If you have a MySQL Server installed and running on the computer before installing the remaining components of Pandora FMS, you're required to change the MySQL root password for the user called 'pandora'. This change is necessary in order for the database to be created which has to be able to assign permissions to the Pandora FMS Database correctly. Once you've installed Pandora FMS on your computer, please feel free to replace the password.

After selecting the components to install, you're required to specify the installation path:



Pandora server install windows 04.png



The components are going to be installed by following this setup window. The only component which requires a user validation is Apache. Please accept all the conditions you're getting asked about:



Pandora server install windows 05.png



As denoted above, other components are installed besides MySQL and Apache. In case they have been already installed, you may see a message like this:



Pandora server install windows 06.png



Please wait until the files are copied and all the setup-related settings are carried out.



Pandora server install windows 07.png



Until the installation is complete as shown below.




Pandora server install windows 08.png



Once completed, it's going to open the browser on the login screen automatically. In cases you've installed the Enterprise Version, you're going to be asked for the license code which will be provided from Artica for implementation. Except for the Enterprise Version, the server is installed as a service and starts automatically during the installation process. If the installation of the Enterprise Version has been completed with no valid license code, the server is not going to boot.

In order to quickly start the process, please click on 'Start' and 'Programs'.




Pandora server install windows 09.png



Once the service is running properly, a ready-to-use console with all the servers is going to appear as shown on the picture below.




Pandora server install windows 10.png



1.13.1 Folders to consider in Windows

There are a set of directories you need to set correctly in Pandora FMS Setup. They are:

- Remote Config directory

- Attachment store



Path windows.png



- Server logs directory



Path windows2.png



- Custom graphviz directory



Path windows3.png



Template warning.png

It has been observed that in Windows 2008 Professional R2, is needed the installation of Microsoft Visual C++ 2008 for the proper operation of Apache.

 


Microsoft Visual C++ 2008
http://www.microsoft.com/es-es/download/details.aspx?id=29

1.14 Windows Agent Installation

The agent comes as a self-installer in executable format (.exe). The basic installation conducts all the required steps. It's only going to be necessary to accept all of the options. To install the Pandora FMS Agent under Windows, you're just required to download and to execute it. The installer is going to guide you though all the steps in your chosen language. The following example shows the installation for Windows Vista. Pandora FMS has been tested on all Microsoft Windows versions, from Windows 2000 to Windows 8, you have 32 and 64 bit versions of the agent.

Please select the language:



Pandora agent 3.0 RC3 install windows 01.png



Please follow the installer steps.



Pandora agent 3.0 RC3 install windows 02.png



Please accept the license terms here and click on 'next':



Pandora agent 3.0 RC3 install windows 03.png



Please select the path where you want the Pandora FMS Agent to be installed. You can change it by clicking on 'Browse'. After that, just klick on 'Next'.



Pandora agent 3.0 RC3 install windows 04.png



Please wait while the files are being copied.



Pandora agent 3.0 RC3 install windows 06.png



Please configure the agent's data such as IP (or name) of the Pandora FMS Server which is going to receive the agent's data and the data entry path (if you aren't sure whether you know the correct value or not, just leave it at the default value that's already in here).



Pandora agent 3.0 RC3 install windows 07.png



Please decide whether you want to start the Pandora FMS Agent's service in this moment. Contrary to common belief you're going to have to do this manually, otherwise Pandora FMS won't start automatically if Windows reboots.



Pandora agent 3.0 RC3 install windows 08.png



When the installation is finished, you may change the agent's parameters in the file named 'pandora_agent.conf' or by the direct link in the Pandora FMS Menu


1.14.1 Windows Agent - Unattended Installation

From versions 3 RC3 and above, Pandora FMS includes the option of installing the Windows Agent unattended. You're required to execute the agent installer, handing over the /mode Silent parameter, indicating the installation to be conducted unattendedly. Besides, you can hand over the /prefix <Ruta> parameter to indicate the complete installation path to the installer.

Please execute the following command where 'XXXXX' could change depending on the installers version, and <Ruta> is the complete path where we want to install it (in inverted commas if it has any spaces).

PandoraFMS_windows_agent_v3.0.XXXXX.setup.exe /mode Silent /prefix <Ruta>

In order to install the current version and to install e.g. in c:\agente_pandora\, you're required to execute the following:

PandoraFMS_windows_agent_v3.0.RC3.setup.exe /mode Silent /prefix c:\agente_pandora

This is going to install Pandora FMS along with the default values in the indicated path and starts the Pandora FMS service on the machine. It's necessary to execute this installing process by a user which bears the privileges to install software or services on the machine.

From the agent's versions 5.1 and above, the installer has changed. In order to install the agent in an unattended way, you're required to execute it in the following way:

PandoraFMS_agent_v5.1.exe /S

In case you intend to install the agent in a different path:

PandoraFMS_agent_v5.1.exe /S /D=C:\Agente_Pandora

1.14.2 Unattended Deinstallation

The uninstaller is an executable called ' uninstall.exe' which remains in the Pandora FMS installation directory. It also allows the unattended deinstallation for it. You're required to execute the unistaller by the /mode Silent option to use it.

Let's assume that Pandora FMS is installed in the default path:

c:\archivos de programa\pandora_agent

You're required to execute it in the following way:

“c:\archivos de programa\pandora_agent\uninstall.exe” /mode silent

1.14.3 Manual Installation of Windows Agent

The Windows Agent can be installed manually. To learn in which way the manual installation works also serves to understand how the Agent works internally and to be able to reset some parameters of the installation later.

Assuming that all the agents necessary files are obtained including their directory structure, they are summarized below.

  • PandoraAgent.exe: The Pandora FMS service executable. We'll later see that it accepts any parameters useful for us.
  • pandora_agent.conf: The main configuration file.
  • libcurl.dll: The library used by Pandora FMS to upload the files by FTP.
  • libeay32.dll: The library used to encrypt connections (SSH and Tentacle) by Pandora FMS.
  • zlub1.dll: The Library used to compress data by Pandora FMS.
  • libodbc++.dll: The library used for ODBC checking by Pandora FMS.
  • pandora_agent.log: The agents main log.
  • pandora_debug.log: The agents main log (as debug).
  • /util: In the 'util' directory, there are several 'typical' given UNIX tools to Win32 such as 'grep', 'gawk', 'wc', 'head', 'tail', etc.

There is also the Tentacle client named 'tentacle_client.exe. It's the one used to send the packages to the Pandora FMS Server.

All these files can be obtained from our code repository (subversion) under 'sourceforge.net'.

Another easier solution is to compress a ZIP file from the contents of a currently installed agent. Just zip the contents of the directory named 'c:\program files\pandora_agent' and decompress it within the appropriate sub folder on the desired system.

1.14.3.1 Using 'PandoraAgent.exe' from the Command Line

If we're executing 'pandoraagent.exe' including the '--help' parameter, it's going to show something like this:

Pandora agent for Windows. Version 3.0 (Build 090924)
Usage: 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.

To install the service (if not already installed), please execute the following command from the directory where the '.exe' is residing, e.g. 'c:\program files\pandora_agent':

pandoraagent.exe --install

This command is going to install the service on the machine, building on the path where the '.exe' is located. If we want to remove it, it's the same process, but with a differt option:

pandoraagent.exe --uninstall

Depending on the kind of the selected Windows system, it's possible that you may have to reboot the system after removing the service. On other systems, the change is inherited without the need for a reboot.

If you want to try a FTP or SSH connection from the command line, you may use the above mentioned options.

1.14.3.2 Pandora FMS Windows Agent as a Process

For debugging reasons, tests and other unusual circumstances, it's possible to execute the agent the way processes usually do. To get this done, please execute the following command:

pandoraagent.exe --process

There are some restrictions to the execution in process mode. Pandora FMS is meant to be executed as service and a user system. If you execute it by means of other users without privileges, there are going to be some functions which aren't going to work properly.

1.14.4 Pandora FMS for Windows NT4

This agent is a porting of the UNIX agent, compiled in Perl by the 'ActiveState DevKit' Perl compiler. It's a stand-alone EXE file, equipped with all the tools required to run. It comes with the same features as the UNIX agent, but it runs on an NT4 box. This means it can execute commands and change the output in a way to produce usable data for Pandora FMS.

It was created to be used on any Windows machine (NT4, Win95, Windows 2000-2008 and Windows 7) and could be useful on Windows embedded systems without WMI core (which renders the standard Pandora FMS Windows Agent not to run properly).

1.14.4.1 Installing the Agent

Please copy all contents on a directory of your choice, e.g. 'c:\pandora'.

Edit the 'pandora_agent.conf' and set your parameters, including the log file and the temporary directory. It should be something like 'c:\pandora\temp' and 'c:\pandora\log'. Please make sure the appropriate directories exist before trying to start the Pandora FMS Agent.

1.14.4.2 Running the Agent

This agent doesn't run as a service. You're required to install by the startup menu or by hand. The shortlink you're creating has to have a parameter, which is where the main Pandora FMS agent directory is located. In this scenario, it's 'c:\pandora'. The start-up command has to be the following:

c:\pandora\pandora_agent.exe c:\pandora

1.14.4.3 Installation as a Service

The 'srvany.exe' tool is intended to perform this task. It's a Microsoft resource kit tool and capable to use any '.exe' file as a service. Please read the documentation on how to use 'srvany' tool. It's contained in this package.

1.15 Embedded Agent

Pandora FMS has a very special agent, called the "embedded" agent. It's a pure C development, designed to be entirely cross-plattform compatible. You're only required to have the GNU C compiler to compile. You may link and use it in any available system. We have tested it in a few ARM enviroments. It doesn't require anything special and should be able to run on any system equipped with a GNU C compiler.

In order to use it, you'll also require to compile and link the Tentacle client protocol to send information to the Pandora FMS Server.

To compile both, you're going to require the GNU C extensions and autotools (e.g. 'autoconf', 'automake', 'pkg-config', etc).

You'll require sources for the embedded agent from our SVN or file release section on Sourceforge AND the code for Tentacle Client from our SVN or the download section as a separate file.

1.15.1 Basic Installation

The simplest way to compile this package is the following:

1. 'cd' to the directory containing the package's source code and type './configure' to configure the package for your system. If you're using 'csh' on an old version of System V, you might need to type 'sh ./configure' instead (to prevent 'csh' from trying to execute 'configure' itself).

Running 'configure' takes a while. While running, it gives back some messages, telling for which features it's checking for.

2. Type 'make' to compile the package.

3. Optionally, type 'make check' to run any self-tests that comes along with the package.

4. Type 'make install' to install the programs, all data files and the documentation.

5. You may remove the program binaries and the object files from the source code directory by executing 'make clean'. To also remove the files created by the 'configure' command (to compile the package for a different kind of computer), please execute 'make distclean'. There is also a 'make maintainer-clean' target, but it's mainly intended for the package developers. If you use it, you may have to get all sorts of other programs in order to regenerate files which came along with the distribution.

1.15.2 Installation Names

By default, 'make install' is going to install the package's files in '/usr/local/bin', '/usr/local/etc', etc. You may specify an installation prefix other than '/usr/local' by giving 'configure' the option of '--prefix=PATH'. The command 'make install' is going to install the following files by default:

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

You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you give 'configure' the option '--exec-prefix=PATH', the package is going to use 'PATH' as the prefix for installing programs and libraries. The documentation and other data files are still going to use the regular prefixes.

In addition, if you use an unusual directory layout, you may execute options like '--bindir=PATH' to specify different values for particular kinds of files. Please execute 'configure --help' for a list of the directories you can set up and which types of files go into them.

If the package supports it, you can cause programs to be installed by an extra prefix or suffix on their names by giving 'configure' the option of '--program-prefix=PREFIX' or '--program-suffix=SUFFIX'.

1.15.3 Features of the Embedded Agent

In this moment, the agents supports the basic features only, which means there are only the 'module_exec' and the 'module_plugin' method to obtain information. All information you're gathering from the system must be done by using an external command execution.

2 Initial Configuration after Installation

The order you should follow after Installation is:

  1. Create the database through the Pandora FMS web console installation wizard.
  2. Modify the server configuration including the access credentials to the BBDD that have been generated by the previous step.
  3. Start server Arrancar servidor.
  4. Start the local agent (if required).
  5. Go to Pandora FMS for the first time to start using it.

2.1 Console Initial Configuration

Assuming we are going to execute all components (Database, Console, Server and Agent) on the same machine: If you haven't done it already, please start the MySQL server and create an Admin password (root).

/etc/init.d/mysql start

Now create the password, for example "pandora123" for your MySQL root user:

mysqladmin password pandora123

Then start the Apache Server on your server:

/etc/init.d/apache2 start

You may get to your server IP address through the web to conduct the Pandora FMS post-installation now. This post-installation serves to create the Pandora FMS database and to configure the access credentials (user, password, name of database) in the Pandora Server to the established user DB.


If your server's IP is e.g. '192.168.5.54', please put the following line into the address bar of your browser:

http://192.168.5.54/pandora_console/install.php

From now on, you're just required to follow the below mentioned steps in order to create the Pandora FMS DB.



Pandora install 1.png



Please klick on 'Next'.



Pandora install 2.png



This screen is intended to verify that all software dependencies have been properly installed.

Note: If you're required to install some dependencies, it's going to be necessary to restart the web server in order to use it.



Pandora install 3.png



At this point, it configures the access data to your MySQL server. You're required to enter the root password which you've created in the previous step (which was 'pandora 1234' in the example).



Pandora install 4.png



You're required to enter the password for database access here.



File:Paso5.png



Installation complete.



Paso6.png



In this point, you're required to delete "install.php" manually. Please go to the Pandora FMS Console install directory and delete the 'install.php':

  • (DEBIAN/UBUNTU) /var/www/pandora_console
  • (FEDORA/CENTOS/REDHAT) /var/www/htdocs/pandora_console
  • (SUSE) /srv/www/htdocs/pandora_console

To delete a file under Linux, please use the 'rm' command in the following way:

rm install.php

2.1.1 License Application

The Pandora FMS Enterprise version bears a different license key associated to each installation. To use the Enterprise Features and the console's remote updates, you're required to enter the license code in the console configuration section.

After installing the Enterprise version's Pandora FMS Console by any installation method, you're required to access the Pandora Console (http://IP/pandora_console/). Subsequently, the following welcome screen to accept the license is going to appear:


License accept.png


After accepting the license, the Pandora FMS Database schema is going to change, adding required new tables for the use of the Enterprise Version. In this moment, a new screen to register the license key, which Artica has sent to you, is going to appear:


License setup.png


For versions prior to Pandora FMS 5, you're required to enter the license key directly. For Pandora FMS Versions 5 and above, you're required to perform a specific procedure, which is thoroughly explained in a welcome document which is going to be shipped along with the License to you.


Template warning.png

It's very important -not- to start the 'pandora_server' daemon until the Enterprise Version's Pandora FMS Console has been properly installed, because numerous different errors might occur if you do so before completing the process.

 


2.2 Server Initialization and Basic Configuration

Pandora FMS has configured your database and created a MySQL user for gaining access to it. It has created a random password for the 'pandora' user that should be the one which was used to modify the defined password in the Pandora FMS Server.

For this last step, you're required to edit the file named '/etc/pandora/pandora_server.conf' from your Pandora installation and look for the following line:

dbpass pandora

Then replace 'pandora' for the password which was created by the wizard. Once this is done and the file is saved, you're able to start the Pandora FMS server by entering the following command:

/etc/init.d/pandora_server start

The server should return start values like the ones below.

Pandora FMS Server 3.0-dev Build PS090915 Copyright (c) 2004-2009 ArticaST
This program is OpenSource, licensed under the terms of GPL License version 2.
You can download latest versions and documentation at http://www.pandorafms.org 

 [*] Backgrounding Pandora FMS Server process.
 

The Pandora Server is now running with PID 2085.


Info.png

The Tentacle Server is configured to start along with the system boot. If you intend to work with the Pandora FMS Server without rebooting the machine, it's recommended to restart this service by hand.

 


2.3 Initial and Basic Configuration of the Agent

You can start your machines local agent (it comes preconfigured to send data to the same machine where it's running, using tentacle), to start collecting data automatically:

/etc/init.d/pandora_agent_daemon start

You're now able to gain access to your Pandora FMS WEB console by the following URL:

http://x.x.x.x/pandora_console

x.x.x.x is the IP of the machine on which you've installed the Pandora FMS Console.

Go back to Pandora FMS documentation index