Table of Contents
> Webscenario-object
De volgende objecten zijn direct gerelateerd aan de webcheck API.
Web scenario
Het web scenario-object heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| httptestid | string | (alleen lezen) ID van het web scenario. |
| hostid (vereist) |
string | ID van de host waartoe het web scenario behoort. |
| name (vereist) |
string | Naam van het web scenario. |
| agent | string | User-agentstring die wordt gebruikt door het web scenario. Standaard: Zabbix |
| authentication | integer | Authenticatiemethode die wordt gebruikt door het web scenario. Mogelijke waarden: 0 - (standaard) geen; 1 - basis-HTTP-authenticatie; 2 - NTLM-authenticatie. |
| delay | string | Uitvoeringsinterval van het web scenario. Accepteert seconden, tijdseenheid met achtervoegsel en gebruikersmacro. Standaard: 1m. |
| headers | array van HTTP-velden | HTTP-headers die worden verzonden bij het uitvoeren van een verzoek. |
| http_password | string | Wachtwoord dat wordt gebruikt voor basis-HTTP- of NTLM-authenticatie. |
| http_proxy | string | Proxy die wordt gebruikt door het web scenario, opgegeven als http://[gebruikersnaam[:wachtwoord]@]proxy.example.com[:poort]. |
| http_user | string | Gebruikersnaam die wordt gebruikt voor basis-HTTP- of NTLM-authenticatie. |
| nextcheck | tijdstempel | (alleen lezen) Tijdstip van de volgende uitvoering van het web scenario. |
| retries | integer | Aantal keer dat een web scenario elke stap zal proberen uit te voeren voordat het mislukt. Standaard: 1. |
| ssl_cert_file | string | Naam van het SSL-certificaatbestand dat wordt gebruikt voor clientauthenticatie (moet in PEM-indeling zijn). |
| ssl_key_file | string | Naam van het bestand met de privésleutel van SSL die wordt gebruikt voor clientauthenticatie (moet in PEM-indeling zijn). |
| ssl_key_password | string | Wachtwoord voor privésleutel van SSL. |
| status | integer | Of het web scenario is ingeschakeld. Mogelijke waarden zijn: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
| templateid | string | (alleen lezen) ID van het bovenliggende sjabloon web scenario. |
| variables | array van HTTP-velden | Variabelen van het web scenario. |
| verify_host | integer | Of de hostnaam opgegeven in het SSL-certificaat moet overeenkomen met die welke in het scenario wordt gebruikt. Mogelijke waarden zijn: 0 - (standaard) hostverificatie overslaan; 1 - host verifiëren. |
| verify_peer | integer | Of het SSL-certificaat van de webserver moet worden geverifieerd. Mogelijke waarden zijn: 0 - (standaard) peer-verificatie overslaan; 1 - peer verifiëren. |
| uuid | string | Wereldwijd unieke identificator, gebruikt om geïmporteerde web scenario's te koppelen aan reeds bestaande. Alleen gebruikt voor web scenario's in sjablonen. |
Merk op dat voor sommige methoden (bijwerken, verwijderen) de vereiste/optionele parametercombinatie anders is.
Webscenario-tag
Het webscenario-tagobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| tag (vereist) |
string | Tagnaam webscenario. |
| value | string | Waarde webscenario-tag. |
Scenariostap
Het scenariostapobject definieert een specifieke webscenariocontrole. Het heeft de volgende eigenschappen.
| Property | Type | Beschrijving |
|---|---|---|
| httpstepid | string | (alleen-lezen) ID van de scenariostap. |
| name (verplicht) |
string | Naam van de scenariostap. |
| nee (verplicht) |
geheel getal | Volgnummer van de stap in een webscenario. |
| url (verplicht) |
string | URL moet worden gecontroleerd. |
| follow_redirects | integer | Of HTTP-omleidingen moeten worden gevolgd. Mogelijke waarden zijn: 0 - volg geen omleidingen; 1 - (standaard) volg omleidingen. |
| headers | array van HTTP-velden | HTTP-headers die worden verzonden bij het uitvoeren van een verzoek. Headers van scenariostappen overschrijven de headers die zijn opgegeven voor het webscenario. |
| httptestid | string | (alleen-lezen) ID van het webscenario waartoe de stap behoort. |
| posts | string array van HTTP-velden |
HTTP POST-variabelen als een string (onbewerkte postgegevens) of als een array van HTTP-velden (formulierveldgegevens). |
| required | string | Tekst die in het antwoord aanwezig moet zijn. |
| retrieve_mode | integer | Een deel van het HTTP-antwoord dat de scenariostap moet ophalen. Mogelijke waarden zijn: 0 - (standaard) alleen hoofdtekst; 1 - alleen headers; 2 - kopteksten en tekst. |
| status_codes | string | Bereik van vereiste HTTP-statuscodes gescheiden door komma's. |
| timeout | string | Verzoek time-out in seconden. Accepteert seconden, tijdseenheid met achtervoegsel en gebruikersmacro. Standaard: 15s. Maximaal: 1 uur. Minimaal: 1s. |
| variabelen | array van HTTP-velden | Scenariostapvariabelen. |
| query_fields | array van HTTP-velden | Queryvelden - array van HTTP-velden die aan de URL wordt toegevoegd bij het uitvoeren van een verzoek |
HTTP-veld
Het HTTP-veldobject definieert een naam en waarde die wordt gebruikt om te specificeren: variabele, HTTP-header, POST-formulierveldgegevens van queryveldgegevens. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| name (verplicht) |
string | Naam van header / variabele / POST- of GET-veld. |
| waarde (verplicht) |
string | Waarde van header / variabele / POST- of GET-veld. |