Web-Szenario-Objekt
Die folgenden Objekte stehen in direktem Zusammenhang mit der webcheck API.
Webszenario
Das Webszenario-Objekt verfügt über die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| httptestid | ID | ID des Webszenarios. Verhalten der Eigenschaft: - schreibgeschützt - erforderlich für Aktualisierungsvorgänge |
| hostid | ID | ID des Hosts, zu dem das Webszenario gehört. Verhalten der Eigenschaft: - konstant - erforderlich für Erstellungsvorgänge |
| name | string | Name des Webszenarios. Verhalten der Eigenschaft: - erforderlich für Erstellungsvorgänge |
| agent | string | User-Agent-Zeichenfolge, die vom Webszenario verwendet wird. Standard: Zabbix |
| authentication | integer | Authentifizierungsmethode, die vom Webszenario verwendet wird. Mögliche Werte: 0 - (Standard) keine; 1 - einfache HTTP-Authentifizierung; 2 - NTLM-Authentifizierung; 3 - Kerberos-Authentifizierung; 4 - Digest-Authentifizierung. |
| delay | string | Ausführungsintervall des Webszenarios. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300), einen Wert mit einem Zeitsuffix (z. B. 30s, 1m, 2h, 1d) oder ein Benutzermakro.Standard: 1m. |
| headers | array | HTTP-Header, die beim Ausführen einer Anfrage gesendet werden. |
| http_password | string | Passwort für die einfache HTTP-, NTLM-, Kerberos- oder Digest-Authentifizierung. |
| http_proxy | string | Proxy, der vom Webszenario verwendet wird, angegeben als http://\[username\[:password\]@\]proxy.example.com\[:port]. |
| http_user | string | Benutzername für die einfache HTTP-, NTLM-, Kerberos- oder Digest-Authentifizierung. |
| retries | integer | Anzahl der Versuche, die ein Webszenario zur Ausführung jedes Schritts unternimmt, bevor es fehlschlägt. Standard: 1. |
| ssl_cert_file | string | Name der SSL-Zertifikatsdatei, die für die Clientauthentifizierung verwendet wird (muss im PEM-Format vorliegen). |
| ssl_key_file | string | Name der privaten SSL-Schlüsseldatei, die für die Clientauthentifizierung verwendet wird (muss im PEM-Format vorliegen). |
| ssl_key_password | string | Passwort des privaten SSL-Schlüssels. |
| status | integer | Gibt an, ob das Webszenario aktiviert ist. Mögliche Werte: 0 - (Standard) aktiviert; 1 - deaktiviert. |
| templateid | ID | ID des übergeordneten Webszenarios der Vorlage. Verhalten der Eigenschaft: - schreibgeschützt |
| variables | array | Variablen des Webszenarios. |
| verify_host | integer | Gibt an, ob überprüft werden soll, dass der Hostname der Verbindung mit dem im Zertifikat des Hosts angegebenen Hostnamen übereinstimmt. Mögliche Werte: 0 - (Standard) Hostüberprüfung überspringen; 1 - Host überprüfen. |
| verify_peer | integer | Gibt an, ob überprüft werden soll, dass das Zertifikat des Hosts authentisch ist. Mögliche Werte: 0 - (Standard) Peer-Überprüfung überspringen; 1 - Peer überprüfen. |
| uuid | string | Global eindeutige Kennung, die verwendet wird, um importierte Webszenarien mit bereits vorhandenen Webszenarien zu verknüpfen. Wird automatisch generiert, wenn sie nicht angegeben wird. Verhalten der Eigenschaft: - unterstützt, wenn das Webszenario zu einer Vorlage gehört |
Szenarioschritt
Das Objekt des Szenarioschritts definiert eine bestimmte Prüfung eines Webszenarios. Es verfügt über die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| name | string | Name des Szenarioschritts. Verhalten der Eigenschaft: - erforderlich |
| no | integer | Sequenznummer des Schritts in einem Webszenario. Verhalten der Eigenschaft: - erforderlich |
| url | string | Zu prüfende URL. Verhalten der Eigenschaft: - erforderlich |
| follow_redirects | integer | Gibt an, ob HTTP-Weiterleitungen verfolgt werden sollen. Mögliche Werte: 0 - Weiterleitungen nicht verfolgen; 1 - (Standard) Weiterleitungen verfolgen. |
| headers | array | HTTP-Header, die beim Ausführen einer Anfrage gesendet werden. Die Header des Szenarioschritts überschreiben die für das Webszenario angegebenen Header. |
| posts | string/array | HTTP-POST-Variablen als Zeichenfolge (rohe POST-Daten) oder als Array von HTTP-Feldern (Formulardaten). |
| required | string | Text, der in der Antwort vorhanden sein muss. |
| retrieve_mode | integer | Teil der HTTP-Antwort, den der Szenarioschritt abrufen muss. Mögliche Werte: 0 - (Standard) nur Body; 1 - nur Header; 2 - Header und Body. |
| status_codes | string | Bereiche der erforderlichen HTTP-Statuscodes, durch Kommas getrennt. |
| timeout | string | Zeitüberschreitung für die Anfrage in Sekunden. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300), einen Wert mit einem Zeitsuffix (z. B. 30s, 1m, 1h) oder ein Benutzermakro.Standard: 15s. Maximum: 1h. Minimum: 1s. |
| variables | array | Variablen des Szenarioschritts. |
| query_fields | array | Abfragefelder - Array von HTTP-Feldern, die beim Ausführen einer Anfrage zur URL hinzugefügt werden. |
HTTP-Feld
Das HTTP-Feldobjekt definiert den Namen und den Wert, die verwendet werden, um die Webszenario-Variablen, HTTP-Header sowie POST-Felder oder Abfragefelder anzugeben. Es hat die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| name | string | Name des Headers/der Variable/des POST- oder GET-Feldes. Eigenschaftsverhalten: - erforderlich |
| value | string | Wert des Headers/der Variable/des POST- oder GET-Feldes. Eigenschaftsverhalten: - erforderlich |
Web-Szenario-Tag
Das Objekt für den Web-Szenario-Tag hat die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| tag | string | Name des Web-Szenario-Tags. Property behavior: - required |
| value | string | Wert des Web-Szenario-Tags. |