Objet de scénario web
Les objets suivants sont directement liés à l'API webcheck.
Scénario web
L'objet de scénario web possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| httptestid | ID | ID du scénario web. Comportement de la propriété : - lecture seule - obligatoire pour les opérations de mise à jour |
| hostid | ID | ID de l'hôte auquel appartient le scénario web. Comportement de la propriété : - constant - obligatoire pour les opérations de création |
| name | string | Nom du scénario web. Comportement de la propriété : - obligatoire pour les opérations de création |
| agent | string | Chaîne d'agent utilisateur qui sera utilisée par le scénario web. Par défaut : Zabbix |
| authentication | integer | Méthode d'authentification qui sera utilisée par le scénario web. Valeurs possibles : 0 - (par défaut) aucune ; 1 - authentification HTTP basique ; 2 - authentification NTLM ; 3 - authentification Kerberos ; 4 - authentification Digest. |
| delay | string | Intervalle d'exécution du scénario web. Accepte des secondes ou une unité de temps avec suffixe (par exemple, 30s, 1m, 2h, 1d), ou une macro utilisateur. Par défaut : 1m. |
| headers | array | En-têtes HTTP qui seront envoyés lors de l'exécution d'une requête. |
| http_password | string | Mot de passe utilisé pour l'authentification HTTP basique, NTLM, Kerberos ou Digest. |
| http_proxy | string | Proxy qui sera utilisé par le scénario web, indiqué sous la forme http://\[username\[:password\]@\]proxy.example.com\[:port]. |
| http_user | string | Nom d'utilisateur utilisé pour l'authentification HTTP basique, NTLM, Kerberos ou Digest. |
| retries | integer | Nombre de fois qu'un scénario web tentera d'exécuter chaque étape avant d'échouer. Par défaut : 1. |
| ssl_cert_file | string | Nom du fichier de certificat SSL utilisé pour l'authentification du client (doit être au format PEM). |
| ssl_key_file | string | Nom du fichier de clé privée SSL utilisé pour l'authentification du client (doit être au format PEM). |
| ssl_key_password | string | Mot de passe de la clé privée SSL. |
| status | integer | Indique si le scénario web est activé. Valeurs possibles : 0 - (par défaut) activé ; 1 - désactivé. |
| templateid | ID | ID du scénario web du modèle parent. Comportement de la propriété : - lecture seule |
| variables | array | Variables du scénario web. |
| verify_host | integer | Indique s'il faut valider que le nom d'hôte de la connexion correspond à celui figurant dans le certificat de l'hôte. Valeurs possibles : 0 - (par défaut) ignorer la vérification de l'hôte ; 1 - vérifier l'hôte. |
| verify_peer | integer | Indique s'il faut valider que le certificat de l'hôte est authentique. Valeurs possibles : 0 - (par défaut) ignorer la vérification du pair ; 1 - vérifier le pair. |
| uuid | string | Identifiant unique global, utilisé pour lier les scénarios web importés à ceux qui existent déjà. Généré automatiquement s'il n'est pas fourni. Comportement de la propriété : - pris en charge si le scénario web appartient à un modèle |
Étape de scénario
L'objet d'étape de scénario définit une vérification spécifique d'un scénario web. Il possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| name | string | Nom de l'étape de scénario. Comportement de la propriété : - obligatoire |
| no | integer | Numéro de séquence de l'étape dans un scénario web. Comportement de la propriété : - obligatoire |
| url | string | URL à vérifier. Comportement de la propriété : - obligatoire |
| follow_redirects | integer | Indique s'il faut suivre les redirections HTTP. Valeurs possibles : 0 - ne pas suivre les redirections ; 1 - (par défaut) suivre les redirections. |
| headers | array | En-têtes HTTP qui seront envoyés lors de l'exécution d'une requête. Les en-têtes de l'étape de scénario remplaceront les en-têtes spécifiés pour le scénario web. |
| posts | string/array | Variables HTTP POST sous forme de chaîne (données POST brutes) ou sous forme de tableau de champs HTTP (données de champs de formulaire). |
| required | string | Texte qui doit être présent dans la réponse. |
| retrieve_mode | integer | Partie de la réponse HTTP que l'étape de scénario doit récupérer. Valeurs possibles : 0 - (par défaut) corps uniquement ; 1 - en-têtes uniquement ; 2 - en-têtes et corps. |
| status_codes | string | Plages de codes d'état HTTP requis, séparées par des virgules. |
| timeout | string | Délai d'expiration de la requête en secondes. Accepte des secondes, une unité de temps avec suffixe ou une macro utilisateur. Par défaut : 15s. Maximum : 1h. Minimum : 1s. |
| variables | array | Variables de l'étape de scénario. |
| query_fields | array | Champs de requête - tableau de champs HTTP qui seront ajoutés à l'URL lors de l'exécution d'une requête. |
Champ HTTP
L'objet champ HTTP définit le nom et la valeur utilisés pour spécifier les variables du scénario web, les en-têtes HTTP, ainsi que les champs POST ou les paramètres de requête. Il possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| name | string | Nom de l'en-tête/de la variable/du champ POST ou GET. Comportement de la propriété: - obligatoire |
| value | string | Valeur de l'en-tête/de la variable/du champ POST ou GET. Comportement de la propriété: - obligatoire |
Balise de scénario web
L'objet de balise de scénario web possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag | string | Nom de la balise du scénario web. Comportement de la propriété : - obligatoire |
| value | string | Valeur de la balise du scénario web. Comportement de la propriété : - lecture seule. |
| object | integer | Type d'objet dont la balise a été héritée. Valeurs possibles : 0 - modèle ; 1 - hôte. Comportement de la propriété : - lecture seule. |
| objectid | ID | ID de l'objet dont la balise a été héritée. Comportement de la propriété : - lecture seule. |