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