差分
このページの2つのバージョン間の差分を表示します。
| 両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン | ||
| ja:documentation:pandorafms:technical_reference:03_anexo_cli [2025/05/17 01:52] – [--create_policy_data_module] junichi | ja:documentation:pandorafms:technical_reference:03_anexo_cli [2025/05/17 02:35] (現在) – [--start_snmptrapd] junichi | ||
|---|---|---|---|
| 行 4160: | 行 4160: | ||
| ==== --create_policy_web_module ==== | ==== --create_policy_web_module ==== | ||
| - | (バージョン 7.0 以上) | ||
| - | **オプションパラメーター: | + | **Required parameters**: |
| - | **説明:** ポリシーウェブモジュールを作成します。デフォルト値は、--create_web_module と同じです。 | + | **必須パラメータ**: |
| - | **実行例:** | + | |
| + | | ||
| + | | ||
| - | | + | |
| + | * < モジュール名 > | ||
| + | * < モジュールタイプ > '' | ||
| + | |||
| + | **Optional parameters**: | ||
| + | |||
| + | **オプションパラメータ**: | ||
| + | |||
| + | * < description > | ||
| + | * < module_group > | ||
| + | * < min > | ||
| + | * < max > | ||
| + | * < post_process > | ||
| + | * < interval > | ||
| + | * < warning_min > | ||
| + | * < warning_max > | ||
| + | * < critical_min > | ||
| + | * < critical_max > | ||
| + | * < history_data > | ||
| + | * < retries > | ||
| + | * < requests > | ||
| + | * < agent_browser_id > | ||
| + | * < auth_server > | ||
| + | * < auth_realm > | ||
| + | * < configuration_data > | ||
| + | * < proxy_url > | ||
| + | * < proxy_auth_login > | ||
| + | * < proxy_auth_password > | ||
| + | * < warning_str > | ||
| + | * < critical_str > | ||
| + | * < enable_unknown_events > | ||
| + | * < ff_threshold > | ||
| + | * < each_ff > | ||
| + | * < ff_threshold_normal > | ||
| + | * < ff_threshold_warning > | ||
| + | * < ff_threshold_critical > | ||
| + | * < ff_timeout > | ||
| + | * < warning_inverse > | ||
| + | * < critical_inverse > | ||
| + | * < critical_instructions > | ||
| + | * < warning_instructions > | ||
| + | * < unknown_instructions > | ||
| + | * '' | ||
| + | |||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * '' | ||
| + | |||
| + | **Description**: | ||
| + | |||
| + | **説明**: ポリシー内にウェブモジュールが作成されます。デフォルト値は[[# | ||
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage | ||
| + | |||
| + | </ | ||
| ==== --create_policy_network_module ==== | ==== --create_policy_network_module ==== | ||
| - | (バージョン 5.0 以上) | ||
| - | **オプションパラメーター:** < | + | **Required parameters**: |
| + | |||
| + | **必須パラメータ** | ||
| + | |||
| + | * < policy_name > | ||
| + | * < module_name > | ||
| + | * < module_type > | ||
| + | |||
| + | | ||
| + | * < モジュール名 > | ||
| + | * < モジュールタイプ > | ||
| + | |||
| + | **Optional parameters**: | ||
| - | **説明:** ポリシーネットワークモジュールを作成します。デフォルトの値は、--create_network_module | + | **オプションパラメータ** |
| - | **注意:** | + | |
| + | | ||
| + | | ||
| + | | ||
| + | * < max > | ||
| + | * < post_process > | ||
| + | * < interval > | ||
| + | * < warning_min > | ||
| + | * < warning_max > | ||
| + | * < critical_min > | ||
| + | * < critical_max > | ||
| + | * < history_data > | ||
| + | * < ff_threshold > | ||
| + | * < warning_str > | ||
| + | * < critical_str > | ||
| + | * < enable_unknown_events > | ||
| + | * < each_ff > | ||
| + | * < ff_threshold_normal > | ||
| + | * < ff_threshold_warning > | ||
| + | * < ff_threshold_critical > | ||
| + | * < critical_instructions > | ||
| + | * < warning_instructions > | ||
| + | * < unknown_instructions > | ||
| + | * '' | ||
| - | 以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。 | + | * < |
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| * < | * < | ||
| * < | * < | ||
| * < | * < | ||
| * < | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * '' | ||
| - | **実行例:** | + | **Description**: A network module will be created in a policy. The default values [[# |
| + | |||
| + | **説明**: ポリシー内にネットワークモジュールが作成されます。デフォルト値は[[# | ||
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage / | ||
| + | |||
| + | </ | ||
| - | perl pandora_manage.pl / | ||
| ==== --create_policy_snmp_module ==== | ==== --create_policy_snmp_module ==== | ||
| - | (バージョン 5.0 以上) | ||
| - | **オプションパラメーター:** < | + | **Required parameters**: |
| + | |||
| + | **必須パラメータ**: | ||
| + | |||
| + | | ||
| + | * < module_name > | ||
| + | * < module_type > | ||
| + | * < module_port > | ||
| + | * < version > | ||
| + | |||
| + | | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | |||
| + | **Optional parameters**: | ||
| - | **説明:** ポリシー SNMP モジュールを作成します。デフォルトの値は、--create_snmp_module | + | **オプションパラメータ**: |
| - | **注意:** | + | |
| + | | ||
| + | | ||
| + | | ||
| + | * < min > | ||
| + | * < max > | ||
| + | * < post_process > | ||
| + | * < interval > | ||
| + | * < warning_min > | ||
| + | * < warning_max > | ||
| + | * < critical_min > | ||
| + | * < critical_max > | ||
| + | * < history_data > | ||
| + | * < snmp3_priv_method > | ||
| + | * < snmp3_priv_pass > | ||
| + | * < snmp3_sec_level > | ||
| + | * < snmp3_auth_method > | ||
| + | * < snmp3_auth_user > | ||
| + | * < snmp3_priv_pass > | ||
| + | * < ff_threshold > | ||
| + | * < warning_str > | ||
| + | * < critical_str > | ||
| + | * < enable_unknown_events > | ||
| + | * < each_ff > | ||
| + | * < ff_threshold_normal > | ||
| + | * < ff_threshold_warning > | ||
| + | * < ff_threshold_critical > | ||
| + | * < critical_instructions > | ||
| + | * < warning_instructions > | ||
| + | * < unknown_instructions > | ||
| + | * '' | ||
| - | 以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。 | + | * < |
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * <警告の最小値> | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * <データの保存> | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| * < | * < | ||
| * < | * < | ||
| * < | * < | ||
| * < | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * '' | ||
| - | **実行例:** | + | **Description**: An SNMP module will be created in a policy. The default values [[# |
| - | perl pandora_manage.pl / | + | **説明**: ポリシー内にSNMPモジュールが作成されます。デフォルト値は[[# |
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage / | ||
| + | |||
| + | </ | ||
| ==== --create_policy_plugin_module ==== | ==== --create_policy_plugin_module ==== | ||
| - | (バージョン 5.0 以上) | ||
| - | **オプションパラメーター:** < | + | **Required parameters**: |
| + | |||
| + | **必須パラメータ**: | ||
| + | |||
| + | | ||
| + | * < module_name > | ||
| + | * < module_kind > | ||
| + | * < module_port > numerical value between 1 and 65535. | ||
| + | * < plugin_name > | ||
| + | * < user > | ||
| + | * < password > | ||
| + | * < parameters > | ||
| + | |||
| + | | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | |||
| + | **Optional parameters**: | ||
| - | **説明:** ポリシープラグインモジュールを作成します。デフォルトの値は、--create_plugin_module | + | **オプションパラメータ**: |
| - | **注意:** | + | |
| + | | ||
| + | | ||
| + | | ||
| + | * < post_process > | ||
| + | * < interval > | ||
| + | * < warning_min > | ||
| + | * < warning_max > | ||
| + | * < critical_min > | ||
| + | * < critical_max > | ||
| + | * < history_data > | ||
| + | * < warning_str > | ||
| + | * < critical_str > | ||
| + | * < enable_unknown_events > | ||
| + | * < each_ff > | ||
| + | * < ff_threshold_normal > | ||
| + | * < ff_threshold_warning > | ||
| + | * < ff_threshold_critical > | ||
| + | * < critical_instructions > | ||
| + | * < warning_instructions > | ||
| + | * < unknown_instructions> | ||
| + | * '' | ||
| - | 以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。 | + | * < |
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * <警告の最小値> | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * <データの保存> | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| * < | * < | ||
| * < | * < | ||
| * < | * < | ||
| * < | * < | ||
| + | * < | ||
| + | * < | ||
| + | * < | ||
| + | * '' | ||
| - | **実行例:** | + | **Description**: A module of type //plugin// will be created in a policy. The default values [[# |
| - | perl pandora_manage.pl / | + | **説明**: ポリシー内に // |
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage / | ||
| + | |||
| + | </ | ||
| ==== --validate_policy_alerts ==== | ==== --validate_policy_alerts ==== | ||
| - | (バージョン 5.0 以上) | ||
| - | **オプションパラメーター: | + | **Required parameter**: < policy_name |
| - | **説明:** 指定したポリシーの全アラートを承諾します。 | + | **必須パラメータ**: < ポリシー名 > |
| - | **実行例:** | + | **Optional parameters**: None. |
| + | |||
| + | **オプションパラメータ**: | ||
| + | |||
| + | **Description**: | ||
| + | |||
| + | **説明**: 指定された [[ja: | ||
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage / | ||
| + | |||
| + | </ | ||
| - | perl pandora_manage.pl / | ||
| ==== --get_policy_modules ==== | ==== --get_policy_modules ==== | ||
| - | (バージョン 5.0 以上) | ||
| - | **オプションパラメーター: | + | **Required parameter**: < policy_name |
| - | **説明:** 指定したポリシーのモジュールリスト(id と名前)を取得します。 | + | **必須パラメータ**: < ポリシー名 |
| - | **実行例:** | + | **Optional parameters**: None. |
| - | perl pandora_manage.pl / | + | **オプションパラメータ**: |
| + | |||
| + | **Description**: | ||
| + | |||
| + | **説明**: 指定された [[ja: | ||
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage | ||
| + | |||
| + | </ | ||
| ==== --get_policies ==== | ==== --get_policies ==== | ||
| - | (バージョン 5.0 以上) | ||
| - | **オプションパラメーター: | + | **Required parameters**: None. |
| - | **説明:** 全てのポリシー(パラメータ無しの場合)または、指定したエージェントのポリシーを取得します(パラメータにエージェントを指定します)。 | + | **必須パラメータ**: なし |
| - | **実行例:** | + | **Optional parameters**: |
| - | perl pandora_manage.pl / | + | **オプションパラメータ**: |
| + | |||
| + | * < agent_name > | ||
| + | * '' | ||
| + | |||
| + | * < エージェント名 > | ||
| + | * '' | ||
| + | |||
| + | **Description**: | ||
| + | |||
| + | **説明**: | ||
| + | |||
| + | * Without parameters: Obtains all policies (numeric identifier and name). | ||
| + | * Agent name: Gets the policies of an agent (list agent name, numeric policy identifier and policy name). | ||
| + | |||
| + | * パラメータなし: | ||
| + | * エージェント名: | ||
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage | ||
| + | |||
| + | </ | ||
| + | |||
| + | <wrap #ks8 /> | ||
| ===== Netflow ===== | ===== Netflow ===== | ||
| ==== --create_netflow_filter ==== | ==== --create_netflow_filter ==== | ||
| - | (>= 5.0) | ||
| - | **オプションパラメーター: | + | **Required parameters**: |
| - | **説明:** Netflow フィルタを作成します。 | + | **必須パラメータ**: |
| - | 集約方法に指定可能なパラメータ: dstip, | + | * < new_filter_name > |
| - | 出力フォーマットに指定可能なパラメータ: | + | * < agent_group_name > |
| + | * < filter_as_such > | ||
| + | * < aggregated_by > One of the following values: '' | ||
| + | * < formato_de_salida > '' | ||
| - | **実行例:** | + | |
| + | | ||
| + | | ||
| + | * < 集約 > 次のいずれか: | ||
| + | | ||
| - | Netflow | + | **Optional parameters**: |
| + | |||
| + | **オプションパラメータ**: | ||
| + | |||
| + | **Description**: | ||
| + | |||
| + | **説明**: NetFlow® 経由で監視する新しいフィルターを作成します。 | ||
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage / | ||
| + | |||
| + | </ | ||
| - | perl pandora_manage.pl | + | <wrap #ks9 /> |
| ===== ツール ===== | ===== ツール ===== | ||
| ==== --exec_from_file ==== | ==== --exec_from_file ==== | ||
| - | (バージョン 5.0 以上) | ||
| - | **オプションパラメーター: | + | **Required parameters** (see case study): |
| - | **説明:** このオプションで、CSV ファイルから読み込んだマクロで CLI を実行します。マクロの数は、CSV ファイルのカラム数になります。それぞれのマクロは、__FIELD1__ , __FIELD2__ , __FIELD3__ といった形式になります。 | + | **必須パラメータ** (ケーススタディを参照してください): |
| - | **実行例: | + | |
| - | CSV ファイルから、ユーザを作成します。 | + | |
| - | 次のような CSV ファイルが必要です。 | + | * < 実行するコマンド > |
| + | * < 実行するコマンドのパラメータ > | ||
| - | <code> | + | **Description**: |
| - | User 1,Password 1,0 | + | |
| - | User 2,Password 2,0 | + | |
| - | User 3,Password 3,0 | + | |
| - | User Admin, | + | |
| - | </code> | + | |
| - | ファイル名は、'/ | + | **説明**: このオプションを使用すると、CSVファイルからマクロを使用して任意の PFMS CLI コマンドを実行できます。マクロの数は CSV ファイルの列数に対応します。各マクロは ''< |
| - | --create_user を次のオプションをつけて実行します。<ユーザ名> | + | <WRAP center round info 90%> |
| - | 次のように実行します。 | + | Commas in CSV columns are not yet supported. |
| - | perl pandora_manage.pl | + | </WRAP> |
| - | 注意: | + | <WRAP center round info 90%> |
| + | |||
| + | CSV 列内のカンマはまだサポートされていません。 | ||
| + | |||
| + | </ | ||
| + | |||
| + | **Case study**: | ||
| + | |||
| + | **ケーススタディ**: | ||
| + | |||
| + | Register users with the command [[# | ||
| + | |||
| + | CSV ファイル ''/ | ||
| + | |||
| + | < | ||
| + | User 1,Password 1,0 | ||
| + | User 2,Password 2,0 | ||
| + | User 3,Password 3,0 | ||
| + | User Admin, | ||
| + | |||
| + | </ | ||
| + | |||
| + | Sentence to be executed (line connectors are included for didactic purposes): | ||
| + | |||
| + | 実行される内容 (わかりやすいように複数行で書いています): | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage / | ||
| + | / | ||
| + | create_user \ | ||
| + | __FIELD1__ \ | ||
| + | __FIELD2__ \ | ||
| + | __FIELD3__ \ | ||
| + | ' | ||
| + | |||
| + | </ | ||
| ==== --create_snmp_trap ==== | ==== --create_snmp_trap ==== | ||
| - | **オプションパラメーター: | + | **Required parameters**: |
| - | **名前**: snmp トラップコンソールで表示されます。 | + | **必須パラメータ**: |
| - | **OID**: | + | |
| + | | ||
| + | | ||
| + | | ||
| - | **重要度**: 次の数値: 0(メンテナンス)、1(情報)、2(正常)、3(警告)、4(障害)、5(マイナー)、6(メジャー) | + | |
| + | | ||
| + | * < 説明 > | ||
| + | * < 重要度 | ||
| - | **実行例:** | + | **Description**: Creates a new SNMP trap definition. **A name must be entered, if an OID is repeated, the trap will not be created**. |
| - | perl pandora_manage.pl / | + | **説明**: 新しいSNMPトラップ定義を作成します。**名前を入力する必要があります。OIDが重複している場合、トラップは作成されません。** |
| + | |||
| + | **Example (see [[# | ||
| + | |||
| + | **例（[[# | ||
| + | |||
| + | <code bash> | ||
| + | pandora_manage / | ||
| + | |||
| + | </ | ||
| ==== --start_snmptrapd ==== | ==== --start_snmptrapd ==== | ||
| - | **Parameters: | + | **Parameters**: None. |
| + | |||
| + | **パラメータ**: | ||
| + | |||
| + | Starts the '' | ||
| - | **オプションパラメーター:** なし | + | [[: |
| - | Starts the '' | + | < |
| + | / | ||
| - | トラップサーバで '' | + | </file> |
| - | **Example:** | + | **Example |
| - | **実行例:** | + | **例（[[# |
| - | < | + | < |
| pandora_manage / | pandora_manage / | ||