Installation und Benutzung der Icinga-API
Zurück | Kapitel 11. Entwicklung | Weiter

## Installation und Benutzung der Icinga-API

Voraussetzungen

Sie benötigen installierte und lauffähige Versionen von Icinga und IDOUtils oder MKLiveStatus, um die Icinga-API nutzen zu können.

| Anmerkung
Falls Sie Icinga noch nicht installiert haben, folgen Sie den Anweisungen in der quickstart-idoutils-Dokumentation.

Wenn Sie die IDOUtils-Datenbank als Datenquelle verwenden, installieren Sie bitte PHP-PDO.

- RHEL/Fedora/CentOS

  Stellen Sie sicher, dass Sie ein Repository/Packages für PHP 5.2.x zur Verfügung haben - RHEL/CentOS (CentOS <= 5.4) unterstützen lediglich 5.1.6.

       # yum install php-pdo php-mysql|pgsql

- Debian/Ubuntu

       # apt-get install php5 php5-mysql|pgsql

- openSuSE;

  Bitte benutzen Sie yast zur Installation der Pakete php5, php5-pdo und php5-mysql bzw. php5-pgsql.

Installation und Konfiguration

1. Software

   Klonen Sie von icinga-api.git, um einen neuen Branch zu bekommen:

        # git clone git://git.icinga.org/icinga-api.git

   oder laden Sie die Software von https://git.icinga.org/index?p=icinga-api.git;a=snapshot;h=refs/heads/master;sf=tgz.

2. Installation

   | Anmerkung
   Die Icinga-API ist innerhalb des Pakets von Icinga Core, IDOUtils und Docs enthalten und wird während 'make install' mit installiert. Sofern Sie das schon durchgeführt haben, befindet sich die API standardmäßig in /usr/local/icinga/share/icinga-api/ und Sie können diesen Abschnitt überspringen.

   | Anmerkung
   Wenn Sie die Icinga-API für das neue Icinga-Web benötigen und schon Icinga Core mit den IDOUtils installiert haben, können Sie diesen Guide verlassen und direkt Icinga-Web installieren.

   Download

   Sie können die Icinga-API direkt aus dem GIT Repository beziehen, für einen frischen Clone führen Sie folgenden Befehl aus:

        # git clone git://git.icinga.org/icinga-api.git

   Sofern Sie lediglich ein Update benötigen:

        # cd icinga-api && git pull origin master

   Oder laden Sie einen Snapshot direkt über das Gitweb: https://git.icinga.org/index?p=icinga-api.git;a=snapshot;h=refs/heads/master;sf=tgz.

   Installation

   Entpacken Sie die Icinga-API, führen Sie configure aus und installieren Sie die Icinga-API

        # tar xzvf icinga-api-(version).tar.gz

        # ./configure

   Sie können den Präfix definieren, wohin die Icinga-API installiert wird, sowie den Ort der Systemkonfiguration für Icinga Core und IDOUtils und die ausführenden Benutzer. All diese Informationen werden bei einer Installation durch das Core Paket direkt gesetzt.

        # ./configure --datarootdir=/usr/local/icinga/share \
           --sysconfdir=/usr/local/icinga/etc \
           --with-command-user=icinga-cmd \
           --with-command-group=icinga-cmd \
           --with-icinga-user=icinga \
           --with-icinga-group=icinga \
           --with-web-user=www-data \
           --with-web-group=www-data

   | Anmerkung
   Die --with-web...-Direktiven müssen gesetzt sein. Anderenfalls werden die Web-Logs nicht korrekt erstellt. Außerdem kann dies zu einem leeren Haupt-Cronk führen. Bitte beachten Sie, dass die Werte von 'user' und 'group' abhängig von der Distribution sind.

        # make install

Konfiguration

Wenn Sie Ihr eigenes Addon auf Basis der Icinga-API entwickeln möchten, benötigen Sie das folgende assoziative Array:

     $idoConfig = array (
        'type'         => '<Type of database>',
        'host'         => '<Database hostname>',
        'database'     => '<Databasename>',
        'user'         => '<Username>',
        'password'     => '<password>',
        'persistent'   => <true | false>,
        'table_prefix' => '<table prefix>',
     );

Beispiel:

     $idoConfig = array (
        'type'         => 'mysql',
        'host'         => 'localhost',
        'database'     => 'ido',
        'user'         => 'idouser',
        'password'     => 'idopassword',
        'persistent'   => true,
        'table_prefix' => 'icinga_',
     );

Unterstützte Backends

Aktuell sind folgende Backend Typen verfügbar. Mehr Information finden Sie unter doc/icinga-api-types.txt.

- IDOUtils DB - OK

- Livestatus Modul - experimentell, noch nicht produktiv einsetzbar.

- Dateibasierend, status.dat - experimentell, noch nicht produktiv einsetzbar.

Benutzung

1. Datenermittlung

   Host-Namen und zugehörige Zustände

   Erzeugen Sie eine Instant der Klasse IcingaApi:

        $api = IcingaApi::getConnection(IcingaApi::CONNECTION_IDO, $idoConfig);

   Erzeugen Sie die Suchkriterien:

        $apiRes = $api->createSearch()
        ->setSearchTarget(IcingaApi::TARGET_HOST)
        ->setResultColumns(array('HOST_NAME', 'HOST_CURRENT_STATE'))
        ->fetch();

   Mit Hilfe von setSearchFilter() können Sie Filter benutzen, um die Suche einzuschränken:

        $apiRes = $api->createSearch()
        ->setSearchTarget(IcingaApi::TARGET_HOST)
        ->setResultColumns(array('HOST_NAME', 'HOST_CURRENT_STATE'))
        ->setSearchFilter(HOST_NAME, 'Switch%', IcingaApi::MATCH_LIKE)
        ->fetch();

2. Verarbeiten der Ergebnisse

        foreach($apiRes as $apiHandle){
           echo 'Host '.$apiHandle->HOST_NAME.' has state '.$apiHandle->HOST_CURRENT_STATE.'<br />';
        }

   Ausgabe ohne Filter:

        Host localhost has state 0
        Host MySql has state 0
        Host router-01 has state 0
        Host windows100 has state 0
        Host Apache_01 has state 0

   Ausgabe mit Filter:

        Host switch70 has the current state 0
        Host switch71 has the current state 0
        Host switch72 has the current state 0
        Host switch73 has the current state 0
        Host switch74 has the current state 0
        Host switch75 has the current state 0
        Host switch76 has the current state 0
        Host switch77 has the current state 0

3. Kompletter Code ohne die Nutzung von Filtern

        <?
        // Path to icinga api file
        $apiFile = 'icinga-api/IcingaApi.php';

        // Database connection
        $idoConfig = array (
           'type'         => 'mysql',
           'host'         => 'localhost',
           'database'     => 'ido',
           'user'         => 'idouser',
           'password'     => 'idopassword',
           'persistent'   => true,
           'table_prefix' => 'icinga_',
        );

        // Include required files
        require_once($apiFile);

        // Instance the class
        $api = IcingaApi::getConnection(IcingaApi::CONNECTION_IDO, $idoConfig);

        // Create search
        $apiRes = $api->createSearch()
        ->setSearchTarget(IcingaApi::TARGET_HOST)
        ->setResultColumns(array('HOST_NAME', 'HOST_CURRENT_STATE'))
        ->fetch();

        // Create output
        foreach($apiRes as $apiHandle){
           echo 'Host '.$apiHandle->HOST_NAME.' has the current state '.$apiHandle->HOST_CURRENT_STATE.'<br />';
        }
        ?>

   Für nähere Informationen werfen Sie bitte einen Blick in das git repository oder die Beispiele im doc/examples-Verzeichnis.

Zurück | Nach oben | Weiter
Liste der externen Befehle | Zum Anfang | Die Icinga-Web REST API

© 2009-2011 Icinga Development Team, http://www.icinga.org