このページで
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～60秒。 デフォルト: 30秒。 プロパティの動作: - 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 | ログメッセージ。 |