Documentation
Table of Contents
> Objet Scénario Web
Les objets suivants sont directement liés à l'API webcheck.
Scénario Web
L'objet de Scénario Web a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| httptestid | string | (lecture seule) ID du scénario web. |
| hostid (obligatoire) |
string | ID de l'hôte auquel appartient le scénario Web. |
| name (obligatoire) |
string | Nom du scénario web. |
| agent | string | Chaîne d'agent utilisateur qui sera utilisé par le scénario Web. Par défaut: Zabbix |
| applicationid | string | ID de l'application à laquelle appartient le scénario Web. |
| authentication | integer | Méthode d'authentification utilisée par le scénario Web. Valeurs possibles : 0 - (par défaut) aucune ; 1 - authentification HTTP de base ; 2 - Authentification NTLM. |
| delay | string | Intervalle d'exécution du scénario Web. Accepte les secondes, une unité de temps avec suffixe et les macros utilisateur. par défaut : 1m. |
| headers | string (obsolète) tableau de champs HTTP |
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 basique HTTP ou NTLM. |
| http_proxy | string | Le proxy qui sera utilisé par le scénario Web donné tel que http://[username[:password]@]proxy.example.com[:port]. |
| http_user | string | Nom d'utilisateur utilisé pour l'authentification basique HTTP ou NTLM. |
| nextcheck | timestamp | (lecture seule) Heure de la prochaine exécution du scénario Web. |
| 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 | string | (lecture seule) ID du scénario Web du modèle parent. |
| variables | string (obsolète) tableau de champs HTTP |
Variables de scénario web. |
| verify_host | integer | Indique si le nom d'hôte spécifié dans le certificat SSL correspond à celui utilisé dans le scénario. 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 vérifier le certificat SSL du serveur Web. Valeurs possibles : 0 - (par défaut) ignorer la vérification ; 1 - vérifier. |
Étape de scénario
L'objet d'étape de scénario définit une vérification de scénario Web spécifique. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| httpstepid | string | (lecture seule) ID de l'étape du scénario. |
| name (obligatoire) |
string | Nom de l'étape du scénario. |
| no (obligatoire) |
integer | Numéro de séquence de l'étape dans un scénario Web. |
| url (obligatoire) |
string | URL à vérifier. |
| 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 | string (obsolète) tableau de champs HTTP |
En-têtes HTTP qui seront envoyés lors de l'exécution d'une requête. Les en-têtes d'étape de scénario écraseront les en-têtes spécifiés pour le scénario Web. |
| httptestid | string | (lecture seule) ID du scénario Web auquel l'étape appartient. |
| posts | string tableau de champs HTTP |
Les variables HTTP POST sous forme de chaîne (données post brutes) ou de tableau de champs HTTP (données de champ 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 extraire. Valeurs possibles : 0 - (par défaut) seulement le corps ; 1 - seulement les en-têtes. |
| 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 les secondes, une unité de temps avec suffixe et les macros utilisateur. Par défaut : 15s. |
| variables | string (obsolète) tableau de champs HTTP |
Variables d'étape de scénario. |
| query_fields | tableau de champs HTTP | Champs de requête - tableau de champs HTTP qui sera ajouté à l'URL lors de l'exécution d'une requête. |
A la fois chaîne et tableau de champs HTTP sont autorisés pour les champs headers et variables du scénario Web et de l'objet d'étape de scénario Web.
Le type de données de chaîne pour headers et variables est obsolète et sera supprimé dans les futures versions.
Champ HTTP
L'objet de champ HTTP définit un nom et une valeur utilisés pour spécifier une variable, un en-tête HTTP, des données de champ de formulaire POST et des données de champ de requête. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| name (obligatoire) |
string | Nom de l'en-tête / variable / du champ POST ou GET. |
| value (obligatoire) |
string | Valeur de l'en-tête / variable / du champ POST ou GET. |