Le WebService-receiver est le module qui permet de recevoir des résultats passifs pour des hôtes ou checks via HTTP(s).
Configuration du module Webservice
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 écoute sur port 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/ws-receiver.cfg ).
| Code Block | ||
|---|---|---|
| ||
#===============================================================================
# WebService-Receiver (webservice)
#===============================================================================
# Daemons that can load this module:
# - receiver
# 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 authentification =========
# You can use HTTP basic authentification method for this module.
# If username is set to anonymous and password is commented, then
# no authentification will be required.
username anonymous
#password secret
} |
Description des clés :
| Clés | Description |
|---|---|
| module_name | Définit un nom unique pour le module |
| module_type | Doit être ws_arbiter |
| host | Adresse de l'interface réseau sur laquelle effectuer l'écoute. 0.0.0.0 signifie "toutes les interfaces" |
| port | Port TCP à écouter |
| use_ssl | Définissez cette clé à la valeur 1 pour permettre au module d'écoute sur le port en SSL afin d'utiliser le protocole HTTPS et ainsi de sécuriser la connexion. Par défaut cette propriété est définie à 0 (protocole HTTP). |
| ssl_cert / ssl_key | Ces deux clés permettent de définir le certificat et la clé SSL du serveur utilisé lorsque le module écoute sur le port SSL. |
| username et password | Si vous souhaitez qu'une authentification soit nécessaire pour utiliser ce module, il faudra définir un nom utilisateur et un mot de passe. Si vous ne souhaitez pas une authentification, définissez la valeur "anonymous" pour les username et password |
| Note | ||
|---|---|---|
| ||
Pour activer le module, ajouter simplement à votre Receiver le module receiver- module ws-webservicereceiver à la liste des modules dans le fichier de configuration de votre receiver situé dans /etc/shinken/receivers/. Sur une architecture distribuée importante, si vous avez plusieurs Receivers, vous pourrez activer un module receiver- module ws-webservicereceiver par Receiver. |