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

Les sources d'import par fichier permettent d'utiliser des fichiers de configuration existants pour importer des éléments.


La syntaxe de ces fichiers d'import est très proche de la syntaxe Nagios, à laquelle s'ajoute quelques clés spécifiques à Shinken Entreprise.


Warning

Les fichiers d'imports .cfg doivent être créer ou éditer avec l'encodage utf-8

Info

Pour créer un

commentaire ou

COMMENTAIRE ou mettre une ligne en

commentaire

COMMENTAIRE dans le fichier .cfg, il faut

placer dans

  • Utiliser le caractère "#" au début de la ligne
soit
  • Utiliser le
caractère
  • "
#" soit le caractère "
  • ;"
.
  • pour les fin de ligne

Les lignes commentées ne seront pas lues et donc pas

importés

importées.

panel
Code Block

Sommaire

Table of Contents

themeEmacs

Les hôtes

code
define host {
	##### l’hôte que l'on veut définir ####  <= un commentaire au début de la ligne
    host_name 	Serveur1
    address 	192.168.1.16 ; adresse interne <= un commentaire en fin de ligne.
}

Les hôtes

Code Block
define host {
	##### Définition générale de l’hôte ####
    host_name 					[OBLIGATOIRE]	*Nom de l'hôte*
	name						[OBLIGATOIRE]	*Nom de l'hôte (lorsqu'il s'agit d'un modèle d'hôte)*
	display_name								*Description*
    address 									*Adresse de l'hôte*
    use 										*Liste des modèles d'hôte à utiliser*
    hostgroups 									*Liste des groupes d'hôtes dans lesquels appartient l'hôte*
    realm 										*Royaume de l'hôte*
    business_impact 							[0-5]; Impact métier de l'hôte
    parents 									*Liste des hôtes desquels dépend cet hôte (d'un point de vue réseau)*
    notes_url 									*URL externe pouvant donner des informations supplémentaires sur l'hôte*
    notes_multi_url								*Propriété utilisée pour définir plusieurs URL *
    enabled 									[0/1]; Est ce que l'hôte est activé/désactivé ?
    pack 									    *Pack auquel appartient l'hôte*
 
	#### Données ####
	_NOMDEDONNEE								*valeur de la donnée*
 
	#### Droits de l'utilisateur ####
	view_contacts								*Les utilisateurs qui voient l'hôte*
	view_contact_groups							*Les groupes d'utilisateurs qui voient l'hôte*
	notification_contacts						*Les utilisateurs à notifier*
	notification_contact_groups					*Les groupes d'utilisateurs à notifier*
	edition_contacts							*Les utilisateurs peuvent modifier la configuration de l'hôte.*
	edition_contact_groups						*Les groupes d'utilisateurs qui peuvent modifier la configuration de l'hôte.*
    
	contacts 									*Liste des contacts qui pourront Voir/Editer/EtreNotifié*
    contact_groups 								*Groupes d'utilisateurs qui pourront Voir/Editer/EtreNotifié*
	
	#### Parametres de supervision ####
    check_period 								*Période de temps pendant laquelle les checks sont exécutés*
    check_command 								*Commande utilisée pour vérifier le statut UP/DOWN de l'hôte*
	max_check_attempts 							*Nombre de vérifications de l'état de l'hôte pour passer en état HARD*
	check_running_timeout 						*Timeout de la commande de vérification de l'hôte (en secondes)*
	warning_threshold_cpu_usage					*Nombre de secondes que peut consommer une commande avant d'apparaître en Warning dans le check 'Scheduler - Performance'*
	check_interval 								*Intervalle d’exécution de la commande de vérification de l'hôte*
	retry_interval 								*Intervalle de confirmation d'état (en minutes)* 
    active_checks_enabled 						[0/1]; Est ce que les checks actifs sont activés pour cet hôte ?
    passive_checks_enabled 						[0/1]; Est ce que les checks passifs sont activés pour cet hôte ?
    maintenance_period 							*Période de temps récurrente pendant laquelle l'hôte est en maintenance*
 
	#### Notifications ####

    notifications_enabled 						[0/1]; Est ce que les notifications sont activées pour cet hôte ?
    notification_interval 						*Intervalle d'envoi des notifications (en minutes)*
    notification_period 						*Période de temps pendant laquelle les notifications sont actives*
    notification_options						*Cette propriété permet de définir quels états de l'hôte peuvent envoyer des notifications*
	first_notification_delay					*Délai avant l'envoi de la première notification*
    escalations 								*Liste des escalades de notifications utilisées pour cet hôte*
    
	#### Expert ####
 
	poller_tag 									*Poller tag associé à cet hôte*
	reactionner_tag				    			*Poller reactionner associé à cet hôte*
	process_perf_data 							[0/1]; Prendre en compte la métrique éventuellement retournée par la check_command ?
	flap_detection_enabled 						[0/1]; Est ce que la détection du flapping est activée ?
	flap_detection_options						[o,d,u] ;Cette propriété permet de définir quel statut d'un hôte sont pris en compte pour le calcul du % de FLAPPING
    low_flap_threshold 							[0-100]; Seuil de sortie de l'état Flapping
	high_flap_threshold 						[0-100]; Seuil d'entrée dans l'état Flapping 
    event_handler_enabled 						[0/1]; Le gestionnaire d’événements est-il activé pour cet hôte ?
    event_handler 								*Commande utilisée pour le gestionnaire d’événements*
	check_freshness								[0/1]; Est ce que la vérification de fraîcheur du check est activée ?
    freshness_threshold 						*Seuil de fraîcheur du check*
	business_impact_modulations 				*Modulation d'impact métier à utiliser*
	macromodulations 							*Modulation de données à utiliser*
	resultmodulations 							*Modulation de données à utiliser*
    service_excludes 							*Liste des checks à ne pas appliquer sur l'hôte*
	service_overrides							[Check,propriété valeur]; Liste des surcharges appliquées à des checks (les surcharges peuvent être séparées par -=#=-)

	#### Modèles ####

	register									[0/1]; L'objet est-il un modèle d'hôte ou un hôte ?
	for_all_users								[0/1]; Est-ce que le modèle est visible par tout le monde (1) ou seulement par les utilisateurs administrateurs Shinken (0) ?
}


Pour créer un modèle d'hôte:

  • La clé register doit avoir la valeur 0
  • La clé host_name est remplacée par la clé name
  • La clé for_all_users est spécifique aux modèles d'hôte. Elle ne doit pas exister pour un hôte.


Info
Le nom d'hôte (host_name) ne doit pas exister en tant que nom de cluster. Si tel est le cas, un warning sera affiché à l'import indiquant que les éléments de même nom ont été ignorés.

Exemple de surcharge de check

Une surcharge de check sur un hôte peut être définie comme dans l'exemple suivant:

Code Block
define host {
	host_name						172.16.0.191
	address							172.16.0.191
	use								linux

	service_overrides				NET Stats,max_check_attempts 2-=#=-NET Stats,notifications_enabled 0
}


Dans cet exemple, on désactive les notifications sur le check "NET Stats" accroché sur l'hôte et on met la valeur 2 dans la propriété "max_check_attempts" du check "Net Stats" accroché sur l'hôte. Les 2 surcharges de check sont séparées par -=#=-.

Les Clusters

Les clusters sont en fait des hôtes particuliers.

Ils sont donc définis avec le mot clé host. La différence avec les clusters et les hôtes est qu'un cluster possède obligatoirement une règle bp_rule.

Comme pour les hôtes, il est possible de définir des modèles de cluster, via la clé register.

Code Block
define host {
    
    is_cluster									[0/1]; il maintenant possible d'utiliser cette propriété pour déterminer si l'élément est un cluster
    
    #### Définition du Cluster ####
    host_name 					[OBLIGATOIRE]	*Nom du Cluster*
	name						[OBLIGATOIRE]	*Nom de modèle de Cluster (lorsqu'il s'agit d'un modèle de Cluster)*
	check_command								bp_rule!ma-definition-bpde-rule
cluster   ( use 										*Liste des modèles de cluster à utiliser*
    realm 										*Royaume de l'hôte*DEPRECATED: correspond à l'ancienne manière de définir un cluster. Toujours opérationnelle, mais nous encourageons l'utilisation de la propriété bp_rule, ci dessous )
    businessbp_impact 							[0-5]; Impact métier du cluster
rule           notes_url 									*URL externe pouvant donner des informations supplémentaires sur l'hôte*
    notes_multi_url								*Propriété utilisée pour définir plusieurs URL *
    enabled 									[0/1]; Est ce que le cluster *ma-definition-de-cluster* ; il est activé/désactivé ?
    pack 									    *Pack auquel appartient le cluster*

	#### Supervision ####
	maintenance_period possible de définir le cluster avec cette clé (pour que cette clé soit prise en compte is_cluster 1 doit être défini pour l'élément)
    use 										*PériodeListe dedes tempsmodèles récurrente pendant laquelle le de cluster està en maintenanceutiliser*


	#### Valeurs par défaut pour les checks ####
	check_period realm 										*périodeRoyaume de supervisionl'hôte*
 pendant laquelle sont faites les vérifications de l'état du cluster par Shinken*
	check_running_timeout business_impact 							[0-5]; Impact métier du cluster
    notes_url 									*TimeoutURL deexterne lapouvant commandedonner dedes vérificationinformations dusupplémentaires cluster (en secondes)*
	warning_threshold_cpu_usagesur l'hôte*
    notes_multi_url								*NombrePropriété deutilisée secondespour quedéfinir peutplusieurs consommer une commande avant d'apparaître en Warning dans le check 'Scheduler - Performance'*


	#### Droits de l'utilisateur ####
	view_contactsURL *
    enabled 									[0/1]; Est ce que le cluster est activé/désactivé ?
    pack 									    *LesPack utilisateursauquel quiappartient voientle l'hôtecluster*

	view_contact_groups#### Supervision ####
	maintenance_period 							*Les groupes d'utilisateurs qui voient l'hôte*
	notification_contacts						*Les utilisateurs à notifier*
	notification_contact_groups					*Les groupes d'utilisateurs à notifier*
	edition_contactsPériode de temps récurrente pendant laquelle le cluster est en maintenance*


	#### Valeurs par défaut pour les checks ####
	check_period 								*Les utilisateurs peuvent modifier la configurationpériode de supervision pendant laquelle sont faites les vérifications de l'hôte.état du cluster par Shinken*
	editioncheck_contactrunning_groupstimeout 						*LesTimeout groupesde d'utilisateursla quicommande peuventde modifiervérification ladu configurationcluster de l'hôte.*
    
	contacts (en secondes)*
	warning_threshold_cpu_usage									*Liste des contacts qui pourront Voir/Editer/EtreNotifié*
    contact_groups *Nombre de secondes que peut consommer une commande avant d'apparaître en Warning dans le check 'Scheduler - Performance'*


	#### Droits de l'utilisateur ####
	view_contacts								*GroupesLes d'utilisateurs qui pourront Voir/Editer/EtreNotifiévoient l'hôte*

	#### Notifications ####
    notifications_enabled 	view_contact_groups							[0/1]; Est ce que les notifications sont activées pour ce cluster ?	
    notification_interval *Les groupes d'utilisateurs qui voient l'hôte*
	notification_contacts						*IntervalleLes d'envoiutilisateurs des notifications (en minutes)*
    notification_period 	à notifier*
	notification_contact_groups					*PériodeLes degroupes tempsd'utilisateurs pendant laquelle les notifications sont activesà notifier*
	notificationedition_optionscontacts							*EtatsLes pourutilisateurs lesquelspeuvent ilmodifier fautla envoyerconfiguration une notification*
    first_notification_delay de l'hôte.*
	edition_contact_groups						*DélaiLes avantgroupes l'envoi ded'utilisateurs qui peuvent modifier la configuration première notificationde l'hôte.*
    escalations
	contacts 									*Liste des escaladescontacts dequi notifications utilisées pour cet cluster*

	#### Expert ####
	reactionner_tagpourront Voir/Editer/EtreNotifié*
    contact_groups 					    			*PollerGroupes reactionnerd'utilisateurs associéqui à cet hôtepourront Voir/Editer/EtreNotifié*
	flap_detection_
	#### Notifications ####
    notifications_enabled 						[0/1]; Est ce que lales notifications détectionsont duactivées flappingpour estce activéecluster ?
	flap_detection_options	
    notification_interval 						[o,d,u] ;Cette propriété permet de définir quel statut d'un hôte sont pris en compte pour le calcul du % de FLAPPING*Intervalle d'envoi des notifications (en minutes)*
    notification_period 						*Période de temps pendant laquelle les notifications sont actives*
	notification_options						*Etats pour lesquels il faut envoyer une notification*
    lowfirst_flapnotification_thresholddelay 							[0-100]; Seuil de sortie de l'état Flapping
	high_flap_threshold *Délai avant l'envoi de la première notification*
    escalations 								[0-100]; Seuil d'entrée dans l'état Flapping 
    event_handler*Liste des escalades de notifications utilisées pour cet cluster*

	#### Expert ####
	reactionner_tag				    			*Poller reactionner associé à cet hôte*
	flap_detection_enabled 						[0/1]; Est Lece gestionnaireque d’événementsla est-ildétection activédu pourflapping cetest hôteactivée ?
    event_handler 	flap_detection_options								*Commande utilisée pour le gestionnaire d’événements*
	business_impact_modulations 				*Modulation d'impact métier à utiliser*
	macromodulations 							*Modulation de données à utiliser*
	resultmodulations 							*Modulation de données à utiliser*



    #### Modèles ####
	register	[o,d,u] ;Cette propriété permet de définir quel statut d'un hôte sont pris en compte pour le calcul du % de FLAPPING
    low_flap_threshold 								[0/1-100]; L'objet est-il un modèle de cluster ou un cluster ?
}
Info
Le nom du cluster (host_name) ne doit pas exister en tant que nom d'hôte. Si tel est le cas, un warning sera affiché à l'import indiquant que les éléments de même nom ont été ignorés.

Les groupes d'hôtes

Code Block
define hostgroup {
	hostgroup_name			[OBLIGATOIRE]	*Nom du groupe d'hôtes*
	members									*Liste des hôtes à ajouter dans le groupe*
	template_membersSeuil de sortie de l'état Flapping
	high_flap_threshold 						[0-100]; Seuil d'entrée dans l'état Flapping 
    event_handler_enabled 						*Les hôtes ayant les modèles listés seront ajoutés au groupe*
	enabled[0/1]; Le gestionnaire d’événements est-il activé pour cet hôte ?
    event_handler 								[0/1]; Est ce que*Commande utilisée pour le groupe d'hôtes est activé/désactivé ?
	packgestionnaire d’événements*
	business_impact_modulations 				*Modulation d'impact métier à utiliser*
	macromodulations 									*PackModulation auquelde appartientdonnées leà groupeutiliser*
}

Les checks

	resultmodulations 							*Modulation de données à utiliser*



    #### Modèles ####
	register									[0/1]; L'objet est-il un modèle de cluster ou un cluster ?
}
Info
Le nom du cluster ( host_name ) ne doit pas exister en tant que nom d'hôte. Si tel est le cas, un warning sera affiché à l'import indiquant que les éléments de même nom ont été ignorés.

Les groupes d'hôtes

Code Block
define hostgroup {
	hostgroup_name			[OBLIGATOIRE]	*Nom du groupe d'hôtes*
	members
Code Block
define service {
 
    ##### Définition du check - Général ####
	service_description				[OBLIGATOIRE]	*Nom du check*
    name							[OBLIGATOIRE]	*Nom du check (lorsqu'il s'agit d'un modèle)*
	use 											*Liste des modèles de check à utiliser*
    hostgroup_name									*Liste des groupes d'hôtes sur lesquels va s'appliquer le check*
    host_name 										*Liste des hôtes, modèle d'hôtes, clusters ou modèle de cluster sur lesquels le check va s'appliquer (cf la clé apply_on_type)*  
    notes_url à ajouter dans le groupe*
	template_members										*URLLes externehôtes pouvantayant donnerles desmodèles informationslistés supplémentairesseront surajoutés leau checkgroupe*
	enabled 										[0/1]; Est ce que le groupe d'hôtes est activé/désactivé ?
	pack 											*Pack auquel appartient le groupe*
}

Les checks

Code Block
define service   {
 
    apply_on_type##### Définition du check - Général ####
	service_description				[OBLIGATOIRE]	*Nom du  check*
    name							[OBLIGATOIRE]	*Nom du check (lorsqu'il s'agit d'un modèle)*
	use 											*Liste des modèles de check à utiliser*
    hostgroup_name									*Liste des groupes d'hôtes  [hosts/hosttpls/clusters/clustertpls]; Sur quel type d'objetsur lesquels va s'appliquer le check*
 sera appliqué ? (si non renseigné, sur un hôte)
 
	#### Données ####
	_NOMDEDONNEE host_name 										*valeurListe dedes la donnée*
 
	#### Paramètres de supervision ####
    maintenance_period 								*Période de temps récurrente pendant laquelle l'hôte est en maintenance*hôtes, modèle d'hôtes, clusters ou modèle de cluster sur lesquels le check va s'appliquer (cf la clé apply_on_type)*  
    checknotes_periodurl 										*PériodeURL externe depouvant tempsdonner pendantdes laquelleinformations lessupplémentaires checkssur sontle exécutéscheck*
    check_command 	enabled 										[OBLIGATOIRE]	*Commande utilisée pour vérifier le statut UP/DOWN du check*
    max_check_attempts 				[OBLIGATOIRE]	*Nombre de vérifications de l'état du check pour passer en état HARD*
    check_interval 					[OBLIGATOIRE]	*Intervalle d’exécution de la commande*
    retry_interval 					[OBLIGATOIRE]	*Intervalle de confirmation d'état (en minutes)*

    check_running_timeout 							*Timeout de la commande de vérification de l'hôte (en secondes)*

    active_checks_enabled 							[0/1]; Est ce que les checks actifs sont activés pour ce check ?
    passive_checks_enabled 							[0/1]; Est ce que les checks passifs sont activés pour ce check ?
	duplicate_foreach0/1]; Est ce que le groupe d'hôtes est activé/désactivé ?
	pack 											*Pack auquel appartient le groupe*
    
    apply_on_type                                   [hosts/hosttpls/clusters/clustertpls]; Sur quel type d'objet le check sera appliqué ? (si non renseigné, sur un hôte)
 
	#### Données ####
	_NOMDEDONNEE									*valeur de la donnée*
 
	#### Paramètres de supervision ####
    maintenance_period 								*DonnéePériode utiliséede pourtemps larécurrente fonctionnalitépendant Duplicatelaquelle Forl'hôte Eachest (en majusculemaintenance*
 et débutant par un _)*
	default_valuecheck_period 										*Vous pouvez fournir plusieurs arguments pour chaque valeur définie dans la donnée de l'hôte utilisé par la fonctionnalité Duplicate for Each.*
 
	#### Notifications ####
    notifications_enabled 	*Période de temps pendant laquelle les checks sont exécutés*
    check_command 						[0/1]; Est ce que les notifications sont activées pour cet hôte ?	OBLIGATOIRE]	*Commande utilisée pour vérifier le statut UP/DOWN du check*
    contactsmax_check_attempts 										*Liste des contacts auxquels envoyer les notifications[OBLIGATOIRE]	*Nombre de vérifications de l'état du check pour passer en état HARD*
    contactcheck_groupsinterval 					[OBLIGATOIRE]				*GroupesIntervalle d'utilisateursd’exécution auxquelsde seront envoyées les notifications pour cet hôtela commande*
    notificationretry_interval 					[OBLIGATOIRE]		*Intervalle de confirmation d'envoi desétat notifications (en minutes)*

    notificationcheck_running_periodtimeout 							*PériodeTimeout de la tempscommande pendantde laquellevérification lesde notifications sont actives*
	notification_optionsl'hôte (en secondes)*

    active_checks_enabled 							*Etats pour lesquels il faut envoyer une notification*[0/1]; Est ce que les checks actifs sont activés pour ce check ?
    firstpassive_notificationchecks_delayenabled 							*Délai avant l'envoi de la première notification*
    escalations 	[0/1]; Est ce que les checks passifs sont activés pour ce check ?
	duplicate_foreach 								*ListeDonnée desutilisée escaladespour dela notificationsfonctionnalité utiliséesDuplicate pourFor cet hôte*
    
	#### Expert ####
	poller_tag 										*Poller tag associé à ce check*
	reactionner_tagEach (en majuscule et débutant par un _)*
	default_value									*ReactionnerVous tagpouvez associéfournir àplusieurs cearguments check*
pour chaque valeur  business_impact 								[0-5]; Impact métier du check
	is_volatiledéfinie dans la donnée de l'hôte utilisé par la fonctionnalité Duplicate for Each.*
 
	#### Notifications ####
    notifications_enabled 										[0/1]; CetteEst propriétéce permetque deles forcernotifications Shinkensont àactivées envoyerpour unecet notificationhôte pour?	
 chaque retour en erreur d'un check.
	check_freshnesscontacts 										[0/1]; Est ce que la vérification de fraicheur du check est activée ?*Liste des contacts auxquels envoyer les notifications*
    freshnesscontact_thresholdgroups 									*Seuil de fraicheur du check*
	flap_detection_enabledGroupes d'utilisateurs auxquels seront envoyées les notifications pour cet hôte*
    notification_interval 							[0/1]; Est ce que la détection du flapping est activée ?
	flap_detection_options          				[o,d,u] ;Cette propriété permet de définir quel statut d'un hôte sont pris en compte pour le calcul du % de FLAPPING
    high_flap_threshold*Intervalle d'envoi des notifications (en minutes)*
    notification_period 							*Période de temps pendant laquelle les notifications sont actives*
	notification_options							*Etats pour lesquels il faut envoyer une notification*
    first_notification_delay 						*Délai avant l'envoi de la première notification*
    escalations 							[0-100]; Seuil d'entrée dans l'état Flapping		*Liste des escalades de notifications utilisées pour cet hôte*
    low_flap_threshold
	#### Expert ####
	poller_tag 								[0-100]; Seuil de sortie de l'état Flapping		*Poller tag associé à ce check*
	reactionner_tag									*Reactionner tag associé à ce check*
    processbusiness_perf_dataimpact 								[0-5]; Impact métier du check
	is_volatile										[0/1]; Cette Prendrepropriété permet ende compteforcer laShinken métriqueà éventuellementenvoyer retournéeune parnotification lapour check_command ?
    event_handler_enabled chaque retour en erreur d'un check.
	check_freshness									[0/1]; Le gestionnaire d’événements est-il activé pour cet hôte Est ce que la vérification de fraicheur du check est activée ?
    eventfreshness_handlerthreshold 									*CommandeSeuil utiliséede pourfraicheur le gestionnaire d'évenements*
    business_impact_modulations du check*
	flap_detection_enabled 							*Modulation d'impact métier à utiliser*
    macromodulations 								*Modulation de données à utiliser*
[0/1]; Est ce que la détection du flapping est activée ?
	flap_detection_options         resultmodulations 								*Modulation de resultats à utiliser*
	definition_order[o,d,u] ;Cette propriété permet de définir quel statut d'un hôte sont pris en compte pour le calcul du % de FLAPPING
    high_flap_threshold 								[100]
}

Détails sur les applications possibles des checks

Les clés à utiliser pour l'importation différent selon le type de check que l'on veut importer. Le tableau ci-dessous résume ces différences:

service_descriptionnameregisterapply_on_typeType de l'objetX1hostsCheck appliqué sur un hôteX1clustersCheck appliqué sur un clusterX0hosttplsCheck appliqué sur un modèle d'hôteX0clustertplsCheck appliqué sur un modèle de clusterX0Modèle de checkX1Erreur

Les contacts

Code Block
define contact {
	contact_name			[OBLIGATOIRE]	*Nom de l'utilisateur*
	name									*Nom de l'utilisateur (lorsqu'il s'agit d'un modèle d'utilisateur)*
	display_name0-100]; Seuil d'entrée dans l'état Flapping
    low_flap_threshold 								[0-100]; Seuil de sortie de l'état Flapping
    process_perf_data 								[0/1]; Prendre en compte la métrique éventuellement retournée par la check_command ?
    event_handler_enabled 							[0/1]; Le gestionnaire d’événements est-il activé pour cet hôte ?
    event_handler 									*Nom d'affichage de l'utilisateur*
	passwordCommande utilisée pour le gestionnaire d'évenements*
    business_impact_modulations 									*MotModulation ded'impact passemétier deà l'utilisateurutiliser*
	email	    macromodulations 								*Adresse email*
	pager									*Numéro de téléphone*
	use										*Liste des modèles de contact à hériter*
	contactgroupsModulation de données à utiliser*
    resultmodulations 								*ListeModulation desde groupesresultats auxquels appartient l'utilisateurà utiliser*
	expertdefinition_order									[100]
}
        

Détails sur les applications possibles des checks

Les clés à utiliser pour l'importation différent selon le type de check que l'on veut importer. Le tableau ci-dessous résume ces différences:

service_descriptionnameregisterapply_on_typeType de l'objet
X
1hostsCheck appliqué sur un hôte
X
1clustersCheck appliqué sur un cluster
X
0hosttplsCheck appliqué sur un modèle d'hôte
X
0clustertplsCheck appliqué sur un modèle de cluster

X0
Modèle de check

X1
Erreur

Les contacts

Code Block
define contact {
	contact_name			[OBLIGATOIRE]	*Nom de l'utilisateur*
	name									*Nom de l'utilisateur (lorsqu'il s'agit d'un modèle d'utilisateur)*
	display_name							*Nom d'affichage de l'utilisateur*
	password								*Mot de passe de l'utilisateur*
	email									*Adresse email*
	pager									*Numéro de téléphone*
	use										*Liste des modèles de contact à hériter*
	contactgroups							*Liste des groupes auxquels appartient l'utilisateur*
	expert									[0/1]; Est ce que l'utilisateur est un administrateur système ?
	is_admin			0/1]; Est ce que l'utilisateur est un administrateur système ?
	is_admin								[0/1]; Est ce que l'utilisateur est un administrateur Shinken ?
	notificationways						*Liste des méthodes de notifications à utiliser pour cet utilisateur*
	enabled									[0/1]; Utilisateur désactivé/activé
	can_submit_commands						[0/1]; Est ce que l'utilisateur peut soumettre des commandes ?
	acl_make_downtime						[0/1]; Cette propriété permet de donner à l'utilisateur le droit de planifier ou d'enlever des périodes de maintenance depuis l'interface de visualisation
	acl_make_acknowledge					[0/1]; Cette propriété permet de donner à l'utilisateur le droit d'effectuer ou d'enlever des prises en compte dans l'interface de visualisation
	acl_force_result_check					[0/1]; Cette propriété permet de donner à l'utilisateur le droit de forcer le résultat d'un check dans l'interface de visualisation 
	acl_force_retry_check					[0/1]; Cette propriété permet de donner à l'utilisateur le droit de demander les réexécutions de checks dans l'interface de visualisation
	acl_in_tab_history						[null,history,sla,history_sla] Cette propriété permet de choisir la vue de l'onglet Historique dans l'interface de visualisation
	acl_show_history_range					[0/1]; CetteEst propriété permet de donner à ce que l'utilisateur le droit de voir le détail des changements dans l'Historique dans l'onglet Historique de l'interface de visualisation
	acl_show_sla_range						est un administrateur Shinken ?
    default_submit_to_staging               [0/1]; Cette propriété permet de donner àsélectionner l'utilisateuronglet lede droitworkflow deà voirafficher lepar détaildéfaut, deslorsque changementsl'utilisateur danscharge lesune SLAnouvelle dans l'onglet Historique de l'interface de visualisation
	acl_share_everybodypage.  
    notificationways							[none,read,create,organize,modify,delete,all]; Vous pouvez paramétrer ici les droits d'accès à la section "Tout le monde" des favoris de l'interface de visualisation
	acl_share_group*Liste des méthodes de notifications à utiliser pour cet utilisateur*
	enabled									[none,read,create,organize,modify,delete,all0/1]; Vous pouvez paramétrer ici les droits d'accès à la section "Mes groupes" des favoris de l'interface de visualisation
	acl_share_privateUtilisateur désactivé/activé
	can_submit_commands						[0/1]; Est ce que l'utilisateur peut soumettre des commandes ?
	acl_make_downtime						[none,read,create,organize,modify,delete,all0/1]; VousCette pouvezpropriété paramétrerpermet icide lesdonner droitsà dl'accèsutilisateur àle ladroit sectionde "Privé"planifier des favorisou d'enlever des périodes de maintenance depuis l'interface de visualisation.
	acl_try_check_on_pollermake_acknowledge					[0/1]; Cette propriété permet de donner à l'utilisateur le droit d'effectuer ou d'executer les checks sur les pollers.enlever des prises en compte dans l'interface de visualisation
	acl_force_tryresult_check_on_synchronizer					[0/1]; Cette propriété permet de donner à l'utilisateur le droit de forcer le résultat d'executerun lescheck checks sur la machine de configuration. 
}

La clé contact_groups est dépréciée, utilisez plutôt contactgroups

Pour créer un modèle d'utilisateur:

  • La clé register doit avoir la valeur 0
  • La clé contact_name est remplacée par la clé name

    Les Groupes de contacts

    Code Block
    define contactgroup {
    	contactgroup_name		[OBLIGATOIRE]	*Nom du contact group*
    	members									*Membres du groupe*
    	template_members						*Les Utilisateurs avec le Modèle d'utilisateur spécifié appartiendront au groupe*
    	enableddans l'interface de visualisation 
    	acl_force_retry_check					[0/1]; Cette propriété permet de donner à l'utilisateur le droit de demander les réexécutions de checks dans l'interface de visualisation
    	acl_in_tab_history									[0/1]; Contact désactivé/activé
    	pack									*[null,history,sla,history_sla] Cette propriété permet de définirchoisir dansla quelvue packde sel'onglet trouveHistorique ledans groupe d'hôte.*
    }

    Les Méthodes de Notification

    Code Block
    define notificationway {
    	notificationway_namel'interface de visualisation
    	acl_show_history_range					[OBLIGATOIRE]	*0/1] Cette propriété permet de donner à l'utilisateur le droit de définirvoir le nom utilisé pour identifier la méthode de notification.*
    	host_notification_period détail des changements dans l'Historique dans l'onglet Historique de l'interface de visualisation
    	acl_show_sla_range						*[0/1] Cette propriété permet de définir la périodedonner à l'utilisateur le droit de tempsvoir pendantle laquelledétail lesdes notificationschangements concernantdans les hôtes seront envoyées.*
    	service_notification_period SLA dans l'onglet Historique de l'interface de visualisation
    	acl_share_everybody						*Cette propriété permet de définir la période de temps pendant laquelle les notifications concernant les checks seront envoyées.*
    	host_notifications_enabled						*Cette propriété permet de définir si Shinken va envoyer des notifications concernant les hôtes.*
    	service_notifications_enabled					*Cette propriété permet de définir si Shinken va envoyer des notifications concernant les checks.*
    	host_notification_commands						*[none,read,create,organize,modify,delete,all]; Vous pouvez paramétrer ici les droits d'accès à la section "Tout le monde" des favoris de l'interface de visualisation
    	acl_share_group							[none,read,create,organize,modify,delete,all]; Vous pouvez paramétrer ici les droits d'accès à la section "Mes groupes" des favoris de l'interface de visualisation
    	acl_share_private						[none,read,create,organize,modify,delete,all]; Vous pouvez paramétrer ici les droits d'accès à la section "Privé" des favoris de l'interface de visualisation.
    	acl_try_check_on_poller					[0/1]; Cette propriété permet de donner définirà lesl'utilisateur commandesle quidroit envoientd'executer les notificationschecks poursur unles hôtepollers.*
    	service_notification_commandsacl_try_check_on_synchronizer					*[0/1]; Cette propriété permet de définir les commandes qui envoientdonner à l'utilisateur le droit d'executer les notifications pour un check.*
    	host_notification_optionschecks sur la machine de configuration. 
    }

    La clé contact_groups est dépréciée, utilisez plutôt contactgroups

    Pour créer un modèle d'utilisateur:

    • La clé  register doit avoir la valeur 0
    • La clé contact_ name  est remplacée par la clé name

    Les Groupes de contacts

    Code Block
    define contactgroup {
    	contactgroup_name		[OBLIGATOIRE]	*Nom du contact group*
    	members									*CetteMembres propriété permet de définir quels Statuts et Contextes de l'hôte peuvent envoyer des notificationsdu groupe*
    	service_notification_optionstemplate_members						*CetteLes propriétéUtilisateurs permetavec dele définirModèle quelsd'utilisateur Statutsspécifié etappartiendront Contextes du check peuvent envoyer des notifications*
    	min_business_impactau groupe*
    	enabled									[0/1]; Contact désactivé/activé
    	pack									*Cette propriété permet de définir ledans seuilquel d'Impactpack Métierse quitrouve enverrale desgroupe d'hôte.*
    }

    Les Méthodes de Notification

    Code Block
    define notificationway {
    	notificationway_name			[OBLIGATOIRE]	notifications.*
    	enabled											[0/1]; Contact désactivé/activé
    	pack											*Cette propriété permet de définir le dansnom quelutilisé packpour seidentifier trouvela leméthode groupede d'hôtenotification.*
    }

    Les Escalades

    Code Block
    define escalation {
    	escalation_name	host_notification_period					[OBLIGATOIRE]	*Nom du contact group*
    	first_notification_time	*Cette propriété permet de définir la période de temps pendant laquelle les notifications concernant les hôtes seront envoyées.*
    	service_notification_period						*Cette propriété estpermet utiliséede pourdéfinir définirla combienpériode de temps (enpendant minutes)laquelle Shinkenles doitnotifications attendreconcernant aprèsles lachecks première notification pour démarrer l'escaladeseront envoyées.*
    	lasthost_notificationnotifications_timeenabled						*Cette propriété estpermet utiliséede pour définir combiensi deShinken tempsva (enenvoyer minutes)des Shinkennotifications doitconcernant attendre après la première notification pour arreter l'escaladeles hôtes.*
    	notificationservice_notifications_intervalenabled						*Cette propriété permet de définir les intervalles de temps entresi Shinken va envoyer des notifications concernant les notificationschecks.*
    	escalationhost_notification_periodcommands							*Cette propriété permet estde utiliséedéfinir pourles définircommandes laqui périodeenvoient pendantles laquellenotifications l'escaladepour seraun activéehôte.*
    	escalationservice_notification_optionscommands							*Cette propriété permet de définir les quelscommandes étatsqui peuventenvoient démarrerles une escalade*
    	contacts			notifications pour un check.*
    	host_notification_options						*Cette propriété estpermet utiliséede pour définir quels sont les utilisateurs à notifier.*
    	contact_groups	 Statuts et Contextes de l'hôte peuvent envoyer des notifications*
    	service_notification_options							*Cette propriété estpermet utiliséede pour définir quels sont les utilisateurs à notifier.*
    	enabled Statuts et Contextes du check peuvent envoyer des notifications*
    	min_business_impact										[0/1]; Contact désactivé/activé
    	pack*Cette propriété permet de définir le seuil d'Impact Métier qui enverra des notifications.*
    	enabled											[0/1]; Contact désactivé/activé
    	pack											*Cette propriété permet de définir dans quel pack se trouve le groupe d'hôte.*
    }
    Modulation d'impact métier

    Les Escalades

    Code Block
    define businessimpactmodulationescalation {
        business_impact_modulation_name     	escalation_name				[OBLIGATOIRE]	*Nom dedu lacontact modulationgroup*
    
        modulation_period                   	first_notification_time						*Cette propriété est utilisée pour définir combien de temps (en minutes) Shinken doit attendre après la première notification pour démarrer l'escalade.*
    	last_notification_time						*PériodeCette depropriété tempsest pendantutilisée laquellepour ladéfinir modulationcombien estde effective*
    temps (en minutes) Shinken business_impactdoit attendre après la première notification pour arreter l'escalade*
    	notification_interval						*Cette propriété permet de définir les intervalles de temps entre les  	notifications.*
    	escalation_period				[0-5]; Valeur de l'impact métier à utiliser pour la modulation
    
        pack                                				*Nom du pack dans lequel se trouve la modulation*
        enabled                             			*Cette propriété est utilisée pour définir la période pendant laquelle l'escalade sera activée.*
    	escalation_options							*Cette propriété permet de définir quels états peuvent démarrer une escalade*
    	contacts									*Cette propriété est utilisée pour définir quels sont les utilisateurs à notifier.*
    	contact_groups								*Cette propriété est utilisée pour définir quels sont les utilisateurs à notifier.*
    	enabled										[0/1]; La modulation est elle activée ?
    }Contact désactivé/activé
    	pack										*Cette propriété permet de définir dans quel pack se trouve le groupe d'hôte.*
    }

    Modulation d'impact métier

    Modulation de données

    Code Block
    define macromodulationbusinessimpactmodulation {
        macromodulationbusiness_impact_modulation_name	     [OBLIGATOIRE]	*Nom de la modulation*
    
        modulation_period                   				*Période de temps pendant laquelle la modulation est effective*
    
        packbusiness_impact                    					[0-5]; Valeur de l'impact métier à utiliser pour la modulation
    
       	*Nom du pack dans lequel se trouve la modulation*
        enabled                      				*Nom du pack dans lequel se trouve la modulation*
        enabled                             				[0/1]; La modulation est elle activée ?
    }

    Modulation de

    résultats

    données

    Code Block
    define resultmodulationmacromodulation {
        resultmodulationmacromodulation_name	[OBLIGATOIRE]	*Nom de la modulation*
    
        modulation_period                  	 	*Période de temps pendant laquelle la modulation est effective*
        output_rules                        	*Définition des règles de 	modulation*
    
        pack                                	*Nom du pack dans lequel se trouve la modulation*
        enabled                             	[0/1]; La modulation est elle activée ?
    }
    Les commandes

    Modulation de résultats

    Code Block
    define commandresultmodulation {
        commandresultmodulation_name	[OBLIGATOIRE]	*Nom de la commandemodulation*
    
        command_linemodulation_period        [OBLIGATOIRE]	*Commande à executer*
        timeout    	 	*Période de temps pendant laquelle la modulation est 			*Temps en secondes à partir duquel la commande entre en timeout*
    
    effective*
        output_rules           enabled             			[0/1]; La commande est elle activée ?
    *Définition des règles de 	modulation*
    
        pack                pack                			*Nom du pack dans lequel se trouve la commande*
    }modulation*
        enabled                             	[0/1]; La modulation est elle activée ?
    }

    Les commandes

    Les Périodes de temps

    Code Block
    define timeperiodcommand {
        timeperiodcommand_name		[OBLIGATOIRE]	*Nom de la période de tempscommande*
    
        mondaycommand_line    [OBLIGATOIRE]	*Commande          				08:00-18:00à executer*
        tuesdaytimeout             				08:00-18:00
        wednesday      *Temps en secondes à partir duquel la commande entre en timeout*
    
         				08:00-18:00
    enabled     thursday        			[0/1]; La commande  				08:00-18:00
    est elle activée ?
        pack friday               				08:00-18:00
        sunday	 *Nom du pack dans lequel se trouve la commande*
    
        poller_tag       				08:00-18:00
            saturday       *Poller tag associé à  				08:00-18:00cette commande*
        
    
    reactionner_tag    enabled	            				[0/1]; La modulation est elle activée ?
        pack *Reactionner tag associé à cette commande*
        module_type                     				*Nom du pack dans lequel se trouve la modulation*
    }
    
    

    Forcer l'utilisation d'un modèle

    Certains objets de Shinken Entreprise peuvent utiliser des modèles pour accélérer le processus de configuration. C'est le cas par exemple des hôtes, checks ou des contacts.

    Dans les fichiers d'imports, la propriété "use" permet de définir une liste de modèles à utiliser.

    Pour chaque objet de même nom qui définit la propriété "use", les modèles spécifiés seront ajoutés dans la liste des modèles à hériter pour l'objet en question.

    Prenons par exemple la configuration suivante:

    Code Block
    # Fichier 1
    define host {
    	host_name			Test host
    	address				192.168.1.XX
    	use					modele1, modele2
    }
     
    # Fichier 2
    define host {
    	host_name			Test host
    	address				192.168.1.XX
    	use					modele3
    }

    L'hôte "Test host" héritera des modèles modele1modele2 et modele3.

    Or, il se peut aussi que l'utilisateur veuille remplacer la liste des modèles utilisés au lieu d'y ajouter des éléments. Dans ce cas, il peut ajouter [FORCE] à la propriété "use", ce qui aura pour effet de remplacer completement la liste des modèles utilisés par celle fournie avec l'option [FORCE]. 

    Note : il n'y a pas d'espace entre la propriété et le [FORCE].

    La configuration se comporterait alors de la manière suivante:

    Code Block
    # Source 1
    define host {
    	host_name			Test host
    	address				192.168.1.XX
    	use					modele1, modele2
    }
    
    # Source 2
    define host {
    	host_name			Test host
    	address				192.168.1.XX
    	use[FORCE]			modele3
    }

    Dans ce dernier cas, l'hôte "Test host" utilisera seulement le modèle modele3, à cause de l'option FORCE.

    *Cette propriété est utilisée pour définir si cette commande devrait être exécutée par un module spécifique de vos pollers ou reactionners.*
        shell_execution                 [0/1]; Cette propriété est utilisée pour définir si la commande doit être exécutée dans un shell.
     }



    Les Périodes de temps

    Code Block
    define timeperiod {
        timeperiod_name		[OBLIGATOIRE]	*Nom de la période de temps*
    
        monday              				08:00-18:00
        tuesday             				08:00-18:00
        wednesday           				08:00-18:00
        thursday            				08:00-18:00
        friday              				08:00-18:00
        sunday	            				08:00-18:00
        saturday            				08:00-18:00
        
    
        enabled	            				[0/1]; La modulation est elle activée ?
        pack                				*Nom du pack dans lequel se trouve la modulation*
    }
    
    

    Forcer l'utilisation d'un modèle

    Résolution des conflits

    Dans le cas ou l'option FORCE est utilisée plusieurs fois, la dernière à être définie sera effective. Par exemple, si le même objet est défini plusieurs fois dans des sources différentes, la dernière source définissant la propriété "use" avec l'option FORCE fera foi.

    Prenons la configuration suivante:

    Code Block
    # Source 1
    define host {
    	host_name			Test host
    	address				192.168.1.XX
    	use					modele1, modele2
    }
    
    # Source 2
    define host {
    	host_name			Test host
    	address				192.168.1.XX
    	use[FORCE]			modele3
    }
    
    # Source 3
    define host {
    	host_name			Test host
    	address				192.168.1.XX
    	use[FORCE]			modele4
    }

    Dans cet exemple de configuration, l'hôte utilisera seulement le modèle "modele4".

    Forcer l'application d'autres propriétés

    De la même manière que pour forcer l'application des modèles, voici la liste des propriétés ou vous pouvez rajouter le [FORCE] suivant la propriété :
     

    Clé d'importview_contacts
    view_contact_groups
    notification_contacts
    notification_contact_groups
    edition_contacts
    edition_contact_groups
    parents
    escalations
    business_impact_modulations
    macromodulations
    resultmodulations
     

    Forcer une propriété à aucune valeur

    Dans certains cas, on veut définir spécifiquement qu'une propriété d'un objet n'a aucune valeur. Cela signifie aussi que cette propriété n'aura pas de valeur héritée d'un modèle.

    On peut obtenir ce comportement en utilisant la valeur "null" dans les fichiers de configuration:

    Code Blockdefine host { host_name mon_hote parents null }

    Note sur le champ SE_UUID

    Le champ SE_UUID qui peut être trouvé dans les fichiers de configuration est un champ interne à Shinken Entreprise.

    Il permet d'identifier les objets de manière unique. Ce champ ne doit donc pas être modifié manuellement.


    Aussi, lors de la copie d'objet dans les fichiers de configuration, il faut être vigilant quand à la présence d'un champ SE_UUID. Dans ce cas de figure, il faut supprimer le champ SE_UUID de l'objet dupliqué, sans quoi l'interface de Configuration affichera une erreur à l'import de la source.