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

Szenarioschritt

Das Objekt „Szenarioschritt“ definiert eine bestimmte Prüfung eines Webszenarios. Es hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
name string Name des Szenarioschritts.

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 Gibt an, ob HTTP-Weiterleitungen gefolgt werden soll.

Mögliche Werte:
0 - Weiterleitungen nicht folgen;
1 - (Standard) Weiterleitungen folgen.
headers array HTTP-Header, die beim Ausführen einer Anfrage gesendet werden. 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 erforderlicher HTTP-Statuscodes, durch Kommas getrennt.
timeout string Zeitüberschreitung der Anfrage in Sekunden. Akzeptiert Sekunden, eine Zeiteinheit mit Suffix 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

Tag des Webszenarios

Das Tag-Objekt des Webszenarios hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
tag string Name des Webszenario-Tags.

Property behavior:
- required
value string Wert des Webszenario-Tags.

Property behavior:
- read-only.
object integer Typ des Objekts, von dem das Tag geerbt wurde.

Mögliche Werte:
0 - Vorlage;
1 - Host.

Property behavior:
- read-only.
objectid ID ID des Objekts, von dem das Tag geerbt wurde.

Property behavior:
- read-only.