Zabbix エージェント上で実行されるリモートコマンドの場合:
- 許可する各コマンドについて、エージェント設定に AllowKey=system.run[<command>,*] パラメータを追加します。* は wait モードおよび nowait モードを表します。
Zabbix プロキシ上で実行されるリモートコマンドの場合:
- 警告: リモートコマンドが Zabbix プロキシによって監視されている Zabbix エージェント上で実行される場合、Zabbix プロキシでリモートコマンドを有効にする必要はありません。ただし、Zabbix プロキシ上でリモートコマンドを実行する必要がある場合は、プロキシ設定で EnableRemoteCommands パラメータを '1' に設定してください。

Zabbix サーバーでのグローバルスクリプト実行は、サーバー設定で EnableGlobalScripts=0 を設定することで無効にできます。
新規インストールでは、Zabbix 7.0 以降、Zabbix サーバーでのグローバルスクリプト実行はデフォルトで無効です。

既存のスクリプトの一覧とその詳細が表示されます。

表示されるデータ:

Column	Description
Name	スクリプト名。スクリプト名をクリックすると、スクリプトの設定フォームが開きます。
Scope	スクリプトのスコープ - アクションの実行内容、手動ホストアクション、または手動イベントアクション。この設定により、スクリプトを利用できる場所が決まります。
Used in actions	スクリプトが使用されているすべてのアクションが表示されます。（Zabbix 7.0.4 以降では）その前に該当アクションの総数も表示されます。アクション名をクリックすると、アクション設定フォームが開きます。ユーザーにそのアクションへの権限がない場合、名前はクリックできません。
Type	スクリプトタイプが表示されます - URL、Webhook、Script、SSH、Telnet、または IPMI コマンド。
Execute on	スクリプトが Zabbix エージェント、Zabbix プロキシ、サーバー、または Zabbix サーバーのみのどこで実行されるかが表示されます。
Commands	スクリプト内で実行されるすべてのコマンドが表示されます。 webhook の場合、ここには何も表示されません。
User group	スクリプトを利用できるユーザーグループが表示されます（すべてのユーザーグループが対象の場合は All）。
Host group	スクリプトを利用できるホストグループが表示されます（すべてのホストグループが対象の場合は All）。
Host access	ホストグループに対する権限レベルが表示されます - Read または Write。必要な権限レベルを持つユーザーのみがスクリプトを実行できます。

新しいスクリプトを設定するには、右上隅にある Create script ボタンをクリックします。

一括編集オプション

一覧の下にあるボタンでは、次の一括編集オプションを利用できます。

Delete - スクリプトを削除します

このオプションを使用するには、対象のスクリプトの前にあるチェックボックスを選択し、Delete をクリックします。

フィルターの使用

フィルターを使用すると、関心のあるスクリプトのみを表示できます。
検索パフォーマンスを向上させるため、データはマクロを未展開のまま検索されます。

スクリプトの一覧の上に、フィルター リンクがあります。
これをクリックすると、名前とスコープでスクリプトを絞り込めるフィルターが表示されます。

グローバルスクリプトの設定

セキュリティを強化するため、グローバルスクリプトではプレーンなマクロの代わりにマクロ関数を使用することを推奨します。マクロは自動的にエスケープされないためです。

スクリプト属性:

Parameter		Description
Name		スクリプトの一意な名前。例: `Clear /tmp filesystem`
Scope		スクリプトのスコープ - アクションの実行、手動ホストアクション、または手動イベントアクション。この設定により、スクリプトをどこで使用できるかが決まります。つまり、アクション実行のリモートコマンド、ホストメニュー、またはイベントメニューです。スコープを「アクションの実行」に設定すると、Alerts > Actions にアクセスできるすべてのユーザーがこのスクリプトを利用できます。スクリプトが実際にアクションで使用されている場合、そのスコープを「アクションの実行」以外に変更することはできません。マクロのサポートスコープは利用可能なマクロの範囲に影響します。たとえば、ユーザー関連のマクロ ({USER.*}) は、スクリプトを起動したユーザーに関する情報を渡せるように、スクリプトでサポートされています。ただし、アクションの実行は自動的に実行されるため、スクリプトのスコープがアクションの実行である場合はサポートされません。 {MANUALINPUT} マクロを使用すると、スクリプト実行時に手動入力を指定できます。これは手動ホストアクションおよび手動イベントアクションのスクリプトでサポートされています。他にどのマクロがサポートされているかを確認するには、サポートされているマクロテーブルで「Trigger-based notifications and commands/Trigger-based commands」、「Manual host action scripts」、「Manual event action scripts」を検索してください。マクロがスペースを含む値（たとえばホスト名）に展開される可能性がある場合は、必要に応じて引用符で囲むことを忘れないでください。
Menu path		スクリプトのメニューパスを指定します。たとえば `Default` または `Default/` を指定すると、それぞれのディレクトリにスクリプトが表示されます。メニューはネスト可能で、たとえば `Main menu/Sub menu1/Sub menu2` のように指定できます。監視セクションのホスト/イベントメニューからスクリプトにアクセスする場合、指定したディレクトリに従って整理されます。このフィールドは、Scope として「手動ホストアクション」または「手動イベントアクション」が選択されている場合にのみ表示されます。
Type		対応するボタンをクリックしてスクリプトタイプを選択します: URL、Webhook、Script、SSH、Telnet、または IPMI コマンド。 URL タイプは、Scope として「手動ホストアクション」または「手動イベントアクション」が選択されている場合にのみ使用できます。
	スクリプトタイプ: URL
	URL	ホストメニューまたはイベントメニューからすばやくアクセスするためのURLを指定します。マクロおよびカスタムのユーザーマクロがサポートされています。マクロのサポートはスクリプトのスコープに依存します（上記の Scope を参照）。このフィールドで {MANUALINPUT} マクロを使用すると、スクリプト実行時に手動入力を指定できます。例: `http://{MANUALINPUT}/zabbix/zabbix.php?action=dashboard.view` マクロ値はURLエンコードしてはいけません。
	Open in new window	URLを新しいブラウザータブで開くか、同じタブで開くかを決定します。
	スクリプトタイプ: Webhook
	Parameters	webhook 変数を属性と値のペアとして指定します。関連項目: Webhook メディア設定。パラメータ値ではマクロおよびカスタムのユーザーマクロがサポートされています。マクロのサポートはスクリプトのスコープに依存します（上記の Scope を参照）。
	Script	パラメータフィールド内、またはその横にある鉛筆アイコンをクリックすると開くモーダルエディターに JavaScript コードを入力します。マクロのサポートはスクリプトのスコープに依存します（上記の Scope を参照）。関連項目: Webhook メディア設定、追加の JavaScript オブジェクト。
	Timeout	JavaScript の実行タイムアウト（1～60秒、デフォルトは30秒）。 30s、1m などの時間サフィックスがサポートされています。
	スクリプトタイプ: Script
	Execute on	対応するボタンをクリックして、シェルスクリプトの実行先を選択します: Zabbix agent - スクリプトはホスト上で Zabbix エージェントにより実行されます（system.run アイテムが許可されている場合） Zabbix proxy or server - スクリプトは Zabbix プロキシまたはサーバーにより実行されます。どちらで実行されるかは、そのホストがプロキシとサーバーのどちらで監視されているかによって決まります。 EnableRemoteCommands により有効化されている場合は、プロキシ上で実行されます。グローバルスクリプトがサーバーパラメータ EnableGlobalScripts により有効化されている場合は、サーバー上で実行されます。 Zabbix server - スクリプトは Zabbix サーバーのみにより実行されます。このオプションは、サーバーパラメータ EnableGlobalScripts によりグローバルスクリプトが無効化されている場合は使用できません。
	Commands	スクリプト内で実行するコマンドのフルパスを入力します。マクロのサポートはスクリプトのスコープに依存します（上記の Scope を参照）。カスタムのユーザーマクロがサポートされています。
	スクリプトタイプ: SSH
	Authentication method	認証方式を選択します - パスワードまたは公開鍵。
	Username	ユーザー名を入力します。
	Password	パスワードを入力します。このフィールドは、認証方式として「Password」が選択されている場合に使用できます。
	Public key file	公開鍵ファイルへのパスを入力します。このフィールドは、認証方式として「Public key」が選択されている場合に使用できます。
	Private key file	秘密鍵ファイルへのパスを入力します。このフィールドは、認証方式として「Public key」が選択されている場合に使用できます。
	Passphrase	パスフレーズを入力します。このフィールドは、認証方式として「Public key」が選択されている場合に使用できます。
	Port	Zabbix が接続する対象ホスト上のリモート SSH サービスのポートを入力します。
	Commands	コマンドを入力します。マクロのサポートはスクリプトのスコープに依存します（上記の Scope を参照）。カスタムのユーザーマクロがサポートされています。
	スクリプトタイプ: Telnet
	Username	ユーザー名を入力します。
	Password	パスワードを入力します。
	Port	Zabbix が接続する対象ホスト上のリモート Telnet サービスのポートを入力します。
	Commands	コマンドを入力します。マクロのサポートはスクリプトのスコープに依存します（上記の Scope を参照）。カスタムのユーザーマクロがサポートされています。
	スクリプトタイプ: IPMI
	Command	IPMI コマンドを入力します。マクロのサポートはスクリプトのスコープに依存します（上記の Scope を参照）。カスタムのユーザーマクロがサポートされています。
Description		スクリプトの説明を入力します。
Host group		スクリプトを利用可能にするホストグループを選択します（すべてのホストグループに対して利用可能にする場合は All）。
User group		スクリプトを利用可能にするユーザーグループを選択します（すべてのユーザーグループに対して利用可能にする場合は All）。このフィールドは、Scope として「手動ホストアクション」または「手動イベントアクション」が選択されている場合にのみ表示されます。
Required host permissions		ホストグループに対する権限レベルを選択します - Read または Write。必要な権限レベルを持つユーザーのみがスクリプトを実行できます。このフィールドは、Scope として「手動ホストアクション」または「手動イベントアクション」が選択されている場合にのみ表示されます。
Advanced configuration		Advanced configuration ラベルをクリックすると、高度な設定オプションが表示されます。このフィールドは、Scope として「手動ホストアクション」または「手動イベントアクション」が選択されている場合にのみ表示されます。

詳細設定

詳細設定オプションは、折りたたみ可能な詳細設定セクションで利用できます。

パラメータ	説明
ユーザー入力を有効にする	スクリプトを実行する前に、手動ユーザー入力を有効にするには、チェックボックスをオンにします。手動ユーザー入力は、スクリプト内の{MANUALINPUT}マクロ値を置き換えます。参照: 手動ユーザー入力
入力プロンプト	カスタムユーザー入力用のカスタムテキストプロンプトを入力します。このテキストは、手動入力ポップアップの入力フィールドの上に表示されます。手動入力ポップアップのプレビューを表示するには、ユーザー入力のテストをクリックします。プレビューでは、入力文字列が入力検証ルールに準拠しているかどうかもテストできます（以下のパラメータを参照）マクロとユーザーマクロのサポートは、スクリプトのスコープによって異なります（一般的なスクリプト設定パラメータのスコープを参照）
入力タイプ	手動入力タイプを選択します。文字列 - 単一の文字列。ドロップダウン - 複数のドロップダウンオプションから値を選択します。
ドロップダウンオプション	ユーザー入力ドロップダウンの一意の値を、カンマ区切りのリストで入力します。ドロップダウンに空のオプションを含めるには、リストの先頭、中央、または末尾にカンマを追加します。このフィールドは、入力タイプとして 'ドロップダウン'を選択した場合にのみ表示されます。
デフォルト入力文字列	ユーザー入力のデフォルト文字列を入力します（または入力しないこともできます）。このフィールドは、入力検証ルールフィールドで指定された正規表現に基づいて検証されます。ここで入力された値は、手動入力ポップアップにデフォルトで表示されます。このフィールドは、入力タイプとして'文字列'を選択した場合にのみ表示されます。
入力検証ルール	ユーザー入力文字列を検証するための正規表現を入力します。グローバル正規表現がサポートされています。このフィールドは、入力タイプとして'文字列'を選択した場合にのみ表示されます。
確認を有効にする	スクリプトを実行する前に確認メッセージを表示するには、チェックボックスをオンにします。この機能は、潜在的に危険な操作（再起動スクリプトなど）や、時間のかかる操作で特に役立ちます。
確認テキスト	上記のチェックボックスで有効にした確認ポップアップのカスタム確認テキストを入力します（例：リモートシステムが再起動されます。よろしいですか？）テキストの表示を確認するには、フィールドの横にある確認テストをクリックしてください。マクロとカスタムユーザーマクロがサポートされています。注: 確認メッセージのテストでは、マクロは展開されません。

手動ユーザー入力と確認メッセージの両方が設定されている場合、それらは連続してポップアップウィンドウに表示されます。

手動ユーザー入力

手動ユーザー入力を使用すると、スクリプトの実行ごとにカスタムパラメータを指定できます。
これにより、1つのパラメータだけが異なる複数の類似したユーザースクリプトを作成する必要がなくなります。

たとえば、実行時に異なる整数値や異なるURLアドレスをスクリプトに渡したい場合があります。

手動ユーザー入力を有効にするには、次のいずれかを行います。

必要な箇所で、スクリプト（コマンド、スクリプト、スクリプトパラメータ）内、またはURLスクリプトのURLフィールドで {MANUALINPUT} マクロを使用します。
高度なスクリプト設定で、手動ユーザー入力を有効にし、入力オプションを設定します。

ユーザー入力を有効にすると、スクリプトの実行前に、ユーザーにカスタム値の入力を求める 手動入力 ポップアップが表示されます。
入力された値は、スクリプト内の {MANUALINPUT} を置き換えます。

設定に応じて、ユーザーは文字列値の入力を求められます。

または、あらかじめ定義されたオプションのドロップダウンから値を選択します。

手動ユーザー入力は、スコープが「手動ホストアクション」または「手動イベントアクション」であるスクリプトでのみ使用できます。

スクリプトの実行と結果

Zabbixサーバーによって実行されるスクリプトは、コマンド実行のページで説明されている順序で実行されます。

スクリプトの結果は、スクリプト実行後に表示されるポップアップウィンドウに表示されます。スクリプトの戻り値は標準出力です。

スクリプトが正常に終了した場合（終了コード 0）、戻り値は16MBに制限されます（切り捨てられる末尾の空白文字を含む）。
スクリプトがエラーで終了した場合（終了コードが0以外）、戻り値は標準エラーとなり、2KBに制限されます。

Zabbixは、デフォルトでは拡張されたスクリプト出力を保存しません。出力の完全な詳細を保持するには、スクリプト自体にロギングを実装できます（例: 出力をローカルのログファイルにリダイレクトする）。

ZabbixサーバーまたはZabbixプロキシ上で実行されるスクリプトには、データベースの制限も適用されることに注意してください。

以下は、スクリプトの例と結果ウィンドウです。

uname -v
/tmp/non_existing_script.sh
echo "This script was started by {USER.USERNAME}"

スクリプトの結果には、スクリプト自体は表示されません。

Zabbixエージェント

スクリプトの実行中にタイムアウトが発生する場合があります。

以下は、Zabbixエージェント上で実行されるスクリプトと、その結果ウィンドウの例です。

sleep 5
df -h

この場合のエラーメッセージは次のとおりです。

Timeout while executing a shell script.

このような状況を避けるには、Zabbixエージェント設定および Zabbixサーバー設定の Timeout パラメータを調整するのではなく、スクリプト自体（上記の例では「5」）を最適化することを推奨します。
ただし、アクティブモードのZabbixエージェントでは、Zabbixサーバー設定の Timeout パラメータを、Zabbixエージェント設定の RefreshActiveChecks パラメータより少なくとも数秒長く設定する必要があります。
これにより、サーバーはエージェントからアクティブチェックの結果を受信するための十分な時間を確保できます。
なお、アクティブなエージェントでのスクリプト実行は、Zabbixエージェント 7.0 以降でサポートされています。

Zabbixエージェント設定で Timeout パラメータが変更されている場合、次のエラーメッセージが表示されます。

Get value from agent failed: ZBX_TCP_READ() timed out.

これは、Zabbixエージェント設定では変更が行われているものの、Zabbixサーバー設定の Timeout パラメータもあわせて変更する必要があることを意味します。

Script timeout on active agents

It is possible to execute scripts on agents operating in active mode only (since Zabbix 7.0). Once the script execution is triggered by action operation or manual script execution, the command is included in active check configuration and executed once the active agent receives it.

These scripts are sent to the active agent along with the server/proxy timeout for script execution. Please increase the default server/proxy timeout for script execution. The timeout must be higher than the active check refresh frequency, otherwise the timeout is exceeded before the active agent receives the script and is able to return the result.

Zabbix サーバー/プロキシ

Zabbix サーバー上で実行されるスクリプトの例と、その結果ウィンドウを以下に示します。

sleep 11
df -h

また、Zabbix サーバー設定を変更して TrapperTimeout パラメータを対応する値（この場合は 11 より大きい値）に調整するのではなく、スクリプト自体を最適化することも推奨されます。

What’s next?

8 ユーザー

Docs

3 スクリプト

概要