This is a translation of the original English documentation page. Help us make it better.

Sidebar

Zabbix Summit 2022
View presentations

> Action object

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

Action

L'objet action a les propriétés suivantes.

Propriété Type Description
actionid string (lecture seule) ID de l'action.
esc_period
(obligatoire)
string Durée de l'étape d'opération par défaut. Doit être supérieur à 60 secondes. Accepte les secondes, les unités de temps avec suffixe et les macros utilisateur.
eventsource
(obligatoire)
integer (constant) Type d'événements que l'action va gérer.

Se référer à la propriété "source" de l'objet Événement pour une liste des types d'événements supportés.
name
(obligatoire)
string Nom de l'action.
def_longdata string Texte du message du problème.
def_shortdata string Sujet du message du problème.
r_longdata string Texte du message de récupération.
r_shortdata string Sujet du message de récupération.
ack_longdata string Texte du message de l'opération d'acquittement.
ack_shortdata string Sujet du message de l'opération d'acquittement.
status integer Indique si l'action est activée ou désactivée.

Valeurs possibles :
0 - (par défaut) activée ;
1 - désactivée.
maintenance_mode integer Indique si l'escalade est en pause ou non durant une période de maintenance.

Valeurs possibles :
0 - Ne pas mettre en pause l'escalade ;
1 - (par défaut) Mettre en pause l'escalade.

Opération d'action

L'objet d'opération d'action définit une opération qui sera effectuée lorsqu'une action est exécutée. Il a les propriétés suivantes.

Propriété Type Description
operationid string (lecture seule) ID de l'opération d'action.
operationtype
(obligatoire)
integer Type de l'opération d'action.

Valeurs possibles :
0 - envoi de message ;
1 - commande à distance ;
2 - ajouter un hôte ;
3 - supprimer un hôte ;
4 - ajouter à un groupe d'hôtes ;
5 - supprimer d'un groupe d'hôtes ;
6 - lier à un modèle ;
7 - délier du modèle ;
8 - activer l'hôte ;
9 - désactiver l'hôte ;
10 - définir le mode d'inventaire de l'hôte.
esc_period string Durée d'une étape d'escalade en secondes. Doit être supérieur à 60 secondes. Accepte les secondes, les unités de temps avec suffixe et les macros utilisateur. Si la valeur est définie sur 0 ou sur 0s, la période d'escalade de l'action par défaut sera utilisée.

Par défaut : 0s.
esc_step_from integer Étape à partir de laquelle commencer l'escalade.

Par défaut : 1.
esc_step_to integer Étape à laquelle terminer l'escalade.

Par défaut : 1.
evaltype integer Méthode d'évaluation des conditions de l'opération.

Valeurs possibles :
0 - (par défaut) ET / OU;
1 - ET;
2 - OU.
opcommand object Objet contenant les données sur la commande exécutée par l'opération.

L'objet commande d'opération est décrit en détail plus bas.

Obligatoire pour les opérations de commande à distance.
opcommand_grp array Groupes d'hôtes sur lesquels exécuter des commandes à distance.

Chaque objet a les propriétés suivantes :
opcommand_grpid - (string, lecture seule) ID de l'objet ;
operationid - (string) ID de l'opération ;
groupid - (string) ID du groupe d'hôtes.

Obligatoire pour les opérations de commande à distance si opcommand_hst est défini.
opcommand_hst array Hôte pour exécuter les commandes à distance.

Chaque objet a les propriétés suivantes :
opcommand_hstid - (string, lecture seule) ID de l'objet ;
operationid - (string) ID de l'opération ;
hostid - (string) ID de l'hôte ; Si la valeur est 0, la commande sera exécutée sur l'hôte actuel.

Obligatoire pour les opérations de commande à distance si opcommand_grp n'est pas défini.
opconditions array Conditions d'opération utilisées pour les actions de déclencheur.

L'objet commande d'opération est décrit en détail plus bas.
opgroup array Groupes d'hôtes auxquels ajouter des hôtes.

Chaque objet a les propriétés suivantes :
operationid - (string) ID de l'opération ;
groupid - (string) ID du groupe d'hôtes.

Obligatoire pour les opérations "ajouter à un groupe d'hôtes" et "supprimer d'un groupe d'hôtes".
opmessage object Objet contenant les données sur le message envoyé par l'opération.

L'objet message d'opération est décrit en détail plus bas.

Obligatoire pour les messages d'opérations.
opmessage_grp array Groupes d'utilisateurs auxquels envoyer des messages.

Chaque objet a les propriétés suivantes :
operationid - (string) ID de l'opération ;
usrgrpid - (string) ID du groupe d'utilisateurs.

Obligatoire pour les messages d'opérations si opmessage_usr n'est pas défini.
opmessage_usr array Utilisateurs auxquels envoyer des messages.

Chaque objet a les propriétés suivantes :
operationid - (string) ID de l'opération ;
userid - (string) ID de l'utilisateur.

Obligatoire pour les messages d'opérations si opmessage_grp n'est pas défini.
optemplate array Modèles auxquels liés les hôtes.

Chaque objet a les propriétés suivantes :
operationid - (string) ID de l'opération ;
templateid - (string) ID du modèle.

Obligatoire pour les opérations "lier à un modèle" et "délier du modèle".
opinventory object Mode d'inventaire à définir sur l'hôte.

Chaque objet a les propriétés suivantes :
operationid - (string) ID de l'opération ;
inventory_mode - (string) Mode d'inventaire.

Obligatoire pour les opérations "définir le mode d'inventaire de l'hôte".

Commande d'opération d'action

L'objet de commande d'opération contient des données sur la commande qui sera exécutée par l'opération.

Propriété Type Description
operationid string (lecture seule) ID de l'opération.
command string Commande à exécuter. Requis lorsque le type est 0, 1, 2 ou 3).
type
(obligatoire)
integer Type de la commande d'opération.

Valeurs possibles :
0 - script personnalisé ;
1 - IPMI ;
2 - SSH ;
3 - Telnet ;
4 - script global.
authtype integer Méthode d'authentification utilisée pour les commandes SSH.

Valeurs possibles :
0 - mot de passe ;
1 - clé publique.

Requis pour les commandes SSH.
execute_on integer Cible sur laquelle la commande d'opération de script personnalisée sera exécutée.

Valeurs possibles :
0 - agent Zabbix ;
1 - serveur Zabbix ;
2 - serveur Zabbix (proxy).

Requis pour les commandes de script personnalisé.
password string Mot de passe utilisé pour les commandes SSH et Telnet avec authentification par mot de passe.
port string Numéro de port utilisé pour les commandes SSH et Telnet.
privatekey string Nom du fichier de clé privée utilisé pour les commandes SSH avec authentification par clé publique.

Requis pour les commandes SSH avec authentification par clé publique.
publickey string Nom du fichier de clé publique utilisé pour les commandes SSH avec authentification par clé publique.

Requis pour les commandes SSH avec authentification par clé publique.
scriptid string ID du script utilisé pour les commandes de script global.

Requis pour les commandes de script global.
username string Nom d'utilisateur utilisé pour l'authentification.

Requis pour les commandes SSH et Telnet.

Message d'opération d'action

L'objet de message d'opération contient des données sur le message qui sera envoyé par l'opération.

Propriété Type Description
operationid string (lecture seule) ID de l'opération d'action.
default_msg integer Indique s'il faut utiliser le texte et l'objet du message d'action par défaut.

Valeurs possibles :
0 - (par défaut) utiliser les données de l'opération ;
1 - utiliser les données de l'action.
mediatypeid string Identifiant du type de média qui sera utilisé pour envoyer le message.
message string Texte du message de l'opération.
subject string Sujet du message de l'opération.

Condition d'opération d'action

L'objet condition d'opération d'action définit une condition qui doit être remplie pour effectuer l'opération en cours. Il a les propriétés suivantes.

Propriété Type Description
opconditionid string (lecture seule) ID de la condition d'opération d'action.
conditiontype
(obligatoire)
integer Type de condition.

Valeurs possibles :
14 - événement acquitté.
value
(obligatoire)
string Valeur à comparer.
operationid string (lecture seule) ID de l'opération.
operator integer Opérateur de condition.

Valeurs possibles :
0 - (par défaut) =.

Les opérateurs et valeurs suivants sont pris en charge pour chaque type de condition d'opération.

Condition Nom de la condition Opérateurs pris en charge Valeur attendue
14 Événement acquitté = Si l'événement est acquitté.

Valeurs possibles :
0 - non acquitté ;
1 - acquitté.

Opération de récupération d'action

L'objet d'opération de récupération d'action définit une opération qui sera effectuée lorsqu'un problème est résolu. Les opérations de récupération sont possibles pour les actions de déclencheur et les actions internes. Il a les propriétés suivantes.

Propriété Type Description
operationid string (lecture seule) ID de l'opération d'action.
operationtype
(obligatoire)
integer Type d'opération.

Valeurs possibles pour les actions de déclencheur :
0 - envoi de message ;
1 - commande à distance ;
11 - informer toutes les personnes impliquées.

Valeurs possibles pour les actions internes :
0 - envoi de message ;
11 - informer toutes les personnes impliquées.
actionid string ID de l'action à laquelle l'opération de récupération appartient.
opcommand object Objet contenant les données sur la commande exécutée par l'opération de récupération.

L'objet Commande d'opération est décrit en détail plus haut.

Requis pour les opérations de commande à distance.
opcommand_grp array Groupes d'hôtes sur lesquels exécuter des commandes à distance.

Chaque objet a les propriétés suivantes :
opcommand_grpid - (string, lecture seule) ID de l'objet ;
operationid - (string) ID de l'opération ;
groupid - (string) ID du groupe d'hôtes.

Requis pour les opérations de commande à distance si opcommand_hst n'est pas défini.
opcommand_hst array Hôte pour exécuter les commandes à distance.

Chaque objet a les propriétés suivantes :
opcommand_hstid - (string, lecture seule) ID de l'objet ;
operationid - (string) ID de l'opération ;
hostid - (string) ID de l'hôte ; Si la valeur est 0, la commande sera exécutée sur l'hôte actuel.

Requis pour les opérations de commande à distance si opcommand_grp n'est pas défini.
opmessage object Objet contenant les données sur le message envoyé par l'opération de récupération.

L'objet Message d'opération d'action est décrit en détail plus haut.

Requis pour les opérations de message.
opmessage_grp array Groupes d'utilisateurs auxquels envoyer des messages.

Chaque objet a les propriétés suivantes :
operationid - (string) ID de l'opération ;
usrgrpid - (string) ID du groupe d'utilisateurs.

Obligatoire pour les opérations de message si opmessage_usr n'est pas défini.
opmessage_usr array Utilisateurs auxquels envoyer des messages.

Chaque objet a les propriétés suivantes :
operationid - (string) ID de l'opération ;
userid - (string) ID de l'utilisateur.

Requis pour les opérations de message si opmessage_grp n'est pas défini.

Opération d'acquittement d'action

L'objet d'opération d'acquittement d'action définit une opération qui sera effectuée lors de l'acquittement d'un problème. Les opérations d'acquittement sont possibles pour les actions de déclencheur. Il a les propriétés suivantes.

Propriété Type Description
operationid string (lecture seule) ID de l'opération d'action.
operationtype
(obligatoire)
integer Type de l'opération.

Valeurs possibles pour les actions de déclencheur :
0 - envoi de message ;
1 - commande à distance ;
12 - informer toutes les personnes impliquées.
opcommand object Objet contenant les données sur la commande exécutée par l'opération d'acquittement.

L'objet Commande d'opération est décrit en détail plus haut.

Requis pour les opérations de commande à distance.
opcommand_grp array Groupes d'hôtes sur lesquels exécuter des commandes à distance.

Chaque objet a les propriétés suivantes :
groupid - (string) ID du groupe d'hôtes.

Requis pour les opérations de commande à distance si opcommand_hst n'est pas défini.
opcommand_hst array Hôte pour exécuter les commandes à distance.

Chaque objet a les propriétés suivantes :
hostid - (string) ID de l'hôte ; Si la valeur est 0, la commande sera exécutée sur l'hôte actuel.

Requis pour les opérations de commande à distance si opcommand_grp n'est pas défini.
opmessage object Objet contenant les données sur le message envoyé par l'opération de récupération.

L'objet Message d'opération d'action est décrit en détail plus haut.

Requis pour les opérations envoi de message si opmessage_usr n'est pas défini.
Est ignoré pour les opérations envoi message d'acquittement.
opmessage_usr array Utilisateurs auxquels envoyer des messages.

Chaque objet a les propriétés suivantes :
userid - (string) ID de l'utilisateur.

Requis seulement pour les opérations envoi de message si opmessage_grp n'est pas défini.
Est ignoré pour les opérations envoi message d'acquittement.

Filtre d'action

L'objet filtre d'action définit un ensemble de conditions qui doivent être remplies pour effectuer les opérations d'action configurées. Il a les propriétés suivantes.

Propriété Type Description
conditions
(obligatoire)
array Ensemble de conditions de filtrage à utiliser pour filtrer les résultats.
evaltype
(obligatoire)
integer Méthode d'évaluation des conditions de filtrage.

Valeurs possibles :
0 - et/ou ;
1 - et ;
2 - ou ;
3 - expression personnalisée.
eval_formula string (lecture seule) Expression générée qui sera utilisée pour évaluer les conditions de filtre. L'expression contient des ID qui font référence à des conditions de filtre spécifiques par leur formulaid. La valeur de eval_formula est égale à celle de formula pour les filtres avec une expression personnalisée.
formula string Expression définie par l'utilisateur à utiliser pour évaluer les conditions de filtres avec une expression personnalisée. L'expression doit contenir des identifiants faisant référence à des conditions de filtre spécifiques par leur formulaid. Les identifiants utilisés dans l'expression doivent correspondre exactement à ceux définis dans les conditions de filtre : aucune condition ne peut rester non utilisée ou omise.

Obligatoire pour les filtres d'expression personnalisée.

Condition de Filtre d'action

L'objet condition de filtre d'action définit une condition spécifique qui doit être vérifiée avant l'exécution des opérations d'action.

Propriété Type Description
conditionid string (lecture seule) ID de la condition d'action.
conditiontype
(obligatoire)
integer Type de la condition.

Valeurs possibles pour les actions de déclencheur :
0 - groupe d'hôtes ;
1 - hôte ;
2 - déclencheur ;
3 - nom de déclencheur ;
4 - sévérité de déclencheur ;
6 - période de temps ;
13 - modèle d'hôte ;
15 - application ;
16 - problème supprimé ;
25 - tag d'événement ;
26 - valeur de tag d'événement.

Valeurs possibles pour les actions de découverte :
7 - IP de l'hôte ;
8 - type de service découvert ;
9 - port de service découvert ;
10 - statut de la découverte ;
11 - durée de disponibilité ou d'indisponibilité ;
12 - valeur reçue ;
18 - règle de découverte ;
19 - test de découverte ;
20 - proxy ;
21 - objet découvert.

Valeurs possibles pour les actions d’auto-enregistrement :
20 - proxy ;
22 - nom d'hôte ;
24 - métadonnées de l'hôte.

Valeurs possibles pour les actions internes :
0 - groupe d'hôtes ;
1 - hôte ;
13 - modèle d'hôte ;
15 - application ;
23 - type d'événement.
value
(obligatoire)
string Valeur à comparer.
value2
string Valeur secondaire à comparer. Obligatoire pour les actions de déclenchement lorsque le type de condition est 26.
actionid string (lecture seule) ID de l'action à laquelle la condition appartient.
formulaid string ID unique arbitraire utilisé pour référencer la condition à partir d'une expression personnalisée. Ne peut contenir que des majuscules. L'ID doit être défini par l'utilisateur lors de la modification des conditions de filtre, mais sera généré à nouveau lors de la demande ultérieure.
operator integer Opérateur de condition.

Valeurs possibles :
0 - (par défaut) est égal ;
1 - n'est pas égal ;
2 - contient ;
3 - ne contient pas ;
4 - est dans ;
5 - est plus grand ou égal ;
6 - est plus petit ou égal ;
7 - n'est pas dans ;
10 - Oui ;
11 - Non.

Pour mieux comprendre comment utiliser les filtres avec différents types d’expressions, voir les exemples sur les pages action.get et action.create.

Les opérateurs et valeurs suivants sont pris en charge pour chaque type de condition.

Condition Nom de la condition Opérateurs pris en charge Valeur attendue
0 Groupe d'hôtes est égal,
n'est pas égal
ID du groupe d'hôtes.
1 Hôte est égal,
n'est pas égal
ID de l'hôte.
2 Déclencheur est égal,
n'est pas égal
ID du déclencheur.
3 Nom du déclencheur contient,
ne contient pas
Nom du déclencheur.
4 Sévérité du déclencheur est égal,
n'est pas égal,
est plus grand ou égal,
est plus petit ou égal
Sévérité du déclencheur. Se référer à la propriété "severity" de l'objet déclencheur pour une liste des sévérités supportées.
5 Valeur du déclencheur est égal Valeur du déclencheur. Se référer à la propriété "value" de l'objet déclencheur pour une liste des valeurs supportées.
6 Période de temps est dans,
n'est pas dans
Heure à laquelle l'événement a été déclenché en tant que période de temps.
7 IP de l'hôte est égal,
n'est pas égal
Une ou plusieurs plages IP à vérifier, séparées par des virgules.
8 Type de service découvert est égal,
n'est pas égal
Type de service découvert. Le type de service correspond au type de test de découverte utilisé pour détecter le service. Se référer à la propriété "type" de l'objet test de découverte pour une liste de types supportés.
9 Port de service découvert est égal,
n'est pas égal
Une ou plusieurs plages de ports séparées par des virgules.
10 Statut de la découverte est égal Statut d'un objet découvert.

Valeurs possibles :
0 - hôte ou service actif ;
1 - hôte ou service inactif ;
2 - hôte ou service découvert ;
3 - hôte ou service perdu .
11 Durée de disponibilité ou d'indisponibilité est plus grand ou égal,
est plus petit ou égal
Heure indiquant depuis combien de temps l'objet découvert est dans l'état actuel, en secondes.
12 Valeur reçue est égal,
n'est pas égal,
est plus grand ou égal,
est plus petit ou égal,
contient,
ne contient pas
Valeur renvoyée lors d'un test de découverte d'agent Zabbix, SNMPv1, SNMPv2 ou SNMPv3.
13 Modèle d'hôte est égal,
n'est pas égal
ID du modèle lié.
15 Application est égal,
contient,
ne contient pas
Nom de l'application.
16 Problème supprimé Oui, Non Aucune valeur requise: utiliser l'opérateur "Oui" signifie que le problème doit être supprimé, "Non" - non supprimé.
18 Règle de découverte est égal,
n'est pas égal
ID de la règle de découverte.
19 Test de découverte est égal,
n'est pas égal
ID du test de décuverte.
20 Proxy est égal,
n'est pas égal
ID du proxy.
21 Objet découvert est égal Type d'objet ayant déclenché l'événement de découverte.

Valeurs possibles :
1 - hôte découvert ;
2 - service découvert.
22 Nom d'hôte contient,
ne contient pas
Nom de l'hôte.
23 Type d'événement est égal Événement interne spécifique.

Valeurs possibles :
0 - élément dans l'état "non supporté" ;
1 - élément dans l'état "normal" ;
2 - règle de découverte bas niveau dans l'état "non supporté" ;
3 - règle de découverte bas niveau dans l'état "normal" ;
4 - déclencheur dans l'état "inconnu" ;
5 - déclencheur dans l'état "normal".
24 Métadonnées de l'hôte contient,
ne contient pas
Métadonnées de l'hôte auto-enregistré.
25 Tag est égal,
n'est pas égal,
contient,
ne contient pas
Tag de l'événement.
26 Valeur de tag est égal,
n'est pas égal,
contient,
ne contient pas
Valeur du tag de l'événement.