Difference between revisions of "Pandora: Documentation ja: Annex ExternalAPI"

From Pandora FMS Wiki
Jump to: navigation, search
<
()
(set add_event_comment)
 
(404 intermediate revisions by 4 users not shown)
Line 33: Line 33:
 
現時点では、セキュリティはツールにアクセスする IP アドレスリストに基づいています。以下に示す画面のように Pandora コンソールの設定オプションで設定できます。
 
現時点では、セキュリティはツールにアクセスする IP アドレスリストに基づいています。以下に示す画面のように Pandora コンソールの設定オプションで設定できます。
  
'''*''' 文字を設定すると、IP による ACL チェックは省略され、プロトコルおよび環境によるセキュリティのみに下がります。同様に、'''*'''' 文字はワイルドカードとして利用できます。例えば、183.234.33.* などです。
+
'''*''' 文字を設定すると、IP による ACL チェックは省略され、プロトコルおよび環境によるセキュリティのみに下がります。
  
 
[[image:Screnshot of api acl list setup.png|500px]]
 
[[image:Screnshot of api acl list setup.png|500px]]
Line 42: Line 42:
  
 
*''APIパスワード'': コンソールでAPIパスワードを設定します。これは次の設定画面 (システム管理(Administration) > 設定(Setup))で設定できます。
 
*''APIパスワード'': コンソールでAPIパスワードを設定します。これは次の設定画面 (システム管理(Administration) > 設定(Setup))で設定できます。
 
注意: 4.0.2 より前のバージョンでは、このパラメータは、''パスワード(pass)'' です。
 
  
 
<center><br>
 
<center><br>
 
[[image:Api_password.png|650px]]
 
[[image:Api_password.png|650px]]
 
</center><br>
 
</center><br>
 +
 +
注意: 4.0.2 より前のバージョンでは、このパラメータは、''パスワード(pass)'' です。
  
 
APIにアクセスするには、Pandora FMS の正しいユーザとパスワードも必要です。
 
APIにアクセスするには、Pandora FMS の正しいユーザとパスワードも必要です。
Line 65: Line 65:
 
ここでは、API パスワードが ''1234'' で、アクセスユーザが ''admin''、そのパスワードが ''pandora'' とします。
 
ここでは、API パスワードが ''1234'' で、アクセスユーザが ''admin''、そのパスワードが ''pandora'' とします。
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
アクセスできるための条件は次の通りです。
 
アクセスできるための条件は次の通りです。
Line 130: Line 130:
 
この呼び出し例では、"Servers" グループのモジュール数を取得します。
 
この呼び出し例では、"Servers" グループのモジュール数を取得します。
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=extension&ext_name=module_groups&ext_function=groupmodules&id=Servers&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=extension&ext_name=module_groups&ext_function=groupmodules&id=Servers&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
=== API 関数 ===
 
=== API 関数 ===
Line 191: Line 191:
 
返される情報はログイン画面から確認することができるものであるため、セキュリティ上の脆弱性にはなりません。
 
返される情報はログイン画面から確認することができるものであるため、セキュリティ上の脆弱性にはなりません。
  
  http://127.0.0.1/pandora_console/include/api.php?info=version
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?info=version</nowiki>
  
 
返される値は、''Pandora FMS v5.0 - PC131015'' といったものです。
 
返される値は、''Pandora FMS v5.0 - PC131015'' といったものです。
Line 208: Line 208:
 
以下の例では、OK を返します。
 
以下の例では、OK を返します。
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=test
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=test</nowiki>
  
 
====get all_agents====
 
====get all_agents====
Line 228: Line 228:
 
この例では、OS ID が 1、グループ ID が 2、状態が警告、エージェント名に 'j' を含み、関連付けられたポリシーが 2 の全エージェントを返します。
 
この例では、OS ID が 1、グループ ID が 2、状態が警告、エージェント名に 'j' を含み、関連付けられたポリシーが 2 の全エージェントを返します。
  
  CSV の例: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
+
  CSV の例: <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  JSON の例: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
+
  JSON の例: <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
====get module_last_value====
 
====get module_last_value====
Line 244: Line 244:
 
=====例=====
 
=====例=====
  
  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_|
+
  <nowiki>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_|</nowiki>
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62</nowiki>
  
 
====get agent_module_name_last_value====
 
====get agent_module_name_last_value====
Line 262: Line 262:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=miguel-portatil&id2=cpu_user
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=miguel-portatil&id2=cpu_user</nowiki>
  
 
====get agent_module_name_last_value_alias====
 
====get agent_module_name_last_value_alias====
Line 282: Line 282:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
 
====get module_value_all_agents====
 
====get module_value_all_agents====
Line 294: Line 294:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_value_all_agents&id=example_module_name
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_value_all_agents&id=example_module_name</nowiki>
  
 
====get agent_modules====
 
====get agent_modules====
Line 309: Line 309:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|</nowiki>
 
 
  
 
====get module_id====
 
====get module_id====
Line 325: Line 324:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
 
====get locate_agent====
 
====get locate_agent====
Line 341: Line 340:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?api.php?op=get&op2=locate_agent&return_type=csv&id=Pepito&other_mode=url_encode_separator_|
+
  <nowiki>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</nowiki>
  
 
====get policies====
 
====get policies====
Line 355: Line 354:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|</nowiki>
  
 
====get tree_agents====
 
====get tree_agents====
Line 505: Line 504:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;</nowiki>
  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_|
+
  <nowiki>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_|</nowiki>
  
 
====get module_data====
 
====get module_data====
Line 524: Line 523:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
 
====get graph_module_data====
 
====get graph_module_data====
Line 544: Line 543:
 
=====例=====
 
=====例=====
  
  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_|
+
  <nowiki>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_|
 +
</nowiki>
  
 
====get events====
 
====get events====
 +
 +
other パラメータでフィルタしたイベントの一覧を返します。
  
 
書式:
 
書式:
Line 568: Line 570:
 
:*&lt;表示オフセット&gt;
 
:*&lt;表示オフセット&gt;
 
:*&lt;形式オプション [total|more_criticity]&gt; (total - 該当レコード数を返す, more_criticity - 該当レコード中の重要度の最も大きい値を返す)
 
:*&lt;形式オプション [total|more_criticity]&gt; (total - 該当レコード数を返す, more_criticity - 該当レコード中の重要度の最も大きい値を返す)
 +
:*&lt;グループID&gt;
 +
:*&lt;タグ&gt;
 
:*&lt;イベントタイプ&gt; unknown, alert_fired, alert_recovered など(部分文字列も可) または、not_normal
 
:*&lt;イベントタイプ&gt; unknown, alert_fired, alert_recovered など(部分文字列も可) または、not_normal
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&other_mode=url_encode_separator_|&return_type=csv&other=;|2|SERVER|CPU|template_alert00||1274715715|127471781&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&other_mode=url_encode_separator_|&return_type=csv&other=;|2|SERVER|CPU|template_alert00||1274715715|127471781&apipass=1234&user=admin&pass=pandora</nowiki>
 
 
=====取得情報の例=====
 
 
 
例えば、次のような情報が得られます。
 
 
 
<pre>
 
951140;3998;0;14;0;2012-06-23 22:51:28;Module CheckPandora (0.00) is going to
 
CRITICAL;1340484688;going_up_critical;8176;0;4;;;RemoteAgent;Aerin;transmit;Going down to critical
 
state;http://firefly.artica.es/pandora_demo//images/b_red.png;Critical;http://firefly.artica.es/pandora_demo//
 
images/status_sets/default/severity_critical.png
 
</pre>
 
 
 
取得したデータの多くは、データベースの対応テーブルに保存されている値そのものです。
 
試しに、SQL マネージャーから次のクエリを実行してみてください。
 
 
 
select * from tevento order by id_evento DESC limit 100;
 
 
 
取得したデータの各フィールドは次の通り;
 
 
 
* フィールド1 - イベントID (自動インクリメント)
 
* フィールド2 - エージェントID
 
* フィールド3 - イベントを承諾したユーザーのユーザーID
 
* フィールド4 - グループID
 
* フィールド5 - 状態 (0 - 新規, 1 - 承諾済み, など.. 詳細は、状態コードの記述を参照)
 
* フィールド6 - タイムスタンプ (可読文字列)
 
* フィールド7 - イベント文字列
 
* フィールド8 - unixタイムスタンプ (1970年1月1日からの経過秒数)
 
* フィールド9 - イベントタイプ (イベントタイプを表す固定文字列)
 
* フィールド10 - モジュールID (イベントが発生したモジュールに割り当てられた数値。例えば new_agent の場合など、イベントタイプによっては 0 が返る。この後記載している通り、取得データにはモジュール名も含まれるので、追加で API を呼んでモジュールID をモジュール名に変換する必要はない)
 
* フィールド11- アラートID。モジュールID と同様にイベントタイプによっては 0 が返る
 
* フィールド12 - 重要度 (数値、詳細は、重要度の記述を参照)
 
* フィールド13 - ユーザーコメント (ユーザー指定があった場合)
 
* フィールド14 - タグ
 
 
 
これ以降は、同テーブル外からの追加情報;
 
 
 
* フィールド15 - エージェント名
 
* フィールド16 - グループ名
 
* フィールド17 - グループに対するイメージファイル名
 
* フィールド18 - イベントタイプに対する説明
 
* フィールド19 - 障害状態を示す赤いボールイメージの URL
 
* フィールド20 - (フィールド12の)重要度に対する説明
 
* フィールド21 - 重要度を表すイメージの URL
 
  
 
====get all_alert_templates====
 
====get all_alert_templates====
Line 629: Line 590:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;</nowiki>
  
 
====get module_groups====
 
====get module_groups====
Line 641: Line 602:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;</nowiki>
  
 
====get plugins====
 
====get plugins====
Line 653: Line 614:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;</nowiki>
  
 
====get tags====
 
====get tags====
Line 667: Line 628:
 
この例では、システムの全てのタグを返します。
 
この例では、システムの全てのタグを返します。
  
  http://localhost/pandora_console/include/api.php?op=get&op2=tags&return_type=csv
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=tags&return_type=csv</nowiki>
  
 
====get module_from_conf====
 
====get module_from_conf====
Line 679: Line 640:
  
 
=====例=====
 
=====例=====
  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
+
  <nowiki>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</nowiki>
  
 
モジュールが見つからない場合は、空の文字列を返します。
 
モジュールが見つからない場合は、空の文字列を返します。
Line 694: Line 655:
  
 
=====例=====
 
=====例=====
  http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
グループ ID が 0 の場合、モジュールの全数が返ります。
  
 
====get total_agents====
 
====get total_agents====
Line 707: Line 670:
  
 
=====例=====
 
=====例=====
  http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
====get agent_name====
 
====get agent_name====
Line 719: Line 682:
  
 
=====例=====
 
=====例=====
  http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
====get agent_alias====
 
====get agent_alias====
Line 730: Line 693:
 
*op2=agent_alias (必須)
 
*op2=agent_alias (必須)
 
*id=&lt;エージェントID&gt; (必須)
 
*id=&lt;エージェントID&gt; (必須)
 +
*id2=<ノードID> (メタコンソールでは必須、ノードでは不要)
  
 
=====例=====
 
=====例=====
  http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora
+
 
 +
ノード:
 +
 
 +
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
メタコンソール:
 +
 
 +
<nowiki>http://localhost/pandora_console/enterprise/meta/include/api.php?op=get&op2=agent_alias&id=1&id2=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
====get module_name====
 
====get module_name====
Line 744: Line 715:
  
 
=====例=====
 
=====例=====
  http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
====get alert_action_by_group====
 
====get alert_action_by_group====
Line 757: Line 728:
  
 
=====例=====
 
=====例=====
  http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get event_info====
+
====get alert_actions====
 +
 
 +
アラートアクションの一覧を取得します。
  
 
書式:
 
書式:
 
*op=get (必須)
 
*op=get (必須)
*op2=event_info (必須)
+
*op2=alert_actions (必須)
*id=&lt;イベントID&gt; (必須)
+
*return_type=&lt;return type&gt; (必須) 'csv' または 'json' を指定できます。
 +
*other=&lt;連続パラメータ&gt; (オプション):
 +
:*&lt;action_name&gt; (オプション)
 +
:*&lt;separator&gt; (オプション)
  
 
=====例=====
 
=====例=====
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions&apipass=1234&user=admin&pass=pandora&other=Create|&other_mode=url_encode_separator_|&return_type=json</nowiki>
  
====get tactical_view====
+
====get alert_actions_meta====
 +
{{メタコンソール}}
 +
メタコンソールから、ノードのアラートアクションの一覧を取得します。
  
 
書式:
 
書式:
 
*op=get (必須)
 
*op=get (必須)
*op2=tactical_view (必須)
+
*op2=alert_actions_meta (必須)
 +
*return_type=&lt;return type&gt; (必須) 'csv' または 'json' を指定できます。
 +
*other=&lt;連続パラメータ&gt; (オプション):
 +
:*&lt;server_name&gt; (オプション)
 +
:*&lt;action_name&gt; (オプション)
 +
:*&lt;separator&gt; (オプション)
  
 
=====例=====
 
=====例=====
  http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora
+
  <nowiki>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</nowiki>
  
====get pandora_servers====
+
====get all_alert_commands====
バージョン 5.0 かそれ以降
+
 
 +
全アラートコマンドを返します。
  
 
書式:
 
書式:
 
*op=get (必須)
 
*op=get (必須)
*op2=pandora_servers (必須)
+
*op2=all_alert_commands (必須)
 
*other=cvs_separator (オプション)
 
*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
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=all_alert_commands&return_type=csv&other=$&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====get event_info====
  
次の順番で値が返ります。
+
書式:
 +
*op=get (必須)
 +
*op2=event_info (必須)
 +
*id=&lt;イベントID&gt; (必須)
 +
 
 +
=====例=====
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====get tactical_view====
 +
 
 +
書式:
 +
*op=get (必須)
 +
*op2=tactical_view (必須)
 +
 
 +
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====get pandora_servers====
 +
バージョン 5.0 かそれ以降
 +
 
 +
書式:
 +
*op=get (必須)
 +
*op2=pandora_servers (必須)
 +
*other=cvs_separator (オプション)
 +
 
 +
=====Example=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
次の順番で値が返ります。
 
*サーバ名
 
*サーバ名
 
*状態 (1 - 稼働, 0 - 停止)
 
*状態 (1 - 稼働, 0 - 停止)
Line 813: Line 827:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
 
====get gis_agent====
 
====get gis_agent====
Line 828: Line 842:
 
=====例=====
 
=====例=====
  
http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1
+
<nowiki>http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1</nowiki>
  
 
====get special_days====
 
====get special_days====
Line 843: Line 857:
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?apipass=caca&user=admin&pass=pandora&op=get&op2=special_days
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=special_days</nowiki>
  
 
====get module_properties====
 
====get module_properties====
Line 914: Line 928:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  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
+
  <nowiki>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</nowiki>
  
 
====get module_properties_by_name====
 
====get module_properties_by_name====
Line 932: Line 946:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  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
+
  <nowiki>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</nowiki>
  
 
====get module_properties_by_alias====
 
====get module_properties_by_alias====
Line 950: Line 964:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
 
====get module_graph====
 
====get module_graph====
Line 965: Line 979:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
 
====get all_planned_downtimes====
 
====get all_planned_downtimes====
Line 985: Line 999:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  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
+
  <nowiki>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</nowiki>
  
 
====get planned_downtimes_items====
 
====get planned_downtimes_items====
Line 1,006: Line 1,020:
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  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
+
  <nowiki>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</nowiki>
  
 
====get id_group_agent_by_name====
 
====get id_group_agent_by_name====
Line 1,021: Line 1,035:
  
 
=====例=====
 
=====例=====
  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
+
  <nowiki>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</nowiki>
  
 
====get id_group_agent_by_alias====
 
====get id_group_agent_by_alias====
Line 1,035: Line 1,049:
  
 
=====例=====
 
=====例=====
  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
+
  <nowiki>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</nowiki>
  
 
====get group_agent_by_name====
 
====get group_agent_by_name====
Line 1,049: Line 1,063:
  
 
=====例=====
 
=====例=====
  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
+
  <nowiki>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</nowiki>
  
 
====get group_agent_by_alias====
 
====get group_agent_by_alias====
Line 1,063: Line 1,077:
  
 
=====例=====
 
=====例=====
  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
+
  <nowiki>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</nowiki>
  
===設定===
+
====get group_id_by_name====
 +
>= 7.0NG
 +
 
 +
名前からグループ ID を返します。
 +
 
 +
書式:
 +
* op=get
 +
* op2=group_id_by_name
 +
* other=<単一パラメータ> (必須):
 +
:* <グループ名>
  
データを送信します。
+
=====例=====
 +
<nowiki>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</nowiki>
  
====set new_agent====
+
====get get_timezone====
 +
>= 7.0NG
  
パラメータで指定した内容で新たなエージェントを作成します。
+
Pandora に設定されているタイムゾーンを返します。
  
 
書式:
 
書式:
 +
* op=get
 +
* op2=timezone
  
*op=set (必須)
+
=====例=====
*op2=new_agent (必須)
+
<nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone</nowiki>
*other=&lt;連続したパラメータ&gt; (必須) エージェントの設定とデータを次の順番に指定します。
+
 
 +
====get cluster_status====
 +
>= 7.0
 +
 
 +
ID ごとのクラスタ状態を返します。
 +
 
 +
*op=get
 +
*op2=cluster_status
 +
*id=<クラスタID>
 +
 
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_status&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
:*&lt;エージェント名&gt;
+
====get cluster_id_by_name====
:*&lt;IP&gt;
+
>= 7.0
:*&lt;親エージェントのID&gt;
 
:*&lt;グループID&gt;
 
:*&lt;関連障害検知抑制&gt;
 
:*&lt;関連障害検知抑制モジュール&gt;
 
:*&lt;間隔(秒)&gt;
 
:*&lt;OSのID&gt;
 
:*&lt;サーバ名&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;学習モード&gt;
 
:*&lt;無効化&gt;
 
:*&lt;説明&gt;
 
  
=====例=====
+
名前からクラスタの ID を返します。
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_agent&other=agente_nombre|1.1.1.1|0|4|0|30|8|miguel-portatil||0|0|la%20descripcion&other_mode=url_encode_separator_|
+
*op=get
 +
*op2=cluster_id_by_name
 +
*id=<クラスタ名>
  
*注意: ''alias_as_name'' が 1 の場合はエージェント名は別名と同じです。0 の場合はエージェント名は自動的に生成されます。
+
  <nowiki>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</nowiki>
  
====set update_agent====
+
====get agents_id_name_by_cluster_id====
 +
>= 7.0
  
パラメータで渡したデータで、新たなエージェントを更新します。
+
クラスタ ID から、ID => クラスタエージェント名を返します。
  
書式:
+
*op=get
 +
*op2=agents_id_name_by_cluster_id
 +
*id=<クラスタID>
  
*op=set (必須)
+
  <nowiki>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</nowiki>
*op2=update_agent (必須)
 
*id=&lt;エージェントID&gt; (必須)
 
*other=&lt;連続パラメータ&gt; (必須) エージェントの設定データで次の順番で設定します。
 
  
:*&lt;エージェント名&gt;
+
====get agents_id_name_by_cluster_name====
:*&lt;ip&gt;
+
>= 7.0
:*&lt;親ID&gt;
 
:*&lt;グループID&gt;
 
:*&lt;関連障害検知抑制&gt;
 
:*&lt;間隔(秒)&gt;
 
:*&lt;OSのID&gt;
 
:*&lt;サーバ名&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;学習モード&gt;
 
:*&lt;無効化&gt;
 
:*&lt;説明&gt;
 
  
=====例=====
+
クラスタ名から、ID => クラスタエージェント名を返します。
  
http://127.0.0.1/pandora_console/include/api.php?id=5&op=set&op2=update_agent&other=agente_nombre|1.1.1.1|0|4|0|30|8|10||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
*op=get
 +
*op2=agents_id_name_by_cluster_name
 +
*id=<クラスタ名>
  
====set delete_agent====
+
  <nowiki>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</nowiki>
  
指定した名前のエージェントを削除します。
+
====get modules_id_name_by_cluster_id====
 +
>= 7.0
  
書式:
+
クラスタ ID から、ID => クラスタエージェントの全モジュール名を返します。
*op=set (必須)
 
*op2=delete_agent (必須)
 
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
 
  
=====例=====
+
*op=get
 +
*op2=modules_id_name_by_cluster_id
 +
*id=<クラスタID>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo
+
  <nowiki>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</nowiki>
  
====set create_module_template====
+
====get modules_id_name_by_cluster_name====
 +
>= 7.0
  
id に指定したテンプレート、other に指定したエージェント、モジュール ID から、アラートを作成します。
+
クラスタ名から、ID => クラスタエージェントの全モジュール名を返します。
  
書式:
+
*op=get
*op=set (必須)
+
*op2=modules_id_name_by_cluster_name
*op2=create_module_template (必須)
+
*id=<クラスタ名>
*id=&lt;テンプレートID&gt; (必須) テンプレートIDでなければいけません。
 
*other=&lt;id_module&gt;|&lt;id_agent&gt;
 
  
=====例=====
+
  <nowiki>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</nowiki>
  
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
+
====get cluster_items====
 +
>= 7.0
  
====set apply_module_template====
+
クラスタ ID から、アイテムID => (name,id,module_agent,type,pcrit,pwarn) のフォーマットで json オブジェクトの要素を返します。
  
モジュールテンプレートをエージェントへ適用します。
+
pcrit: % for the critic state if its AA or 1 o 0 if its AP
  
モジュールテンプレートは、ネットワークモジュールを集めたものです。このテンプレートは、直接エージェントに適用することができ、モジュールを一つ一つ追加する必要はありません。
+
pwarn: % for the warning state if its AA or null if its AP
  
書式:
+
*op=get
*op=set (必須)
+
*op2=cluster_items
*op2=apply_module_template (必須)
+
*id=<クラスタID>
*id&lt;id_template&gt; (必須) 適用されるテンプレートの ID
 
*id2&lt;id_agente&gt; (必須) モジュールが作成されるエージェントの ID
 
  
=====例=====
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_items&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
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
+
====get policy====
 +
>= 7.0NG. 725
  
====set create_network_module====
+
ポリシーから全データを返します。ポリシー ID が指定されていない場合は、全ポリシーから全データを返します。
  
指定のパラメータでネットワークモジュールを作成します。
+
書式:
 +
* op=get
 +
* op2=policy
 +
* id=<ポリシーID> (オプション)
 +
* return_type=(json, csv, string).
 +
 
 +
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 +
 
 +
====get collections_policy====
 +
>= 7.0NG. 725
 +
 
 +
ポリシーの全コレクションを返します。ポリシー ID が指定されていない場合は、全ポリシーの全コレクションを返します。
 +
 
 +
書式:
 +
* op=get
 +
* op2=collections_policy
 +
* id=<ポリシーID> (オプション)
 +
* return_type=(json, csv, string).
 +
 
 +
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 +
 
 +
====get plugins_policy====
 +
>= 7.0NG. 725
 +
 
 +
ポリシーの全プラグインを返します。ポリシー ID が指定されていない場合は、全ポリシーの全プラグインを返します。
 +
 
 +
書式:
 +
* op=get
 +
* op2=plugins_policy
 +
* id=<ポリシーID> (オプション)
 +
* return_type=(json, csv, string).
 +
 
 +
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 +
 
 +
====get inventory_policy====
 +
>= 7.0NG. 725
 +
 
 +
ポリシーのインベントリモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全インベントリモジュールを返します。
  
 
書式:
 
書式:
 +
* op=get
 +
* op2=inventory_policy
 +
* id=<ポリシーID> (オプション)
 +
* return_type=(json, csv, string).
  
*op=set (必須)
+
=====例=====
*op2=create_network_module (必須)
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2</nowiki>
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
+
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定するモジュール設定パラメータです。
+
====get unlinking_policy====
:*&lt;モジュール名&gt;
+
>= 7.0NG. 725
:*&lt;無効化&gt;
+
 
:*&lt;モジュールタイプID&gt;
+
ポリシーの全未リンクモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全未リンクモジュールを返します。
:*&lt;モジュールグループID&gt;
+
 
:*&lt;警告の最小値&gt;
+
書式:
:*&lt;警告の最大値&gt;
+
* op=get
:*&lt;警告の文字列&gt;
+
* op2=unlinking_policy
:*&lt;障害の最小値&gt;
+
* id=<ポリシーID> (オプション)
:*&lt;障害の最大値&gt;
+
* return_type=(json, csv, string).
:*&lt;障害の文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;ヒストリーデータ&gt;
 
:*&lt;対象IP&gt;
 
:*&lt;TCPポート&gt;
 
:*&lt;snmpコミュニティ&gt;
 
:*&lt;snmp OID&gt;
 
:*&lt;モジュール間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;最小&gt;
 
:*&lt;最大&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
  
 
=====例=====
 
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_network_module&id=pepito&other=prueba|0|7|1|0|0|0|0|0|1|127.0.0.1|0||0|180|0|0|0||latency%20ping&other_mode=url_encode_separator_|
+
====get alerts_policy====
 +
>= 7.0NG. 725
  
====set create_plugin_module====
+
次の点を考慮して、ポリシーのアラートを返します。
  
指定のパラメータでプラグインモジュールを作成します。
+
* ポリシー ID が指定されていれば、ポリシーのアラートを返します。そうでなければ、全ポリシーの全アラートを返します。
 +
* アラートのタイプを指定されている場合: (オプションは 3つあります)
 +
** 0: すべてを表示します(デフォルト)
 +
** 1: 通常アラートのみ表示します
 +
** 2: 外部アラートのみ表示します
  
 
書式:
 
書式:
 +
* op=get
 +
* op2=alerts_policy
 +
* id=<ポリシーID> (オプション)
 +
* id2= 0:すべて(デフォルト), 1:通常, 2:外部
 +
* return_type=(json, csv, string).
 +
 +
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id2=2.</nowiki>
 +
 +
====get alerts_actions_policy====
 +
>= 7.0NG. 725
 +
 +
以下を考慮して、ポリシーのアラートの全アクションを返します。
 +
 +
* ポリシー ID が指定されている場合は、そのポリシーのアラートのアクションを返します。指定されていない場合は、全ポリシーの全アラートの全アクションを返します。
 +
* アラート ID が指定されている場合は、そのアラートのアクションを返します。
 +
 +
書式:
 +
* op = get
 +
* op2 = alerts_actions_policy
 +
* id = <ポリシーID> (オプション)
 +
* id2 = <ポリシーアラートID> (オプション)
 +
* return_type=(json, csv, string).
 +
 +
=====例=====
 +
<nowiki>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</nowiki>
 +
 +
====get agents_policy====
 +
>= 7.0NG. 725
 +
 +
ポリシーの全エージェントを返します。ポリシー ID が指定されていない場合は、全ポリシーの全エージェントを返します。
 +
 +
書式:
 +
* op = get
 +
* op2 = agents_policy
 +
* id = <ポリシーID> (オプション)
 +
* return_type = (json, csv, string).
 +
 +
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agents_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 +
 +
====get groups_policy====
 +
>= 7.0NG. 725
 +
 +
ポリシーの全グループを返します。ポリシー ID が指定されていない場合は、全ポリシーの全グループを返します。
 +
 +
書式:
 +
* op = get
 +
* op2 = groups_policy
 +
* id = <ポリシーID> (オプション)
 +
* return_type = (json, csv, string).
 +
 +
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=groups_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2</nowiki>
 +
 +
====get queue_policy====
 +
>= 7.0NG. 725
 +
 +
ポリシーのキューを返します。ポリシー ID が指定されていない場合は、全ポリシーの全キューを返します。
 +
 +
書式:
 +
* op = get
 +
* op2 = queue_policy
 +
* id = <ポリシーID> (オプション)
 +
* return_type = (json, csv, string).
  
*op=set (必須)
 
*op2=create_plugin_module (必須)
 
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定を指定します。
 
:*&lt;モジュール名&gt;
 
:*&lt;無効化&gt;
 
:*&lt;モジュールタイプID&gt;
 
:*&lt;モジュールグループID&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;ヒストリーデータ&gt;
 
:*&lt;対象IP&gt;
 
:*&lt;TCPポート&gt;
 
:*&lt;snmp コミュニティ&gt;
 
:*&lt;snmp OID&gt;
 
:*&lt;モジュール間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;最小値&gt;
 
:*&lt;最大値&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;プラグインID&gt;
 
:*&lt;プラグインユーザ&gt;
 
:*&lt;プラグインパスワード&gt;
 
:*&lt;プラグインパラメータ&gt;
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 のみ)
 
:*&lt;マクロ&gt; (バージョン 5 以降のみ) base 64 でエンコードされた JSON 文字列である必要があります。内容は、次のプロパティでまとめたオブジェクトでなければいけません。
 
:**'"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。
 
:**''"desc"'': マクロを表す名前。
 
:**''"help"'': マクロの説明。
 
:**''"value"'': マクロの値。
 
:**''"hide"'': マクロの値を隠す場合は "1" に設定します。(パスワードの記載に便利です)
 
:例
 
{
 
  "1": {
 
    "macro": "_field1_",
 
    "desc": "Target&#x20;IP",
 
    "help": "",
 
    "value": "192.168.0.1",
 
    "hide": ""
 
  },
 
  "2": {
 
    "macro": "_field2_",
 
    "desc": "Port",
 
    "help": "",
 
    "value": "80",
 
    "hide": ""
 
  }
 
}
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロを一つのプロパティで表した base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" です。
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
 
 
=====例=====
 
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_plugin_module&id=pepito&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|2|admin|pass|-p%20max&other_mode=url_encode_separator_|
+
====get traps====
 +
>= 7.0NG. 728
  
====set create_data_module====
+
指定されたソーストラップを返します。また、タイムスタンプやその他のデータをフィルタリングすることもできます。
  
指定したパラメータでモジュールを作成します。
+
書式:
 +
* op = get
 +
* op2 = traps
 +
* other=<オプションパラメータ>:
 +
:* <timestamp>
 +
:* <limit>
 +
:* <offset>
 +
:* <status>
 +
:* <oid_custom>
 +
 
 +
=====例=====
 +
<nowiki>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</nowiki>
 +
 
 +
====get event_responses====
  
{{warning|このコマンドにてデータベースにモジュールデータを追加できますが、モジュールに関連づけられたエージェントの設定ファイルの編集はできません。}}
+
Pandora FMS でユーザがアクセスするイベント応答の一覧を返します。
  
 
書式:
 
書式:
 
+
*op=get (必須)
*op=set (必須)
+
*op2=event_reponses (必須)
*op2=create_data_module (必須)
+
*return_type=csv|json (必須)
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
 
*other=&lt;連続パラメータ&gt; (必須) モジュールの設定とデータを次の順番で指定します。
 
:*&lt;モジュール名&gt;
 
:*&lt;無効化&gt;
 
:*&lt;モジュールタイプID&gt;
 
:*&lt;説明&gt;
 
:*&lt;モジュールグループID&gt;
 
:*&lt;最小値&gt;
 
:*&lt;最大値&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告の文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害の文字列&gt;
 
:*&lt;データの保存&gt;
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
  
 
=====例=====
 
=====例=====
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_data_module&id=pepito&other=prueba|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0&other_mode=url_encode_separator_|
+
この例では、csv フォーマットで全システムイベント応答を返します。
  
====set create_SNMP_module====
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====get users====
 +
 
 +
Pandora FMS のユーザ一覧を返します。
 +
 
 +
書式:
 +
*op=get (必須)
 +
*op2=users (必須)
 +
*return_type=csv|json (必須)
 +
 
 +
=====例=====
 +
 
 +
この例では、全ユーザを CSV フォーマットで返します。
 +
 
 +
<nowiki>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_&</nowiki>
 +
 
 +
====get list all user====
 +
{{metaconsole_ja}}
 +
 
 +
全 Pandora FMS ユーザ一覧を出力します。
 +
 
 +
書式:
 +
*op=get (必須)
 +
*op2=list_all_user(必須)
 +
*return_type=csv|json (必須)
 +
 
 +
=====例=====
 +
 
 +
Json または CSV にて返すことができます。この戻り値は URL を介して指定します。
 +
応答タイプのみの指定で、その他変数は使用しません。
 +
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====get info user name====
 +
{{metaconsole_ja}}
  
SNMP モジュールを作成します。
+
ユーザデータの一覧を返します。
  
 
書式:
 
書式:
*op=set (必須)
+
*op=get (必須)
*op2=create_snmp_module (必須)
+
*op2=list_all_user(必須)
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
+
*return_type=csv|json (必須)
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定するモジュールの設定とデータです。
+
*other= usernarme (必須)
:*&lt;モジュール名&gt;
 
:*&lt;無効化&gt;
 
:*&lt;モジュールタイプID&gt;
 
:*&lt;モジュールグループID&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告の文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害の文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;データの保存&gt;
 
:*&lt;対象IP&gt;
 
:*&lt;モジュールのポート&gt;
 
:*&lt;SNMPバージョン&gt;
 
:*&lt;SNMPコミュニティ&gt;
 
:*&lt;SNMP OID&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;最小値&gt;
 
:*&lt;最大値&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;SNMPv3 暗号化手法 [AES|DES]&gt;
 
:*&lt;SNMPv3 暗号化パスワード&gt;
 
:*&lt;SNMPv3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]&gt;
 
:*&lt;SNMPv3 認証手法 [MD5|SHA]&gt;
 
:*&lt;SNMPv3 認証ユーザ&gt;
 
:*&lt;SNMPv3 認証パスワード&gt;
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
  
 
=====例=====
 
=====例=====
  
例 1 (SNMP v3, 暗号化手法: AES, 暗号化パスワード: example_priv_passw, セキュリティレベル: authNoPriv, 認証手法:MD5, 認証ユーザ: pepito_user, 認証パスワード: example_priv_passw)
+
指定のユーザに関するすべての情報を取得します。
 +
Json または CSV にて返すことができます。この戻り値は URL を介して指定します。
 +
応答タイプのみの指定で、その他変数は使用しません。
 +
 
 +
<nowiki>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</nowiki>
 +
 
 +
====get user_profiles_info====
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito&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_|
+
Pandora FMS のユーザプロファイル一覧を返します。
  
例 2 (SNMP v1)
+
書式:
 +
*op=get (必須)
 +
*op2=user_profiles_info (必須)
 +
*return_type=csv|json (必須)
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito1&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 module from API&other_mode=url_encode_separator_|
+
=====例=====
  
====set update_network_module====
+
この例では、全システムユーザプロファイルを json フォーマットで返します。
  
ネットワークモジュールを更新します。
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
  
書式:
+
====get migrate_agent====
  
*op=set (必須)
+
>= 7.21 メタコンソールのみ
*op2=update_network_module (必須)
+
 
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
+
エージェントマイグレーションキューに、指定のエージェントが存在するかを確認します。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
+
 
:*&lt;エージェントID&gt;
+
*op=get
:*&lt;無効化&gt;
+
*op2=migrate_agent
:*&lt;モジュールグループID&gt;
+
*id=id_agente a migrar
:*&lt;警告の最小値&gt;
+
*return_type = string, json, etc
:*&lt;警告の最大値&gt;
 
:*&lt;警告文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;データの保存&gt;
 
:*&lt;対象のIPO&gt;
 
:*&lt;モジュールのポート&gt;
 
:*&lt;SNMPコミュニティ&gt;
 
:*&lt;SNMP OID&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;最小値&gt;
 
:*&lt;最大値&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_network_module&id=3431&other=44|0|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&other_mode=url_encode_separator_|
+
  <nowiki>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</nowiki>
  
====set update_plugin_module====
+
====get language====
 +
>= 7.0NG 730
  
プラグインモジュールを更新します。
+
Pandora FMS に設定されている言語を返します。
  
 
書式:
 
書式:
 +
* op=get
 +
* op2=language
 +
 +
=====例=====
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language</nowiki>
 +
 +
====get session_timeout====
 +
 +
>= 7.0NG 730
 +
 +
Pandora FMS に設定されたセッションタイムアウトを返します。
 +
 +
書式:
 +
* op=get
 +
* op2=session_timeout
 +
 +
=====例=====
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=session_timeout</nowiki>
 +
 +
====get groups====
 +
>= 7.0NG 732
 +
 +
存在するグループを返します。
 +
 +
書式:
 +
* op=get
 +
* op2=groups
 +
* other=<オプションパラメータ>:
 +
:* <csv_separator>: デフォルトは ';'。
 +
:* <return_all_group>: 'すべて' グループを返します。
 +
:* <return_all_columns>: 全カラムを返します。
 +
 +
=====例=====
 +
<nowiki>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</nowiki>
 +
 +
====get filter user group====
 +
{{metaconsole_ja}}
 +
 +
フィルタリングを行ったユーザグループを取得します。
  
*op=set (必須)
+
書式:
*op2=update_plugin_module (必須)
+
* op=get (必須)
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
+
* op2=filter_user_group (必須)
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
+
* return_type=csv|json(必須)
:*&lt;エージェントID&gt;
+
*other= id group(必須)|Enabled or not(Disabled)(必須)
:*&lt;無効化&gt;
+
 
:*&lt;モジュールグループID&gt;
+
 
:*&lt;警告の最小値&gt;
+
=====例=====
:*&lt;警告の最大値&gt;
+
 
:*&lt;警告文字列&gt;
+
Json または CSV にて返すことができます。この戻り値は URL を介して指定します。
:*&lt;障害の最小値&gt;
+
2つの変数(グループIDまたは有効化)の 1つは空ですが、少なくとも 1つは入力する必要があることに注意してください。
:*&lt;障害の最大値&gt;
+
 
:*&lt;障害文字列&gt;
+
{{Warning|2つの変数(グループIDまたは Enabled)のうちいずれかが空でも構いませんが、少なくとも一つは指定する必要があることに注意してください。}}
:*&lt;連続抑制回数&gt;
+
 
:*&lt;データの保存&gt;
+
<nowiki>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</nowiki>
:*&lt;対象IP&gt;
+
 
:*&lt;モジュールのポート&gt;
+
====get inventory_modules====
:*&lt;SNMPコミュニティ&gt;
+
 
:*&lt;SNMP OID&gt;
+
Pandora インベントリモジュールの一覧を返します。
:*&lt;モジュールの間隔&gt;
+
 
:*&lt;データ保存倍率&gt;
+
書式:
:*&lt;最小値&gt;
+
*op=get (必須)
:*&lt;最大値&gt;
+
*op2=inventory_modules (必須)
:*&lt;カスタムID&gt;
+
*return_type=csv|json (必須)
:*&lt;説明&gt;
+
 
:*&lt;プラグインID&gt;
+
=====例=====
:*&lt;プラグインユーザ&gt;
+
 
:*&lt;プラグインパスワード&gt;
+
この例では、全インベントリの情報を json フォーマットで返します。
:*&lt;プラグインパラメータ&gt;
+
 
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
:*&lt;マクロ&gt; (バージョン 5 以降のみ) base 64 でエンコードされた文字列でなければいけません。内容は、次のプロパティで表すオブジェクトを一つにまとめたものでなければいけません。
+
 
:** ''"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。
+
====get inventory_modules_by_name====
:**''"desc"'': マクロを表す名前。
+
 
:**''"help"'': マクロの説明。
+
エージェント名を用いてエージェントからインベントリモジュールを取得します。
:**''"value"'':マクロの値。
+
 
:例
+
書式:
  {
+
*op=get (必須)
  "1": {
+
*op2=inventory_modules_by_name (必須)
    "macro": "_field1_",
+
*id=<エージェント名> (必須)
    "desc": "Target&#x20;IP",
 
    "help": "",
 
    "value": "192.168.0.1"
 
  },
 
  "2": {
 
    "macro": "_field2_",
 
    "desc": "Port",
 
    "help": "",
 
    "value": "80"
 
  }
 
}
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめ base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
  
 
=====例=====
 
=====例=====
 +
http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_name&id=name&return_type=csv&apipass=1234&user=admin&pass=pandora
 +
 +
====get inventory_modules_by_alias====
 +
 +
エージェントの別名を用いて、エージェントからインベントリモジュールを取得します。
  
http://127.0.0.1/pandora_console/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|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|
+
書式:
 +
*op=get (必須)
 +
*op2=inventory_modules_by_alias (必須)
 +
*id=<エージェントの別名> (必須)
  
====set update_data_module====
+
==========
 +
http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_alias&id=alias&return_type=csv&apipass=1234&user=admin&pass=pandora
  
ローカルモジュールを更新します。
+
====get inventory_module_data====
  
{{warning|これによりデータベースにモジュールデータを追加することはできますが、該当モジュールに関するエージェントの設定ファイルを変更することはできません。}}
+
エージェント名とモジュールを用いて、インベントリモジュールからデータを取得します。
  
 
書式:
 
書式:
 +
*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
  
*op=set (必須)
+
=====例=====
*op2=update_data_module (必須)
+
http://127.0.0.1/pandora_console/include/api.phpop=get&op2=inventory_module_data&id=e14ae3b959b08a1fb7a057281401a08063cf04eb714efa5fbf1cf4043cfa1314&id2=Routes&other=,|20191010T13:40|20191211T13:40|0&return_type=csv&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
+
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
+
====get list_collections====
:*&lt;エージェントID&gt;
+
 
:*&lt;無効化&gt;
+
Pandora の全コレクションの一覧を返します。
:*&lt;モジュールグループID&gt;
+
 
:*&lt;警告の最小値&gt;
+
書式:
:*&lt;警告の最大値&gt;
+
*op=get (必須)
:*&lt;警告文字列&gt;
+
*op2=list_collections (必須)
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;データの保存&gt;
 
:*&lt;対象のIP&gt;
 
:*&lt;モジュールのポート&gt;
 
:*&lt;SNMPコミュニティ&gt;
 
:*&lt;SNMP OID&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;最小値&gt;
 
:*&lt;最大値&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 
  
 
=====例=====
 
=====例=====
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module&id=23234&other=44|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0&other_mode=url_encode_separator_|
+
この例では、全コレクションの情報を json フォーマットで返します。
  
====set update_data_module_policy====
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_collections&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====get list_collection_files====
  
ポリシーのデータモジュールを更新し、新たなモジュールの ID を返します。
+
コレクション内の全ファイル一覧を返します。コレクション ID を指定しなかった場合、全コレクションの全ファイルを返します。
  
 
書式:
 
書式:
*op=set (必須)
+
*op=get (必須)
*op2=update_data_module (必須)
+
*op2=list_collections_files (必須)
*id=&lt;id_agent_module&gt; (必須) 対象のポリシーモジュールID。
+
*id=id_collection
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。:
 
:*&lt;ポリシーモジュールID&gt;
 
:*&lt;説明&gt;
 
:*&lt;モジュールグループID&gt;
 
:*&lt;最小&gt;
 
:*&lt;最大&gt;
 
:*&lt;事前処理&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害の文字列&gt;
 
:*&lt;データの保存&gt;
 
:*&lt;設定データ&gt;
 
:*&lt;disabled_types_event&gt; (バージョン 5以降)
 
:*&lt;モジュールマクロ&gt; (バージョン 5以降) 各マクロに対して 1つのプロパティを持つオブジェクトによって形成された、base64 でエンコードされた JSON ドキュメントである必要があります。JSON フォーマットは、"<マクロ名>": "<マクロの値>" となっている必要があります。
 
  
 
=====例=====
 
=====例=====
  
http://127.0.0.1/pandora_console/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_
+
この例では、コレクション内の全ファイル名を json フォーマットで返します。
  
====set update_SNMP_module====
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_collection_files&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====get all_event_filters====
  
SNMP モジュールを更新します。
+
存在するイベントフィルタの一覧を返します。
  
 
書式:
 
書式:
*op=set (必須)
+
*op=get (必須)
*op2=update_snmp_module (必須)
+
*op2=all_event_filters (必須)
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
+
*other=cvs_separator (オプション)
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
+
 
:*&lt;エージェントID&gt;
+
=====例=====
:*&lt;無効化&gt;
+
 
:*&lt;モジュールグループID&gt;
+
<nowiki>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</nowiki>
:*&lt;警告の最小値&gt;
+
 
:*&lt;警告の最大値&gt;
+
====get event_mcid====
:*&lt;警告文字列&gt;
+
 
:*&lt;障害の最小値&gt;
+
ノードの ID および、ノードのイベント ID を用いて、メタコンソールでのイベント ID を返します。
:*&lt;障害の最大値&gt;
+
 
:*&lt;障害文字列&gt;
+
{{metaconsole_ja}}
:*&lt;連続抑制回数&gt;
+
 
:*&lt;データの保存&gt;
+
書式:
:*&lt;対象のIP&gt;
+
*op=get (必須)
:*&lt;モジュールのポート&gt;
+
*op2=event_mcid (必須)
:*&lt;SNMPバージョン&gt;
+
*id=<server_id> (必須) ノードの ID です。
:*&lt;SNMPコミュニティ&gt;
+
*id2 = <id_source_event> (必須) ノードのイベント ID です。
:*&lt;SNMP OID&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;最小値&gt;
 
:*&lt;最大値&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;snmp3 暗号化方式 [AES|DES]&gt;
 
:*&lt;snmp3 暗号化パスワード&gt;
 
:*&lt;snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]&gt;
 
:*&lt;snmp3 認証方式 [MD5|SHA]&gt;
 
:*&lt;snmp3 認証ユーザ&gt;
 
:*&lt;snmp3 認証パスワード&gt;
 
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
  
 
=====例=====
 
=====例=====
  
例 (SNMPバージョン: 3、snmp3暗号化方式: AES、snmp3暗号化パスワード: example_priv_passw、snmp3セキュリティレベル: authNoPriv、snmp3認証方式:MD5、snmp3認証ユーザ: pepito_user、snmp3認証パスワード: example_priv_passw)
+
<nowiki>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</nowiki>
  
http://127.0.0.1/pandora_console/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|pepito_user|example_auth_passw&other_mode=url_encode_separator_|
+
===設定===
  
====set apply_policy====
+
データを送信します。
  
id パラメータで指定したポリシーを適用します。
+
====set new_agent====
 +
 
 +
パラメータで指定した内容で新たなエージェントを作成します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=apply_policy (必須)
+
*op2=new_agent (必須)
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
+
*other=&lt;連続したパラメータ&gt; (必須) エージェントの設定とデータを次の順番に指定します。
 +
 
 +
:*&lt;エージェント名&gt;
 +
:*&lt;IP&gt;
 +
:*&lt;親エージェントのID&gt;
 +
:*&lt;グループID&gt;
 +
:*&lt;関連障害検知抑制&gt;
 +
:*&lt;関連障害検知抑制モジュール&gt;
 +
:*&lt;間隔(秒)&gt;
 +
:*&lt;OSのID&gt;
 +
:*&lt;サーバ名&gt;
 +
:*&lt;カスタムID&gt;
 +
:*&lt;学習モード&gt;
 +
:*&lt;無効化&gt;
 +
:*&lt;説明&gt;
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_policy&id=1
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_agent&other=agente_nombre|1.1.1.1|0|4|0|0|30|8|miguel-portatil||0|0|la%20descripcion&other_mode=url_encode_separator_|</nowiki>
  
====set apply_all_policies====
+
*注意: ''alias_as_name'' が 1 の場合はエージェント名は別名と同じです。0 の場合はエージェント名は自動的に生成されます。
 +
 
 +
====set update_agent====
  
Pandora 内にある全ポリシーを適用します。
+
パラメータで渡したデータで、新たなエージェントを更新します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=apply_all_policies (必須)
+
*op2=update_agent (必須)
 +
*id=&lt;エージェントID&gt; (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) エージェントの設定データで次の順番で設定します。
  
=====例=====
+
:*&lt;エージェント名&gt;
 
+
:*&lt;ip&gt;
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies
+
:*&lt;親ID&gt;
 
+
:*&lt;グループID&gt;
====set add_network_module_policy====
+
:*&lt;関連障害検知抑制&gt;
 +
:*&lt;間隔(秒)&gt;
 +
:*&lt;OSのID&gt;
 +
:*&lt;サーバ名&gt;
 +
:*&lt;カスタムID&gt;
 +
:*&lt;学習モード&gt;
 +
:*&lt;無効化&gt;
 +
:*&lt;説明&gt;
  
指定したパラメータで、ポリシーにネットワークモジュールを追加します。
+
=====例=====
 +
 
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?id=5&op=set&op2=update_agent&other=agente_nombre|1.1.1.1|0|4|0|30|8|10||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 
 +
====set delete_agent====
 +
 
 +
指定した名前のエージェントを削除します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=add_network_module_policy (必須)
+
*op2=delete_agent (必須)
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
+
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
+
*other (オプション)=&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
:*&lt;モジュールタイプID&gt;
+
 
:*&lt;説明&gt;
+
=====例=====
:*&lt;モジュールグループID&gt;
+
 
:*&lt;最小値&gt;
+
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo</nowiki>
:*&lt;最大値&gt;
+
 
:*&lt;データ保存倍率&gt;
+
====set create_module_template====
:*&lt;モジュールの間隔&gt;
+
 
:*&lt;警告の最小値&gt;
+
id に指定したテンプレート、other に指定したエージェント、モジュール ID から、アラートを作成します。
:*&lt;警告の最大値&gt;
+
 
:*&lt;警告文字列&gt;
+
書式:
:*&lt;障害の最小値&gt;
+
*op=set (必須)
:*&lt;障害の最大値&gt;
+
*op2=create_module_template (必須)
:*&lt;障害文字列&gt;
+
*id=&lt;テンプレートID&gt; (必須) テンプレートIDでなければいけません。
:*&lt;データの保存&gt;
+
*other=&lt;id_module&gt;|&lt;id_agent&gt;
:*&lt;連続抑制回数&gt;
 
:*&lt;無効化&gt;
 
:*&lt;モジュールのポート&gt;
 
:*&lt;SNMPコミュニティ&gt;
 
:*&lt;SNMP OID&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 のみ)
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
  
 
=====例=====
 
=====例=====
  
  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_|
+
  <nowiki>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</nowiki>
 +
 
 +
====set apply_module_template====
  
====set add_plugin_module_policy====
+
モジュールテンプレートをエージェントへ適用します。
  
指定したパラメータで、ポリシーにプラグインモジュールを追加します。
+
モジュールテンプレートは、ネットワークモジュールを集めたものです。このテンプレートは、直接エージェントに適用することができ、モジュールを一つ一つ追加する必要はありません。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=add_plugin_module_policy (必須)
+
*op2=apply_module_template (必須)
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
+
*id&lt;id_template&gt; (必須) 適用されるテンプレートの ID
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
+
*id2&lt;id_agente&gt; (必須) モジュールが作成されるエージェントの ID
:*&lt;モジュール名&gt;
+
 
 +
=====例=====
 +
 
 +
<nowiki>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</nowiki>
 +
 
 +
====set create_network_module====
 +
 
 +
指定のパラメータでネットワークモジュールを作成します。
 +
 
 +
書式:
 +
 
 +
*op=set (必須)
 +
*op2=create_network_module (必須)
 +
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定するモジュール設定パラメータです。
 +
:*&lt;モジュール名&gt;
 
:*&lt;無効化&gt;
 
:*&lt;無効化&gt;
 
:*&lt;モジュールタイプID&gt;
 
:*&lt;モジュールタイプID&gt;
Line 1,703: Line 1,750:
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告の最大値&gt;
:*&lt;警告文字列&gt;
+
:*&lt;警告の文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害の最大値&gt;
:*&lt;障害文字列&gt;
+
:*&lt;障害の文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;連続抑制回数&gt;
:*&lt;データの保存&gt;
+
:*&lt;ヒストリーデータ&gt;
:*&lt;モジュールのポート&gt;
+
:*&lt;対象IP&gt;
:*&lt;SNMPコミュニティ&gt;
+
:*&lt;TCPポート&gt;
:*&lt;SNMP OID&gt;
+
:*&lt;snmpコミュニティ&gt;
:*&lt;モジュールの間隔&gt;
+
:*&lt;snmp OID&gt;
 +
:*&lt;モジュール間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;データ保存倍率&gt;
:*&lt;最小値&gt;
+
:*&lt;最小&gt;
:*&lt;最大値&gt;
+
:*&lt;最大&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;説明&gt;
:*&lt;プラグインID&gt;
 
:*&lt;プラグインユーザ&gt;
 
:*&lt;プラグインパスワード&gt;
 
:*&lt;プラグインパラメータ&gt;
 
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
:*&lt;マクロ&gt; (バージョン 5 以降のみ) base 64 でエンコードした JSON 文字列でなければいけません。内容は、次のプロパティのオブジェクトを一つのオブジェクトにまとめた形式でなければいけません。
+
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
:** ''"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。
 
:**''"desc"'': マクロを表す名前。
 
:**''"help"'': マクロの説明。
 
:**''"value"'':マクロの値。
 
:例
 
{
 
  "1": {
 
    "macro": "_field1_",
 
    "desc": "Target&#x20;IP",
 
    "help": "",
 
    "value": "192.168.0.1"
 
  },
 
  "2": {
 
    "macro": "_field2_",
 
    "desc": "Port",
 
    "help": "",
 
    "value": "80"
 
  }
 
}
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
 
=====例=====
 
=====例=====
  
  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_|
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_network_module&id=pepito&other=prueba|0|7|1|0|0|0|0|0|1|127.0.0.1|0||0|180|0|0|0||latency%20ping&other_mode=url_encode_separator_|</nowiki>
  
====set add_data_module_policy====
+
====set create_plugin_module====
  
指定したパラメータで、ポリシーにローカルモジュールを追加します。
+
指定のパラメータでプラグインモジュールを作成します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=add_data_module_policy (必須)
+
*op2=create_plugin_module (必須)
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
+
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定を指定します。
 
:*&lt;モジュール名&gt;
 
:*&lt;モジュール名&gt;
 +
:*&lt;無効化&gt;
 
:*&lt;モジュールタイプID&gt;
 
:*&lt;モジュールタイプID&gt;
:*&lt;説明&gt;
 
 
:*&lt;モジュールグループID&gt;
 
:*&lt;モジュールグループID&gt;
:*&lt;最小値&gt;
+
:*&lt;警告の最小値&gt;
:*&lt;最大値&gt;
+
:*&lt;警告の最大値&gt;
:*&lt;データ保存倍率&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害文字列&gt;
 
:*&lt;データの保存&gt;
 
:*&lt;設定データ&gt; ポリシーエージェントの設定ファイルに挿入されるエージェントの定義ブロックです。
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
 
 
 
=====例=====
 
 
 
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_~
 
 
 
====set add_SNMP_module_policy====
 
 
 
指定したパラメータで、ポリシーに SNMP モジュールを追加します。
 
 
 
書式:
 
*op=set (必須)
 
*op2=add_snmp_module_policy (必須)
 
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
 
:*&lt;モジュール名&gt;
 
:*&lt;無効化&gt;
 
:*&lt;モジュールタイプID&gt;
 
:*&lt;モジュールグループID&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
 
:*&lt;警告文字列&gt;
 
:*&lt;警告文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最小値&gt;
Line 1,811: Line 1,802:
 
:*&lt;障害文字列&gt;
 
:*&lt;障害文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;連続抑制回数&gt;
:*&lt;データの保存&gt;
+
:*&lt;ヒストリーデータ&gt;
:*&lt;モジュールのポート&gt;
+
:*&lt;対象IP&gt;
:*&lt;SNMPバージョン&gt;
+
:*&lt;TCPポート&gt;
:*&lt;SNMPコミュニティ&gt;
+
:*&lt;snmp コミュニティ&gt;
:*&lt;SNMP OID&gt;
+
:*&lt;snmp OID&gt;
:*&lt;モジュールの間隔&gt;
+
:*&lt;モジュール間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;最小値&gt;
 
:*&lt;最小値&gt;
Line 1,822: Line 1,813:
 
:*&lt;カスタムID&gt;
 
:*&lt;カスタムID&gt;
 
:*&lt;説明&gt;
 
:*&lt;説明&gt;
:*&lt;snmp3 暗号化方式 [AES|DES]&gt;
+
:*&lt;プラグインID&gt;
:*&lt;snmp3 暗号化パスワード&gt;
+
:*&lt;プラグインユーザ&gt;
:*&lt;snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]&gt;
+
:*&lt;プラグインパスワード&gt;
:*&lt;snmp3 認証方式 [MD5|SHA]&gt;
+
:*&lt;プラグインパラメータ&gt;
:*&lt;snmp3 認証ユーザ&gt;
+
:*&lt;不明イベントの有効化&gt; (バージョン 5 のみ)
:*&lt;snmp3 認証パスワード&gt;
+
:*&lt;マクロ&gt; (バージョン 5 以降のみ) base 64 でエンコードされた JSON 文字列である必要があります。内容は、次のプロパティでまとめたオブジェクトでなければいけません。
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
+
:**'"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
+
:**''"desc"'': マクロを表す名前。
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
+
:**''"help"'': マクロの説明。
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
+
:**''"value"'': マクロの値。
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
+
:**''"hide"'': マクロの値を隠す場合は "1" に設定します。(パスワードの記載に便利です)
 
+
:例
=====例=====
+
{
 +
  "1": {
 +
    "macro": "_field1_",
 +
    "desc": "Target&#x20;IP",
 +
    "help": "",
 +
    "value": "192.168.0.1",
 +
    "hide": ""
 +
  },
 +
  "2": {
 +
    "macro": "_field2_",
 +
    "desc": "Port",
 +
    "help": "",
 +
    "value": "80",
 +
    "hide": ""
 +
  }
 +
}
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
 +
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロを一つのプロパティで表した base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" です。
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 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_|
+
=====例=====
  
====set add_agent_policy====
+
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_plugin_module&id=pepito&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|2|admin|pass|-p%20max&other_mode=url_encode_separator_|</nowiki>
  
ポリシーにエージェントを追加します。
+
====set create_data_module====
  
書式:
+
指定したパラメータでモジュールを作成します。
*op=set (必須)
 
*op2=add_agent_policy (必須)
 
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番でエージェントの設定とデータを指定します。
 
:*&lt;エージェントID&gt;
 
  
=====例=====
+
{{warning|このコマンドにてデータベースにモジュールデータを追加できますが、モジュールに関連づけられたエージェントの設定ファイルの編集はできません。}}
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy&id=1&other=167&other_mode=url_encode_separator_|
+
書式:
  
====set new_network_component====
 
 
新たなネットワークコンポーネントを作成します。
 
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=new_network_component (必須)
+
*op2=create_data_module (必須)
*id=&lt;ネットワークコンポーネント名&gt; (必須) ネットワークコンポーネント名でなければいけません。
+
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でエージェントの設定とネットワークコンポーネントのデータを指定します。
+
*other=&lt;連続パラメータ&gt; (必須) モジュールの設定とデータを次の順番で指定します。
:*&lt;ネットワークコンポーネントタイプ&gt;
+
:*&lt;モジュール名&gt;
 +
:*&lt;無効化&gt;
 +
:*&lt;モジュールタイプID&gt;
 
:*&lt;説明&gt;
 
:*&lt;説明&gt;
 +
:*&lt;モジュールグループID&gt;
 +
:*&lt;最小値&gt;
 +
:*&lt;最大値&gt;
 +
:*&lt;データ保存倍率&gt;
 
:*&lt;モジュールの間隔&gt;
 
:*&lt;モジュールの間隔&gt;
:*&lt;最大値&gt;
 
:*&lt;最小値&gt;
 
:*&lt;SNMPコミュニティ&gt;
 
:*&lt;モジュールグループID&gt;
 
:*&lt;最大タイムアウト&gt;
 
:*&lt;データの保存&gt;
 
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告の最大値&gt;
:*&lt;警告文字列&gt;
+
:*&lt;警告の文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害の最大値&gt;
:*&lt;障害文字列&gt;
+
:*&lt;障害の文字列&gt;
:*&lt;連続抑制回数&gt;
+
:*&lt;データの保存&gt;
:*&lt;データ保存倍率&gt;
 
:*&lt;ネットワークコンポーネントグループ&gt;
 
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 +
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
 
=====例=====
 
=====例=====
  
  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_|
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_data_module&id=pepito&other=prueba|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0&other_mode=url_encode_separator_|</nowiki>
  
====set new_plugin_component====
+
====set create_SNMP_module====
  
新たなプラグインコンポーネントを作成します。
+
SNMP モジュールを作成します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=new_plugin_component (必須)
+
*op2=create_snmp_module (必須)
*id=&lt;プラグインコンポーネント名&gt; (必須) プラグインコンポーネント名でなければいけません。
+
*id=&lt;エージェント名&gt; (必須) エージェント名でなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でエージェントの設定とプラグインコンポーネントのデータを指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定するモジュールの設定とデータです。
:*&lt;プラグインコンポーネントタイプ&gt;
+
:*&lt;モジュール名&gt;
:*&lt;説明&gt;
+
:*&lt;無効化&gt;
:*&lt;モジュールの間隔&gt;
+
:*&lt;モジュールタイプID&gt;
:*&lt;最大値&gt;
 
:*&lt;最小値&gt;
 
:*&lt;モジュールのポート&gt;
 
 
:*&lt;モジュールグループID&gt;
 
:*&lt;モジュールグループID&gt;
:*&lt;プラグインID&gt;
 
:*&lt;最大タイムアウト&gt;
 
:*&lt;データの保存&gt;
 
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告の最大値&gt;
:*&lt;警告文字列&gt;
+
:*&lt;警告の文字列&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最小値&gt;
 
:*&lt;障害の最大値&gt;
 
:*&lt;障害の最大値&gt;
:*&lt;障害文字列&gt;
+
:*&lt;障害の文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;連続抑制回数&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;対象IP&gt;
 +
:*&lt;モジュールのポート&gt;
 +
:*&lt;SNMPバージョン&gt;
 +
:*&lt;SNMPコミュニティ&gt;
 +
:*&lt;SNMP OID&gt;
 +
:*&lt;モジュールの間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;データ保存倍率&gt;
:*&lt;プラグインコンポーネントグループ&gt;
+
:*&lt;最小値&gt;
 +
:*&lt;最大値&gt;
 +
:*&lt;カスタムID&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;SNMPv3 暗号化手法 [AES|DES]&gt;
 +
:*&lt;SNMPv3 暗号化パスワード&gt;
 +
:*&lt;SNMPv3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]&gt;
 +
:*&lt;SNMPv3 認証手法 [MD5|SHA]&gt;
 +
:*&lt;SNMPv3 認証ユーザ&gt;
 +
:*&lt;SNMPv3 認証パスワード&gt;
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
Line 1,923: Line 1,943:
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
 
=====例=====
 
=====例=====
  
  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_|
+
例 1 (SNMP v3, 暗号化手法: AES, 暗号化パスワード: example_priv_passw, セキュリティレベル: authNoPriv, 認証手法:MD5, 認証ユーザ: pepito_user, 認証パスワード: example_priv_passw)
 +
 
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito&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_|</nowiki>
 +
 
 +
例 2 (SNMP v1)
 +
 
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito1&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 module from API&other_mode=url_encode_separator_|</nowiki>
  
====set new_snmp_component====
+
====set update_network_module====
  
新たな SNMP コンポーネントを作成します。
+
ネットワークモジュールを更新します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=new_snmp_component (必須)
+
*op2=update_network_module (必須)
*id=&lt;SNMPコンポーネント名&gt; (必須) SNMPコンポーネント名でなければいけません。
+
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番で SNMP コンポーネントの設定とデータを指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
:*&lt;SNMPコンポーネントタイプ&gt;
+
:*&lt;エージェントID&gt;
:*&lt;説明&gt;
+
:*&lt;無効化&gt;
:*&lt;モジュールの間隔&gt;
 
:*&lt;最大値&gt;
 
:*&lt;最小値&gt;
 
 
:*&lt;モジュールグループID&gt;
 
:*&lt;モジュールグループID&gt;
:*&lt;最大タイムアウト&gt;
 
:*&lt;データの保存&gt;
 
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最小値&gt;
 
:*&lt;警告の最大値&gt;
 
:*&lt;警告の最大値&gt;
Line 1,952: Line 1,976:
 
:*&lt;障害文字列&gt;
 
:*&lt;障害文字列&gt;
 
:*&lt;連続抑制回数&gt;
 
:*&lt;連続抑制回数&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;対象のIPO&gt;
 +
:*&lt;モジュールのポート&gt;
 +
:*&lt;SNMPコミュニティ&gt;
 +
:*&lt;SNMP OID&gt;
 +
:*&lt;モジュールの間隔&gt;
 
:*&lt;データ保存倍率&gt;
 
:*&lt;データ保存倍率&gt;
:*&lt;SNMPバージョン&gt;
+
:*&lt;最小値&gt;
:*&lt;SNMP OID&gt;
+
:*&lt;最大値&gt;
:*&lt;SNMPコミュニティ&gt;
+
:*&lt;カスタムID&gt;
:*&lt;snmp3 認証ユーザ&gt;
+
:*&lt;説明&gt;
:*&lt;snmp3 認証パスワード&gt;
+
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
:*&lt;モジュールのポート&gt;
+
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
:*&lt;snmp3 暗号化手法&gt;
 
:*&lt;snmp3 暗号化パスワード&gt;
 
:*&lt;snmp3 認証手法&gt;
 
:*&lt;snmp3 セキュリティレベル&gt;
 
:*&lt;SNMPコンポーネントグループ&gt;
 
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 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_|
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_network_module&id=3431&other=44|0|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&other_mode=url_encode_separator_|</nowiki>
  
====set new_local_component====
+
====set update_plugin_module====
  
新たなローカルコンポーネントを作成します。
+
プラグインモジュールを更新します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=new_local_component (必須)
+
*op2=update_plugin_module (必須)
*id=&lt;ローカルコンポーネント名&gt; (必須) ローカルコンポーネント名でなければいけません。
+
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でローカルコンポーネントの設定とデータを指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
:*&lt;説明&gt;
+
:*&lt;エージェントID&gt;
:*&lt;OSのID&gt;
+
:*&lt;無効化&gt;
:*&lt;ローカルコンポーネントグループ&gt;
+
:*&lt;モジュールグループID&gt;
:*&lt;設定データ&gt; モジュールの設定ブロックです。
+
:*&lt;警告の最小値&gt;
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
+
:*&lt;警告の最大値&gt;
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
+
:*&lt;警告文字列&gt;
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
+
:*&lt;障害の最小値&gt;
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
+
:*&lt;障害の最大値&gt;
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
+
:*&lt;障害文字列&gt;
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
+
:*&lt;連続抑制回数&gt;
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
+
:*&lt;データの保存&gt;
 
+
:*&lt;対象IP&gt;
=====例=====
+
:*&lt;モジュールのポート&gt;
 
+
:*&lt;SNMPコミュニティ&gt;
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_~
+
:*&lt;SNMP OID&gt;
 
+
:*&lt;モジュールの間隔&gt;
====set create_alert_template====
+
:*&lt;データ保存倍率&gt;
 
+
:*&lt;最小値&gt;
アラートテンプレートを作成します。
+
:*&lt;最大値&gt;
 
+
:*&lt;カスタムID&gt;
書式:
 
 
 
*op=set (必須)
 
*op2=create_alert_template (必須)
 
*id=&lt;テンプレート名&gt; (必須) テンプレート名でなければいけません。
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番でテンプレートの設定とデータを指定します。
 
:*&lt;タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
 
 
:*&lt;説明&gt;
 
:*&lt;説明&gt;
:*&lt;アラートアクションID&gt;
+
:*&lt;プラグインID&gt;
:*&lt;フィールド1&gt;
+
:*&lt;プラグインユーザ&gt;
:*&lt;フィールド2&gt;
+
:*&lt;プラグインパスワード&gt;
:*&lt;フィールド3&gt;
+
:*&lt;プラグインパラメータ&gt;
:*&lt;&gt;
+
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
:*&lt;マッチする値&gt;
+
:*&lt;マクロ&gt; (バージョン 5 以降のみ) base 64 でエンコードされた文字列でなければいけません。内容は、次のプロパティで表すオブジェクトを一つにまとめたものでなければいけません。
:*&lt;最大値&gt;
+
:** ''"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。
:*&lt;最小値&gt;
+
:**''"desc"'': マクロを表す名前。
:*&lt;再通知間隔&gt;
+
:**''"help"'': マクロの説明。
:*&lt;最大アラート数&gt;
+
:**''"value"'':マクロの値。
:*&lt;最小アラート数&gt;
+
:例
:*&lt;開始時間&gt;
+
{
:*&lt;終了時間&gt;
+
  "1": {
:*&lt;月曜&gt;
+
    "macro": "_field1_",
:*&lt;火曜&gt;
+
    "desc": "Target&#x20;IP",
:*&lt;水曜&gt;
+
    "help": "",
:*&lt;木曜&gt;
+
    "value": "192.168.0.1"
:*&lt;金曜&gt;
+
  },
:*&lt;土曜&gt;
+
  "2": {
:*&lt;日曜&gt;
+
    "macro": "_field2_",
:*&lt;復旧アラート&gt;
+
    "desc": "Port",
:*&lt;復旧時のフィールド2&gt;
+
    "help": "",
:*&lt;復旧時のフィールド3&gt;
+
    "value": "80"
:*&lt;優先度&gt;
+
  }
:*&lt;グループID&gt;
+
}
 +
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめ base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
 
=====例=====
 
=====例=====
  
例1 (状態: regexp =~ /pp/、アクション: Mail to XXX、最大アラート数: 10、最小アラート数: 0、優先度: 警告、グループ: database):
+
<nowiki>http://127.0.0.1/pandora_console/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|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=pepito&other=regex|template%20based%20in%20regexp|1||||pp|1||||10|0|||||||||||||3&other_mode=url_encode_separator_|
+
====set update_data_module====
  
例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|NULL||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|
+
{{warning|これによりデータベースにモジュールデータを追加することはできますが、該当モジュールに関するエージェントの設定ファイルを変更することはできません。}}
 
 
====set update_alert_template====
 
 
 
アラートテンプレートを更新します。
 
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=update_alert_template (必須)
+
*op2=update_data_module (必須)
*id=&lt;テンプレートID&gt; (必須) テンプレートIDでなければいけません。
+
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でテンプレートの設定とデータを指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
:*&lt;テンプレート名&gt;
+
:*&lt;エージェントID&gt;
:*&lt;タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
+
:*&lt;無効化&gt;
:*&lt;説明&gt;
+
:*&lt;モジュールグループID&gt;
:*&lt;アラートアクションID&gt;
+
:*&lt;警告の最小値&gt;
:*&lt;フィールド1&gt;
+
:*&lt;警告の最大値&gt;
:*&lt;フィールド2&gt;
+
:*&lt;警告文字列&gt;
:*&lt;フィールド3&gt;
+
:*&lt;障害の最小値&gt;
:*&lt;&gt;
+
:*&lt;障害の最大値&gt;
:*&lt;マッチする値&gt;
+
:*&lt;障害文字列&gt;
 +
:*&lt;連続抑制回数&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;対象のIP&gt;
 +
:*&lt;モジュールのポート&gt;
 +
:*&lt;SNMPコミュニティ&gt;
 +
:*&lt;SNMP OID&gt;
 +
:*&lt;モジュールの間隔&gt;
 +
:*&lt;データ保存倍率&gt;
 +
:*&lt;最小値&gt;
 
:*&lt;最大値&gt;
 
:*&lt;最大値&gt;
:*&lt;最小値&gt;
+
:*&lt;カスタムID&gt;
:*&lt;再実行間隔&gt;
+
:*&lt;説明&gt;
:*&lt;最大アラート数&gt;
+
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
:*&lt;最小アラート数&gt;
+
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
:*&lt;開始時間&gt;
+
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
:*&lt;終了時間&gt;
+
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
:*&lt;月曜&gt;
+
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
:*&lt;火曜&gt;
+
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
:*&lt;水曜&gt;
+
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
:*&lt;木曜&gt;
+
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
:*&lt;金曜&gt;
+
:*&lt;障害条件の反転&gt; (バージョン 6.0SP1 以降のみ)
:*&lt;土曜&gt;
+
:*&lt;警告条件の反転&gt; (バージョン 6.0SP1 以降のみ)
:*&lt;日曜&gt;
+
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
:*&lt;復旧アラート&gt;
 
:*&lt;復旧時のフィールド2&gt;
 
:*&lt;復旧時のフィールド3&gt;
 
:*&lt;優先度&gt;
 
:*&lt;グループID&gt;
 
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=38&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%201|field%20recovery%20example%202|1|8&other_mode=url_encode_separator_|
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module&id=23234&other=44|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0&other_mode=url_encode_separator_|</nowiki>
  
====set delete_alert_template====
+
====set update_data_module_policy====
  
アラートテンプレートと、テンプレートで使われているアラートを削除します。
+
ポリシーのデータモジュールを更新し、新たなモジュールの ID を返します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=delete_alert_template (必須)
+
*op2=update_data_module (必須)
*id=&lt;テンプレートID&gt; (必須) テンプレートIDでなければいけません。
+
*id=&lt;id_agent_module&gt; (必須) 対象のポリシーモジュールID。
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。:
 +
:*&lt;ポリシーモジュールID&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;モジュールグループID&gt;
 +
:*&lt;最小&gt;
 +
:*&lt;最大&gt;
 +
:*&lt;事前処理&gt;
 +
:*&lt;モジュールの間隔&gt;
 +
:*&lt;警告の最小値&gt;
 +
:*&lt;警告の最大値&gt;
 +
:*&lt;障害の最小値&gt;
 +
:*&lt;障害の最大値&gt;
 +
:*&lt;障害の文字列&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;設定データ&gt;
 +
:*&lt;disabled_types_event&gt; (バージョン 5以降)
 +
:*&lt;モジュールマクロ&gt; (バージョン 5以降) 各マクロに対して 1つのプロパティを持つオブジェクトによって形成された、base64 でエンコードされた JSON ドキュメントである必要があります。JSON フォーマットは、"<マクロ名>": "<マクロの値>" となっている必要があります。
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38
+
  <nowiki>http://127.0.0.1/pandora_console/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_</nowiki>
  
====set delete_module_template====
+
====set update_SNMP_module====
  
モジュールテンプレートを削除します。
+
SNMP モジュールを更新します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=delete_module_template (必須)
+
*op2=update_snmp_module (必須)
*id=&lt;alert_template_module ID&gt; (必須) alert_template_module のIDでなければいけません。
+
*id=&lt;モジュールID&gt; (必須) モジュールIDでなければいけません。
 
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
=====例=====
+
:*&lt;エージェントID&gt;
 
+
:*&lt;無効化&gt;
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38
+
:*&lt;モジュールグループID&gt;
 
+
:*&lt;警告の最小値&gt;
====set delete_module_template_by_names====
+
:*&lt;警告の最大値&gt;
 
+
:*&lt;警告文字列&gt;
モジュールテンプレートを削除します。
+
:*&lt;障害の最小値&gt;
 
+
:*&lt;障害の最大値&gt;
書式:
+
:*&lt;障害文字列&gt;
 
+
:*&lt;連続抑制回数&gt;
*op=set (必須)
+
:*&lt;データの保存&gt;
*op2=delete_module_template_by_names (必須)
+
:*&lt;対象のIP&gt;
*id=&lt;エージェント名&gt; (必須)
+
:*&lt;モジュールのポート&gt;
*id2=&lt;アラートテンプレート名&gt; (必須)
+
:*&lt;SNMPバージョン&gt;
*other=&lt;連続パラメータ&gt; (必須) 次の順番でデータを指定します。
+
:*&lt;SNMPコミュニティ&gt;
:*&lt;モジュール名&gt; (必須)
+
:*&lt;SNMP OID&gt;
 +
:*&lt;モジュールの間隔&gt;
 +
:*&lt;データ保存倍率&gt;
 +
:*&lt;最小値&gt;
 +
:*&lt;最大値&gt;
 +
:*&lt;カスタムID&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;snmp3 暗号化方式 [AES|DES]&gt;
 +
:*&lt;snmp3 暗号化パスワード&gt;
 +
:*&lt;snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]&gt;
 +
:*&lt;snmp3 認証方式 [MD5|SHA]&gt;
 +
:*&lt;snmp3 認証ユーザ&gt;
 +
:*&lt;snmp3 認証パスワード&gt;
 +
:*&lt;イベントタイプの無効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
 
=====例=====
 
=====例=====
  
  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
+
例 (SNMPバージョン: 3、snmp3暗号化方式: AES、snmp3暗号化パスワード: example_priv_passw、snmp3セキュリティレベル: authNoPriv、snmp3認証方式:MD5、snmp3認証ユーザ: pepito_user、snmp3認証パスワード: example_priv_passw)
 +
 
 +
  <nowiki>http://127.0.0.1/pandora_console/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|pepito_user|example_auth_passw&other_mode=url_encode_separator_|</nowiki>
  
====set stop_dowtime====
+
====set apply_policy====
  
計画停止を停止します。
+
ひとつもしくは複数のエージェントに、ID を指定してポリシーを適用します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=stop_downtime (必須)
+
*op2=apply_policy (必須)
*id=&lt;計画停止ID&gt; (必須) 計画停止IDでなければいけません。
+
*id=&lt;id_policy&gt; (必須)
 +
*id2=&lt;id_agent&gt; (オプション) 他のパラメータに示されているエージェントのIDまたは名前。 空の場合、ポリシーはすべてのエージェントに適用されます。
 +
*other=&lt;連続パラメータ&gt;
 +
:*&lt;name_agent (整数)&gt; エージェントを ID(0) で指定するか、名前(1) で指定するか、別名(2) で指定するかを示します。
 +
:*&lt;server_id&gt; (メタコンソールの場合必要です) ポリシーを適用するサーバの ID です。
 +
:*&lt;return&gt;
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1
+
  <nowiki>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</nowiki>
  
====set new_user====
+
====set apply_all_policies====
  
Pandora に新たなユーザを作成します。
+
Pandora 内にある全ポリシーを適用します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=new_user (必須)
+
*op2=apply_all_policies (必須)
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
+
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番で設定とデータを指定します。
+
=====例=====
:*&lt;ユーザ名&gt;
+
 
:*&lt;フルネーム&gt;
+
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies</nowiki>
:*&lt;名前&gt;
 
:*&lt;名字&gt;
 
:*&lt;ミドルネーム&gt;
 
:*&lt;電子メールアドレス&gt;
 
:*&lt;電話番号&gt;
 
:*&lt;言語&gt;
 
:*&lt;コメント&gt;
 
  
=====例=====
+
====set add_network_module_policy====
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_user&id=md&other=miguel|de%20dios|matias|kkk|pandora|[email protected]|666|es|descripcion%20y%20esas%20cosas&other_mode=url_encode_separator_|
+
指定したパラメータで、ポリシーにネットワークモジュールを追加します。
 
 
====Set update_user====
 
 
 
指定した ID のユーザを指定したパラメータで更新します。
 
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=update_user (必須)
+
*op2=add_network_module_policy (必須)
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
+
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番で設定とデータを指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
:*&lt;フルネーム&gt;
+
:*&lt;モジュールタイプID&gt;
:*&lt;名前&gt;
+
:*&lt;説明&gt;
:*&lt;名字&gt;
+
:*&lt;モジュールグループID&gt;
:*&lt;ミドルネーム&gt;
+
:*&lt;最小値&gt;
:*&lt;パスワード&gt;
+
:*&lt;最大値&gt;
:*&lt;電子メールアドレス&gt;
+
:*&lt;データ保存倍率&gt;
:*&lt;電話番号&gt;
+
:*&lt;モジュールの間隔&gt;
:*&lt;言語&gt;
+
:*&lt;警告の最小値&gt;
:*&lt;コメント&gt;
+
:*&lt;警告の最大値&gt;
:*&lt;管理者&gt;
+
:*&lt;警告文字列&gt;
:*&lt;一画面の表示数&gt;
+
:*&lt;障害の最小値&gt;
:*&lt;フラッシュグラフ&gt;
+
:*&lt;障害の最大値&gt;
 +
:*&lt;障害文字列&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;連続抑制回数&gt;
 +
:*&lt;無効化&gt;
 +
:*&lt;モジュールのポート&gt;
 +
:*&lt;SNMPコミュニティ&gt;
 +
:*&lt;SNMP OID&gt;
 +
:*&lt;カスタムID&gt;
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 のみ)
 +
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
 
=====例=====
 
=====例=====
  
  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_|
+
  <nowiki>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_|</nowiki>
  
====set delete_user====
+
====set add_plugin_module_policy====
  
選択したユーザを削除します。
+
指定したパラメータで、ポリシーにプラグインモジュールを追加します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=delete_user (必須)
+
*op2=add_plugin_module_policy (必須)
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
+
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
 
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
=====例=====
+
:*&lt;モジュール名&gt;
 
+
:*&lt;無効化&gt;
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md
+
:*&lt;モジュールタイプID&gt;
 
+
:*&lt;モジュールグループID&gt;
====set enable_disable_user====
+
:*&lt;警告の最小値&gt;
 
+
:*&lt;警告の最大値&gt;
ユーザを無効化・有効化します。
+
:*&lt;警告文字列&gt;
 
+
:*&lt;障害の最小値&gt;
書式:
+
:*&lt;障害の最大値&gt;
 
+
:*&lt;障害文字列&gt;
*op=set (必須)
+
:*&lt;連続抑制回数&gt;
*op2=enable_disable_user (必須)
+
:*&lt;データの保存&gt;
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
+
:*&lt;モジュールのポート&gt;
other=<フラグ> (必須) 有効化する場合は 1、無効化する場合は 0 を指定します。
+
:*&lt;SNMPコミュニティ&gt;
 
+
:*&lt;SNMP OID&gt;
=====例=====
+
:*&lt;モジュールの間隔&gt;
 
+
:*&lt;データ保存倍率&gt;
例1 (ユーザ 'example_name' を無効化)
+
:*&lt;最小値&gt;
 
+
:*&lt;最大値&gt;
  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_|
+
:*&lt;カスタムID&gt;
 
+
:*&lt;説明&gt;
例2 (ユーザ 'example_name' を有効化)
+
:*&lt;プラグインID&gt;
 
+
:*&lt;プラグインユーザ&gt;
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_|
+
:*&lt;プラグインパスワード&gt;
 +
:*&lt;プラグインパラメータ&gt;
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;マクロ&gt; (バージョン 5 以降のみ) base 64 でエンコードした JSON 文字列でなければいけません。内容は、次のプロパティのオブジェクトを一つのオブジェクトにまとめた形式でなければいけません。
 +
:** ''"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。
 +
:**''"desc"'': マクロを表す名前。
 +
:**''"help"'': マクロの説明。
 +
:**''"value"'':マクロの値。
 +
:例
 +
  {
 +
  "1": {
 +
    "macro": "_field1_",
 +
    "desc": "Target&#x20;IP",
 +
    "help": "",
 +
    "value": "192.168.0.1"
 +
  },
 +
  "2": {
 +
    "macro": "_field2_",
 +
    "desc": "Port",
 +
    "help": "",
 +
    "value": "80"
 +
  }
 +
}
 +
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
====set create_group====
+
=====例=====
 +
 
 +
<nowiki>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_|</nowiki>
 +
 
 +
====set add_data_module_policy====
  
グループを作成します。
+
指定したパラメータで、ポリシーにローカルモジュールを追加します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=create_group (必須)
+
*op2=add_data_module_policy (必須)
*id=&lt;グループ名&gt; (必須) グループ名を指定します。
+
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
:*&lt;アイコン名&gt;  
+
:*&lt;モジュール名&gt;
:*&lt;親グループID&gt; (オプション)
+
:*&lt;モジュールタイプID&gt;
:*&lt;説明&gt; (オプション)
+
:*&lt;説明&gt;
:*&lt;ACLの伝播&gt; (オプション)
+
:*&lt;モジュールグループID&gt;
:*&lt;アラートの無効化&gt; (オプション)
+
:*&lt;最小値&gt;
:*&lt;カスタムID&gt; (オプション)
+
:*&lt;最大値&gt;
:*&lt;連絡先&gt; (オプション)
+
:*&lt;データ保存倍率&gt;
:*&lt;その他&gt; (オプション)
+
:*&lt;モジュールの間隔&gt;
 +
:*&lt;警告の最小値&gt;
 +
:*&lt;警告の最大値&gt;
 +
:*&lt;警告文字列&gt;
 +
:*&lt;障害の最小値&gt;
 +
:*&lt;障害の最大値&gt;
 +
:*&lt;障害文字列&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;設定データ&gt; ポリシーエージェントの設定ファイルに挿入されるエージェントの定義ブロックです。
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;モジュールマクロ&gt; (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
 +
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
 
=====例=====
 
=====例=====
  
例1 (親グループ: Servers)
+
<nowiki>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_~</nowiki>
  
  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_|
+
====set add_SNMP_module_policy====
 
例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_|
+
指定したパラメータで、ポリシーに SNMP モジュールを追加します。
 
 
====set update_group====
 
 
 
グループの設定を更新します。
 
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=update_group (必須)
+
*op2=add_snmp_module_policy (必須)
*id=&lt;グループID&gt; (必須) グループIDを指定します。
+
*id=&lt;ポリシーID&gt; (必須) ポリシーIDでなければいけません。
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でモジュールの設定とデータを指定します。
:*&lt;グループ名&gt;  
+
:*&lt;モジュール名&gt;
:*&lt;アイコン名&gt;  
+
:*&lt;無効化&gt;
:*&lt;親グループID&gt;  
+
:*&lt;モジュールタイプID&gt;
:*&lt;説明&gt;  
+
:*&lt;モジュールグループID&gt;
:*&lt;ACLの伝播&gt;  
+
:*&lt;警告の最小値&gt;
:*&lt;アラートの無効化&gt;  
+
:*&lt;警告の最大値&gt;
:*&lt;カスタムID&gt;  
+
:*&lt;警告文字列&gt;
:*&lt;連絡先&gt;  
+
:*&lt;障害の最小値&gt;
:*&lt;その他&gt;  
+
:*&lt;障害の最大値&gt;
 
+
:*&lt;障害文字列&gt;
=====例=====
+
:*&lt;連続抑制回数&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;モジュールのポート&gt;
 +
:*&lt;SNMPバージョン&gt;
 +
:*&lt;SNMPコミュニティ&gt;
 +
:*&lt;SNMP OID&gt;
 +
:*&lt;モジュールの間隔&gt;
 +
:*&lt;データ保存倍率&gt;
 +
:*&lt;最小値&gt;
 +
:*&lt;最大値&gt;
 +
:*&lt;カスタムID&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;snmp3 暗号化方式 [AES|DES]&gt;
 +
:*&lt;snmp3 暗号化パスワード&gt;
 +
:*&lt;snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]&gt;
 +
:*&lt;snmp3 認証方式 [MD5|SHA]&gt;
 +
:*&lt;snmp3 認証ユーザ&gt;
 +
:*&lt;snmp3 認証パスワード&gt;
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
  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
+
=====例=====
  
====set delete_group====
+
<nowiki>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_|</nowiki>
>= 6
+
 
 +
====set add_agent_policy_by_id====
  
グループを削除します。
+
エージェント ID を用いてポリシーにエージェントを追加します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=update_group (必須)
+
*op2=add_agent_policy_by_id (必須)
*id=&lt;グループID&gt; (必須) グループIDを指定します。
+
*id=&lt;id_policy&gt; (必須) ポリシー ID である必要があります。
 +
*other=&lt;serialized parameters&gt; (必須) エージェント設定とデータで、次の順番で指定する必要があります:
 +
:*&lt;id_agent&gt;
 +
:*&lt;id_node&gt; (メタコンソールの場合は必須) ポリシーに追加するエージェントが属するノードのID。
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora
+
* ノード:
 +
<nowiki>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</nowiki>
  
====set add_user_profile====
+
* メタコンソール:
 +
<nowiki>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</nowiki>
 +
 
 +
====set add_agent_policy_by_name====
  
ユーザにプロファイルを追加します。
+
エージェント名を用いてポリシーへエージェントを追加します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=add_user_profile (必須)
+
*op2=add_agent_policy_by_name (必須)
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
+
*id=&lt;id_policy&gt; (必須) ポリシー ID である必要があります。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でグループの設定、プロファイルを指定します。
+
*other=&lt;serialized parameters&gt; (必須) エージェント設定とデータで、次の順番で指定する必要があります:
:*&lt;グループ&gt;
+
:*&lt;agent_name&gt;
:*&lt;プロファイル&gt;
 
  
 
=====例=====
 
=====例=====
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_|
 
  
====set delete_user_profile====
+
<nowiki>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</nowiki>
 +
 
 +
====set remove_agent_from_policy_by_id====
  
ユーザのプロファイルを削します。
+
エージェント ID を用いて、ポリシーからエージェントを削除します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=delete_user_profile (必須)
+
*op2=remove_agent_from_policy_by_id (必須)
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
+
*id=&lt;id_política&gt; (必須) ポリシー ID である必要があります。
*other=&lt;連続パラメータ&gt; (必須) 次の順番でグループおよびプロファイルを指定します。
+
*other=&lt;serialized parameters&gt; (必須) エージェント設定とデータで、次の順番で指定する必要があります:
:*&lt;グループ&gt;
+
:*&lt;id_agent&gt;
:*&lt;プロファイル&gt;
+
:*&lt;id_node&gt; (required when using the Metaconsole). ID of the node the agent you wish to remove from the policy belongs to.
  
=====例=====
+
=====必須=====
 
 
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_|
 
 
 
====set new_incident====
 
 
 
新たなインシデントを作成します。
 
 
 
書式:
 
*op=set (必須)
 
*op2=new_incident (必須)
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番でインシデントの設定とデータを指定します。
 
:*&lt;タイトル&gt;
 
:*&lt;説明&gt;
 
:*&lt;作成者&gt;
 
:*&lt;優先度&gt;
 
:*&lt;状態&gt;
 
:*&lt;グループ&gt;
 
  
=====例=====
+
* ノード:
 +
<nowiki>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</nowiki>
  
  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_|
+
* メタコンソール:
 +
  <nowiki>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</nowiki>
  
====set new_note_incident====
+
====set remove_agent_from_policy_by_name====
  
インシデントにコメントを追加します。
+
エージェント名を用いて、ポリシーからエージェントを削除します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=new_note_incident (必須)
+
*op2=remove_agent_from_policy_by_name (必須)
*id=&lt;インシデントID&gt; (必須) インシデントのIDです。
+
*id=&lt;id_policy&gt; (必須) ポリシー ID である必要があります。
*id2=&lt;ユーザ名&gt; (必須) ユーザ名です。
+
*other=&lt;serialized parameters&gt; (必須) エージェント設定とデータで、次の順番で指定する必要があります:
*other=&lt;コメント&gt; (必須) URLエンコードされたコメントです。
+
:*&lt;agent_name&gt;
  
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
====set validate_all_alerts====
+
====set new_network_component====
  
全アラートを承諾します。
+
新たなネットワークコンポーネントを作成します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=validate_all_alerts (必須)
+
*op2=new_network_component (必須)
 +
*id=&lt;ネットワークコンポーネント名&gt; (必須) ネットワークコンポーネント名でなければいけません。
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番でエージェントの設定とネットワークコンポーネントのデータを指定します。
 +
:*&lt;ネットワークコンポーネントタイプ&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;モジュールの間隔&gt;
 +
:*&lt;最大値&gt;
 +
:*&lt;最小値&gt;
 +
:*&lt;SNMPコミュニティ&gt;
 +
:*&lt;モジュールグループID&gt;
 +
:*&lt;最大タイムアウト&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;警告の最小値&gt;
 +
:*&lt;警告の最大値&gt;
 +
:*&lt;警告文字列&gt;
 +
:*&lt;障害の最小値&gt;
 +
:*&lt;障害の最大値&gt;
 +
:*&lt;障害文字列&gt;
 +
:*&lt;連続抑制回数&gt;
 +
:*&lt;データ保存倍率&gt;
 +
:*&lt;ネットワークコンポーネントグループ&gt;
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
 
=====例=====
 
=====例=====
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts
 
  
====set validate_all_policy_alerts====
+
<nowiki>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_|</nowiki>
 +
 
 +
====set new_plugin_component====
  
ポリシーから作成されたアラートを承諾します。
+
新たなプラグインコンポーネントを作成します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=validate_all_policy_alerts (必須)
+
*op2=new_plugin_component (必須)
 
+
*id=&lt;プラグインコンポーネント名&gt; (必須) プラグインコンポーネント名でなければいけません。
=====例=====
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でエージェントの設定とプラグインコンポーネントのデータを指定します。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts
+
:*&lt;プラグインコンポーネントタイプ&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;モジュールの間隔&gt;
 +
:*&lt;最大値&gt;
 +
:*&lt;最小値&gt;
 +
:*&lt;モジュールのポート&gt;
 +
:*&lt;モジュールグループID&gt;
 +
:*&lt;プラグインID&gt;
 +
:*&lt;最大タイムアウト&gt;
 +
:*&lt;データの保存&gt;
 +
:*&lt;警告の最小値&gt;
 +
:*&lt;警告の最大値&gt;
 +
:*&lt;警告文字列&gt;
 +
:*&lt;障害の最小値&gt;
 +
:*&lt;障害の最大値&gt;
 +
:*&lt;障害文字列&gt;
 +
:*&lt;連続抑制回数&gt;
 +
:*&lt;データ保存倍率&gt;
 +
:*&lt;プラグインコンポーネントグループ&gt;
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
 +
 
 +
=====例=====
  
====set event_validate_filter====
+
<nowiki>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_|</nowiki>
 +
 
 +
====set new_snmp_component====
  
指定したフィルタにマッチするすべてのイベントを承諾します。
+
新たな SNMP コンポーネントを作成します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=event_validate_filter (必須)
+
*op2=new_snmp_component (必須)
*other_mode=url_encode_separator_|(オプション)
+
*id=&lt;SNMPコンポーネント名&gt; (必須) SNMPコンポーネント名でなければいけません。
*other=&lt;連続パラメータ&gt; (オプション) 次の順番で指定します。
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番で SNMP コンポーネントの設定とデータを指定します。
:*&lt;セパレータ&gt;
+
:*&lt;SNMPコンポーネントタイプ&gt;
:*&lt;重要度&gt; 0 から 4
+
:*&lt;説明&gt;
:*&lt;エージェント名&gt;
+
:*&lt;モジュールの間隔&gt;
:*&lt;モジュール名&gt;
+
:*&lt;最大値&gt;
:*&lt;アラートテンプレート名&gt;
+
:*&lt;最小値&gt;
:*&lt;ユーザ&gt;
+
:*&lt;モジュールグループID&gt;
:*&lt; 最小レベルの数値間隔&gt; UNIXタイムスタンプ
+
:*&lt;最大タイムアウト&gt;
:*&lt; 最大レベルの数値間隔&gt; UNIXタイムスタンプ
+
:*&lt;データの保存&gt;
 
+
:*&lt;警告の最小値&gt;
=====例=====
+
:*&lt;警告の最大値&gt;
 
+
:*&lt;警告文字列&gt;
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2
+
:*&lt;障害の最小値&gt;
 
+
:*&lt;障害の最大値&gt;
====set event_validate_filter_pro====
+
:*&lt;障害文字列&gt;
 
+
:*&lt;連続抑制回数&gt;
前述の API と似たものです。
+
:*&lt;データ保存倍率&gt;
 
+
:*&lt;SNMPバージョン&gt;
書式:
+
:*&lt;SNMP OID&gt;
 
+
:*&lt;SNMPコミュニティ&gt;
*op=set (必須)
+
:*&lt;snmp3 認証ユーザ&gt;
*op2=event_validate_filter_pro (必須)
+
:*&lt;snmp3 認証パスワード&gt;
*other_mode=url_encode_separator_| (オプション)
+
:*&lt;モジュールのポート&gt;
*other=&lt;連続パラメータ&gt; (オプション) 次の順番で指定します。
+
:*&lt;snmp3 暗号化手法&gt;
:*&lt;セパレータ&gt;
+
:*&lt;snmp3 暗号化パスワード&gt;
:*&lt;重要度&gt; 0 から 4
+
:*&lt;snmp3 認証手法&gt;
:*&lt;エージェントID&gt;
+
:*&lt;snmp3 セキュリティレベル&gt;
:*&lt;モジュールID&gt;
+
:*&lt;SNMPコンポーネントグループ&gt;
:*&lt;エージェントモジュールアラートID&gt;
+
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
:*&lt;ユーザ&gt;
+
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
:*&lt;最小レベルの数値間隔&gt; UNIXタイムスタンプ
+
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
:*&lt;最大レベルの数値間隔&gt; UNIXタイムスタンプ
+
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2
+
  <nowiki>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_|</nowiki>
  
====set new_alert_template====
+
====set new_local_component====
  
テンプレートおよび、エージェントIDおよびモジュール名からモジュールを指定して、新たなアラートを適用します。
+
新たなローカルコンポーネントを作成します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=new_alert_template (必須)
+
*op2=new_local_component (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;ローカルコンポーネント名&gt; (必須) ローカルコンポーネント名でなければいけません。
*id2=&lt;アラートテンプレート名&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でローカルコンポーネントの設定とデータを指定します。
*other_mode=url_encode_separator_| (オプション)
+
:*&lt;説明&gt;
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
+
:*&lt;OSのID&gt;
:*&lt;モジュール名&gt; (必須)
+
:*&lt;ローカルコンポーネントグループ&gt;
 +
:*&lt;設定データ&gt; モジュールの設定ブロックです。
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 以降のみ)
 +
:*&lt;連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;個別状態変化の利用&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;正常移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;警告移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;障害移行時連続抑制回数&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;連続抑制タイムアウト&gt; (バージョン 5.1 以降のみ)
 +
:*&lt;ff_type&gt; (バージョン 733 以降のみ)
  
 
=====例=====
 
=====例=====
  
  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
+
  <nowiki>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_~</nowiki>
  
====set alert_actions====
+
====set create_alert_template====
  
アラートにアクションを追加します。
+
アラートテンプレートを作成します。
 
 
書式:
 
*op=set (必須)
 
*op2=alert_actions (必須)
 
*id=&lt;エージェント名&gt; (必須)
 
*id2=&lt;アラートテンプレート名&gt; (必須)
 
*other_mode=url_encode_separator_| (オプション)
 
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
 
:*&lt;モジュール名&gt; (必須)
 
:*&lt;アクション名&gt; (必須)
 
:*&lt;開始アラート数&gt; (オプション)
 
:*&lt;終了アラート数&gt; (オプション)
 
 
 
=====例=====
 
 
 
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
 
 
 
====set new_module====
 
 
 
新たなモジュールを作成します。
 
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=new_module (必須)
+
*op2=create_alert_template (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;テンプレート名&gt; (必須) テンプレート名でなければいけません。
*id2=&lt;新たなモジュール名&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でテンプレートの設定とデータを指定します。
*other_mode=url_encode_separator_| (オプション)
+
:*&lt;タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
+
:*&lt;説明&gt;
:*&lt;ネットワークモジュールの種類&gt; (必須)
+
:*&lt;アラートアクションID&gt;
:*&lt;アクション名&gt; (必須)
+
:*&lt;フィールド1&gt;
:*&lt;IP または URL&gt; (必須)
+
:*&lt;フィールド2&gt;
:*&lt;ポート&gt; (オプション)
+
:*&lt;フィールド3&gt;
:*&lt;説明&gt; (オプション)
+
:*&lt;&gt;
:*&lt;最小値&gt; (オプション)
+
:*&lt;マッチする値&gt;
:*&lt;最大値&gt; (オプション)
+
:*&lt;最大値&gt;
:*&lt;データ保存倍率&gt; (オプション)
+
:*&lt;最小値&gt;
:*&lt;モジュールの間隔&gt; (オプション)
+
:*&lt;再通知間隔&gt;
:*&lt;警告の最小値&gt; (オプション)
+
:*&lt;最大アラート数&gt;
:*&lt;警告の最大値&gt; (オプション)
+
:*&lt;最小アラート数&gt;
:*&lt;障害の最小値&gt; (オプション)
+
:*&lt;開始時間&gt;
:*&lt;障害の最大値&gt; (オプション)
+
:*&lt;終了時間&gt;
:*&lt;データの保存&gt; (オプション)
+
:*&lt;月曜&gt;
:*&lt;不明イベントの有効化&gt; (バージョン 5 のみ)
+
:*&lt;火曜&gt;
 
+
:*&lt;水曜&gt;
 +
:*&lt;木曜&gt;
 +
:*&lt;金曜&gt;
 +
:*&lt;土曜&gt;
 +
:*&lt;日曜&gt;
 +
:*&lt;復旧アラート&gt;
 +
:*&lt;復旧時のフィールド2&gt;
 +
:*&lt;復旧時のフィールド3&gt;
 +
:*&lt;優先度&gt;
 +
:*&lt;グループID&gt;
 +
 
 
=====例=====
 
=====例=====
  
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
+
例1 (状態: regexp =~ /pp/、アクション: Mail to XXX、最大アラート数: 10、最小アラート数: 0、優先度: 警告、グループ: database):
  
====set delete_module====
+
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=pepito&other=regex|template%20based%20in%20regexp|1||||pp|1||||10|0|||||||||||||3&other_mode=url_encode_separator_|</nowiki>
  
モジュールを削除します。
+
例2 (状態: 値が5と10の間以外、最大値: 10.00、最小値: 5.00、開始時間: 00:00:00、終了時間: 15:00:00、優先度: 障害、グループ: Servers):
  
書式:
+
<nowiki>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|NULL||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|</nowiki>
  
*op=set (必須)
+
====set update_alert_template====
*op2=delete_module (必須)
 
*id=&lt;エージェント名&gt; (必須)
 
*id2=&lt;モジュール名&gt; (必須)
 
*other=simulate (オプション)
 
  
=====例=====
+
アラートテンプレートを更新します。
 
 
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito&other=simulate
 
 
 
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito
 
 
 
====set enable_alert====
 
 
 
エージェントのアラートを有効化します。
 
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=enable_alert
+
*op2=update_alert_template (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;テンプレートID&gt; (必須) テンプレートIDでなければいけません。
*id2=&lt;モジュール名&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でテンプレートの設定とデータを指定します。
*other: アラートテンプレート名 (例: Warning イベント) (必須)
+
:*&lt;テンプレート名&gt;
 +
:*&lt;タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;アラートアクションID&gt;
 +
:*&lt;フィールド1&gt;
 +
:*&lt;フィールド2&gt;
 +
:*&lt;フィールド3&gt;
 +
:*&lt;値&gt;
 +
:*&lt;マッチする値&gt;
 +
:*&lt;最大値&gt;
 +
:*&lt;最小値&gt;
 +
:*&lt;再実行間隔&gt;
 +
:*&lt;最大アラート数&gt;
 +
:*&lt;最小アラート数&gt;
 +
:*&lt;開始時間&gt;
 +
:*&lt;終了時間&gt;
 +
:*&lt;月曜&gt;
 +
:*&lt;火曜&gt;
 +
:*&lt;水曜&gt;
 +
:*&lt;木曜&gt;
 +
:*&lt;金曜&gt;
 +
:*&lt;土曜&gt;
 +
:*&lt;日曜&gt;
 +
:*&lt;復旧アラート&gt;
 +
:*&lt;復旧時のフィールド2&gt;
 +
:*&lt;復旧時のフィールド3&gt;
 +
:*&lt;優先度&gt;
 +
:*&lt;グループID&gt;
  
===== 例 =====
+
=====例=====
  
  http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=garfio&id2=Status&other=Warning%20condition
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=38&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%201|field%20recovery%20example%202|1|8&other_mode=url_encode_separator_|</nowiki>
  
====set enable_alert_alias====
+
====set delete_alert_template====
  
エイリアスでエージェントのアラートを有効化します。
+
アラートテンプレートと、テンプレートで使われているアラートを削除します。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=enable_alert_alias
+
*op2=delete_alert_template (必須)
*id=&lt;エージェントの別名&gt; (必須)
+
*id=&lt;テンプレートID&gt; (必須) テンプレートIDでなければいけません。
*id2=&lt;モジュール名&gt; (必須)
 
*other: アラートテンプレート名 (p.e: 警告イベント) (必須)
 
  
 +
=====例=====
  
===== 例 =====
+
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38</nowiki>
  
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
+
====set delete_module_template====
  
====set disable_alert====
+
モジュールテンプレートを削除します。
 
 
エージェントのアラートを無効化します。
 
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=disable_alert
+
*op2=delete_module_template (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;alert_template_module ID&gt; (必須) alert_template_module のIDでなければいけません。
*id2=&lt;モジュール名&gt; (必須)
 
*other: アラートテンプレート名 (例: Warning イベント) (必須)
 
  
===== 例 =====
+
=====例=====
  
  http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=garfio&id2=Status&other=Warning%20condition
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38</nowiki>
  
====set disable_alert_alias====
+
====set delete_module_template_by_names====
  
エージェントのアラートを無効化します。
+
モジュールテンプレートを削除します。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=disable_alert_alias
+
*op2=delete_module_template_by_names (必須)
*id=&lt;エージェントエイリアス&gt; (必須)
+
*id=&lt;エージェント名&gt; (必須)
*id2=&lt;モジュール名&gt; (必須)
+
*id2=&lt;アラートテンプレート名&gt; (必須)
*other: アラートテンプレート名 (: 警告イベント) (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でデータを指定します。
 +
:*&lt;モジュール名&gt; (必須)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
===== 例 =====
+
=====例=====
  
  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
+
  <nowiki>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</nowiki>
  
====set enable_module_alerts====
+
====set stop_dowtime====
  
enable_alert と同じです。
+
計画停止を停止します。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=enable_module_alerts
+
*op2=stop_downtime (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;計画停止ID&gt; (必須) 計画停止IDでなければいけません。
*id2=&lt;モジュール名&gt; (必須)
 
  
===== 例 =====
+
=====例=====
  
  http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=garfio&id2=Status
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1</nowiki>
  
====set disable_module_alerts====
+
====set new_user====
  
disable_alert と同じです。
+
Pandora に新たなユーザを作成します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=disable_module_alerts
+
*op2=new_user (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
*id2=&lt;モジュール名&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番で設定とデータを指定します。
 +
:*&lt;ユーザ名&gt;
 +
:*&lt;フルネーム&gt;
 +
:*&lt;名前&gt;
 +
:*&lt;名字&gt;
 +
:*&lt;ミドルネーム&gt;
 +
:*&lt;電子メールアドレス&gt;
 +
:*&lt;電話番号&gt;
 +
:*&lt;言語&gt;
 +
:*&lt;コメント&gt;
 +
:*&lt;自動更新時間&gt;
 +
:*&lt;デフォルトイベントフィルタ&gt;
 +
:*&lt;セクション&gt;
 +
:*&lt;セッション時間&gt; (-1 は永久です)
  
===== 例 =====
+
=====例=====
  
  http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=garfio&id2=Status
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_user&id=md&other=miguel|de%20dios|matias|kkk|pandora|[email protected]|666|es|descripcion%20y%20esas%20cosas&other_mode=url_encode_separator_|</nowiki>
  
====set enable_module====
+
====Set update_user====
  
モジュールを有効化します。
+
指定した ID のユーザを指定したパラメータで更新します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=enable_module
+
*op2=update_user (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
*id2=&lt;モジュール名&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番で設定とデータを指定します。
 
+
:*&lt;フルネーム&gt;
===== 例 =====
+
:*&lt;名前&gt;
 +
:*&lt;名字&gt;
 +
:*&lt;ミドルネーム&gt;
 +
:*&lt;パスワード&gt;
 +
:*&lt;電子メールアドレス&gt;
 +
:*&lt;電話番号&gt;
 +
:*&lt;言語&gt;
 +
:*&lt;コメント&gt;
 +
:*&lt;管理者&gt;
 +
:*&lt;一画面の表示数&gt;
 +
:*&lt;フラッシュグラフ&gt;
 +
 
 +
=====例=====
  
  http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=garfio&id2=Status
+
  <nowiki>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_|</nowiki>
  
====set disable_module====
+
====set delete_user====
  
モジュールを無効化します。
+
選択したユーザを削除します。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=disable_module
+
*op2=delete_user (必須)
*id=&lt;エージェント名&gt; (必須)
+
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
*id2=&lt;モジュール名&gt; (必須)
 
  
===== 例 =====
+
=====例=====
  
  http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=garfio&id2=Status
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md</nowiki>
  
====set create_network_module_from_component====
+
====Set delete_user_permissions====
 +
{{metaconsole_ja}}
  
コンポーネントから新たなネットワークモジュールを作成します。
+
ユーザのパーミッションを削除します。
  
 
書式:
 
書式:
 +
*Op = set(必須)
 +
*Op2 =delete_user_permission(必須)
 +
*Return_type = csv|json(必須)
 +
*Other = id profile(必須)
  
*op=set (必須)
+
=====例=====
*op2=create_network_module_from_component (必須)
 
*id=&lt;エージェント名&gt; (必須)
 
*id2=&lt;コンポーネント名&gt; (必須)
 
  
===== 例 =====
+
ユーザのパーミッションを削除します。
 +
Json または CSV にて返すことができます。この戻り値は URL を介して指定します。
  
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
+
<nowiki>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</nowiki>
  
====set module_data====
+
====Set add_permission_user_group====
 +
{{metaconsole_ja}}
  
モジュールに値を追加します。
+
ユーザグループへパーミッションを追加します。
  
 
書式:
 
書式:
 +
* Op = set(必須)
 +
* Op2 =add_permission_user_to_group(必須)
 +
* Return_type = csv|json(必須)
 +
* Other = user id(必須)|group_id(必須)|profile id(必須)|No hierarchy(オプション)| profile id(オプション)
  
*op=set (必須)
+
=====例=====
*op2=module_data (必須)
+
*id=&lt;エージェントモジュールID&gt; (必須)
+
Json または CSV にて返すことができます。この戻り値は URL を介して指定します。
*other: モジュールのデータとタイムスタンプ
+
 
**dato: Pandora のデータタイプ
+
{{Warning|no_hierarchy が空の場合、値が 0 になることに注意してください。}}
**tiempo: タイムスタンプ、"now" を指定できます。
+
 
 +
{{Warning|既存のプロファイルを変更する場合は、profile_user テーブルのプロファイルIDが使用されることに注意してください。}}
  
=====例=====
+
  <nowiki>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</nowiki>
  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
 
  
====set add_module_in_conf====
+
====set enable_disable_user====
>= 5.0 (エンタープライズ版のみ)
 
  
ローカルモジュールに設定を追加します。
+
ユーザを無効化・有効化します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=add_module_in_conf (必須)
+
*op2=enable_disable_user (必須)
*id=&lt;エージェントID&gt; (必須)
+
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
*id2=&lt;モジュール名&gt; (必須)
+
other=<フラグ> (必須) 有効化する場合は 1、無効化する場合は 0 を指定します。
*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' を返します。
+
例1 (ユーザ 'example_name' を無効化)
 +
 
 +
<nowiki>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_|</nowiki>
 +
 
 +
例2 (ユーザ 'example_name' を有効化)
 +
 
 +
<nowiki>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_|</nowiki>
  
====set delete_module_in_conf====
+
====set meta_synch_user====
>= 5.0 (エンタープライズ版のみ)
 
  
ローカルモジュールの設定を削除します。
+
{{メタコンソール}}
 +
ノードへメタコンソールユーザを同期します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=add_module_in_conf (必須)
+
*op2=meta_synch_user (必須)
*id=&lt;エージェントID&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (オプション):
*id2=&lt;モジュール名&gt; (必須)
+
:*&lt;user_name_1,user_name_2,user_name_3..&gt; (先頭および末尾にスペースを入れずにカンマで区切ったユーザ名, 必須)
 +
:*&lt;server_name&gt; (必須)
 +
:*&lt;profile_mode(1-0)&gt; (オプション)
 +
:*&lt;group_name&gt; (オプション)
 +
:*&lt;profile_1,profile_2,profile_3&gt; (最初と最後にスペースを入れずにカンマで区切ったプロファイル, オプション)
 +
:*&lt;create_groups(1-0)&gt; (オプション)
  
 
=====例=====
 
=====例=====
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' を返します。
+
<nowiki>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_|</nowiki>
  
====set update_module_in_conf====
+
====set create_group====
>= 5.0 (エンタープライズ版のみ)
 
  
ローカルモジュールの設定を更新します。
+
グループを作成します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=update_module_in_conf (必須)
+
*op2=create_group (必須)
*id=&lt;エージェントID&gt; (必須)
+
*id=&lt;グループ名&gt; (必須) グループ名を指定します。
*id2=&lt;モジュール名&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
*other: conf ファイル内のモジュール設定を置き換える内容を、base64 でエンコードしたもの。(必須)
+
:*&lt;アイコン名&gt;
 +
:*&lt;親グループID&gt; (オプション)
 +
:*&lt;説明&gt; (オプション)
 +
:*&lt;ACLの伝播&gt; (オプション)
 +
:*&lt;アラートの無効化&gt; (オプション)
 +
:*&lt;カスタムID&gt; (オプション)
 +
:*&lt;連絡先&gt; (オプション)
 +
:*&lt;その他&gt; (オプション)
  
 
=====例=====
 
=====例=====
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' を返します。
+
例1 (親グループ: Servers)
 +
 
 +
  <nowiki>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_|</nowiki>
 +
 +
例2 (親グループなし)
 +
 
 +
  <nowiki>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_|</nowiki>
  
====set create_event====
+
====set update_group====
  
Pandora 内に新たなイベントを作成します。
+
グループの設定を更新します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=create_event (必須)
+
*op2=update_group (必須)
*other=&lt;連続パラメータ&gt; (必須) 次の順番でイベントデータを指定します:
+
*id=&lt;グループID&gt; (必須) グループIDを指定します。
:*&lt;イベントテキスト&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
:*&lt;グループID&gt; (必須)
+
:*&lt;グループ名&gt;  
:*&lt;エージェントID&gt; (必須)
+
:*&lt;アイコン名&gt;  
:*&lt;状態&gt;
+
:*&lt;親グループID&gt;  
:*&lt;ユーザID&gt;
+
:*&lt;説明&gt;  
:*&lt;イベントタイプ&gt;
+
:*&lt;ACLの伝播&gt;  
:*&lt;重要度&gt;
+
:*&lt;アラートの無効化&gt;  
:*&lt;エージェントモジュールID&gt;
+
:*&lt;カスタムID&gt;  
:*&lt;アラートID&gt;
+
:*&lt;連絡先&gt;  
:*&lt;障害の説明&gt;
+
:*&lt;その他&gt;  
:*&lt;警告の説明&gt;
 
:*&lt;不明の説明&gt;
 
:*&lt;コメント&gt;
 
:*&lt;ユーザコマンド&gt;
 
:*&lt;発生元&gt;
 
:*&lt;タグ&gt;
 
:*&lt;カスタムデータ&gt; カスタムデータは、base64 でエンコードされた JSON データである必要があります。
 
  
 
=====例=====
 
=====例=====
  
http://127.0.0.1/pandora_trunk/include/api.php?op=set&op2=create_event&other=NewEvent|0|189||apiuser|system|1||||||||VMware||eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
  <nowiki>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</nowiki>
  
====set add_event_comment====
+
====set delete_group====
  
>= 5.1
+
グループを削除します。
  
イベントにコメントを追加します。
+
書式:
  
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=create_event (必須)
+
*op2=update_group (必須)
*other=&lt;連続パラメータ&gt; (必須) 次の順番でイベントデータを指定します:
+
*id=&lt;グループID&gt; (必須) グループIDを指定します。
:*&lt;コメント&gt; (必須)
 
  
 
=====例=====
 
=====例=====
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_netflow_filter====
+
====set add_user_profile====
(>=5.0)
 
  
新たな netflow フィルタを作成します。
+
ユーザにプロファイルを追加します。
  
 
書式:
 
書式:
 +
 
*op=set (必須)
 
*op=set (必須)
*op2=create_netflow_filter (必須)
+
*op2=add_user_profile (必須)
*other=&lt;連続パラメータ&gt; (必須) 次の順番でフィルタデータを指定します:
+
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
:*&lt;フィルター名&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でグループの設定、プロファイルを指定します。
:*&lt;グループID&gt; (必須)
+
:*&lt;グループ&gt;
:*&lt;フィルタ&gt; (必須)
+
:*&lt;プロファイル&gt;
:*&lt;集約方法&gt; (設定可能な値: dstip,dstport,none,proto,srcip,srcport)  (必須)
 
:*&lt;出力フォーマット&gt; (設定可能な値: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (必須)
 
  
 
=====例=====
 
=====例=====
 +
<nowiki>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_|</nowiki>
  
http://127.0.0.1/pandora/include/api.php?op=set&op2=create_netflow_filter&apipass=1234&user=admin&pass=pandora&other=Filter%20name|9|host%20192.168.50.3%20OR%20host%20192.168.50.4%20or%20HOST%20192.168.50.6|dstport|kilobytes&other_mode=url_encode_separator_|
+
====set delete_user_profile====
  
====set create_custom_field====
+
ユーザのプロファイルを削します。
>= 5.0
 
  
新たなカスタムフィールドを作成します。
+
書式:
  
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=create_custom_field (必須)
+
*op2=delete_user_profile (必須)
*other=&lt;連続パラメータ&gt; (必須) カスタムフィールドを設定するパラメータ
+
*id=&lt;ユーザ名&gt; (必須) ユーザ名でなければいけません。
:*&lt;名前&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でグループおよびプロファイルを指定します。
:*&lt;フロント表示フラグ&gt; (必須; 0:操作画面でフィールドを表示しない。1:フィールドを表示する。)
+
:*&lt;グループ&gt;
 +
:*&lt;プロファイル&gt;
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_custom_field&other=mycustomfield|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
  <nowiki>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_|</nowiki>
  
====set create_tag====
+
====set new_incident====
>= 5.0
 
  
新たなタグを作成します。
+
新たなインシデントを作成します。
  
 
書式:
 
書式:
 
*op=set (必須)
 
*op=set (必須)
*op2=create_tag (必須)
+
*op2=new_incident (必須)
*other=&lt;連続パラメータ&gt; (必須) タグの設定パラメータ
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番でインシデントの設定とデータを指定します。
:*&lt;名前&gt; タグ名 (必須)
+
:*&lt;タイトル&gt;
:*&lt;説明&gt; タグの説明
+
:*&lt;説明&gt;
:*&lt;url&gt; タグの URL
+
:*&lt;作成者&gt;
:*&lt;email&gt; タグのメールアドレス
+
:*&lt;優先度&gt;
 +
:*&lt;状態&gt;
 +
:*&lt;グループ&gt;
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_tag&other=tag_name|tag_description|tag_url|tag_email&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
  <nowiki>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_|</nowiki>
  
====set enable_disable_agent====
+
====set new_note_incident====
  
エージェントを有効化/無効化します。
+
インシデントにコメントを追加します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=enable_disable_agent (必須)
+
*op2=new_note_incident (必須)
*id=&lt;エージェントID&gt; (必須) エージェントIDでなければいけません。
+
*id=&lt;インシデントID&gt; (必須) インシデントのIDです。
*other=&lt;フラグ&gt; (必須) 有効化する場合は 1、無効化する場合は 0 を指定します。
+
*id2=&lt;ユーザ名&gt; (必須) ユーザ名です。
 +
*other=&lt;コメント&gt; (必須) URLエンコードされたコメントです。
  
 
=====例=====
 
=====例=====
  
例1 (エージェント 'example_id' を無効化)
+
<nowiki>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</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
====set validate_all_alerts====
  
例2 (エージェント 'example_id' を有効化)
+
全アラートを承諾します。
 
 
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 
 
 
====set gis_agent_only_position====
 
>= 5.0
 
 
 
エージェントに、新たな GIS 位置情報を追加します。
 
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=gis_agent_only_position (必須)
+
*op2=validate_all_alerts (必須)
*id=<id> (必須) エージェントID
 
*other=&lt;連続パラメータ&gt; (必須) 位置情報パラメータ
 
:*&lt;緯度&gt;
 
:*&lt;経度&gt;
 
:*&lt;高度&gt;
 
  
 
=====例=====
 
=====例=====
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0
+
====set validate_all_policy_alerts====
  
====set gis_agent====
+
ポリシーから作成されたアラートを承諾します。
>= 5.0
 
 
 
エージェントに gis データを追加します。
 
  
 
書式:
 
書式:
 +
*op=set (必須)
 +
*op2=validate_all_policy_alerts (必須)
  
*op=set (必須)
+
=====例=====
*op2=gis_agent_only_position (必須)
+
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts</nowiki>
*id=<id> (必須) エージェントID
 
*other=&lt;連続パラメータ&gt; (必須) gisデータ
 
:*&lt;緯度&gt;
 
:*&lt;経度&gt;
 
:*&lt;高度&gt;
 
:*&lt;新たなgisデータの無視&gt;
 
:*&lt;手動位置決め&gt;
 
:*&lt;開始タイムスタンプ&gt;
 
:*&lt;終了タイムスタンプ&gt;
 
:*&lt;データ数&gt;
 
:*&lt;履歴保存の説明&gt;
 
:*&lt;gis更新の説明&gt;
 
:*&lt;初回挿入の説明&gt;
 
  
====set create_special_day====
+
====set event_validate_filter====
>= 5.1
 
  
新たな特別日を追加します。
+
指定したフィルタにマッチするすべてのイベントを承諾します。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=update_special_day (必須)
+
*op2=event_validate_filter (必須)
*id=<id> (必須) エージェントID
+
*other_mode=url_encode_separator_|(オプション)
*other=&lt;連続パラメータ&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (オプション) 次の順番で指定します。
:*&lt;特別日&gt;
+
:*&lt;セパレータ&gt;
:*&lt;同一の日&gt;
+
:*&lt;重要度&gt; 0 から 4
:*&lt;説明&gt;
+
:*&lt;エージェント名&gt;
:*&lt;グループID&gt;
+
:*&lt;モジュール名&gt;
 +
:*&lt;アラートテンプレート名&gt;
 +
:*&lt;ユーザ&gt;
 +
:*&lt; 最小レベルの数値間隔&gt; UNIXタイムスタンプ
 +
:*&lt; 最大レベルの数値間隔&gt; UNIXタイムスタンプ
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?apipass=caca&user=admin&pass=pandora&op=set&op2=create_special_day&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2</nowiki>
  
====set update_special_day====
+
====set event_validate_filter_pro====
>= 5.1
 
  
定義済の特別日の設定を更新します。
+
前述の API と似たものです。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=update_special_day (必須)
+
*op2=event_validate_filter_pro (必須)
*id=&lt;特別日ID&gt; (compulsory)
+
*other_mode=url_encode_separator_| (オプション)
*other=&lt;連続パラメータ&gt; (必須)
+
*other=&lt;連続パラメータ&gt; (オプション) 次の順番で指定します。
:*&lt;特別日&gt;
+
:*&lt;セパレータ&gt;
:*&lt;同一の日&gt;
+
:*&lt;重要度&gt; 0 から 4
:*&lt;説明&gt;
+
:*&lt;エージェントID&gt;
:*&lt;グループID&gt;
+
:*&lt;モジュールID&gt;
 +
:*&lt;エージェントモジュールアラートID&gt;
 +
:*&lt;ユーザ&gt;
 +
:*&lt;最小レベルの数値間隔&gt; UNIXタイムスタンプ
 +
:*&lt;最大レベルの数値間隔&gt; UNIXタイムスタンプ
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?apipass=caca&user=admin&pass=pandora&op=set&op2=update_special_day&id=1&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2</nowiki>
  
====set delete_special_day====
+
====set validate_event_by_id====
>= 5.1
 
  
特別日を削除。
+
指定した ID のイベントを承諾します。
  
 
書式:
 
書式:
 
 
*op=set (必須)
 
*op=set (必須)
*op2=update_special_day (必須)
+
*op2=validate_event_by_id (必須)
*id=<特別日ID> (必須)
+
*id=<event_id> (必須) イベント ID です。
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?apipass=caca&user=admin&pass=pandora&op=set&op2=delete_special_day&id=1
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=validate_event_by_id&id=23&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set pagerduty_webhook====
+
====set new_alert_template====
>= 5.1
 
  
Pandora FMS アラートと PagerDuty 通知を接続します。PagerDuty サービスの webhooks オプションを、PagerDuty からアラートを承諾した場合の動作に対して、あらかじめ PagerDuty にリンクさせた Pandora FMS のアラートの承諾に設定します。
+
テンプレートおよび、エージェントIDおよびモジュール名からモジュールを指定して、新たなアラートを適用します。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=pagerduty_webhook (必須)
+
*op2=new_alert_template (必須)
*id=alert (必須)
+
*id=&lt;エージェント名&gt; (必須)
 +
*id2=&lt;アラートテンプレート名&gt; (必須)
 +
*other_mode=url_encode_separator_| (オプション)
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
 +
:*&lt;モジュール名&gt; (必須)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert
+
  <nowiki>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</nowiki>
  
====set tag_user_profile====
+
====set alert_actions====
>= 6
 
  
ユーザのプロファイルにタグを追加します。
+
アラートにアクションを追加します。
  
 
書式:
 
書式:
 
+
*op=set (必須)
* op = set (必須)
+
*op2=alert_actions (必須)
* op2 = tag_user_profile (必須)
+
*id=&lt;エージェント名&gt; (必須)
* id = id_user (必須)
+
*id2=&lt;アラートテンプレート名&gt; (必須)
* id2 = id_tag (必須)
+
*other_mode=url_encode_separator_| (オプション)
* other_mode = url_encode_separator_| (必須)
+
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
* other = <id_group>|<id_profile> (必須)
+
:*&lt;モジュール名&gt; (必須)
 +
:*&lt;アクション名&gt; (必須)
 +
:*&lt;開始アラート数&gt; (オプション)
 +
:*&lt;終了アラート数&gt; (オプション)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag_user_profile&apipass=1234&user=admin&pass=pandora&id=1&id2=2&other_mode=url_encode_separator_|&other=122|3
+
  <nowiki>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</nowiki>
  
====set tag====
+
<nowiki>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</nowiki>
>= 6
 
  
pandora にタグを追加します。
+
====set alert_commands====
  
書式:
+
アラートにコマンドを追加します。
 
 
* op = set (必須)
 
* op2 = tag (必須)
 
* id = name (必須)
 
* other_mode = url_encode_separator_| (必須)
 
* other = <description>|<url>|<email>|<phone>
 
 
 
=====例=====
 
 
 
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag&apipass=1234&user=admin&pass=pandora&id=test&other_mode=url_encode_separator_|&other="a test"|http://www.artica.es|[email protected]|01189998819991197253
 
 
 
====set add_tag_module====
 
>= 6
 
 
 
モジュールにタグを追加します。
 
  
 
書式:
 
書式:
 
+
*op=set (必須)
* op = set (必須)
+
*op2=alert_commands (必須)
* op2 = add_tag_module (必須)
+
*id=&lt;コマンド名&gt; (必須)
* id = id_module (必須)
+
*other_mode=url_encode_separator_| (オプション)
* id2 = id_tag (必須)
+
*other=&lt;連続パラメータ&gt; (必須), 次の順番:
 +
:*&lt;command&gt; (必須)
 +
:*&lt;id_group&gt; (必須)
 +
:*&lt;description &gt; (必須)
 +
:*&lt;internal &gt; (オプション)
 +
:*&lt;field_description_1&gt;&lt;field_value_1&gt;&lt;field_description_2&gt;&lt;field_value_2&gt;...&lt;field_description_n&gt;&lt;field_value_n&gt;
  
 
=====例=====
 
=====例=====
 +
<nowiki>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</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2
+
====set new_module====
  
====set remove_tag_module====
+
新たなモジュールを作成します。
>= 6
 
 
 
モジュールのタグを削除します。
 
  
 
書式:
 
書式:
  
* op = set (必須)
+
*op=set (必須)
* op2 = add_tag_module (必須)
+
*op2=new_module (必須)
* id = id_module (必須)
+
*id=&lt;エージェント名&gt; (必須)
* id2 = id_tag (必須)
+
*id2=&lt;新たなモジュール名&gt; (必須)
 
+
*other_mode=url_encode_separator_| (オプション)
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番で指定します。
 +
:*&lt;ネットワークモジュールの種類&gt; (必須)
 +
:*&lt;アクション名&gt; (必須)
 +
:*&lt;IP または URL&gt; (必須)
 +
:*&lt;ポート&gt; (オプション)
 +
:*&lt;説明&gt; (オプション)
 +
:*&lt;最小値&gt; (オプション)
 +
:*&lt;最大値&gt; (オプション)
 +
:*&lt;データ保存倍率&gt; (オプション)
 +
:*&lt;モジュールの間隔&gt; (オプション)
 +
:*&lt;警告の最小値&gt; (オプション)
 +
:*&lt;警告の最大値&gt; (オプション)
 +
:*&lt;障害の最小値&gt; (オプション)
 +
:*&lt;障害の最大値&gt; (オプション)
 +
:*&lt;データの保存&gt; (オプション)
 +
:*&lt;不明イベントの有効化&gt; (バージョン 5 のみ)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
 +
 
 
=====例=====
 
=====例=====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2
+
  <nowiki>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</nowiki>
  
====set planned_downtimes_created====
+
====set delete_module====
>= 5.1
 
  
計画停止を作成します
+
モジュールを削除します。
  
 
書式:
 
書式:
  
 
*op=set (必須)
 
*op=set (必須)
*op2=planned_downtimes_created (必須)
+
*op2=delete_module (必須)
*other=&lt;連続パラメータ&gt; (必須) 計画停止を作成するパラメータ列:
+
*id=&lt;エージェント名&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
*other=simulate (オプション)
 +
:*&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
 +
 
 +
=====例=====
 +
 
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito&other=simulate</nowiki>
 +
 
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito</nowiki>
  
:*&lt;説明&gt;
+
====set enable_alert====
:*&lt;開始日時&gt; 一回のみの場合の開始日時
 
:*&lt;終了日時&gt; 一回のみの場合の終了日時
 
:*&lt;グループID&gt;
 
:*&lt;月&gt;
 
:*&lt;火&gt;
 
:*&lt;水&gt;
 
:*&lt;木&gt;
 
:*&lt;金&gt;
 
:*&lt;土&gt;
 
:*&lt;日&gt;
 
:*&lt;定期実行開始時間&gt;
 
:*&lt;定期実行終了時間&gt;
 
:*&lt;定期実行開始日&gt;
 
:*&lt;定期実行終了日&gt;
 
:*&lt;タイプ&gt;  quit, disabled_agents, disabled_agents_alerts のいずれか
 
:*&lt;実行&gt; once または periodically
 
:*&lt;定期実行タイプ&gt; weekly または monthly
 
  
 +
エージェントのアラートを有効化します。
  
=====例=====
+
書式:
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&id=pepito&other=testing|08/04/2015|08/31/2015|0|1|1|1|1|1|1|1|17:06:00|19:06:00|1|31|quiet|periodically|weekly&other_mode=url_encode_separator_|
+
*op=set (必須)
 +
*op2=enable_alert
 +
*id=&lt;エージェント名&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
*other: アラートテンプレート名 (例: Warning イベント) (必須)
  
====set planned_downtimes_additem====
+
===== 例 =====
>= 5.1
 
  
計画停止に対象エージェント(および対象モジュール)を追加します
+
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=garfio&id2=Status&other=Warning%20condition</nowiki>
  
書式:
+
====set enable_alert_alias====
  
*op=set
+
エイリアスでエージェントのアラートを有効化します。
*op2=planned_downtimes_additem
 
*id=&lt;計画停止ID&gt;
 
*other=&lt;連続パラメータ&gt; (必須) 追加対象
 
  
:*&lt;エージェントID1;エージェントID2;エージェントID3;...エージェントIDn&gt;
+
書式:
:*&lt;モジュール名1;モジュール名2;モジュール名3;...モジュール名n&gt;
 
  
=====例=====
+
*op=set (必須)
 +
*op2=enable_alert_alias
 +
*id=&lt;エージェントの別名&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
*other: アラートテンプレート名 (p.e: 警告イベント) (必須)
 +
 
 +
 
 +
===== 例 =====
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&id=123&other=1;2;3;4|Status;Unkown_modules&other_mode=url_encode_separator_|
+
<nowiki>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</nowiki>
  
====set planned_downtimes_deleted====
+
====set disable_alert====
>=5.1
 
  
計画停止を削除します。
+
エージェントのアラートを無効化します。
  
 
書式:
 
書式:
  
*op=set
+
*op=set (必須)
*op2=planned_downtimes_deleted
+
*op2=disable_alert
*id=&lt;計画停止ID&gt;
+
*id=&lt;エージェント名&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
*other: アラートテンプレート名 (例: Warning イベント) (必須)
  
=====例=====
+
===== 例 =====
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted &id=10
+
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=garfio&id2=Status&other=Warning%20condition</nowiki>
  
====set create_synthetic_module====
+
====set disable_alert_alias====
>=5.1SP4
 
  
新たな統合モジュールを作成します。
+
エージェントのアラートを無効化します。
  
 
書式:
 
書式:
  
*op=set
+
*op=set (必須)
*op2=create_synthetic_module
+
*op2=disable_alert_alias
*id=モジュールを追加するエージェント名
+
*id=&lt;エージェントエイリアス&gt; (必須)
*other= <モジュール名><統合タイプ><エージェント名;演算タイプ;モジュール名> または <エージェント名;モジュール名> または <演算タイプ;値>
+
*id2=&lt;モジュール名&gt; (必須)
 +
*other: アラートテンプレート名 (例: 警告イベント) (必須)
  
**モジュールのデータ:
+
===== 例 =====
  演算設定の場合で、エージェントとモジュール名を指定して演算タイプを指定しない場合: <エージェント名;モジュール名>、値を指定する場合: <演算タイプ;値>. それ以外: <エージェント名;演算タイプ;モジュール名> または <演算タイプ;値>
 
  平均: <エージェント名;演算タイプ;モジュール名> または <演算タイプ;値>
 
  
**演算タイプ:
+
<nowiki>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</nowiki>
  演算: ADD, SUB, MUL, DIV
 
  平均: AVG のみ
 
  
=====例=====
+
====set enable_module_alerts====
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&id=test&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;ADD;Module%20Name2&other_mode=url_encode_separator_|
 
OR
 
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&id=pepito&other=prueba|average|Agent%20Name;AVG;Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|
 
  
====set create_service====
+
enable_alert と同じです。
>= 7
 
 
 
新たなサービスを作成します。
 
  
 
書式:
 
書式:
  
*op=set
+
*op=set (必須)
*op2=create_service
+
*op2=enable_module_alerts
*id=サービスID
+
*id=&lt;エージェント名&gt; (必須)
*other=<名前>;<説明>;<グループID>;<障害>;<警告>;<エージェントID>;<SLA間隔>;<SLA制限>;
+
*id2=&lt;モジュール名&gt; (必須)
<警告モジュールアラートテンプレートID>;<障害モジュールアラートテンプレートID>;<障害モジュールSLAアラートテンプレートID>;
+
*other (オプション)=&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
=====例=====
+
===== 例 =====
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_service&return_type=json&other=test1%7CDescripcion%7C12%7C1%7C0.5%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=garfio&id2=Status</nowiki>
  
====set update_service====
+
====set disable_module_alerts====
>= 7
 
  
サービスを更新します。
+
disable_alert と同じです。
  
 
書式:
 
書式:
  
*op=set
+
*op=set (必須)
*op2=update_service
+
*op2=disable_module_alerts
*id=サービスID
+
*id=&lt;エージェント名&gt; (必須)
*other=<名前>;<説明>;<グループID>;<障害>;<警告>;<エージェントID>;<SLA間隔>;<SLA制限>;
+
*id2=&lt;モジュール名&gt; (必須)
<警告モジュールアラートテンプレートID>;<障害モジュールアラートテンプレートID>;<障害モジュールSLAアラートテンプレートID>;
+
*other (オプション)=&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
=====例=====
+
===== 例 =====
  
  http://172.17.0.1/pandora_console/include/api.php?op=set&op2=update_service&return_type=json&id=1&other=test2%7CDescripcion2%7C%7C%7C0.6%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=garfio&id2=Status</nowiki>
  
====set add_element_service====
+
====set enable_module====
>= 7
 
  
サービスに要素を追加します。
+
モジュールを有効化します。
  
 
書式:
 
書式:
  
*op=set
+
*op=set (必須)
*op2=add_element_service
+
*op2=enable_module
*id=サービスID
+
*id=&lt;エージェント名&gt; (必須)
*other=base64エンコードした要素のJson
+
*id2=&lt;モジュール名&gt; (必須)
 +
*other (オプション)=&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
json の構造は次の通りです。
+
===== 例 =====
  
[{"type":"agent","id":2,"description":"Test1","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"module","id":1,"description":"Test2","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"service","id":3,"description":"Test3","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0}]
+
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=garfio&id2=Status</nowiki>
  
それぞれのタイプで、ID フィールドは異なるものを参照します。
+
====set disable_module====
  
- タイプが agent の場合は、エージェント ID です。
+
モジュールを無効化します。
  
- タイプが module の場合は、エージェントモジュール ID です。
+
書式:
  
- タイプが service の場合は、追加したいサービス ID です。
+
*op=set (必須)
 +
*op2=disable_module
 +
*id=&lt;エージェント名&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
*other (オプション)=&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
  
=====例=====
+
===== 例 =====
  
  http://172.17.0.1/pandora_console/include/api.php?op=set&op2=add_element_service&return_type=json&id=6&other=W3sidHlwZSI6ImFnZW50IiwiaWQiOjIsImRlc2NyaXB0aW9uIjoiamlqaWppIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoibW9kdWxlIiwiaWQiOjEsImRlc2NyaXB0aW9uIjoiSG9sYSBxdWUgdGFsIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoic2VydmljZSIsImlkIjozLCJkZXNjcmlwdGlvbiI6ImplamVqZWplIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH1d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=garfio&id2=Status</nowiki>
  
====set metaconsole_synch====
+
====set create_network_module_from_component====
>= 7
 
  
ライセンスキーをメタコンソールへ追加し、ノードへ同期します。
+
コンポーネントから新たなネットワークモジュールを作成します。
  
*op=set
+
書式:
*op2=metaconsole_synch
 
*id=License key
 
  
=====例=====
+
*op=set (必須)
 +
*op2=create_network_module_from_component (必須)
 +
*id=&lt;エージェント名&gt; (必須)
 +
*id2=&lt;コンポーネント名&gt; (必須)
 +
*other (オプション)=&lt;エージェントの別名の利用&gt; (値は 0 または 1 です)
 +
 
 +
===== 例 =====
 +
 
 +
<nowiki>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</nowiki>
  
http://127.0.0.1/pandora_console/enterprise/meta/include/api.php?op=set&op2=metaconsole_synch&id=LICENSEKEY&apipass=1234&user=admin&pass=pandora
+
====set module_data====
  
====set migrate_agent====
+
モジュールに値を追加します。この機能は、サーバに送信するデータを含む XML を生成します。このデータはデータベースを更新するためのものです。
  
>= 7.21 メタコンソールのみ
+
この API 呼び出しは、XML ファイルの生成を制御し、そのプロセスの状態をメッセージで表示します。
  
選択したエージェントをエージェントマイグレーションキューへ追加します。
+
書式:
  
*op=set
+
*op=set (必須)
*op2=migrate_agent
+
*op2=module_data (必須)
*id=id_agent to migrate
+
*id=&lt;エージェントモジュールID&gt; (必須)
*other=origin node name| destination node name | (true|false) not to migrate historical database
+
*other: モジュールのデータとタイムスタンプ
*other_mode=url_encode_separator_|
+
**dato: Pandora のデータタイプ
*return_type = string, json, etc
+
**tiempo: タイムスタンプ、"now" を指定できます。
  
 
=====例=====
 
=====例=====
 +
<nowiki>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</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&other=nova|fringe|0&other_mode=url_encode_separator_|&return_type=string
+
{{Warning|XML ファイルの生成が成功しても、データがデータベースに保存されることは保証されません。}}
  
====get migrate_agent====
+
====set new_module_group====
  
>= 7.21 メタコンソールのみ
+
新たなモジュールグループを作成します。
  
エージェントマイグレーションキューに、指定のエージェントが存在するかを確認します。
+
書式:
 
+
*op=set (必須)
*op=get
+
*op2=new_module_group (必須)
*op2=migrate_agent
+
*id=&lt;モジュールグループ名&gt; (必須)
*id=id_agente a migrar
 
*return_type = string, json, etc
 
  
 
=====例=====
 
=====例=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora</nowiki>
  
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
+
====set module_group_synch====
  
== 例 ==
+
{{メタコンソール}}
 +
メタコンソールからモジュールグループを同期します。
  
Pandora API を呼び出すためのいくつかの言語での例です。
+
書式:
 +
*op=set (必須)
 +
*op2=module_group_synch (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) メタコンソールと同期するサーバの名前が必須です。
 +
:*&lt;server_name_1&gt;&lt;server_name_2&gt;...&lt;server_name_n&gt; (必須)
  
 
=====例=====
 
=====例=====
 +
<nowiki>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</nowiki>
 +
 +
====set add_module_in_conf====
 +
>= 5.0 (エンタープライズ版のみ)
 +
 +
ローカルモジュールに設定を追加します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=add_module_in_conf (必須)
 +
*id=&lt;エージェントID&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
*other: conf ファイルに書くモジュール設定を base64 でエンコードしたもの (必須)
 +
 +
=====例=====
 +
<nowiki>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</nowiki>
 +
 +
成功すると '0'、エラー時は '-1'、すでに存在する場合は '-2' を返します。
 +
 +
====set delete_module_in_conf====
 +
>= 5.0 (エンタープライズ版のみ)
 +
 +
ローカルモジュールの設定を削除します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=add_module_in_conf (必須)
 +
*id=&lt;エージェントID&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
 +
=====例=====
 +
<nowiki>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</nowiki>
 +
 +
成功すると '0'、エラー時は '-1' を返します。
 +
 +
====set update_module_in_conf====
 +
>= 5.0 (エンタープライズ版のみ)
 +
 +
ローカルモジュールの設定を更新します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=update_module_in_conf (必須)
 +
*id=&lt;エージェントID&gt; (必須)
 +
*id2=&lt;モジュール名&gt; (必須)
 +
*other: conf ファイル内のモジュール設定を置き換える内容を、base64 でエンコードしたもの。(必須)
 +
 +
=====例=====
 +
<nowiki>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</nowiki>
 +
 +
変更が無い場合は '1'、成功すると '0'、エラー時は '-1'、存在しない場合は '-2' を返します。
 +
 +
====set create_event====
 +
 +
Pandora 内に新たなイベントを作成します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=create_event (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番でイベントデータを指定します:
 +
:*&lt;イベントテキスト&gt; (必須)
 +
:*&lt;グループID&gt; (必須)
 +
:*&lt;エージェントID&gt; (必須)
 +
:*&lt;状態&gt;
 +
:*&lt;ユーザID&gt;
 +
:*&lt;イベントタイプ&gt;
 +
:*&lt;重要度&gt;
 +
:*&lt;エージェントモジュールID&gt;
 +
:*&lt;アラートID&gt;
 +
:*&lt;障害の説明&gt;
 +
:*&lt;警告の説明&gt;
 +
:*&lt;不明の説明&gt;
 +
:*&lt;コメント&gt;
 +
:*&lt;ユーザコマンド&gt;
 +
:*&lt;オーナーユーザ&gt;(文字列)
 +
:*&lt;発生元&gt;
 +
:*&lt;タグ&gt;
 +
:*&lt;カスタムデータ&gt; カスタムデータは、base64 でエンコードされた JSON データである必要があります。
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_trunk/include/api.php?op=set&op2=create_event&other=NewEvent|0|189||apiuser|system|1||||||||VMware||eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set add_event_comment====
 +
 +
イベントにコメントを追加します。
 +
 +
{{Tip|これはメタコンソールでも利用できます。}}
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=create_event (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番でイベントデータを指定します:
 +
:*&lt;コメント&gt; (必須)
 +
 +
{{Tip|メタコンソールで利用するには、"string" の後に "true" をパラメータで指定してください。}}
 +
 +
=====例=====
 +
 +
* ノード
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
* メタコンソール
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string|true&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set update_event====
 +
 +
API を通してイベントを更新します。
 +
 +
{{Tip|この機能は、メタコンソールでも利用できます。}}
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=event (必須)
 +
*id=event_id (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) 更新するイベントデータ
 +
*&lt;comment&gt; (必須)
 +
 +
=====例=====
 +
* ノード:
 +
 +
<nowiki>http://192.168.80.190/pandora_console/include/api.php?op=set&op2=event&apipass=pandora&user=admin&pass=pandora&id=175&other_mode=url_encode_separator_|&other=estado,2|evento,cambiadito2</nowiki>
 +
 +
* メタコンソール:
 +
 +
<nowiki>http://192.168.80.35/pandora_console/include/api.php?op=set&op2=event&apipass=1234&user=admin&pass=t3st1ng!&id=315132&other_mode=url_encode_separator_|&other=estado,0|evento,pepe|custom_data,1</nowiki>
 +
 +
====set create_netflow_filter====
 +
(>=5.0)
 +
 +
新たな netflow フィルタを作成します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=create_netflow_filter (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) 次の順番でフィルタデータを指定します:
 +
:*&lt;フィルター名&gt; (必須)
 +
:*&lt;グループID&gt; (必須)
 +
:*&lt;フィルタ&gt; (必須)
 +
:*&lt;集約方法&gt; (設定可能な値: dstip,dstport,none,proto,srcip,srcport)  (必須)
 +
:*&lt;出力フォーマット&gt; (設定可能な値: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (必須)
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora/include/api.php?op=set&op2=create_netflow_filter&apipass=1234&user=admin&pass=pandora&other=Filter%20name|9|host%20192.168.50.3%20OR%20host%20192.168.50.4%20or%20HOST%20192.168.50.6|dstport|kilobytes&other_mode=url_encode_separator_|</nowiki>
 +
 +
====set create_custom_field====
 +
>= 5.0
 +
 +
新たなカスタムフィールドを作成します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=create_custom_field (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) カスタムフィールドを設定するパラメータ
 +
:*&lt;名前&gt; (必須)
 +
:*&lt;フロント表示フラグ&gt; (必須; 0:操作画面でフィールドを表示しない。1:フィールドを表示する。)
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_custom_field&other=mycustomfield|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set create_tag====
 +
>= 5.0
 +
 +
新たなタグを作成します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=create_tag (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) タグの設定パラメータ
 +
:*&lt;名前&gt; タグ名 (必須)
 +
:*&lt;説明&gt; タグの説明
 +
:*&lt;url&gt; タグの URL
 +
:*&lt;email&gt; タグのメールアドレス
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_tag&other=tag_name|tag_description|tag_url|tag_email&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set enable_disable_agent====
 +
 +
エージェントを有効化/無効化します。
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=enable_disable_agent (必須)
 +
*id=&lt;エージェントID&gt; (必須) エージェントIDでなければいけません。
 +
*other=&lt;フラグ&gt; (必須) 有効化する場合は 1、無効化する場合は 0 を指定します。
 +
 +
=====例=====
 +
 +
例1 (エージェント 'example_id' を無効化)
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
例2 (エージェント 'example_id' を有効化)
 +
 
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set gis_agent_only_position====
 +
>= 5.0
 +
 +
エージェントに、新たな GIS 位置情報を追加します。
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=gis_agent_only_position (必須)
 +
*id=<id> (必須) エージェントID
 +
*other=&lt;連続パラメータ&gt; (必須) 位置情報パラメータ
 +
:*&lt;緯度&gt;
 +
:*&lt;経度&gt;
 +
:*&lt;高度&gt;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0</nowiki>
 +
 +
====set gis_agent====
 +
>= 5.0
 +
 +
エージェントに gis データを追加します。
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=gis_agent_only_position (必須)
 +
*id=<id> (必須) エージェントID
 +
*other=&lt;連続パラメータ&gt; (必須) gisデータ
 +
:*&lt;緯度&gt;
 +
:*&lt;経度&gt;
 +
:*&lt;高度&gt;
 +
:*&lt;新たなgisデータの無視&gt;
 +
:*&lt;手動位置決め&gt;
 +
:*&lt;開始タイムスタンプ&gt;
 +
:*&lt;終了タイムスタンプ&gt;
 +
:*&lt;データ数&gt;
 +
:*&lt;履歴保存の説明&gt;
 +
:*&lt;gis更新の説明&gt;
 +
:*&lt;初回挿入の説明&gt;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc</nowiki>
 +
 +
====set reset_agent_counts====
 +
 +
エージェントのモジュールおよびアラートカウントを更新します。
 +
 +
書式:
 +
*op=set (必須)
 +
*op2=reset_agent_counts (必須)
 +
*id=<id_agent> (必須) エージェント ID もしくは "All" である必要があります。
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=reset_agent_counts&apipass=1234&user=admin&pass=pandora&id=All</nowiki>
 +
 +
====set create_special_day====
 +
>= 5.1
 +
 +
新たな特別日を追加します。
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=update_special_day (必須)
 +
*id=<id> (必須) エージェントID
 +
*other=&lt;連続パラメータ&gt; (必須)
 +
:*&lt;特別日&gt;
 +
:*&lt;同一の日&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;グループID&gt;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=create_special_day&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0</nowiki>
 +
 +
====set update_special_day====
 +
>= 5.1
 +
 +
定義済の特別日の設定を更新します。
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=update_special_day (必須)
 +
*id=&lt;特別日ID&gt; (compulsory)
 +
*other=&lt;連続パラメータ&gt; (必須)
 +
:*&lt;特別日&gt;
 +
:*&lt;同一の日&gt;
 +
:*&lt;説明&gt;
 +
:*&lt;グループID&gt;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=update_special_day&id=1&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0</nowiki>
 +
 +
====set delete_special_day====
 +
>= 5.1
 +
 +
特別日を削除。
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=update_special_day (必須)
 +
*id=<特別日ID> (必須)
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=delete_special_day&id=1</nowiki>
 +
 +
====set pagerduty_webhook====
 +
>= 5.1
 +
 +
Pandora FMS アラートと PagerDuty 通知を接続します。PagerDuty サービスの webhooks オプションを、PagerDuty からアラートを承諾した場合の動作に対して、あらかじめ PagerDuty にリンクさせた Pandora FMS のアラートの承諾に設定します。
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=pagerduty_webhook (必須)
 +
*id=alert (必須)
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert</nowiki>
 +
 +
====set tag_user_profile====
 +
>= 6
 +
 +
ユーザのプロファイルにタグを追加します。
 +
 +
書式:
 +
 +
* op = set (必須)
 +
* op2 = tag_user_profile (必須)
 +
* id = id_user (必須)
 +
* id2 = id_tag (必須)
 +
* other_mode = url_encode_separator_| (必須)
 +
* other = <id_group>|<id_profile> (必須)
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag_user_profile&apipass=1234&user=admin&pass=pandora&id=1&id2=2&other_mode=url_encode_separator_|&other=122|3</nowiki>
 +
 +
====set tag====
 +
>= 6
 +
 +
pandora にタグを追加します。
 +
 +
書式:
 +
 +
* op = set (必須)
 +
* op2 = tag (必須)
 +
* id = name (必須)
 +
* other_mode = url_encode_separator_| (必須)
 +
* other = <description>|<url>|<email>|<phone>
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag&apipass=1234&user=admin&pass=pandora&id=test&other_mode=url_encode_separator_|&other="a test"|http://www.artica.es|[email protected]|01189998819991197253</nowiki>
 +
 +
====set add_tag_module====
 +
>= 6
 +
 +
モジュールにタグを追加します。
 +
 +
書式:
 +
 +
* op = set (必須)
 +
* op2 = add_tag_module (必須)
 +
* id = id_module (必須)
 +
* id2 = id_tag (必須)
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2</nowiki>
 +
 +
====set remove_tag_module====
 +
>= 6
 +
 +
モジュールのタグを削除します。
 +
 +
書式:
 +
 +
* op = set (必須)
 +
* op2 = add_tag_module (必須)
 +
* id = id_module (必須)
 +
* id2 = id_tag (必須)
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2</nowiki>
 +
 +
====set planned_downtimes_created====
 +
>= 5.1
 +
 +
計画停止を作成します
 +
 +
書式:
 +
 +
*op=set (必須)
 +
*op2=planned_downtimes_created (必須)
 +
*other=&lt;連続パラメータ&gt; (必須) 計画停止を作成するパラメータ列:
 +
 +
:*&lt;説明&gt;
 +
:*&lt;開始日時&gt; 一回のみの場合の開始日時
 +
:*&lt;終了日時&gt; 一回のみの場合の終了日時
 +
:*&lt;グループID&gt;
 +
:*&lt;月&gt;
 +
:*&lt;火&gt;
 +
:*&lt;水&gt;
 +
:*&lt;木&gt;
 +
:*&lt;金&gt;
 +
:*&lt;土&gt;
 +
:*&lt;日&gt;
 +
:*&lt;定期実行開始時間&gt;
 +
:*&lt;定期実行終了時間&gt;
 +
:*&lt;定期実行開始日&gt;
 +
:*&lt;定期実行終了日&gt;
 +
:*&lt;タイプ&gt;  quit, disabled_agents, disabled_agents_alerts のいずれか
 +
:*&lt;実行&gt; once または periodically
 +
:*&lt;定期実行タイプ&gt; weekly または monthly
 +
:*&lt;id_user&gt;
 +
 +
{{Warning|この呼び出しが正しく動作するためには、日付のフォーマットは MM/DD/YYYY である必要があります。}}
 +
 +
=====例=====
 +
 +
一回:
 +
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|once|weekly|admin&other_mode=url_encode_separator_|</nowiki>
 +
 +
繰り返し:
 +
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|periodically|weekly|admin&other_mode=url_encode_separator_|</nowiki>
 +
 +
====set planned_downtimes_additem====
 +
>= 5.1
 +
 +
計画停止に対象エージェント(および対象モジュール)を追加します
 +
 +
書式:
 +
 +
*op=set
 +
*op2=planned_downtimes_additem
 +
*id=&lt;計画停止ID&gt;
 +
*other=&lt;連続パラメータ&gt; (必須) 追加対象
 +
 +
:*&lt;エージェントID1;エージェントID2;エージェントID3;...エージェントIDn&gt;
 +
:*&lt;モジュール名1;モジュール名2;モジュール名3;...モジュール名n&gt;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&apipass=1234&user=admin&pass=pandora&id=123&other=1;2;3;4%7CStatus;Unkown_modules%20&other_mode=url_encode_separator_|</nowiki>
 +
 +
====set planned_downtimes_deleted====
 +
>=5.1
 +
 +
計画停止を削除します。
 +
 +
書式:
 +
 +
*op=set
 +
*op2=planned_downtimes_deleted
 +
*id=&lt;計画停止ID&gt;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted&apipass=1234&user=admin&pass=pandora&id=10</nowiki>
 +
 +
====set create_synthetic_module====
 +
>=5.1SP4
 +
 +
新たな統合モジュールを作成します。
 +
 +
書式:
 +
 +
*op=set
 +
*op2=create_synthetic_module
 +
*id=モジュールを追加するエージェント名
 +
*id2=&lt;エージェントの別名の利用&gt;
 +
*other= <モジュール名><統合タイプ><エージェント名;演算タイプ;モジュール名> または <エージェント名;モジュール名> または <演算タイプ;値>
 +
 +
:**モジュールのデータ:
 +
  演算設定の場合で、エージェントとモジュール名を指定して演算タイプを指定しない場合: <エージェント名;モジュール名>、値を指定する場合: <演算タイプ;値>. それ以外: <エージェント名;演算タイプ;モジュール名> または <演算タイプ;値>
 +
  平均: <エージェント名;演算タイプ;モジュール名> または <演算タイプ;値>
 +
 +
:**演算タイプ:
 +
  演算: ADD, SUB, MUL, DIV
 +
  平均: AVG のみ
 +
 +
=====例=====
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=test&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;ADD;Module%20Name2&other_mode=url_encode_separator_|</nowiki>
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=pepito&other=prueba|average|Agent%20Name;AVG;Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|</nowiki>
 +
 +
====set create_service====
 +
>= 7
 +
 +
新たなサービスを作成します。
 +
 +
書式:
 +
 +
*op=set
 +
*op2=create_service
 +
*id=サービスID
 +
*other=<名前>;<説明>;<グループID>;<障害>;<警告>;<エージェントID>;<SLA間隔>;<SLA制限>;
 +
<警告モジュールアラートテンプレートID>;<障害モジュールアラートテンプレートID>;<障害モジュールSLAアラートテンプレートID>;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_service&return_type=json&other=test1%7CDescripcion%7C12%7C1%7C0.5%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set update_service====
 +
>= 7
 +
 +
サービスを更新します。
 +
 +
書式:
 +
 +
*op=set
 +
*op2=update_service
 +
*id=サービスID
 +
*other=<名前>;<説明>;<グループID>;<障害>;<警告>;<エージェントID>;<SLA間隔>;<SLA制限>;
 +
<警告モジュールアラートテンプレートID>;<障害モジュールアラートテンプレートID>;<障害モジュールSLAアラートテンプレートID>;
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_service&return_type=json&id=1&other=test2%7CDescripcion2%7C%7C%7C0.6%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set add_element_service====
 +
>= 7
 +
 +
サービスに要素を追加します。
 +
 +
書式:
 +
 +
*op=set
 +
*op2=add_element_service
 +
*id=サービスID
 +
*other=base64エンコードした要素のJson
 +
 +
json の構造は次の通りです。
 +
 +
[{"type":"agent","id":2,"description":"Test1","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"module","id":1,"description":"Test2","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"service","id":3,"description":"Test3","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0}]
 +
 +
それぞれのタイプで、ID フィールドは異なるものを参照します。
 +
 +
- タイプが agent の場合は、エージェント ID です。
 +
 +
- タイプが module の場合は、エージェントモジュール ID です。
 +
 +
- タイプが service の場合は、追加したいサービス ID です。
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_element_service&return_type=json&id=6&other=W3sidHlwZSI6ImFnZW50IiwiaWQiOjIsImRlc2NyaXB0aW9uIjoiamlqaWppIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoibW9kdWxlIiwiaWQiOjEsImRlc2NyaXB0aW9uIjoiSG9sYSBxdWUgdGFsIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoic2VydmljZSIsImlkIjozLCJkZXNjcmlwdGlvbiI6ImplamVqZWplIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH1d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set metaconsole_synch====
 +
>= 7
 +
 +
ライセンスキーをメタコンソールへ追加し、ノードへ同期します。
 +
 +
*op=set
 +
*op2=metaconsole_synch
 +
*id=License key
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/enterprise/meta/include/api.php?op=set&op2=metaconsole_synch&id=LICENSEKEY&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set migrate_agent====
 +
 +
>= 7.21 メタコンソールのみ
 +
 +
選択したエージェントをエージェントマイグレーションキューへ追加します。
 +
 +
*op=set
 +
*op2=migrate_agent
 +
*id=id_agent to migrate
 +
*other=origin node name| destination node name | (true|false) not to migrate historical database
 +
*other_mode=url_encode_separator_|
 +
*return_type = string, json, etc
 +
 +
=====例=====
 +
 +
<nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&other=nova|fringe|0&other_mode=url_encode_separator_|&return_type=string</nowiki>
 +
 +
====set new_cluster====
 +
>= 7.0
 +
 +
エージェントのクラスタを作成します。
 +
 +
異なるノードを監視するためのエージェントとアイテムを持つ監視クラスタを作成します。
 +
 +
書式:
 +
*op=set
 +
*op2=new_cluster
 +
*other=クラスタ名| クラスタタイプ| 説明| グループID
 +
*other_mode=url_encode_separator_
 +
 +
=====例=====
 +
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_cluster&other=nombre_cluster%7CAA%7Cdescripcion%7C12&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set add_cluster_agent====
 +
>= 7.0
 +
 +
エージェントをクラスタに追加します。
 +
 +
書式:
 +
*op=set
 +
*op2=add_cluster_agent
 +
*other=要素を含む json を base64 エンコードしたもの
 +
*other_mode=url_encode_separator_
 +
 +
json の構造は次の通りです。
 +
 +
[{"id":5,"id_agent":2},
 +
{"id":5,"id_agent":3}]
 +
 +
=====例=====
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set add_cluster_item (アクティブ/アクティブ)====
 +
>= 7.0
 +
 +
クラスタに、アクティブ/アクティブ アイテムを追加します。
 +
 +
書式:
 +
*op=set
 +
*op2=add_cluster_item
 +
*other=要素を含む json を base64 エンコードしたもの
 +
*other_mode=url_encode_separator_
 +
 +
json の構造は次の通りです。
 +
 +
[{"name":"Swap_Used","id_cluster":5,"type":"AA","critical_limit":80,"warning_limit":60},
 +
{"name":"TCP_Connections","id_cluster":5,"type":"AA","critical_limit":80,"warning_limit":60}]
 +
 +
=====例=====
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IlN3YXBfVXNlZCIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBQSIsImNyaXRpY2FsX2xpbWl0Ijo4MCwid2FybmluZ19saW1pdCI6NjB9LAp7Im5hbWUiOiJUQ1BfQ29ubmVjdGlvbnMiLCJpZF9jbHVzdGVyIjo1LCJ0eXBlIjoiQUEiLCJjcml0aWNhbF9saW1pdCI6ODAsIndhcm5pbmdfbGltaXQiOjYwfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set add_cluster_item (アクティブ/スタンバイ)====
 +
>= 7.0
 +
 +
クラスタに、アクティブ/スタンバイのアイテムを追加します。
 +
 +
書式:
 +
*op=set
 +
*op2=add_cluster_item
 +
*other=要素を含む json を base64 エンコードしたもの
 +
*other_mode=url_encode_separator_
 +
 +
json の構造は次の通りです。
 +
 +
[{"name":"DiskUsed_/proc/kcore","id_cluster":5,"type":"AP","is_critical":1},
 +
{"name":"DiskUsed_/proc/sched_debug","id_cluster":5,"type":"AP","is_critical":1}]
 +
 +
=====例=====
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwiaWRfY2x1c3RlciI6NSwidHlwZSI6IkFQIiwiaXNfY3JpdGljYWwiOjF9LAp7Im5hbWUiOiJEaXNrVXNlZF8vcHJvYy9zY2hlZF9kZWJ1ZyIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBUCIsImlzX2NyaXRpY2FsIjoxfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set delete_cluster====
 +
>= 7.0
 +
 +
クラスタを削除します。
 +
 +
書式:
 +
*op=set
 +
*op2=delete_cluster
 +
*id=<削除するクラスタID>
 +
 +
=====例=====
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster&id=7&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set delete_cluster_agent====
 +
>= 7.0
 +
 +
クラスタからエージェントを削除します。
 +
 +
書式:
 +
*op=set
 +
*op2=delete_cluster_agent
 +
*other=エージェントID| クラスタID|
 +
*other_mode=url_encode_separator_
 +
 +
json の構造は次のようになっている必要があります。
 +
 +
[{"id":5,"id_agent":2}, {"id":5,"id_agent":3}]
 +
 +
=====例=====
 +
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_agent&other=2%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set delete_cluster_item====
 +
>= 7.0
 +
 +
クラスタからアイテムを削除します。
 +
 +
書式:
 +
*op=set
 +
*op2=delete_cluster_item
 +
*id=<削除するアイテムID>
 +
 +
=====例=====
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_item&id=9&apipass=1234&user=admin&pass=pandora</nowiki>
 +
 +
====set create_policy====
 +
>= 7.0. 725
 +
 +
ポリシーを作成します。
 +
ポリシー名を指定する必要があります。複数設定はできません。また、グループ ID がデータベースに存在する必要があります。
 +
 +
書式:
 +
*op = set
 +
*op2 = create_policy
 +
*other = ポリシー名(必須) | グループID(必須) | 説明;
 +
*other_mode = url_encode_separator_|
 +
*return_type = (string, csv, json).
 +
 +
=====例=====
 +
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_policy&apipass=1234&user=admin&pass=pandora&other=name%20Policy|11|this%20description&other_mode=url_encode_separator_|&return_type=json</nowiki>