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.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | 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?: Áú»¢¶Ä²© |
| 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) ²¹³¦³Ù¾±±¹¨¦?; 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.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | 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.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | 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.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | 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.. |