外部 API

Pandora FMS ドキュメント一覧に戻る

バージョン NG 776 からは、PFMS API 2.0 がデフォルトでインストールされます。PFMS サーバのオペレーティングシステムとして Ubuntu を使用し、バージョン 777 にアップグレードする場合は、root ユーザまたは同等のユーザで以下を実行およびインストールする必要があります。

a2enmod rewrite
service apache2 restart

PFMS をインストールする際の Apache Web サーバのデフォルト設定 が正しく設定されていることを確認する必要があります。

デフォルトでは、Pandora FMS をインストールすると、許可された IP アドレスのリストはローカル呼び出しのみに制限されます (localhost、127.0.0.1)。PFMS API 2.0 で動作する IP アドレスは、一般的な Web コンソール設定 に追加する必要があります。

各ユーザの認証トークンは、Web コンソールのメニュー 管理(Management) → プロファイル(Profile) → トークン管理(Token management) → トークンの作成(Create token) から生成する必要があります。ここで、このトークンを使用するユーザ、説明、有効期限 (推奨) を選択します。作成(Create) ボタンをクリックすると、トークンの値が 1 回だけ表示されるので、それをコピーして安全な場所に保存する必要があります。

Web コンソールでトークンを生成したら、Web ブラウザのアドレスバーで次のリンクを使用します。

https://< IP address or FQDN >/pandora_console/api/

認証(Authorize) ボタンをクリックし、ポップアップウィンドウに 以前に生成した トークンを入力します。

トークンが設定されると、南京錠アイコンが変わり、API リクエストを開始できるようになります。このようなリクエストは次のように分類されます。

• POST: 新しい要素を作成します。
• GET: 登録された要素を視覚化します。
• PUT: 登録された要素を編集します。
• DELETE: 登録された要素を削除します。

次に、アクションの論理的なグループ化が提供されます。

• 認証(Authentication): API アクセス トークンを管理します (最初のトークンは常に Web コンソール経由で 生成します)。
• イベント(Events): Pandora FMS イベントを管理します。
• グループ(Groups): PFMS エージェントのグループ を管理します。
• プロファイル(Profiles): PFMS ユーザプロファイル を管理します。
• タグ(Tags): PFMS タグシステム を管理します。
• ユーザ(Users): PFMS ユーザを管理します。
• PandoraITSM: Pandora ITSM によって PFMS に提供される インベントリ を管理します。

この目的には、現在のほとんどのオペレーティングシステムに存在する curl を使用することをお勧めします。

curl -X '< action >' \
  'http://< IP address or FQDN >/pandora_console/api/v2/< command >/< parameter >' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer < your token >'
  -d '< JSON parameters >'

補足:

• < action > 行われるアクション:

• POST: 新しい要素を作成します。
• GET: 登録された要素を表示します。
• PUT: 登録された要素を編集します。
• DELETE: 登録された要素を削除します。

• < command > API コマンド自体 (ping など など)。
• < parameter > それぞれのケースに応じた一意の識別子またはページングパラメータ。
• < your token > 各ユーザに対して生成されるトークン。
• < JSON parameters > 残りのパラメータは必要に応じて指定します。

https://< IP address or FQDN >/pandora_console/api/v2/swagger.json

上記のリンクにアクセスすると、ドキュメントのすべての機能が自動的に取得され、JSON 互換のソフトウェアを使用してドキュメントを生成できるようになります。

さらに、Web インターフェース では、各コマンドに特定のスキーマへのリンクがあります。

PFMS API で接続と認証を確認する最も簡単な方法は、ping コマンドを使用することです。

curl -m 3 -X 'GET' \
  'http://192.168.7.117/pandora_console/api/v2/ping' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer < your token >' && echo 

Web インターフェース で、認証 (認証の API エンドポイント) セクションにアクセスし、試す(Try out) ボタンをクリックし (ロックアイコンが開いている場合は、生成されたユーザトークン をクリックして入力します)、実行(Execute) ボタンをクリックします。応答本文(Response body) にコード { “valid”: true } が表示されていれば、接続は成功です。

Pandora FMS 外部 API は、(/include/api.php に対して HTTP アクセスすることにより) リモート操作に利用します。 これは、Pandora FMS 外から操作するアプリケーションを作成できるように、Pandora FMS に用意されている手法です。基本的に、アプリケーションからの操作で、指定したフォーマットのパラメータで値を受け渡します。

API.php の呼び出しは、次のように単純です。

http://<Pandora FMS コンソールのインストールパス>/include/api.php<パラメータ>

API は次のパラメータのみ受け取ることができます。

• op (必須): 最初のパラメータで、操作の種類を指定します。“get”、“set”、“help” のいずれかを指定できます。
  • get: 値を取得します。
  • set: 値を設定します。
  • help: 小さなヘルプを返します。
• op2 (必須): 処理の名前を指定します。
• id (コマンドによる): 1番目のパラメータです。
• id2 (コマンドによる): 2番目のパラメータです。
• other (コマンドによる): 3番目のパラメータです。連続したデータリストの場合もあります。
• other_mode (オプション): 連続データのフォーマットです。指定可能な値は次の通りです。
  • url_encode: 文字列フォーマットです。UrlEncode
  • url_encode_separator_<セパレータ»複数の値を分割する文字を指定します。例えば、次の通りです。

...other=pears|melons|watermelon&other_mode=url_encode_separator_|

• returnType (コマンドによる): 値の取得フォーマットです。設定可能な値は次の通りです。
  • string: 英数字として値を返します。
  • csv: デフォルトで ; および改行で区切られた CSV で値を返します。
  • csv_head: csv と同様ですが、最初にフィールド名を返します。
• Security credentials: セキュリティ の章を参照してください。

API は、API ソース および/または パスワード および/または ユーザ認証情報 を介してアクセスを認証します。

現時点では、セキュリティはアクセスする IP アドレスリストに基づいています。

テキストボックスに * を入力すると、IP アドレスによる ACL チェックは省略され、セキュリティはプロトコルと環境に委ねられます。

API アクセスのパスワードも設定することができます。(API パスワード(API password))

• apipass: デフォルトかつこのドキュメントでは、1234 が使われています。

ユーザ名とパスワードによるものです。さらに、バージョン 768 以降からは、Bearer トークンによる認証が可能です。

API へアクセスするには、Pandora FMS の正しいユーザ名とパスワードを与える必要があります。

• user: 正しい Pandora FMS のユーザで、このドキュメントでは admin を使っています。
• pass: ユーザのパスワードで、このドキュメントでは pandora を使っています。

API へのアクセスができなかった場合は、単純に “auth error” という文字が出力されます。

このドキュメントでは、API パスワードが 1234 で、アクセスユーザが admin、そのパスワードが pandora とします。

呼び出し書式:

.../include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

• ソース IP アドレスが ACL の IP アドレス一覧に存在する(または * が設定されている)
• API パスワードが 設定されていない または 1234
• ユーザ admin が存在し、そのパスワードが pandora

管理メニューの 管理ツール(Admin tools) → API チェッカー(API checker) からアクセスします。

次の 3つの要素で実装されています。

• IPフィルタリング: リストに設定された IP から API への接続ができます。
• グローバル API パスワード: 定義されている場合は、API を利用する場合に必要です。
• コンソールのユーザとパスワード: スーパー管理者 ユーザおよび必要な権限があるユーザ。リクエストされた操作ごとにユーザの権限が確認されます。バージョン NG 768 以降では、Bearer トークンでのアクセスもできます。

以下に処理の流れを示します。

Pandora FMS に対して読み出しか書き込みかによって、2つの種類に分けられます。

例外があります: 情報取得 呼出

bearer トークンに基づく認証により、Pandora FMS に登録された各ユーザは、1 対 1 の対応で独自の識別子を生成できます。この bearer トークンは、HTTP ヘッダーに挿入す る必要があります。つまり、API の URL の一部ではありません。 送信メカニズムは、Pandora FMS API にアクセスするアプリケーションにて対応します。

以下の例では、コマンドラインプログラムである cURL バージョン 7.68 を使っています。

• curl のバージョンは、curl -V で確認します。

• curl のヘルプが必要な場合は、curl -h を実行します。
• -k および -H パラメータは、それぞれ HTTPS アクセスで自己証明書でのアクセスの受け入れ、ヘッダ情報を送信するために利用します。
• API クエリを実行するユーザに対応する bearer トークンを調べます。
• API クエリを実行できるようになりました。次の例では、get test を使用しています (あらかじめ用意した自身の bearer トークンに置き換えます)。

BEARER="Authorization: Bearer 811a0c1889f3aa62ef481ccd173ea5ec"
URL="http://192.168.7.117/pandora_console/include/api.php"
API_QUERY="?op=get&op2=test"
curl -k -H "$BEARER" $URL$API_QUERY && echo ""

• 接続をデバッグする場合は、-v パラメータを利用します。(バージョンを表示する -V と混同しないでください。)

Pandora コンソールのバージョンを返します。get test と似ていますが、API 接続のチェックをしません。

これは、Pandora FMS のインストールパスの確認と、認証前にバージョンを確認するのに便利です。

返される情報はログイン画面から確認することができるものであるため、セキュリティ上の脆弱性にはなりません。

http://127.0.0.1/pandora_console/include/api.php?info=version

例えば、Pandora FMS v7.0NG.768 - PC230120 MR60 といった内容が返ります。

データを読み出します。

書式: パラメータ無し

例

以下の例では、OK を返します。

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=test

応答サンプル: OK,v7.0NG.751,PC201215

ユーザ権限のアクセスレベルに応じて、Pandora FMS のライセンス状態を返します。

書式:

• op=get (必須)
• op2=license (必須)
• return_type=json (必須)

例 ( 呼び出し書式を参照):

…/include/api.php?op=get&op2=license&return_type=json&apipass=1234&user=admin&pass=pandora

コミュニティ 版では、次のような応答を返します。

 {
  "type":"array",
  "data":{
   "license_mode":"PANDORA-FREE",
  }
 }

他のパラメータのフィルタに従って、エージェントフィルタのリストを返します。

書式:

• op=get (必須)
• op2=all_agents (必須)
• return_type=csv または return_type=json (必須)
• other=<連続パラメータ> (オプション) 検索するエージェントをフィルタするためのパラメータ列:

• < OS フィルタ >
• < グループフィルタ >
• < モジュール状態フィルタ > unknown, warning, critical, no_modules.
• < 別名フィルタ >
• < ポリシーフィルタ >
• < csv セパレータ >
• 再帰 (1 または 0)

例 (呼出書式を参照):

この例では、OS ID が 1 の全エージェントを返します。(CSV フォーマット)

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1||||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

この例では、id_group が 2 であるすべてのエージェントを返します。(JSON フォーマット)

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=|2|||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

この例では、状態が障害のすべてのエージェントを返します。(CSV フォーマット)

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=||critical||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

この例では、別名に pa が含まれるすべてのエージェントを返します。(CSV フォー アット)

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=|||pa|||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

この例では、関連付けられたポリシーが 2 で再帰ですべてのエージェントを返します。(CSV フォーマット)

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=||||2||1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

この例では、OS ID が 1、id_group が 2、状態が障害、別名に pa が含まれ、関連 付けられたポリシーが 2 のすべてのエージェントを返します。(@ 区切り文字での CSV フォーマット)

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1|2|critical|pa|2|@|0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

= 7.0NG 752

Pandora FMS ライセンスおよびユーザのアクセス権限に応じた、残りのエージェントまたはモジュール数を確認します。

書式:

• op = get (必須)
• op2= license_remaining (必須)
• return_type = json (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=license_remaining&return_type=json&apipass=1234&user=admin&pass=pandora

書式:

• op=get (必須)
• op2=module_last_value (必須)
• id=<インデックス> (必須) エージェントモジュールのインデックスである必要があ ります。
• other=<返すエラー> (オプション) (通常データベースに記録されない)エラーが発生したときに、返したいもの。
  • エラーコードは次の通りです:
    • 'error_message' テキストでエラーメッセージを返します。
    • 'error_value'<セパレータ><コードまたは値> エラーの値を返します。ただし、 other_mode=url_encode_separator_<セパレータ> のように、分割するためのセパレータを 'other_mode' で設定する必要があります。

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=63&other=error_value|0&other_mode=url_encode_separator_|
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62

書式:

• op=get (必須)
• op2=agent_module_name_last_value (必須)
• id=<英数字>(必須) エージェント名。
• id2=<英数字> (必須) モジュール名。
• other=<返すエラー> (オプション) (通常DBには記録されない)エラー時に返したいもの。
  • エラーコードは次の通りです:
    • 'error_message' テキストのエラーメッセージ。
    • 'error_value'<セパレータ><コードまたは値> このコードまたはエラーの値が返ります。ただし、 other_mode=url_encode_separator_<セパレータ> のように、 'other_mode' でセパレータを指定する必要があります。

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=miguel-portatil&id2=cpu_user

= 7.0NG

モジュールの最新の値を返します。このモジュールは、パラメータ id で渡されるエージェントの別名と、パラメータ id2 で渡されるモジュール名でフィルタされます。other パラメータで、アプリケーションが利用するエラーコードおよび、範囲を超えたモジュールの値を追加することができます。

書式:

• op=get (必須)
• op2=agent_module_name_last_value_alias (必須)
• id=<英数字>(必須) エージェント名。
• id2=<英数字> (必須) モジュール名。
• other=<返すエラー> (オプション) (通常DBには記録されない)エラー時に返したいもの。
  • エラーコードは次の通りです:
    • 'error_message' テキストのエラーメッセージ。
    • 'error_value'<セパレータ><コードまたは値> このコードまたはエラーの値が返ります。ただし、other_mode=url_encode_separator_<セパレータ> のように、 'other_mode' でセパレータを指定する必要があります。

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value_alias&id=miguel-portatil&id2=cpu_user

モジュール名を指定すると、そのモジュール名を含むエージェントのリストを返します。 結果は、セミコロン (;) で区切られた、エージェントID、エージェントの別名、要求されたモジュールの値、およびエージェント名を返します。例：

653;agente network;0.00000;a8c83b348451040dc91c1327303adf8945aefce6ac59ab9bf856c9f4e0cf6c6f

書式:

• op=get (必須)
• op2=module_value_all_agents (必須)
• id=<エージェント名> (必須)

例 (書式を参照):

Host Alive というモジュールがある全エージェントの一覧:

.../include/api.php?op=get&op2=module_value_all_agents&id=Host%20Alive&apipass=1234&user=admin&pass=pandora

数値 ID で指定したエージェントのモジュール一覧を返します。

書式:

• op=get (必須)
• op2=agent_modules (必須)
• return_type=<csv> (必須) 出力書式
• other=<連続パラメータ> (必須) エージェントでフィルタするためのパラメータ:
  • <エージェントID>

例 ( 書式を参照):

.../include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

エージェントのモジュール ID を返します。

書式:

• op=get (必須)
• op2=module_id (必須)
• id=id agent (必須)
• other=module name (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_id&id=5&other=Host%20Alive&apipass=1234&user=admin&pass=pandora

モジュール ID をパラメータをとして渡し、特定のエージェントモジュールの カスタ ムID の値を返します。

書式:

• op=get (必須)
• op2=module_custom_id (必須)
• id=id_agent_module (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_custom_id&id=5&apipass=1234&user=admin&pass=pandora

エージェントが存在するサーバ ID を取得し、すべての結果を csv で出力します。

書式:

• op=get (必須)
• op2=locate_agent (必須)
• return_type=<csv> (必須) 出力フォーマット
• id=id_agent (必須)
• other_mode=other_mode=url_encode_separator_<separator> (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=locate_agent&return_type=csv&apipass=1234&user=admin&pass=pandora&id=Pepito&other_mode=url_encode_separator_%7C

書式:

• op=get (必須)
• op2=policies (必須)
• return_type=<csv> (必須)
• other=<複数の値> (オプション) ポリシーエージェントによってポリシーをフィルタするための複数の値:
  • <エージェントID>

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|

書式:

• op=get (必須)
• op2=tree_agents (必須)
• return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
• other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。以下に2つのケースを示します。:

• <セパレータ> CSV のセパレータ
• <CSVセパレータ>|<CR と置き換える文字>|<フィールド1>,<フィールド2>,<フィール ドN>これは、次のパラメータを構成します。（セパレータ文字として '|' を “other_mode” で指定できます。):
  • <CSVセパレータ>: CSV のフィールドセパレータ
  • <CR と置き換える文字> CSVファイル内に改行コードを見つけた場合に、通常の 改行の意味で利用している場合と曖昧になるのを避けるために、それを置き換える文字です。文字列を渡すと、スペースに置換されます。

• <フィールド1>,<フィールド2>,<フィールドN> :CSV に指定できるフィールドは次の 通りです:
  • type_row
  • group_id
  • group_name
  • group_parent
  • disabled
  • custom_id
  • group_description
  • group_contact
  • group_other
  • agent_id
  • alias
  • agent_direction
  • agent_comentary
  • agent_id_group
  • agent_last_contant
  • agent_mode
  • agent_interval
  • agent_id_os
  • agent_os_version
  • agent_version
  • agent_last_remote_contact
  • agent_disabled
  • agent_id_parent
  • agent_custom_id
  • agent_server_name
  • agent_cascade_protection
  • agent_name
  • module_id_agent_modulo
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
  • module_critical_inverse (only in version 6.0SP1 or later)
  • module_warning_inverse (only in version 6.0SP1 or later)
  • alert_id_agent_module
  • alert_id_alert_template
  • alert_internal_counter
  • alert_last_fired
  • alert_last_reference
  • alert_times_fired
  • alert_disabled
  • alert_force_execution
  • alert_id_alert_action
  • alert_type
  • alert_value
  • alert_matches_value
  • alert_max_value
  • alert_min_value
  • alert_time_threshold
  • alert_max_alerts
  • alert_min_alerts
  • alert_time_from
  • alert_time_to
  • alert_monday
  • alert_tuesday
  • alert_wednesday
  • alert_thursday
  • alert_friday
  • alert_saturday
  • alert_sunday
  • alert_recovery_notify
  • alert_field2_recovery
  • alert_field3_recovery
  • alert_id_alert_template_module
  • alert_fires_min
  • alert_fires_max
  • alert_id_alert_command
  • alert_command
  • alert_internal
  • alert_template_modules_id
  • alert_templates_id
  • alert_template_module_actions_id
  • alert_actions_id
  • alert_commands_id
  • alert_templates_name
  • alert_actions_name
  • alert_commands_name
  • alert_templates_description
  • alert_commands_description
  • alert_template_modules_priority
  • alert_templates_priority
  • alert_templates_field1
  • alert_actions_field1
  • alert_templates_field2
  • alert_actions_field2
  • alert_templates_field3
  • alert_actions_field3
  • alert_templates_id_group
  • alert_actions_id_group'

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;|%20|type_row,group_id,agent_alias&other_mode=url_encode_separator_|

書式:

• op=get (必須)
• op2=module_data (必須)
• id=<モジュールID> (必須)
• other_mode=url_encode_separator_<セパレータ> (必須)
• other=<連続パラメータ> (オプション)
  • CSV の区切り文字
  • 間隔 (秒)
  • 開始日時 (<年><月><日>T<時間»<分>)
  • 終了日時 (<年><月><日>T<時間»<分>)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_data&id=17&other=;|604800|20121201T13:40|20171215T13:40&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

モジュールのグラフを画像ファイルで返します。このグラフは、Pandora の静的グラフと同じ手法で生成されます。グラフの幅、高さ、期間、ラベル、開始日(データの終わりが グラフに表示される最後になります)をパラメータに指定する必要があります。

書式:

• op=set (必須)
• op2=module_data (必須)
• id=<モジュールID> (必須)
• other=<連続パラメータ> (必須), 順番に次のデータを指定します:
  • <期間>
  • <幅>
  • <高さ>
  • <ラベル>
  • <開始日>

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=graph_module_data&id=17&other=604800|555|245|pepito|2009-12-07&other_mode=url_encode_separator_|

other パラメータでフィルタしたイベントの一覧を返します。

書式:

• op=get (必須)
• op2=events (必須)
• id=<ノードID> (メタコンソールではオプション、ノードでは不要)
• return_type=csv (必須)
• other_mode=url_encode_separator_| (オプション)
• other=<連続したパラメータ> (オプション) 次の順番でパラメータを指定します:
  1. < セパレータ > (必須).
  2. < 重要度 > 0 から 6 で次の通り:
     1. 0:メンテナンス
     2. 1:情報
     3. 2:正常
     4. 3:警告
     5. 4:障害
     6. 5:マイナー
     7. 6:メジャー
  3. < エージェントの別名 >
  4. < モジュール名 >
  5. < アラートによるフィルタ > アラートにより生成されたイベントをフィルタす るには 1 にします。
  6. < イベントの所有者ユーザ >
  7. < 最小の日時 (開始日時) > ミリ秒は含まない UnixR 時刻フォーマット(EPOCH)。
  8. < 最大の日時 (終了日時) > ミリ秒は含まない UnixR 時刻フォーマット(EPOCH)。
  9. < 状態 > 未承諾イベントをフィルタするには 0、承諾済みは 1 。
  10. < テキスト > イベント内を検索するキーワード。
  11. < ページサイズ > ページネーション (オフセット) のために返すレコードの数 を設定します。 オフセット番号が省略された場合、最初のオフセットのみが返されます (最初のオフセットは数字のゼロ 0 です)。
  12. < ページ番号 > 上記のページ サイズに応じて、前後のレコードブロック (オフセット) を返します。
  13. < スタイル > 以下の二種類の値のみ指定可能です:
      1. total: 単純にイベントの総数を返します。たとえば、JSON 形式では、{“type”:“json”,“data”:{“count”:990}} が配信されます。
      2. more_criticity: 最も重大なイベントの数を返します。JSON 形式でリク エストされた場合の例: {“type”:“json”,“data”:[{“criticity”:“4”,“user_can_manage”:“1”,“user_can_write”:“1”,“server_id”:5,“server_name”:“stod”}]}.
  14. < グループ ID > エージェントのグループに属する 未承諾 イベントを返します。数値のみ指定できます。
  15. < タグ > Pandora FMS に登録されている任意のタグです。(get tags を参照)。JSON フォーマットである必要があります。例: [“2”,“5”] (書式 を参照)。
  16. < イベントタイプ > 以下の値を指定できます:
      • going_unknown
      • unknown
      • recon_host_detected
      • system
      • error
      • new_agent
      • going_up_warning
      • going_up_critical
      • going_down_warning
      • going_down_normal
      • going_down_critical
      • going_up_normal
      • configuration_change
      • ncm
      • not_normal

例 (書式を参照):

メタコンソールで、ノード ID が 5 の ncm (ネットワーク設定管理) イベントの取得:

…include/api.php?op=get&op2=events&user=admin&pass=pandora&return_type=json&apipass=1234&other_mode=url_encode_separator_|&other=|||||||||||||||ncm&id=5

書式:

• op=get (必須)
• op2=all_alert_templates (必須)
• other=cvs_separator (オプション)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;

書式:

• op=get (必須)
• op2=module_groups (必須)
• other=cvs_separator (オプション)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;

書式:

• op=get (必須)
• op2=plugins (必須)
• other=cvs_separator (オプション)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;

書式:

• op=get (必須)
• op2=tags (必須)
• return_type=csv または、return_type=json (必須)
• other=< フィールドセパレータ > CSV フォーマットを指定した場合はフィール ドセパレータは必須です。指定しないと各フィールドが一緒に返されます。

例 (書式を参照):

この例では、システムの全てのタグをセミコロンで区切った CSV フォーマットで返しま す。

…/include/api.php?op=get&op2=tags&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

= 5.0 (エンタープライズ版のみ)

書式:

• op=get (必須)
• op2=update_module_in_conf (必須)
• id=<エージェントID> (必須)
• id2=<モジュール名> (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_from_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name

モジュールが見つからない場合は、空の文字列を返します。

グループの全モジュール。

書式:

• op=get (必須)
• op2=total_modules (必須)
• id=<グループID> (バージョン 768 までは必須、バージョン 769 以降はオプシ ョン)

例 (書式を参照)

Networking モジュールグループの全モジュール数の取得:

.../include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora

Pandora FMS インストール時のデフォルトでは、以下の モジュールグループ があります。

1. General.
2. Networking.
3. Application.
4. System.
5. Miscellaneous.
6. Performance.
7. Database.
8. Enviromental.
9. Users.

グループ ID が 0 または、省力した場合は、全モジュール数が返ります。

.../include/api.php?op=get&op2=total_modules&apipass=1234&user=admin&pass=pandora

グループの全エージェント

書式:

• op=get (必須)
• op2=total_agents (必須)
• id=<グループID> (必須)

例

http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora

指定した ID のエージェント名

書式:

• op=get (必須)
• op2=agent_name (必須)
• id=<エージェントID> (必須)

例

http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora

= 7.0NG

指定した ID のエージェントの別名を取得します。

書式:

• op=get (必須)
• op2=agent_alias (必須)
• id=<エージェントID> (必須)
• id2=<ノードID> (メタコンソールでは必須、ノードでは不要)

例

ノード:

http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora

メタコンソール:

http://localhost/pandora_console/enterprise/meta/include/api.php?op=get&op2=agent_alias&id=1&id2=1&apipass=1234&user=admin&pass=pandora

指定した ID のモジュール名

書式:

• op=get (必須)
• op2=module_name (必須)
• id=<モジュールID> (必須)

例

http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora

指定したグループにおよびアクションにおいて、実行された全アラート

書式:

• op=get (必須)
• op2=alert_action_by_group (必須)
• id=<グループID> (必須)
• id2=<アクションID> (必須)

例

http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora

アラートアクションの一覧を取得します。

書式:

• op=get (必須)
• op2=alert_actions (必須)
• return_type=<一覧フォーマット> (必須) 'csv' または 'json' を指定できます。
• other=<連続パラメータ> (オプション):
  • <action_name>
  • <separator>

例

JSON フォーマットでアラートアクションの一覧を取得する (書式を参照):

.../include/api.php?op=get&op2=alert_actions&return_type=json&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

CSV フォーマットでアラートアクションの一覧を取得する (書式を 参照):

.../include/api.php?op=get&op2=alert_actions&return_type=csv&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

メタコンソールからノードのアラートアクション一覧を取得します。

書式:

• op=get (必須)
• op2=alert_actions_meta (必須)
• return_type=<return type> (必須) 'csv' または 'json' を指定できます。
• other=<連続パラメータ> (オプション):
  • <server_name> (オプション)
  • <action_name> (オプション)
  • <separator> (オプション)

例

http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions_meta&apipass=1234&user=admin&pass=pandora&other=nodo|Create|&other_mode=url_encode_separator_|&return_type=json

全アラートコマンドを返します。

書式:

• op=get (必須)
• op2=all_alert_commands (必須)
• other=cvs_separator (オプション)

例

http://localhost/pandora_console/include/api.php?op=get&op2=all_alert_commands&return_type=csv&other=$&apipass=1234&user=admin&pass=pandora

書式:

• op=get (必須)
• op2=event_info (必須)
• id=<イベントID> (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora

書式:

• op=get (必須)
• op2=tactical_view (必須)

例

http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora

バージョン 5.0 かそれ以降

書式:

• op=get (必須)
• op2=pandora_servers (必須)
• other=cvs_separator (オプション)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora

次の順番で値が返ります。

• サーバ名
• 状態 (1 - 稼働, 0 - 停止)
• サーバタイプ (文字列)
• マスターサーバかどうか (1 - マスターサーバ, 0 - マスターサーバではない)
• 稼働中のモジュール数
• 該当する全モジュール数
• 最大遅延(秒)
• 遅延モジュール数
• スレッド数
• 現在キューに溜まっているモジュール数
• 最終更新日時 (文字列)

= 5.0

書式:

• op=get (必須)
• op2=custom_field_id (必須)
• other=<連続パラメータ> (必須) カスタムフィールド名です
  • <名前> (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=custom_field_id&other=mycustomfield&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

= 5.0

エージェントの最新の gis データを返します。

書式:

• op=set (必須)
• op2=gis_agent (必須)
• id=<id> (必衰) エージェントID

例

http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1

= 5.1

特別日一覧を返します。

書式:

• op=get (必須)
• op2=special_days (必須)
• other=<csvセパレータ> (オプション) CSVのセパレータ

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=special_days

= 5.1SP2

モジュールのプロパティ一覧を返します。出力する項目は other で指定できます。

書式:

• op=get (必須)
• op2=module_properties (必須)
• id=モジュールID。 (必須)
• return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
• other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。以下に2つのケースを示します。:

• <セパレータ> CSV のセパレータ
• <CSVセパレータ>|<CR と置き換える文字>|<フィールド1>,<フィールド2>,<フィール ドN>これは、次のパラメータを構成します。（セパレータ文字として '|' を “other_mode” で指定できます。):
  • <CSVセパレータ>: CSV のフィールドセパレータ
  • <CR と置き換える文字> CSVファイル内に改行コードを見つけた場合に、通常の 改行の意味で利用している場合と曖昧になるのを避けるために、それを置き換える文字です。文字列を渡すと、スペースに置換されます。
  • <フィールド1>,<フィールド2>,<フィールドN> :CSV に指定できるフィールドは 次の通りです:
    • module_id_agent_modulo
    • module_id_agent
    • module_id_module_type
    • module_description
    • module_name
    • module_max
    • module_min
    • module_interval
    • module_tcp_port
    • module_tcp_send
    • module_tcp_rcv
    • module_snmp_community
    • module_snmp_oid
    • module_ip_target
    • module_id_module_group
    • module_flag
    • module_id_module
    • module_disabled
    • module_id_export
    • module_plugin_user
    • module_plugin_pass
    • module_plugin_parameter
    • module_id_plugin
    • module_post_process
    • module_prediction_module
    • module_max_timeout
    • module_custom_id
    • module_history_data
    • module_min_warning
    • module_max_warning
    • module_min_critical
    • module_max_critical
    • module_min_ff_event
    • module_delete_pending
    • module_id_agent_state
    • module_data
    • module_timestamp
    • module_state
    • module_last_try
    • module_utimestamp
    • module_current_interval
    • module_running_by
    • module_last_execution_try
    • module_status_changes
    • module_last_status
    • module_plugin_macros
    • module_macros
    • module_critical_inverse (only in version 6.0SP1 or later)
    • module_warning_inverse (only in version 6.0SP1 or later)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=6233&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=1103&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

= 5.1SP2

モジュールのプロパティ一覧を返します。出力する項目は other で指定できます。

書式:

• op=get (必須)
• op2=module_properties_by_name (必須)
• id=エージェント名。 (必須)
• id2=モジュール名。 (必須)
• return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
• other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。(get_module_properties と同じです。詳しくは、get_module_properties を参照してください)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

= 7.0NG

モジュールプロパティの一覧を返します。一覧はパラメータでフィルタできます。

書式:

• op=get (必須)
• op2=module_properties_by_alias (必須)
• id=agent_alias (必須)
• id2=agentmodule_name (必須)
• return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
• other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。(get_module_properties と同じです。詳しくは、get_module_properties を参照してください)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_alias&id=pandorafms&id2=Memory_Used&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

base64 でエンコードされたモジュールグラフを返します。

書式:

• op=get (必須)
• op2=module_graph (必須)
• id=<モジュールID> (必須)
• other=<秒単位の間隔> (オプション) デフォルトは 3600 (1時間)です。 時間間隔はデータリカバリに使われます。

バージョン NG 752 以降では、追加のパラメータがあります。必須項目っとそのセパレータ | または、その エスケープ文字 %7C に注意してください。

• op=get (必須)
• op2=module_graph (必須)
• id=<module id> (必須)
• other ====
  • リクエストの日付からさかのぼってデータが収集される秒単位の時間範囲(デフ ォルトは 3600)(必須)。
  • セパレータ
  • 0 であれば base64 グラフィック、1 であれば画像(必須)
  • セパレータ
  • 0 であればしきい値無し。 1 であればしきい値あり。- モジュールに有効なし きい値がある場合 - (必須)
  • セパレータ
  • ピクセル単位のグラフの高さ(必須)。マップキーを表示するには 49ピクセルが 必要です。

例

バージョン NG 752 未満:

http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=5&other=3600%7C1&other_mode=url_encode_separator_%7C&apipass=1234&api=1&user=admin&pass=pandora

バージョン NG 752 以上:

http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=2&other=3600%7C1%7C1%7C500%7C&other_mode=url_encode_separator_%7C|&apipass=1234&api=1&user=admin&pass=pandora

= 5.1

フィルタにマッチした計画停止の一覧を返します。

op=get (必須) op2=all_planned_downtimes (必須) return_type=csv または json (必須) other=<連続パラメータ> (オプション) 計画停止をフィルタするためのパラメータ列:

• <名前>
• <グループID>
• <タイプ> quit, disabled_agents, disabled_agents_alerts のいずれか
• <実行> once または periodically
• <定期実行タイプ> weekly または monthly

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

= 5.1

フィルタにマッチした計画停止のアイテム一覧を返します。

• op=get (必須)
• op2=planned_downtimes_items (必須)
• return_type=csv または json (必須)
• other=<連続パラメータ> (オプション) 計画停止をフィルタするためのパラメータ列:

• <名前>
• <グループID>
• <タイプ> quit, disabled_agents, disabled_agents_alerts のいずれか
• <実行> once または periodically
• <定期実行タイプ> weekly または monthly

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

= 5.1

エージェントのグループ ID を返します。

書式:

• op=get
• op2=id_group_agent_by_name
• other=<文字列または連続パラメータ> エージェント名およびフィルタリングパラメ ータ (オプション)
  • <エージェント名>

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40

= 7.0NG

エージェントのグループ ID を返します。

書式:

• op=get
• op2=id_group_agent_by_alias
• other=<文字列または連続パラメータ> エージェントの別名およびフィルタリングパ ラメータ (オプション)
  • <エージェントの別名>

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

= 5.1

エージェントのグループ名を返します。

書式:

• op=get
• op2=group_agent_by_name
• other=<文字列または連続パラメータ> エージェント名およびフィルタリングパラメ ータ (オプション)
  • <エージェント名>

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40

= 7.0NG

エージェントのグループ名を返します。

書式:

• op=get
• op2=group_agent_by_alias
• other=<文字列または連続パラメータ> エージェントの別名およびフィルタリングパ ラメータ (オプション)
  • <エージェントの別名>

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

= 7.0NG

名前からグループ ID を返します。

書式:

• op=get
• op2=group_id_by_name
• other=<単一パラメータ> (必須):
  • <グループ名>

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_id_by_name&other=Servers

= 7.0NG

Pandora に設定されているタイムゾーンを返します。

書式:

• op=get
• op2=timezone

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone

= 7.0

ID ごとのクラスタ状態を返します。

• op=get
• op2=cluster_status
• id=<クラスタID>

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_status&id=1&apipass=1234&user=admin&pass=pandora

= 7.0

名前からクラスタの ID を返します。

• op=get
• op2=cluster_id_by_name
• id=<クラスタ名>

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_id_by_name&id=paco&apipass=1234&user=admin&pass=pandora

= 7.0

クラスタ ID から、ID ⇒ クラスタエージェント名を返します。

• op=get
• op2=agents_id_name_by_cluster_id
• id=<クラスタID>

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

= 7.0

クラスタ名から、ID ⇒ クラスタエージェント名を返します。

• op=get
• op2=agents_id_name_by_cluster_name
• id=<クラスタ名>

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_name&id=paco&apipass=1234&user=admin&pass=pandora

= 7.0

クラスタ ID から、ID ⇒ クラスタエージェントの全モジュール名を返します。

• op=get
• op2=modules_id_name_by_cluster_id
• id=<クラスタID>

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

= 7.0

クラスタ名から、ID ⇒ クラスタエージェントの全モジュール名を返します。

• op=get
• op2=modules_id_name_by_cluster_name
• id=<クラスタ名>

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_name&id=paco&apipass=1234&user=admin&pass=pandora

= 7.0

クラスタ ID から、アイテムID ⇒ (name,id,module_agent,type,pcrit,pwarn) のフォーマットで json オブジェクトの要素を返します。

pcrit: アクティブ・アクティブの場合は障害状態のパーセンテージ、アクティブ・スタ ンバイの場合は 1 または 0

pwarn: アクティブ・アクティブの場合は警告状態のパーセンテージ、アクティブ・スタ ンバイの場合は null

• op=get
• op2=cluster_items
• id=<クラスタID>

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_items&id=1&apipass=1234&user=admin&pass=pandora

= 7.0NG. 725

ポリシーから全データを返します。ポリシー ID が指定されていない場合は、全ポリシーから全データを返します。

書式:

• op=get
• op2=policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

ポリシーの全コレクションを返します。ポリシー ID が指定されていない場合は、全ポリシーの全コレクションを返します。

書式:

• op=get
• op2=collections_policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

ポリシーの全プラグインを返します。ポリシー ID が指定されていない場合は、全ポリシーの全プラグインを返します。

書式:

• op=get
• op2=plugins_policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

ポリシーのインベントリモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全インベントリモジュールを返します。

書式:

• op=get
• op2=inventory_policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=inventory_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

= 7.0NG. 725

ポリシーの全未リンクモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全未リンクモジュールを返します。

書式:

• op=get
• op2=unlinking_policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

次の点を考慮して、ポリシーのアラートを返します。

• ポリシー ID が指定されていれば、ポリシーのアラートを返します。そうでなければ、全ポリシーの全アラートを返します。
• アラートのタイプを指定されている場合: (オプションは 3つあります)
  • 0: すべてを表示します(デフォルト)
  • 1: 通常アラートのみ表示します
  • 2: 外部アラートのみ表示します

書式:

• op=get
• op2=alerts_policy
• id=<ポリシーID> (オプション)
• id2=0:すべて(デフォルト), 1:通常, 2:外部
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id2=2.

= 7.0NG. 725

以下を考慮して、ポリシーのアラートの全アクションを返します。

• ポリシー ID が指定されている場合は、そのポリシーのアラートのアクションを返します。指定されていない場合は、全ポリシーの全アラートの全アクションを返します。
• アラート ID が指定されている場合は、そのアラートのアクションを返します。

書式:

• op=get
• op2=alerts_actions_policy
• id=<ポリシーID> (オプション)
• id2=<ポリシーアラートID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=1&id2=3

= 7.0NG. 725

ポリシーの全エージェントを返します。ポリシー ID が指定されていない場合は、全ポリシーの全エージェントを返します。

書式:

• op=get
• op2=agents_policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=agents_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

ポリシーの全グループを返します。ポリシー ID が指定されていない場合は、全ポリシーの全グループを返します。

書式:

• op=get
• op2=groups_policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=groups_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

= 7.0NG. 725

ポリシーのキューを返します。ポリシー ID が指定されていない場合は、全ポリシーの全キューを返します。

書式:

• op=get
• op2=queue_policy
• id=<ポリシーID> (オプション)
• return_type=(json, csv, string).

例

http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json

= 7.0NG. 728

指定されたソーストラップを返します。また、タイムスタンプやその他のデータをフィルタリングすることもできます。

書式:

• op=get
• op2=traps
• other=<オプションパラメータ»
  • <timestamp>
  • <limit>
  • <offset>
  • <status>
  • <oid_custom>

例

https://localhost/pandora_console/include/api.php?op=get&op2=traps&other=1537128000%7C9000%7C0%7C1%7C.1.2.3.6.4&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

Pandora FMS でユーザがアクセスするイベント応答の一覧を返します。

書式:

• op=get (必須)
• op2=event_reponses (必須)
• return_type=csv|json (必須)

例

この例では、csv フォーマットで全システムイベント応答を返します。

http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora

Pandora FMS のユーザ一覧を返します。

書式:

• op=get (必須)
• op2=users (必須)
• return_type=csv|json (必須)

例

この例では、全ユーザを CSV フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=users&return_type=csv&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_&

全 Pandora FMS ユーザ一覧を出力します。

書式:

• op=get (必須)
• op2=list_all_user(必須)
• return_type=csv|json (必須)

例

Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 応答タイプのみの指定で、その他変数は使用しません。

http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora

ユーザデータの一覧を返します。

書式:

• op=get (必須)
• op2=list_all_user(必須)
• return_type=csv|json (必須)
• other=usernarme (必須)

例

指定のユーザに関するすべての情報を取得します。 Json または CSV にて返すことがで きます。この戻り値は URL を介して指定します。 応答タイプのみの指定で、その他変数は使用しません。

http://localhost/pandora_console/include/api.php?op=get&op2=info_user_name&return_type=json&other=admin&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Pandora FMS のユーザプロファイル一覧を返します。

書式:

• op=get (必須)
• op2=user_profiles_info (必須)
• return_type=csv|json (必須)

例

この例では、全システムユーザプロファイルを json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=csv&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_&

= 7.21 メタコンソールのみ

エージェントマイグレーションキューに、指定のエージェントが存在するかを確認します。

• op=get
• op2=migrate_agent
• id=id_agente a migrar
• return_type=string, json, etc

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&return_type=json

= 7.0NG 730

Pandora FMS に設定されている言語を返します。

書式:

• op=get
• op2=language

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language

= 7.0NG 730

Pandora FMS に設定されたセッションタイムアウトを返します。

書式:

• op=get
• op2=session_timeout

例

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=session_timeout

= 7.0NG 732

存在するグループを返します。

書式:

• op=get
• op2=groups
• other=<オプションパラメータ»
  • <csv_separator» デフォルトは ';'。
  • <return_all_group» 'すべて' グループを返します。
  • <return_all_columns» 全カラムを返します。

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=groups&other=;%7C1%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

フィルタリングを行ったユーザグループを取得します。

書式:

• op=get (必須)
• op2=filter_user_group (必須)
• return_type=csv|json(必須)
• other=id group(必須)|Enabled or not(Disabled)(必須)

例

Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 2 つの変数(グループIDまたは有効化)の 1つは空ですが、少なくとも 1つは入力する必要があることに注意してください。

http://localhost/pandora_console/include/api.php?op=get&op2=filter_user_group&return_type=json&other=0|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Pandora インベントリモジュールの一覧を返します。

書式:

• op=get (必須)
• op2=inventory_modules (必須)
• return_type=csv|json (必須)

例

この例では、全インベントリの情報を json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora

エージェント名を用いてエージェントからインベントリモジュールを取得します。

書式:

• op=get (必須)
• op2=inventory_modules_by_name (必須)
• id=<エージェント名> (必須)

例

http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_name&id=name&return_type=csv&apipass=1234&user=admin&pass=pandora

エージェントの別名を用いて、エージェントからインベントリモジュールを取得します。

書式:

• op=get (必須)
• op2=inventory_modules_by_alias (必須)
• id=<エージェントの別名> (必須)

例

http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_alias&id=alias&return_type=csv&apipass=1234&user=admin&pass=pandora

エージェント名とモジュールを用いて、インベントリモジュールからデータを取得します。

書式:

• op=get (必須)
• op2=inventory_module_data (必須)
• id=<エージェント名> (必須)
• id2=<インベントリモジュール名> (オプション)
• other=<連続パラメータ> (オプション), 次の順番で指定します:
  • <separator>
  • <date_from» <year><month><day>T<hour»<minute>
  • <date_to» <year><month><day>T<hour»<minute>
  • <use_agent_alias> (オプション) 0 または 1

例

http://127.0.0.1/pandora_console/include/api.phpop=get&op2=inventory_module_data&id=e14ae3b959b08a1fb7a057281401a08063cf04eb714efa5fbf1cf4043cfa1314&id2=Routes&other=,%7C20191010T13:40%7C20191211T13:40%7C0&return_type=csv&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

Pandora の全コレクションの一覧を返します。

書式:

• op=get (必須)
• op2=list_collections (必須)

例

この例では、全コレクションの情報を json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=list_collections&apipass=1234&user=admin&pass=pandora

コレクション内の全ファイル一覧を返します。コレクション ID を指定しなかった場合、全コレクションの全ファイルを返します。

書式:

• op=get (必須)
• op2=list_collections_files (必須)
• id=id_collection

例

この例では、コレクション内の全ファイル名を json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=list_collection_files&id=1&apipass=1234&user=admin&pass=pandora

存在するイベントフィルタの一覧を返します。

書式:

• op=get (必須)
• op2=all_event_filters (必須)
• other=cvs_separator (オプション)

例

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_event_filters&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

ノードの ID および、ノードのイベント ID を用いて、メタコンソールでのイベント ID を返します。

書式:

• op=get (必須)
• op2=event_mcid (必須)
• id=<server_id> (必須) ノードの ID です。
• id2=<id_source_event> (必須) ノードのイベント ID です。

例

http://172.16.0.3/pandora_console/include/api.php?op=get&op2=event_mcid&return_type=json&id=0&id2=0&apipass=1234&user=admin&pass=pandora

ノードが中央管理されているか(1)、そうでないか(0)を返します。 ノードが存在しない場合は、その旨を通知するテキスト文字列が返されます。コマンドセンター(メタコンソール)およびノードで直接使用することができます。

書式:

• op=get (必須)
• op2=is_centralized (必須)
• id=(コマンドセンター(メタコンソール)では必須。ノードでは不要。)

ノードでの例:

 http://localhost/pandora_console/include/api.php?op=get&op2=is_centralized&apipass=1234&user=admin&pass=pandora

コマンドセンター(メタコンソール)での例:

http://localhost/pandora_console/include/api.php?op=get&op2=is_centralized&id=3&apipass=1234&user=admin&pass=pandora

データを送信します。

パラメータで指定した内容で新たなエージェントを作成します。

書式:

• op=set (必須)
• op2=new_agent (必須)
• id= (コマンドセンター(メタコンソール)) エージェントが属するノードの数値識別子(必須)
• other=<連続したパラメータ> (必須) エージェントの設定とデータを次の順番に指定します。
  • <エージェントの別名>
  • <IP>
  • <親エージェントのID>
  • <グループID>
  • <関連障害検知抑制>
  • <関連障害検知抑制モジュール>
  • <間隔(秒)>
  • <OSのID>
  • <サーバ名>
  • <カスタムID>
  • <学習モード>
  • <無効化>
  • <説明>
  • <alias_as_name>

例

ノード での呼び出し例 (呼出書式 を参照 ):

.../include/api.php?op=set&op2=new_agent&other=agent_api|1.1.1.1|0|4|0|0|300|10|pandorafms|8|10||description|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

コマンドセンター(メタコンソール) での呼び出し例 (呼出書式 を参照):

.../include/api.php?op=set&op2=new_agent&id=1&other=agent_api|1.1.1.1|0|4|0|0|300|10|pandorafms|8|10||description|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

• 注意: alias_as_name が 1 の場合はエージェント名は別名と同じです。0 の場合はエージェント名は自動的に生成されます。

パラメータで渡したデータで、エージェントを更新します。

書式:

• op=set (必須)
• op2=update_agent (必須)
• id=<エージェントID> (必須)
• other=<連続パラメータ> (必須) エージェントの設定データで次の順番で設定します。
  • <エージェントの別名>
  • <ipアドレス>
  • <親ID>
  • <グループID>
  • <関連障害検知抑制>
  • <関連障害検知抑制モジュール>
  • <間隔(秒)>
  • <OSのID>
  • <サーバ名>
  • <カスタムID>
  • <学習モード>
  • <無効化>
  • <説明>
  • <OSバージョン>

例 (書式を参照):

.../include/api.php?op=set&op2=update_agent&id=5&other=agent_name%7C1.1.1.1%7C0%7C4%7C0%7C0%7C30%7C8%7Clocalhost.localdomain%7C%7C0%7C0%7Cla%20description|Ubuntu&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

この呼び出しは、1つもしくは、(別名を利用し一致するエージェントが複数ある場合は) 複数のエージェントのフィールドを更新します。

書式:

• op=set (必須)
• op2=update_agent (必須)
• id=<id_agent> or <alias> (必須), <alias> id2 パラメータに依存します。
• id2= <id_agente> の場合 0 (オプション), <alias> の場合 1 (必須)
• other=<連続パラメータ> (必須) 次の順番でエージェント設置とデータを指定します。

• <エージェントの別名>
• <ip>
• <親 ID>
• <グループ ID>
• <関連障害検知抑制>
• <関連障害検知抑制モジュール>
• <秒単位の間隔>
• <OS ID>
• <サーバ名>
• <カスタム ID>
• <学習モード>
• <無効化>
• <説明>

例

エージェント名を利用する場合:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

別名を利用する場合。別名を含む全エージェントを編集します:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=pandora&id2=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

指定した名前のエージェントを削除します。

書式:

• op=set (必須)
• op2=delete_agent (必須)
• id=<エージェント名> (必須) エージェント名でなければいけません。
• other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo

id に指定したテンプレート、other に指定したエージェント、モジュール ID から、ア ラートを作成します。

書式:

• op=set (必須)
• op2=create_module_template (必須)
• id=<テンプレートID> (必須) テンプレートIDでなければいけません。
• other=<id_module>|<id_agent>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_module_template&id=1&other=1|10&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

モジュールテンプレートをエージェントへ適用します。

モジュールテンプレートは、ネットワークモジュールを集めたものです。このテンプレートは、直接エージェントに適用することができ、モジュールを一つ一つ追加する必要はありません。

書式:

• op=set (必須)
• op2=apply_module_template (必須)
• id<id_template> (必須) 適用されるテンプレートの ID
• id2<id_agente> (必須) モジュールが作成されるエージェントの ID

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_module_template&id=2&id2=2&apipass=1234&user=admin&pass=pandora

指定のパラメータでネットワークモジュールを作成します。

書式:

• op=set (必須)
• op2=create_network_module (必須)
• id=< エージェント名 > (必須) エージェント名でなければいけません。
• other=< 連続パラメータ > (必須) 次の順番で指定するモジュール設定パラメータです。

1. < モジュール名 >
2. < 無効化 >
3. < モジュールタイプID >
4. < モジュールグループID >
5. < 警告の最小値 >
6. < 警告の最大値 >
7. < 警告の文字列 >
8. < 障害の最小値 >
9. < 障害の最大値 >
10. < 障害の文字列 >
11. < 連続抑制回数 >
12. < データの保存 >
13. < 対象IP >
14. < TCPポート >
15. < SNMPコミュニティ >
16. < SNMP OID >
17. < モジュール間隔 >
18. < データ保存倍率 >
19. < 最小 >
20. < 最大 >
21. < カスタムID >
22. < 説明 >
23. < 不明イベントの有効化 >
24. < モジュールマクロ > それぞれのマクロのプロパティを一つのオブジェクトにまと めて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、“<macro name>”: “<macro value>” でなければいけません。
25. < 個別状態変化の利用 >
26. < 正常移行時連続抑制回数 >
27. < 警告移行時連続抑制回数 >
28. < 障害移行時連続抑制回数 >
29. < 障害条件の反転 >
30. < 警告状態の反転 >
31. < ff_type >
32. < 不明の無視 > 0 もしくは 1
33. < 警告の間隔数 > モジュールが警告状態に留まる連続間隔の最大数を指定すること により、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状 態にエスカレートします。

例 (書式を参照):

…/include/api.php?op=set&op2=create_network_module&id=example&other=test|0|7|1|10|15|0|16|18|0|15|0|127.0.0.1|0||0|180|0|0|0|0|latency%20ping|1|||||||||||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

指定のパラメータでプラグインモジュールを作成します。

書式:

• op=set (必須)
• op2=create_plugin_module (必須)
• id=<エージェント名> (必須) エージェント名でなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定を指定します。

1. < モジュール名 >
2. < 無効化 >
3. < モジュールタイプID >
4. < モジュールグループID >
5. < 警告の最小値 >
6. < 警告の最大値 >
7. < 警告の文字列 >
8. < 障害の最小値 >
9. < 障害の最大値 >
10. < 障害の文字列 >
11. < 連続抑制回数 >
12. < データの保存 >
13. < 対象IP >
14. < TCPポート >
15. < SNMPコミュニティ >
16. < SNMP OID >
17. < モジュール間隔 >
18. < 保存倍率 >
19. < 最小値 >
20. < 最大値 >
21. < カスタムID >
22. < 説明 >
23. < プラグインID >
24. < プラグインユーザ >
25. < プラグインパスワード >
26. < プラグインパラメータ >
27. < 不明イベントの有効化 >
28. < マクロ > base 64 でエンコードされた JSON 文字列である必要があります。
29. < モジュールマクロ > これは、マクロごとに 1 つのプロパティを持つオブジェクトで構成される、base64 でエンコードされた JSON ドキュメントである必要があります。 JSON プロパティの形式は、“<macro name>”: “<macro value>” である必要があります。
30. < 個別状態変化の利用 >
31. < 正常移行時連続抑制回数 >
32. < 警告移行時連続抑制回数 >
33. < 障害移行時連続抑制回数 >
34. < 障害条件の反転 >
35. < 警告条件の反転 >
36. < ff_type >
37. < エージェント別名の利用 > 0 または 1
38. < 不明の無視 > 0 または 1
39. < 警告の間隔数 > モジュールが警告状態に留まる連続間隔の最大数を指定すること により、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状 態にエスカレートします。

例 (書式を参照):

…/include/api.php?op=set&op2=create_plugin_module&id=example&other=prueba|0|1|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|4|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

JSON ドキュメントの内容は、次のプロパティを持つ複数のオブジェクトで構成されるオ ブジェクトである必要があります。

• macro: マクロ名。_field1_, _field2_, …, _fieldN_ である必要があります。
• desc: マクロを表す名前。
• help: マクロの説明。
• value: マクロ値。
• hide: マクロ値を非表示にするには、1 に設定します (パスワードの保存に役立ちます)。

例:

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1",
   "hide": ""
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80",
   "hide": ""
 }
}

指定したパラメータでモジュールを作成します。

書式:

• op=set (必須)
• op2=create_data_module (必須)
• id=<エージェント名> (必須) エージェント名でなければいけません。
• other=<連続パラメータ> (必須) モジュールの設定とデータを次の順番で指定します。

1. <モジュール名>
2. <無効化>
3. <モジュールタイプID>
4. <説明>
5. <モジュールグループID>
6. <最小値>
7. <最大値>
8. <データ保存倍率>
9. <モジュールの間隔>
10. <警告の最小値>
11. <警告の最大値>
12. <警告の文字列>
13. <障害の最小値>
14. <障害の最大値>
15. <障害の文字列>
16. <データの保存>
17. <不明イベントの有効化>
18. <モジュールマクロ> それぞれのマクロのプロパティを一つのオブジェクトにまとめ て base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、“<macro name>”: “<macro value>” でなければいけません。
19. <連続抑制回数>
20. <個別状態変化の利用>
21. <正常移行時連続抑制回数>
22. <警告移行時連続抑制回数>
23. <障害移行時連続抑制回数>
24. <連続抑制タイムアウト>
25. <障害条件の反転>
26. <警告条件の反転>
27. <ff_type>
28. <不明の無視> 0 または 1
29. < 警告の間隔数 > モジュールが警告状態に留まる連続間隔の最大数を指定すること により、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状 態にエスカレートします。

例 (書式を参照):

…/include/api.php?op=set&op2=create_data_module&id=test&other=test%202|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0|0|0|0|0|0|0|0|0|0|0|1|1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

SNMP モジュールを作成します。

書式:

• op=set (必須)
• op2=create_snmp_module (必須)
• id=<エージェント名> (必須) エージェント名でなければいけません。
• other=<連続パラメータ> (必須) 次の順番で指定するモジュールの設定とデータです。

1. <モジュール名>
2. <無効化>
3. <モジュールタイプID>
4. <モジュールグループID>
5. <警告の最小値>
6. <警告の最大値>
7. <警告の文字列>
8. <障害の最小値>
9. <障害の最大値>
10. <障害の文字列>
11. <連続抑制回数>
12. <データの保存>
13. <対象IP>
14. <モジュールのポート>
15. <SNMPバージョン>
16. <SNMPコミュニティ>
17. <SNMP OID>
18. <モジュールの間隔>
19. <データ保存倍率>
20. <最小値>
21. <最大値>
22. <カスタムID>
23. <説明>
24. <SNMPv3 暗号化手法 [AES|DES]>
25. <SNMPv3 暗号化パスワード>
26. <SNMPv3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]>
27. <SNMPv3 認証手法 [MD5|SHA]>
28. <SNMPv3 認証ユーザ>
29. <SNMPv3 認証パスワード>
30. <不明イベントの有効化>
31. <個別状態変化の利用>
32. <正常移行時連続抑制回数>
33. <警告移行時連続抑制回数>
34. <障害移行時連続抑制回数>
35. <ff_type>
36. <不明の無視> 0 または 1
37. < 警告の間隔数 > モジュールが警告状態に留まる連続間隔の最大数を指定すること により、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状 態にエスカレートします。

例 (書式を参照):

例 1 (SNMP v3, 暗号化手法: AES, 暗号化パスワード: example_priv_passw, セキュリティレベル: authNoPriv, 認証手法:MD5, 認証ユーザ: pepito_user, 認証パスワード: example_priv_passw)

…/include/api.php?op=set&op2=create_snmp_module&id=example&other=prueba|0|15|1|10|15||16|18||15|0|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP%20module%20from%20API|AES|example_priv_passw|authNoPriv|MD5|pepito_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

例 2 (SNMP v1)

…/include/api.php?op=set&op2=create_snmp_module&id=example&other=prueba2|0|15|1|10|15||16|18||15|0|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP&20module&20from&20API&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

ネットワークモジュールを更新します。

書式:

• op=set (必須)
• op2=update_network_module (必須)
• id=<モジュールID> (必須) モジュールIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。

1. <エージェントID>
2. <無効化>
3. <モジュールグループID>
4. <警告の最小値>
5. <警告の最大値>
6. <警告文字列>
7. <障害の最小値>
8. <障害の最大値>
9. <障害文字列>
10. < min_ff_even >
11. <連続抑制回数>
12. <データの保存>
13. <対象のIPO>
14. <モジュールのポート>
15. <SNMPコミュニティ>
16. <SNMP OID>
17. <モジュールの間隔>
18. <データ保存倍率>
19. <最小値>
20. <最大値>
21. <カスタムID>
22. <説明>
23. <イベントタイプの無効化>
24. <モジュールマクロ> それぞれのマクロのプロパティを一つのオブジェクトにまとめ て base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、“<macro name>”: “<macro value>” でなければいけません。
25. <個別状態変化の利用>
26. <正常移行時連続抑制回数>
27. <警告移行時連続抑制回数>
28. <障害移行時連続抑制回数>
29. <障害条件の反転>
30. <警告条件の反転>
31. <ff_type>
32. < 警告の間隔数 > モジュールが警告状態に留まる連続間隔の最大数を指定すること により、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状 態にエスカレートします。

例 (書式を参照):

…/include/api.php?op=set&op2=update_network_module&id=132&other=|0|6|2|10|15||16|18||7|0|127.0.0.1|0||0|300|30.00|0|0|0|latency%20ping%20modified%20by%20the%20Api|||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

プラグインモジュールを更新します。

書式:

• op=set (必須)
• op2=update_plugin_module (必須)
• id=<モジュールID> (必須) モジュールIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。

1. <エージェントID>
2. <無効化>
3. <モジュールグループID>
4. <警告の最小値>
5. <警告の最大値>
6. <警告文字列>
7. <障害の最小値>
8. <障害の最大値>
9. <障害文字列>
10. <連続抑制回数>
11. <データの保存>
12. <対象IP>
13. <モジュールのポート>
14. <SNMPコミュニティ>
15. <SNMP OID>
16. <モジュールの間隔>
17. <データ保存倍率>
18. <最小値>
19. <最大値>
20. <カスタムID>
21. <説明>
22. <プラグインID>
23. <プラグインユーザ>
24. <プラグインパスワード>
25. <プラグインパラメータ>
26. <イベントタイプの無効化>
27. <マクロ> base 64 でエンコードされた文字列でなければいけません。
28. <モジュールマクロ> それぞれのマクロのプロパティを一つのオブジェクトにまとめ base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式 は、“<macro name>”: “<macro value>” でなければいけません。
29. <個別状態変化の利用>
30. <正常移行時連続抑制回数>
31. <警告移行時連続抑制回数>
32. <障害移行時連続抑制回数>
33. <障害条件の反転>
34. <警告条件の反転>
35. <リンクポリシー>
36. <ff_type>
37. <不明の無視> 0 または 1
38. < 警告の間隔数 > モジュールが警告状態に留まる連続間隔の最大数を指定すること により、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状 態にエスカレートします。

例 (書式を参照):

…/include/api.php?op=set&op2=update_plugin_module&id=2343&other=44|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|pluginmodule%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

内容は、次のプロパティで表すオブジェクトを一つにまとめたものでなければいけません。

• “macro”: マクロ名。_field1_, _field2_, …, _fieldN_ でなけ ればいけません。
• “desc”: マクロを表す名前。
• “help”: マクロの説明。
• “value”:マクロの値。

JSON マクロフォーマットの例:

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}

状態スケーリングを使用した別の例:

…/include/api.php?op=set&op2=update_plugin_module&id=135&other=|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max|||||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora"

ローカルモジュールを更新します。

書式:

• op=set (必須)
• op2=update_data_module (必須)
• id=<モジュールID> (必須) 更新するモジュールの数値 ID。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。

1. < エージェントID >
2. < 無効化 > 無効化の場合は 1、変更なし は 0。
3. < 説明 >
4. < モジュールグループID > get_module_groups を参照。
5. < 最小 >
6. < 最大 >
7. < 保存倍率 > ( (ソフトウエアエージェント でリモート設定が有効な場合のみ)
8. < モジュールの間隔 >
9. < 警告の最小値 >
10. < 警告の最大値 >
11. < 警告文字列 >
12. < 障害の最小値 >
13. < 障害の最大値 >
14. < 障害文字列 >
15. < データの保存 > 0 に設定するとモ ジュールのデータは、tagente_datos に保存されません。tagent_estado のみ更新されます。
16. < 無効化イベント > JSON フォーマット。例: {“going_unknown”:1}
17. < モジュールマクロ > これは、マクロごとに 1 つのプロパティを持つオブジェクトで構成された、base64 でエンコードされた JSON ドキュメントである必要があります。JSON プロパティのフォーマット: “<macro name>”: “<macro value>”
18. < 連続抑制回数 > モジュールの監視結果が何回連続で変化したらモジュールの状態 を変更するかの値。(連続抑制回数 )
19. < 個別状態変化の利用 >
20. < 正常移行時連続抑制回数 >
21. < 警告移行時連続抑制回数 >
22. < 障害移行時連続抑制回数 >
23. < 連続抑制タイムアウト >
24. < 障害条件の反転 >
25. < 警告条件の反転 >
26. < 関連ポリシー >
27. < 連続抑制カウンタの維持 >
28. < 不明の無視 > 0 または 1

例 (書式を参照):

.../include/api.php?op=set&op2=update_data_module&id=123&other=44|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

ポリシーのデータモジュールを更新し、新たなモジュールの ID を返します。

書式:

• op=set (必須)
• op2=update_data_module_policy (必須)
• id=<id_policy> (必須) 対象のポリシーモジュールID。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。:

1. <ポリシーモジュールID>
2. <説明>
3. <モジュールグループID>
4. <最小>
5. <最大>
6. <事前処理>
7. <モジュールの間隔>
8. <警告の最小値>
9. <警告の最大値>
10. <障害の最小値>
11. <障害の最大値>
12. <障害の文字列>
13. <データの保存>
14. <設定データ>
15. <disabled_types_event>
16. <モジュールマクロ> (バージョン 5以降) 各マクロに対して 1つのプロパティを持つオブジェクトによって形成された、base64 でエンコードされた JSON ドキュメントであ る必要があります。JSON フォーマットは、<マクロ名>:<マクロ値> のようになって いる必要があります。
17. <不明の無視> 0 または 1

例 (書式を参照):

.../include/api.php?op=set&op2=update_data_module_policy&id=1&other=10|data%20module%20updated%20by%20Api|2|0|0|50.00|10|20|180||21|35||1|module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

パラメータの識別子によって渡されたポリシー内のプラグインモジュールを更新します。

書式:

• op=set (必須)
• op2=update_plugin_module_policy (必須)
• id= < ポリシー ID > (必須) ポリシー ID である必要があります。
• other= <連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。

1. < ポリシーモジュール ID >
2. < 無効化 >
3. < モジュールグループID >
4. < 警告の最小値 >
5. < 警告の最大値 >
6. < 警告文字列 >
7. < 障害の最小値 >
8. < 障害の最大値 >
9. < 障害文字列 >
10. < 連続抑制回数 >
11. < データの保存 >
12. < モジュールポート >
13. < snmpコミュニティ >
14. < snmp OID >
15. < モジュール間隔 >
16. < 保存倍率 >
17. < 最小値 >
18. < 最大値 >
19. < カスタムID >
20. < 説明 >
21. < プラグインID >
22. < プラグインユーザ >
23. < プラグインパスワード >
24. < プラグインパラメータ >
25. < イベントタイプの無効化 >
26. < マクロ > 値は Base 64 でエンコードされた JSON 形式である必要があります。このセクションの最後にある例を参照してください。
27. < モジュールマクロ > 値は、Base 64 でエンコードされた JSON 形式である必要があります。JSON ドキュメント内のデータの形式は、“< マクロ名 >”: “< マクロ値 >” である必要があります。
28. < 不明状態の無視 > 値 0 および 1 が有効です。

例 (呼出書式を参照):

…/include/api.php?op=set&op2=update_plugin_module_policy&id=1&other=23|0|1|0|0||0|0||15|0|166|||180|150.00|0|0|0|plugin%20module%20updated%20from%20api|2|example_user|pass|-p%20min&other_mode=url_encode_separator_|

JSON ドキュメントのコンテンツは、次のプロパティ を持つ複数のオブジェクトで構成されたオブジェクトである必要があります。

• “macro”: マクロの名前。_field1_, _field2_, …, _fieldN_ である必要があります。
• “desc”: マクロの名前。
• “help”: マクロの説明。
• “value”: マクロの値。

SNMP モジュールを更新します。

書式:

• op=set (必須)
• op2=update_snmp_module (必須)
• id=<モジュールID> (必須) モジュールIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。

1. <エージェントID>
2. <無効化>
3. <モジュールグループID>
4. <警告の最小値>
5. <警告の最大値>
6. <警告文字列>
7. <障害の最小値>
8. <障害の最大値>
9. <障害文字列>
10. <連続抑制回数>
11. <データの保存>
12. <対象のIP>
13. <モジュールのポート>
14. <SNMPバージョン>
15. <SNMPコミュニティ>
16. <SNMP OID>
17. <モジュールの間隔>
18. <データ保存倍率>
19. <最小値>
20. <最大値>
21. <カスタムID>
22. <説明>
23. <snmp3 暗号化方式 [AES|DES]>
24. <snmp3 暗号化パスワード>
25. <snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]>
26. <snmp3 認証方式 [MD5|SHA]>
27. <snmp3 認証ユーザ>
28. <snmp3 認証パスワード>
29. <イベントタイプの無効化>
30. <個別状態変化の利用>
31. <正常移行時連続抑制回数>
32. <警告移行時連続抑制回数>
33. <障害移行時連続抑制回数>
34. <リンクポリシー>
35. <ff_type>
36. <不明の無視> 0 または 1
37. < 警告の間隔数 > モジュールが警告状態に留まる連続間隔の最大数を指定すること により、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状 態にエスカレートします。

例 (書式を参照):

例 (SNMPバージョン: 3、snmp3暗号化方式: AES、snmp3暗号化パスワード: example_priv_passw、snmp3セキュリティレベル: authNoPriv、snmp3認証方式:MD5、snmp3認証ユーザ: pepito_user、snmp3認証パスワード: example_priv_passw)

…/include/api.php?op=set&op2=update_snmp_module&id=33432&other=44|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module&20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

状態スケーリングと SNMP v1 を使用した別の例:

…/include/api.php?op=set&op2=update_snmp_module&id=137&other=|0|6|20|25||26|30||15|1|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora"

状態スケーリングと SNMP v3 を使用した別の例:

…/include/api.php?op=set&op2=update_snmp_module&id=138&other=|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw|||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora"

ひとつもしくは複数のエージェントに、ID を指定してポリシーを適用します。

書式:

• op=set (必須)
• op2=apply_policy (必須)
• id=<id_policy> (必須)
• id2=<id_agent> (オプション) 他のパラメータに示されているエージェントのIDまたは名前。 空の場合、ポリシーはすべてのエージェントに適用されます。
• other=<連続パラメータ>
  • <name_agent (整数)> エージェントを ID(0) で指定するか、名前(1) で指定す るか、別名(2) で指定するかを示します。
  • <server_id> (コマンドセンター(メタコンソール)の場合必要です) ポリシーを適用するサーバの ID です。

例

http://192.168.70.102/pandora_console/include/api.php?op=set&op2=apply_policy&id=22&id2=3e&other=0 |1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Pandora 内にある全ポリシーを適用します。

書式:

• op=set (必須)
• op2=apply_all_policies (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies&apipass=1234&user=admin&pass=pandora

指定したパラメータで、ポリシーにネットワークモジュールを追加します。

書式:

• op=set (必須)
• op2=add_network_module_policy (必須)
• id=<ポリシーID> (必須) ポリシーIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュールタイプID>
  • <説明>
  • <モジュールグループID>
  • <最小値>
  • <最大値>
  • <データ保存倍率>
  • <モジュールの間隔>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <データの保存>
  • <連続抑制回数>
  • <無効化>
  • <モジュールのポート>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <カスタムID>
  • <不明イベントの有効化> (バージョン 5 のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティ を一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけ ません。JSON プロパティの書式は、“<macro name>”: “<macro value>” でなければいけ ません。
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_network_module_policy&id=1&other=network_module_policy_example_name |6|network%20module%20created%20by%20Api|2|0|0|50.00|180|10|20||21|35||1|15|0|66|||0&other_mode=url_encode_separator_|

指定したパラメータで、ポリシーにプラグインモジュールを追加します。

書式:

• op=set (必須)
• op2=add_plugin_module_policy (必須)
• id=<ポリシーID> (必須) ポリシーIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <モジュールのポート>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <プラグインID>
  • <プラグインユーザ>
  • <プラグインパスワード>
  • <プラグインパラメータ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <マクロ> (バージョン 5 以降のみ) base 64 でエンコードした JSON 文字列で なければいけません。内容は、次のプロパティのオブジェクトを一つのオブジェクトにまとめた形式でなければいけません。
    • “macro”: マクロ名。_field1_, _field2_, …, _fieldN_ でなければいけません。
    • “desc”: マクロを表す名前。
    • “help”: マクロの説明。
    • “value”:マクロの値。

例

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}

• <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一 つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけませ ん。JSON プロパティの書式は、“<macro name>”: “<macro value>” でなければいけませ ん。
• <個別状態変化の利用> (バージョン 5.1 以降のみ)
• <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
• <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
• <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
• <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_plugin_module_policy&id=1&other=example%20plugin%20module%20name|0|1|2|0|0||0|0||15|0|66|||300|50.00|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|

指定したパラメータで、ポリシーにローカルモジュールを追加します。

書式:

• op=set (必須)
• op2=add_data_module_policy (必須)
• id=<ポリシーID> (必須) ポリシーIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュール名>
  • <モジュールタイプID>
  • <説明>
  • <モジュールグループID>
  • <最小値>
  • <最大値>
  • <データ保存倍率>
  • <モジュールの間隔>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <データの保存>
  • <設定データ> ポリシーエージェントの設定ファイルに挿入されるエージェント の定義ブロックです。
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティ を一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけ ません。JSON プロパティの書式は、“<macro name>”: “<macro value>” でなければいけ ません。
  • <連続抑制回数> (バージョン 5.1 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <連続抑制タイムアウト> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_data_module_policy&id=1&other=data_module_policy_example_name~2~data%20module%20created%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_~

指定したパラメータで、ポリシーに SNMP モジュールを追加します。

書式:

• op=set (必須)
• op2=add_snmp_module_policy (必須)
• id=<ポリシーID> (必須) ポリシーIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <モジュールのポート>
  • <SNMPバージョン>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <snmp3 暗号化方式 [AES|DES]>
  • <snmp3 暗号化パスワード>
  • <snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3 認証方式 [MD5|SHA]>
  • <snmp3 認証ユーザ>
  • <snmp3 認証パスワード>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_snmp_module_policy&id=1&other=example%20SNMP%20module%20name|0|15|2|0|0||0|0||15|1|66|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|pepito_user|example_auth_passw&other_mode=url_encode_separator_|

エージェント ID を用いてポリシーにエージェントを追加します。

書式:

• op=set (必須)
• op2=add_agent_policy_by_id (必須)
• id=<id_policy> (必須) ポリシー ID である必要があります。
• other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で 指定する必要があります:
  • <id_agent>
  • <id_node> (コマンドセンター(メタコンソール)の場合は必須) ポリシーに追加するエージェントが 属するノードのID。

例

• ノード:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

• コマンドセンター(メタコンソール):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

エージェント名を用いてポリシーへエージェントを追加します。

書式:

• op=set (必須)
• op2=add_agent_policy_by_name (必須)
• id=<id_policy> (必須) ポリシー ID である必要があります。
• other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で 指定する必要があります:
  • <agent_name>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

エージェント ID を用いて、ポリシーからエージェントを削除します。

書式:

• op=set (必須)
• op2=remove_agent_from_policy_by_id (必須)
• id=<id_politica> (必須) ポリシー ID である必要があります。
• other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で 指定する必要があります:
  • <id_agent>
  • <id_node> (コマンド センター (メタコンソール) を使用する場合に必要)。ポリシーから削除するエージェントが属するノードの ID。

必須

• ノード:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=2&other=2&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

• コマンドセンター(メタコンソール):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=4&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

エージェント名を用いて、ポリシーからエージェントを削除します。

書式:

• op=set (必須)
• op2=remove_agent_from_policy_by_name (必須)
• id=<id_policy> (必須) ポリシー ID である必要があります。
• other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で 指定する必要があります:
  • <agent_name>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

新たなネットワークコンポーネントを作成します。

書式:

• op=set (必須)
• op2=new_network_component (必須)
• id=<ネットワークコンポーネント名> (必須) ネットワークコンポーネント名でなけ ればいけません。
• other=<連続パラメータ> (必須) 次の順番でエージェントの設定とネットワークコンポーネントのデータを指定します。
  • <ネットワークコンポーネントタイプ>
  • <説明>
  • <モジュールの間隔>
  • <最大値>
  • <最小値>
  • <SNMPコミュニティ>
  • <モジュールグループID>
  • <最大タイムアウト>
  • <データの保存>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データ保存倍率>
  • <ネットワークコンポーネントグループ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_network_component&id=example_network_component_name&other=7|network%20component%20created%20by%20Api|300|30|10|public|3||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|

新たなプラグインコンポーネントを作成します。

書式:

• op=set (必須)
• op2=new_plugin_component (必須)
• id=<プラグインコンポーネント名> (必須) プラグインコンポーネント名でなければ いけません。
• other=<連続パラメータ> (必須) 次の順番でエージェントの設定とプラグインコンポーネントのデータを指定します。
  • <プラグインコンポーネントタイプ>
  • <説明>
  • <モジュールの間隔>
  • <最大値>
  • <最小値>
  • <モジュールのポート>
  • <モジュールグループID>
  • <プラグインID>
  • <最大タイムアウト>
  • <データの保存>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データ保存倍率>
  • <プラグインコンポーネントグループ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_plugin_component&id=example_plugin_component_name&other=2|plugin%20component%20created%20by%20Api|300|30|10|66|3|2|example_user|example_pass|-p%20max||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|

新たな SNMP コンポーネントを作成します。

書式:

• op=set (必須)
• op2=new_snmp_component (必須)
• id=<SNMPコンポーネント名> (必須) SNMPコンポーネント名でなければいけません。
• other=<連続パラメータ> (必須) 次の順番で SNMP コンポーネントの設定とデータを指定します。
  • <SNMPコンポーネントタイプ>
  • <説明>
  • <モジュールの間隔>
  • <最大値>
  • <最小値>
  • <モジュールグループID>
  • <最大タイムアウト>
  • <データの保存>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データ保存倍率>
  • <SNMPバージョン>
  • <SNMP OID>
  • <SNMPコミュニティ>
  • <snmp3 認証ユーザ>
  • <snmp3 認証パスワード>
  • <モジュールのポート>
  • <snmp3 暗号化手法>
  • <snmp3 暗号化パスワード>
  • <snmp3 認証手法>
  • <snmp3 セキュリティレベル>
  • <SNMPコンポーネントグループ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_snmp_component&id=example_snmp_component_name&other=16|SNMP%20component%20created%20by%20Api|300|30|10|3||1|10|20|str|21|30|str1|15|50.00|3|.1.3.6.1.2.1.2.2.1.8.2|public|example_auth_user|example_auth_pass|66|AES|example_priv_pass|MD5|authNoPriv|12&other_mode=url_encode_separator_|

新たなローカルコンポーネントを作成します。

書式:

• op=set (必須)
• op2=new_local_component (必須)
• id=<ローカルコンポーネント名> (必須) ローカルコンポーネント名でなければいけ ません。
• other=<連続パラメータ> (必須) 次の順番でローカルコンポーネントの設定とデータを指定します。
  • <説明>
  • <OSのID>
  • <ローカルコンポーネントグループ>
  • <設定データ> モジュールの設定ブロックです。
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <連続抑制回数> (バージョン 5.1 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <連続抑制タイムアウト> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_local_component&id=example_local_component_name&other=local%20component%20created%20by%20Api~5~12~module_begin%0dmodule_name%20example_local_component_name%0dmodule_type%20generic_data%0dmodule_exec%20ps%20|%20grep%20pid%20|%20wc%20-l%0dmodule_interval%202%0dmodule_end&other_mode=url_encode_separator_~

アラートテンプレートを作成します。

書式:

• op=set (必須)
• op2=create_alert_template (必須)
• id=<テンプレート名> (必須) テンプレート名でなければいけません。
• other=<連続パラメータ> (必須) 次の順番でテンプレートの設定とデータを指定します。
  • <タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always|not_normal]>
  • <説明>
  • <アラートアクションID>
  • <フィールド1>
  • <フィールド2>
  • <フィールド3>
  • <値>
  • <マッチする値>
  • <最大値>
  • <最小値>
  • <再通知間隔>
  • <最大アラート数>
  • <最小アラート数>
  • <開始時間>
  • <終了時間>
  • <月曜>
  • <火曜>
  • <水曜>
  • <木曜>
  • <金曜>
  • <土曜>
  • <日曜>
  • <復旧アラート>
  • <復旧時のフィールド2>
  • <復旧時のフィールド3>
  • <優先度>
  • <グループID>
  • <特別日の利用>
  • <アラートが継続しない場合にカウンターをリセット>
  • <復旧時のフィールド1>
  • <フィールド4>
  • <フィールド5>
  • <フィールド6>
  • <フィールド7>
  • <フィールド8>
  • <フィールド9>
  • <フィールド10>
  • <フィールド11>
  • <フィールド12>
  • <フィールド13>
  • <フィールド14>
  • <フィールド15>
  • <復旧時のフィールド4>
  • <復旧時のフィールド5>
  • <復旧時のフィールド6>
  • <復旧時のフィールド7>
  • <復旧時のフィールド8>
  • <復旧時のフィールド9>
  • <復旧時のフィールド10>
  • <復旧時のフィールド11>
  • <復旧時のフィールド12>
  • <復旧時のフィールド13>
  • <復旧時のフィールド14>
  • <復旧時のフィールド15>

例

例1 (状態: regexp =~ /pp/、アクション: Mail to XXX、最大アラート数: 10、最小アラート数: 0、優先度: 警告、グループ: database):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=example&other=regex|template%20based%20in%20regexp|1||||pp|1||||10|0|||||||||||||3|8&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

例2 (状態: 値が5と10の間以外、最大値: 10.00、最小値: 5.00、開始時間: 00:00:00、 終了時間: 15:00:00、優先度: 障害、グループ: Servers):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=template_min_max&other=max_min|template%20based%20in%20range|1||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

アラートテンプレートを更新します。

書式:

• op=set (必須)
• op2=update_alert_template (必須)
• id=<テンプレートID> (必須) テンプレートIDでなければいけません。
• other=<連続パラメータ> (必須) 次の順番でテンプレートの設定とデータを指定します。
  • <テンプレート名>
  • <タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <説明>
  • <アラートアクションID>
  • <フィールド1>
  • <フィールド2>
  • <フィールド3>
  • <値>
  • <マッチする値>
  • <最大値>
  • <最小値>
  • <再実行間隔>
  • <最大アラート数>
  • <最小アラート数>
  • <開始時間>
  • <終了時間>
  • <月曜>
  • <火曜>
  • <水曜>
  • <木曜>
  • <金曜>
  • <土曜>
  • <日曜>
  • <復旧アラート>
  • <復旧時のフィールド2>
  • <復旧時のフィールド3>
  • <優先度>
  • <グループID>
  • <特別日の利用>
  • <アラートが継続しない場合にカウンターをリセット>
  • <復旧時のフィールド1>
  • <フィールド4>
  • <フィールド5>
  • <フィールド6>
  • <フィールド7>
  • <フィールド8>
  • <フィールド9>
  • <フィールド10>
  • <フィールド11>
  • <フィールド12>
  • <フィールド13>
  • <フィールド14>
  • <フィールド15>
  • <復旧時のフィールド4>
  • <復旧時のフィールド5>
  • <復旧時のフィールド6>
  • <復旧時のフィールド7>
  • <復旧時のフィールド8>
  • <復旧時のフィールド9>
  • <復旧時のフィールド10>
  • <復旧時のフィールド11>
  • <復旧時のフィールド12>
  • <復旧時のフィールド13>
  • <復旧時のフィールド14>
  • <復旧時のフィールド15>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=18&other=example_template_with_changed_name|onchange|changing%20from%20min_max%20to%20onchange||||||1||||5|1|||1|1|0|1|1|0|0|1|field%20recovery%20example%202|field%20recovery%20example%203|1|8&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

アラートテンプレートと、テンプレートで使われているアラートを削除します。

書式:

• op=set (必須)
• op2=delete_alert_template (必須)
• id=<テンプレートID> (必須) テンプレートIDでなければいけません。

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38

モジュールテンプレートを削除します。

書式:

• op=set (必須)
• op2=delete_module_template (必須)
• id=<alert_template_module ID> (必須) alert_template_module のIDでなければい けません。

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38

モジュールテンプレートを削除します。

書式:

• op=set (必須)
• op2=delete_module_template_by_names (必須)
• id=<エージェント名> (必須)
• id2=<アラートテンプレート名> (必須)
• other=<連続パラメータ> (必須) 次の順番でデータを指定します。
  • <モジュール名> (必須)
  • <エージェントの別名の利用> (値は 0 または 1 です)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template_by_names&id=sample-agent&id2=test&other=memfree&apipass=1234&user=admin&pass=pandora

計画停止を停止します。

書式:

• op=set (必須)
• op2=stop_downtime (必須)
• id=<計画停止ID> (必須) 計画停止IDでなければいけません。

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1

Pandora FMS に新たなユーザを作成します。

書式:

• op=set (必須)
• op2=new_user (必須)
• id=<ユーザ名> (必須)
• other=<連続パラメータ> (必須) 次の順番でユーザ設定とデータを指定します。
  1. <フルネーム> (スペースは %20 に置き換えます)
  2. <名前>
  3. <名字>
  4. <ミドルネーム>
  5. <パスワード>
  6. <電子メールアドレス>
  7. <電話番号>
  8. <言語>
  9. <コメント>
  10. <自動更新時間>
  11. <デフォルトイベントフィルタ>
  12. <コンソールセクション>
  13. <セッション時間>

例 (書式を参照):

.../include/api.php?op=set&op2=new_user&id=id_nu&other=John%20J.%20Doe|John|Doe|Jay|1234|johndoe@example.com|5555555|en||30|||-1|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

指定した ID のユーザを指定したパラメータで更新します。

書式:

• op=set (必須)
• op2=update_user (必須)
• id=<ユーザ名> (必須) ユーザ名でなければいけません。
• other=<連続パラメータ> (必須) 次の順番で設定とデータを指定します。
  • <フルネーム>
  • <名前>
  • <名字>
  • <ミドルネーム>
  • <パスワード>
  • <電子メールアドレス>
  • <電話番号>
  • <言語>
  • <コメント>
  • <管理者>
  • <一画面の表示数>
  • <フラッシュグラフ>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_user&id=example_user_name&other=example_fullname||example_lastname||example_new_passwd|example_email||example_language|example%20comment|1|30|&other_mode=url_encode_separator_|

ID で指定したユーザを削除します。

書式:

• op=set (必須)
• op2=delete_user (必須)
• id=<ユーザID> (必須) 削除するユーザの ID です。

例 (書式を参照):

../include/api.php?op=set&op2=delete_user&id=md&apipass=1234&user=admin&pass=pandora

ユーザのパーミッションを削除します。

書式:

• op=set(必須)
• op2=delete_user_permission(必須)
• return_type=csv|json(必須)
• other=id profile(必須)

例

ユーザのパーミッションを削除します。 Json または CSV にて返すことができます。こ の戻り値は URL を介して指定します。

http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_permission&return_type=json&other=2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

ユーザグループへパーミッションを追加します。

書式:

• op=set(必須)
• op2=add_permission_user_to_group(必須)
• return_type=csv|json(必須)
• other=user id(必須)|group_id(必須)|profile id(必須)|No hierarchy(オプション)| profile id(オプション)

例

Json または CSV にて返すことができます。この戻り値は URL を介して指定します。

http://localhost/pandora_console/include/api.php?op=set&op2=add_permission_user_to_group&return_type=json&other=admin|0|1|1|20&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

ユーザを無効化・有効化します。

書式:

• op=set (必須)
• op2=enable_disable_user (必須)
• id=<ユーザ名> (必須) ユーザ名でなければいけません。
• other=<フラグ> (必須) 有効化する場合は 1、無効化する場合は 0 を指定します。

例

例1 (ユーザ 'example_name' を無効化)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

例2 (ユーザ 'example_name' を有効化)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

コマンドセンター（メタコンソール）のユーザをノードに同期します。

書式:

• op=set (必須)
• op2=meta_synch_user (必須)
• other=<連続パラメータ> (オプション):
  • <user_name_1,user_name_2,user_name_3..> (先頭および末尾にスペースを入れ ずにカンマで区切ったユーザ名, 必須)
  • <server_name> (必須)
  • <profile_mode(1-0)> (オプション)
  • <group_name> (オプション)
  • <profile_1,profile_2,profile_3> (最初と最後にスペースを入れずにカンマで 区切ったプロファイル, オプション)
  • <create_groups(1-0)> (オプション)

例

http://localhost/pandora_console/include/api.php?op=set&op2=meta_synch_user&apipass=1234&user=admin&pass=pandora&other=name1,name2|nodo1|0|||&other_mode=url_encode_separator_|

グループを作成します。

書式:

• op=set (必須)
• op2=create_group (必須)
• id=<グループ名> (必須) グループ名を指定します。
• other=<連続パラメータ> (必須) 次の順番で指定します。
  • <アイコン名>
  • <親グループID> (オプション)
  • <説明> (オプション)
  • <ACLの伝播> (オプション)
  • <アラートの無効化> (オプション)
  • <カスタムID> (オプション)
  • <連絡先> (オプション)
  • <その他> (オプション)
  • <グループ内の最大エージェント数> (必須, 0 は制限なしを意味します)
  • <パスワード付きでエージェントグループを作成> (オプション)

例

例1 (親グループ: Servers)

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name&other=applications|2&other_mode=url_encode_separator_|

例2 (親グループなし)

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name2&other=computer|&other_mode=url_encode_separator_|

例3 (パスワード “1234” かつ、グループ内のエージェント数制限 3 でエージェントグループを作成)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name&other=applications|2|||||||3|1234&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

グループの設定を更新します。

書式:

• op=set (必須)
• op2=update_group (必須)
• id=<グループID> (必須) グループIDを指定します。
• other=<連続パラメータ> (必須) 次の順番で指定します。
  • <グループ名>
  • <アイコン名>
  • <親グループID>
  • <説明>
  • <ACLの伝播>
  • <アラートの無効化>
  • <カスタムID>
  • <連絡先>
  • <その他>

例

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_group&id=example_group_id&other=New%20Name|application|2|new%20description|1|0|custom%20id||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

グループを削除します。

書式:

• op=set (必須)
• op2=update_group (必須)
• id=<グループID> (必須) グループIDを指定します。

例

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora

ユーザにプロファイルを追加します。

書式:

• op=set (必須)
• op2=add_user_profile (必須)
• id=<ユーザ名> (必須) ユーザ名でなければいけません。
• other=<連続パラメータ> (必須) 次の順番でグループの設定、プロファイルを指定します。
  • <グループ>
  • <プロファイル>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|

ユーザのプロファイルを削します。

書式:

• op=set (必須)
• op2=delete_user_profile (必須)
• id=<ユーザ名> (必須) ユーザ名でなければいけません。
• other=<連続パラメータ> (必須) 次の順番でグループおよびプロファイルを指定します。
  • <グループ>
  • <プロファイル>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|

新たなインシデントを作成します。

書式:

• op=set (必須)
• op2=new_incident (必須)
• other=<連続パラメータ> (必須) 次の順番でインシデントの設定とデータを指定します。
  • <タイトル>
  • <説明>
  • <作成者>
  • <優先度>
  • <状態>
  • <グループ>

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_incident&other=titulo|descripcion%20texto|Logfiles|2|10|12&other_mode=url_encode_separator_|

インシデントにコメントを追加します。

書式:

• op=set (必須)
• op2=new_note_incident (必須)
• id=<インシデントID> (必須) インシデントのIDです。
• id2=<ユーザ名> (必須) ユーザ名です。
• other=<コメント> (必須) URLエンコードされたコメントです。

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_note_incident&id=5&id2=miguel&other=una%20nota%20para%20la%20incidencia

全アラートを承諾します。

書式:

• op=set (必須)
• op2=validate_all_alerts (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts

ポリシーから作成されたアラートを承諾します。

書式:

• op=set (必須)
• op2=validate_all_policy_alerts (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts

指定したフィルタにマッチするすべてのイベントを承諾します。

書式:

• op=set (必須)
• op2=event_validate_filter (必須)
• other_mode=url_encode_separator_|(オプション)
• other=<連続パラメータ> (オプション) 次の順番で指定します。
  • <セパレータ>
  • <重要度> 0 から 4
  • <エージェント名>
  • <モジュール名>
  • <アラートテンプレート名>
  • <ユーザ>
  • < 最小レベルの数値間隔> UNIXタイムスタンプ
  • < 最大レベルの数値間隔> UNIXタイムスタンプ
  • <エージェントの別名の利用> (値は 0 または 1 です)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2

前述の API と似たものです。

書式:

• op=set (必須)
• op2=event_validate_filter_pro (必須)
• other_mode=url_encode_separator_| (オプション)
• other=<連続パラメータ> (オプション) 次の順番で指定します。
  • <セパレータ>
  • <重要度> 0 から 4
  • <エージェントID>
  • <モジュールID>
  • <エージェントモジュールアラートID>
  • <ユーザ>
  • <最小レベルの数値間隔> UNIXタイムスタンプ
  • <最大レベルの数値間隔> UNIXタイムスタンプ

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2

指定した ID のイベントを承諾します。

書式:

• op=set (必須)
• op2=validate_event_by_id (必須)
• id=<event_id> (必須) イベント ID です。

例

http://localhost/pandora_console/include/api.php?op=set&op2=validate_event_by_id&id=23&apipass=1234&user=admin&pass=pandora

テンプレートおよび、エージェントIDおよびモジュール名からモジュールを指定して、新たなアラートを適用します。

書式:

• op=set (必須)
• op2=new_alert_template (必須)
• id=<エージェント名> (必須)
• id2=<アラートテンプレート名> (必須)
• other_mode=url_encode_separator_| (オプション)
• other=<連続パラメータ> (必須) 次の順番で指定します。
  • <モジュール名> (必須)
  • <エージェントの別名の利用> (値は 0 または 1 です)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_alert_template&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree

アラートにアクションを追加します。

書式:

• op=set (必須)
• op2=alert_actions (必須)
• id=<エージェント名> (必須)
• id2=<アラートテンプレート名> (必須)
• other_mode=url_encode_separator_| (オプション)
• other=<連続パラメータ> (必須) 次の順番で指定します。
  • <モジュール名> (必須)
  • <アクション名> (必須)
  • <開始アラート数> (オプション)
  • <終了アラート数> (オプション)
  • <エージェントの別名の利用> (値は 0 または 1 です)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test|1|3

アラートにコマンドを追加します。

書式:

• op=set (必須)
• op2=alert_commands (必須)
• id=<コマンド名> (必須)
• other_mode=url_encode_separator_| (オプション)
• other=<連続パラメータ> (必須), 次の順番:
  • <command> (必須)
  • <id_group> (必須)
  • <description > (必須)
  • <internal > (オプション)
  • <field_description_1><field_value_1><field_description_2><field_value_2>…<field_description_n><field_value_n>

例

http://localhost/pandora_console/include/api.php?op=set&op2=alert_commands&id=PRUEBA1&other=command|0|Desc|1|des1|val1|des2|val2|des3|val3||val4|des5&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

新たなモジュールを作成します。

書式:

• op=set (必須)
• op2=new_module (必須)
• id=<エージェント名> (必須)
• id2=<新たなモジュール名> (必須)
• other_mode=url_encode_separator_| (オプション)
• other=<連続パラメータ> (必須) 次の順番で指定します。
  • <ネットワークモジュールの種類> (必須)
  • <アクション名> (必須)
  • <IP または URL> (必須)
  • <ポート> (オプション)
  • <説明> (オプション)
  • <最小値> (オプション)
  • <最大値> (オプション)
  • <データ保存倍率> (オプション)
  • <モジュールの間隔> (オプション)
  • <警告の最小値> (オプション)
  • <警告の最大値> (オプション)
  • <障害の最小値> (オプション)
  • <障害の最大値> (オプション)
  • <データの保存> (オプション)
  • <不明イベントの有効化> (バージョン 5 のみ)
  • <エージェントの別名の利用> (値は 0 または 1 です)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_module&id=miguel-portatil&id2=juanito&other_mode=url_encode_separator_|&other=remote_tcp_string|localhost|33|descripcion%20larga

モジュールを削除します。

書式:

• op=set (必須)
• op2=delete_module (必須)
• id=<エージェント名> (必須)
• id2=<モジュール名> (必須)

例 (書式を参照):

.../include/api.php?op=set&op2=delete_module&id=example&id2=example2&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_|

simulate パラメータ

エージェントが存在し、そのモジュールも存在するかどうかを確認したい場合は、最終的な削除を実行する前に、simulate パラメータを使用できます。 テスト呼び出しが正しくない場合、Pandora FMS API 1.0 は次のメッセージを返します: Parameter error.

例 (書式を参照):

.../include/api.php?op=set&op2=delete_module&id=agent_name_example&id2=module_name_example&other=simulate&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

エージェントのアラートを有効化します。

書式:

• op=set (必須)
• op2=enable_alert
• id=<エージェント名> (必須)
• id2=<モジュール名> (必須)
• other: アラートテンプレート名 (例: Warning イベント) (必須)

例

http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=garfio&id2=Status&other=Warning%20condition

エイリアスでエージェントのアラートを有効化します。

書式:

• op=set (必須)
• op2=enable_alert_alias
• id=<エージェントの別名> (必須)
• id2=<モジュール名> (必須)
• other: アラートテンプレート名 (p.e: 警告イベント) (必須)

例

http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert_alias&id=nova&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

エージェントのアラートを無効化します。

書式:

• op=set (必須)
• op2=disable_alert
• id=<エージェント名> (必須)
• id2=<モジュール名> (必須)
• other: アラートテンプレート名 (例: Warning イベント) (必須)

例

http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=garfio&id2=Status&other=Warning%20condition

エージェントのアラートを無効化します。

書式:

• op=set (必須)
• op2=disable_alert_alias
• id=<エージェントエイリアス> (必須)
• id2=<モジュール名> (必須)
• other: アラートテンプレート名 (例: 警告イベント) (必須)

例

http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert_alias&id=nova&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

enable_alert と同じです。

書式:

• op=set (必須)
• op2=enable_module_alerts
• id=<エージェント名> (必須)
• id2=<モジュール名> (必須)
• other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です)

例

http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=garfio&id2=Status

disable_alert と同じです。

書式:

• op=set (必須)
• op2=disable_module_alerts
• id=<エージェント名> (必須)
• id2=<モジュール名> (必須)
• other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です)

例

http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=garfio&id2=Status

モジュールを有効化します。

書式:

• op=set (必須)
• op2=enable_module
• id=<エージェント名> (必須)
• id2=<モジュール名> (必須)
• other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です)

例

http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=garfio&id2=Status

モジュールを無効化します。

書式:

• op=set (必須)
• op2=disable_module
• id=<エージェント名> (必須)
• id2=<モジュール名> (必須)
• other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です)

例

http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=garfio&id2=Status

コンポーネントから新たなネットワークモジュールを作成します。

書式:

• op=set (必須)
• op2=create_network_module_from_component (必須)
• id=<エージェント名> (必須)
• id2=<コンポーネント名> (必須)
• other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です)

例

http://localhost/pandora_console/include/api.php?op=set&op2=create_network_module_from_component&id=garfio&id2=OS%20Total%20process&apipass=1234&user=admin&pass=pandora

モジュールに値を追加します。この機能は、サーバに送信するデータを含む XML を生成 します。このデータはデータベースを更新するためのものです。

この API 呼び出しは、XML ファイルの生成を制御し、そのプロセスの状態をメッセージ で表示します。

書式:

• op=set (必須)
• op2=module_data (必須)
• id=<エージェントモジュールID> (必須)
• other: モジュールのデータとタイムスタンプ
  • dato: Pandora のデータタイプ
  • tiempo: タイムスタンプ、“now” を指定できます。

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_data&id=14&other_mode=url_encode_separator_|&other=123|now&apipass=1234&user=admin&pass=pandora

新たなモジュールグループを作成します。

書式:

• op=set (必須)
• op2=new_module_group (必須)
• id=<モジュールグループ名> (必須)

例

http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora

コマンドセンター (メタコンソール) からモジュールグループを同期します。

書式:

• op=set (必須)
• op2=module_group_synch (必須)
• other=<連続パラメータ> (必須) メタコンソールと同期するサーバの名前が必須です。
  • <server_name_1><server_name_2>…<server_name_n> (必須)

例

http://localhost/pandora_console/include/api.php?op=set&op2=module_group_synch&other=server_name1|server_name2|server_name3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

ローカルモジュールに設定を追加します。

書式:

• op=set (必須)
• op2=add_module_in_conf (必須)
• id=<エージェントID> (必須)
• id2=<モジュール名> (必須)
• other: conf ファイルに書くモジュール設定を base64 でエンコードしたもの (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

成功すると '0'、エラー時は '-1'、すでに存在する場合は '-2' を返します。

ローカルモジュールの設定を削除します。

書式:

• op=set (必須)
• op2=add_module_in_conf (必須)
• id=<エージェントID> (必須)
• id2=<モジュール名> (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&user=admin&pass=pandora&id=9043&id2=example_name

成功すると '0'、エラー時は '-1' を返します。

ローカルモジュールの設定を更新します。

書式:

• op=set (必須)
• op2=update_module_in_conf (必須)
• id=<エージェントID> (必須)
• id2=<モジュール名> (必須)
• other: conf ファイル内のモジュール設定を置き換える内容を、base64 でエンコー ドしたもの。(必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

変更が無い場合は '1'、成功すると '0'、エラー時は '-1'、存在しない場合は '-2' を 返します。

モジュール ID とカスタム ID の値をパラメータとして渡すことにより、カスタムID の値を設定または削除します。

書式:

• op=set (必須)
• op2=module_custom_id (必須)
• id=id_agent_module (必須)
• id2=カスタムIDの値、もしくは、削除する場合は何も指定しない (必須)

例

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_custom_id&id=5&id2=1521&apipass=1234&user=admin&pass=pandora

Pandora 内に新たなイベントを作成します。

書式:

• op=set (必須)
• op2=create_event (必須)
• other=<連続パラメータ> (必須) 次の順番でイベントデータを指定します:
  • < イベントテキスト > (必須、文字列)
  • < グループ ID > (必須、文字列)
  • < エージェント ID> (必須、数値)
  • < 状態 > 0 新規, 1 承諾済, 2 処理中
  • < ユーザ ID >(数値)
  • < イベントタイプ > 以下の値のいずれか:
    • unknown
    • alert_fired
    • alert_recovered
    • alert_ceased
    • alert_manual_validation
    • system
    • error
    • new_agent
    • configuration_change
    • going_unknown
    • going_down_critical
    • going_down_warning
    • going_up_normal
  • < 重要度 > 以下の値のいずれか:
    • 0 メンテナンス
    • 1 情報
    • 2 正常
    • 3 警告
    • 4 障害
    • 5 マイナー
    • 6 メジャー
  • < エージェントモジュール ID > (数値)
  • < alert_am ID> ( イベントにリンクしたアラートモジュール ID、数値)
  • < 障害手順 > (文字列)
  • < 警告手順 > (文字列)
  • < 不明手順 > (文字列)
  • < コメント > (文字列)
  • < 所有者ユーザ名 > (文字列)
  • < イベントソース > (文字列)
  • < タグ > (文字列)
  • < カスタムデータ > base64 でエンコードした JSON 形式でなければいけません
  • < サーバ ID > (コマンドセンター(メタコンソール)のみ) 子ノードの ID です。
  • <extra ID> (英数字、追加IDを持つ新しいイベントの処理ステータスを維持 を参照。)

例 (書式を参照):

作成するイベントの JSON は次の通りとします。

{"Answer to the Ultimate Question of Life, the Universe, and Everything": 42}

上記を base64 でエンコードし、次のように呼び出しに含めます。

../include/api.php?op=set&op2=create_event&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora&other=Event_name|0|1|0|admin|alert_fired|4|1|||||comment|admin||tags|eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=||12

イベントにコメントを追加します。

書式:

• op=set (必須)
• op2=add_event_comment (必須)
• id= < イベントID > (必須、数値)
• other= <連続パラメータ> (必須) 次の順番でイベントデータを指定します:
  • < コメント > (必須、文字列)
  • < セパレータ> (オプション、コマンドセンター(メタコンソール)で使用)。
  • < ノードID > (オプション、コマンドセンター(メタコンソール)で使用)。
• url_encode_separator_< セパレータ >:呼出書式を参照

例 (呼出書式を参照)

• ノード (イベント ID は 7 、コメントは comment):

../include/api.php?op=set&op2=add_event_comment&id=7&other=comment&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

• コマンドセンター (メタコンソール) (NG 766 以降、イベント識別子は 1、コメントは comment、ノード識別子は 3):

../include/api.php?op=set&op2=add_event_comment&id=1&other=comment|3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

API を通してイベントを更新します。

書式:

• op=set (必須)
• op2=event (必須)
• id=event_id (必須)
• other=<連続パラメータ> (必須) field.value フォーマットおよび url_encode_separator (例: |) で分割した、更新するイベントフィールド
• <comment> (必須)