> Objecte d'escenari web

Els següents objectes són vinculats a l'API webcheck.

Escenari web

L'objecte té les propietats següents.

Propietat Tipus Descripció
httptestid string (només lectura) ID de l'escenari web.
hostid
(obligatori)
string ID de l'equip al qual pertany l'escenari web.
name
(obligatori)
string Nom de l'escenari web.
agent string Cadena d'agent d'usuari que emprarà l'escenari web.

Per defecte: Zabbix
authentication integer Mètode d'autenticació que emprarà l'escenari web.

Valors possibles:
0 - (per defecte) cap;
1 - autenticació HTTP bàsica;< br>2 - Autenticació NTLM.
delay string Interval d'execució de l'escenari web. Accepta segons, unitat de temps amb sufix i macro d'usuari.

Per defecte: 1m.
headers array of camps HTTP Capçaleres HTTP que s'enviaran en executar una petició.
http_password string el mot de pas emprat per a l'autenticació bàsica HTTP o NTLM.
http_proxy string Proxy que emprarà l'escenari web donat com a http://[nom d'usuari[:mot de pas]@]proxy.example.com[:port].
http_user string Nom d'usuari emprat per a l'autenticació bàsica HTTP o NTLM.
nextcheck timestamp (només lectura) Hora de l'execució de l'escenari web següent.
retries integer Nombre de vegades que un escenari web intentarà executar cada passa abans de fallar.

Per defecte: 1.
ssl_cert_file string Nom del fitxer de certificat SSL emprat per a l'autenticació del client (ha d'ésser en format PEM).
ssl_key_file string Nom del fitxer de clau privada SSL emprat per a l'autenticació del client (ha d'ésser en format PEM).
ssl_key_password string mot de pas de clau privada SSL.
status integer Indica si l'escenari web és habilitat.

Els valors possibles són:
0 - (per defecte) activat;
1 - desactivat.
templateid string (només lectura) ID de l'escenari web de la plantilla principal.
variables array of camps HTTP variables d'escenari web.
verify_host integer Indica si s'ha de verificar que el nom d'equip especificat al certificat SSL coincideix amb el que s'empra a l'escenari.

Els valors possibles són:
0 - (per defecte) no comprova l'equip;
1 - comprova l'equip.
verify_peer integer Indica si s'ha de verificar el certificat SSL del servidor web.

Els valors possibles són:
0 - (per defecte) omet la verificació d'iguals;
1 - comprova.
uuid string (només lectura en escenaris web ja existents)
Identificador únic global, emprat per enllaçar escenaris web importats amb els ja existents. S'empra només per a escenaris web en models.

Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.

Etiqueta d'escenari web

L'objecte d'etiqueta d'escenari web té les propietats següents:

Propietat Tipus Descripció
tag
(obligatori)
string Nom de l'etiqueta de l'escenari web.
value string Valor de l'escenari web.

Passes de l'escenari

L'objecte defineix una comprovació d'escenari web específica. Té les següents propietats.

Propietat Tipus Descripció
httpstepid string (només lectura) ID de la passa de l'escenari.
name
(obligatori)
string Nom de la passa de l'escenari.
no
(obligatori)
integer Nombre de seqüència de la passa en un escenari web.
url
(obligatori)
string URL per comprovar.
follow_redirects integer Si s'han de seguir o no les redireccions HTTP.

Els valors possibles són:
0 - no segueix les redireccions;
1 - (per defecte) segueix les redireccions.
headers array of camps HTTP capçaleres HTTP que s'enviaran en executar una petició. Les capçaleres de passa d'escenari substituiran les capçaleres especificades per a l'escenari web.
httptestid string (només lectura) ID de l'escenari web al qual pertany la passa.
posts string
array of camps HTTP
variables HTTP POST com a cadena (dades de publicació en brut) o com a matriu de camps HTTP (dades del camp del formulari).
required string Text que ha d'ésser present a la resposta.
retrieve_mode integer Part de la resposta HTTP que hauria de retornar la passa de l'escenari.

Els valors possibles són:
0 - (per defecte) només cos;
1 - capçaleres només;
2 - capçaleres i cos.
status_codes string Intervals de codis d'estat HTTP obligatoris, separats per comes.
timeout string Temps d'espera de la petició, en segons. Accepta segons, unitat de temps amb sufix i macro d'usuari.

Per defecte: 15 s. Màxim: 1 hora. Mínim: 1s.
variables array of camps HTTP Variables de passa d'escenari.
query array of camps HTTP Camps de consulta - matriu de camps HTTP que s'afegirà a l'URL quan s'executi una consulta.

Camp HTTP

L'objecte de camp HTTP defineix un nom i un valor emprats per especificar una variable, una capçalera HTTP, les dades del camp de formulari POST o les dades de camp de petició. Té les propietats següents.

Propietat Tipus Descripció
nom
(obligatori)
string Nom de la capçalera / variable / camp POST o GET.
nom
(obligatori)
string Valor de la capçalera / variable / camp POST o GET.