Page History

Scroll Ignore

scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	true

Panel

title	Sommaire

Table of Contents

style	none

Description

Le WebService-receiver est receiver-module-webservice est le module qui permet de recevoir des résultats passifs pour des hôtes ou checks via statuts et des contextes d'éléments en mode Passif ( voir la page Mode actif et mode passif ) via une API HTTP(s).

Ce module met à disposition une écoute HTTP pour les requêtes HTTP POST et effectue des actions sur hôtes, clusters et checks.

Le Web Service Le module écoute sur port TCP 7760 TCP 7760 ( par défaut ).
Il supporte les accès authentifiés ou anonymes.

La configuration se définit dans le fichier de configuration du module ( présent par défaut dans /etc/shinken/modules/wsreceiver-module-receiverwebservice.cfg ).

Ce module permet notamment de recevoir et traiter les statuts envoyés par les traps SNMP ( Voir la page Script d'interprétation des traps avec le module receiver-module-webservice )

Activation du module

Le module receiver-module-webservice est un module qui peut être activé seulement sur le démon Receiver.

L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du démon Receiver.
Pour se faire, ouvrez le fichier de configuration du Reveiver Receiver à l'emplacement /etc/shinken/receivers/nom_du_receiver.cfg, et ajouter le nom de votre module "receiver-module-webservice".

Exemple : par défaut, nous livrons un module dont le nom est "receiver-module-webservice" :

Code Block
define receiver { [...] modules Module 1, Module 2, Module 3, receiver-module-webservice [...] }

Pour prendre en compte le changement de configuration, redémarrez l'Arbiter :

Code Block
service shinken-arbiter restart

Configuration

La configuration du module se trouve par défaut dans le fichier /etc/shinken/modules/receiver-module-webservice.cfg

Vous trouverez aussi un fichier d'exemple avec le chemin suivant : /etc/shinken-user-example/configuration/daemons/receiver/receiver-module-webservice/receiver-module-webservice-example.cfg

Exemple de fichier de configuration

Code Block

language	js

#===============================================================================
# wsWebService-arbiterReceiver   (webservice)
#===============================================================================
# Daemons that can load this module:
# - receiver
# - arbiter
# This module is a webservice that can be used to send checks to Shinken Enterprise
# as POST HTTP(s)
#===============================================================================


define module {

    #======== Module identity =========
    # Module name. Must be unique
    module_name               receiver-module-webservice
    # Module type (to load module code). Do not edit.
    module_type               ws_arbiter


    #======== Listening address =========
    # host: IP address to listen to.
    #       note: 0.0.0.0 = all interfaces.
    host                      0.0.0.0

    # port to listen
    port                      7760

    # HTTPs part, enable if you want to set the listening for HTTPS instead of default HTTP.
    # disabled by default. Set your own certificates.
    use_ssl                   0
    ssl_cert                  /etc/shinken/certs/server.cert
    ssl_key                   /etc/shinken/certs/server.key


    #======== HTTP authentication =========
    # You can use HTTP basic authentication method for this module.
    # If username is set to anonymous and password is commented, then
    # no authentication will be required.
    username                 anonymous
    #password                secret


}

Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type "receiver-module-webservice" dans votre architecture Shinken.

Chaque instance devra avoir un nom unique.

Nom

Type

Unité

Défaut

Commentaire

Code Block
module_name

Texte

---

receiver-module-webservice

Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir.

Doit être unique.

Code Block
module_type

Texte

---

receiver-module-webservice

ws_arbiter

Ne peut être modifié.

Configuration de l'interface et du port d'écoute

Code Block

language	js

#======== Listening address ========= 
# host: IPv4 address to listen to. 
# note: 0.0.0.0 = all interfaces. 
host 0.0.0.0 

# port to listen 
port 7760

Il est possible de configurer l'interface réseau sur laquelle est mise à disposition l'API. Si par exemple l'API ne doit être accessible seulement via un réseau local, il est possible de n'écouter les requêtes que sur cette interface réseau.

Les paramètres suivants permettent de configurer l'accès à l'API :

Nom Type Unité Défaut Commentaire

Code Block
host

Texte

Adresse IPv4

0.0.0.0

L'interface réseau sur laquelle le module "receiver-module-webservice" va écouter.

Code Block
port

Texte

Port réseau

7760

Port réseau sur lequel le module "receiver-module-webservice" va écouter.

Sécurisation de la communication avec le module

Code Block

# HTTPs part, enable if you want to set the listening for HTTPS instead of default HTTP.
# disabled by default. Set your own certificates.
use_ssl 					0 
ssl_cert 					/etc/shinken/certs/server.cert 
ssl_key 					/etc/shinken/certs/server.key

L'API du module est accessible via HTTP. Il est recommandé d'utiliser le protocole HTTPS pour chiffrer la communication avec le module.

Si pour des raisons de sécurité, cette API doit être accessible via HTTPS, il est possible de configurer les certificats avec les paramètres suivants :

Nom

Type

Unité

Défaut

Commentaire

Code Block
use_ssl

Booléen

---

0

Permet d'activer ou non l'utilisation du protocole HTTPS.

0 : Désactivé ( utilise HTTP )
1 : Activé ( utilise HTTPS )

Code Block
ssl_cert

Texte

Chemin

/etc/shinken/certs/server.cert

Chemin vers le certificat SSL utilisé par le protocole HTTPS.

Code Block
ssl_key

Texte

Chemin

/etc/shinken/certs/server.key

Chemin vers la clé SSL utilisée par le protocole HTTPS.

Authentification HTTP

Code Block

language	js

#======== HTTP authentication =========
# You can use HTTP basic authentication method for this module.
# If username is set to anonymous and password is commented, then
# no authentication will be required.
username anonymous
#password secret

Afin d'être authentifié auprès du module, il est possible de configurer les identifiants à utiliser dans les requêtes, dans la configuration du module grâce au aux paramètres suivants :

Nom

Type

Unité

Défaut

Commentaire

Code Block
username

Texte

---

anonymous

Nom d'utilisateur.

Code Block
password

Texte

---

secret

Mot de passe.

Info

Lors d'une requête cURLcurl, les identifiants se renseignent grâce à l'option -u

Code Block

language	js

curl -u anonymous:secret -X POST ...

Page tree

Versions Compared

Old Version 20

New Version Current

Key

Description

Activation du module

Configuration

Exemple de fichier de configuration

Détails des sections composant le fichier de configuration

Identification du module

Configuration de l'interface et du port d'écoute

Sécurisation de la communication avec le module

Authentification HTTP