Versions Compared

Old Version 2

changes.mady.by.user Jroy

Saved on

compared with

New Version Current

changes.mady.by.user Soubrié Grégoire

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=clean_macro_parameter
Scroll Ignore
scroll-html
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmlfalse
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtruefalse
Panel
titleSommaire

Table of Contents
stylenone

Description

Le webservice du Receiver module écoute des requêtes HTTP pour ensuite effectuer des actions sur les hôtes/clusters ou checks concernés.

Un simple curl ou appel HTTP dans votre programme suffit pour envoyer des actions à Shinken.

Mettre un

Poser ou Enlever une Prise en compte sur un hôte, un cluster ou un check

Paramètres de l'appel

NomObligatoireDescription
user
(tick)Nom de l'utilisateur
password
(tick)Mot de passe de l'utilisateur
Méthode HTTP utilisé
(tick)POST
action

Options disponibles:
add, delete. Ajoute un

  • add : ajoute la prise en compte ( par défaut )
  • delete : supprime la prise en compte
.Par défaut: add
time_stamp
(optionnel) 

La date d'activation de la prise en compte.
  • Par défaut, la date d'appel de l'API sera utilisée.
host_name
(tick)Nom de l'hôte
 cible
service_description

Nom du check 
 cible 
 ( si 
 résultat est celui d'
la cible un check )
comment

Le commentaire de la prise en compte
 (optionnel)
notify
1 ou 0 pour 

Permet de notifier les contacts ( qui sont signalés sur l'
équipement 
élément comme recevant les notifications
 de changement sur cet élément.
 ).
  • 1 : envoi de notification
  • 0 : pas d'envoi de notification
author
L

Nom de l'auteur de la prise en compte.
  • Par défaut "anonyme" qui correspond à un utilisateur lambda non déclaré dans Shinken Enterprise.
sticky
Si sticky=1, 

Défini le mode de suppression automatique de la prise en compte.
  • 1 : la prise en compte est automatiquement enlevée lorsque 
 l'état est OK. Si sticky=2, 
Par défaut, sticky=1.
Option présente dans Shinken Framework, dépréciée dans Shinken Entreprise.
persistentSi persistent=1, 
  • le statut change ( par défaut ).
Le statut inconnu est ignoré pour déterminer la suppression.
      • La logique du statut INCONNU est de ne pas savoir quel état est l'élément, donc Shinken considère qu'on ne peut pas perdre une Prise en compte, en passant dans ce statut.
La prise en compte ne s'enlèvera pas dans les cas suivants :
      • si ATTENTION ⭢ INCONNU
      • si CRITIQUE ⭢ INCONNU
      • si ATTENTION ⭢ INCONNU ⭢ ATTENTION
      • si CRITIQUE ⭢ INCONNU ⭢ CRITIQUE
  • 2 : la prise en compte est automatiquement enlevée lorsque 
 l'état change, peu importe, l'état (Warning → Critique par exemple).
  • le statut devient OK.
La valeur par défaut est modifiable dans le fichier shinken.cfg ( voir la page Fichier de configuration ( shinken.cfg ) ).
 Note
Attention, si vous modifiez la valeur par défaut dans le fichier shinken.cfg, elle impactera la valeur pour l'UI de Visualisation.
persistent
(minus)
( déprécié )
Défini si 
la prise en compte sera toujours présente après un redémarrage des services Shinken.
  • 1 : la prise en compte sera toujours présente
 Dans Shinken Entreprise, ce comportement est celui par défaut et ne peut pas être changé. 
 Option présente dans Shinken Framework, dépréciée dans Shinken Entreprise.  

Exemple:
noformat
 Code Block
languagetext
themeEmacs
curl -u user:password -X POST -d "time_stamp=$(date +%s)&host_name=host-checked&service_description=service-checked&
comment=Nous sommes entrain de corriger le problème&notify=1" http://shinken-srv:7760/acknowledge