Difference between revisions of "Pandora: Documentation ja: Annex ExternalAPI"
From Pandora FMS Wiki
(→例) |
(→get module_graph) |
||
| (416 intermediate revisions by 4 users not shown) | |||
| Line 33: | Line 33: | ||
現時点では、セキュリティはツールにアクセスする IP アドレスリストに基づいています。以下に示す画面のように Pandora コンソールの設定オプションで設定できます。 | 現時点では、セキュリティはツールにアクセスする IP アドレスリストに基づいています。以下に示す画面のように Pandora コンソールの設定オプションで設定できます。 | ||
| − | '''*''' 文字を設定すると、IP による ACL | + | '''*''' 文字を設定すると、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))で設定できます。 | ||
| − | |||
| − | |||
<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 module_custom_id==== | ||
| + | モジュール ID をパラメータをとして渡し、特定のエージェントモジュールの ''カスタムID'' の値を返します。 | ||
| + | |||
| + | 書式: | ||
| + | |||
| + | *op=get (必須) | ||
| + | *op2=module_custom_id (必須) | ||
| + | *id= id_agent_module (必須) | ||
| + | |||
| + | =====例===== | ||
| + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_custom_id&id=5&apipass=1234&user=admin&pass=pandora</nowiki> | ||
====get locate_agent==== | ====get locate_agent==== | ||
| Line 341: | Line 352: | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/ | + | <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 366: | ||
=====例===== | =====例===== | ||
| − | 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 516: | ||
=====例===== | =====例===== | ||
| − | 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 535: | ||
=====例===== | =====例===== | ||
| − | 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 555: | ||
=====例===== | =====例===== | ||
| − | 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 582: | ||
:*<表示オフセット> | :*<表示オフセット> | ||
:*<形式オプション [total|more_criticity]> (total - 該当レコード数を返す, more_criticity - 該当レコード中の重要度の最も大きい値を返す) | :*<形式オプション [total|more_criticity]> (total - 該当レコード数を返す, more_criticity - 該当レコード中の重要度の最も大きい値を返す) | ||
| + | :*<グループID> | ||
| + | :*<タグ> | ||
:*<イベントタイプ> unknown, alert_fired, alert_recovered など(部分文字列も可) または、not_normal | :*<イベントタイプ> 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> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | < | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | <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> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
====get all_alert_templates==== | ====get all_alert_templates==== | ||
| Line 629: | Line 602: | ||
=====例===== | =====例===== | ||
| − | 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 614: | ||
=====例===== | =====例===== | ||
| − | 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 626: | ||
=====例===== | =====例===== | ||
| − | 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 640: | ||
この例では、システムの全てのタグを返します。 | この例では、システムの全てのタグを返します。 | ||
| − | 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 652: | ||
=====例===== | =====例===== | ||
| − | 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 667: | ||
=====例===== | =====例===== | ||
| − | 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 682: | ||
=====例===== | =====例===== | ||
| − | 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 694: | ||
=====例===== | =====例===== | ||
| − | 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 705: | ||
*op2=agent_alias (必須) | *op2=agent_alias (必須) | ||
*id=<エージェントID> (必須) | *id=<エージェントID> (必須) | ||
| + | *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 727: | ||
=====例===== | =====例===== | ||
| − | 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 740: | ||
=====例===== | =====例===== | ||
| − | 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 | + | ====get alert_actions==== |
| + | |||
| + | アラートアクションの一覧を取得します。 | ||
書式: | 書式: | ||
*op=get (必須) | *op=get (必須) | ||
| − | *op2= | + | *op2=alert_actions (必須) |
| − | * | + | *return_type=<return type> (必須) 'csv' または 'json' を指定できます。 |
| + | *other=<連続パラメータ> (オプション): | ||
| + | :*<action_name> (オプション) | ||
| + | :*<separator> (オプション) | ||
=====例===== | =====例===== | ||
| − | http:// | + | <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 | + | ====get alert_actions_meta==== |
| + | {{メタコンソール}} | ||
| + | メタコンソールから、ノードのアラートアクションの一覧を取得します。 | ||
書式: | 書式: | ||
*op=get (必須) | *op=get (必須) | ||
| − | *op2= | + | *op2=alert_actions_meta (必須) |
| + | *return_type=<return type> (必須) 'csv' または 'json' を指定できます。 | ||
| + | *other=<連続パラメータ> (オプション): | ||
| + | :*<server_name> (オプション) | ||
| + | :*<action_name> (オプション) | ||
| + | :*<separator> (オプション) | ||
=====例===== | =====例===== | ||
| − | http://localhost/pandora_console/include/api.php?op=get&op2= | + | <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 (必須) | ||
| + | *op2=all_alert_commands (必須) | ||
| + | *other=cvs_separator (オプション) | ||
| + | |||
| + | =====例===== | ||
| + | <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=<イベントID> (必須) | ||
| + | |||
| + | =====例===== | ||
| + | <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 かそれ以降 | ||
書式: | 書式: | ||
| Line 787: | Line 813: | ||
=====Example===== | =====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=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki> |
次の順番で値が返ります。 | 次の順番で値が返ります。 | ||
| Line 813: | Line 839: | ||
=====例===== | =====例===== | ||
| − | 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 854: | ||
=====例===== | =====例===== | ||
| − | 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 838: | Line 864: | ||
*op=get (必須) | *op=get (必須) | ||
| − | *op2= | + | *op2=special_days (必須) |
*other=<csvセパレータ> (オプション) CSVのセパレータ | *other=<csvセパレータ> (オプション) CSVのセパレータ | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?apipass= | + | <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 940: | ||
=====例===== | =====例===== | ||
| − | 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 958: | ||
=====例===== | =====例===== | ||
| − | 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 976: | ||
=====例===== | =====例===== | ||
| − | 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==== | ||
>= 6.0 | >= 6.0 | ||
| − | base64 でエンコードされたモジュールグラフを返します。 | + | [https://docs.python.org/ja/3/library/base64.html base64] でエンコードされたモジュールグラフを返します。 |
書式: | 書式: | ||
| Line 962: | Line 988: | ||
*id=<モジュールID> (必須) | *id=<モジュールID> (必須) | ||
*other=<秒単位の間隔> (オプション) デフォルトは 3600 (1時間)です。 時間間隔はデータリカバリに使われます。 | *other=<秒単位の間隔> (オプション) デフォルトは 3600 (1時間)です。 時間間隔はデータリカバリに使われます。 | ||
| + | |||
| + | バージョン NG 752 以降では、追加のパラメータがあります。必須項目っとそのセパレータ <code>|</code> または、その [https://en.wikipedia.org/wiki/Escape_character エスケープ文字] <code> %7C </code> に注意してください。 | ||
| + | |||
| + | *op=get (必須) | ||
| + | *op2=module_graph (必須) | ||
| + | *id=<module id> (必須) | ||
| + | *other= | ||
| + | ** リクエストの日付からさかのぼってデータが収集される秒単位の時間範囲(デフォルトは 3600)(必須)。 | ||
| + | ** セパレータ | ||
| + | ** 0 であれば base64 グラフィック、1 であれば画像(必須) | ||
| + | ** セパレータ | ||
| + | ** 0 であればしきい値無し。 1 であればしきい値あり。- モジュールに有効なしきい値がある場合 - (必須) | ||
| + | ** セパレータ | ||
| + | ** ピクセル単位のグラフの高さ(必須) | ||
=====例===== | =====例===== | ||
| − | http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=5&other=3600%7C1&other_mode=url_encode_separator_%7C&apipass=1234&api=1&user=admin&pass=pandora | + | バージョン NG 752 未満: |
| + | |||
| + | <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> | ||
| + | |||
| + | バージョン NG 752 以上: | ||
| + | |||
| + | <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=2&other=3600%7C1%7C1%7C500%7C&other_mode=url_encode_separator_%7C|&apipass=1234&api=1&user=admin&pass=pandora</nowiki> | ||
====get all_planned_downtimes==== | ====get all_planned_downtimes==== | ||
| Line 985: | Line 1,031: | ||
=====例===== | =====例===== | ||
| − | 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,052: | ||
=====例===== | =====例===== | ||
| − | 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,067: | ||
=====例===== | =====例===== | ||
| − | 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,081: | ||
=====例===== | =====例===== | ||
| − | 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,095: | ||
=====例===== | =====例===== | ||
| − | 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,109: | ||
=====例===== | =====例===== | ||
| − | 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> | ||
| − | + | ====get get_timezone==== | |
| + | >= 7.0NG | ||
| − | + | Pandora に設定されているタイムゾーンを返します。 | |
| − | |||
| − | |||
| − | : | + | 書式: |
| − | + | * op=get | |
| − | + | * op2=timezone | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone</nowiki> | ||
| − | + | ====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> |
| − | + | ====get cluster_id_by_name==== | |
| + | >= 7.0 | ||
| − | + | 名前からクラスタの ID を返します。 | |
| − | *op= | + | *op=get |
| − | *op2= | + | *op2=cluster_id_by_name |
| − | *id= | + | *id=<クラスタ名> |
| − | |||
| − | : | + | <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> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ==== | + | ====get agents_id_name_by_cluster_id==== |
| + | >= 7.0 | ||
| − | + | クラスタ ID から、ID => クラスタエージェント名を返します。 | |
| − | === | + | *op=get |
| + | *op2=agents_id_name_by_cluster_id | ||
| + | *id=<クラスタID> | ||
| − | + | <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> | |
| − | + | ====get agents_id_name_by_cluster_name==== | |
| − | + | >= 7.0 | |
| − | |||
| − | |||
| − | = | + | クラスタ名から、ID => クラスタエージェント名を返します。 |
| − | + | *op=get | |
| + | *op2=agents_id_name_by_cluster_name | ||
| + | *id=<クラスタ名> | ||
| − | ==== | + | <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=get |
| + | *op2=modules_id_name_by_cluster_id | ||
| + | *id=<クラスタID> | ||
| − | + | <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> | |
| − | ==== | + | ====get modules_id_name_by_cluster_name==== |
| + | >= 7.0 | ||
| − | + | クラスタ名から、ID => クラスタエージェントの全モジュール名を返します。 | |
| − | + | *op=get | |
| + | *op2=modules_id_name_by_cluster_name | ||
| + | *id=<クラスタ名> | ||
| − | 書式: | + | <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> |
| − | *op= | + | |
| − | * | + | ====get cluster_items==== |
| − | *id | + | >= 7.0 |
| − | * | + | |
| + | クラスタ 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 | ||
| + | *op2=cluster_items | ||
| + | *id=<クラスタ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> | ||
| + | |||
| + | ====get policy==== | ||
| + | >= 7.0NG. 725 | ||
| + | |||
| + | ポリシーから全データを返します。ポリシー 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). | ||
| − | http:// | + | =====例===== |
| + | <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). | ||
| − | + | =====例===== | |
| − | + | <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> | |
| − | + | ||
| − | + | ====get unlinking_policy==== | |
| − | : | + | >= 7.0NG. 725 |
| − | + | ||
| − | + | ポリシーの全未リンクモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全未リンクモジュールを返します。 | |
| − | + | ||
| − | + | 書式: | |
| − | + | * op=get | |
| − | + | * op2=unlinking_policy | |
| − | + | * id=<ポリシーID> (オプション) | |
| − | + | * return_type=(json, csv, string). | |
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| + | <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki> | ||
| − | + | ====get alerts_policy==== | |
| + | >= 7.0NG. 725 | ||
| − | + | 次の点を考慮して、ポリシーのアラートを返します。 | |
| − | + | * ポリシー ID が指定されていれば、ポリシーのアラートを返します。そうでなければ、全ポリシーの全アラートを返します。 | |
| + | * アラートのタイプを指定されている場合: (オプションは 3つあります) | ||
| + | ** 0: すべてを表示します(デフォルト) | ||
| + | ** 1: 通常アラートのみ表示します | ||
| + | ** 2: 外部アラートのみ表示します | ||
書式: | 書式: | ||
| + | * op=get | ||
| + | * op2=alerts_policy | ||
| + | * id=<ポリシーID> (オプション) | ||
| + | * id2= 0:すべて(デフォルト), 1:通常, 2:外部 | ||
| + | * return_type=(json, csv, string). | ||
| − | *op= | + | =====例===== |
| − | *op2= | + | <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). |
| − | + | ||
| − | + | =====例===== | |
| + | <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json</nowiki> | ||
| + | |||
| + | ====get traps==== | ||
| + | >= 7.0NG. 728 | ||
| + | |||
| + | 指定されたソーストラップを返します。また、タイムスタンプやその他のデータをフィルタリングすることもできます。 | ||
| + | |||
| + | 書式: | ||
| + | * 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==== | ||
| + | |||
| + | Pandora FMS でユーザがアクセスするイベント応答の一覧を返します。 | ||
| + | |||
| + | 書式: | ||
| + | *op=get (必須) | ||
| + | *op2=event_reponses (必須) | ||
| + | *return_type=csv|json (必須) | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | この例では、csv フォーマットで全システムイベント応答を返します。 | ||
| + | |||
| + | <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}} |
| − | + | ||
| − | + | ユーザデータの一覧を返します。 | |
| − | + | ||
| − | + | 書式: | |
| − | + | *op=get (必須) | |
| − | + | *op2=list_all_user(必須) | |
| − | + | *return_type=csv|json (必須) | |
| − | + | *other= usernarme (必須) | |
| − | |||
| − | |||
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | + | 指定のユーザに関するすべての情報を取得します。 | |
| + | 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==== | ||
| − | + | Pandora FMS のユーザプロファイル一覧を返します。 | |
書式: | 書式: | ||
| − | *op= | + | *op=get (必須) |
| − | *op2= | + | *op2=user_profiles_info (必須) |
| − | * | + | *return_type=csv|json (必須) |
| − | + | ||
| − | + | =====例===== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | この例では、全システムユーザプロファイルを 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==== | |
| + | |||
| + | >= 7.21 メタコンソールのみ | ||
| + | |||
| + | エージェントマイグレーションキューに、指定のエージェントが存在するかを確認します。 | ||
| − | 例 2 | + | *op=get |
| + | *op2=migrate_agent | ||
| + | *id=id_agente a migrar | ||
| + | *return_type = string, json, etc | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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> | ||
| + | |||
| + | ====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=get (必須) | ||
| + | * op2=filter_user_group (必須) | ||
| + | * return_type=csv|json(必須) | ||
| + | *other= id group(必須)|Enabled or not(Disabled)(必須) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | + | Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 | |
| + | 2つの変数(グループIDまたは有効化)の 1つは空ですが、少なくとも 1つは入力する必要があることに注意してください。 | ||
| − | ==== | + | {{Warning|2つの変数(グループIDまたは Enabled)のうちいずれかが空でも構いませんが、少なくとも一つは指定する必要があることに注意してください。}} |
| + | |||
| + | <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> | ||
| + | |||
| + | ====get inventory_modules==== | ||
| − | + | Pandora インベントリモジュールの一覧を返します。 | |
書式: | 書式: | ||
| + | *op=get (必須) | ||
| + | *op2=inventory_modules (必須) | ||
| + | *return_type=csv|json (必須) | ||
| − | *op= | + | =====例===== |
| − | *op2= | + | |
| − | *id= | + | この例では、全インベントリの情報を json フォーマットで返します。 |
| − | + | ||
| − | : | + | <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki> |
| − | + | ||
| − | + | ====get inventory_modules_by_name==== | |
| − | + | ||
| − | + | エージェント名を用いてエージェントからインベントリモジュールを取得します。 | |
| − | + | ||
| − | + | 書式: | |
| − | + | *op=get (必須) | |
| − | : | + | *op2=inventory_modules_by_name (必須) |
| − | + | *id=<エージェント名> (必須) | |
| − | + | ||
| − | + | =====例===== | |
| − | + | http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_name&id=name&return_type=csv&apipass=1234&user=admin&pass=pandora | |
| − | + | ||
| − | : | + | ====get inventory_modules_by_alias==== |
| − | + | ||
| − | + | エージェントの別名を用いて、エージェントからインベントリモジュールを取得します。 | |
| − | + | ||
| − | + | 書式: | |
| − | + | *op=get (必須) | |
| − | + | *op2=inventory_modules_by_alias (必須) | |
| − | + | *id=<エージェントの別名> (必須) | |
| − | : | + | |
| − | + | =====例===== | |
| − | + | http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_alias&id=alias&return_type=csv&apipass=1234&user=admin&pass=pandora | |
| − | + | ||
| − | + | ====get inventory_module_data==== | |
| − | + | ||
| − | + | エージェント名とモジュールを用いて、インベントリモジュールからデータを取得します。 | |
| − | + | ||
| − | + | 書式: | |
| − | : | + | *op=get (必須) |
| − | + | *op2=inventory_module_data (必須) | |
| − | + | *id=<エージェント名> (必須) | |
| − | + | *id2=<インベントリモジュール名> (オプション) | |
| − | + | *other=<連続パラメータ> (オプション), 次の順番で指定します: | |
| − | + | **<separator> | |
| − | + | **<date_from>: <year><month><day>T<hour>:<minute> | |
| − | + | **<date_to>: <year><month><day>T<hour>:<minute> | |
| − | + | **<use_agent_alias> (オプション) 0 または 1 | |
| − | + | ||
| − | + | =====例===== | |
| − | + | http://127.0.0.1/pandora_console/include/api.phpop=get&op2=inventory_module_data&id=e14ae3b959b08a1fb7a057281401a08063cf04eb714efa5fbf1cf4043cfa1314&id2=Routes&other=,|20191010T13:40|20191211T13:40|0&return_type=csv&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora | |
| − | + | ||
| − | + | ====get list_collections==== | |
| − | + | ||
| − | :* | + | Pandora の全コレクションの一覧を返します。 |
| − | :* | + | |
| − | + | 書式: | |
| − | : | + | *op=get (必須) |
| − | :* | + | *op2=list_collections (必須) |
| − | + | ||
| − | + | =====例===== | |
| + | |||
| + | この例では、全コレクションの情報を json フォーマットで返します。 | ||
| + | |||
| + | <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 を指定しなかった場合、全コレクションの全ファイルを返します。 | ||
| + | |||
| + | 書式: | ||
| + | *op=get (必須) | ||
| + | *op2=list_collections_files (必須) | ||
| + | *id=id_collection | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | この例では、コレクション内の全ファイル名を json フォーマットで返します。 | ||
| + | |||
| + | <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==== | ||
| + | |||
| + | 存在するイベントフィルタの一覧を返します。 | ||
| + | |||
| + | 書式: | ||
| + | *op=get (必須) | ||
| + | *op2=all_event_filters (必須) | ||
| + | *other=cvs_separator (オプション) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op= | + | <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> |
| − | ==== | + | ====get event_mcid==== |
| − | + | ノードの ID および、ノードのイベント ID を用いて、メタコンソールでのイベント ID を返します。 | |
| − | {{ | + | {{metaconsole_ja}} |
書式: | 書式: | ||
| + | *op=get (必須) | ||
| + | *op2=event_mcid (必須) | ||
| + | *id=<server_id> (必須) ノードの ID です。 | ||
| + | *id2 = <id_source_event> (必須) ノードのイベント ID です。 | ||
| − | + | =====例===== | |
| − | + | ||
| − | + | <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> | |
| − | + | ||
| − | + | ===設定=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | データを送信します。 | |
| − | + | ====set new_agent==== | |
| − | + | パラメータで指定した内容で新たなエージェントを作成します。 | |
| − | + | 書式: | |
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_agent (必須) |
| − | * | + | *other=<連続したパラメータ> (必須) エージェントの設定とデータを次の順番に指定します。 |
| − | * | + | |
| − | :*< | + | :*<エージェントの別名> |
| + | :*<IP> | ||
| + | :*<親エージェントのID> | ||
| + | :*<グループID> | ||
| + | :*<関連障害検知抑制> | ||
| + | :*<関連障害検知抑制モジュール> | ||
| + | :*<間隔(秒)> | ||
| + | :*<OSのID> | ||
| + | :*<サーバ名> | ||
| + | :*<カスタムID> | ||
| + | :*<学習モード> | ||
| + | :*<無効化> | ||
:*<説明> | :*<説明> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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> |
| − | + | *注意: ''alias_as_name'' が 1 の場合はエージェント名は別名と同じです。0 の場合はエージェント名は自動的に生成されます。 | |
| − | + | ====set update_agent==== | |
| + | |||
| + | パラメータで渡したデータで、新たなエージェントを更新します。 | ||
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_agent (必須) |
| − | *id=< | + | *id=<エージェントID> (必須) |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) エージェントの設定データで次の順番で設定します。 |
| − | :*< | + | |
| + | :*<エージェントの別名> | ||
| + | :*<ip> | ||
| + | :*<親ID> | ||
| + | :*<グループID> | ||
| + | :*<関連障害検知抑制> | ||
| + | :*<関連障害検知抑制モジュール> | ||
| + | :*<間隔(秒)> | ||
| + | :*<OSのID> | ||
| + | :*<サーバ名> | ||
| + | :*<カスタムID> | ||
| + | :*<学習モード> | ||
:*<無効化> | :*<無効化> | ||
| − | :*< | + | :*<説明> |
| − | + | ||
| − | + | =====例===== | |
| − | + | ||
| − | : | + | <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 (必須) | |
| − | + | *op2=delete_agent (必須) | |
| − | + | *id=<エージェント名> (必須) エージェント名でなければいけません。 | |
| − | + | *other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です) | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo</nowiki> | |
| − | + | ====set create_module_template==== | |
| − | + | id に指定したテンプレート、other に指定したエージェント、モジュール ID から、アラートを作成します。 | |
| − | |||
| − | id | ||
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=create_module_template (必須) |
| − | *id=< | + | *id=<テンプレートID> (必須) テンプレートIDでなければいけません。 |
| + | *other=<id_module>|<id_agent> | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set apply_module_template==== |
| + | |||
| + | モジュールテンプレートをエージェントへ適用します。 | ||
| − | + | モジュールテンプレートは、ネットワークモジュールを集めたものです。このテンプレートは、直接エージェントに適用することができ、モジュールを一つ一つ追加する必要はありません。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=apply_module_template (必須) |
| + | *id<id_template> (必須) 適用されるテンプレートの ID | ||
| + | *id2<id_agente> (必須) モジュールが作成されるエージェントの ID | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set create_network_module==== |
| − | + | 指定のパラメータでネットワークモジュールを作成します。 | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=create_network_module (必須) |
| − | *id=< | + | *id=<エージェント名> (必須) エージェント名でなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番で指定するモジュール設定パラメータです。 |
| + | :*<モジュール名> | ||
| + | :*<無効化> | ||
:*<モジュールタイプID> | :*<モジュールタイプID> | ||
| − | |||
:*<モジュールグループID> | :*<モジュールグループID> | ||
| − | |||
| − | |||
| − | |||
| − | |||
:*<警告の最小値> | :*<警告の最小値> | ||
:*<警告の最大値> | :*<警告の最大値> | ||
| − | :*< | + | :*<警告の文字列> |
:*<障害の最小値> | :*<障害の最小値> | ||
:*<障害の最大値> | :*<障害の最大値> | ||
| − | :*< | + | :*<障害の文字列> |
| − | |||
:*<連続抑制回数> | :*<連続抑制回数> | ||
| − | :*< | + | :*<ヒストリーデータ> |
| − | :*< | + | :*<対象IP> |
| − | :*< | + | :*<TCPポート> |
| − | :*< | + | :*<snmpコミュニティ> |
| + | :*<snmp OID> | ||
| + | :*<モジュール間隔> | ||
| + | :*<データ保存倍率> | ||
| + | :*<最小> | ||
| + | :*<最大> | ||
:*<カスタムID> | :*<カスタムID> | ||
| − | :*<不明イベントの有効化> (バージョン 5 | + | :*<説明> |
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
:*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | ||
:*<個別状態変化の利用> (バージョン 5.1 以降のみ) | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| Line 1,683: | Line 1,805: | ||
:*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<警告条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
| + | :*<エージェントの別名の利用> (値は 0 または 1 です) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set create_plugin_module==== |
| − | + | 指定のパラメータでプラグインモジュールを作成します。 | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=create_plugin_module (必須) |
| − | *id=< | + | *id=<エージェント名> (必須) エージェント名でなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定を指定します。 |
:*<モジュール名> | :*<モジュール名> | ||
:*<無効化> | :*<無効化> | ||
| Line 1,708: | Line 1,835: | ||
:*<障害文字列> | :*<障害文字列> | ||
:*<連続抑制回数> | :*<連続抑制回数> | ||
| − | :*< | + | :*<ヒストリーデータ> |
| − | :*< | + | :*<対象IP> |
| − | :*< | + | :*<TCPポート> |
| − | :*< | + | :*<snmp コミュニティ> |
| − | :*< | + | :*<snmp OID> |
| + | :*<モジュール間隔> | ||
:*<データ保存倍率> | :*<データ保存倍率> | ||
:*<最小値> | :*<最小値> | ||
| Line 1,722: | Line 1,850: | ||
:*<プラグインパスワード> | :*<プラグインパスワード> | ||
:*<プラグインパラメータ> | :*<プラグインパラメータ> | ||
| − | :*<不明イベントの有効化> (バージョン 5 | + | :*<不明イベントの有効化> (バージョン 5 のみ) |
| − | :*<マクロ> (バージョン 5 以降のみ) base 64 | + | :*<マクロ> (バージョン 5 以降のみ) base 64 でエンコードされた JSON 文字列である必要があります。内容は、次のプロパティでまとめたオブジェクトでなければいけません。 |
| − | :** | + | :**'"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。 |
:**''"desc"'': マクロを表す名前。 | :**''"desc"'': マクロを表す名前。 | ||
:**''"help"'': マクロの説明。 | :**''"help"'': マクロの説明。 | ||
| − | :**''"value"'':マクロの値。 | + | :**''"value"'': マクロの値。 |
| + | :**''"hide"'': マクロの値を隠す場合は "1" に設定します。(パスワードの記載に便利です) | ||
:例 | :例 | ||
{ | { | ||
| Line 1,734: | Line 1,863: | ||
"desc": "Target IP", | "desc": "Target IP", | ||
"help": "", | "help": "", | ||
| − | "value": "192.168.0.1" | + | "value": "192.168.0.1", |
| + | "hide": "" | ||
}, | }, | ||
"2": { | "2": { | ||
| Line 1,740: | Line 1,870: | ||
"desc": "Port", | "desc": "Port", | ||
"help": "", | "help": "", | ||
| − | "value": "80" | + | "value": "80", |
| + | "hide": "" | ||
} | } | ||
} | } | ||
| − | :*<モジュールマクロ> (バージョン 5 以降のみ) | + | :*<エージェントの別名の利用> (値は 0 または 1 です) |
| + | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロを一つのプロパティで表した base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" です。 | ||
:*<個別状態変化の利用> (バージョン 5.1 以降のみ) | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
:*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<警告条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set create_data_module==== |
| + | |||
| + | 指定したパラメータでモジュールを作成します。 | ||
| − | + | {{warning|このコマンドにてデータベースにモジュールデータを追加できますが、モジュールに関連づけられたエージェントの設定ファイルの編集はできません。}} | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=create_data_module (必須) |
| − | *id=< | + | *id=<エージェント名> (必須) エージェント名でなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) モジュールの設定とデータを次の順番で指定します。 |
:*<モジュール名> | :*<モジュール名> | ||
| + | :*<無効化> | ||
:*<モジュールタイプID> | :*<モジュールタイプID> | ||
:*<説明> | :*<説明> | ||
| Line 1,772: | Line 1,911: | ||
:*<警告の最小値> | :*<警告の最小値> | ||
:*<警告の最大値> | :*<警告の最大値> | ||
| − | :*< | + | :*<警告の文字列> |
:*<障害の最小値> | :*<障害の最小値> | ||
:*<障害の最大値> | :*<障害の最大値> | ||
| − | :*< | + | :*<障害の文字列> |
:*<データの保存> | :*<データの保存> | ||
| − | |||
:*<不明イベントの有効化> (バージョン 5 以降のみ) | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
:*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | ||
| Line 1,786: | Line 1,924: | ||
:*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<連続抑制タイムアウト> (バージョン 5.1 以降のみ) | :*<連続抑制タイムアウト> (バージョン 5.1 以降のみ) | ||
| + | :*<障害条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<警告条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
| + | :*<エージェントの別名の利用> (値は 0 または 1 です) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set create_SNMP_module==== |
| − | + | SNMP モジュールを作成します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=create_snmp_module (必須) |
| − | *id=< | + | *id=<エージェント名> (必須) エージェント名でなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番で指定するモジュールの設定とデータです。 |
:*<モジュール名> | :*<モジュール名> | ||
:*<無効化> | :*<無効化> | ||
| Line 1,806: | Line 1,948: | ||
:*<警告の最小値> | :*<警告の最小値> | ||
:*<警告の最大値> | :*<警告の最大値> | ||
| − | :*< | + | :*<警告の文字列> |
:*<障害の最小値> | :*<障害の最小値> | ||
:*<障害の最大値> | :*<障害の最大値> | ||
| − | :*< | + | :*<障害の文字列> |
:*<連続抑制回数> | :*<連続抑制回数> | ||
:*<データの保存> | :*<データの保存> | ||
| + | :*<対象IP> | ||
:*<モジュールのポート> | :*<モジュールのポート> | ||
:*<SNMPバージョン> | :*<SNMPバージョン> | ||
| Line 1,822: | Line 1,965: | ||
:*<カスタムID> | :*<カスタムID> | ||
:*<説明> | :*<説明> | ||
| − | :*< | + | :*<SNMPv3 暗号化手法 [AES|DES]> |
| − | :*< | + | :*<SNMPv3 暗号化パスワード> |
| − | :*< | + | :*<SNMPv3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]> |
| − | :*< | + | :*<SNMPv3 認証手法 [MD5|SHA]> |
| − | :*< | + | :*<SNMPv3 認証ユーザ> |
| − | :*< | + | :*<SNMPv3 認証パスワード> |
:*<不明イベントの有効化> (バージョン 5 以降のみ) | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
:*<個別状態変化の利用> (バージョン 5.1 以降のみ) | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| Line 1,833: | Line 1,976: | ||
:*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
| + | :*<エージェントの別名の利用> (値は 0 または 1 です) | ||
=====例===== | =====例===== | ||
| − | + | 例 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 update_network_module==== |
| − | + | ネットワークモジュールを更新します。 | |
| − | + | 書式: | |
| − | + | *op=set (必須) | |
| − | + | *op2=update_network_module (必須) | |
| − | + | *id=<モジュールID> (必須) モジュールIDでなければいけません。 | |
| − | *op=set (必須) | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 |
| − | *op2= | + | :*<エージェントID> |
| − | *id=< | + | :*<無効化> |
| − | *other=<連続パラメータ> (必須) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | :*< | ||
| − | :*< | ||
:*<モジュールグループID> | :*<モジュールグループID> | ||
| − | |||
| − | |||
:*<警告の最小値> | :*<警告の最小値> | ||
:*<警告の最大値> | :*<警告の最大値> | ||
| Line 1,878: | Line 2,009: | ||
:*<障害文字列> | :*<障害文字列> | ||
:*<連続抑制回数> | :*<連続抑制回数> | ||
| + | :*<データの保存> | ||
| + | :*<対象のIPO> | ||
| + | :*<モジュールのポート> | ||
| + | :*<SNMPコミュニティ> | ||
| + | :*<SNMP OID> | ||
| + | :*<モジュールの間隔> | ||
:*<データ保存倍率> | :*<データ保存倍率> | ||
| − | :*< | + | :*<最小値> |
| − | :*< | + | :*<最大値> |
| + | :*<カスタムID> | ||
| + | :*<説明> | ||
| + | :*<イベントタイプの無効化> (バージョン 5 以降のみ) | ||
| + | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | ||
:*<個別状態変化の利用> (バージョン 5.1 以降のみ) | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
:*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<警告条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set update_plugin_module==== |
| − | + | プラグインモジュールを更新します。 | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_plugin_module (必須) |
| − | *id=< | + | *id=<モジュールID> (必須) モジュールIDでなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 |
| − | :*< | + | :*<エージェントID> |
| − | :*< | + | :*<無効化> |
| − | |||
| − | |||
| − | |||
| − | |||
:*<モジュールグループID> | :*<モジュールグループID> | ||
| − | |||
| − | |||
| − | |||
:*<警告の最小値> | :*<警告の最小値> | ||
:*<警告の最大値> | :*<警告の最大値> | ||
| Line 1,916: | Line 2,054: | ||
:*<障害文字列> | :*<障害文字列> | ||
:*<連続抑制回数> | :*<連続抑制回数> | ||
| + | :*<データの保存> | ||
| + | :*<対象IP> | ||
| + | :*<モジュールのポート> | ||
| + | :*<SNMPコミュニティ> | ||
| + | :*<SNMP OID> | ||
| + | :*<モジュールの間隔> | ||
:*<データ保存倍率> | :*<データ保存倍率> | ||
| − | :*< | + | :*<最小値> |
| − | :*< | + | :*<最大値> |
| − | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | + | :*<カスタムID> |
| − | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | + | :*<説明> |
| − | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | + | :*<プラグインID> |
| − | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | + | :*<プラグインユーザ> |
| + | :*<プラグインパスワード> | ||
| + | :*<プラグインパラメータ> | ||
| + | :*<イベントタイプの無効化> (バージョン 5 以降のみ) | ||
| + | :*<マクロ> (バージョン 5 以降のみ) base 64 でエンコードされた文字列でなければいけません。内容は、次のプロパティで表すオブジェクトを一つにまとめたものでなければいけません。 | ||
| + | :** ''"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。 | ||
| + | :**''"desc"'': マクロを表す名前。 | ||
| + | :**''"help"'': マクロの説明。 | ||
| + | :**''"value"'':マクロの値。 | ||
| + | :例 | ||
| + | { | ||
| + | "1": { | ||
| + | "macro": "_field1_", | ||
| + | "desc": "Target IP", | ||
| + | "help": "", | ||
| + | "value": "192.168.0.1" | ||
| + | }, | ||
| + | "2": { | ||
| + | "macro": "_field2_", | ||
| + | "desc": "Port", | ||
| + | "help": "", | ||
| + | "value": "80" | ||
| + | } | ||
| + | } | ||
| + | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめ base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<警告条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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> |
| − | ====set | + | ====set update_data_module==== |
| + | |||
| + | ローカルモジュールを更新します。 | ||
| − | + | {{warning|これによりデータベースにモジュールデータを追加することはできますが、該当モジュールに関するエージェントの設定ファイルを変更することはできません。}} | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_data_module (必須) |
| − | *id=< | + | *id=<モジュールID> (必須) モジュールIDでなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 |
| − | :*< | + | :*<エージェントID> |
| − | :*< | + | :*<無効化> |
| − | |||
| − | |||
| − | |||
:*<モジュールグループID> | :*<モジュールグループID> | ||
| − | |||
| − | |||
:*<警告の最小値> | :*<警告の最小値> | ||
:*<警告の最大値> | :*<警告の最大値> | ||
| Line 1,952: | Line 2,125: | ||
:*<障害文字列> | :*<障害文字列> | ||
:*<連続抑制回数> | :*<連続抑制回数> | ||
| + | :*<データの保存> | ||
| + | :*<対象のIP> | ||
| + | :*<モジュールのポート> | ||
| + | :*<SNMPコミュニティ> | ||
| + | :*<SNMP OID> | ||
| + | :*<モジュールの間隔> | ||
:*<データ保存倍率> | :*<データ保存倍率> | ||
| − | :*< | + | :*<最小値> |
| − | :*< | + | :*<最大値> |
| − | :*< | + | :*<カスタムID> |
| − | :*< | + | :*<説明> |
| − | :*< | + | :*<イベントタイプの無効化> (バージョン 5 以降のみ) |
| − | :*< | + | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 |
| − | + | :*<連続抑制回数> (バージョン 5.1 以降のみ) | |
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | :*< | ||
:*<個別状態変化の利用> (バージョン 5.1 以降のみ) | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
:*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
:*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<連続抑制タイムアウト> (バージョン 5.1 以降のみ) | ||
| + | :*<障害条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<警告条件の反転> (バージョン 6.0SP1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set update_data_module_policy==== |
| − | + | ポリシーのデータモジュールを更新し、新たなモジュールの ID を返します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_data_module (必須) |
| − | *id=< | + | *id=<id_agent_module> (必須) 対象のポリシーモジュールID。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。: |
| + | :*<ポリシーモジュールID> | ||
:*<説明> | :*<説明> | ||
| − | :*< | + | :*<モジュールグループID> |
| − | :*< | + | :*<最小> |
| − | :*< | + | :*<最大> |
| − | :*< | + | :*<事前処理> |
| − | :*< | + | :*<モジュールの間隔> |
| − | :*< | + | :*<警告の最小値> |
| − | :*< | + | :*<警告の最大値> |
| − | :*< | + | :*<障害の最小値> |
| − | :*< | + | :*<障害の最大値> |
| − | :*< | + | :*<障害の文字列> |
| + | :*<データの保存> | ||
| + | :*<設定データ> | ||
| + | :*<disabled_types_event> (バージョン 5以降) | ||
| + | :*<モジュールマクロ> (バージョン 5以降) 各マクロに対して 1つのプロパティを持つオブジェクトによって形成された、base64 でエンコードされた JSON ドキュメントである必要があります。JSON フォーマットは、"<マクロ名>": "<マクロの値>" となっている必要があります。 | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set update_SNMP_module==== |
| − | + | SNMP モジュールを更新します。 | |
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_snmp_module (必須) |
| − | *id=< | + | *id=<モジュールID> (必須) モジュールIDでなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 |
| − | :*< | + | :*<エージェントID> |
| + | :*<無効化> | ||
| + | :*<モジュールグループID> | ||
| + | :*<警告の最小値> | ||
| + | :*<警告の最大値> | ||
| + | :*<警告文字列> | ||
| + | :*<障害の最小値> | ||
| + | :*<障害の最大値> | ||
| + | :*<障害文字列> | ||
| + | :*<連続抑制回数> | ||
| + | :*<データの保存> | ||
| + | :*<対象のIP> | ||
| + | :*<モジュールのポート> | ||
| + | :*<SNMPバージョン> | ||
| + | :*<SNMPコミュニティ> | ||
| + | :*<SNMP OID> | ||
| + | :*<モジュールの間隔> | ||
| + | :*<データ保存倍率> | ||
| + | :*<最小値> | ||
| + | :*<最大値> | ||
| + | :*<カスタムID> | ||
:*<説明> | :*<説明> | ||
| − | :*< | + | :*<snmp3 暗号化方式 [AES|DES]> |
| − | :*< | + | :*<snmp3 暗号化パスワード> |
| − | :*< | + | :*<snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]> |
| − | :*< | + | :*<snmp3 認証方式 [MD5|SHA]> |
| − | :*< | + | :*<snmp3 認証ユーザ> |
| − | :*< | + | :*<snmp3 認証パスワード> |
| − | :*< | + | :*<イベントタイプの無効化> (バージョン 5 以降のみ) |
| − | :*< | + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) |
| − | :*< | + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) |
| − | :*< | + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) |
| − | :*< | + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) |
| − | :*< | + | :*<ff_type> (バージョン 733 以降のみ) |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | + | 例 (SNMPバージョン: 3、snmp3暗号化方式: AES、snmp3暗号化パスワード: example_priv_passw、snmp3セキュリティレベル: authNoPriv、snmp3認証方式:MD5、snmp3認証ユーザ: pepito_user、snmp3認証パスワード: example_priv_passw) | |
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 apply_policy==== | |
| − | + | ひとつもしくは複数のエージェントに、ID を指定してポリシーを適用します。 | |
| − | ====set | + | 書式: |
| + | *op=set (必須) | ||
| + | *op2=apply_policy (必須) | ||
| + | *id=<id_policy> (必須) | ||
| + | *id2=<id_agent> (オプション) 他のパラメータに示されているエージェントのIDまたは名前。 空の場合、ポリシーはすべてのエージェントに適用されます。 | ||
| + | *other=<連続パラメータ> | ||
| + | :*<name_agent (整数)> エージェントを ID(0) で指定するか、名前(1) で指定するか、別名(2) で指定するかを示します。 | ||
| + | :*<server_id> (メタコンソールの場合必要です) ポリシーを適用するサーバの ID です。 | ||
| + | :*<return> | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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 apply_all_policies==== | ||
| − | + | Pandora 内にある全ポリシーを適用します。 | |
書式: | 書式: | ||
| + | *op=set (必須) | ||
| + | *op2=apply_all_policies (必須) | ||
| + | =====例===== | ||
| + | |||
| + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies</nowiki> | ||
| + | |||
| + | ====set add_network_module_policy==== | ||
| + | |||
| + | 指定したパラメータで、ポリシーにネットワークモジュールを追加します。 | ||
| + | |||
| + | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=add_network_module_policy (必須) |
| − | *id=< | + | *id=<ポリシーID> (必須) ポリシーIDでなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 |
| − | :*< | + | :*<モジュールタイプID> |
| − | |||
:*<説明> | :*<説明> | ||
| − | :*< | + | :*<モジュールグループID> |
| − | :*< | + | :*<最小値> |
| − | |||
| − | |||
| − | |||
| − | |||
:*<最大値> | :*<最大値> | ||
| − | :*< | + | :*<データ保存倍率> |
| − | :*< | + | :*<モジュールの間隔> |
| − | :*< | + | :*<警告の最小値> |
| − | :*< | + | :*<警告の最大値> |
| − | :*< | + | :*<警告文字列> |
| − | :*< | + | :*<障害の最小値> |
| − | :*< | + | :*<障害の最大値> |
| − | :*< | + | :*<障害文字列> |
| − | :*< | + | :*<データの保存> |
| − | :*< | + | :*<連続抑制回数> |
| − | :*< | + | :*<無効化> |
| − | :*< | + | :*<モジュールのポート> |
| − | :*< | + | :*<SNMPコミュニティ> |
| − | :*< | + | :*<SNMP OID> |
| − | :*< | + | :*<カスタムID> |
| − | :*< | + | :*<不明イベントの有効化> (バージョン 5 のみ) |
| − | :*< | + | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 |
| − | :*< | + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) |
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set add_plugin_module_policy==== |
| − | + | 指定したパラメータで、ポリシーにプラグインモジュールを追加します。 | |
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=add_plugin_module_policy (必須) |
| − | *id=< | + | *id=<ポリシーID> (必須) ポリシーIDでなければいけません。 |
| − | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 | |
| − | + | :*<モジュール名> | |
| − | + | :*<無効化> | |
| − | + | :*<モジュールタイプID> | |
| − | + | :*<モジュールグループID> | |
| − | + | :*<警告の最小値> | |
| − | + | :*<警告の最大値> | |
| − | + | :*<警告文字列> | |
| − | + | :*<障害の最小値> | |
| − | + | :*<障害の最大値> | |
| − | + | :*<障害文字列> | |
| − | * | + | :*<連続抑制回数> |
| − | * | + | :*<データの保存> |
| − | * | + | :*<モジュールのポート> |
| − | + | :*<SNMPコミュニティ> | |
| − | + | :*<SNMP OID> | |
| + | :*<モジュールの間隔> | ||
| + | :*<データ保存倍率> | ||
| + | :*<最小値> | ||
| + | :*<最大値> | ||
| + | :*<カスタムID> | ||
| + | :*<説明> | ||
| + | :*<プラグインID> | ||
| + | :*<プラグインユーザ> | ||
| + | :*<プラグインパスワード> | ||
| + | :*<プラグインパラメータ> | ||
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
| + | :*<マクロ> (バージョン 5 以降のみ) base 64 でエンコードした JSON 文字列でなければいけません。内容は、次のプロパティのオブジェクトを一つのオブジェクトにまとめた形式でなければいけません。 | ||
| + | :** ''"macro"'': マクロ名。''_field1_'', ''_field2_'', ..., ''_fieldN_'' でなければいけません。 | ||
| + | :**''"desc"'': マクロを表す名前。 | ||
| + | :**''"help"'': マクロの説明。 | ||
| + | :**''"value"'':マクロの値。 | ||
| + | :例 | ||
| + | { | ||
| + | "1": { | ||
| + | "macro": "_field1_", | ||
| + | "desc": "Target IP", | ||
| + | "help": "", | ||
| + | "value": "192.168.0.1" | ||
| + | }, | ||
| + | "2": { | ||
| + | "macro": "_field2_", | ||
| + | "desc": "Port", | ||
| + | "help": "", | ||
| + | "value": "80" | ||
| + | } | ||
| + | } | ||
| + | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
| − | + | =====例===== | |
| − | + | <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= | + | *op2=add_data_module_policy (必須) |
| − | *id=< | + | *id=<ポリシーID> (必須) ポリシーIDでなければいけません。 |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 |
| − | * | + | :*<モジュール名> |
| − | :*< | + | :*<モジュールタイプID> |
| + | :*<説明> | ||
| + | :*<モジュールグループID> | ||
| + | :*<最小値> | ||
| + | :*<最大値> | ||
| + | :*<データ保存倍率> | ||
| + | :*<モジュールの間隔> | ||
| + | :*<警告の最小値> | ||
| + | :*<警告の最大値> | ||
| + | :*<警告文字列> | ||
| + | :*<障害の最小値> | ||
| + | :*<障害の最大値> | ||
| + | :*<障害文字列> | ||
| + | :*<データの保存> | ||
| + | :*<設定データ> ポリシーエージェントの設定ファイルに挿入されるエージェントの定義ブロックです。 | ||
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
| + | :*<モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。 | ||
| + | :*<連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<連続抑制タイムアウト> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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> |
| − | ====set | + | ====set add_SNMP_module_policy==== |
| − | + | 指定したパラメータで、ポリシーに SNMP モジュールを追加します。 | |
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=add_snmp_module_policy (必須) |
| − | *id=< | + | *id=<ポリシーID> (必須) ポリシーIDでなければいけません。 |
| − | + | *other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。 | |
| − | + | :*<モジュール名> | |
| − | + | :*<無効化> | |
| − | + | :*<モジュールタイプID> | |
| − | + | :*<モジュールグループID> | |
| − | + | :*<警告の最小値> | |
| − | + | :*<警告の最大値> | |
| − | + | :*<警告文字列> | |
| − | + | :*<障害の最小値> | |
| − | + | :*<障害の最大値> | |
| − | * | + | :*<障害文字列> |
| − | * | + | :*<連続抑制回数> |
| − | * | + | :*<データの保存> |
| − | * | + | :*<モジュールのポート> |
| − | :*< | + | :*<SNMPバージョン> |
| − | :*< | + | :*<SNMPコミュニティ> |
| − | :*< | + | :*<SNMP OID> |
| − | :*< | + | :*<モジュールの間隔> |
| − | :*< | + | :*<データ保存倍率> |
| − | :*< | + | :*<最小値> |
| − | :*< | + | :*<最大値> |
| − | :*< | + | :*<カスタムID> |
| − | :*< | + | :*<説明> |
| + | :*<snmp3 暗号化方式 [AES|DES]> | ||
| + | :*<snmp3 暗号化パスワード> | ||
| + | :*<snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]> | ||
| + | :*<snmp3 認証方式 [MD5|SHA]> | ||
| + | :*<snmp3 認証ユーザ> | ||
| + | :*<snmp3 認証パスワード> | ||
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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> |
| − | ==== | + | ====set add_agent_policy_by_id==== |
| − | + | エージェント ID を用いてポリシーにエージェントを追加します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=add_agent_policy_by_id (必須) |
| − | *id=< | + | *id=<id_policy> (必須) ポリシー ID である必要があります。 |
| − | *other=< | + | *other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります: |
| − | :*< | + | :*<id_agent> |
| − | :*< | + | :*<id_node> (メタコンソールの場合は必須) ポリシーに追加するエージェントが属するノードのID。 |
| − | : | + | |
| − | : | + | =====例===== |
| − | : | + | |
| − | + | * ノード: | |
| − | + | <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> | |
| − | :* | + | |
| − | + | * メタコンソール: | |
| − | + | <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 (必須) | ||
| + | *op2=add_agent_policy_by_name (必須) | ||
| + | *id=<id_policy> (必須) ポリシー ID である必要があります。 | ||
| + | *other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります: | ||
| + | :*<agent_name> | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set remove_agent_from_policy_by_id==== |
| − | + | エージェント ID を用いて、ポリシーからエージェントを削除します。 | |
書式: | 書式: | ||
| + | *op=set (必須) | ||
| + | *op2=remove_agent_from_policy_by_id (必須) | ||
| + | *id=<id_política> (必須) ポリシー ID である必要があります。 | ||
| + | *other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります: | ||
| + | :*<id_agent> | ||
| + | :*<id_node> (required when using the Metaconsole). ID of the node the agent you wish to remove from the policy belongs to. | ||
| − | + | =====必須===== | |
| − | |||
| − | |||
| − | ===== | + | * ノード: |
| + | <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= | + | * メタコンソール: |
| + | <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 | + | ====set remove_agent_from_policy_by_name==== |
| − | + | エージェント名を用いて、ポリシーからエージェントを削除します。 | |
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=remove_agent_from_policy_by_name (必須) |
| − | *id=< | + | *id=<id_policy> (必須) ポリシー ID である必要があります。 |
| − | other= | + | *other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります: |
| + | :*<agent_name> | ||
=====例===== | =====例===== | ||
| − | + | <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 new_network_component==== | |
| − | + | 新たなネットワークコンポーネントを作成します。 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_network_component (必須) |
| − | *id=< | + | *id=<ネットワークコンポーネント名> (必須) ネットワークコンポーネント名でなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でエージェントの設定とネットワークコンポーネントのデータを指定します。 |
| − | :*< | + | :*<ネットワークコンポーネントタイプ> |
| − | :*< | + | :*<説明> |
| − | :*< | + | :*<モジュールの間隔> |
| − | :*< | + | :*<最大値> |
| − | :*< | + | :*<最小値> |
| − | :*< | + | :*<SNMPコミュニティ> |
| − | :*< | + | :*<モジュールグループID> |
| − | :*< | + | :*<最大タイムアウト> |
| + | :*<データの保存> | ||
| + | :*<警告の最小値> | ||
| + | :*<警告の最大値> | ||
| + | :*<警告文字列> | ||
| + | :*<障害の最小値> | ||
| + | :*<障害の最大値> | ||
| + | :*<障害文字列> | ||
| + | :*<連続抑制回数> | ||
| + | :*<データ保存倍率> | ||
| + | :*<ネットワークコンポーネントグループ> | ||
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | + | <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 (必須) | ||
| + | *op2=new_plugin_component (必須) | ||
| + | *id=<プラグインコンポーネント名> (必須) プラグインコンポーネント名でなければいけません。 | ||
| + | *other=<連続パラメータ> (必須) 次の順番でエージェントの設定とプラグインコンポーネントのデータを指定します。 | ||
| + | :*<プラグインコンポーネントタイプ> | ||
| + | :*<説明> | ||
| + | :*<モジュールの間隔> | ||
| + | :*<最大値> | ||
| + | :*<最小値> | ||
| + | :*<モジュールのポート> | ||
| + | :*<モジュールグループID> | ||
| + | :*<プラグインID> | ||
| + | :*<最大タイムアウト> | ||
| + | :*<データの保存> | ||
| + | :*<警告の最小値> | ||
| + | :*<警告の最大値> | ||
| + | :*<警告文字列> | ||
| + | :*<障害の最小値> | ||
| + | :*<障害の最大値> | ||
| + | :*<障害文字列> | ||
| + | :*<連続抑制回数> | ||
| + | :*<データ保存倍率> | ||
| + | :*<プラグインコンポーネントグループ> | ||
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
| − | + | =====例===== | |
| − | + | <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= | + | *op2=new_snmp_component (必須) |
| − | *id=< | + | *id=<SNMPコンポーネント名> (必須) SNMPコンポーネント名でなければいけません。 |
| − | + | *other=<連続パラメータ> (必須) 次の順番で SNMP コンポーネントの設定とデータを指定します。 | |
| − | + | :*<SNMPコンポーネントタイプ> | |
| − | + | :*<説明> | |
| − | + | :*<モジュールの間隔> | |
| − | + | :*<最大値> | |
| − | + | :*<最小値> | |
| − | + | :*<モジュールグループID> | |
| − | + | :*<最大タイムアウト> | |
| + | :*<データの保存> | ||
| + | :*<警告の最小値> | ||
| + | :*<警告の最大値> | ||
| + | :*<警告文字列> | ||
| + | :*<障害の最小値> | ||
| + | :*<障害の最大値> | ||
| + | :*<障害文字列> | ||
| + | :*<連続抑制回数> | ||
| + | :*<データ保存倍率> | ||
| + | :*<SNMPバージョン> | ||
| + | :*<SNMP OID> | ||
| + | :*<SNMPコミュニティ> | ||
| + | :*<snmp3 認証ユーザ> | ||
| + | :*<snmp3 認証パスワード> | ||
| + | :*<モジュールのポート> | ||
| + | :*<snmp3 暗号化手法> | ||
| + | :*<snmp3 暗号化パスワード> | ||
| + | :*<snmp3 認証手法> | ||
| + | :*<snmp3 セキュリティレベル> | ||
| + | :*<SNMPコンポーネントグループ> | ||
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
| − | + | =====例===== | |
| − | + | <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_local_component==== |
| − | |||
| − | + | 新たなローカルコンポーネントを作成します。 | |
| − | |||
| − | |||
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_local_component (必須) |
| − | *id=< | + | *id=<ローカルコンポーネント名> (必須) ローカルコンポーネント名でなければいけません。 |
| − | *other=<連続パラメータ> (必須) | + | *other=<連続パラメータ> (必須) 次の順番でローカルコンポーネントの設定とデータを指定します。 |
| − | :*< | + | :*<説明> |
| − | :*< | + | :*<OSのID> |
| + | :*<ローカルコンポーネントグループ> | ||
| + | :*<設定データ> モジュールの設定ブロックです。 | ||
| + | :*<不明イベントの有効化> (バージョン 5 以降のみ) | ||
| + | :*<連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<個別状態変化の利用> (バージョン 5.1 以降のみ) | ||
| + | :*<正常移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<警告移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<障害移行時連続抑制回数> (バージョン 5.1 以降のみ) | ||
| + | :*<連続抑制タイムアウト> (バージョン 5.1 以降のみ) | ||
| + | :*<ff_type> (バージョン 733 以降のみ) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set create_alert_template==== |
| − | + | アラートテンプレートを作成します。 | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=create_alert_template (必須) |
| − | *other=<連続パラメータ> (必須) | + | *id=<テンプレート名> (必須) テンプレート名でなければいけません。 |
| − | :*< | + | *other=<連続パラメータ> (必須) 次の順番でテンプレートの設定とデータを指定します。 |
| + | :*<タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]> | ||
:*<説明> | :*<説明> | ||
| − | :*< | + | :*<アラートアクションID> |
| + | :*<フィールド1> | ||
| + | :*<フィールド2> | ||
| + | :*<フィールド3> | ||
| + | :*<値> | ||
| + | :*<マッチする値> | ||
| + | :*<最大値> | ||
| + | :*<最小値> | ||
| + | :*<再通知間隔> | ||
| + | :*<最大アラート数> | ||
| + | :*<最小アラート数> | ||
| + | :*<開始時間> | ||
| + | :*<終了時間> | ||
| + | :*<月曜> | ||
| + | :*<火曜> | ||
| + | :*<水曜> | ||
| + | :*<木曜> | ||
| + | :*<金曜> | ||
| + | :*<土曜> | ||
| + | :*<日曜> | ||
| + | :*<復旧アラート> | ||
| + | :*<復旧時のフィールド2> | ||
| + | :*<復旧時のフィールド3> | ||
:*<優先度> | :*<優先度> | ||
| − | :*< | + | :*<グループID> |
| − | :*< | + | :*<特別日の利用> |
| + | :*<アラートが継続しない場合にカウンターをリセット> | ||
| + | :*<復旧時のフィールド1> | ||
| + | :*<フィールド4> | ||
| + | :*<フィールド5> | ||
| + | :*<フィールド6> | ||
| + | :*<フィールド7> | ||
| + | :*<フィールド8> | ||
| + | :*<フィールド9> | ||
| + | :*<フィールド10> | ||
| + | :*<フィールド11> | ||
| + | :*<フィールド12> | ||
| + | :*<フィールド13> | ||
| + | :*<フィールド14> | ||
| + | :*<フィールド15> | ||
| + | :*<復旧時のフィールド4> | ||
| + | :*<復旧時のフィールド5> | ||
| + | :*<復旧時のフィールド6> | ||
| + | :*<復旧時のフィールド7> | ||
| + | :*<復旧時のフィールド8> | ||
| + | :*<復旧時のフィールド9> | ||
| + | :*<復旧時のフィールド10> | ||
| + | :*<復旧時のフィールド11> | ||
| + | :*<復旧時のフィールド12> | ||
| + | :*<復旧時のフィールド13> | ||
| + | :*<復旧時のフィールド14> | ||
| + | :*<復旧時のフィールド15> | ||
=====例===== | =====例===== | ||
| − | + | 例1 (状態: regexp =~ /pp/、アクション: Mail to XXX、最大アラート数: 10、最小アラート数: 0、優先度: 警告、グループ: database): | |
| − | + | <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> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ==== | + | ====set update_alert_template==== |
| − | + | アラートテンプレートを更新します。 | |
| − | + | 書式: | |
| − | |||
| − | |||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_alert_template (必須) |
| + | *id=<テンプレートID> (必須) テンプレートIDでなければいけません。 | ||
| + | *other=<連続パラメータ> (必須) 次の順番でテンプレートの設定とデータを指定します。 | ||
| + | :*<テンプレート名> | ||
| + | :*<タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]> | ||
| + | :*<説明> | ||
| + | :*<アラートアクションID> | ||
| + | :*<フィールド1> | ||
| + | :*<フィールド2> | ||
| + | :*<フィールド3> | ||
| + | :*<値> | ||
| + | :*<マッチする値> | ||
| + | :*<最大値> | ||
| + | :*<最小値> | ||
| + | :*<再実行間隔> | ||
| + | :*<最大アラート数> | ||
| + | :*<最小アラート数> | ||
| + | :*<開始時間> | ||
| + | :*<終了時間> | ||
| + | :*<月曜> | ||
| + | :*<火曜> | ||
| + | :*<水曜> | ||
| + | :*<木曜> | ||
| + | :*<金曜> | ||
| + | :*<土曜> | ||
| + | :*<日曜> | ||
| + | :*<復旧アラート> | ||
| + | :*<復旧時のフィールド2> | ||
| + | :*<復旧時のフィールド3> | ||
| + | :*<優先度> | ||
| + | :*<グループID> | ||
| + | :*<特別日の利用> | ||
| + | :*<アラートが継続しない場合にカウンターをリセット> | ||
| + | :*<復旧時のフィールド1> | ||
| + | :*<フィールド4> | ||
| + | :*<フィールド5> | ||
| + | :*<フィールド6> | ||
| + | :*<フィールド7> | ||
| + | :*<フィールド8> | ||
| + | :*<フィールド9> | ||
| + | :*<フィールド10> | ||
| + | :*<フィールド11> | ||
| + | :*<フィールド12> | ||
| + | :*<フィールド13> | ||
| + | :*<フィールド14> | ||
| + | :*<フィールド15> | ||
| + | :*<復旧時のフィールド4> | ||
| + | :*<復旧時のフィールド5> | ||
| + | :*<復旧時のフィールド6> | ||
| + | :*<復旧時のフィールド7> | ||
| + | :*<復旧時のフィールド8> | ||
| + | :*<復旧時のフィールド9> | ||
| + | :*<復旧時のフィールド10> | ||
| + | :*<復旧時のフィールド11> | ||
| + | :*<復旧時のフィールド12> | ||
| + | :*<復旧時のフィールド13> | ||
| + | :*<復旧時のフィールド14> | ||
| + | :*<復旧時のフィールド15> | ||
=====例===== | =====例===== | ||
| − | |||
| − | + | <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 delete_alert_template==== | |
| + | |||
| + | アラートテンプレートと、テンプレートで使われているアラートを削除します。 | ||
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=delete_alert_template (必須) |
| + | *id=<テンプレートID> (必須) テンプレートIDでなければいけません。 | ||
=====例===== | =====例===== | ||
| − | |||
| − | ====set | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38</nowiki> |
| + | |||
| + | ====set delete_module_template==== | ||
| − | + | モジュールテンプレートを削除します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=delete_module_template (必須) |
| − | * | + | *id=<alert_template_module ID> (必須) alert_template_module のIDでなければいけません。 |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38</nowiki> |
| − | ====set | + | ====set delete_module_template_by_names==== |
| − | + | モジュールテンプレートを削除します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=delete_module_template_by_names (必須) |
| − | * | + | *id=<エージェント名> (必須) |
| − | + | *id2=<アラートテンプレート名> (必須) | |
| − | + | *other=<連続パラメータ> (必須) 次の順番でデータを指定します。 | |
| − | + | :*<モジュール名> (必須) | |
| − | :*< | + | :*<エージェントの別名の利用> (値は 0 または 1 です) |
| − | :*< | ||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set stop_dowtime==== |
| − | + | 計画停止を停止します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=stop_downtime (必須) |
| − | *id=< | + | *id=<計画停止ID> (必須) 計画停止IDでなければいけません。 |
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1</nowiki> |
| − | ====set | + | ====set new_user==== |
| − | + | Pandora に新たなユーザを作成します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_user (必須) |
| − | *id=< | + | *id=<ユーザ名> (必須) ユーザ名でなければいけません。 |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番で設定とデータを指定します。 |
| − | * | + | :*<ユーザ名> |
| − | * | + | :*<フルネーム> |
| − | :*< | + | :*<名前> |
| − | :*< | + | :*<名字> |
| − | :*< | + | :*<ミドルネーム> |
| − | :*< | + | :*<電子メールアドレス> |
| + | :*<電話番号> | ||
| + | :*<言語> | ||
| + | :*<コメント> | ||
| + | :*<自動更新時間> | ||
| + | :*<デフォルトイベントフィルタ> | ||
| + | :*<セクション> | ||
| + | :*<セッション時間> (-1 は永久です) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 update_user==== | ||
| + | |||
| + | 指定した ID のユーザを指定したパラメータで更新します。 | ||
| + | |||
| + | 書式: | ||
| + | *op=set (必須) | ||
| + | *op2=update_user (必須) | ||
| + | *id=<ユーザ名> (必須) ユーザ名でなければいけません。 | ||
| + | *other=<連続パラメータ> (必須) 次の順番で設定とデータを指定します。 | ||
| + | :*<フルネーム> | ||
| + | :*<名前> | ||
| + | :*<名字> | ||
| + | :*<ミドルネーム> | ||
| + | :*<パスワード> | ||
| + | :*<電子メールアドレス> | ||
| + | :*<電話番号> | ||
| + | :*<言語> | ||
| + | :*<コメント> | ||
| + | :*<管理者> | ||
| + | :*<一画面の表示数> | ||
| + | :*<フラッシュグラフ> | ||
| + | |||
| + | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set delete_user==== |
| − | + | 選択したユーザを削除します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=delete_user (必須) |
| − | *id=< | + | *id=<ユーザ名> (必須) ユーザ名でなければいけません。 |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md</nowiki> |
| − | ==== | + | ====Set delete_user_permissions==== |
| + | {{metaconsole_ja}} | ||
| − | + | ユーザのパーミッションを削除します。 | |
書式: | 書式: | ||
| − | + | *Op = set(必須) | |
| − | * | + | *Op2 =delete_user_permission(必須) |
| − | * | + | *Return_type = csv|json(必須) |
| − | * | + | *Other = id profile(必須) |
| − | * | ||
| − | |||
=====例===== | =====例===== | ||
| − | + | ユーザのパーミッションを削除します。 | |
| + | Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 | ||
| − | http:// | + | <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 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(オプション) | ||
| − | + | =====例===== | |
| − | + | ||
| − | + | Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 | |
| − | |||
| − | |||
| − | + | {{Warning|no_hierarchy が空の場合、値が 0 になることに注意してください。}} | |
| − | + | {{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> |
| − | + | ====set enable_disable_user==== | |
| + | |||
| + | ユーザを無効化・有効化します。 | ||
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=enable_disable_user (必須) |
| − | + | *id=<ユーザ名> (必須) ユーザ名でなければいけません。 | |
| − | * | + | other=<フラグ> (必須) 有効化する場合は 1、無効化する場合は 0 を指定します。 |
| − | + | ||
| + | =====例===== | ||
| + | 例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> |
| − | http:// | + | 例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 | + | ====set meta_synch_user==== |
| − | + | {{メタコンソール}} | |
| + | ノードへメタコンソールユーザを同期します。 | ||
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=meta_synch_user (必須) |
| − | * | + | *other=<連続パラメータ> (オプション): |
| − | * | + | :*<user_name_1,user_name_2,user_name_3..> (先頭および末尾にスペースを入れずにカンマで区切ったユーザ名, 必須) |
| − | * | + | :*<server_name> (必須) |
| + | :*<profile_mode(1-0)> (オプション) | ||
| + | :*<group_name> (オプション) | ||
| + | :*<profile_1,profile_2,profile_3> (最初と最後にスペースを入れずにカンマで区切ったプロファイル, オプション) | ||
| + | :*<create_groups(1-0)> (オプション) | ||
| − | ===== 例 ===== | + | =====例===== |
| − | http://localhost/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set create_group==== |
| − | + | グループを作成します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=create_group (必須) |
| − | *id=< | + | *id=<グループ名> (必須) グループ名を指定します。 |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番で指定します。 |
| − | * | + | :*<アイコン名> |
| + | :*<親グループID> (オプション) | ||
| + | :*<説明> (オプション) | ||
| + | :*<ACLの伝播> (オプション) | ||
| + | :*<アラートの無効化> (オプション) | ||
| + | :*<カスタムID> (オプション) | ||
| + | :*<連絡先> (オプション) | ||
| + | :*<その他> (オプション) | ||
| − | ===== 例 ===== | + | =====例===== |
| + | |||
| + | 例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 | + | ====set update_group==== |
| − | + | グループの設定を更新します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_group (必須) |
| − | *id=< | + | *id=<グループID> (必須) グループIDを指定します。 |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番で指定します。 |
| + | :*<グループ名> | ||
| + | :*<アイコン名> | ||
| + | :*<親グループID> | ||
| + | :*<説明> | ||
| + | :*<ACLの伝播> | ||
| + | :*<アラートの無効化> | ||
| + | :*<カスタムID> | ||
| + | :*<連絡先> | ||
| + | :*<その他> | ||
| − | ===== 例 ===== | + | =====例===== |
| − | + | <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 | + | ====set delete_group==== |
| − | + | グループを削除します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=update_group (必須) |
| − | + | *id=<グループID> (必須) グループIDを指定します。 | |
| − | * | ||
| − | ===== 例 ===== | + | =====例===== |
| − | + | <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 | + | ====set add_user_profile==== |
| − | + | ユーザにプロファイルを追加します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=add_user_profile (必須) |
| − | *id=< | + | *id=<ユーザ名> (必須) ユーザ名でなければいけません。 |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番でグループの設定、プロファイルを指定します。 |
| + | :*<グループ> | ||
| + | :*<プロファイル> | ||
| − | ===== 例 ===== | + | =====例===== |
| + | <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> | ||
| − | + | ====set delete_user_profile==== | |
| − | + | ユーザのプロファイルを削します。 | |
| − | |||
| − | |||
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=delete_user_profile (必須) |
| − | *id=< | + | *id=<ユーザ名> (必須) ユーザ名でなければいけません。 |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番でグループおよびプロファイルを指定します。 |
| + | :*<グループ> | ||
| + | :*<プロファイル> | ||
| − | ===== 例 ===== | + | =====例===== |
| − | http:// | + | <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 | + | ====set new_incident==== |
| − | + | 新たなインシデントを作成します。 | |
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_incident (必須) |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番でインシデントの設定とデータを指定します。 |
| − | * | + | :*<タイトル> |
| + | :*<説明> | ||
| + | :*<作成者> | ||
| + | :*<優先度> | ||
| + | :*<状態> | ||
| + | :*<グループ> | ||
| − | ===== 例 ===== | + | =====例===== |
| − | http:// | + | <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 | + | ====set new_note_incident==== |
| − | + | インシデントにコメントを追加します。 | |
書式: | 書式: | ||
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_note_incident (必須) |
| − | *id=< | + | *id=<インシデントID> (必須) インシデントのIDです。 |
| − | * | + | *id2=<ユーザ名> (必須) ユーザ名です。 |
| − | * | + | *other=<コメント> (必須) URLエンコードされたコメントです。 |
| − | |||
=====例===== | =====例===== | ||
| − | |||
| − | ====set | + | <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> |
| − | + | ||
| + | ====set validate_all_alerts==== | ||
| − | + | 全アラートを承諾します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=validate_all_alerts (必須) |
| − | + | ||
| − | |||
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts</nowiki> |
| − | + | ====set validate_all_policy_alerts==== | |
| − | + | ポリシーから作成されたアラートを承諾します。 | |
| − | |||
| − | |||
| − | |||
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=validate_all_policy_alerts (必須) |
| − | |||
| − | |||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts</nowiki> |
| − | + | ====set event_validate_filter==== | |
| − | + | 指定したフィルタにマッチするすべてのイベントを承諾します。 | |
| − | |||
| − | + | 書式: | |
| − | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=event_validate_filter (必須) |
| − | * | + | *other_mode=url_encode_separator_|(オプション) |
| − | * | + | *other=<連続パラメータ> (オプション) 次の順番で指定します。 |
| − | * | + | :*<セパレータ> |
| + | :*<重要度> 0 から 4 | ||
| + | :*<エージェント名> | ||
| + | :*<モジュール名> | ||
| + | :*<アラートテンプレート名> | ||
| + | :*<ユーザ> | ||
| + | :*< 最小レベルの数値間隔> UNIXタイムスタンプ | ||
| + | :*< 最大レベルの数値間隔> UNIXタイムスタンプ | ||
| + | :*<エージェントの別名の利用> (値は 0 または 1 です) | ||
=====例===== | =====例===== | ||
| − | |||
| − | + | <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 | + | ====set event_validate_filter_pro==== |
| − | + | 前述の API と似たものです。 | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=event_validate_filter_pro (必須) |
| − | * | + | *other_mode=url_encode_separator_| (オプション) |
| − | + | *other=<連続パラメータ> (オプション) 次の順番で指定します。 | |
| − | + | :*<セパレータ> | |
| − | + | :*<重要度> 0 から 4 | |
| − | :*< | + | :*<エージェントID> |
| − | + | :*<モジュールID> | |
| − | + | :*<エージェントモジュールアラートID> | |
| − | :*<重要度> | + | :*<ユーザ> |
| − | :*< | + | :*<最小レベルの数値間隔> UNIXタイムスタンプ |
| − | + | :*<最大レベルの数値間隔> UNIXタイムスタンプ | |
| − | |||
| − | |||
| − | |||
| − | :*< | ||
| − | :*< | ||
| − | :*< | ||
| − | :*< | ||
| − | :*< | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/ | + | <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 | + | ====set validate_event_by_id==== |
| − | + | 指定した ID のイベントを承諾します。 | |
| − | + | 書式: | |
| − | |||
| − | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=validate_event_by_id (必須) |
| − | * | + | *id=<event_id> (必須) イベント ID です。 |
| − | |||
=====例===== | =====例===== | ||
| − | http:// | + | <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 | + | ====set new_alert_template==== |
| − | |||
| − | + | テンプレートおよび、エージェントIDおよびモジュール名からモジュールを指定して、新たなアラートを適用します。 | |
書式: | 書式: | ||
| + | |||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_alert_template (必須) |
| − | * | + | *id=<エージェント名> (必須) |
| − | + | *id2=<アラートテンプレート名> (必須) | |
| − | + | *other_mode=url_encode_separator_| (オプション) | |
| − | + | *other=<連続パラメータ> (必須) 次の順番で指定します。 | |
| − | :*< | + | :*<モジュール名> (必須) |
| − | :*< | + | :*<エージェントの別名の利用> (値は 0 または 1 です) |
=====例===== | =====例===== | ||
| − | http://127.0.0.1/ | + | <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 | + | ====set alert_actions==== |
| − | |||
| − | + | アラートにアクションを追加します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=alert_actions (必須) |
| − | *other=<連続パラメータ> (必須) | + | *id=<エージェント名> (必須) |
| − | :*< | + | *id2=<アラートテンプレート名> (必須) |
| − | :*< | + | *other_mode=url_encode_separator_| (オプション) |
| + | *other=<連続パラメータ> (必須) 次の順番で指定します。 | ||
| + | :*<モジュール名> (必須) | ||
| + | :*<アクション名> (必須) | ||
| + | :*<開始アラート数> (オプション) | ||
| + | :*<終了アラート数> (オプション) | ||
| + | :*<エージェントの別名の利用> (値は 0 または 1 です) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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> |
| + | |||
| + | <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> | ||
| − | ====set | + | ====set alert_commands==== |
| − | |||
| − | + | アラートにコマンドを追加します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=alert_commands (必須) |
| − | *other=<連続パラメータ> (必須) | + | *id=<コマンド名> (必須) |
| − | :*< | + | *other_mode=url_encode_separator_| (オプション) |
| − | :*< | + | *other=<連続パラメータ> (必須), 次の順番: |
| − | :*< | + | :*<command> (必須) |
| − | :*< | + | :*<id_group> (必須) |
| + | :*<description > (必須) | ||
| + | :*<internal > (オプション) | ||
| + | :*<field_description_1><field_value_1><field_description_2><field_value_2>...<field_description_n><field_value_n> | ||
=====例===== | =====例===== | ||
| + | <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> | ||
| − | + | ====set new_module==== | |
| − | + | 新たなモジュールを作成します。 | |
| − | |||
| − | |||
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=new_module (必須) |
| − | *id=< | + | *id=<エージェント名> (必須) |
| − | *other=< | + | *id2=<新たなモジュール名> (必須) |
| − | + | *other_mode=url_encode_separator_| (オプション) | |
| − | + | *other=<連続パラメータ> (必須) 次の順番で指定します。 | |
| − | + | :*<ネットワークモジュールの種類> (必須) | |
| − | + | :*<アクション名> (必須) | |
| − | + | :*<IP または URL> (必須) | |
| − | + | :*<ポート> (オプション) | |
| + | :*<説明> (オプション) | ||
| + | :*<最小値> (オプション) | ||
| + | :*<最大値> (オプション) | ||
| + | :*<データ保存倍率> (オプション) | ||
| + | :*<モジュールの間隔> (オプション) | ||
| + | :*<警告の最小値> (オプション) | ||
| + | :*<警告の最大値> (オプション) | ||
| + | :*<障害の最小値> (オプション) | ||
| + | :*<障害の最大値> (オプション) | ||
| + | :*<データの保存> (オプション) | ||
| + | :*<不明イベントの有効化> (バージョン 5 のみ) | ||
| + | :*<エージェントの別名の利用> (値は 0 または 1 です) | ||
| − | + | =====例===== | |
| − | + | ||
| − | http://127.0.0.1/pandora_console/include/api.php?op=set&op2= | + | <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 | + | ====set delete_module==== |
| − | |||
| − | + | モジュールを削除します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=delete_module (必須) |
| − | *id | + | *id=<エージェント名> (必須) |
| − | + | *id2=<モジュール名> (必須) | |
| − | + | *other=simulate (オプション) | |
| − | + | :*<エージェントの別名の利用> (値は 0 または 1 です) | |
| − | :*< | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora_console/include/api.php? | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito&other=simulate</nowiki> |
| − | ====set | + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito</nowiki> |
| − | + | ||
| + | ====set enable_alert==== | ||
| − | + | エージェントのアラートを有効化します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=enable_alert |
| − | *id | + | *id=<エージェント名> (必須) |
| − | + | *id2=<モジュール名> (必須) | |
| − | + | *other: アラートテンプレート名 (例: Warning イベント) (必須) | |
| − | + | ||
| − | : | + | ===== 例 ===== |
| − | : | + | |
| − | + | <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=garfio&id2=Status&other=Warning%20condition</nowiki> | |
| − | |||
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | ====set | + | ====set enable_alert_alias==== |
| − | |||
| − | + | エイリアスでエージェントのアラートを有効化します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=enable_alert_alias |
| − | *id | + | *id=<エージェントの別名> (必須) |
| − | + | *id2=<モジュール名> (必須) | |
| − | + | *other: アラートテンプレート名 (p.e: 警告イベント) (必須) | |
| − | : | + | |
| − | : | ||
| − | |||
| − | =====例===== | + | ===== 例 ===== |
| − | http:// | + | <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 | + | ====set disable_alert==== |
| − | |||
| − | + | エージェントのアラートを無効化します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=disable_alert |
| − | *id=< | + | *id=<エージェント名> (必須) |
| − | * | + | *id2=<モジュール名> (必須) |
| − | + | *other: アラートテンプレート名 (例: Warning イベント) (必須) | |
| − | : | ||
| − | : | ||
| − | |||
| − | =====例===== | + | ===== 例 ===== |
| − | http:// | + | <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=garfio&id2=Status&other=Warning%20condition</nowiki> |
| − | ====set | + | ====set disable_alert_alias==== |
| − | |||
| − | + | エージェントのアラートを無効化します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=disable_alert_alias |
| − | * | + | *id=<エージェントエイリアス> (必須) |
| + | *id2=<モジュール名> (必須) | ||
| + | *other: アラートテンプレート名 (例: 警告イベント) (必須) | ||
| − | =====例===== | + | ===== 例 ===== |
| − | http:// | + | <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> |
| − | ====set | + | ====set enable_module_alerts==== |
| − | |||
| − | + | enable_alert と同じです。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=enable_module_alerts |
| − | * | + | *id=<エージェント名> (必須) |
| + | *id2=<モジュール名> (必須) | ||
| + | *other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です) | ||
| − | =====例===== | + | ===== 例 ===== |
| − | http:// | + | <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=garfio&id2=Status</nowiki> |
| − | ====set | + | ====set disable_module_alerts==== |
| − | |||
| − | + | disable_alert と同じです。 | |
書式: | 書式: | ||
| − | * op = set (必須) | + | *op=set (必須) |
| − | * op2 = | + | *op2=disable_module_alerts |
| − | * id = | + | *id=<エージェント名> (必須) |
| − | * id2 = | + | *id2=<モジュール名> (必須) |
| − | * | + | *other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です) |
| − | |||
| − | =====例===== | + | ===== 例 ===== |
| − | http:// | + | <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=garfio&id2=Status</nowiki> |
| − | ====set | + | ====set enable_module==== |
| − | |||
| − | + | モジュールを有効化します。 | |
書式: | 書式: | ||
| − | * op = set (必須) | + | *op=set (必須) |
| − | * op2 = | + | *op2=enable_module |
| − | * id = | + | *id=<エージェント名> (必須) |
| − | * | + | *id2=<モジュール名> (必須) |
| − | * other = | + | *other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です) |
| − | =====例===== | + | ===== 例 ===== |
| − | http:// | + | <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=garfio&id2=Status</nowiki> |
| − | ====set | + | ====set disable_module==== |
| − | |||
| − | + | モジュールを無効化します。 | |
書式: | 書式: | ||
| − | * op = set (必須) | + | *op=set (必須) |
| − | * op2 = | + | *op2=disable_module |
| − | * | + | *id=<エージェント名> (必須) |
| − | * | + | *id2=<モジュール名> (必須) |
| + | *other (オプション)=<エージェントの別名の利用> (値は 0 または 1 です) | ||
| − | =====例===== | + | ===== 例 ===== |
| − | http:// | + | <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=garfio&id2=Status</nowiki> |
| − | ====set | + | ====set create_network_module_from_component==== |
| − | |||
| − | + | コンポーネントから新たなネットワークモジュールを作成します。 | |
書式: | 書式: | ||
| − | * op = set (必須) | + | *op=set (必須) |
| − | * op2 = | + | *op2=create_network_module_from_component (必須) |
| − | * id = | + | *id=<エージェント名> (必須) |
| − | * id2 = | + | *id2=<コンポーネント名> (必須) |
| + | *other (オプション)=<エージェントの別名の利用> (値は 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> |
| − | + | ====set module_data==== | |
| − | + | モジュールに値を追加します。この機能は、サーバに送信するデータを含む XML を生成します。このデータはデータベースを更新するためのものです。 | |
| − | |||
| − | + | この API 呼び出しは、XML ファイルの生成を制御し、そのプロセスの状態をメッセージで表示します。 | |
書式: | 書式: | ||
*op=set (必須) | *op=set (必須) | ||
| − | *op2= | + | *op2=module_data (必須) |
| − | * | + | *id=<エージェントモジュールID> (必須) |
| − | + | *other: モジュールのデータとタイムスタンプ | |
| − | + | **dato: Pandora のデータタイプ | |
| − | + | **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> | ||
| − | + | {{Warning|XML ファイルの生成が成功しても、データがデータベースに保存されることは保証されません。}} | |
| − | ====set | + | ====set new_module_group==== |
| − | |||
| − | + | 新たなモジュールグループを作成します。 | |
書式: | 書式: | ||
| + | *op=set (必須) | ||
| + | *op2=new_module_group (必須) | ||
| + | *id=<モジュールグループ名> (必須) | ||
| − | + | =====例===== | |
| − | + | <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> | |
| − | |||
| − | |||
| − | + | ====set module_group_synch==== | |
| − | |||
| − | + | {{メタコンソール}} | |
| + | メタコンソールからモジュールグループを同期します。 | ||
| − | + | 書式: | |
| + | *op=set (必須) | ||
| + | *op2=module_group_synch (必須) | ||
| + | *other=<連続パラメータ> (必須) メタコンソールと同期するサーバの名前が必須です。 | ||
| + | :*<server_name_1><server_name_2>...<server_name_n> (必須) | ||
| − | ====set | + | =====例===== |
| − | >=5. | + | <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 (必須) | |
| − | *op=set | + | *op2=add_module_in_conf (必須) |
| − | *op2= | + | *id=<エージェントID> (必須) |
| − | *id=< | + | *id2=<モジュール名> (必須) |
| + | *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 | + | ====set delete_module_in_conf==== |
| − | >=5. | + | >= 5.0 (エンタープライズ版のみ) |
| − | + | ローカルモジュールの設定を削除します。 | |
書式: | 書式: | ||
| + | *op=set (必須) | ||
| + | *op2=add_module_in_conf (必須) | ||
| + | *id=<エージェントID> (必須) | ||
| + | *id2=<モジュール名> (必須) | ||
| − | + | =====例===== | |
| − | + | <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 (必須) | |
| − | *op=set | + | *op2=update_module_in_conf (必須) |
| − | *op2= | + | *id=<エージェントID> (必須) |
| − | *id= | + | *id2=<モジュール名> (必須) |
| − | * | + | *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 | + | ====set module_custom_id==== |
| − | |||
| − | + | モジュール ID とカスタム ID の値をパラメータとして渡すことにより、''カスタムID'' の値を設定または削除します。 | |
書式: | 書式: | ||
| − | *op=set | + | *op=set (必須) |
| − | *op2= | + | *op2=module_custom_id (必須) |
| − | *id= | + | *id=id_agent_module (必須) |
| − | * | + | *id2=カスタムIDの値、もしくは、削除する場合は何も指定しない (必須) |
| − | |||
=====例===== | =====例===== | ||
| + | <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_custom_id&id=5&id2=1521&apipass=1234&user=admin&pass=pandora</nowiki> | ||
| − | + | ====set create_event==== | |
| − | + | Pandora 内に新たなイベントを作成します。 | |
| − | |||
| − | |||
| − | |||
書式: | 書式: | ||
| + | *op=set (必須) | ||
| + | *op2=create_event (必須) | ||
| + | *other=<連続パラメータ> (必須) 次の順番でイベントデータを指定します: | ||
| + | :*<イベントテキスト> (必須) | ||
| + | :*<グループID> (必須) | ||
| + | :*<エージェントID> (必須) | ||
| + | :*<状態> | ||
| + | :*<ユーザID> | ||
| + | :*<イベントタイプ> | ||
| + | :*<重要度> | ||
| + | :*<エージェントモジュールID> | ||
| + | :*<アラートID> | ||
| + | :*<障害の説明> | ||
| + | :*<警告の説明> | ||
| + | :*<不明の説明> | ||
| + | :*<コメント> | ||
| + | :*<ユーザコマンド> | ||
| + | :*<オーナーユーザ>(文字列) | ||
| + | :*<発生元> | ||
| + | :*<タグ> | ||
| + | :*<カスタムデータ> カスタムデータは、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=<連続パラメータ> (必須) 次の順番でイベントデータを指定します: | ||
| + | :*<コメント> (必須) | ||
| − | + | {{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=<連続パラメータ> (必須) ''field.value'' フォーマットおよび url_encode_separator (例: |) で分割した、更新するイベントフィールド | ||
| + | *<comment> (必須) | ||
| − | + | =====設定可能フィールド===== | |
| − | * | + | * '''estado''': イベントの状態表す数値。以下を指定可能です。 |
| − | * | + | ** 0 (新規) |
| − | * | + | ** 1 (承諾済) |
| − | * | + | ** 2 (処理中) |
| − | * | + | * '''evento''': イベント名。 |
| − | * | + | * '''event_type''': イベントタイプ。以下を指定可能です。 |
| + | ** going_unknown | ||
| + | ** unknown | ||
| + | ** alert_fired | ||
| + | ** alert_recovered | ||
| + | ** alert_ceased | ||
| + | ** alert_manual_validation | ||
| + | ** recon_host_detected | ||
| + | ** system | ||
| + | ** error | ||
| + | ** new_agent | ||
| + | ** going_up_warning | ||
| + | ** going_up_critical | ||
| + | ** going_down_warning | ||
| + | ** going_down_normal | ||
| + | ** going_down_critical | ||
| + | ** going_up_normal | ||
| + | ** configuration_change | ||
| + | * '''criticity''': イベントの重要度を表す数値。以下を指定可能です。 | ||
| + | ** 0 (メンテナンス) | ||
| + | ** 1 (情報) | ||
| + | ** 2 (正常) | ||
| + | ** 3 (マイナー) | ||
| + | ** 4 (警告) | ||
| + | ** 5 (メジャー) | ||
| + | ** 6 (障害) | ||
| + | ** 20 (警告または障害) | ||
| + | ** 21 (正常以外) | ||
| + | ** 34 (障害または正常) | ||
| + | * '''tags''': イベントに関連付けられたタグ。 | ||
| + | * '''source''': イベントのデータソース。 | ||
| + | * '''id_extra''': この機能を使用すると、新しいイベントと同じ追加 ID を持つ古いイベントが自動的に承諾されます。 | ||
| + | * '''critical_instructions''': モジュールが障害状態になったときに実行するアクションに関するオペレーター向けの手順。モジュールが障害状態の場合にのみイベントに表示されます。 | ||
| + | * '''warning_instructions''': モジュールが警告状態になったときに実行するアクションに関するオペレーター向けの手順。モジュールが警告状態の場合にのみイベントに表示されます。 | ||
| + | * '''unknown_instructions''': モジュールが不明状態になったときに実行するアクションに関するオペレーター向けの手順。モジュールが不明状態の場合にのみイベントに表示されます。 | ||
| + | * '''owner_user''': イベントに割り当てられたユーザ。 | ||
| + | * '''custom_data''': カスタム情報をイベントに追加できます。base64 でエンコードされた json フォーマット(例: <nowiki>{"field1":"value1","field2":"value2"}</nowiki>) である必要があります。以下の例を参照ください。 | ||
| + | * '''module_status''': イベントを発生させたモジュールの状態を表す数値です。以下を指定可能です。 | ||
| + | ** 0 (正常) | ||
| + | ** 1 (障害) | ||
| + | ** 2 (警告) | ||
| + | ** 3 (不明) | ||
| + | ** 4 (未初期化) | ||
=====例===== | =====例===== | ||
| + | * ノード: | ||
| + | |||
| + | <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,Updated event|custom_data,eyJmaWVsZDEiOiJ2YWx1ZTEiLCJmaWVsZDIiOiJ2YWx1ZTIifQo=</nowiki> | ||
| − | + | * メタコンソール: | |
| − | ==== | + | <nowiki>http://192.168.80.35/pandora_console/include/api.php?op=set&op2=event&apipass=1234&user=admin&pass=pandora&id=315132&other_mode=url_encode_separator_|&other=estado,0|owner_user,operator|evento,Updated event</nowiki> |
| − | >= | + | ====set create_netflow_filter==== |
| + | (>=5.0) | ||
| − | + | 新たな netflow フィルタを作成します。 | |
| − | *op= | + | 書式: |
| − | *op2= | + | *op=set (必須) |
| − | * | + | *op2=create_netflow_filter (必須) |
| − | * | + | *other=<連続パラメータ> (必須) 次の順番でフィルタデータを指定します: |
| + | :*<フィルター名> (必須) | ||
| + | :*<グループID> (必須) | ||
| + | :*<フィルタ> (必須) | ||
| + | :*<集約方法> (設定可能な値: dstip,dstport,none,proto,srcip,srcport) (必須) | ||
| + | :*<出力フォーマット> (設定可能な値: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (必須) | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/ | + | <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=<連続パラメータ> (必須) カスタムフィールドを設定するパラメータ | ||
| + | :*<名前> (必須) | ||
| + | :*<フロント表示フラグ> (必須; 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=<連続パラメータ> (必須) タグの設定パラメータ | ||
| + | :*<名前> タグ名 (必須) | ||
| + | :*<説明> タグの説明 | ||
| + | :*<url> タグの URL | ||
| + | :*<email> タグのメールアドレス | ||
=====例===== | =====例===== | ||
| − | http://127.0.0.1/pandora5/include/api.php?apipass= | + | <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=<エージェントID> (必須) エージェントIDでなければいけません。 | ||
| + | *other=<フラグ> (必須) 有効化する場合は 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=<連続パラメータ> (必須) 位置情報パラメータ | ||
| + | :*<緯度> | ||
| + | :*<経度> | ||
| + | :*<高度> | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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=<連続パラメータ> (必須) gisデータ | ||
| + | :*<緯度> | ||
| + | :*<経度> | ||
| + | :*<高度> | ||
| + | :*<新たなgisデータの無視> | ||
| + | :*<手動位置決め> | ||
| + | :*<開始タイムスタンプ> | ||
| + | :*<終了タイムスタンプ> | ||
| + | :*<データ数> | ||
| + | :*<履歴保存の説明> | ||
| + | :*<gis更新の説明> | ||
| + | :*<初回挿入の説明> | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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=<連続パラメータ> (必須) | ||
| + | :*<特別日> | ||
| + | :*<同一の日> | ||
| + | :*<説明> | ||
| + | :*<グループID> | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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=<特別日ID> (compulsory) | ||
| + | *other=<連続パラメータ> (必須) | ||
| + | :*<特別日> | ||
| + | :*<同一の日> | ||
| + | :*<説明> | ||
| + | :*<グループID> | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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=<連続パラメータ> (必須) 計画停止を作成するパラメータ列: | ||
| + | |||
| + | :*<説明> | ||
| + | :*<開始日時> 一回のみの場合の開始日時 | ||
| + | :*<終了日時> 一回のみの場合の終了日時 | ||
| + | :*<グループID> | ||
| + | :*<月> | ||
| + | :*<火> | ||
| + | :*<水> | ||
| + | :*<木> | ||
| + | :*<金> | ||
| + | :*<土> | ||
| + | :*<日> | ||
| + | :*<定期実行開始時間> | ||
| + | :*<定期実行終了時間> | ||
| + | :*<定期実行開始日> | ||
| + | :*<定期実行終了日> | ||
| + | :*<タイプ> quit, disabled_agents, disabled_agents_alerts のいずれか | ||
| + | :*<実行> once または periodically | ||
| + | :*<定期実行タイプ> weekly または monthly | ||
| + | :*<id_user> | ||
| + | |||
| + | {{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=<計画停止ID> | ||
| + | *other=<連続パラメータ> (必須) 追加対象 | ||
| + | |||
| + | :*<エージェントID1;エージェントID2;エージェントID3;...エージェントIDn> | ||
| + | :*<モジュール名1;モジュール名2;モジュール名3;...モジュール名n> | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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=<計画停止ID> | ||
| + | |||
| + | =====例===== | ||
| + | |||
| + | <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=<エージェントの別名の利用> | ||
| + | *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 | ||