You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

> Webscenario-object

De volgende objecten zijn direct gerelateerd aan de webcheck API.

Web scenario

The web scenario object has the following properties.

Property Type Description
httptestid string ID of the web scenario.

Property behavior:
- read-only
- required for update operations
hostid string ID of the host that the web scenario belongs to.

Property behavior:
- constant
- required for create operations
name string Name of the web scenario.

Property behavior:
- required for create operations
agent string User agent string that will be used by the web scenario.

Default: Zabbix
authentication integer Authentication method that will be used by the web scenario.

Possible values:
0 - (default) none;
1 - basic HTTP authentication;
2 - NTLM authentication.
delay string Execution interval of the web scenario.
Accepts seconds, time unit with suffix, or a user macro.

Default: 1m.
headers array HTTP headers that will be sent when performing a request.
http_password string Password used for basic HTTP or NTLM authentication.
http_proxy string Proxy that will be used by the web scenario given as http://[username[:password]@]proxy.example.com[:port].
http_user string User name used for basic HTTP or NTLM authentication.
retries integer Number of times a web scenario will try to execute each step before failing.

Default: 1.
ssl_cert_file string Name of the SSL certificate file used for client authentication (must be in PEM format).
ssl_key_file string Name of the SSL private key file used for client authentication (must be in PEM format).
ssl_key_password string SSL private key password.
status integer Whether the web scenario is enabled.

Possible values:
0 - (default) enabled;
1 - disabled.
templateid string ID of the parent template web scenario.

Property behavior:
- read-only
variables array Web scenario variables.
verify_host integer Whether to verify that the host name specified in the SSL certificate matches the one used in the scenario.

Possible values:
0 - (default) skip host verification;
1 - verify host.
verify_peer integer Whether to verify the SSL certificate of the web server.

Possible values:
0 - (default) skip peer verification;
1 - verify peer.
uuid string Global unique identifier, used for linking imported web scenarios to already existing ones. Auto-generated, if not given.

Property behavior:
- supported if the web scenario belongs to a template

Webscenario-tag

Het object webscenario-tag heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
tag string Naam van de webscenario-tag.

Eigenschapsgedrag:
- vereist
value string Waarde van de webscenario-tag.

Scenariostap

Het object scenariostap definieert een specifieke controle in een webscenario. Het heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
name string Naam van de scenariostap.

Eigenschapsgedrag:
- vereist
no integer Volgnummer van de stap in een webscenario.

Eigenschapsgedrag:
- vereist
url string URL die moet worden gecontroleerd.

Eigenschapsgedrag:
- vereist
follow_redirects integer Of HTTP-omleidingen moeten worden gevolgd.

Mogelijke waarden:
0 - omleidingen niet volgen;
1 - (standaard) omleidingen volgen.
headers array HTTP-headers die worden verzonden bij het uitvoeren van een aanvraag. Scenariostap-headers zullen headers overschrijven die zijn gespecificeerd voor het webscenario.
posts string/array HTTP POST-variabelen als een string (ruwe postdata) of als een array van HTTP-velden (formuliergegevens).
required string Tekst die aanwezig moet zijn in het antwoord.
retrieve_mode integer Deel van het HTTP-antwoord dat de scenariostap moet ophalen.

Mogelijke waarden:
0 - (standaard) alleen de body;
1 - alleen headers;
2 - headers en body.
status_codes string Reeksen vereiste HTTP-statuscodes, gescheiden door komma's.
timeout string Aanvraagtime-out in seconden. Accepteert seconden, tijdeenheid met suffix of een gebruikersmacro.

Standaard: 15s. Maximum: 1u. Minimum: 1s.
variables array Scenariostap variabelen.
query_fields array Query-velden - array van HTTP-velden die aan de URL worden toegevoegd bij het uitvoeren van een aanvraag.

HTTP-veld

Het object HTTP-veld definieert de naam en de waarde die wordt gebruikt om de webscenario-variabelen, HTTP-headers en POST- of queryvelden op te geven. Het heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
name string Naam van header/variabele/POST- of GET-veld.

Eigenschapsgedrag:
- vereist
value string Waarde van header/variabele/POST- of GET-veld.

Eigenschapsgedrag:
- vereist