Web-Szenario-Objekt
Die folgenden Objekte stehen in direktem Zusammenhang mit der webcheck API.
Webszenario
Das Webszenario-Objekt hat die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| httptestid | ID | ID des Webszenarios. Eigenschaftsverhalten: - schreibgeschützt - erforderlich für Aktualisierungsvorgänge |
| hostid | ID | ID des Hosts, zu dem das Webszenario gehört. Eigenschaftsverhalten: - konstant - erforderlich für Erstellungsvorgänge |
| name | string | Name des Webszenarios. Eigenschaftsverhalten: - 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 Sekunden oder eine Zeiteinheit mit Suffix (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, das für die einfache HTTP-, NTLM-, Kerberos- oder Digest-Authentifizierung verwendet wird. |
| http_proxy | string | Proxy, der vom Webszenario verwendet wird, angegeben als http://\[username\[:password\]@\]proxy.example.com\[:port]. |
| http_user | string | Benutzername, der für die einfache HTTP-, NTLM-, Kerberos- oder Digest-Authentifizierung verwendet wird. |
| retries | integer | Anzahl der Versuche, mit denen ein Webszenario jeden Schritt ausführt, bevor es fehlschlägt. Standard: 1. |
| ssl_cert_file | string | Name der SSL-Zertifikatsdatei, die für die Client-Authentifizierung verwendet wird (muss im PEM-Format vorliegen). |
| ssl_key_file | string | Name der SSL-Datei mit dem privaten Schlüssel, die für die Client-Authentifizierung 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 Webszenarios der übergeordneten Vorlage. Eigenschaftsverhalten: - 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 ü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 zu verknüpfen. Wird automatisch erzeugt, wenn sie nicht angegeben wird. Eigenschaftsverhalten: - unterstützt, wenn das Webszenario zu einer Vorlage gehört |
Scenario-Schritt
Das Objekt des Scenario-Schritts definiert eine bestimmte Webszenario-Prüfung. Es hat die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| name | string | Name des Scenario-Schritts. Property behavior: - required |
| no | integer | Sequenznummer des Schritts in einem Webszenario. Property behavior: - required |
| url | string | Zu prüfende URL. Property behavior: - required |
| follow_redirects | integer | Ob HTTP-Weiterleitungen gefolgt werden soll. Possible values: 0 - don't follow redirects; 1 - (default) follow redirects. |
| headers | array | HTTP-Header, die beim Ausführen einer Anfrage gesendet werden. Header des Scenario-Schritts überschreiben die für das Webszenario angegebenen Header. |
| posts | string/array | HTTP-POST-Variablen als Zeichenfolge (Raw-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 Scenario-Schritt abrufen muss. Possible values: 0 - (default) nur Body; 1 - nur Header; 2 - Header und Body. |
| status_codes | string | Bereiche der erforderlichen HTTP-Statuscodes, durch Kommas getrennt. |
| timeout | string | Zeitüberschreitung der Anfrage in Sekunden. Akzeptiert Sekunden, Zeiteinheiten mit Suffix oder ein Benutzer-Makro. Default: 15s. Maximum: 1h. Minimum: 1s. |
| variables | array | Variablen des Scenario-Schritts. |
| query_fields | array | Abfragefelder - Array von HTTP-Feldern, die der URL beim Ausführen einer Anfrage 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. |