Objet type de média

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

Type de média

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

Property Type Description
mediatypeid ID ID du type de média.

Property behavior:
- lecture seule
- requis pour les opérations de mise à jour
name string Nom du type de média.

Property behavior:
- requis pour les opérations de création
type integer Transport utilisé par le type de média.

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

Property behavior:
- requis pour les opérations de création
exec_path string Nom du fichier de script (par ex. notification.sh) situé dans le répertoire spécifié par le paramètre de configuration du serveur AlertScriptsPath.

Property behavior:
- requis si type est défini sur "Script"
gsm_modem string Nom du périphérique série du modem GSM.

Property behavior:
- requis si type est défini sur "SMS"
passwd string Mot de passe d'authentification.

Property behavior:
- pris en charge si smtp_authentication est défini sur "Normal password"
provider integer Fournisseur de messagerie.

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.

Property behavior:
- requis si type est défini sur "Email"
smtp_helo string SMTP HELO.

Property behavior:
- pris en charge si type est défini sur "Email"
smtp_server string Serveur SMTP.

Property behavior:
- requis si type est défini sur "Email"
smtp_port integer Port du serveur SMTP auquel se connecter.

Par défaut : 25.

Property behavior:
- pris en charge si type est défini sur "Email"
smtp_security integer Niveau de sécurité de la connexion SMTP à utiliser.

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

Property behavior:
- pris en charge si type est défini sur "Email"
smtp_verify_host integer Vérification SSL de l'hôte pour SMTP.

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

Property behavior:
- pris en charge si smtp_security est défini sur "STARTTLS" ou "SSL/TLS"
smtp_verify_peer integer Vérification SSL du pair pour SMTP.

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

Property behavior:
- 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;
2 - Jeton OAuth.
L'authentification OAuth n'est pas autorisée pour le fournisseur de messagerie Office365 relay.

Property behavior:
- pris en charge si type est défini sur "Email"
redirection_url string URL de l'interface Zabbix vers laquelle rediriger l'autorisation OAuth.

Par défaut :
Valeur de la propriété url des paramètres de l'API avec la partie zabbix.php?action=oauth.authorize

Property behavior:
- requis si smtp_authentication est défini sur "OAuth token"
client_id string Identifiant client enregistré sur le serveur d'autorisation OAuth.

Property behavior:
- requis si smtp_authentication est défini sur "OAuth token"
client_secret string Secret client enregistré sur le serveur d'autorisation OAuth. Accessible uniquement pour un utilisateur de type Super Admin.

Property behavior:
- requis si smtp_authentication est défini sur "OAuth token"
authorization_url string URL OAuth, avec paramètres, permettant d'obtenir les jetons d'accès et d'actualisation.

Property behavior:
- requis si smtp_authentication est défini sur "OAuth token"
token_url string URL OAuth permettant d'échanger le jeton d'autorisation contre des jetons d'accès et d'actualisation.
Cette URL est également utilisée par le serveur pour actualiser un jeton d'accès invalide.

Property behavior:
- requis si smtp_authentication est défini sur "OAuth token"
tokens_status integer Masque binaire de l'état des jetons.

Valeurs possibles :
0 - (par défaut) Les deux jetons contiennent une valeur invalide
1 - Le jeton d'accès contient une valeur valide
2 - Le jeton d'actualisation contient une valeur valide
3 - Les deux jetons contiennent une valeur valide.

Property behavior:
- pris en charge si smtp_authentication est défini sur "OAuth token"
access_token string Valeur du jeton d'accès OAuth.

Property behavior:
- requis si smtp_authentication est défini sur "OAuth token"
access_token_updated timestamp Horodatage de la dernière modification de access_token effectuée par le serveur lors de l'actualisation avec refresh_token ou par l'API lors des changements de jeton.

Property behavior:
- pris en charge si smtp_authentication est défini sur "OAuth token"
access_expires_in integer Temps, en secondes, au bout duquel access_token deviendra obsolète et nécessitera une requête vers refresh_url.
Défini par le serveur Zabbix lors de l'actualisation de access_token ou par l'API lors des changements de jeton.

L'horodatage est calculé en ajoutant la valeur de access_token_updated.

Property behavior:
- pris en charge si smtp_authentication est défini sur "OAuth token"
refresh_token string Valeur du jeton d'actualisation OAuth.

Property behavior:
- requis si smtp_authentication est défini sur "OAuth token"
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.

Property behavior:
- pris en charge si smtp_authentication est défini sur "Normal password"
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 "Email", "Script" ou "Webhook" : 0-100.

Par défaut : 1.
maxattempts integer Nombre maximal de tentatives d'envoi d'une alerte.

Valeurs possibles : 1-100.

Par défaut : 3.
attempt_interval string Intervalle entre les tentatives de nouvelle exécution.
Accepte les secondes et les unités de temps avec suffixe.

Valeurs possibles : 0-1h.

Par défaut : 10s.
message_format integer Format du message.

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

Property behavior:
- pris en charge si type est défini sur "Email"
script text Corps du script webhook (JavaScript).

Property behavior:
- requis si type est défini sur "Webhook"
timeout string Délai d'expiration du script webhook.
Accepte les secondes et les unités de temps avec suffixe.

Valeurs possibles : 1-60s.

Par défaut : 30s.

Property behavior:
- pris en charge si type est défini sur "Webhook"
process_tags integer Traiter les valeurs des propriétés JSON dans la réponse du script webhook comme des tags. Ces tags sont ajoutés à tous les 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.

Property behavior:
- pris en charge si type est défini sur "Webhook"
show_event_menu integer Inclure une entrée dans le menu d'événement 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 d'entrée dans le menu d'événement ni la propriété urls;
1 - Inclure l'entrée dans le menu d'événement et la propriété urls.

Property behavior:
- pris en charge si type est défini sur "Webhook"
event_menu_url string URL utilisée dans l'entrée du menu d'événement et dans la propriété urls renvoyée par problem.get et event.get.

Property behavior:
- pris en charge si show_event_menu est défini sur "Include event menu entry and urls property"
event_menu_name string Nom utilisé pour l'entrée du menu d'événement et dans la propriété urls renvoyée par problem.get et event.get.

Property behavior:
- pris en charge si show_event_menu est défini sur "Include event menu entry and urls property"
parameters array Paramètres Webhook ou script.

Property behavior:
- 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.