差分

このページの2つのバージョン間の差分を表示します。

--- ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2026/06/06 22:58] – [set update_agent] junichi
+++ ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2026/07/25 22:19] (現在) – [API パスワードによる] junichi
@@ 行 365: / 行 365: @@
 テキストボックスに ''*'' を入力すると、IP アドレスによる ACL チェックは省略され、セキュリティはプロトコルと環境に委ねられます。
+<wrap #ks2_1_2 />
 === API パスワードによる ===
-You can also set a password for API actions (·**API password**).
+A password can also be set (//token// <wrap :en>**API password**</wrap>) to perform API actions.
+API 操作を実行するためのパスワード（//トークン// <wrap :ja>**API パスワード(API password**</wrap>)）も設定可能です。
-API アクセスのパスワードも設定することができます。(**API パスワード(API password)**)
+  * ''apipass'': For practical purposes throughout this documentation, ''1234'' is used for the PFMS API 1.0. **A strong password must always be used**: It must contain uppercase and lowercase letters, including a number and a symbol, all mixed randomly. //Through the Web Console, you will be notified in a timely manner to change the default password created during the Pandora FMS installation//.
-   * ''apipass'': By default, and used in this documentation, ''1234''.
+  * ''apipass'': 本ドキュメント全体において、説明用として PFMS API 1.0 用のパスワードとして ''1234'' を使用しています。**本番環境では必ず強力なパスワードを使用してください**。パスワードには、大文字、小文字、数字、記号をランダムに組み合わせて含める必要があります。//Pandora FMS のインストール時に作成されたデフォルトパスワードを変更するよう、Web コンソールを通じて適宜通知が行われます//。
-  * ''apipass'': デフォルトかつこのドキュメントでは、''1234'' が使われています。
+<wrap #ks2_1_3 />
 === ユーザ資格情報による ===
@@ 行 3037: / 行 3041: @@
 [[#ks2|Call syntax]]:
-[[#ks2|呼び出し書式]]:
+[[#ks2|書式]]:
   * ''op=set'' (required)
@@ 行 3079: / 行 3083: @@
   - <OSバージョン>
-**Example (see [[:en:documentation:08_technical_reference:02_annex_externalapi#pandora_fms_external_api|call syntax]]**):
+**Example (see [[#ks2|call syntax]]**):
-**例 ([[:ja:documentation:08_technical_reference:02_annex_externalapi#外部_api| 書式]]を参照):**
+**例 ([[#ks2|書式]]を参照):**
 <code bash>
@@ 行 3089: / 行 3093: @@
 == 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.
+Updates one or more fields of an agent (or multiple agents if ''agent_alias'' is used) with the data passed as parameters.
-この呼び出しは、1つもしくは、(別名を利用し一致するエージェントが複数ある場合は) 複数のエージェントのフィールドを更新します。
+つもしくは、(''agent_alias'' を利用し一致するエージェントが複数ある場合は) 複数のエージェントのフィールドを更新します。
-Call syntax:
+[[#ks2|Call syntax]]:
+[[#ks2|書式]]:
   * op=set (required)
@@ 行 3114: / 行 3120: @@
   * <disabled>
   * <description>
-書式:
   * op=set (必須)
-  * op2=update_agent (必須)
+  * op2=update_agent_field (必須)
   * id=<id_agent> or <alias> (必須), <alias> id2 パラメータに依存します。
   * id2= <id_agente> の場合 0 (オプション), <alias> の場合 1 (必須)
@@ 行 3143: / 行 3147: @@
 エージェント名を利用する場合:
-<code>
+<code bash>
-http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+.../include/api.php?op=set&op2=update_agent_field&id=3&other=id_os,1|direccion,192.168.10.15|id_parent,2|cascade_protection,1|cascade_protection_module,40|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 </code>
@@ 行 3151: / 行 3154: @@
 別名を利用する場合。別名を含む全エージェントを編集します:
 <code>
+.../include/api.php?op=set&op2=update_agent_field&id=pandora&id2=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
-http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=pandora&id2=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 </code>
 == set delete_agent ==
@@ 行 7651: / 行 7652: @@
 == set create_alerts_policy ==
->= 7.0. 725
+To create standard or external alerts in a monitoring policy.
-ポリシーアラートを作成します。
+監視ポリシーで標準アラートまたは外部アラートを作成します。
-  * 存在するポリシー ID を指定する必要があります。
+[[#ks2|Call syntax]]:
-  * 通常のタイプの場合、ポリシーモジュールIDを指定する必要があります。
-  * 存在するテンプレートIDを指定する必要があります。
-  * 外部かどうかを 0(通常)、1(外部) で設定します。デフォルトは、通常の 0 です。
-  * 外部タイプ(1) の場合は、名前を指定する必要があります。
-(失敗) または、ポリシーに追加したアラートID(成功) を返します。
+[[#ks2|書式]]:
-書式:
+**To create [[:en:documentation:pandorafms:complex_environments_and_optimization:02_policy#ks4_6|standard alerts]]**:
-  * op=set
+**[[:ja:documentation:pandorafms:complex_environments_and_optimization:02_policy#ks4_6|標準アラート]]を作成するには**：
-  * op2=create_alerts_policy
-  * id=ポリシーID
-  * id2=ポリシーモジュールID
-  * other=ポリシーモジュールID|テンプレートID|0 または 1|モジュール名
-  * other_mode=url_encode_separator_|
-  * return_type=(string, csv, json).
-**例**
+  * ''op=set'' (required).
-<code>
+  * ''op2=create_alerts_policy'' (required).
+  * ''id='' A policy identifier that must exist (required).
+  * ''return_type'' Output format (optional): STRING, CSV o JSON.
+  * ''other_mode=url_encode_separator_|''.
+  * ''other='' With the following fields properly delimited:
-http://localhost/pandora_console/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&other=0|2|1|cpu%20load&other_mode=url_encode_separator_|
+  * ''op=set'' (必須)。
+  * ''op2=create_alerts_policy'' (必須)。
+  * ''id='' ポリシー識別子 (必須)。
+  * ''return_type'' 出力形式 (オプション)：STRING、CSV、または JSON。
+  * ''other_mode=url_encode_separator_|''。
+  - Existing module ID (required).
+  - A template identifier that must exist (required).
+  - ''0'' It is explicitly stated that this is a standard alert (optional); this parameter can also be omitted, as the default value is zero.
+  - This parameter is omitted when creating a standard alert, as it will be generated using the name of the existing module identifier provided.
+  - 既存のモジュールID（必須）。
+  - 必ず存在するテンプレート識別子（必須）。
+  - ''0'' は、これが標準アラートであることを明示的に示しています（オプション）。デフォルト値はゼロなので、このパラメータは省略できます。
+  - 標準アラートを作成する場合、このパラメータは省略されます。指定された既存のモジュール識別子の名前を使用してアラートが生成されるためです。
+**To create [[:en:documentation:pandorafms:complex_environments_and_optimization:02_policy#ks4_7|external alerts]]**:
+**[[:ja:documentation:pandorafms:complex_environments_and_optimization:02_policy#ks4_7|外部アラート]]を作成するには**：
+  * ''op=set'' (required).
+  * ''op2=create_alerts_policy'' (required).
+  * ''id='' A policy identifier that must exist (required).
+  * ''return_type'' Output format (optional): STRING, CSV o JSON.
+  * ''other_mode=url_encode_separator_|''.
+  * ''other='' With the following fields properly delimited:
+  * ''op=set'' (必須)。
+  * ''op2=create_alerts_policy'' (必須)。
+  * ''id='' ポリシー識別子 (必須)。
+  * ''return_type'' 出力形式 (オプション)：STRING、CSV、またはJSON。
+  * ''other_mode=url_encode_separator_|''。
+  * ''other='' 以下のフィールドを適切に区切り文字で区切ってください。
+  - ''0'' Since the external alert does not require an existing module to be generated (optional).
+  - A template identifier that must exist (required).
+  - ''1'' It is explicitly stated that this is an external alert (mandatory).
+  - Module name for the external alert (required).
+  - ''0'' 外部アラートは既存のモジュールを生成する必要がないため（オプション）。
+  - 必ず存在しなければならないテンプレート識別子（必須）。
+  - ''1'' これが外部アラートであることを明示的に指定する（必須）。
+  - 外部アラートのモジュール名（必須）。
+**Result**:
+**結果**:
+Returns '0' (//false//) or the identifier of the alert added to the policy (//true//).
+'0' (//false//) またはポリシーに追加されたアラートの識別子 (//true//) を返します。
+**Example of a standard alert (see [[#ks2|call syntax]]):**
+**標準アラートの例（[[#ks2|書式]]を参照）：**
+<code bash>
+…/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&other=39|1|0|&other_mode=url_encode_separator_|
+</code>
+**Example of an external alert (see [[#ks2|call syntax]]):**
+**外部アラートの例（[[#ks2|書式]]を参照）：**
+<code bash>
+…/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=8&other=0|1|1|ESET%20logd&other_mode=url_encode_separator_|
 </code>