Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

> Web scenario object

次のオブジェクトは、webcheckAPIに直接関連しています。

Web scenario

Web scenarioオブジェクトには、次のプロパティがあります。

プロパティ タイプ 説明
httptestid string (読取専用)WebシナリオのID
hostid
(必須)
string Webシナリオが属するホストのID
name
(必須)
string Webシナリオ名
agent string Webシナリオで使用されるユーザーエージェント文字列

デフォルト:Zabbix
authentication integer Webシナリオで使用される認証方法

利用可能な値:
0 - (デフォルト)なし
1 - basic HTTP認証
2 - NTLM認証
delay string Webシナリオの実行間隔。 秒、接尾辞付きの時間単位、およびユーザーマクロを受け入れます。

デフォルト:1m
headers array of HTTP fields リクエストの実行時に送信されるHTTPヘッダー
http_password string basic HTTP認証またはNTLM認証に使用されるパスワード。
http_proxy string 次のように指定されたWebシナリオで使用されるプロキシ:http://[username[:password]@]proxy.example.com[:port]
http_user string basic HTTP認証またはNTLM認証に使用されるユーザー名
nextcheck timestamp (読取専用) 次のWebシナリオの実行時間
retries integer Webシナリオが失敗する前に各ステップの実行を試行する回数

デフォルト:1
ssl_cert_file string クライアント認証に使用されるSSL証明書ファイルの名前(PEM形式である必要があります)
ssl_key_file string クライアント認証に使用されるSSL秘密鍵ファイルの名前(PEM形式である必要があります)
ssl_key_password string SSL秘密鍵のパスワード
status integer Webシナリオが有効かどうか

利用可能な値:
0 - (デフォルト)有効
1 - 無効
templateid string (読取専用)親テンプレートWebシナリオのID
variables array of HTTP fields Webシナリオ変数
verify_host integer SSL証明書で指定されたホスト名がシナリオで使用されているものと一致することを確認するかどうか

利用可能な値は次のとおり
0 - (デフォルト)ホストの検証をスキップ
1 - ホストを確認する
verify_peer integer WebサーバーのSSL証明書を検証するかどうか

利用可能な値は次のとおり
0 - (デフォルト)ピア検証をスキップ
1 - ピア検証を実施
uuid string (既存のWebシナリオの場合は読み取り専用)
インポートされたWebシナリオを既存のシナリオにリンクするために使用されるグローバル一意識別子。 テンプレートのWebシナリオにのみ使用されます。

Web scenarioのタグ

Web scenarioタグオブジェクトには、次のプロパティがあります。

プロパティ タイプ 説明
tag
(必須)
string Webシナリオタグ名
value string Webシナリオのタグ値

Scenario step

Scenario stepオブジェクトは、特定のWebシナリオチェックを定義します。 以下の特性があります。

プロパティ タイプ 説明
httpstepid string (読取専用)シナリオステップのID
name
(必須)
string シナリオステップ名
no
(必須)
integer Webシナリオステップのシーケンス番号
url
(必須)
string チェックするURL
follow_redirects integer HTTPリダイレクトするか

利用可能な値は次のとおり
0 - リダイレクトしない
1 - (デフォルト)リダイレクトする
headers array of HTTP fields リクエストの実行時に送信されるHTTPヘッダー。 シナリオステップヘッダーは、Webシナリオに指定されたヘッダーを上書きします
httptestid string (読取専用)ステップが属するWebシナリオのID
posts string
array of HTTP fields
文字列(生のPOSTデータ)またはHTTPフィールド (form field data)の配列としてのHTTPPOST変数
required string 応答に存在する必要のあるテキスト
retrieve_mode integer シナリオステップで取得する必要のあるHTTP応答の一部

利用可能な値は次のとおり
0 - (デフォルト)本文のみ
1 - ヘッダーのみ
2 - ヘッダーと本文
status_codes string コンマで区切られた必要なHTTPステータスコードの範囲
timeout string 秒単位のリクエストタイムアウト。 秒、接尾辞付きの時間単位、およびユーザーマクロを受け入れます。

デフォルト:15s 最大:1h 最小:1s
variables array of HTTP fields シナリオステップ変数
query_fields array of HTTP fields クエリフィールド - リクエストの実行時にURLに追加されるHTTPフィールドの配列

HTTP field

HTTP fieldオブジェクトは、クエリフィールドデータの変数、HTTPヘッダー、POSTフォームフィールドデータを指定するために使用される名前と値を定義します。

プロパティ タイプ 説明
name
(必須)
string ヘッダー/変数/POSTまたはGETフィールドの名前
value
(必須)
string ヘッダー/変数/POSTまたはGETフィールドの値