Documentation
Table of Contents
> Objet Scenario 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 | 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 de l'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 de base ; 2 - Authentification NTLM. |
| delay | string | Intervalle d'exécution du scénario Web. Accepte les secondes, l'unité de temps avec suffixe et la macro utilisateur. Par défaut : 1 m. |
| headers | 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 HTTP ou NTLM de base. |
| http_proxy | string | Proxy qui sera utilisé par le scénario Web donné comme http://[username[:password]@]proxy.example.com[:port]. |
| http_user | string | Nom d'utilisateur utilisé pour l'authentification HTTP ou NTLM de base. |
| 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é. Les valeurs possibles sont : 0 - (par défaut) activé ; 1 - désactivé. |
| templateid | string | (lecture seule) ID du scénario Web du modèle parent. |
| variables | tableau de champs HTTP | Variables de scénario Web. |
| verify_host | integer | Indique s'il faut vérifier que le nom d'hôte spécifié dans le certificat SSL correspond à celui utilisé dans le scénario. Les valeurs possibles sont : 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. Les valeurs possibles sont : 0 - (par défaut) ignorer la vérification par l'homologue ; 1 - vérifier l'homologue. |
| uuid | string | (lecture seule sur les scénarios Web déjà existants) Identifiant unique global, utilisé pour lier les scénarios Web importés à ceux déjà existants. Utilisé uniquement pour les scénarios Web sur des modèles. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Tag de scénario Web
L'objet tag de scénario Web possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag (obligatoire) |
string | Nom du tag du scénario Web. |
| value | string | Valeur du tag du scénario Web. |
Étape du 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 | Suivre ou non les redirections HTTP. Les valeurs possibles sont : 0 - ne pas suivre les redirections ; 1 - (par défaut) suivre les redirections. |
| headers | 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 remplaceront les en-têtes spécifiés pour le scénario Web. |
| httptestid | string | (lecture seule) ID du scénario Web auquel appartient l'étape. |
| posts | string tableau de champs HTTP |
Variables HTTP POST sous forme de chaîne (données de publication brutes) ou sous forme de tableau de champs HTTP (données du 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 du scénario doit récupérer. Les valeurs possibles sont : 0 - (par défaut) uniquement le corps ; 1 - uniquement les en-têtes ; 2 - en-têtes et corps. |
| status_codes | string | Plages de codes d'état HTTP requis séparés par des virgules. |
| timeout | string | Délai d'expiration de la demande en secondes. Accepte les secondes, l'unité de temps avec suffixe et la macro utilisateur. Par défaut : 15 s. Maximum : 1h. Minimum : 1s. |
| variables | 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 |
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 ou 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 / champ POST ou GET. |
| value (obligatoire) |
string | Valeur de l'en-tête / variable / champ POST ou GET.. |