Objet Action

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

Action

L'objet action possède les propriétés suivantes.

Propriété Type Description
actionid ID ID de l'action.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
esc_period string Durée par défaut de l'étape d'opération. Doit être d'au moins 60 secondes. Accepte des secondes, une unité de temps avec suffixe ou une macro utilisateur.

Comportement de la propriété :
- pris en charge si eventsource est défini sur « événement créé par un déclencheur », « événement interne » ou « événement créé lors de la mise à jour de l'état du service »
eventsource integer Type d'événements que l'action traitera.

Consultez la propriété source de l'événement pour obtenir la liste des types d'événements pris en charge.

Comportement de la propriété :
- constant
- obligatoire pour les opérations de création
name string Nom de l'action.

Comportement de la propriété :
- obligatoire pour les opérations de création
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.
pause_symptoms integer Indique s'il faut mettre en pause l'escalade si l'événement est un événement symptôme.

Valeurs possibles :
0 - Ne pas mettre en pause l'escalade pour les problèmes symptôme ;
1 - (par défaut) Mettre en pause l'escalade pour les problèmes symptôme.

Comportement de la propriété :
- pris en charge si eventsource est défini sur « événement créé par un déclencheur »
pause_suppressed integer Indique s'il faut mettre en pause l'escalade pendant les périodes de maintenance ou non.

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

Comportement de la propriété :
- pris en charge si eventsource est défini sur « événement créé par un déclencheur »
notify_if_canceled integer Indique s'il faut envoyer une notification lorsque l'escalade est annulée.

Valeurs possibles :
0 - Ne pas notifier lorsque l'escalade est annulée ;
1 - (par défaut) Notifier lorsque l'escalade est annulée.

Comportement de la propriété :
- pris en charge si eventsource est défini sur « événement créé par un déclencheur »

Opération d'action

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

Propriété Type Description
operationtype integer Type d'opération.

Valeurs possibles :
0 - envoyer un message ;
1 - script global ;
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 un modèle ;
8 - activer un hôte ;
9 - désactiver un hôte ;
10 - définir le mode d'inventaire de l'hôte ;
13 - ajouter des tags d'hôte ;
14 - supprimer des tags d'hôte.

Valeurs possibles si eventsource de l'objet Action est défini sur « événement créé par un déclencheur » ou « événement créé lors d'une mise à jour de l'état du service » :
0 - « envoyer un message » ;
1 - « script global ».

Valeurs possibles si eventsource de l'objet Action est défini sur « événement interne » :
0 - « envoyer un message ».

Comportement de la propriété :
- obligatoire
esc_period string Durée d'une étape d'escalade en secondes. Doit être supérieure à 60 secondes. Accepte des secondes, une unité de temps avec suffixe ou une macro utilisateur. Si la valeur est définie sur 0 ou 0s, la période d'escalade d'action par défaut sera utilisée.

Par défaut : 0s.

Comportement de la propriété :
- pris en charge si eventsource de l'objet Action est défini sur « événement créé par un déclencheur », « événement interne » ou « événement créé lors d'une mise à jour de l'état du service »
esc_step_from integer Étape à partir de laquelle démarrer l'escalade.

Par défaut : 1.

Comportement de la propriété :
- pris en charge si eventsource de l'objet Action est défini sur « événement créé par un déclencheur », « événement interne » ou « événement créé lors d'une mise à jour de l'état du service »
esc_step_to integer Étape à laquelle terminer l'escalade.

Par défaut : 1.

Comportement de la propriété :
- pris en charge si eventsource de l'objet Action est défini sur « événement créé par un déclencheur », « événement interne » ou « événement créé lors d'une mise à jour de l'état du service »
evaltype integer Méthode d'évaluation des conditions d'opération.

Valeurs possibles :
0 - (par défaut) Et/Ou ;
1 - Et ;
2 - Ou.
opcommand object Script global à exécuter.

Le script global doit avoir la propriété scriptid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « script global »
opcommand_grp array Groupes d'hôtes sur lesquels exécuter les scripts globaux.

Les groupes d'hôtes doivent avoir la propriété groupid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « script global » et que opcommand_hst n'est pas défini
opcommand_hst array Hôte sur lequel exécuter les scripts globaux.

Les hôtes doivent avoir la propriété hostid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « script global » et que opcommand_grp n'est pas défini
opconditions array Conditions d'opération utilisées pour les actions de déclencheur.

L'objet de condition d'opération est décrit en détail ci-dessous.
opgroup array Groupes d'hôtes auxquels ajouter des hôtes.

Les groupes d'hôtes doivent avoir la propriété groupid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « ajouter à un groupe d'hôtes » ou « supprimer d'un groupe d'hôtes »
opmessage object Objet contenant les données relatives au message envoyé par l'opération.

L'objet de message d'opération est décrit en détail ci-dessous.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « envoyer un message »
opmessage_grp array Groupes d'utilisateurs auxquels envoyer des messages.

Les groupes d'utilisateurs doivent avoir la propriété usrgrpid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « envoyer un message » et que opmessage_usr n'est pas défini
opmessage_usr array Utilisateurs auxquels envoyer des messages.

Les utilisateurs doivent avoir la propriété userid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « envoyer un message » et que opmessage_grp n'est pas défini
optemplate array Modèles à lier aux hôtes.

Les modèles doivent avoir la propriété templateid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « lier un modèle » ou « délier un modèle »
opinventory object Mode d'inventaire à définir pour l'hôte.

L'inventaire doit avoir la propriété inventory_mode définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « définir le mode d'inventaire de l'hôte »
optag array Tags d'hôte à ajouter ou à supprimer.

Les tags doivent avoir la propriété tag définie.
La propriété value est facultative.

Comportement de la propriété :
- pris en charge si operationtype est défini sur « ajouter des tags d'hôte » ou « supprimer des tags d'hôte ».

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. Il possède les propriétés suivantes.

Propriété Type Description
default_msg integer Indique s'il faut utiliser le texte et l'objet par défaut du message d'action.

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

Comportement de la propriété :
- pris en charge si operationtype de l'objet d'opération d'action, de l'objet d'opération de récupération d'action ou de l'objet d'opération de mise à jour d'action est défini sur « envoyer un message », ou si operationtype de l'objet d'opération de mise à jour d'action est défini sur « notifier toutes les parties impliquées »
message string Texte du message d'opération.

Comportement de la propriété :
- pris en charge si default_msg est défini sur « utiliser les données de l'opération »
subject string Objet du message d'opération.

Comportement de la propriété :
- pris en charge si default_msg est défini sur « utiliser les données de l'opération »

Condition d’opération d’action

L’objet de condition d’opération d’action définit une condition qui doit être remplie pour exécuter l’opération actuelle. Il possède les propriétés suivantes.

Propriété Type Description
conditiontype integer Type de condition.

Valeurs possibles :
14 - événement acquitté.

Comportement de la propriété :
- obligatoire
value string Valeur à comparer.

Comportement de la propriété :
- obligatoire
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é = Indique 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 exécutée lorsqu’un problème est résolu. Les opérations de récupération sont possibles uniquement pour les actions de déclencheur, internes et de service. Il possède les propriétés suivantes.

Propriété Type Description
operationtype integer Type d’opération.

Valeurs possibles si eventsource de l’objet Action est défini sur « événement créé par un déclencheur » ou « événement créé lors de la mise à jour de l’état du service » :
0 - envoyer un message ;
1 - script global ;
11 - notifier toutes les parties impliquées.

Valeurs possibles si eventsource de l’objet Action est défini sur « événement interne » :
0 - envoyer un message ;
11 - notifier toutes les parties impliquées.

Comportement de la propriété :
- obligatoire
opcommand object Script global à exécuter.

Le script global doit avoir la propriété scriptid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « script global »
opcommand_grp array Groupes d’hôtes sur lesquels exécuter les scripts globaux.

Les groupes d’hôtes doivent avoir la propriété groupid définie.

Comportement de la propriété :
- obligatoire si eventsource de l’objet Action est défini sur « événement créé par un déclencheur », et operationtype est défini sur « script global », et opcommand_hst n’est pas défini
opcommand_hst array Hôtes sur lesquels exécuter les scripts globaux.

Les hôtes doivent avoir la propriété hostid définie.

Comportement de la propriété :
- obligatoire si eventsource de l’objet Action est défini sur « événement créé par un déclencheur », et operationtype est défini sur « script global », et opcommand_grp n’est pas défini
opmessage object Objet contenant les données du message envoyé par l’opération de récupération.

L’objet de message d’opération est décrit en détail ci-dessus.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « envoyer un message »
opmessage_grp array Groupes d’utilisateurs auxquels envoyer des messages.

Les groupes d’utilisateurs doivent avoir la propriété usrgrpid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « envoyer un message » et opmessage_usr n’est pas défini
opmessage_usr array Utilisateurs auxquels envoyer des messages.

Les utilisateurs doivent avoir la propriété userid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur « envoyer un message » et opmessage_grp n’est pas défini

Opération de mise à jour d'action

L'objet d'opération de mise à jour d'action définit une opération qui sera exécutée lorsqu'un problème est mis à jour (commenté, acquitté, avec changement de gravité ou fermeture manuelle). Les opérations de mise à jour sont possibles uniquement pour les actions de déclencheur et de service. Il possède les propriétés suivantes.

Propriété Type Description
operationtype integer Type d'opération.

Valeurs possibles :
0 - envoyer un message ;
1 - script global ;
12 - notifier toutes les parties impliquées.

Comportement de la propriété :
- obligatoire
opcommand object Script global à exécuter.

Le script global doit avoir la propriété scriptid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur "script global"
opcommand_grp array Groupes d'hôtes sur lesquels exécuter des scripts globaux.

Les groupes d'hôtes doivent avoir la propriété groupid définie.

Comportement de la propriété :
- obligatoire si eventsource de l'objet Action est défini sur "événement créé par un déclencheur", et operationtype est défini sur "script global", et opcommand_hst n'est pas défini
opcommand_hst array Hôte sur lequel exécuter des scripts globaux.

Les hôtes doivent avoir la propriété hostid définie.

Comportement de la propriété :
- obligatoire si eventsource de l'objet Action est défini sur "événement créé par un déclencheur", et operationtype est défini sur "script global", et opcommand_grp n'est pas défini
opmessage object Objet contenant les données du message envoyé par l'opération de mise à jour.

L'objet de message d'opération est décrit en détail ci-dessus.
opmessage_grp array Groupes d'utilisateurs auxquels envoyer des messages.

Les groupes d'utilisateurs doivent avoir la propriété usrgrpid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur "envoyer un message" et opmessage_usr n'est pas défini
opmessage_usr array Utilisateurs auxquels envoyer des messages.

Les utilisateurs doivent avoir la propriété userid définie.

Comportement de la propriété :
- obligatoire si operationtype est défini sur "envoyer un message" et opmessage_grp n'est pas défini

Filtre d’action

L’objet de filtre d’action définit un ensemble de conditions qui doivent être remplies pour exécuter les opérations d’action configurées. Il possède les propriétés suivantes.

Property Type Description
conditions array Ensemble de conditions de filtre à utiliser pour filtrer les résultats. Les conditions seront triées dans l’ordre de leur placement dans la formule.

Property behavior:
- required
evaltype integer Méthode d’évaluation des conditions du filtre.

Valeurs possibles :
0 - Et/Ou ;
1 - Et ;
2 - Ou ;
3 - Expression personnalisée.

Property behavior:
- required
eval_formula string Expression générée qui sera utilisée pour évaluer les conditions du filtre. L’expression contient des identifiants qui font référence à des conditions de filtre spécifiques par leur formulaid. La valeur de eval_formula est égale à la valeur de formula pour les filtres avec une expression personnalisée.

Property behavior:
- read-only
formula string Expression définie par l’utilisateur à utiliser pour évaluer les conditions des filtres avec une expression personnalisée. L’expression doit contenir des identifiants qui font 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 du filtre : aucune condition ne peut rester inutilisée ou omise.

Property behavior:
- required si evaltype est défini sur « custom expression »

Condition de filtre d'action

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

Property Type Description
conditiontype integer Type de condition.

Valeurs possibles si eventsource de l'objet Action est défini sur « événement créé par un déclencheur » :
0 - groupe d'hôtes ;
1 - hôte ;
2 - déclencheur ;
3 - nom de l'événement ;
4 - sévérité du déclencheur ;
6 - période ;
13 - modèle d'hôte ;
16 - le problème est supprimé ;
25 - tag d'événement ;
26 - valeur du tag d'événement.

Valeurs possibles si eventsource de l'objet Action est défini sur « événement créé par une règle de découverte » :
7 - IP de l'hôte ;
8 - type de service découvert ;
9 - port du service découvert ;
10 - statut de découverte ;
11 - durée de disponibilité ou d'indisponibilité ;
12 - valeur reçue ;
18 - règle de découverte ;
19 - vérification de découverte ;
20 - proxy ;
21 - objet de découverte.

Valeurs possibles si eventsource de l'objet Action est défini sur « événement créé par l'auto-enregistrement de l'agent actif » :
20 - proxy ;
22 - nom d'hôte ;
24 - métadonnées de l'hôte.

Valeurs possibles si eventsource de l'objet Action est défini sur « événement interne » :
0 - groupe d'hôtes ;
1 - hôte ;
13 - modèle d'hôte ;
23 - type d'événement ;
25 - tag d'événement ;
26 - valeur du tag d'événement.

Valeurs possibles si eventsource de l'objet Action est défini sur « événement créé lors de la mise à jour du statut du service » :
25 - tag d'événement ;
26 - valeur du tag d'événement ;
27 - service ;
28 - nom du service.

Comportement de la propriété :
- obligatoire
value string Valeur à comparer.

Comportement de la propriété :
- obligatoire
value2 string Valeur secondaire à comparer.

Comportement de la propriété :
- obligatoire si eventsource de l'objet Action est défini sur « événement créé par un déclencheur », que conditiontype est défini sur n'importe quelle valeur possible pour les actions de déclencheur, et que le type de condition (voir ci-dessous) est « 26 »
- obligatoire si eventsource de l'objet Action est défini sur « événement interne », que conditiontype est défini sur n'importe quelle valeur possible pour les actions internes, et que le type de condition (voir ci-dessous) est « 26 »
- obligatoire si eventsource de l'objet Action est défini sur « événement créé lors de la mise à jour du statut du service », que conditiontype est défini sur n'importe quelle valeur possible pour les actions de service, et que le type de condition (voir ci-dessous) est « 26 »
formulaid string ID unique arbitraire utilisé pour référencer la condition depuis une expression personnalisée. Ne peut contenir que des lettres majuscules. L'ID doit être défini par l'utilisateur lors de la modification des conditions de filtre, mais il sera généré à nouveau lors de leur demande ultérieure.
operator integer Opérateur de condition.

Valeurs possibles :
0 - (par défaut) égal à ;
1 - différent de ;
2 - contient ;
3 - ne contient pas ;
4 - dans ;
5 - supérieur ou égal à ;
6 - inférieur ou égal à ;
7 - pas dans ;
8 - correspond ;
9 - ne correspond pas ;
10 - Oui ;
11 - Non.

Pour mieux comprendre comment utiliser les filtres avec différents types d'expressions, consultez les exemples dans les pages des méthodes action.get et action.create.

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

Condition Condition name Supported operators Expected value
0 Groupe d'hôtes égal à,
différent de		 ID du groupe d'hôtes.
1 Hôte égal à,
différent de		 ID de l'hôte.
2 Déclencheur égal à,
différent de		 ID du déclencheur.
3 Nom de l'événement contient,
ne contient pas		 Nom de l'événement.
4 Sévérité du déclencheur égal à,
différent de,
supérieur ou égal à,
inférieur ou égal à		 Sévérité du déclencheur. Consultez la propriété severity du déclencheur pour la liste des sévérités de déclencheur prises en charge.
5 Valeur du déclencheur égal à Valeur du déclencheur. Consultez la propriété value du déclencheur pour la liste des valeurs de déclencheur prises en charge.
6 Période dans, pas dans Heure à laquelle l'événement a été déclenché sous forme de période.
7 IP de l'hôte égal à,
différent de		 Une ou plusieurs plages d'adresses IP à vérifier, séparées par des virgules. Consultez la section configuration de la découverte réseau pour plus d'informations sur les formats pris en charge des plages d'adresses IP.
8 Type de service découvert égal à,
différent de		 Type de service découvert. Le type de service correspond au type de la vérification de découverte utilisée pour détecter le service. Consultez la propriété type de la vérification de découverte pour la liste des types pris en charge.
9 Port du service découvert égal à,
différent de		 Une ou plusieurs plages de ports, séparées par des virgules.
10 Statut de découverte é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é supérieur ou égal à,
inférieur ou égal à		 Temps indiquant depuis combien de temps l'objet découvert se trouve dans le statut actuel, en secondes.
12 Valeurs reçues égal à,
différent de,
supérieur ou égal à,
inférieur ou égal à,
contient,
ne contient pas		 Valeur renvoyée lors de l'exécution d'une vérification de découverte Zabbix agent, SNMPv1, SNMPv2 ou SNMPv3.
13 Modèle d'hôte égal à,
différent de		 ID du modèle lié.
16 Le problème est supprimé Oui, Non Aucune valeur requise : l'utilisation de l'opérateur « Oui » signifie que le problème doit être supprimé, « Non » - non supprimé.
18 Règle de découverte égal à,
différent de		 ID de la règle de découverte.
19 Vérification de découverte égal à,
différent de		 ID de la vérification de découverte.
20 Proxy égal à,
différent de		 ID du proxy.
21 Objet de découverte é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,
correspond,
ne correspond pas		 Nom d'hôte.
L'utilisation d'une expression régulière est prise en charge pour les opérateurs correspond et ne correspond pas dans les conditions d'auto-enregistrement.
23 Type d'événement égal à Événement interne spécifique.

Valeurs possibles :
0 - élément dans l'état « non pris en charge » ;
1 - élément dans l'état « normal » ;
2 - règle LLD dans l'état « non pris en charge » ;
3 - règle LLD 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,
correspond,
ne correspond pas		 Métadonnées de l'hôte auto-enregistré.
L'utilisation d'une expression régulière est prise en charge pour les opérateurs correspond et ne correspond pas.
25 Tag égal à,
différent de,
contient,
ne contient pas		 Tag d'événement.
26 Valeur du tag égal à,
différent de,
contient,
ne contient pas		 Valeur du tag d'événement.
27 Service égal à,
différent de		 ID du service.
28 Nom du service égal à,
différent de		 Nom du service.