差分

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

--- ja:documentation:pandorafms:technical_reference:03_anexo_cli [2025/08/15 22:36] – [--parse_siem_log] junichi
+++ ja:documentation:pandorafms:technical_reference:03_anexo_cli [2025/12/17 08:47] (現在) – [--create_plugin_module] junichi
@@ 行 38: / 行 38: @@
 ==== 書式 ====
-  * All parameters, mandatory or optional, can be delimited with single quotes. This is especially useful when a parameter has one or more spaces.
+  * All parameters, required or optional, can be delimited with single quotes. This is especially useful when a parameter has one or more spaces.
   * If you need to omit a parameter you can use two single quotes together. In case the parameter is strictly necessary a message like ''[ERROR] Error:'' will be displayed followed by a description of the parameter. This is also useful to indicate empty optional parameters.
   * Some parameters are case sensitive, others are case insensitive. For example, [[#ks2_1|when creating an agent]] the name of the PFMS server must be strictly the same, however the name of the primary group to which the agent will belong can be in upper and/or lower case and if there is a match the group will be assigned.
@@ 行 534: / 行 534: @@
 ==== --delete_group ====
-**Mandatory parameter:**
+**Required parameter:**
 **必須パラメータ:**
@@ 行 567: / 行 567: @@
 ==== --update_group ====
-**Mandatory parameters:**
+**Required parameters:**
 **必須パラメータ:**
@@ 行 2297: / 行 2297: @@
 ==== --create_plugin_module ====
-**Required parameters**:
+**Required Parameters**:
 **必須パラメータ**:
@@ 行 2306: / 行 2306: @@
   * < module_address >
   * < module_port > numerical value between ''1'' and ''65535''.
-  * < plugin_name >
+  * < plugin_name > one of the registered ones (menu <wrap :en>**Management → Servers → Plugins**</wrap>).
   * < user >
   * < password >
-  * < parameters >
+  * < params >
+  * < description >
+  * < module_group >
   * <モジュール名>
@@ 行 2315: / 行 2317: @@
   * <エージェント名>
   * <アドレス>
-  * <ポート番号>
+  * <ポート番号> ''1'' から ''65535'' までの数値。
-  * <プラグイン名>
+  * <プラグイン名> 登録済みのものの 1 つ (<wrap :ja>**管理(Management) → サーバ(Servers) → プラグイン(Plugins)**</wrap> メニュー)。
   * <ユーザ>
   * <パスワード>
   * <パラメーター>
+  * <説明>
+  * <モジュールグループ>
-**Parámetros opcionales**:
+**Optional Parameters**:
 **オプションパラメータ**:
-  * < description >
-  * < module_group >
   * < min >
   * < max >
@@ 行 2337: / 行 2339: @@
   * < history_data >
   * < ff_threshold >
-  * < warning_str >
+  * < warning_string >
-  * < critical_str >
+  * < critical_string >
   * < enable_unknown_events >
   * < each_ff >
   * < ff_threshold_normal >
-  * < ff_treshold_warning >
+  * < ff_threshold_warning >
   * < ff_threshold_critical >
   * < timeout >
@@ 行 2351: / 行 2353: @@
   * < critical_inverse >
   * ''use_agent_alias'' to search for the agent by its alias instead of its name.
-  * ''ignore_unknown'' Discards the unknown state calculation, so that the module will never change to that state and will always keep the last known state.
+  * ''ignore_unknown'' Discards the calculation of unknown status, meaning the module will never switch to this status and will always retain the last known status.
-  * < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.
+  * < number_of_intervals_in_warning > Allows status escalation by specifying the maximum number of consecutive intervals in which the module remains in a warning status. If this value is exceeded, the module will escalate to a critical status.
-  * <説明>
-  * <モジュールグループ>
   * <最小値>
   * <最大値>
@@ 行 2382: / 行 2382: @@
   * < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。
-**Description**: A module of type //plugin// will be created in an agent with the module name, module type, name of the agent where it will be created, the module address, the associated port and the corresponding plugin name. Optionally, a description, the module group, minimum and maximum values, a post processing value, an interval in seconds, minimum and maximum warning values, minimum and maximum criticality values, among other optional values, can be provided.
+**Description**: A //plugin// type module will be created on an agent with the module name, module type, agent name where it will be created, the module address, the associated port, the corresponding //plugin// name, a description, the module group, and some minimum and maximum values, among other optional values.
 **説明**: //プラグイン// タイプのモジュールは、モジュール名、モジュールタイプ、作成されるエージェントの名前、モジュールアドレス、関連付けられたポート、および対応するプラグイン名を指定してエージェント内に作成されます。 オプションで、説明、モジュールグループ、最小値と最大値、保存倍率、秒単位の間隔、警告の最小と最大値、障害の最小と最大値、その他のオプションの値を指定できます。
-The default values are ''0'' for minimum and maximum, ''history_data'' and ''post_process'' and ''300'' for the interval.
+The default values are ''0'' for the minimum and maximum, ''history_data'' and ''post_process'' and ''300'' for the interval.
 最小、最大、データの保存および保存倍率のデフォルトは ''0'' で、間隔のデフォルトは ''300'' です。
@@ 行 2394: / 行 2394: @@
 **例 ([[#pandora_fms_cli|呼び出し]]および[[#書式|書式]] を参照):**
-Simple example for state scaling:
+Basic example:
-状態スケーリングの簡単な例:
+基本的な例:
 <code bash>
-pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module plugin_module_test generic_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 "1" "DNS Plugin" "admin" "pandora" "100" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001
+pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module \
+  "My plugin module" "generic_data" "pandora.internals" "" "8080" \
+  "DNS Plugin" "" "" "" "" "" "" "" "" "" "" ""
+</code>
+Simple example for status escalation:
+状態エスカレーションの簡単な例:
+<code bash>
+pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module \
+  plugin_module_test generic_data \
+f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 \
+  "1" "DNS Plugin" "admin" "pandora" "100" "" "" "" "" "" "" "" "" "" "" "" \
+  "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001
 </code>
@@ 行 2408: / 行 2422: @@
 <code bash>
-pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module 'My module' generic_data 'Mi agente' 192.168.12.123 8080 myplugin myuser mypass 'param1 param2 param3' 'Descripcion del modulo' 'General' 1 3 0 300 0 0 0 0 1
+pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module \
+  'My module' generic_data 'My agent' 192.168.12.123 8080 myplugin \
+  myuser mypass 'param1 param2 param3' 'Module description' \
+  'General' 1 3 0 300 0 0 0 0 1
+</code>
+Advanced example:
+高度な例:
+If you need to set a //timeout// of ''30'', you must explicitly pass each of the optional parameters with ''<nowiki>""</nowiki>'' so that the indicated position (in this case, //timeout//) is correct:
+タイムアウトを設定する必要がある場合 (以下の例では ''30'') は、指定された位置 (この場合はタイムアウト) が正しくなるように、各オプションパラメータを ''<nowiki>""</nowiki>'' で明示的に渡す必要があります。
+<code bash>
+pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module \
+  MyModule generic_data MyAgent 127.0.0.1 5667 \
+  MyPlugin "" "" "" "" MyGroup "" "" "" "" "" "" \
+  "" "" "" "" "" "" "" "" "" "" "" "" 30
 </code>
@@ 行 2498: / 行 2530: @@
 ==== --delete_module ====
-**Mandatory parameters:**
+**Required parameters:**
 **必須パラメータ:**
@@ 行 3741: / 行 3773: @@
 **必須パラメータ**: < ユーザID >
-**Description**:  The [[:en:documentation:pandorafms:management_and_operation:12_console_setup#double_authentication|double authentication]] will be disabled for the specified user.
+**Description**: The [[:en:documentation:pandorafms:cybersecurity:07_safety_functions#ks1_4|double authentication]] will be disabled for the specified user.
-**説明:** 特定ユーザに対して[[:ja:documentation:pandorafms:management_and_operation:12_console_setup#二段階認証|二段階認証]]を無効化します。
+**説明:** 特定ユーザに対して[[:ja:documentation:pandorafms:cybersecurity:07_safety_functions#ks1_4|二段階認証]]を無効化します。
 **例:**
@@ 行 3756: / 行 3788: @@
 ==== --create_event ====
-**Mandatory parameters**:
+**Required parameters**:
 ** 必須パラメータ**:
@@ 行 4977: / 行 5009: @@
 </code>
-A valid SIEM license and the decoders and rules already loaded in the database are required for the CLI call to work. The result will always be what would be generated at the time it is evaluated. This call does not introduce new log entries in monitoring, nor does it generate [[:en:documentation:pandorafms:monitoring:21_siem#ks6|SIEM events]].
+A valid SIEM license and the decoders and rules already loaded in the database are required for the CLI call to work. The result will always be what would be generated at the time it is evaluated. This call does not introduce new log entries in monitoring, nor does it generate [[:en:documentation:pandorafms:cybersecurity:21_siem#ks6|SIEM events]].
 CLI 呼び出しが機能するためには、有効な SIEM ライセンスと、データベースに既にロードされているデコーダーとルールが必要です。結果は、常に評価時に生成されるものと同じになります。この呼び出しによって監視に新しいログエントリが追加されたり、[[:ja:documentation:pandorafms:monitoring:21_siem#ks6|SIEM イベント]] が生成されたりすることはありません。