Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


Panel
titleSommaire

Table of Contents
stylenone



Description

Le listener-rest est une source qui expose une API REST permettant d'ajouter de nouveaux hôtes via des requêtes HTTP contenant un objet décrivant un hôte au format JSON.

Voici un exemple de requête avec cURL :

Code Block
themeEmacs
curl -u USER:PASSWORD \
     -H "Content-Type: application/json" \
     -d '{"host_name":"my_host", "use":"linux", "address":"192.168.1.254"}' \
     -X PUT 'http://SYNCHRONIZER-IP-INTERFACE:7761/shinken/listener-rest/v1/hosts/'


Configuration

Voici le fichier CFG de configuration présent dans : /etc/shinken/listeners/listener-rest.cfg

Exemple de fichier de configuration



Code Block
languagejs
#===============================================================================
# listener-rest
#===============================================================================
# Daemons that can load this listener:
# - synchronizer
#===============================================================================
 
 
define listener {
    listener_name           listener-rest

	#======== Module identity ========= 
	# Listener type (to load module code). Do not edit. 
	module_type 			listener-rest

	order                   5
    import_interval         0
 
    # enabled: is this listener enabled or not
    enabled                 0
 
    # description: display a description on the interface for this source
    description             The listener-rest allow listening by HTTP(s)/REST hosts
  
    #======== Listening address =========
    # host: IP address to listen to.
    # note: 0.0.0.0 = all interfaces.
    host                    0.0.0.0
 
    # port to listen
    port                    7761

 }


Option du module

Adresse de

Communication avec l'API

REST


nomtypedéfautcommentaire


Code Block
host


Texte ( adresse IP )0.0.0.0
Adresse IP

Interface réseau sur la quelle l'API REST va écouter. Il n'est possible de mettre qu'une seule valeur.

Info

L'adresse 0.0.0.0 correspond à toutes les interfaces réseau.



Code Block
port	


Texte ( port réseau )7761Le port réseau sur le quel l'API REST va écouter.