差分
このページの2つのバージョン間の差分を表示します。
ja:documentation:08_technical_reference:02_annex_externalapi [2023/02/15 05:34] – [API 呼び出し] junichi | ja:documentation:08_technical_reference:02_annex_externalapi [Unknown date] (現在) – 削除 - 外部編集 (Unknown date) 127.0.0.1 | ||
---|---|---|---|
行 1: | 行 1: | ||
- | ====== 外部 API ====== | ||
- | {{indexmenu_n> | ||
- | |||
- | [[ja: | ||
- | |||
- | ===== Pandora FMS 外部 API ===== | ||
- | |||
- | Pandora FMS 外部 API は、(**/ | ||
- | これは、Pandora FMS 外から操作するアプリケーションを作成できるように、Pandora FMS に用意されている手法です。基本的に、アプリケーションからの操作で、指定したフォーマットのパラメータで値を受け渡します。 | ||
- | |||
- | API.php の呼び出しは、次のように単純です。 | ||
- | |||
- | <code bash> | ||
- | http://< | ||
- | |||
- | |||
- | </ | ||
- | |||
- | <code bash> | ||
- | http://< | ||
- | |||
- | |||
- | </ | ||
- | |||
- | API は次のパラメータのみ受け取ることができます。 | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | | ||
- | <code bash> | ||
- | ...other=pears|melons|watermelon& | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round tip 60%> | ||
- | |||
- | You can use any separator, in this documentation the '' | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round tip 60%> | ||
- | 任意の区切り文字を使用できます。このドキュメントでは、'' | ||
- | </ | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * **Security credentials**: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * **Security credentials**: | ||
- | |||
- | ==== セキュリティ ==== | ||
- | |||
- | The API authenticates access via API source and/or password and/or user credentials. | ||
- | |||
- | API は、アクセス元、パスワードおよび、ユーザ資格情報を介してアクセスを認証します。 | ||
- | |||
- | === アクセス元による === | ||
- | |||
- | At the moment, security is based on an IP addresses list that will have [[: | ||
- | |||
- | 現時点では、セキュリティは[[: | ||
- | |||
- | {{ : | ||
- | |||
- | If you enter the character '' | ||
- | |||
- | テキストボックスに '' | ||
- | |||
- | === API パスワードによる === | ||
- | |||
- | You can also set a password for API actions (·**API password**). | ||
- | |||
- | API アクセスのパスワードも設定することができます。(**API パスワード(API password)**) | ||
- | |||
- | * '' | ||
- | |||
- | * '' | ||
- | |||
- | === ユーザ資格情報による === | ||
- | |||
- | Access is by user name and password; additionally from version 768 or later it is possible to authenticate by bearer token. | ||
- | |||
- | ユーザ名とパスワードによるものです。さらに、バージョン 768 以降からは、Bearer トークンによる認証が可能です。 | ||
- | |||
- | == ユーザ名とパスワードによる == | ||
- | |||
- | To access API actions, it is necessary to give a Pandora FMS valid user name and password. | ||
- | |||
- | API へアクセスするには、Pandora FMS の正しいユーザ名とパスワードを与える必要があります。 | ||
- | |||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | |||
- | <WRAP center round important 60%> | ||
- | |||
- | In API calls, passwords are uncoded. Be careful and use SSL connections to avoid sniffers from third party. The API allows POST petitions to encrypt them when using SSL/HTTPS. | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round important 60%> | ||
- | API 呼び出しではパスワードは暗号化されていません。SSL 接続を使用することにより、第三者から盗み見られることを防いでください。API アクセスでは、SSL/ | ||
- | </ | ||
- | |||
- | === 戻り値 === | ||
- | API へのアクセスができなかった場合は、単純に "auth error" という文字が出力されます。 | ||
- | |||
- | === 例 === | ||
- | |||
- | In this documentaion the API password '' | ||
- | |||
- | このドキュメントでは、API パスワードが '' | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | <WRAP center round info 60%> | ||
- | |||
- | Access conditions: | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round info 60%> | ||
- | アクセス条件: | ||
- | </ | ||
- | |||
- | * The source IP address is in the ACLs IP addresses list (or is used '' | ||
- | * The API password is //not set// or is '' | ||
- | * The user '' | ||
- | |||
- | * ソース IP アドレスが ACL の IP アドレス一覧に存在する(または '' | ||
- | * API パスワードが // | ||
- | * ユーザ '' | ||
- | |||
- | ==== API チェッカー ==== | ||
- | |||
- | Access from the Administration menu: **Admin tools** → **API checker**. | ||
- | |||
- | 管理メニューの **管理ツール(Admin tools)** → **API チェッカー(API checker)** からアクセスします。 | ||
- | |||
- | {{ : | ||
- | |||
- | {{ : | ||
- | |||
- | <WRAP center round info 60%> | ||
- | |||
- | **Version 768 or later**: You can authenticate with **API Token** by sending in the [[https:// | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round info 60%> | ||
- | |||
- | **バージョン 768 以降**: [[https:// | ||
- | |||
- | </ | ||
- | |||
- | {{ : | ||
- | |||
- | {{ : | ||
- | |||
- | ==== セキュリティ処理の流れ ==== | ||
- | |||
- | It is implemented thanks to three elements: | ||
- | |||
- | 次の 3つの要素で実装されています。 | ||
- | |||
- | * [[: | ||
- | * [[: | ||
- | * [[: | ||
- | |||
- | * [[: | ||
- | * [[: | ||
- | * [[: | ||
- | |||
- | 以下に処理の流れを示します。 | ||
- | |||
- | {{ : | ||
- | |||
- | |||
- | |||
- | == 関数例 == | ||
- | 以下に示すのは、関数の例です。 | ||
- | |||
- | < | ||
- | function apiextension_get_groupmodules($group_name) { | ||
- | $group_id = group_id_from_name($group_name); | ||
- | if($group_id == false) { | ||
- | echo 'Group doesnt exist'; | ||
- | | ||
- | } | ||
- | |||
- | $number_of_modules = group_modules($group_id); | ||
- | echo $number_of_modules; | ||
- | } | ||
- | </ | ||
- | |||
- | == 呼び出し例 == | ||
- | この呼び出し例では、" | ||
- | |||
- | http:// | ||
- | |||
- | |||
- | |||
- | ===== API 呼び出し ===== | ||
- | |||
- | They are divided into two groups, depending on whether they [[: | ||
- | |||
- | Pandora FMS に対して[[: | ||
- | |||
- | There is an exception: The [[: | ||
- | |||
- | 例外があります: | ||
- | ==== 情報取得 ==== | ||
- | |||
- | Pandora コンソールのバージョンを返します。// | ||
- | |||
- | これは、Pandora FMS のインストールパスの確認と、認証前にバージョンを確認するのに便利です。 | ||
- | |||
- | 返される情報はログイン画面から確認することができるものであるため、セキュリティ上の脆弱性にはなりません。 | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | A return sample could be: //Pandora FMS v7.0NG.756 - PC210802 MR48// | ||
- | |||
- | 例えば、// | ||
- | |||
- | | ||
- | |||
- | ==== 読み出し ==== | ||
- | |||
- | データを読み出します。 | ||
- | |||
- | === get test === | ||
- | |||
- | 書式: パラメータ無し | ||
- | |||
- | **例** | ||
- | |||
- | 以下の例では、OK を返します。 | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 応答サンプル: | ||
- | === get license === | ||
- | |||
- | ユーザ権限のアクセスレベルに応じて、Pandora FMS のライセンス状態を返します。 | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | **Example (see ** [[: | ||
- | |||
- | **例 (** [[: | ||
- | |||
- | <code bash> | ||
- | …/ | ||
- | |||
- | </ | ||
- | |||
- | // | ||
- | |||
- | <code json> | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | </ | ||
- | === get all_agents === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=all_agents (必須) | ||
- | * return_type=csv または json (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | この例では、OS ID が 1、グループ ID が 2、状態が警告、エージェント名に ' | ||
- | |||
- | < | ||
- | CSV の例: http:// | ||
- | JSON の例: http:// | ||
- | |||
- | </ | ||
- | |||
- | === get license_remaining === | ||
- | |||
- | >= 7.0NG 752 | ||
- | |||
- | To check the number of Agents or Modules available according to the Pandora FMS use licence and according to the access level of the user credentials used. | ||
- | |||
- | Pandora FMS ライセンスおよびユーザのアクセス権限に応じた、残りのエージェントまたはモジュール数を確認します。 | ||
- | |||
- | Call syntax: | ||
- | |||
- | 書式: | ||
- | |||
- | * op = get (required) | ||
- | * op2= license_remaining (required) | ||
- | * return_type = json (required) | ||
- | |||
- | * op = get (必須) | ||
- | * op2= license_remaining (必須) | ||
- | * return_type = json (必須) | ||
- | |||
- | **Examples** | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_last_value === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_last_value (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * エラーコードは次の通りです: | ||
- | * ' | ||
- | * ' | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get agent_module_name_last_value === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=agent_module_name_last_value (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other=< | ||
- | * エラーコードは次の通りです: | ||
- | * ' | ||
- | * ' | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get agent_module_name_last_value_alias === | ||
- | |||
- | >= 7.0NG | ||
- | |||
- | モジュールの最新の値を返します。このモジュールは、パラメータ id で渡されるエージェントの別名と、パラメータ id2 で渡されるモジュール名でフィルタされます。other パラメータで、アプリケーションが利用するエラーコードおよび、範囲を超えたモジュールの値を追加することができます。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=agent_module_name_last_value_alias (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other=< | ||
- | * エラーコードは次の通りです: | ||
- | * ' | ||
- | * ' | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_value_all_agents === | ||
- | |||
- | Given a module name, returns a list of agents containing that module name. The result returns the agent identifier, agent alias, requested module value and agent name, separated by semicolon ('';'' | ||
- | |||
- | モジュール名を指定すると、そのモジュール名を含むエージェントのリストを返します。 結果は、セミコロン ('';'' | ||
- | |||
- | < | ||
- | 653;agente network; | ||
- | |||
- | </ | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | **Example (see ** [[: | ||
- | |||
- | **例** ([[: | ||
- | |||
- | A list of all the agents that have the module with '' | ||
- | |||
- | '' | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | </ | ||
- | |||
- | === get agent_modules === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=agent_modules (必須) | ||
- | * return_type=< | ||
- | * other=< | ||
- | * < | ||
- | |||
- | 次のように、セパレータを設定するために ' | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_id === | ||
- | |||
- | エージェントのモジュール ID を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_id (必須) | ||
- | * id=id agent (必須) | ||
- | * other=module name (必須) | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_custom_id === | ||
- | |||
- | モジュール ID をパラメータをとして渡し、特定のエージェントモジュールの // | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_custom_id (必須) | ||
- | * id=id_agent_module (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get locate_agent === | ||
- | |||
- | エージェントが存在するサーバ ID を取得し、すべての結果を csv で出力します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=locate_agent (必須) | ||
- | * return_type=< | ||
- | * id=id_agent (必須) | ||
- | * other_mode=other_mode=url_encode_separator_< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get policies === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=policies (必須) | ||
- | * return_type=< | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get tree_agents === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=tree_agents (必須) | ||
- | * return_type=< | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <CR と置き換える文字> | ||
- | |||
- | * < | ||
- | * type_row | ||
- | * group_id | ||
- | * group_name | ||
- | * group_parent | ||
- | * disabled | ||
- | * custom_id | ||
- | * group_description | ||
- | * group_contact | ||
- | * group_other | ||
- | * agent_id | ||
- | * alias | ||
- | * agent_direction | ||
- | * agent_comentary | ||
- | * agent_id_group | ||
- | * agent_last_contant | ||
- | * agent_mode | ||
- | * agent_interval | ||
- | * agent_id_os | ||
- | * agent_os_version | ||
- | * agent_version | ||
- | * agent_last_remote_contact | ||
- | * agent_disabled | ||
- | * agent_id_parent | ||
- | * agent_custom_id | ||
- | * agent_server_name | ||
- | * agent_cascade_protection | ||
- | * agent_name | ||
- | * module_id_agent_modulo | ||
- | * module_id_agent | ||
- | * module_id_module_type | ||
- | * module_description | ||
- | * module_name | ||
- | * module_max | ||
- | * module_min | ||
- | * module_interval | ||
- | * module_tcp_port | ||
- | * module_tcp_send | ||
- | * module_tcp_rcv | ||
- | * module_snmp_community | ||
- | * module_snmp_oid | ||
- | * module_ip_target | ||
- | * module_id_module_group | ||
- | * module_flag | ||
- | * module_id_module | ||
- | * module_disabled | ||
- | * module_id_export | ||
- | * module_plugin_user | ||
- | * module_plugin_pass | ||
- | * module_plugin_parameter | ||
- | * module_id_plugin | ||
- | * module_post_process | ||
- | * module_prediction_module | ||
- | * module_max_timeout | ||
- | * module_custom_id | ||
- | * module_history_data | ||
- | * module_min_warning | ||
- | * module_max_warning | ||
- | * module_min_critical | ||
- | * module_max_critical | ||
- | * module_min_ff_event | ||
- | * module_delete_pending | ||
- | * module_id_agent_state | ||
- | * module_data | ||
- | * module_timestamp | ||
- | * module_state | ||
- | * module_last_try | ||
- | * module_utimestamp | ||
- | * module_current_interval | ||
- | * module_running_by | ||
- | * module_last_execution_try | ||
- | * module_status_changes | ||
- | * module_last_status | ||
- | * module_plugin_macros | ||
- | * module_macros | ||
- | * module_critical_inverse (only in version 6.0SP1 or later) | ||
- | * module_warning_inverse (only in version 6.0SP1 or later) | ||
- | * alert_id_agent_module | ||
- | * alert_id_alert_template | ||
- | * alert_internal_counter | ||
- | * alert_last_fired | ||
- | * alert_last_reference | ||
- | * alert_times_fired | ||
- | * alert_disabled | ||
- | * alert_force_execution | ||
- | * alert_id_alert_action | ||
- | * alert_type | ||
- | * alert_value | ||
- | * alert_matches_value | ||
- | * alert_max_value | ||
- | * alert_min_value | ||
- | * alert_time_threshold | ||
- | * alert_max_alerts | ||
- | * alert_min_alerts | ||
- | * alert_time_from | ||
- | * alert_time_to | ||
- | * alert_monday | ||
- | * alert_tuesday | ||
- | * alert_wednesday | ||
- | * alert_thursday | ||
- | * alert_friday | ||
- | * alert_saturday | ||
- | * alert_sunday | ||
- | * alert_recovery_notify | ||
- | * alert_field2_recovery | ||
- | * alert_field3_recovery | ||
- | * alert_id_alert_template_module | ||
- | * alert_fires_min | ||
- | * alert_fires_max | ||
- | * alert_id_alert_command | ||
- | * alert_command | ||
- | * alert_internal | ||
- | * alert_template_modules_id | ||
- | * alert_templates_id | ||
- | * alert_template_module_actions_id | ||
- | * alert_actions_id | ||
- | * alert_commands_id | ||
- | * alert_templates_name | ||
- | * alert_actions_name | ||
- | * alert_commands_name | ||
- | * alert_templates_description | ||
- | * alert_commands_description | ||
- | * alert_template_modules_priority | ||
- | * alert_templates_priority | ||
- | * alert_templates_field1 | ||
- | * alert_actions_field1 | ||
- | * alert_templates_field2 | ||
- | * alert_actions_field2 | ||
- | * alert_templates_field3 | ||
- | * alert_actions_field3 | ||
- | * alert_templates_id_group | ||
- | * alert_actions_id_group' | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_data === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (required) | ||
- | * op2=module_data (required) | ||
- | * id=< | ||
- | * other_mode=url_encode_separator_< | ||
- | * other=< | ||
- | |||
- | * The CSV divider character (point by default) | ||
- | * The period (in seconds) | ||
- | * Start time (< | ||
- | * End time (< | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_data (必須) | ||
- | * id=< | ||
- | * other_mode=url_encode_separator_< | ||
- | * other=< | ||
- | * CSV の区切り文字 | ||
- | * 間隔 (秒) | ||
- | * 開始日時 (< | ||
- | * 終了日時 (< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get graph_module_data === | ||
- | |||
- | モジュールのグラフを画像ファイルで返します。このグラフは、Pandora の静的グラフと同じ手法で生成されます。グラフの幅、高さ、期間、ラベル、開始日(データの終わりがグラフに表示される最後になります)をパラメータに指定する必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=module_data (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * <幅> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get events === | ||
- | |||
- | other パラメータでフィルタしたイベントの一覧を返します。 | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | - < separator > (**required**). | ||
- | - < criticality > any of the following values from '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - < agent alias > | ||
- | - < module name > | ||
- | - < filter by alert > use '' | ||
- | - < event owner user > | ||
- | - < minimum date and time (**since**) > in Unix® time format, without milliseconds (EPOCH). | ||
- | - < maximum date and time (**until**) > in Unix® time format, without milliseconds (EPOCH). | ||
- | - < state > '' | ||
- | - < text > keyword to search for in the events. | ||
- | - < page size > sets the number of records to return for pagination (offset). If the offset number is omitted, it will only return the first offset (the first offset is the number zero '' | ||
- | - < page number > according to the page size of the previous point, returns earlier or later record blocks (offset). | ||
- | - < style > only accepts two key values: | ||
- | - '' | ||
- | - '' | ||
- | - < group_id > returns **non-validated** | ||
- | - < tag > any of the tags registered in PFMS (see '' | ||
- | - < event type > any of the following values: | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | - < セパレータ > (**必須**). | ||
- | - < 重要度 > '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - '' | ||
- | - < エージェントの別名 > | ||
- | - < モジュール名 > | ||
- | - < アラートによるフィルタ > アラートにより生成されたイベントをフィルタするには '' | ||
- | - < イベントの所有者ユーザ > | ||
- | - < 最小の日時 (**開始日時**) > ミリ秒は含まない Unix® 時刻フォーマット(EPOCH)。 | ||
- | - < 最大の日時 (**終了日時**) > ミリ秒は含まない Unix® 時刻フォーマット(EPOCH)。 | ||
- | - < 状態 > 未承諾イベントをフィルタするには '' | ||
- | - < テキスト > イベント内を検索するキーワード。 | ||
- | - < ページサイズ > ページネーション (オフセット) のために返すレコードの数を設定します。 オフセット番号が省略された場合、最初のオフセットのみが返されます (最初のオフセットは数字のゼロ '' | ||
- | - < ページ番号 > 上記のページ サイズに応じて、前後のレコードブロック (オフセット) を返します。 | ||
- | - < スタイル > 以下の二種類の値のみ指定可能です: | ||
- | - '' | ||
- | - '' | ||
- | - < グループ ID > エージェントのグループに属する **未承諾** イベントを返します。数値のみ指定できます。 | ||
- | - < タグ > Pandora FMS に登録されている任意のタグです。('' | ||
- | - < イベントタイプ > 以下の値を指定できます: | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | Example (see [[: | ||
- | |||
- | **例** ([[: | ||
- | |||
- | To obtain the '' | ||
- | |||
- | メタコンソールで、ノード ID が '' | ||
- | |||
- | <code bash> | ||
- | …include/ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | === get all_alert_templates === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=all_alert_templates (必須) | ||
- | * other=cvs_separator (オプション) | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_groups === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_groups (必須) | ||
- | * other=cvs_separator (オプション) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get plugins === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=plugins (必須) | ||
- | * other=cvs_separator (オプション) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get tags === | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | Example (see [[: | ||
- | |||
- | **例** ([[: | ||
- | |||
- | This example will return all tags in the system in CSV format with semicolon separator. | ||
- | |||
- | この例では、システムの全てのタグをセミコロンで区切った CSV フォーマットで返します。 | ||
- | |||
- | <code bash> | ||
- | …/ | ||
- | |||
- | </ | ||
- | |||
- | === get module_from_conf === | ||
- | |||
- | >= 5.0 (エンタープライズ版のみ) | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=update_module_in_conf (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | モジュールが見つからない場合は、空の文字列を返します。 | ||
- | |||
- | === get total_modules === | ||
- | |||
- | Total modules by group. | ||
- | |||
- | グループの全モジュール。 | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | Examples (see [[: | ||
- | |||
- | 例 ([[: | ||
- | |||
- | //To obtain the total number of modules in the // | ||
- | |||
- | Networking モジュールグループの全モジュール数の取得: | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | </ | ||
- | |||
- | The following **groups of modules** | ||
- | |||
- | Pandora FMS インストール時のデフォルトでは、以下の **モジュールグループ** があります。 | ||
- | |||
- | - General. | ||
- | - Networking. | ||
- | - Application. | ||
- | - System. | ||
- | - Miscellaneous. | ||
- | - Performance. | ||
- | - Database. | ||
- | - Enviromental. | ||
- | - Users. | ||
- | |||
- | If you set '' | ||
- | |||
- | グループ ID が '' | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | </ | ||
- | |||
- | === get total_agents === | ||
- | |||
- | グループの全エージェント | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=total_agents (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get agent_name === | ||
- | |||
- | 指定した ID のエージェント名 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=agent_name (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get agent_alias === | ||
- | |||
- | >= 7.0NG | ||
- | |||
- | 指定した ID のエージェントの別名を取得します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=agent_alias (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | |||
- | **例** | ||
- | |||
- | ノード: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | メタコンソール: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_name === | ||
- | |||
- | 指定した ID のモジュール名 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_name (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get alert_action_by_group === | ||
- | |||
- | 指定したグループにおよびアクションにおいて、実行された全アラート | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=alert_action_by_group (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get alert_actions === | ||
- | |||
- | アラートアクションの一覧を取得します。 | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < action_name > | ||
- | * < separator > | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | //To get the list of all alert actions in //JSON// format // (see [[: | ||
- | |||
- | JSON // | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | //To get the list of all alert actions in //CSV// format // (see [[: | ||
- | |||
- | CSV // | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | === get alert_actions_meta === | ||
- | |||
- | <WRAP center round box> | ||
- | |||
- | This feature is in Metaconsole. | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round box> | ||
- | この機能はメタコンソールのみです。 | ||
- | </ | ||
- | |||
- | List of node alert actions from Metaconsole. | ||
- | |||
- | メタコンソールからノードのアラートアクション一覧を取得します。 | ||
- | |||
- | Call syntax: | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (required) | ||
- | * op2=alert_actions_meta (required) | ||
- | * return_type=< | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | * op=get (必須) | ||
- | * op2=alert_actions_meta (必須) | ||
- | * return_type=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | === get all_alert_commands === | ||
- | |||
- | 全アラートコマンドを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=all_alert_commands (必須) | ||
- | * other=cvs_separator (オプション) | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get event_info === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=event_info (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get tactical_view === | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=tactical_view (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get pandora_servers === | ||
- | |||
- | バージョン 5.0 かそれ以降 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=pandora_servers (必須) | ||
- | * other=cvs_separator (オプション) | ||
- | |||
- | **Example** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 次の順番で値が返ります。 | ||
- | |||
- | * サーバ名 | ||
- | * 状態 (1 - 稼働, 0 - 停止) | ||
- | * サーバタイプ (文字列) | ||
- | * マスターサーバかどうか (1 - マスターサーバ, | ||
- | * 稼働中のモジュール数 | ||
- | * 該当する全モジュール数 | ||
- | * 最大遅延(秒) | ||
- | * 遅延モジュール数 | ||
- | * スレッド数 | ||
- | * 現在キューに溜まっているモジュール数 | ||
- | * 最終更新日時 (文字列) | ||
- | |||
- | === get custom_field_id === | ||
- | |||
- | >= 5.0 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=custom_field_id (必須) | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get gis_agent === | ||
- | |||
- | >= 5.0 | ||
- | |||
- | エージェントの最新の gis データを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=gis_agent (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get special_days === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | 特別日一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=special_days (必須) | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_properties === | ||
- | |||
- | >= 5.1SP2 | ||
- | |||
- | モジュールのプロパティ一覧を返します。出力する項目は other で指定できます。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_properties (必須) | ||
- | * id=モジュールID。 (必須) | ||
- | * return_type=< | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <CR と置き換える文字> | ||
- | * < | ||
- | * module_id_agent_modulo | ||
- | * module_id_agent | ||
- | * module_id_module_type | ||
- | * module_description | ||
- | * module_name | ||
- | * module_max | ||
- | * module_min | ||
- | * module_interval | ||
- | * module_tcp_port | ||
- | * module_tcp_send | ||
- | * module_tcp_rcv | ||
- | * module_snmp_community | ||
- | * module_snmp_oid | ||
- | * module_ip_target | ||
- | * module_id_module_group | ||
- | * module_flag | ||
- | * module_id_module | ||
- | * module_disabled | ||
- | * module_id_export | ||
- | * module_plugin_user | ||
- | * module_plugin_pass | ||
- | * module_plugin_parameter | ||
- | * module_id_plugin | ||
- | * module_post_process | ||
- | * module_prediction_module | ||
- | * module_max_timeout | ||
- | * module_custom_id | ||
- | * module_history_data | ||
- | * module_min_warning | ||
- | * module_max_warning | ||
- | * module_min_critical | ||
- | * module_max_critical | ||
- | * module_min_ff_event | ||
- | * module_delete_pending | ||
- | * module_id_agent_state | ||
- | * module_data | ||
- | * module_timestamp | ||
- | * module_state | ||
- | * module_last_try | ||
- | * module_utimestamp | ||
- | * module_current_interval | ||
- | * module_running_by | ||
- | * module_last_execution_try | ||
- | * module_status_changes | ||
- | * module_last_status | ||
- | * module_plugin_macros | ||
- | * module_macros | ||
- | * module_critical_inverse (only in version 6.0SP1 or later) | ||
- | * module_warning_inverse (only in version 6.0SP1 or later) | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_properties_by_name === | ||
- | |||
- | >= 5.1SP2 | ||
- | |||
- | モジュールのプロパティ一覧を返します。出力する項目は other で指定できます。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_properties_by_name (必須) | ||
- | * id=エージェント名。 (必須) | ||
- | * id2=モジュール名。 (必須) | ||
- | * return_type=< | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | http:// | ||
- | </ | ||
- | |||
- | |||
- | === get module_properties_by_alias === | ||
- | |||
- | >= 7.0NG | ||
- | |||
- | モジュールプロパティの一覧を返します。一覧はパラメータでフィルタできます。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_properties_by_alias (必須) | ||
- | * id=agent_alias (必須) | ||
- | * id2=agentmodule_name (必須) | ||
- | * return_type=< | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get module_graph === | ||
- | |||
- | [[https:// | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_graph (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | |||
- | バージョン NG 752 以降では、追加のパラメータがあります。必須項目っとそのセパレータ '' | ||
- | |||
- | * op=get (必須) | ||
- | * op2=module_graph (必須) | ||
- | * id=< | ||
- | * other ===== | ||
- | * リクエストの日付からさかのぼってデータが収集される秒単位の時間範囲(デフォルトは 3600)(必須)。 | ||
- | * セパレータ | ||
- | * 0 であれば base64 グラフィック、1 であれば画像(必須) | ||
- | * セパレータ | ||
- | * 0 であればしきい値無し。 1 であればしきい値あり。- モジュールに有効なしきい値がある場合 - (必須) | ||
- | * セパレータ | ||
- | * ピクセル単位のグラフの高さ(必須)。マップキーを表示するには 49ピクセルが必要です。 | ||
- | |||
- | **例** | ||
- | |||
- | バージョン NG 752 未満: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | バージョン NG 752 以上: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get all_planned_downtimes === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | フィルタにマッチした計画停止の一覧を返します。 | ||
- | |||
- | op=get (必須) op2=all_planned_downtimes (必須) return_type=csv または json (必須) other=< | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get planned_downtimes_items === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | フィルタにマッチした計画停止のアイテム一覧を返します。 | ||
- | |||
- | * op=get (必須) | ||
- | * op2=planned_downtimes_items (必須) | ||
- | * return_type=csv または json (必須) | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get id_group_agent_by_name === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | エージェントのグループ ID を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=id_group_agent_by_name | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get id_group_agent_by_alias === | ||
- | |||
- | >= 7.0NG | ||
- | |||
- | エージェントのグループ ID を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=id_group_agent_by_alias | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get group_agent_by_name === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | エージェントのグループ名を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=group_agent_by_name | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get group_agent_by_alias === | ||
- | |||
- | >= 7.0NG | ||
- | |||
- | エージェントのグループ名を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=group_agent_by_alias | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get group_id_by_name === | ||
- | |||
- | >= 7.0NG | ||
- | |||
- | 名前からグループ ID を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=group_id_by_name | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get get_timezone === | ||
- | |||
- | >= 7.0NG | ||
- | |||
- | Pandora に設定されているタイムゾーンを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=timezone | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get cluster_status === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | ID ごとのクラスタ状態を返します。 | ||
- | |||
- | * op=get | ||
- | * op2=cluster_status | ||
- | * id=< | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === get cluster_id_by_name === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | 名前からクラスタの ID を返します。 | ||
- | |||
- | * op=get | ||
- | * op2=cluster_id_by_name | ||
- | * id=< | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === get agents_id_name_by_cluster_id === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタ ID から、ID ⇒ クラスタエージェント名を返します。 | ||
- | |||
- | * op=get | ||
- | * op2=agents_id_name_by_cluster_id | ||
- | * id=< | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === get agents_id_name_by_cluster_name === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタ名から、ID ⇒ クラスタエージェント名を返します。 | ||
- | |||
- | * op=get | ||
- | * op2=agents_id_name_by_cluster_name | ||
- | * id=< | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === get modules_id_name_by_cluster_id === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタ ID から、ID ⇒ クラスタエージェントの全モジュール名を返します。 | ||
- | |||
- | * op=get | ||
- | * op2=modules_id_name_by_cluster_id | ||
- | * id=< | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === get modules_id_name_by_cluster_name === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタ名から、ID ⇒ クラスタエージェントの全モジュール名を返します。 | ||
- | |||
- | * op=get | ||
- | * op2=modules_id_name_by_cluster_name | ||
- | * id=< | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === get cluster_items === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタ ID から、アイテムID ⇒ (name, | ||
- | |||
- | pcrit: % for the critic state if its AA or 1 o 0 if its AP | ||
- | |||
- | pcrit: アクティブ・アクティブの場合は障害状態のパーセンテージ、アクティブ・スタンバイの場合は 1 または 0 | ||
- | |||
- | pwarn: % for the warning state if its AA or null if its AP | ||
- | |||
- | pwarn: アクティブ・アクティブの場合は警告状態のパーセンテージ、アクティブ・スタンバイの場合は null | ||
- | |||
- | * op=get | ||
- | * op2=cluster_items | ||
- | * id=< | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === get policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーから全データを返します。ポリシー ID が指定されていない場合は、全ポリシーから全データを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get collections_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーの全コレクションを返します。ポリシー ID が指定されていない場合は、全ポリシーの全コレクションを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=collections_policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get plugins_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーの全プラグインを返します。ポリシー ID が指定されていない場合は、全ポリシーの全プラグインを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=plugins_policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get inventory_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーのインベントリモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全インベントリモジュールを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=inventory_policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get unlinking_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーの全未リンクモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全未リンクモジュールを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=unlinking_policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get alerts_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | 次の点を考慮して、ポリシーのアラートを返します。 | ||
- | |||
- | * ポリシー ID が指定されていれば、ポリシーのアラートを返します。そうでなければ、全ポリシーの全アラートを返します。 | ||
- | * アラートのタイプを指定されている場合: | ||
- | * 0: すべてを表示します(デフォルト) | ||
- | * 1: 通常アラートのみ表示します | ||
- | * 2: 外部アラートのみ表示します | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=alerts_policy | ||
- | * id=< | ||
- | * id2=0: | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get alerts_actions_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | 以下を考慮して、ポリシーのアラートの全アクションを返します。 | ||
- | |||
- | * ポリシー ID が指定されている場合は、そのポリシーのアラートのアクションを返します。指定されていない場合は、全ポリシーの全アラートの全アクションを返します。 | ||
- | * アラート ID が指定されている場合は、そのアラートのアクションを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=alerts_actions_policy | ||
- | * id=< | ||
- | * id2=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get agents_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーの全エージェントを返します。ポリシー ID が指定されていない場合は、全ポリシーの全エージェントを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=agents_policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get groups_policy === | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーの全グループを返します。ポリシー ID が指定されていない場合は、全ポリシーの全グループを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=groups_policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | == get queue_policy == | ||
- | |||
- | >= 7.0NG. 725 | ||
- | |||
- | ポリシーのキューを返します。ポリシー ID が指定されていない場合は、全ポリシーの全キューを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=queue_policy | ||
- | * id=< | ||
- | * return_type=(json, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | == get traps == | ||
- | |||
- | >= 7.0NG. 728 | ||
- | |||
- | 指定されたソーストラップを返します。また、タイムスタンプやその他のデータをフィルタリングすることもできます。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=traps | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | https:// | ||
- | |||
- | </ | ||
- | |||
- | == get event_responses == | ||
- | |||
- | Pandora FMS でユーザがアクセスするイベント応答の一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=event_reponses (必須) | ||
- | * return_type=csv|json (必須) | ||
- | |||
- | **例** | ||
- | |||
- | この例では、csv フォーマットで全システムイベント応答を返します。 | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | == get users == | ||
- | |||
- | Pandora FMS のユーザ一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=users (必須) | ||
- | * return_type=csv|json (必須) | ||
- | |||
- | **例** | ||
- | |||
- | この例では、全ユーザを CSV フォーマットで返します。 | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get list all user === | ||
- | |||
- | <WRAP center round> この機能はメタコンソールのみです。 </ | ||
- | |||
- | 全 Pandora FMS ユーザ一覧を出力します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=list_all_user(必須) | ||
- | * return_type=csv|json (必須) | ||
- | |||
- | **例** | ||
- | |||
- | Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 応答タイプのみの指定で、その他変数は使用しません。 | ||
- | |||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get info user name === | ||
- | |||
- | <WRAP center round> この機能はメタコンソールのみです。 </ | ||
- | |||
- | ユーザデータの一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=list_all_user(必須) | ||
- | * return_type=csv|json (必須) | ||
- | * other=usernarme (必須) | ||
- | |||
- | **例** | ||
- | |||
- | 指定のユーザに関するすべての情報を取得します。 Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 応答タイプのみの指定で、その他変数は使用しません。 | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get user_profiles_info === | ||
- | |||
- | Pandora FMS のユーザプロファイル一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=user_profiles_info (必須) | ||
- | * return_type=csv|json (必須) | ||
- | |||
- | **例** | ||
- | |||
- | この例では、全システムユーザプロファイルを json フォーマットで返します。 | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get migrate_agent === | ||
- | |||
- | >= 7.21 メタコンソールのみ | ||
- | |||
- | エージェントマイグレーションキューに、指定のエージェントが存在するかを確認します。 | ||
- | |||
- | * op=get | ||
- | * op2=migrate_agent | ||
- | * id=id_agente a migrar | ||
- | * return_type=string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get language === | ||
- | |||
- | >= 7.0NG 730 | ||
- | |||
- | Pandora FMS に設定されている言語を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=language | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get session_timeout === | ||
- | |||
- | >= 7.0NG 730 | ||
- | |||
- | Pandora FMS に設定されたセッションタイムアウトを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=session_timeout | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get groups === | ||
- | |||
- | >= 7.0NG 732 | ||
- | |||
- | 存在するグループを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get | ||
- | * op2=groups | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get filter user group === | ||
- | |||
- | <WRAP center round> この機能はメタコンソールのみです。 </ | ||
- | |||
- | フィルタリングを行ったユーザグループを取得します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=filter_user_group (必須) | ||
- | * return_type=csv|json(必須) | ||
- | * other=id group(必須)|Enabled or not(Disabled)(必須) | ||
- | |||
- | **例** | ||
- | |||
- | Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 2つの変数(グループIDまたは有効化)の 1つは空ですが、少なくとも 1つは入力する必要があることに注意してください。 | ||
- | |||
- | <WRAP center round important 60%> 2つの変数(グループIDまたは Enabled)のうちいずれかが空でも構いませんが、少なくとも一つは指定する必要があることに注意してください。 </ | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get inventory_modules === | ||
- | |||
- | Pandora インベントリモジュールの一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=inventory_modules (必須) | ||
- | * return_type=csv|json (必須) | ||
- | |||
- | **例** | ||
- | |||
- | この例では、全インベントリの情報を json フォーマットで返します。 | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get inventory_modules_by_name === | ||
- | |||
- | エージェント名を用いてエージェントからインベントリモジュールを取得します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=inventory_modules_by_name (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get inventory_modules_by_alias === | ||
- | |||
- | エージェントの別名を用いて、エージェントからインベントリモジュールを取得します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=inventory_modules_by_alias (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get inventory_module_data === | ||
- | |||
- | エージェント名とモジュールを用いて、インベントリモジュールからデータを取得します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=inventory_module_data (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get list_collections === | ||
- | |||
- | Pandora の全コレクションの一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=list_collections (必須) | ||
- | |||
- | **例** | ||
- | |||
- | この例では、全コレクションの情報を json フォーマットで返します。 | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get list_collection_files === | ||
- | |||
- | コレクション内の全ファイル一覧を返します。コレクション ID を指定しなかった場合、全コレクションの全ファイルを返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=list_collections_files (必須) | ||
- | * id=id_collection | ||
- | |||
- | **例** | ||
- | |||
- | この例では、コレクション内の全ファイル名を json フォーマットで返します。 | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get all_event_filters === | ||
- | |||
- | 存在するイベントフィルタの一覧を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=all_event_filters (必須) | ||
- | * other=cvs_separator (オプション) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get event_mcid === | ||
- | |||
- | ノードの ID および、ノードのイベント ID を用いて、メタコンソールでのイベント ID を返します。 | ||
- | |||
- | <WRAP center round> この機能はメタコンソールのみです。 </ | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (必須) | ||
- | * op2=event_mcid (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === get is_centralized === | ||
- | |||
- | Returns whether a node is centralized ( '' | ||
- | |||
- | ノードが中央管理されているか('' | ||
- | |||
- | Call syntax: | ||
- | |||
- | 書式: | ||
- | |||
- | * op=get (required). | ||
- | * op2=is_centralized (required). | ||
- | * id=(required for Metaconsole, | ||
- | |||
- | * op=get (必須) | ||
- | * op2=is_centralized (必須) | ||
- | * id=(メタコンソールでは必須。ノードでは不要。) | ||
- | |||
- | Example at node: | ||
- | |||
- | ノードでの例: | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | Example at Metaconsole: | ||
- | |||
- | メタコンソールでの例: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | ==== 設定 ==== | ||
- | |||
- | データを送信します。 | ||
- | |||
- | === set new_agent === | ||
- | |||
- | パラメータで指定した内容で新たなエージェントを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < | ||
- | * <ip> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_agent (必須) | ||
- | * id= (メタコンソール) エージェントが属するノードの数値識別子(必須) | ||
- | * other=< | ||
- | * < | ||
- | * <IP> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | //Call example for **node**// | ||
- | |||
- | // | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | //Call example for **Metaconsole**// | ||
- | |||
- | // | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | * Note: If < | ||
- | |||
- | * 注意: // | ||
- | |||
- | === set update_agent === | ||
- | |||
- | It updates an agent with data as parameters. | ||
- | |||
- | パラメータで渡したデータで、エージェントを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (required) | ||
- | * op2=update_agent (required) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * <ip> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_agent (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * <ip> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_agent_field === | ||
- | |||
- | This call updates the field(s) of one or more Agents (the latter if it uses aliases and there are several matching ones. | ||
- | |||
- | この呼び出しは、1つもしくは、(別名を利用し一致するエージェントが複数ある場合は)複数のエージェントのフィールドを更新します。 | ||
- | |||
- | Call syntax: | ||
- | |||
- | * op=set (required) | ||
- | * op2=update_agent (required) | ||
- | * id=< | ||
- | * id2= <0> if is< | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * <ip> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_agent (必須) | ||
- | * id=< | ||
- | * id2= < | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * <ip> | ||
- | * <親 ID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <OS ID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | In case of using the Agent' | ||
- | |||
- | エージェント名を利用する場合: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | In case of using aliases, it modifies all the agents that contain that alias: | ||
- | |||
- | 別名を利用する場合。別名を含む全エージェントを編集します: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | |||
- | === set delete_agent === | ||
- | |||
- | 指定した名前のエージェントを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_agent (必須) | ||
- | * id=< | ||
- | * other (オプション)=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_module_template === | ||
- | |||
- | id に指定したテンプレート、other に指定したエージェント、モジュール ID から、アラートを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_module_template (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set apply_module_template === | ||
- | |||
- | モジュールテンプレートをエージェントへ適用します。 | ||
- | |||
- | モジュールテンプレートは、ネットワークモジュールを集めたものです。このテンプレートは、直接エージェントに適用することができ、モジュールを一つ一つ追加する必要はありません。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=apply_module_template (必須) | ||
- | * id< | ||
- | * id2< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_network_module === | ||
- | |||
- | 指定のパラメータでネットワークモジュールを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_network_module (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <snmp OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_plugin_module === | ||
- | |||
- | 指定のパラメータでプラグインモジュールを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_plugin_module (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <snmp コミュニティ> | ||
- | * <snmp OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * //'" | ||
- | * //" | ||
- | * //" | ||
- | * //" | ||
- | 例 | ||
- | |||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | </ | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | |||
- | === set create_data_module === | ||
- | |||
- | 指定したパラメータでモジュールを作成します。 | ||
- | |||
- | <WRAP center round important 60%> このコマンドにてデータベースにモジュールデータを追加できますが、モジュールに関連づけられたエージェントの設定ファイルの編集はできません。 </ | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_data_module (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_SNMP_module === | ||
- | |||
- | SNMP モジュールを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_snmp_module (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMPv3 暗号化手法 [AES|DES]> | ||
- | * <SNMPv3 暗号化パスワード> | ||
- | * <SNMPv3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]> | ||
- | * <SNMPv3 認証手法 [MD5|SHA]> | ||
- | * <SNMPv3 認証ユーザ> | ||
- | * <SNMPv3 認証パスワード> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | 例 1 (SNMP v3, 暗号化手法: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 例 2 (SNMP v1) | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_network_module === | ||
- | |||
- | ネットワークモジュールを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_network_module (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_plugin_module === | ||
- | |||
- | プラグインモジュールを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_plugin_module (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * //" | ||
- | * //" | ||
- | * //" | ||
- | * //" | ||
- | |||
- | **例** | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | === set update_data_module === | ||
- | |||
- | <WRAP center round important 60%> | ||
- | |||
- | With this call, a database module data can be added but the configuration file of the agents associated to the module cannot be modified. | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round important 60%> | ||
- | これによりデータベースにモジュールデータを追加することはできますが、該当モジュールに関するエージェントの設定ファイルを変更することはできません。 | ||
- | </ | ||
- | |||
- | ローカルモジュールを更新します。 | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < id_agent > | ||
- | * < disabled > use '' | ||
- | * < description > | ||
- | * < id_module_group > see [[: | ||
- | * < min > | ||
- | * < max > | ||
- | * < post_process > ( {{: | ||
- | * < [[: | ||
- | * < min_warning > | ||
- | * < max_warning > | ||
- | * < str_warning > | ||
- | * < min_critical > | ||
- | * < max_critical > | ||
- | * < str_critical > | ||
- | * < [[: | ||
- | * < disabled_types_event > JSON forma, example: '' | ||
- | * < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be //"< | ||
- | * < min_ff_event > Number of times a change of state condition has to occur before the change of state can take place (// | ||
- | * < each_ff > | ||
- | * < min_ff_event_normal > | ||
- | * < min_ff_event_warning > | ||
- | * < min_ff_event_critical > | ||
- | * < ff_timeout > | ||
- | * < critical_inverse > | ||
- | * < warning_inverse > | ||
- | * < policy_linked > | ||
- | * < ff_type > | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < エージェントID > | ||
- | * < 無効化 > 無効化の場合は '' | ||
- | * < 説明 > | ||
- | * < モジュールグループID > [[: | ||
- | * < 最小 > | ||
- | * < 最大 > | ||
- | * < 保存倍率 > ( {{: | ||
- | * < [[: | ||
- | * < 警告の最小値 > | ||
- | * < 警告の最大値 > | ||
- | * < 警告文字列 > | ||
- | * < 障害の最小値 > | ||
- | * < 障害の最大値 > | ||
- | * < 障害文字列 > | ||
- | * < [[: | ||
- | * < 無効化イベント > JSON フォーマット。例: | ||
- | * < モジュールマクロ > これは、マクロごとに 1 つのプロパティを持つオブジェクトで構成された、base64 でエンコードされた JSON ドキュメントである必要があります。JSON プロパティのフォーマット: | ||
- | * < 連続抑制回数 > モジュールの監視結果が何回連続で変化したらモジュールの状態を変更するかの値。(// | ||
- | * < 個別状態変化の利用 > | ||
- | * < 正常移行時連続抑制回数 > | ||
- | * < 警告移行時連続抑制回数 > | ||
- | * < 障害移行時連続抑制回数 > | ||
- | * < 連続抑制タイムアウト > | ||
- | * < 障害条件の反転 > | ||
- | * < 警告条件の反転 > | ||
- | * < 関連ポリシー > | ||
- | * < 連続抑制カウンタの維持 > | ||
- | |||
- | **Example (see ** **[[: | ||
- | |||
- | **例 ([[: | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | === set update_data_module_policy === | ||
- | |||
- | ポリシーのデータモジュールを更新し、新たなモジュールの ID を返します。 | ||
- | |||
- | 書式: | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <min> | ||
- | * <max> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * ''< | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_data_module_policy (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * ''< | ||
- | |||
- | **例** ([[: | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | |||
- | === set update_SNMP_module === | ||
- | |||
- | SNMP モジュールを更新します。 | ||
- | |||
- | 書式: | ||
- | * op=set (必須) | ||
- | * op2=update_snmp_module (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <snmp3 暗号化方式 [AES|DES]> | ||
- | * <snmp3 暗号化パスワード> | ||
- | * <snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]> | ||
- | * <snmp3 認証方式 [MD5|SHA]> | ||
- | * <snmp3 認証ユーザ> | ||
- | * <snmp3 認証パスワード> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | 例 (SNMPバージョン: | ||
- | |||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | === set apply_policy === | ||
- | |||
- | ひとつもしくは複数のエージェントに、ID を指定してポリシーを適用します。 | ||
- | |||
- | 書式: | ||
- | * op=set (必須) | ||
- | * op2=apply_policy (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | === set apply_all_policies === | ||
- | |||
- | Pandora 内にある全ポリシーを適用します。 | ||
- | |||
- | 書式: | ||
- | * op=set (必須) | ||
- | * op2=apply_all_policies (必須) | ||
- | |||
- | 例 | ||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | === set add_network_module_policy === | ||
- | |||
- | 指定したパラメータで、ポリシーにネットワークモジュールを追加します。 | ||
- | |||
- | 書式: | ||
- | * op=set (必須) | ||
- | * op2=add_network_module_policy (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | === set add_plugin_module_policy === | ||
- | |||
- | 指定したパラメータで、ポリシーにプラグインモジュールを追加します。 | ||
- | |||
- | 書式: | ||
- | * op=set (必須) | ||
- | * op2=add_plugin_module_policy (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * //" | ||
- | * //" | ||
- | * //" | ||
- | * //" | ||
- | | ||
- | **例** | ||
- | < | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | </ | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_data_module_policy === | ||
- | |||
- | 指定したパラメータで、ポリシーにローカルモジュールを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_data_module_policy (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_SNMP_module_policy === | ||
- | |||
- | 指定したパラメータで、ポリシーに SNMP モジュールを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_snmp_module_policy (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <snmp3 暗号化方式 [AES|DES]> | ||
- | * <snmp3 暗号化パスワード> | ||
- | * <snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]> | ||
- | * <snmp3 認証方式 [MD5|SHA]> | ||
- | * <snmp3 認証ユーザ> | ||
- | * <snmp3 認証パスワード> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_agent_policy_by_id === | ||
- | |||
- | エージェント ID を用いてポリシーにエージェントを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_agent_policy_by_id (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | * ノード: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | * メタコンソール: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_agent_policy_by_name === | ||
- | |||
- | エージェント名を用いてポリシーへエージェントを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_agent_policy_by_name (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set remove_agent_from_policy_by_id === | ||
- | |||
- | エージェント ID を用いて、ポリシーからエージェントを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=remove_agent_from_policy_by_id (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **必須** | ||
- | |||
- | * ノード: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | * メタコンソール: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set remove_agent_from_policy_by_name === | ||
- | |||
- | エージェント名を用いて、ポリシーからエージェントを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=remove_agent_from_policy_by_name (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_network_component === | ||
- | |||
- | 新たなネットワークコンポーネントを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_network_component (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_plugin_component === | ||
- | |||
- | 新たなプラグインコンポーネントを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_plugin_component (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_snmp_component === | ||
- | |||
- | 新たな SNMP コンポーネントを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_snmp_component (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <SNMP OID> | ||
- | * < | ||
- | * <snmp3 認証ユーザ> | ||
- | * <snmp3 認証パスワード> | ||
- | * < | ||
- | * <snmp3 暗号化手法> | ||
- | * <snmp3 暗号化パスワード> | ||
- | * <snmp3 認証手法> | ||
- | * <snmp3 セキュリティレベル> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_local_component === | ||
- | |||
- | 新たなローカルコンポーネントを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_local_component (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_alert_template === | ||
- | |||
- | アラートテンプレートを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_alert_template (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <値> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | 例1 (状態: regexp =~ / | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 例2 (状態: 値が5と10の間以外、最大値: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_alert_template === | ||
- | |||
- | アラートテンプレートを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_alert_template (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <値> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_alert_template === | ||
- | |||
- | アラートテンプレートと、テンプレートで使われているアラートを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_alert_template (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_module_template === | ||
- | |||
- | モジュールテンプレートを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_module_template (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_module_template_by_names === | ||
- | |||
- | モジュールテンプレートを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_module_template_by_names (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set stop_dowtime === | ||
- | |||
- | 計画停止を停止します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=stop_downtime (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_user === | ||
- | |||
- | It creates a new user in Pandora FMS. | ||
- | |||
- | Pandora FMS に新たなユーザを作成します。 | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | - < full_name > (replace spaces with '' | ||
- | - < first_name > | ||
- | - < surname > | ||
- | - < middle_name > | ||
- | - < [[: | ||
- | - < e_mail > | ||
- | - < phone_number > | ||
- | - < [[: | ||
- | - < comments > | ||
- | - < time_autorefresh > | ||
- | - < default_event_filter > | ||
- | - < console_section > | ||
- | - < [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | - < | ||
- | |||
- | <WRAP center round tip 60%> | ||
- | |||
- | If you lack any of the above thirteen fields simply type the separator (see [[: | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round tip 60%> | ||
- | |||
- | 上記の 13 個のフィールドのいずれかを指定しない場合は、セパレーターを入力するだけです ([[: | ||
- | |||
- | </ | ||
- | |||
- | **Example (see ** [[: | ||
- | |||
- | **例** ([[: | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | === Set update_user === | ||
- | |||
- | 指定した ID のユーザを指定したパラメータで更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_user (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_user === | ||
- | |||
- | Deletes a user by means of its identifier. | ||
- | |||
- | ID で指定したユーザを削除します。 | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | {{ : | ||
- | |||
- | **Example (** [[: | ||
- | |||
- | **例** ([[: | ||
- | |||
- | <code bash> | ||
- | ../ | ||
- | |||
- | </ | ||
- | |||
- | === Set delete_user_permissions === | ||
- | |||
- | <WRAP center round> この機能はメタコンソールのみです。 </ | ||
- | |||
- | ユーザのパーミッションを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set(必須) | ||
- | * op2=delete_user_permission(必須) | ||
- | * return_type=csv|json(必須) | ||
- | * other=id profile(必須) | ||
- | |||
- | **例** | ||
- | |||
- | ユーザのパーミッションを削除します。 Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === Set add_permission_user_group === | ||
- | |||
- | <WRAP center round> この機能はメタコンソールのみです。 </ | ||
- | |||
- | ユーザグループへパーミッションを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * 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 を介して指定します。 | ||
- | |||
- | <WRAP center round important 60%> no_hierarchy が空の場合、値が 0 になることに注意してください。 </ | ||
- | |||
- | <WRAP center round important 60%> 既存のプロファイルを変更する場合は、profile_user テーブルのプロファイルIDが使用されることに注意してください。 </ | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set enable_disable_user === | ||
- | |||
- | ユーザを無効化・有効化します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=enable_disable_user (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | |||
- | 例1 (ユーザ ' | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 例2 (ユーザ ' | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set meta_synch_user === | ||
- | |||
- | Template: | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=meta_synch_user (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_group === | ||
- | |||
- | グループを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_group (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | 例1 (親グループ: | ||
- | < | ||
- | |||
- | | ||
- | |||
- | </ | ||
- | |||
- | 例2 (親グループなし) | ||
- | < | ||
- | |||
- | | ||
- | |||
- | </ | ||
- | |||
- | 例3 (パスワード " | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_group === | ||
- | |||
- | グループの設定を更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_group (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | | ||
- | |||
- | </ | ||
- | |||
- | === set delete_group === | ||
- | |||
- | グループを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_group (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | | ||
- | |||
- | </ | ||
- | |||
- | === set add_user_profile === | ||
- | |||
- | ユーザにプロファイルを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_user_profile (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_user_profile === | ||
- | |||
- | ユーザのプロファイルを削します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_user_profile (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_incident === | ||
- | |||
- | 新たなインシデントを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_incident (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_note_incident === | ||
- | |||
- | インシデントにコメントを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_note_incident (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set validate_all_alerts === | ||
- | |||
- | 全アラートを承諾します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=validate_all_alerts (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set validate_all_policy_alerts === | ||
- | |||
- | ポリシーから作成されたアラートを承諾します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=validate_all_policy_alerts (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set event_validate_filter === | ||
- | |||
- | 指定したフィルタにマッチするすべてのイベントを承諾します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=event_validate_filter (必須) | ||
- | * other_mode=url_encode_separator_|(オプション) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < 最小レベルの数値間隔> | ||
- | * < 最大レベルの数値間隔> | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set event_validate_filter_pro === | ||
- | |||
- | 前述の API と似たものです。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=event_validate_filter_pro (必須) | ||
- | * other_mode=url_encode_separator_| (オプション) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set validate_event_by_id === | ||
- | |||
- | 指定した ID のイベントを承諾します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=validate_event_by_id (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_alert_template === | ||
- | |||
- | テンプレートおよび、エージェントIDおよびモジュール名からモジュールを指定して、新たなアラートを適用します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_alert_template (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other_mode=url_encode_separator_| (オプション) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set alert_actions === | ||
- | |||
- | アラートにアクションを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=alert_actions (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other_mode=url_encode_separator_| (オプション) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set alert_commands === | ||
- | |||
- | アラートにコマンドを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=alert_commands (必須) | ||
- | * id=< | ||
- | * other_mode=url_encode_separator_| (オプション) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_module === | ||
- | |||
- | 新たなモジュールを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_module (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other_mode=url_encode_separator_| (オプション) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * <IP または URL> (必須) | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_module === | ||
- | |||
- | モジュールを削除します。 | ||
- | |||
- | <WRAP center round info 75%> | ||
- | |||
- | From version 768 onwards, if the module to be deleted (e.g. // | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round info 75%> | ||
- | |||
- | バージョン 768 以降、削除するモジュール (例: // | ||
- | |||
- | </ | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | **Example (see ** [[: | ||
- | |||
- | **例 (**[[: | ||
- | |||
- | <code bash> | ||
- | .../ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | === set enable_alert === | ||
- | |||
- | エージェントのアラートを有効化します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=enable_alert | ||
- | * id=< | ||
- | * id2=< | ||
- | * other: アラートテンプレート名 (例: Warning イベント) (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set enable_alert_alias === | ||
- | |||
- | エイリアスでエージェントのアラートを有効化します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=enable_alert_alias | ||
- | * id=< | ||
- | * id2=< | ||
- | * other: アラートテンプレート名 (p.e: 警告イベント) (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set disable_alert === | ||
- | |||
- | エージェントのアラートを無効化します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=disable_alert | ||
- | * id=< | ||
- | * id2=< | ||
- | * other: アラートテンプレート名 (例: Warning イベント) (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set disable_alert_alias === | ||
- | |||
- | エージェントのアラートを無効化します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=disable_alert_alias | ||
- | * id=< | ||
- | * id2=< | ||
- | * other: アラートテンプレート名 (例: 警告イベント) (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set enable_module_alerts === | ||
- | |||
- | enable_alert と同じです。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=enable_module_alerts | ||
- | * id=< | ||
- | * id2=< | ||
- | * other (オプション)=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set disable_module_alerts === | ||
- | |||
- | disable_alert と同じです。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=disable_module_alerts | ||
- | * id=< | ||
- | * id2=< | ||
- | * other (オプション)=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set enable_module === | ||
- | |||
- | モジュールを有効化します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=enable_module | ||
- | * id=< | ||
- | * id2=< | ||
- | * other (オプション)=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set disable_module === | ||
- | |||
- | モジュールを無効化します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=disable_module | ||
- | * id=< | ||
- | * id2=< | ||
- | * other (オプション)=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_network_module_from_component === | ||
- | |||
- | コンポーネントから新たなネットワークモジュールを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_network_module_from_component (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other (オプション)=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set module_data === | ||
- | |||
- | モジュールに値を追加します。この機能は、サーバに送信するデータを含む XML を生成します。このデータはデータベースを更新するためのものです。 | ||
- | |||
- | この API 呼び出しは、XML ファイルの生成を制御し、そのプロセスの状態をメッセージで表示します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=module_data (必須) | ||
- | * id=< | ||
- | * other: モジュールのデータとタイムスタンプ | ||
- | * dato: Pandora のデータタイプ | ||
- | * tiempo: タイムスタンプ、" | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round important 60%> XML ファイルの生成が成功しても、データがデータベースに保存されることは保証されません。 </ | ||
- | |||
- | === set new_module_group === | ||
- | |||
- | 新たなモジュールグループを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=new_module_group (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set module_group_synch === | ||
- | |||
- | Template: | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=module_group_synch (必須) | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_module_in_conf === | ||
- | |||
- | >= 5.0 (エンタープライズ版のみ) | ||
- | |||
- | ローカルモジュールに設定を追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_module_in_conf (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other: conf ファイルに書くモジュール設定を base64 でエンコードしたもの (必須) | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 成功すると ' | ||
- | |||
- | === set delete_module_in_conf === | ||
- | |||
- | >= 5.0 (エンタープライズ版のみ) | ||
- | |||
- | ローカルモジュールの設定を削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_module_in_conf (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 成功すると ' | ||
- | |||
- | === set update_module_in_conf === | ||
- | |||
- | >= 5.0 (エンタープライズ版のみ) | ||
- | |||
- | ローカルモジュールの設定を更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_module_in_conf (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other: conf ファイル内のモジュール設定を置き換える内容を、base64 でエンコードしたもの。(必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 変更が無い場合は ' | ||
- | |||
- | === set module_custom_id === | ||
- | |||
- | モジュール ID とカスタム ID の値をパラメータとして渡すことにより、// | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=module_custom_id (必須) | ||
- | * id=id_agent_module (必須) | ||
- | * id2=カスタムIDの値、もしくは、削除する場合は何も指定しない (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_event === | ||
- | |||
- | Pandora 内に新たなイベントを作成します。 | ||
- | |||
- | <WRAP center round tip 50%> | ||
- | |||
- | This feature also works in Metaconsole. | ||
- | |||
- | </ | ||
- | |||
- | <WRAP center round tip 50%> | ||
- | |||
- | この機能は、Metaconsole でも使えます。 | ||
- | |||
- | </ | ||
- | |||
- | [[: | ||
- | |||
- | [[: | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < event_text > (required, string type). | ||
- | * < id_group > (required, string type). | ||
- | * < id_agent> | ||
- | * < status > '' | ||
- | * < id_user > | ||
- | * < event_type > Any of the following values: | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < severity > Any of the following values: | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < id_agent_module > (numeric type). | ||
- | * < id_alert_am> | ||
- | * < critical_instructions > (string type). | ||
- | * < warning_instructions > (string type). | ||
- | * < unknown_instructions > (string type). | ||
- | * < comment > (string type). | ||
- | * < owner_user_name > (string type). | ||
- | * < event_source > (string type). | ||
- | * < tags > (string type). | ||
- | * < custom_data> | ||
- | * < server_id > (//only for Metaconsole// | ||
- | * < | ||
- | |||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < イベントテキスト > (必須、文字列) | ||
- | * < グループ ID > (必須、文字列) | ||
- | * < エージェント ID> (必須、数値) | ||
- | * < 状態 > '' | ||
- | * < ユーザ ID > | ||
- | * < イベントタイプ > 以下の値のいずれか: | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < 重要度 > 以下の値のいずれか: | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * < エージェントモジュール ID > (数値) | ||
- | * < alert_am ID> ( イベントにリンクしたアラートモジュール ID、数値) | ||
- | * < 障害手順 > (文字列) | ||
- | * < 警告手順 > (文字列) | ||
- | * < 不明手順 > (文字列) | ||
- | * < コメント > (文字列) | ||
- | * < 所有者ユーザ名 > (文字列) | ||
- | * < イベントソース > (文字列) | ||
- | * < タグ > (文字列) | ||
- | * < カスタムデータ > **base64 でエンコードした JSON 形式でなければいけません** | ||
- | * < サーバ ID > (// | ||
- | * <extra ID> (英数字) | ||
- | |||
- | **Example (** **[[: | ||
- | |||
- | **例** ([[: | ||
- | |||
- | The event to be created has the following custom JSON data: | ||
- | |||
- | 作成するイベントの JSON は次の通りとします。 | ||
- | |||
- | < | ||
- | |||
- | {" | ||
- | |||
- | </ | ||
- | |||
- | The above is encoded in base64 and inserted in the call: | ||
- | |||
- | 上記を base64 でエンコードし、次のように呼び出しに含めます。 | ||
- | |||
- | <code bash> | ||
- | ../ | ||
- | |||
- | </ | ||
- | |||
- | === set add_event_comment === | ||
- | |||
- | イベントにコメントを追加します。 | ||
- | |||
- | <WRAP center round tip 60%> これはメタコンソールでも利用できます。 </ | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_event (必須) | ||
- | * other=< | ||
- | * < | ||
- | |||
- | <WRAP center round tip 60%> メタコンソールで利用するには、" | ||
- | |||
- | **例** | ||
- | |||
- | * ノード | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | * メタコンソール | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_event === | ||
- | |||
- | API を通してイベントを更新します。 | ||
- | |||
- | <WRAP center round tip 60%> この機能は、メタコンソールでも利用できます。 </ | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=event (必須) | ||
- | * id=event_id (必須) | ||
- | * other=< | ||
- | * < | ||
- | |||
- | **設定可能フィールド** | ||
- | |||
- | * **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**: | ||
- | * **critical_instructions**: | ||
- | * **warning_instructions**: | ||
- | * **unknown_instructions**: | ||
- | * **owner_user**: | ||
- | * **custom_data**: | ||
- | * **module_status**: | ||
- | * 0 (正常) | ||
- | * 1 (障害) | ||
- | * 2 (警告) | ||
- | * 3 (不明) | ||
- | * 4 (未初期化) | ||
- | |||
- | **例** | ||
- | |||
- | * ノード: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | * メタコンソール: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_netflow_filter === | ||
- | |||
- | (>= 5.0) | ||
- | |||
- | 新たな netflow フィルタを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_netflow_filter (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_custom_field === | ||
- | |||
- | >= 5.0 | ||
- | |||
- | 新たなカスタムフィールドを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_custom_field (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_tag === | ||
- | |||
- | >= 5.0 | ||
- | |||
- | 新たなタグを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_tag (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * <url> タグの URL | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set enable_disable_agent === | ||
- | |||
- | エージェントを有効化/ | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=enable_disable_agent (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | |||
- | 例1 (エージェント ' | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 例2 (エージェント ' | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set gis_agent_only_position === | ||
- | |||
- | >= 5.0 | ||
- | |||
- | エージェントに、新たな GIS 位置情報を追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=gis_agent_only_position (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set gis_agent === | ||
- | |||
- | >= 5.0 | ||
- | |||
- | エージェントに gis データを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=gis_agent_only_position (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set reset_agent_counts === | ||
- | |||
- | エージェントのモジュールおよびアラートカウントを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=reset_agent_counts (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_special_day === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | 新たな特別日を追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_special_day (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_special_day === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | 定義済の特別日の設定を更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_special_day (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_special_day === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | 特別日を削除。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_special_day (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set pagerduty_webhook === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | Pandora FMS アラートと PagerDuty 通知を接続します。PagerDuty サービスの webhooks オプションを、PagerDuty からアラートを承諾した場合の動作に対して、あらかじめ PagerDuty にリンクさせた Pandora FMS のアラートの承諾に設定します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=pagerduty_webhook (必須) | ||
- | * id=alert (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set tag_user_profile === | ||
- | |||
- | >= 6 | ||
- | |||
- | ユーザのプロファイルにタグを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=tag_user_profile (必須) | ||
- | * id=id_user (必須) | ||
- | * id2=id_tag (必須) | ||
- | * other_mode=url_encode_separator_| (必須) | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set tag === | ||
- | |||
- | >= 6 | ||
- | |||
- | pandora にタグを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=tag (必須) | ||
- | * id=name (必須) | ||
- | * other_mode=url_encode_separator_| (必須) | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_tag_module === | ||
- | |||
- | >= 6 | ||
- | |||
- | モジュールにタグを追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_tag_module (必須) | ||
- | * id=id_module (必須) | ||
- | * id2=id_tag (必須) | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set remove_tag_module === | ||
- | |||
- | >= 6 | ||
- | |||
- | モジュールのタグを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=add_tag_module (必須) | ||
- | * id=id_module (必須) | ||
- | * id2=id_tag (必須) | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set planned_downtimes_created === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | 計画停止を作成します | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=planned_downtimes_created (必須) | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * <月> | ||
- | * <火> | ||
- | * <水> | ||
- | * <木> | ||
- | * <金> | ||
- | * <土> | ||
- | * <日> | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | <WRAP center round important 60%> この呼び出しが正しく動作するためには、日付のフォーマットは MM/DD/YYYY である必要があります。 </ | ||
- | |||
- | **例** | ||
- | |||
- | 一回: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | 繰り返し: | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set planned_downtimes_additem === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | 計画停止に対象エージェント(および対象モジュール)を追加します | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=planned_downtimes_additem | ||
- | * id=< | ||
- | * other=< | ||
- | |||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set planned_downtimes_deleted === | ||
- | |||
- | >= 5.1 | ||
- | |||
- | 計画停止を削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=planned_downtimes_deleted | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_synthetic_module === | ||
- | |||
- | >= 5.1SP4 | ||
- | |||
- | 新たな統合モジュールを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=create_synthetic_module | ||
- | * id=モジュールを追加するエージェント名 | ||
- | * id2=< | ||
- | * other=< | ||
- | |||
- | * モジュールのデータ: | ||
- | |||
- | < | ||
- | 演算設定の場合で、エージェントとモジュール名を指定して演算タイプを指定しない場合: | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | * *演算タイプ: | ||
- | |||
- | < | ||
- | 演算: ADD, SUB, MUL, DIV | ||
- | 平均: AVG のみ | ||
- | |||
- | </ | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_service === | ||
- | |||
- | >= 7 | ||
- | |||
- | 新たなサービスを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=create_service | ||
- | * id=サービスID | ||
- | * other=< | ||
- | |||
- | < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_service === | ||
- | |||
- | >= 7 | ||
- | |||
- | サービスを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=update_service | ||
- | * id=サービスID | ||
- | * other=< | ||
- | |||
- | < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_element_service === | ||
- | |||
- | >= 7 | ||
- | |||
- | サービスに要素を追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=add_element_service | ||
- | * id=サービスID | ||
- | * other=base64エンコードした要素のJson | ||
- | |||
- | json の構造は次の通りです。 | ||
- | |||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | |||
- | </ | ||
- | |||
- | それぞれのタイプで、ID フィールドは異なるものを参照します。 | ||
- | |||
- | - タイプが agent の場合は、エージェント ID です。 | ||
- | |||
- | - タイプが module の場合は、エージェントモジュール ID です。 | ||
- | |||
- | - タイプが service の場合は、追加したいサービス ID です。 | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set metaconsole_synch === | ||
- | |||
- | >= 7 | ||
- | |||
- | ライセンスキーをメタコンソールへ追加し、ノードへ同期します。 | ||
- | |||
- | * op=set | ||
- | * op2=metaconsole_synch | ||
- | * id=License key | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set migrate_agent === | ||
- | |||
- | >= 7.21 メタコンソールのみ | ||
- | |||
- | 選択したエージェントをエージェントマイグレーションキューへ追加します。 | ||
- | |||
- | * op=set | ||
- | * op2=migrate_agent | ||
- | * id=id_agent to migrate | ||
- | * other=origin node name| destination node name | (true|false) not to migrate historical database | ||
- | * other_mode=url_encode_separator_| | ||
- | * return_type=string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set new_cluster === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | エージェントのクラスタを作成します。 | ||
- | |||
- | 異なるノードを監視するためのエージェントとアイテムを持つ監視クラスタを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=new_cluster | ||
- | * other=クラスタ名| クラスタタイプ| 説明| グループID | ||
- | * other_mode=url_encode_separator_ | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | | ||
- | |||
- | </ | ||
- | |||
- | === set add_cluster_agent === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | エージェントをクラスタに追加します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=add_cluster_agent | ||
- | * other=要素を含む json を base64 エンコードしたもの | ||
- | * other_mode=url_encode_separator_ | ||
- | |||
- | json の構造は次の通りです。 | ||
- | |||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | |||
- | </ | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | === set add_cluster_item (アクティブ/ | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタに、アクティブ/ | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=add_cluster_item | ||
- | * other=要素を含む json を base64 エンコードしたもの | ||
- | * other_mode=url_encode_separator_ | ||
- | |||
- | json の構造は次の通りです。 | ||
- | |||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | |||
- | </ | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === set add_cluster_item (アクティブ/ | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタに、アクティブ/ | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=add_cluster_item | ||
- | * other=要素を含む json を base64 エンコードしたもの | ||
- | * other_mode=url_encode_separator_ | ||
- | |||
- | json の構造は次の通りです。 | ||
- | |||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | |||
- | </ | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === set delete_cluster === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=delete_cluster | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === set delete_cluster_agents === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタからエージェントを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=delete_cluster_agents | ||
- | * Other=JSON format with elements (see structure below) | ||
- | * other_mode=url_encode_separator_ | ||
- | |||
- | * op=set | ||
- | * op2=delete_cluster_agents | ||
- | * Other=要素を含んだ JSON フォーマット (以下の構造を参照ください) | ||
- | * other_mode=url_encode_separator_ | ||
- | |||
- | json の構造は次のようになっている必要があります。 | ||
- | |||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | |||
- | </ | ||
- | |||
- | **例** | ||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_cluster_item === | ||
- | |||
- | >= 7.0 | ||
- | |||
- | クラスタからアイテムを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=delete_cluster_item | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | === set create_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーを作成します。 ポリシー名を指定する必要があります。複数設定はできません。また、グループ ID がデータベースに存在する必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=create_policy | ||
- | * other=ポリシー名(必須) | グループID(必須) | 説明; | ||
- | * other_mode=url_encode_separator_| | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーを更新します。 ポリシー名は複数指定できません。また、グループ ID がデータベースに存在する必要があります。0(失敗した場合)または、更新したポリシーID(成功した場合)を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=update_policy | ||
- | * id=ポリシーID | ||
- | * other=ポリシー名 | グループID | 説明; | ||
- | * other_mode=url_encode_separator_| | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーを削除します。存在するポリシー ID を指定する必要があります。0(失敗した場合) または、1(成功した場合) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=delete_policy | ||
- | * id=ポリシーID | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_collections_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーにコレクションを追加します。存在するポリシー ID と、コレクションの名前または短い名前を指定する必要があります。いずれも必須です。 0(失敗した場合) または、ポリシーへ追加したコレクション ID (成功した場合) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=add_collections_policy | ||
- | * id=ポリシー ID | ||
- | * id2=名前または短い名前 | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set remove_collections_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーのコレクションに削除予約を設定します。 | ||
- | |||
- | * 存在するポリシー ID を指定する必要があります。 | ||
- | * 存在するコレクションの名前もしくは短い名前を指定する必要があります。 | ||
- | * other に 0 か 1 を指定します。1 を指定すると削除予約を設定します。0 を指定すると削除予約を解除します。このフィールドを指定しない場合、デフォルトでは削除予約を設定します。 | ||
- | |||
- | 0(失敗) または 1(成功) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=remove_collections_policy | ||
- | * id= ポリシーID | ||
- | * id2=名前もしくは短い名前 | ||
- | * other=(bool) 0 または 1 | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_plugins_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーにプラグインを追加します。 | ||
- | |||
- | * 存在するポリシーIDを指定する必要があります。 | ||
- | * 実行するプラグイン文字列を指定する必要があります。 | ||
- | |||
- | 0(失敗) または、ポリシーへ追加したプラグイン ID (成功)を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=create_plugins_policy | ||
- | * id=ポリシーID | ||
- | * id2=テキスト文字列 | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_plugins_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーからプラグインを削除します。 | ||
- | |||
- | * 存在するポリシー ID を指定する必要があります。 | ||
- | * 削除したいプラグイン ID を指定する必要があります。 | ||
- | * other に 0 か 1 を指定します。1を指定するとプラグインの削除予約を設定します。0を指定すると削除予約を解除します。このフィールドを指定しない場合、デフォルトでは予約が設定されます。 | ||
- | |||
- | 0(失敗) または 1(成功) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=delete_plugins_policy | ||
- | * id=ポリシーID | ||
- | * id2=プラグインID | ||
- | * other=0 または 1 | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set linking_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーに未リンクのモジュールをリンクします。 | ||
- | |||
- | * 未リンクのエージェントモジュール ID を指定する必要があります。 | ||
- | |||
- | 0(失敗) または 1(成功) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=linking_policy | ||
- | * id=エージェントモジュールID | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_alerts_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーアラートを作成します。 | ||
- | |||
- | * 存在するポリシー ID を指定する必要があります。 | ||
- | * 通常のタイプの場合、ポリシーモジュールIDを指定する必要があります。 | ||
- | * 存在するテンプレートIDを指定する必要があります。 | ||
- | * 外部かどうかを 0(通常)、1(外部) で設定します。デフォルトは、通常の 0 です。 | ||
- | * 外部タイプ(1) の場合は、名前を指定する必要があります。 | ||
- | |||
- | 0(失敗) または、ポリシーに追加したアラートID(成功) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=create_alerts_policy | ||
- | * id=ポリシーID | ||
- | * id2=ポリシーモジュールID | ||
- | * other=ポリシーモジュールID|テンプレートID|0 または 1|モジュール名 | ||
- | * other_mode=url_encode_separator_| | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_alerts_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーアラートを更新します。 | ||
- | |||
- | * 存在するポリシーIDを指定する必要があります。 | ||
- | * アクティブ 0 または、待ち 1 を指定します。 | ||
- | * 有効化 0 または、無効化 1 を指定します。 | ||
- | |||
- | 0(失敗) もしくは、ポリシーで更新したアラートID(成功)を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=update_alerts_policy | ||
- | * id=ポリシーID | ||
- | * other=0 または 1 (activate/ | ||
- | * other_mode=url_encode_separator_| | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_alerts_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーからアラートを削除します。 | ||
- | |||
- | * 存在するポリシーアラートIDを指定する必要があります。 | ||
- | * 0 | 1 で削除予約の設定・解除設定をします。このフィールドを指定しない場合、デフォルトは 1 です。 | ||
- | * アクティブ 0 | スタンバイ 1 を設定します。 | ||
- | |||
- | 0(失敗) または 1(成功) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=delete_alerts_policy | ||
- | * id=ポリシーID | ||
- | * id2=0 または 1 | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_alerts_actions_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーアラートにアクションを追加します。 | ||
- | |||
- | * 存在するポリシーアラートIDを指定する必要があります。 | ||
- | * 存在するポリシーアクションIDを指定する必要があります。 | ||
- | * 最低および最大アラート数を設定することができます。デフォルトは 0 です。 | ||
- | |||
- | 0(失敗) または、ポリシーアラートに追加したアクションID(成功) を返します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=create_alerts_action_policy | ||
- | * id=ポリシーID | ||
- | * id2=アクションID | ||
- | * other=最小アラート数 | 最大アラート数 | ||
- | * other_mode=url_encode_separator_| | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_alerts_actions_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーアラートからアクションを削除します。 | ||
- | |||
- | * 存在するポリシーアラートIDを指定する必要があります。 | ||
- | * 存在するポリシーアクションIDを指定する必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=delete_alerts_action_policy | ||
- | * id=ポリシーID | ||
- | * id2=アクションID | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set remove_agents_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーからエージェントを削除します。 | ||
- | |||
- | * 存在するポリシーIDを指定する必要があります。 | ||
- | * 存在するエージェントIDを指定する必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=remove_agents_policy | ||
- | * id=ポリシーID | ||
- | * id2=エージェントID | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set add_groups_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーのグループを追加します。 | ||
- | |||
- | * 存在するポリシーIDを指定する必要があります。 | ||
- | * 存在するグループIDを指定する必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=add_groups_policy | ||
- | * id=ポリシーID | ||
- | * id2=グループID | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set remove_groups_policy === | ||
- | |||
- | >= 7.0. 725 | ||
- | |||
- | ポリシーからグループを削除します。 | ||
- | |||
- | * 存在するポリシーIDを指定する必要があります。 | ||
- | * 存在するグループIDを指定する必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=add_groups_policy | ||
- | * id=ポリシーID | ||
- | * id2=グループID | ||
- | * return_type=(string, | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_os === | ||
- | |||
- | >= 7.0. 727 | ||
- | |||
- | パラメータで渡したデータで OS を作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_os (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_os === | ||
- | |||
- | >= 7.0. 727 | ||
- | |||
- | パラメータで渡したデータで OS を更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_os (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set disabled_and_standby === | ||
- | |||
- | >= 7.0. 728 | ||
- | |||
- | エージェントを無効化し、またリモート設定がある場合はスタンバイモードにします。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=disabled_and_standby (必須) | ||
- | * id=< | ||
- | * id2=< | ||
- | * other=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set validate_traps === | ||
- | |||
- | >= 7.0. 728 | ||
- | |||
- | トラップの承諾をします。 | ||
- | |||
- | * op=set | ||
- | * op2=validate_traps | ||
- | * id=トラップID | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | https:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_traps === | ||
- | |||
- | >= 7.0. 728 | ||
- | |||
- | トラップを削除します。 | ||
- | |||
- | * op=set | ||
- | * op2=delete_traps | ||
- | * id=トラップID | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set access_process === | ||
- | |||
- | >= 7.0NG. 728 | ||
- | |||
- | この機能により、Pandora FMS のシステム監査ログにおける、3つ目のレコードのアプリケーションへのアクセスを管理できます。 アプリケーションに登録されたアクションの一つの処理を実行するために異なるパラメータを用い、管理者ユーザによる同時アクセスを回避します。オプションで、管理者以外のユーザーへのアクセスを禁止することもできます。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set | ||
- | * op2=access_process | ||
- | * other=< | ||
- | * < | ||
- | |||
- | アプリケーションにアクセスしようとしているユーザーの ID です。このデータは監査で記録およびチェックされ、アプリケーションを介したユーザのアクセス、終了、閲覧、またはナビゲーションをフィルタリングします。 | ||
- | |||
- | * < | ||
- | |||
- | login: アプリケーションへのアクセスを要求するために使用されます。 テキスト文字列 " | ||
- | |||
- | logout: 他のユーザが再びアクセスを許可されるように、アプリケーションからのユーザのログアウトしたことをログに記録します。 | ||
- | |||
- | browse: このユーザがまだアクセスしているのか、アプリケーションからログアウトさせられたのかをチェックするため、外部アプリケーションのすべてのページで使用する必要があります。 | ||
- | |||
- | exclude: 現在登録されているユーザをログアウトさせ、別のユーザーのアクセスを user_id パラメータに登録します。 | ||
- | |||
- | * < | ||
- | |||
- | アクセス元のアプリケーションの IP アドレス。 これは Pandora FMS 監査で登録およびチェックされ、アプリケーション内のユーザのアクセス状況をチェックします。 | ||
- | |||
- | * < | ||
- | |||
- | アクセスするアプリケーションの名前。これは Pandora FMS 監査で登録およびチェックされ、アプリケーション内のユーザのアクセス状況をチェックします。 | ||
- | |||
- | * < | ||
- | |||
- | 非管理者ユーザのアクセスを禁止します。 | ||
- | |||
- | **例 (適応環境が必要)** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_event_response === | ||
- | |||
- | 新たなイベント応答を作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_event_response (必須) | ||
- | * return_type=csv|json (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_event_response === | ||
- | |||
- | 既存のイベント応答を編集します。イベント応答の編集にはそれが所属するグループにユーザがアクセスできる権限を持っている必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_event_response (必須) | ||
- | * return_type=csv|json (必須) | ||
- | * id=<id of event response> | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_event_response === | ||
- | |||
- | イベント応答を削除します。イベント応答の削除にはそれが所属するグループにユーザがアクセスできる権限を持っている必要があります。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_event_reponse (必須) | ||
- | * return_type=csv|json | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_user_profile_info === | ||
- | |||
- | 新たなユーザプロファイルを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_user_profile_info (必須) | ||
- | * return_type=csv|json (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM**. | ||
- | |||
- | <WRAP center round tip 60%> どの権限を有効化すべきかは、[[: | ||
- | |||
- | **例** | ||
- | |||
- | この例では、Pandora にリードオンリーのプロファイルを作成します。初期設定済の //Operator (read)// | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_user_profile_info === | ||
- | |||
- | 既存のユーザプロファイルを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_user_profile_info (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | |||
- | **IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM**. | ||
- | |||
- | <WRAP center round tip 60%> どの権限を有効化すべきかは、[[: | ||
- | |||
- | **例** | ||
- | |||
- | 以下の例では、// | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_user_profile_info === | ||
- | |||
- | ユーザプロファイルを削除します。また該当のプロファイルのユーザへの割り当ても削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_user_profile_info (必須) | ||
- | * return_type=csv|json | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_event_filter === | ||
- | |||
- | イベントフィルタを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_event_filter (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_event_filter === | ||
- | |||
- | イベントフィルタを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_event_filter (必須) | ||
- | * id=< | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_event_filter === | ||
- | |||
- | イベントフィルタを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_event_filter (必須) | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_inventory_module === | ||
- | |||
- | 新たなインベントリモジュールを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_inventory_module (必須) | ||
- | * return_type=csv|json | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < code >> (必須ですが空でも可) インベントリデータを取得するために実行される // | ||
- | * < data format >> (必須) 展開されるデータのヘッダーです。(//;// | ||
- | * <block mode>> | ||
- | |||
- | **例** | ||
- | |||
- | この例では、Linux システムから // | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_inventory_module === | ||
- | |||
- | インベントリモジュールを更新します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_inventory_module (必須) | ||
- | * id=inventory module ID (必須) | ||
- | * return_type=csv|json | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < code >> (必須ですが空でも可) インベントリデータを取得するために実行される // | ||
- | * < data format >> (必須) 展開されるデータのヘッダーです。(//;// | ||
- | * <block mode>> | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_inventory_module === | ||
- | |||
- | インベントリモジュールを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_inventory_module (必須) | ||
- | * return_type=csv|json | ||
- | * id=< | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_collection === | ||
- | |||
- | コレクションを作成します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_collection (必須) | ||
- | * other=< | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | |||
- | 連続パラメータのセパレータを渡すために、次のように ' | ||
- | |||
- | **例** | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set delete_collection === | ||
- | |||
- | コレクションを削除します。 | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=delete_collection (必須) | ||
- | * id=id_collection (必須) | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set enable_disable_discovery_task === | ||
- | |||
- | [[: | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (必須) | ||
- | * op2=enable_disable_discovery_task (必須) | ||
- | * id=task identifier (必須) | ||
- | * other=1 で無効化、0 で有効化 | ||
- | |||
- | **例** | ||
- | < | ||
- | |||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set create_module_policy_json === | ||
- | |||
- | Adds a Module to the target policy by means of a definition made in JSON format. | ||
- | |||
- | JSON 形式で作成された定義を使用して、モジュールをターゲットポリシーに追加します。 | ||
- | |||
- | Call syntax: | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (required) | ||
- | * op2=create_module_policy_json (required) | ||
- | * id=policy id (required) | ||
- | * other =[[https:// | ||
- | |||
- | * op=set (必須) | ||
- | * op2=create_module_policy_json (必須) | ||
- | * id=ポリシーID (必須) | ||
- | * other =モジュール定義の [[https:// | ||
- | |||
- | < | ||
- | |||
- | { | ||
- | name: < | ||
- | id_module: < | ||
- | id_tipo_modulo: | ||
- | configuration_data: | ||
- | description: | ||
- | unit: < | ||
- | max: < | ||
- | min: < | ||
- | module_interval: | ||
- | ip_target: < | ||
- | tcp_port: < | ||
- | tcp_send: < | ||
- | tcp_rcv: < | ||
- | snmp_community: | ||
- | snmp_oid: < | ||
- | id_module_group: | ||
- | flag: < | ||
- | disabled: < | ||
- | id_export: < | ||
- | plugin_user: | ||
- | plugin_pass: | ||
- | plugin_parameter: | ||
- | id_plugin: < | ||
- | post_process: | ||
- | prediction_module: | ||
- | max_timeout: | ||
- | max_retries: | ||
- | custom_id: < | ||
- | history_data: | ||
- | min_warning: | ||
- | max_warning: | ||
- | str_warning: | ||
- | min_critical: | ||
- | max_critical: | ||
- | str_critical: | ||
- | min_ff_event: | ||
- | custom_string_1: | ||
- | custom_string_2: | ||
- | custom_string_3: | ||
- | custom_integer_1: | ||
- | custom_integer_2: | ||
- | pending_delete: | ||
- | critical_instructions: | ||
- | warning_instructions: | ||
- | unknown_instructions: | ||
- | critical_inverse: | ||
- | warning_inverse: | ||
- | id_category: | ||
- | module_ff_interval: | ||
- | quiet: < | ||
- | cron_interval: | ||
- | macros: < | ||
- | disabled_types_event: | ||
- | " | ||
- | }, | ||
- | module_macros: | ||
- | min_ff_event_normal: | ||
- | min_ff_event_warning: | ||
- | min_ff_event_critical: | ||
- | ff_type: < | ||
- | each_ff: < | ||
- | ff_timeout: < | ||
- | dynamic_interval: | ||
- | dynamic_max: | ||
- | dynamic_min: | ||
- | dynamic_next: | ||
- | dynamic_two_tailed: | ||
- | prediction_sample_window: | ||
- | prediction_samples: | ||
- | prediction_threshold: | ||
- | cps: < | ||
- | } | ||
- | |||
- | </ | ||
- | |||
- | **Examples** | ||
- | |||
- | **例** | ||
- | |||
- | In JSON format before converting to base64: | ||
- | |||
- | base64 へ変換する前の JSON フォーマット: | ||
- | |||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | </ | ||
- | |||
- | Once base64 encoded: | ||
- | |||
- | base64 へのエンコード後: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | === set update_module_policy_json === | ||
- | |||
- | Update a **existing** Module to the target policy by means of a definition made in JSON format. | ||
- | |||
- | JSON 形式で作成された定義を使用して、ターゲットポリシーの**既存の**モジュールを更新します。 | ||
- | |||
- | Call syntax: | ||
- | |||
- | 書式: | ||
- | |||
- | * op=set (required) | ||
- | * op2=update_module_policy_json (required) | ||
- | * id=policy id (required) | ||
- | * other =[[https:// | ||
- | |||
- | * op=set (必須) | ||
- | * op2=update_module_policy_json (必須) | ||
- | * id=ポリシーID (必須) | ||
- | * other =モジュール定義を[[https:// | ||
- | |||
- | < | ||
- | |||
- | { | ||
- | name: < | ||
- | id_module: < | ||
- | id_tipo_modulo: | ||
- | configuration_data: | ||
- | description: | ||
- | unit: < | ||
- | max: < | ||
- | min: < | ||
- | module_interval: | ||
- | ip_target: < | ||
- | tcp_port: < | ||
- | tcp_send: < | ||
- | tcp_rcv: < | ||
- | snmp_community: | ||
- | snmp_oid: < | ||
- | id_module_group: | ||
- | flag: < | ||
- | disabled: < | ||
- | id_export: < | ||
- | plugin_user: | ||
- | plugin_pass: | ||
- | plugin_parameter: | ||
- | id_plugin: < | ||
- | post_process: | ||
- | prediction_module: | ||
- | max_timeout: | ||
- | max_retries: | ||
- | custom_id: < | ||
- | history_data: | ||
- | min_warning: | ||
- | max_warning: | ||
- | str_warning: | ||
- | min_critical: | ||
- | max_critical: | ||
- | str_critical: | ||
- | min_ff_event: | ||
- | custom_string_1: | ||
- | custom_string_2: | ||
- | custom_string_3: | ||
- | custom_integer_1: | ||
- | custom_integer_2: | ||
- | pending_delete: | ||
- | critical_instructions: | ||
- | warning_instructions: | ||
- | unknown_instructions: | ||
- | critical_inverse: | ||
- | warning_inverse: | ||
- | id_category: | ||
- | module_ff_interval: | ||
- | quiet: < | ||
- | cron_interval: | ||
- | macros: < | ||
- | disabled_types_event: | ||
- | " | ||
- | }, | ||
- | module_macros: | ||
- | min_ff_event_normal: | ||
- | min_ff_event_warning: | ||
- | min_ff_event_critical: | ||
- | ff_type: < | ||
- | each_ff: < | ||
- | ff_timeout: < | ||
- | dynamic_interval: | ||
- | dynamic_max: | ||
- | dynamic_min: | ||
- | dynamic_next: | ||
- | dynamic_two_tailed: | ||
- | prediction_sample_window: | ||
- | prediction_samples: | ||
- | prediction_threshold: | ||
- | cps: < | ||
- | } | ||
- | |||
- | </ | ||
- | |||
- | **Examples** | ||
- | |||
- | **例** | ||
- | |||
- | In JSON format before converting to base64: | ||
- | |||
- | base64 へ変換する前の JSON フォーマット: | ||
- | |||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | </ | ||
- | |||
- | Once base64 encoded: | ||
- | |||
- | base64 へのエンコード後: | ||
- | |||
- | < | ||
- | http:// | ||
- | |||
- | </ | ||
- | |||
- | ===== 例 ===== | ||
- | Pandora API を呼び出すためのいくつかの言語での例です。 | ||
- | |||
- | |||
- | ==== PHP ==== | ||
- | |||
- | < | ||
- | <?php | ||
- | $ip = ' | ||
- | $pandora_url = '/ | ||
- | $apipass = ' | ||
- | $user = ' | ||
- | $password = ' | ||
- | $op = ' | ||
- | $op2 = ' | ||
- | $return_type = ' | ||
- | $other = ''; | ||
- | $other_mode = ''; | ||
- | |||
- | $url = " | ||
- | |||
- | $url .= "?"; | ||
- | $url .= " | ||
- | $url .= "& | ||
- | $url .= "& | ||
- | $url .= "& | ||
- | $url .= "& | ||
- | if ($id !== '' | ||
- | $url .= "& | ||
- | } | ||
- | if ($id2 !== '' | ||
- | $url .= "& | ||
- | } | ||
- | if ($return_type !== '' | ||
- | $url .= "& | ||
- | } | ||
- | if ($other !== '' | ||
- | $url .= "& | ||
- | $url .= "& | ||
- | } | ||
- | |||
- | $curlObj = curl_init(); | ||
- | curl_setopt($curlObj, | ||
- | curl_setopt($curlObj, | ||
- | $result = curl_exec($curlObj); | ||
- | curl_close($curlObj); | ||
- | |||
- | $agents = array(); | ||
- | if (!empty($result)) { | ||
- | $lines = explode(" | ||
- | foreach ($lines as $line) { | ||
- | $fields = explode(";", | ||
- | |||
- | $agent = array(); | ||
- | $agent[' | ||
- | $agent[' | ||
- | $agent[' | ||
- | $agent[' | ||
- | $agent[' | ||
- | $agent[' | ||
- | |||
- | $agents[] = $agent; | ||
- | } | ||
- | } | ||
- | |||
- | print_list_agents($agents); | ||
- | |||
- | function print_list_agents($agents) { | ||
- | echo "< | ||
- | |||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "</ | ||
- | echo "</ | ||
- | |||
- | foreach ($agents as $agent) { | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "< | ||
- | echo "</ | ||
- | } | ||
- | echo "</ | ||
- | } | ||
- | ?> | ||
- | </ | ||
- | |||
- | ==== Python ==== | ||
- | |||
- | < | ||
- | import pycurl | ||
- | import cStringIO | ||
- | import pprint | ||
- | |||
- | def main(): | ||
- | ip = ' | ||
- | pandora_url = '/ | ||
- | apipass = ' | ||
- | user = ' | ||
- | password = ' | ||
- | op = ' | ||
- | op2 = ' | ||
- | return_type = ' | ||
- | other = '' | ||
- | other_mode = '' | ||
- | |||
- | url = " | ||
- | |||
- | url += "?" | ||
- | url += " | ||
- | url += "& | ||
- | url += "& | ||
- | url += "& | ||
- | url += "& | ||
- | |||
- | buf = cStringIO.StringIO() | ||
- | |||
- | c = pycurl.Curl() | ||
- | c.setopt(c.URL, | ||
- | c.setopt(c.WRITEFUNCTION, | ||
- | c.perform() | ||
- | |||
- | output = buf.getvalue() | ||
- | buf.close() | ||
- | |||
- | lines = output.split(" | ||
- | agents = [] | ||
- | for line in lines: | ||
- | if not line: | ||
- | continue | ||
- | |||
- | fields = line.split(";" | ||
- | agent = {} | ||
- | agent[' | ||
- | agent[' | ||
- | agent[' | ||
- | agent[' | ||
- | agent[' | ||
- | agent[' | ||
- | |||
- | agents.append(agent) | ||
- | |||
- | for agent in agents: | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print("" | ||
- | |||
- | if __name__ == " | ||
- | main() | ||
- | </ | ||
- | |||
- | |||
- | ==== Perl ==== | ||
- | |||
- | < | ||
- | use strict; | ||
- | use warnings; | ||
- | use WWW:: | ||
- | |||
- | sub write_callback { | ||
- | my ($chunk, | ||
- | |||
- | push @{$variable}, | ||
- | return length($chunk); | ||
- | } | ||
- | |||
- | my $ip = ' | ||
- | my $pandora_url = '/ | ||
- | my $apipass = ' | ||
- | my $user = ' | ||
- | my $password = ' | ||
- | my $op = ' | ||
- | my $op2 = ' | ||
- | my $return_type = ' | ||
- | my $other = ''; | ||
- | my $other_mode = ''; | ||
- | |||
- | my $url = " | ||
- | $url .= "?"; | ||
- | $url .= " | ||
- | $url .= "& | ||
- | $url .= "& | ||
- | $url .= "& | ||
- | $url .= "& | ||
- | |||
- | my @body; | ||
- | |||
- | my $curl = WWW:: | ||
- | $curl-> | ||
- | $curl-> | ||
- | $curl-> | ||
- | $curl-> | ||
- | |||
- | my $body=join("", | ||
- | my @lines = split(" | ||
- | |||
- | foreach my $line (@lines) { | ||
- | my @fields = split(';', | ||
- | |||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | } | ||
- | </ | ||
- | |||
- | ==== Ruby ==== | ||
- | |||
- | < | ||
- | require ' | ||
- | |||
- | ip = ' | ||
- | pandora_url = '/ | ||
- | apipass = ' | ||
- | user = ' | ||
- | password = ' | ||
- | op = ' | ||
- | op2 = ' | ||
- | return_type = ' | ||
- | other = '' | ||
- | other_mode = '' | ||
- | |||
- | url = " | ||
- | |||
- | url += "?" | ||
- | url += " | ||
- | url += "& | ||
- | url += "& | ||
- | url += "& | ||
- | url += "& | ||
- | |||
- | agents = [] | ||
- | |||
- | open(url) do |content| | ||
- | |||
- | content.each do |line| | ||
- | agent = {} | ||
- | |||
- | tokens = line.split(";" | ||
- | |||
- | agent[: | ||
- | agent[: | ||
- | agent[: | ||
- | agent[: | ||
- | agent[: | ||
- | agent[: | ||
- | |||
- | agents.push agent | ||
- | end | ||
- | end | ||
- | |||
- | |||
- | agents.each do |agent| | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | print(" | ||
- | end | ||
- | </ | ||
- | |||
- | ==== Lua ==== | ||
- | |||
- | < | ||
- | require(" | ||
- | |||
- | local content = "" | ||
- | |||
- | function WriteMemoryCallback(s) | ||
- | content = content .. s | ||
- | |||
- | return string.len(s) | ||
- | end | ||
- | |||
- | ip = ' | ||
- | pandora_url = '/ | ||
- | apipass = ' | ||
- | user = ' | ||
- | password = ' | ||
- | op = ' | ||
- | op2 = ' | ||
- | return_type = ' | ||
- | other = '' | ||
- | other_mode = '' | ||
- | |||
- | url = " | ||
- | |||
- | url = url .. "?" | ||
- | url = url .. " | ||
- | url = url .. "& | ||
- | url = url .. "& | ||
- | url = url .. "& | ||
- | url = url .. "& | ||
- | |||
- | if curl.new then c = curl.new() else c = curl.easy_init() end | ||
- | |||
- | c: | ||
- | c: | ||
- | |||
- | c:perform() | ||
- | |||
- | for line in string.gmatch(content, | ||
- | line = string.gsub(line, | ||
- | |||
- | count = 0 | ||
- | for field in string.gmatch(line, | ||
- | if count == 0 then | ||
- | print(" | ||
- | end | ||
- | if count == 1 then | ||
- | print(" | ||
- | end | ||
- | if count == 2 then | ||
- | print(" | ||
- | end | ||
- | if count == 3 then | ||
- | print(" | ||
- | end | ||
- | if count == 4 then | ||
- | print(" | ||
- | end | ||
- | if count == 5 then | ||
- | print(" | ||
- | end | ||
- | |||
- | count = count + 1 | ||
- | end | ||
- | print("" | ||
- | end | ||
- | </ | ||
- | |||
- | ==== Brainfuck ==== | ||
- | |||
- | < | ||
- | [-]> | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | -. | ||
- | > | ||
- | > | ||
- | > | ||
- | +. | ||
- | > | ||
- | > | ||
- | ++. | ||
- | --. | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | +. | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | ----. | ||
- | > | ||
- | +++. | ||
- | -. | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | ++. | ||
- | ++. | ||
- | > | ||
- | > | ||
- | +++. | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | ---. | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | ++++. | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | ++. | ||
- | --. | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | > | ||
- | ++++. | ||
- | > | ||
- | </ | ||
- | |||
- | ==== Java (Android) ==== | ||
- | [[https:// | ||
- | |||
- | < | ||
- | /** | ||
- | * Performs an http get petition. | ||
- | * | ||
- | * @param context | ||
- | * Application context. | ||
- | * @param additionalParameters | ||
- | * Petition additional parameters | ||
- | * @return Petition result. | ||
- | * @throws IOException | ||
- | * If there is any problem with the connection. | ||
- | */ | ||
- | public static String httpGet(Context context, | ||
- | List< | ||
- | SharedPreferences preferences = context.getSharedPreferences( | ||
- | context.getString(R.string.const_string_preferences), | ||
- | Activity.MODE_PRIVATE); | ||
- | |||
- | String url = preferences.getString(" | ||
- | String user = preferences.getString(" | ||
- | String password = preferences.getString(" | ||
- | String apiPassword = preferences.getString(" | ||
- | if (url.length() == 0 || user.length() == 0) { | ||
- | return ""; | ||
- | } | ||
- | ArrayList< | ||
- | parameters.add(new BasicNameValuePair(" | ||
- | parameters.add(new BasicNameValuePair(" | ||
- | if (apiPassword.length() > 0) { | ||
- | parameters.add(new BasicNameValuePair(" | ||
- | } | ||
- | parameters.addAll(additionalParameters); | ||
- | Log.i(TAG, | ||
- | if (url.toLowerCase().contains(" | ||
- | // Secure connection | ||
- | return Core.httpsGet(url, | ||
- | } else { | ||
- | HttpParams params = new BasicHttpParams(); | ||
- | HttpConnectionParams.setConnectionTimeout(params, | ||
- | CONNECTION_TIMEOUT); | ||
- | HttpConnectionParams.setSoTimeout(params, | ||
- | DefaultHttpClient httpClient = new DefaultHttpClient(params); | ||
- | UrlEncodedFormEntity entity; | ||
- | HttpPost httpPost; | ||
- | HttpResponse response; | ||
- | HttpEntity entityResponse; | ||
- | String return_api; | ||
- | httpPost = new HttpPost(url); | ||
- | entity = new UrlEncodedFormEntity(parameters); | ||
- | httpPost.setEntity(entity); | ||
- | response = httpClient.execute(httpPost); | ||
- | entityResponse = response.getEntity(); | ||
- | return_api = Core | ||
- | .convertStreamToString(entityResponse.getContent()); | ||
- | Log.i(TAG, | ||
- | return return_api; | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | ===== API における新規呼び出し拡張 ===== | ||
- | API の新たな呼び出しを開発するには、以下を考慮してください。 | ||
- | |||
- | * The call has to be inscribed as a function in the file < | ||
- | * The function must have this structure: The prefix '' | ||
- | * The function can have no parameters, but if it has them, the parameters received will be the following in the same order: | ||
- | * id: first operator or parameter, it contains a string. | ||
- | * id2: second operator or parameter, it contains a string. | ||
- | * other: rest of operators or parameters, it contains as an array of two positions: | ||
- | * $other[' | ||
- | * $other[' | ||
- | * returnType: string that specifies the kind of return that the call will have. It is usually visible for you, but you may use or modify it if necessary. | ||
- | |||
- | * 呼び出しは < | ||
- | * 呼び出しは、" | ||
- | * 全てを利用しない場合でも、任意の名前で良いですが、呼び出しパラメータは次に示す全てを受け渡す必要があります。 | ||
- | * id: 1番目の操作またはパラメータで、文字列を含みます。 | ||
- | * id2: 2番目の操作またはパラメータで、文字列を含みます。 | ||
- | * other: 残りの操作またはパラメータで、以下の2種類の配列を含みます。 | ||
- | * $other[' | ||
- | * $other[' | ||
- | * returnType: 呼び出しの戻値の種類を指定する文字列です。通常は透過的ですが必要であれば編集できます。 | ||
- | |||
- | ==== Pandora FMS 拡張からの新たな API 呼び出し ==== | ||
- | |||
- | It is possible to create new API calls without using '' | ||
- | |||
- | '' | ||
- | |||
- | < | ||
- | < | ||
- | |||
- | </ | ||
- | |||
- | and into this file create the desired functions with the same considerations of the standard API but with '' | ||
- | |||
- | そして、標準の API と同じように欲しい関数を作成します。ただし、プリフィックスは、'' | ||
- | |||
- | For example, having an extension called '' | ||
- | |||
- | You must create a file called '' | ||
- | |||
- | 例えば、'' | ||
- | |||
- | The desired functions will be within this file, for example a function to get the number of modules in a group. This function must have a name like: '' | ||
- | |||
- | このファイルに、例えば、グループのモジュール数を取得する関数などの欲しい関数を入れます。この関数の名前は、'' | ||
- | |||
- | ==== API 関数 ==== | ||
- | API 関数内では、以下の関数を利用できます。 | ||
- | |||
- | * returnError(typeError, | ||
- | * typeError: 現在のところ、' | ||
- | * returnType: 現在のところ、' | ||
- | * returnData(returnType, | ||
- | * returnType: ' | ||
- | * data: データおよびその形式を含んだ配列です。次のフィールドがあります。 | ||
- | * ' | ||
- | * ' | ||
- | * ' | ||
- | |||
- | === 例 === | ||
- | |||
- | < | ||
- | function get_module_last_value($idAgentModule, | ||
- | { | ||
- | $sql = sprintf(' | ||
- | $value = get_db_value_sql($sql); | ||
- | if ($value === false) { | ||
- | switch ($other[' | ||
- | case ' | ||
- | switch ($other[' | ||
- | case ' | ||
- | default: | ||
- | returnError(' | ||
- | break; | ||
- | } | ||
- | break; | ||
- | case ' | ||
- | switch ($other[' | ||
- | case ' | ||
- | returnData($returnType, | ||
- | break; | ||
- | } | ||
- | break; | ||
- | } | ||
- | } | ||
- | else { | ||
- | $data = array(' | ||
- | returnData($returnType, | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | ===== API.php の今後 ===== | ||
- | 今後の api.php では次のようなことを考えています。 | ||
- | |||
- | * Broading the API call ensemble. | ||
- | * Returning and getting values in xml, JSON… | ||
- | * Increasing security call for insecure environments. | ||
- | * Integration with third tool standards. | ||
- | |||
- | * APIの追加 | ||
- | * xml や jason 等でのデータの取得 | ||
- | * セキュアではない環境向けのセキュリティ強化 | ||
- | * 他のツール標準との統合 | ||
- | |||
- | [[ja: | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||