Sommaire
Objet Action
Les objets suivants sont directement liés à l'API action.
Action
L’objet action possède les propriétés suivantes.
| Property | Type | Description |
|---|---|---|
| actionid | ID | ID de l’action. Comportement de la propriété : - en lecture seule - obligatoire pour les opérations de mise à jour |
| esc_period | string | Durée par défaut d’une étape d’opération. Doit être d’au moins 60 secondes. Accepte un nombre de secondes (par exemple, 60, 300), une valeur avec un suffixe temporel (par exemple, 30s, 1m, 2h) ou une macro utilisateur.Comportement de la propriété : - prise 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 d’un 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é : - constante - 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 suspendre l’escalade si l’événement est un événement symptôme. Valeurs possibles : 0 - Ne pas suspendre l’escalade pour les problèmes symptômes ; 1 - (par défaut) Suspendre l’escalade pour les problèmes symptômes. Comportement de la propriété : - prise en charge si eventsource est défini sur « événement créé par un déclencheur » |
| pause_suppressed | integer | Indique s’il faut suspendre l’escalade pendant les périodes de maintenance. Valeurs possibles : 0 - Ne pas suspendre l’escalade ; 1 - (par défaut) Suspendre l’escalade. Comportement de la propriété : - prise 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 envoyer de notification lorsque l’escalade est annulée ; 1 - (par défaut) Envoyer une notification lorsque l’escalade est annulée. Comportement de la propriété : - prise 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 effectuée lorsqu’une action est exécutée. Il possède les propriétés suivantes.
| Property | 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 étiquettes à l’hôte ; 14 - supprimer des étiquettes de l’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 de la mise à jour de l’état d’un 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é : - required |
| esc_period | string | Durée d’une étape d’escalade en secondes. Doit être supérieure à 60 secondes. Accepte un nombre de secondes (par exemple, 60, 300), une valeur avec un suffixe temporel (par exemple, 30s, 1m, 2h) ou une macro utilisateur. Si la valeur est définie sur 0 ou 0s, la période d’escalade par défaut de l’action sera utilisée.Valeur par défaut : 0s. Comportement de la propriété : - supported 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 de la mise à jour de l’état d’un service » |
| esc_step_from | integer | Étape à partir de laquelle commencer l’escalade. Valeur par défaut : 1. Comportement de la propriété : - supported 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 de la mise à jour de l’état d’un service » |
| esc_step_to | integer | Étape à laquelle terminer l’escalade. Valeur par défaut : 1. Comportement de la propriété : - supported 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 de la mise à jour de l’état d’un service » |
| evaltype | integer | Méthode d’évaluation des conditions de l’opération. Valeurs possibles : 0 - (par défaut) And/Or ; 1 - And ; 2 - Or. |
| opcommand | object | Script global à exécuter. Le script global doit avoir la propriété scriptid définie.Comportement de la propriété : - required 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é : - required 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é : - required si operationtype est défini sur « script global » et que opcommand_grp n’est pas défini |
| opconditions | array | Conditions de l’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 les hôtes. Les groupes d’hôtes doivent avoir la propriété groupid définie.Comportement de la propriété : - required 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 du 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é : - required 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é : - required 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é : - required 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é : - required 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é : - required si operationtype est défini sur « définir le mode d’inventaire de l’hôte » |
| optag | array | Étiquettes de l’hôte à ajouter ou à supprimer. Les étiquettes doivent avoir la propriété tag définie.La propriété value est facultative. Comportement de la propriété : - supported si operationtype est défini sur « ajouter des étiquettes à l’hôte » ou « supprimer des étiquettes 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. Il possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| default_msg | integer | Indique s'il faut utiliser le texte et le sujet 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 "send message", ou si operationtype de l'objet d'opération de mise à jour d'action est défini sur "notify all involved" |
| message | string | Texte du message d'opération. Comportement de la propriété : - pris en charge si default_msg est défini sur "use the data from the operation" |
| subject | string | Sujet du message d'opération. Comportement de la propriété : - pris en charge si default_msg est défini sur "use the data from the operation" |
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 d'une 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", que 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 eventsource de l'objet Action est défini sur "événement créé par un déclencheur", que operationtype est défini sur "script global" et que 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 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 |
Opération de mise à jour d'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 (ajout d'un commentaire, acquittement, modification de la 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", que 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 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", que operationtype est défini sur "script global" et que 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 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 |
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.
| Propriété | 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. Comportement de la propriété: - obligatoire |
| evaltype | integer | Méthode d'évaluation des conditions du filtre. Valeurs possibles : 0 - Et/Ou ; 1 - Et ; 2 - Ou ; 3 - Expression personnalisée. Comportement de la propriété: - obligatoire |
| eval_formula | string | Expression générée qui sera utilisée pour évaluer les conditions du 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 à la valeur de formula pour les filtres avec une expression personnalisée.Comportement de la propriété: - lecture seule |
| 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 ID qui font référence à des conditions de filtre spécifiques par leur formulaid. Les ID utilisés dans l'expression doivent correspondre exactement à ceux définis dans les conditions du filtre : aucune condition ne peut rester inutilisée ou être omise.Comportement de la propriété: - obligatoire si evaltype est défini sur "expression personnalisée" |
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.
| Propriété | 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 de hôtes ; 1 - hôte ; 2 - déclencheur ; 3 - nom de l’événement ; 4 - gravité du déclencheur ; 6 - période ; 13 - modèle d’hôte ; 16 - problème supprimé ; 25 - balise d’événement ; 26 - valeur de balise 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 - adresse IP de l’hôte ; 8 - type de service découvert ; 9 - port du service découvert ; 10 - état de la 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 découvert ; 29 - groupe de proxies. Valeurs possibles si eventsource de l’objet Action est défini sur « événement créé par l’enregistrement automatique d’un agent actif » :20 - proxy ; 22 - nom de l’hôte ; 24 - métadonnées de l’hôte ; 29 - groupe de proxies. 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 - balise d’événement ; 26 - valeur de balise d’événement. Valeurs possibles si eventsource de l’objet Action est défini sur « événement créé lors de la mise à jour de l’état d’un service » :25 - balise d’événement ; 26 - valeur de balise 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 une 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 une 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 de l’état d’un service », que conditiontype est défini sur une 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 sera généré à nouveau lors de leur demande ultérieure. |
| operator | integer | Opérateur de la 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 supérieur ou égal à ; 6 - est inférieur ou égal à ; 7 - n’est 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 des 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 | 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 de l’événement | contient, ne contient pas |
Nom de l’événement. |
| 4 | Gravité du déclencheur | est égal à, n’est pas égal à, est supérieur ou égal à, est inférieur ou égal à |
Gravité du déclencheur. Consultez la propriété severity du déclencheur pour obtenir la liste des gravités de déclencheur prises en charge. |
| 5 | Valeur du déclencheur | est égal à | Valeur du déclencheur. Consultez la propriété value du déclencheur pour obtenir la liste des valeurs de déclencheur prises en charge. |
| 6 | Période | est dans, n’est pas dans |
Moment où l’événement a été déclenché, sous la forme d’une période. |
| 7 | Adresse IP de l’hôte | est égal à, n’est pas égal à |
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 de plages d’adresses IP pris en charge. |
| 8 | Type de service découvert | est égal à, n’est pas égal à |
Type du 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 obtenir la liste des types pris en charge. |
| 9 | Port du service découvert | est égal à, n’est pas égal à |
Une ou plusieurs plages de ports, séparées par des virgules. |
| 10 | État de la découverte | est égal à | État d’un objet découvert. Valeurs possibles : 0 - hôte ou service disponible ; 1 - hôte ou service indisponible ; 2 - hôte ou service découvert ; 3 - hôte ou service perdu. |
| 11 | Durée de disponibilité ou d’indisponibilité | est supérieur ou égal à, est inférieur ou égal à |
Durée, en secondes, pendant laquelle l’objet découvert se trouve dans son état actuel. |
| 12 | Valeurs reçues | est égal à, n’est pas égal à, est supérieur ou égal à, est 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 | est égal à, n’est pas égal à |
ID du modèle lié. |
| 16 | Problème supprimé | Oui, Non | Aucune valeur requise : l’utilisation de l’opérateur « Oui » signifie que le problème doit être supprimé, « Non » qu’il ne doit pas l’être. |
| 18 | Règle de découverte | est égal à, n’est pas égal à |
ID de la règle de découverte. |
| 19 | Vérification de découverte | est égal à, n’est pas égal à |
ID de la vérification de découverte. |
| 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 de l’hôte | contient, ne contient pas, correspond à, ne correspond pas à |
Nom de l’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’enregistrement automatique. |
| 23 | Type d’événement | est é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 enregistré automatiquement. L’utilisation d’une expression régulière est prise en charge pour les opérateurs correspond à et ne correspond pas à. |
| 25 | Balise | est égal à, n’est pas égal à, contient, ne contient pas |
Balise d’événement. |
| 26 | Valeur de balise | est égal à, n’est pas égal à, contient, ne contient pas |
Valeur de la balise d’événement. |
| 27 | Service | est égal à, n’est pas égal à |
ID du service. |
| 28 | Nom du service | est égal à, n’est pas égal à |
Nom du service. |
| 29 | Groupe de proxies | est égal à, n’est pas égal à |
ID du groupe de proxies. |