Table of Contents
Scriptオブジェクト
次のオブジェクトは、scriptAPIに直接関連しています。
スクリプト
スクリプトオブジェクトは以下のプロパティを持ちます。
| プロパティ | タイプ | 説明 |
|---|---|---|
| scriptid | ID | スクリプトのID。 プロパティの動作: - 読み取り専用 - 更新操作時に必須 |
| name | string | スクリプトの名前。 プロパティの動作: - 作成操作時に必須 |
| type | integer | スクリプトタイプ。scopeが「アクション操作」に設定されている場合の値:0 - スクリプト; 1 - IPMI; 2 - SSH; 3 - TELNET; 5 - Webhook。 scopeが「手動ホストアクション」または「手動イベントアクション」に設定されている場合の値:6 - URL。 プロパティの動作: - 作成操作時に必須 |
| command | string | 実行するコマンド。 プロパティの動作: - typeが「スクリプト」「IPMI」「SSH」「TELNET」「Webhook」のいずれかに設定されている場合に必須 |
| scope | integer | スクリプトのスコープ。 値: 1 - アクション操作; 2 - 手動ホストアクション; 4 - 手動イベントアクション。 プロパティの動作: - 作成操作時に必須 |
| execute_on | integer | スクリプトを実行する場所。 値: 0 - Zabbixエージェントで実行; 1 - Zabbixサーバーで実行。グローバルスクリプトの実行がZabbixサーバーで有効な場合のみサポート; 2 - (デフォルト) Zabbixサーバーまたはプロキシで実行。 プロパティの動作: - typeが「スクリプト」に設定されている場合にサポート |
| menu_path | string | スラッシュで区切られたフォルダ。ホストまたはイベントをクリックした際にフロントエンドでメニューのようなナビゲーションを形成します。 プロパティの動作: - scopeが「手動ホストアクション」または「手動イベントアクション」に設定されている場合にサポート |
| authtype | integer | SSHスクリプトタイプで使用される認証方式。 値: 0 - パスワード; 1 - 公開鍵。 プロパティの動作: - typeが「SSH」に設定されている場合にサポート |
| username | string | 認証に使用されるユーザー名。 プロパティの動作: - typeが「SSH」または「TELNET」に設定されている場合に必須 |
| password | string | パスワード認証のSSHスクリプトおよびTELNETスクリプトで使用されるパスワード。 プロパティの動作: - typeが「SSH」かつauthtypeが「パスワード」、またはtypeが「TELNET」に設定されている場合にサポート |
| publickey | string | 公開鍵認証のSSHスクリプトで使用される公開鍵ファイル名。 プロパティの動作: - typeが「SSH」かつauthtypeが「公開鍵」に設定されている場合に必須 |
| privatekey | string | 公開鍵認証のSSHスクリプトで使用される秘密鍵ファイル名。 プロパティの動作: - typeが「SSH」かつauthtypeが「公開鍵」に設定されている場合に必須 |
| port | string | SSHおよびTELNETスクリプトで使用されるポート番号。 プロパティの動作: - typeが「SSH」または「TELNET」に設定されている場合にサポート |
| groupid | ID | スクリプトを実行できるホストグループのID。 「0」に設定すると、すべてのホストグループでスクリプトが利用可能になります。 デフォルト: 0。 |
| usrgrpid | ID | スクリプトの実行を許可するユーザーグループのID。 「0」に設定すると、すべてのユーザーグループでスクリプトが利用可能になります。 デフォルト: 0。 プロパティの動作: - scopeが「手動ホストアクション」または「手動イベントアクション」に設定されている場合にサポート |
| host_access | integer | スクリプトの実行に必要なホスト権限。 値: 2 - (デフォルト) 読み取り; 3 - 書き込み。 プロパティの動作: - scopeが「手動ホストアクション」または「手動イベントアクション」に設定されている場合にサポート |
| confirmation | string | 確認ポップアップのテキスト。 Zabbixフロントエンドからスクリプトを実行しようとした際にポップアップが表示されます。 プロパティの動作: - scopeが「手動ホストアクション」または「手動イベントアクション」に設定されている場合にサポート |
| 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が「手動ホストアクション」または「手動イベントアクション」に設定されている場合にサポート |
| manualinput_prompt | string | 手動入力のプロンプトテキスト。 プロパティの動作: - manualinputが「有効」に設定されている場合に必須 |
| manualinput_validator | string | ユーザー入力を検証するための文字列フィールド。正規表現またはカンマ区切りの値のセットで構成されます。 プロパティの動作: - manualinputが「有効」に設定されている場合に必須 |
| manualinput_validator_type | integer | 期待されるユーザー入力のタイプを決定します。 値: 0 - (デフォルト) 文字列。manualinput_validatorを正規表現として扱うことを示します; 1 - リスト。manualinput_validatorをカンマ区切りの入力値リストとして扱うことを示します。 プロパティの動作: - manualinputが「有効」に設定されている場合にサポート |
| manualinput_default_value | string | ユーザー入力の自動入力用のデフォルト値。 プロパティの動作: - manualinput_validator_typeが「文字列」に設定されている場合にサポート |
Webhookパラメータ
Webhookスクリプトが呼び出されたときに渡されるパラメータは、以下のプロパティを持ちます。
デバッグ
実行されたWebhookスクリプトのデバッグ情報。debugオブジェクトは以下のプロパティを持ちます。
ログエントリ
ログエントリオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| level | integer | ログレベル |
| ms | string | ログエントリが追加されるまでにスクリプト実行後経過したミリ秒数 |
| message | string | ログメッセージ |