Documentation
Table of Contents
> 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 | string | (lecture seule) ID du type de média. |
| name (obligatoire) |
string | Nom du type de média. |
| type (obligatoire) |
integer | Transport utilisé par le type de média. Valeurs possibles : 0 - e-mail ; 1 - script ; 2 - SMS ; 4 - Webhook. |
| exec_path | string | Pour les types de média script, exec_path contient le nom du script exécuté.Requis pour les types de média script. |
| gsm_modem | string | Nom de périphérique série du modem GSM. Requis pour les types de média SMS. |
| passwd | string | Mot de passe d'authentification. Utilisé pour les types de média e-mail. |
| smtp_email | string | Adresse e-mail à partir de laquelle les notifications seront envoyées. Requis pour les types de média e-mail. |
| smtp_helo | string | SMTP HELO. Requis pour les types de média e-mail. |
| smtp_server | string | Serveur SMTP. Requis pour les types de média e-mail. |
| smtp_port | integer | Port du serveur SMTP auquel se connecter. |
| smtp_security | integer | Niveau de sécurité de la connexion SMTP à utiliser. Valeurs possibles : 0 - Aucun ; 1 - STARTTLS ; 2 - SSL/TLS. |
| smtp_verify_host | integer | SSL vérifie l'hôte pour SMTP. Valeurs possibles : 0 - Non ; 1 - Oui. |
| smtp_verify_peer | integer | SSL vérifie le pair pour SMTP. Valeurs possibles : 0 - Non ; 1 - Oui. |
| smtp_authentication | integer | Méthode d'authentification SMTP à utiliser. Valeurs possibles : 0 - Aucune ; 1 - Mot de passe normal. |
| status | integer | Si le type de média est activé. Valeurs possibles : 0 - (par défaut) activé ; 1 - désactivé. |
| username | integer | Nom d'utilisateur. Utilisé pour les types de média e-mail. |
| exec_params | string | Paramètres de script. Chaque paramètre se termine par un nouveau saut de ligne. |
| maxsessions | integer | Le nombre maximal d'alertes pouvant être traitées en parallèle. Valeurs possibles pour les SMS : 1 - (par défaut) Valeurs possibles pour les autres types de médias : 0-100 |
| maxattempts | integer | Le nombre maximal de tentatives d'envoi d'une alerte. Valeurs possibles : 1-100 Valeur par défaut : 3 |
| attempt_interval | string | L'intervalle entre les tentatives de relance. Accepte les secondes et l'unité de temps avec suffixe. Valeurs possibles : 0-1h Valeur par défaut : 10s |
| content_type | integer | Format du message. Valeurs possibles : 0 - texte brut ; 1 - (par défaut) html. |
| script | string | Corps javascript du script du type de média webhook. |
| timeout | string | Délai d'expiration du script du type de média webhook. Accepte les secondes et l'unité de temps avec suffixe. Valeurs possibles : 1-60s Valeur par défaut : 30s |
| process_tags | integer | Définit si la réponse du script du webhook doit être interprétée comme des tags et ces tags doivent être ajoutés à l'événement associé. Valeurs possibles : 0 - (par défaut) Ignorer la réponse du script du webhook. 1 - Traiter la réponse du script du webhook en tant que tags. |
| show_event_menu | integer | Afficher l'entrée du type de média dans problem.get et event.get dans la propriété urls.Valeurs possibles : 0 - (par défaut) Ne pas ajouter l'entrée urls.1 - Ajouter le type de média à la propriété urls. |
| event_menu_url | string | Définir la propriété url de l'entrée de type de média dans la propriété urls de problem.get et event.get. |
| event_menu_name | string | Définir la propriété name de l'entrée de type de média dans la propriété urls de problem.get et event.get. |
| parameters | tableau | Tableau de paramètres d'entrée du webhook. |
| description | string | Description du type de média. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Paramètres Webhook
Les paramètres transmis au script webhook lorsqu'il est appelé ont les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| name (obligatoire) |
string | Nom du paramètre. |
| value | string | Valeur du paramètre. Supporte les macros décrites sur la page des Macros supportées. |
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 a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| eventsource (obligatoire) |
integer | Source de l'évènement. Valeurs possibles : 0 - déclencheurs ; 1 - découverte ; 2 - enregistrement automatique ; 3 - interne ; 4 - services. |
| recovery (obligatoire) |
integer | Mode d'opération. Valeurs possibles : 0 - opérations; 1 - opérations de récupération ; 2 - opérations de mise à jour. |
| subject | string | Sujet du message. |
| message | string | Texte du message. |