Objet type de média

Les objets suivants sont directement liés à l'API mediatype.

Type de média

L’objet de type de média possède les propriétés suivantes.

Propriété Type Description
mediatypeid ID ID du type de média.

Comportement de la propriété :
- en lecture seule
- obligatoire pour les opérations de mise à jour
name string Nom du type de média.

Comportement de la propriété :
- obligatoire pour les opérations de création
type integer Transport utilisé par le type de média.

Valeurs possibles :
0 - E-mail ;
1 - Script ;
2 - SMS ;
4 - Webhook.

Comportement de la propriété :
- obligatoire pour les opérations de création
exec_path string Nom du fichier de script (par exemple, notification.sh) situé dans le répertoire spécifié dans le paramètre de configuration du serveur AlertScriptsPath.

Comportement de la propriété :
- obligatoire si type est défini sur « Script »
gsm_modem string Nom du périphérique série du modem GSM.

Comportement de la propriété :
- obligatoire si type est défini sur « SMS »
passwd string Mot de passe d’authentification.

Comportement de la propriété :
- pris en charge si smtp_authentication est défini sur « Mot de passe normal »
provider integer Fournisseur de messagerie électronique.

Valeurs possibles :
0 - (par défaut) SMTP générique ;
1 - Gmail ;
2 - Relais Gmail ;
3 - Office365 ;
4 - Relais Office365.
smtp_email string Adresse e-mail à partir de laquelle les notifications seront envoyées.

Comportement de la propriété :
- obligatoire si type est défini sur « E-mail »
smtp_helo string HELO SMTP.

Comportement de la propriété :
- pris en charge si type est défini sur « E-mail »
smtp_server string Serveur SMTP.

Comportement de la propriété :
- obligatoire si type est défini sur « E-mail »
smtp_port integer Port du serveur SMTP auquel se connecter.

Valeur par défaut : 25.

Comportement de la propriété :
- pris en charge si type est défini sur « E-mail »
smtp_security integer Niveau de sécurité à utiliser pour la connexion SMTP.

Valeurs possibles :
0 - (par défaut) Aucun ;
1 - STARTTLS ;
2 - SSL/TLS.

Comportement de la propriété :
- pris en charge si type est défini sur « E-mail »
smtp_verify_host integer Vérification SSL de l’hôte pour SMTP.

Valeurs possibles :
0 - (par défaut) Non ;
1 - Oui.

Comportement de la propriété :
- pris en charge si smtp_security est défini sur « STARTTLS » ou « SSL/TLS »
smtp_verify_peer integer Vérification SSL de l’homologue pour SMTP.

Valeurs possibles :
0 - (par défaut) Non ;
1 - Oui.

Comportement de la propriété :
- pris en charge si smtp_security est défini sur « STARTTLS » ou « SSL/TLS »
smtp_authentication integer Méthode d’authentification SMTP à utiliser.

Valeurs possibles :
0 - (par défaut) Aucune ;
1 - Mot de passe normal.

Comportement de la propriété :
- pris en charge si type est défini sur « E-mail »
status integer Indique si le type de média est activé.

Valeurs possibles :
0 - (par défaut) Activé ;
1 - Désactivé.
username string Nom d’utilisateur.

Comportement de la propriété :
- pris en charge si smtp_authentication est défini sur « Mot de passe normal »
maxsessions integer Nombre maximal d’alertes pouvant être traitées en parallèle.

Valeurs possibles si type est défini sur « SMS » : 1.

Valeurs possibles si type est défini sur « E-mail », « Script » ou « Webhook » : 0-100.

Valeur par défaut : 1.
maxattempts integer Nombre maximal de tentatives d’envoi d’une alerte.

Valeurs possibles : 1-100.

Valeur par défaut : 3.
attempt_interval string Intervalle entre les tentatives de nouvelle exécution.
Accepte un nombre de secondes (par exemple, 1, 60, 300) ou une valeur avec un suffixe temporel (par exemple, 30s, 1m, 1h).

Valeurs possibles : 0-1h.

Valeur par défaut : 10s.
content_type
(deprecated)		 integer Ce paramètre est obsolète ; utilisez message_format à la place.
Format du message.

Valeurs possibles :
0 - Texte brut ;
1 - (par défaut) HTML.

Comportement de la propriété :
- pris en charge si type est défini sur « E-mail »
message_format integer Format du message.

Valeurs possibles :
0 - Texte brut ;
1 - (par défaut) HTML.

Comportement de la propriété :
- pris en charge si type est défini sur « E-mail »
script text Corps du script Webhook (JavaScript).

Comportement de la propriété :
- obligatoire si type est défini sur « Webhook »
timeout string Délai d’expiration du script Webhook.
Accepte un nombre de secondes (par exemple, 1, 60) ou une valeur avec un suffixe temporel (par exemple, 30s, 1m).

Valeurs possibles : 1-60s.

Valeur par défaut : 30s.

Comportement de la propriété :
- pris en charge si type est défini sur « Webhook »
process_tags integer Traite les valeurs des propriétés JSON de la réponse du script Webhook comme des tags. Ces tags sont ajoutés aux tags de problème existants.

Valeurs possibles :
0 - (par défaut) Ignorer la réponse du script Webhook ;
1 - Traiter la réponse du script Webhook comme des tags.

Comportement de la propriété :
- pris en charge si type est défini sur « Webhook »
show_event_menu integer Inclut une entrée dans le menu des événements qui renvoie vers une URL personnalisée. Ajoute également la propriété urls à la sortie de problem.get et event.get.

Valeurs possibles :
0 - (par défaut) Ne pas inclure l’entrée du menu des événements ni la propriété urls ;
1 - Inclure l’entrée du menu des événements et la propriété urls.

Comportement de la propriété :
- pris en charge si type est défini sur « Webhook »
event_menu_url string URL utilisée dans l’entrée du menu des événements et dans la propriété urls renvoyée par problem.get et event.get.

Comportement de la propriété :
- pris en charge si show_event_menu est défini sur « Inclure l’entrée du menu des événements et la propriété urls »
event_menu_name string Nom utilisé pour l’entrée du menu des événements et dans la propriété urls renvoyée par problem.get et event.get.

Comportement de la propriété :
- pris en charge si show_event_menu est défini sur « Inclure l’entrée du menu des événements et la propriété urls »
parameters array Paramètres du Webhook ou du script.

Comportement de la propriété :
- pris en charge si type est défini sur « Webhook » ou « Script »
description text Description du type de média.

Paramètres du webhook

Les paramètres du webhook ont les propriétés suivantes.

Propriété Type Description
name string Nom du paramètre.

Comportement de la propriété :
- obligatoire
value string Valeur du paramètre, prend en charge les macros.
Les macros prises en charge sont décrites sur la page Macros prises en charge.

Paramètres du script

Les paramètres du script ont les propriétés suivantes.

Propriété Type Description
sortorder integer L'ordre dans lequel les valeurs des paramètres seront transmises au script en tant qu'arguments de ligne de commande, en commençant par 0 comme premier argument.

Comportement de la propriété :
- obligatoire
value string Valeur du paramètre, prend en charge les macros.
Les macros prises en charge sont décrites sur la page Macros prises en charge.

Modèle de message

L'objet modèle de message définit un modèle qui sera utilisé comme message par défaut pour les opérations d'action afin d'envoyer une notification. Il possède les propriétés suivantes.

Propriété Type Description
eventsource integer Source de l'événement.

Valeurs possibles :
0 - Déclencheurs ;
1 - Découverte ;
2 - Enregistrement automatique ;
3 - Interne ;
4 - Services.

Comportement de la propriété :
- obligatoire
recovery integer Mode de fonctionnement.

Valeurs possibles :
0 - Opérations ;
1 - Opérations de récupération ;
2 - Opérations de mise à jour.

Comportement de la propriété :
- obligatoire
subject string Sujet du message.
message string Texte du message.