> Scriptオブジェクト

次のオブジェクトは、scriptAPIに直接関連しています。

Script

script オブジェクトには次のプロパティがあります。

プロパティ タイプ 説明
scriptid string (読取専用) スクリプトのID
name
(必須)		 string スクリプト名
type
(必須)		 integer スクリプトタイプ

使用可能な値：
0 - Script
1 - IPMI
2 - SSH
3 - Telnet
5 - (デフォルト) Webhook
command
(必須)		 string 実行コマンド
scope integer スクリプトのスコープ

使用可能な値：
1 - デフォルト アクション操作
2 - 手動ホストアクション
4 - 手動イベントアクション
execute_on integer スクリプトの実行場所
typeが0(スクリプト)の場合に使用されます

使用可能な値：
0 - Zabbixエージェントで実行
1 - Zabbixサーバーで実行
2 - (デフォルト) Zabbixサーバー(プロキシ)で実行
menu_path string ホストまたはイベントをクリックしたときにフロントエンドのナビゲーションのようなメニューを形成する基となる、スラッシュで区切られたフォルダー
scopeが2または4の場合に使用されます
authtype integer SSHスクリプトタイプに使用される認証方法
typeが2の場合に使用されます

使用可能な値：
0 - パスワード
1 - 公開鍵
username string 認証に使用されるユーザー名
typeが2または3の場合に必要です
password string パスワード認証付きのSSHスクリプトとTelnetスクリプトに使用されるパスワード
typeが2でauthtypeが0またはtypeが3の場合に使用されます
publickey string 公開鍵認証を使用するSSHスクリプトに使用される公開鍵ファイルの名前
typeが2でauthtypeが1の場合に必要
privatekey string 公開鍵認証を使用するSSHスクリプトに使用される秘密鍵ファイルの名前
typeが2でauthtypeが1の場合に必要
port string SSHおよびTelnetスクリプトに使用されるポート番号
タイプが2または3の場合に必要
groupid string スクリプトを実行できるホストグループのID。 0に設定するとスクリプトはすべてのホストグループで使用できます。

デフォルト：0
usrgrpid string スクリプトの実行を許可されるユーザーグループのID。 0に設定するとスクリプトはすべてのユーザーグループで使用できます。
scopeが2または4の場合に使用されます。

デフォルト：0
host_access integer スクリプトの実行に必要なホストの権限
scopeが2または4の場合に使用されます

使用可能な値：
2 - (デフォルト)読み取り
3 - 書き込み
confirmation string 確認ポップアップテキスト。 Zabbixフロントエンドからスクリプトを実行しようとすると、ポップアップが表示されます。
scopeが2または4の場合に使用されます
timeout string Webhookスクリプトの実行タイムアウト(秒単位)。 時間の接尾辞がサポートされています。 30s,1m
typeが5の場合は必須

使用可能な値：
1 - 60s

デフォルト値：
30s
parameters array [webhook入力パラメーター](/manual/api/reference/script/object#Webhook parameters)の配列
typeが5の場合に使用されます
description string スクリプトの説明

Webhook parameters

Webhookスクリプトが呼び出されたときに渡されるパラメーターには、次のプロパティがあります。

プロパティ タイプ 説明
name
(必須)		 string パラメータ名
value string パラメータ値。 マクロをサポート

デバッグ

実行されたwebhookスクリプトのデバッグ情報。 デバッグオブジェクトには次のプロパティがあります。

プロパティ タイプ 説明
logs array [ログエントリ](/manual/api/reference/script/object#Log entry)の配列
ms string スクリプトの実行時間(ミリ秒単位)

Log entry

log entryオブジェクトには次のプロパティがあります。

プロパティ タイプ 説明
level integer ログレベル
ms string スクリプトが実行されてからログエントリが追加されるまでの経過時間(ミリ秒単位)
message string ログメッセージ