> Objet Action

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

Action

L'objet d'action a les propriétés suivantes :

Propriété	Type	Description
actionid	string	(lecture seule) identifiant de l'action.
esc_period (obligatoire)	string	Durée de l'étape de l'opération par défaut. Doit être d'au moins 60 secondes. Accepte les secondes, l'unité de temps avec suffixe et les macros utilisateur. Notez que les escalades ne sont prises en charge que pour les actions de déclenchement, internes et de service, et uniquement dans les opérations normales.
eventsource (obligatoire)	integer	(constant) Type d'événements que l'action gérera. Reportez-vous à la propriété "source" de l'événement pour obtenir la liste des types d'événements pris en charge.
name (obligatoire)	string	Nom de l'action.
status	integer	Si l'action est activée ou désactivée. Valeurs possibles : 0 - (par défaut) activé ; 1 - désactivé.
pause_suppressed	integer	Indique s'il faut suspendre ou non l'escalade pendant les périodes de maintenance. Valeurs possibles : 0 - Ne pas interrompre l'escalade ; 1 - (par défaut) Suspendre l'escalade. Notez que ce paramètre n'est valide que pour les actions de déclencheur.
notify_if_canceled	integer	Indique si l'escalade est annulée. Valeurs possibles : 0 - Ne pas avertir lorsque l'escalade est annulée ; 1 - (par défaut) Avertir lorsque l'escalade est annulée. Notez que ce paramètre n'est valide que pour les actions de déclencheur.

Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.

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) Identifiant de l'opération d'action.
operationtype (obligatoire)	integer	Type d'operation. Valeurs possibles : 0 - envoyer un message ; 1 - script global ; 2 - ajouter un hôte ; 3 - supprimer un hôte ; 4 - ajouter au groupe d'hôtes ; 5 - supprimer du groupe d'hôte ; 6 - lier au 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. Notez que seuls les types '0' et '1' sont supportés pour les actions de déclencheur et de service, seul '0' est supporté pour les actions internes. Tous les types sont supportés pour les actions de découverte et d'enregistrement automatique.
actionid	string	(lecture seule) Identifiant de l'action à laquelle appartient l'opération.
esc_period	string	Durée d'une étape d'escalade en secondes. Doit être supérieur à 60 secondes. Accepte les secondes, l'unité de temps avec suffixe et la macro utilisateur. Si défini sur 0 ou 0 s, la période d'escalade d'action par défaut sera utilisée. Par défaut : 0 s. Notez que les escalades ne sont prises en charge que pour les actions de déclenchement, internes et de service, et uniquement dans des conditions normales opérations.
esc_step_from	integer	Étape à partir de laquelle l'escalade démarre. Par défaut : 1. Notez que les escalades ne sont prises en charge que pour les actions de déclenchement, internes et de service, et uniquement dans les opérations normales.
esc_step_to	integer	Étape à laquelle l'escalade se termine. Par défaut : 1. Notez que les escalades ne sont prises en charge que pour les actions de déclenchement, internes et de service, et uniquement dans les opérations normales.
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 des données sur le script global exécuté par l'opération. Chaque objet a la propriété suivante : `scriptid` - (string) identifiant du script. Requis pour les opérations de script global.
opcommand_grp	array	Groupes d'hôtes sur lesquels exécuter des scripts globaux. Chaque objet a les propriétés suivantes : `opcommand_grpid` - (string, lecture seule) identifiant de l'objet ; `operationid` - (string, lecture seule) identifiant de l'opération ; `groupid` - (string) identifiant du groupe d'hôtes. Requis pour les opérations de script global si `opcommand_hst` n'est pas défini.
opcommand_hst	array	Hôte sur lequel exécuter des scripts globaux. Chaque objet a les propriétés suivantes : `opcommand_hstid` - (string, lecture seule) identifiant de l'objet ; `operationid` - (string , lecture seule) identifiant de l'opération ; `hostid` - (string) identifiant de l'hôte ; si défini sur 0, la commande sera exécutée sur l'hôte actuel. Requis pour les opérations de script global si `opcommand_grp` n'est pas défini.
opconditions	array	Conditions d'opération utilisées pour les actions de déclenchement. 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. Chaque objet a les propriétés suivantes : `operationid` - (string, lecture seule) identifiant de l'opération ; `groupid` - (string ) identifiant du groupe d'hôtes. Requis pour les opérations "ajouter au groupe d'hôtes" et "supprimer du groupe d'hôtes".
opmessage	object	Objet contenant les données sur le message envoyé par l'opération. L'objet de message d'opération est décrit en détail ci-dessous. 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, lecture seule) identifiant de l'opération ; `usrgrpid` - (string ) identifiant du groupe d'utilisateurs. Requis 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, lecture seule) identifiant de l'opération ; `userid` - (string) identifiant de l'utilisateur. Requis pour les opérations de message si `opmessage_grp` n'est pas défini.
optemplate	array	Modèles auxquels lier les hôtes. Chaque objet a les propriétés suivantes : `operationid` - (string, lecture seule) identifiant de l'opération ; `templateid` - (chaîne) identifiant du modèle. Requis pour les opérations "lier au modèle" et "dissocier du modèle".
opinventory	object	Mode d'inventaire défini sur l'hôte. L'objet a les propriétés suivantes : `operationid` - (string, lecture seule) identifiant de l'opération ; `inventory_mode` - (string) Inventory mode. Requis pour les opérations "Définir le mode d'inventaire de l'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.

Propriété	Type	Description
default_msg	integer	Indique s'il faut utiliser le texte et l'objet du message d'action par défaut. Valeurs possibles : 0 - utiliser les données de l'opération ; 1 - (par défaut) utiliser les données du type de media.
mediatypeid	string	ID 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é	=	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 effectuée lorsqu'un problème est résolu. Les opérations de récupération sont possibles pour les actions de déclenchement, internes et de service. Il a les propriétés suivantes :

Propriété	Type	Description
operationid	string	(lecture seule) identifiant de l'opération d'action.
operationtype (obligatoire)	integer	Type d'opération. Valeurs possibles pour les actions de déclenchement et de service : 0 - envoyer un message ; 1 - script global ;< br>11 - notifier toutes les personnes impliquées. Valeurs possibles pour les actions internes : 0 - envoyer un message ; 11 - notifier toutes les personnes impliquées.
actionid	string	(lecture seule) Identifiant de l'action à laquelle appartient l'opération de restauration.
opcommand	object	Objet contenant des données sur le script de type d'action global exécuté par l'opération. Chaque objet a la propriété suivante : `scriptid` - (string) identifiant du script de type d'action. Requis pour les opérations de script global.
opcommand_grp	array	Groupes d'hôtes sur lesquels exécuter des scripts globaux. Chaque objet a les propriétés suivantes : `opcommand_grpid` - (string, readonly) identifiant de l'objet ; `operationid` - (string, readonly) identifiant de l'opération ; `groupid` - (string) identifiant du groupe d'hôtes. Requis pour les opérations de script global si `opcommand_hst` n'est pas défini.
opcommand_hst	array	Hôte sur lequel exécuter les scripts globaux. Chaque objet a les propriétés suivantes : `opcommand_hstid` - (string, readonly) identifiant de l'objet ; `operationid` - (string, readonly) identifiant de l'opération ; `hostid` - (string) identifiant de l'hôte ; si défini sur 0, la commande sera exécutée sur l'hôte actuel. Requis pour les opérations de script global 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 de message d'opération est décrit en détail ci-dessus. 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, readonly) identifiant de l'opération ; `usrgrpid` - (string) identifiant du groupe d'utilisateurs. Requis 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, readonly) identifiant de l'opération ; `userid` - (chaîne) identifiant de l'utilisateur. Requis pour les opérations de message si `opmessage_grp` n'est pas défini.

Opération de mise à jour de l'action

L'objet d'opération de mise à jour d'action définit une opération qui sera effectuée lorsqu'un problème est mis à jour (commenté, acquitté, gravité modifiée ou fermé manuellement). Les opérations de mise à jour sont possibles pour les actions de déclenchement et de service. Il a les propriétés suivantes :

Propriété	Type	Description
operationid	string	(lecture seule) identifiant de l'opération d'action.
operationtype (obligatoire)	integer	Type d'opération. Valeurs possibles pour les actions de déclenchement et de service : 0 - envoyer un message ; 1 - script global ; 12 - informez toutes les personnes impliquées.
opcommand	object	Objet contenant des données sur le script de type d'action global exécuté par l'opération. Chaque objet a la propriété suivante : `scriptid` - (string) identifiant du script de type d'action. Requis pour les opérations de script global.
opcommand_grp	array	Groupes d'hôtes sur lesquels exécuter des scripts globaux. Chaque objet a les propriétés suivantes : `groupid` - (string) identifiant du groupe d'hôtes. < br>Requis pour les opérations de script global si `opcommand_hst` n'est pas défini.
opcommand_hst	array	Hôte sur lequel exécuter les scripts globaux. Chaque objet a les propriétés suivantes : `hostid` - (string) identifiant de l'hôte ; si défini sur 0, la commande sera exécutée sur l'hôte actuel. Requis pour les opérations de script global si `opcommand_grp` n'est pas défini.
opmessage	object	Objet contenant les données sur le 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. Chaque objet a les propriétés suivantes : `usrgrpid` - (string) identifiant du groupe d'utilisateurs. >Requis uniquement pour les opérations `send message` si `opmessage_usr` n'est pas défini. Est ignoré pour les opérations `send update message`.
opmessage_usr	array	Utilisateurs auxquels envoyer des messages. Chaque objet a les propriétés suivantes : `userid` - (string) identifiant de l'utilisateur. Obligatoire uniquement pour les opérations `send message` si `opmessage_grp` n'est pas défini. Est ignoré pour les opérations `send update message`.

### Filtre d'actions

L'objet de 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 filtre à utiliser pour filtrer les résultats.
evaltype (obligatoire)	integer	Méthode d'évaluation de la condition de filtre. 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 identifiants qui font référence à des conditions de filtre spécifiques par son `formulaid`. La valeur de `eval_formula` est égale à la valeur de `formula` pour les filtres avec une expression personnalisée.
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 faisant référence à des conditions de filtre spécifiques par son `formulaid`. Les identifiants utilisés dans l'expression doivent correspondre exactement à ceux définis dans les conditions de filtre : aucune condition ne peut rester inutilisée ou omise. Requis pour les filtres d'expression personnalisées.

Condition du filtre d'action

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

Propriété	Type	Description
conditionid	string	(lecture seule) Identifiant de la condition d'action.
conditiontype (obligatoire)	integer	Type de condition. Valeurs possibles pour les actions de déclenchement : 0 - groupe d'hôtes ; 1 - hôte ; 2 - déclencheur ; 3 - nom du déclencheur ; 4 - gravité du déclencheur ; 6 - période ; 13 - modèle d'hôte ; 16 - problème supprimé ; 25 - tag d'événement ; 26 - valeur du 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 du service découvert ;< br>10 - état 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 ;<br >21 - objet de découverte. Valeurs possibles pour les actions d'enregistrement automatique : 20 - proxy ; 22 - nom d'hôte ; 24 - métadonnées de l'hôte. Valeurs possibles pour actions internes : 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 pour les actions de service : 25 - tag d'événement ; 26 - valeur du tag d'événement ; 27 - service ;<br >28 - nom du service.
valeur (obligatoire)	string	Valeur à comparer.
value2	string	Valeur secondaire à comparer. Requis pour les actions de déclenchement, internes et de service lorsque le type de condition est 26.
actionid	string	(lecture seule) Identifiant de l'action à laquelle appartient la condition.
formulaid	string	Identifiant unique arbitraire utilisé pour référencer la condition à partir d'une expression personnalisée. Ne peut contenir que des lettres majuscules. L'identifiant doit être défini par l'utilisateur lors de la modification des conditions de filtre, mais sera généré à nouveau lors de sa demande ultérieure.
opérateur	entier	Opérateur de condition. Valeurs possibles : 0 - (par défaut) est égal ; 1 - n'est pas égal ; 2 - contient ; 3 - ne contient pas ; 4 - dans ; 5 - est supérieur ou égal à ; 6 - est inférieur ou égal à ; 7 - n'est pas dans ; 8 - correspond ;<br >9 - ne correspond pas ; 10 - Oui ; 11 - Non.

Pour mieux comprendre comment utiliser les filtres avec différents types d'expressions, consultez les exemples sur les pages de méthodes 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	égal, pas égal	identifiant du groupe d'hôtes.
1	Hôte	égal, pas égal	identifiant d'hôte.
2	Déclencheur	égal, pas égal	identifiant de déclencheur.
3	Nom du déclencheur	contient, ne contient pas	Nom du déclencheur.
4	Gravité du déclencheur	égale, pas égale, supérieure ou égale, inférieure ou égale	Gravité du déclencheur. Reportez-vous à la propriété "trigger "severity" pour obtenir une liste des sévérités de déclenchement prises en charge.
5	Valeur de déclenchement	égal	Valeur de déclenchement. Reportez-vous à la propriété "valeur" du déclencheur pour obtenir une liste des valeurs de déclencheur prises en charge.
6	Période de temps	dans, pas dans	Heure à laquelle l'événement a été déclenché en tant que période.
7	IP de l'hôte	égal, pas égal	Une ou plusieurs plages IP à vérifier séparées par des virgules. Reportez-vous à la section configuration de la découverte du réseau pour plus d'informations sur les formats pris en charge des plages IP.
8	Type de service découvert	égal, pas égal	Type de service découvert. Le type de service correspond au type de contrôle de découverte utilisé pour détecter le service. Reportez-vous à la propriété "type" de la vérification de découverte pour obtenir la liste des types pris en charge.
9	Port de service découvert	égal, différent	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 désactivé ; 2 - hôte ou service découvert ; 3 - hôte ou service perdu.
11	Durée de disponibilité ou d'indisponibilité	supérieure ou égale, inférieure ou égale	Durée indiquant depuis combien de temps l'objet découvert est dans l'état actuel en secondes.
12	Valeurs reçues	égales, différentes, supérieures ou égales, inférieures ou égales, contient, ne contiennent pas	Valeur renvoyée lors de l'exécution d'un Agent Zabbix, contrôle de découverte SNMPv1, SNMPv2 ou SNMPv3.
13	Modèle d'hôte	égal, pas égal	ID de 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, pas égal	ID de la règle de découverte.
19	Contrôle de découverte	égal, pas égal	ID du contrôle de découverte.
20	Proxy	égal, pas égal	ID du proxy.
21	Objet de découverte	égal	Type d'objet qui a 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 des conditions d'auto-enregistrement.
23	Type d'événement	égal	Événement interne spécifique. Valeurs possibles : 0 - élément à l'état "non pris en charge" ; 1 - élément à l'état "normal" ; 2 - Règle LLD à l'état "non pris en charge" ; 3 - Règle LLD à l'état "normal" ; 4 - Déclencheur à l'état "inconnu" ; 5 - Déclencheur à 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 enregistré automatiquement. L'utilisation d'une expression régulière est prise en charge pour les opérateurs correspond et ne correspond pas.
25	Tag	égal, pas égal, contient, ne contient pas	Tag d'événement.
26	Valeur du tag	égale, pas égale, contient, ne contient pas	Valeur du tag d'événement.
27	Service	égal, pas égal à	ID de service.
28	Nom du service	égal, pas égal	Nom du service.

Documentation