このページで
Scriptオブジェクト
次のオブジェクトは、scriptAPIに直接関連しています。
スクリプト
スクリプトオブジェクトには以下のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| scriptid | ID | スクリプトのID。 Property behavior: - read-only - 更新操作では required |
| name | string | スクリプトの名前。 Property behavior: - 作成操作では required |
| type | integer | スクリプトのタイプ。scope が "action operation" に設定されている場合の使用可能な値:0 - スクリプト; 1 - IPMI; 2 - SSH; 3 - TELNET; 5 - Webhook。 scope が "manual host action" または "manual event action" に設定されている場合の使用可能な値:6 - URL。 Property behavior: - 作成操作では required |
| command | string | 実行するコマンド。 Property behavior: - type が "Script"、"IPMI"、"SSH"、"TELNET"、または "Webhook" に設定されている場合は required |
| scope | integer | スクリプトのスコープ。 使用可能な値: 1 - action operation; 2 - manual host action; 4 - manual event action。 Property behavior: - 作成操作では required |
| execute_on | integer | スクリプトの実行場所。 使用可能な値: 0 - Zabbixエージェント上で実行; 1 - Zabbixサーバー上で実行。Zabbixサーバーでグローバルスクリプトの実行が有効な場合にのみ supported; 2 - (default) Zabbixサーバーまたはプロキシ上で実行。 Property behavior: - type が "Script" に設定されている場合は supported |
| menu_path | string | スラッシュで区切られたフォルダで、ホストまたはイベントをクリックした際にWebインターフェースでメニュー形式のナビゲーションを構成します。 Property behavior: - scope が "manual host action" または "manual event action" に設定されている場合は supported |
| authtype | integer | SSHスクリプトタイプで使用される認証方式。 使用可能な値: 0 - パスワード; 1 - 公開鍵。 Property behavior: - type が "SSH" に設定されている場合は supported |
| username | string | 認証に使用されるユーザー名。 Property behavior: - type が "SSH" または "TELNET" に設定されている場合は required |
| password | string | パスワード認証を使用するSSHスクリプトおよびTELNETスクリプトで使用されるパスワード。 Property behavior: - type が "SSH" かつ authtype が "password" に設定されている場合、または type が "TELNET" に設定されている場合は supported |
| publickey | string | 公開鍵認証を使用するSSHスクリプトで使用される公開鍵ファイル名。 Property behavior: - type が "SSH" かつ authtype が "public key" に設定されている場合は required |
| privatekey | string | 公開鍵認証を使用するSSHスクリプトで使用される秘密鍵ファイル名。 Property behavior: - type が "SSH" かつ authtype が "public key" に設定されている場合は required |
| port | string | SSHおよびTELNETスクリプトで使用されるポート番号。 Property behavior: - type が "SSH" または "TELNET" に設定されている場合は supported |
| groupid | ID | スクリプトを実行できるホストグループのID。 "0" に設定すると、スクリプトはすべてのホストグループで利用可能になります。 デフォルト: 0。 |
| usrgrpid | ID | スクリプトの実行を許可されるユーザーグループのID。 "0" に設定すると、スクリプトはすべてのユーザーグループで利用可能になります。 デフォルト: 0。 Property behavior: - scope が "manual host action" または "manual event action" に設定されている場合は supported |
| host_access | integer | スクリプトの実行に必要なホスト権限。 使用可能な値: 2 - (default) 読み取り; 3 - 書き込み。 Property behavior: - scope が "manual host action" または "manual event action" に設定されている場合は supported |
| confirmation | string | 確認ポップアップのテキスト。 Zabbix Webインターフェースからスクリプトを実行しようとすると、このポップアップが表示されます。 Property behavior: - scope が "manual host action" または "manual event action" に設定されている場合は supported |
| timeout | string | webhookスクリプトの実行タイムアウト（秒）。時間のサフィックスを使用できます（例: 30s、1m）。 使用可能な値: 1-60s。 デフォルト: 30s。 Property behavior: - type が "Webhook" に設定されている場合は required |
| parameters | array | webhook入力パラメータの配列。 Property behavior: - type が "Webhook" に設定されている場合は supported |
| description | string | スクリプトの説明。 |
| url | string | ユーザー定義URL。 Property behavior: - type が "URL" に設定されている場合は required |
| new_window | integer | URLを新しいウィンドウで開きます。 使用可能な値: 0 - いいえ; 1 - (default) はい。 Property behavior: - type が "URL" に設定されている場合は supported |
| manualinput | integer | スクリプトがユーザー指定の入力を受け付けるかどうかを示します。 使用可能な値: 0 - (default) 無効; 1 - 有効; Property behavior: - scope が "manual host action" または "manual event action" に設定されている場合は supported |
| manualinput_prompt | string | 手動入力のプロンプトテキスト。 Property behavior: - manualinput が "Enabled" に設定されている場合は required |
| manualinput_validator | string | ユーザーが指定した入力を検証するために使用される文字列フィールド。この文字列は、正規表現またはカンマ区切りの値セットのいずれかで構成されます。 Property behavior: - manualinput が "Enabled" に設定されている場合は required |
| manualinput_validator_type | integer | 想定されるユーザー入力のタイプを決定します。 使用可能な値: 0 - (default) 文字列。manualinput_validator を正規表現として扱うことを示します; 1 - リスト。manualinput_validator を入力可能な値のカンマ区切りリストとして扱うことを示します。 Property behavior: - manualinput が "Enabled" に設定されている場合は supported |
| manualinput_default_value | string | ユーザー入力を自動入力するためのデフォルト値。 Property behavior: - manualinput_validator_type が "String" に設定されている場合は supported |
webhookパラメータ
webhookスクリプトが呼び出されたときに渡されるパラメータには、以下の プロパティがあります。
デバッグ
実行されたwebhookスクリプトのデバッグ情報です。debugオブジェクトには、 以下のプロパティがあります。
ログエントリ
ログエントリオブジェクトには、以下のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| level | integer | ログレベル。 |
| ms | string | スクリプトの実行開始からログエントリが追加されるまでに経過した時間（ミリ秒）。 |
| message | string | ログメッセージ。 |