差分
このページの2つのバージョン間の差分を表示します。
次のリビジョン | 前のリビジョン | ||
ja:documentation:pandorafms:technical_reference:03_anexo_cli [2023/11/15 04:37] – 作成 - 外部編集 127.0.0.1 | ja:documentation:pandorafms:technical_reference:03_anexo_cli [2024/03/31 06:29] (現在) – [--create_plugin_module] junichi | ||
---|---|---|---|
行 1: | 行 1: | ||
====== Pandora FMS のコマンドラインインタフェース (CLI) ====== | ====== Pandora FMS のコマンドラインインタフェース (CLI) ====== | ||
+ | |||
{{indexmenu_n> | {{indexmenu_n> | ||
行 129: | 行 130: | ||
==== --create_agent ==== | ==== --create_agent ==== | ||
- | **Mandatory | + | **Required |
- | **必須パラメータ:** | + | **必須パラメータ |
- | * < agent_name | + | |
- | * < operating_system> | + | * < operating system |
- | * It can be omitted by means of two single quotation marks together. | + | * < group name > Must match an existing OS (case insensitive) otherwise it will be registered without any group. |
- | * < group_name | + | * < server name > Be case sensitive, otherwise the value of the field will be left null //without |
- | * < server_name | + | |
- | * Be case sensitive, | + | |
- | * < エージェント名 > | + | * < エージェント名 > 名前がすでに存在する場合はエラーを返します。( < 別名を名前にする > を参照) |
* < OS > | * < OS > | ||
- | | + | |
- | * < グループ名 > | + | * < サーバ名> |
- | * < サーバ名> | + | |
- | * 大文字と小文字を区別します。//一致しないと、フィールド値は警告なしに null のままになります//。 **エージェントがサーバに割り当てられていることを確認してください。** | + | |
**Optional parameters: | **Optional parameters: | ||
行 151: | 行 148: | ||
**オプションパラメータ: | **オプションパラメータ: | ||
- | * < address | + | * < IP address |
- | * < description > | + | * < description > If you omit the description '' |
- | * If you omit the description | + | * < interval > In seconds, default value: 300. |
- | * < interval > | + | * < alias as name > The default value is '' |
- | * < alias as name > | + | |
* < IPアドレスまたは URL > | * < IPアドレスまたは URL > | ||
- | * < 説明 > | + | * < 説明 > 記述を省略した場合は |
- | * 説明を省略すると、'' | + | * < 間隔 > 秒単位、デフォルト値: |
- | * < 間隔 > | + | * < 別名を名前にする > デフォルト値は '' |
- | * < 別名を名前にする > | + | |
**Description: | **Description: | ||
行 167: | 行 162: | ||
**説明:** | **説明:** | ||
- | An agent with the name, the operating system, | + | An agent will be created |
- | 指定された名前、オペレーティングシステム、グループ名、サーバ名のエージェントを作成します。オプションで、アドレス(IPアドレスもしくはFQDN)、説明、間隔(単位は秒。デフォルトは300)を指定することもできます。 | + | 指定された名前、オペレーティングシステム、グループ名、サーバ名のエージェントを作成します。オプションで、アドレス (IP アドレスまたは名前)、説明、秒単位の間隔を指定できます。 |
- | The parameter < alias as name > is set to '' | + | **Example (see [[# |
- | < 別名を名前にする > はデフォルトで 1 に設定されます。この場合、別名はエージェント名と同じ値になります。ランダムに生成した値にしたい場合は、このパラメータを 0 に設定します。 | + | **例 ( [[# |
- | + | ||
- | **Example (see [[: | + | |
- | + | ||
- | **例 ( [[: | + | |
<code bash> | <code bash> | ||
行 183: | 行 174: | ||
'My agent' AIX Databases Central-Server \ | 'My agent' AIX Databases Central-Server \ | ||
192.168.12.123 'Agent description' | 192.168.12.123 'Agent description' | ||
- | |||
</ | </ | ||
行 1626: | 行 1616: | ||
- < warning_instructions > | - < warning_instructions > | ||
- < unknown_instructions > | - < unknown_instructions > | ||
- | - '' | + | - '' |
+ | - '' | ||
+ | - < 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. | ||
- < 説明 > | - < 説明 > | ||
行 1654: | 行 1646: | ||
- < 警告手順 > | - < 警告手順 > | ||
- < 不明手順 > | - < 不明手順 > | ||
- | - '' | + | - '' |
+ | - '' | ||
+ | - < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。 | ||
**Description: | **Description: | ||
行 1660: | 行 1654: | ||
**説明:** モジュール名、モジュールの種類、および作成されるエージェントの名前を指定して、エージェントにデータサーバモジュールを作成します。 必要に応じて、説明、モジュール グループなどを指定できます。 | **説明:** モジュール名、モジュールの種類、および作成されるエージェントの名前を指定して、エージェントにデータサーバモジュールを作成します。 必要に応じて、説明、モジュール グループなどを指定できます。 | ||
- | The module definition file will contain some like this: | + | The default values are '' |
- | モジュール定義ファイルには、次のような内容が記述されます。 | + | 最小値、最大値、データの保存、保存倍率のデフォルトは '' |
+ | |||
+ | **Example (see [[# | ||
+ | |||
+ | **例 ([[# | ||
+ | |||
+ | Simple example for state scaling: | ||
+ | |||
+ | 状態スケーリングの簡単な例: | ||
+ | |||
+ | <code bash> | ||
+ | pandora_manage / | ||
+ | </ | ||
+ | |||
+ | Complex example, the module definition file will contain something like this: | ||
+ | |||
+ | 複雑な例では、モジュール定義ファイルには次のような内容が含まれます。 | ||
< | < | ||
+ | |||
module_begin | module_begin | ||
module_name My module | module_name My module | ||
行 1673: | 行 1684: | ||
</ | </ | ||
- | The default values are '' | + | <code bash> |
- | + | ||
- | 最小値、最大値、データの保存、および保存倍率のデフォルト値は '' | + | |
- | + | ||
- | **Example (see [[: | + | |
- | + | ||
- | **例 ([[: | + | |
- | + | ||
- | <file> | + | |
pandora_manage / | pandora_manage / | ||
- | </file> | + | </code> |
<WRAP center round info 60%> | <WRAP center round info 60%> | ||
行 1701: | 行 1704: | ||
==== --create_web_module ==== | ==== --create_web_module ==== | ||
- | **オプションパラメータ: | + | **Required parameters**: |
+ | |||
+ | **必須パラメータ**: | ||
+ | |||
+ | | ||
+ | * < module_kind > | ||
+ | * < agent_name > | ||
+ | |||
+ | | ||
+ | * < モジュールの種類 > | ||
+ | * < エージェント名 > | ||
+ | |||
+ | **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 > | ||
+ | - < definition_file > | ||
+ | - < 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 > | ||
+ | - < '' | ||
+ | - < '' | ||
+ | - < 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. | ||
+ | |||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < | ||
+ | - < '' | ||
+ | - '' | ||
+ | - < 警告状態に留まる回数 | ||
+ | |||
+ | **Description: | ||
**説明:** 指定のモジュール名、モジュールの種類で、指定のエージェントに Webモジュールが作成されます。オプションで、説明、モジュールグループ、最小値、最大値、初期値、秒単位の間隔、警告の最小・最大値、障害の最小・最大値、保存データおよび、モジュール定義ファイルなどを指定できます。 | **説明:** 指定のモジュール名、モジュールの種類で、指定のエージェントに Webモジュールが作成されます。オプションで、説明、モジュールグループ、最小値、最大値、初期値、秒単位の間隔、警告の最小・最大値、障害の最小・最大値、保存データおよび、モジュール定義ファイルなどを指定できます。 | ||
- | モジュール定義ファイルは、次のような内容です。 | + | **Example (see [[# |
+ | |||
+ | **例 ([[# | ||
+ | |||
+ | Simple example for state scaling: | ||
+ | |||
+ | 状態スケーリングの簡単な例: | ||
+ | |||
+ | <code bash> | ||
+ | pandora_manage / | ||
+ | |||
+ | </ | ||
+ | |||
+ | As a complex example, the module definition file will contain something like this: | ||
+ | |||
+ | 複雑な例として、モジュール定義ファイルには次のような内容が含まれます。 | ||
< | < | ||
行 1711: | 行 1821: | ||
get http:// | get http:// | ||
task_end | task_end | ||
+ | |||
</ | </ | ||
- | **例:** | + | <code bash> |
+ | pandora_manage / | ||
- | perl pandora_manage.pl | + | </code> |
==== --create_network_module ==== | ==== --create_network_module ==== | ||
- | **オプションパラメーター: | ||
- | **説明:** | + | **Required parameters**: |
- | オプションパラメーターで指定したモジュール名、モジュールの種類、作成済みのエージェント名、指定されたアドレスでエージェントにネットワークモジュールを作成します。 | + | **必須パラメータ**: |
- | 最大値と最小値、保存データ、初期データのデフォルト値は0、間隔のデフォルト値は300です。 | + | * < module_name > |
+ | * < module_type > | ||
+ | * < agent_name > | ||
+ | * < module_address > | ||
- | ポート番号はオプションで、モジュールの種類がICMPの場合は必要ありません。他のタイプでは、必要であれば指定します。 | + | * < モジュール名 > |
+ | * < モジュールの種類 | ||
+ | * < エージェント名 > | ||
+ | * < アドレス > | ||
- | **注意:** | + | **Optional parameters**: |
- | 以下のパラメータは、Pandora バージョン 5 およびそれ以降のみです。 | + | **オプションパラメータ**: |
- | | + | |
- | 以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。 | + | * < module_port > numerical value between '' |
+ | * < description > | ||
+ | * < module_group > | ||
+ | * < min > | ||
+ | * < 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_treshold_warning > | ||
+ | * < ff_threshold_critical > | ||
+ | * < timeout > | ||
+ | * < retries > | ||
+ | * < critical_instructions > | ||
+ | * < warning_instructions > | ||
+ | * < unknown_instructions > | ||
+ | * < warning_inverse > | ||
+ | * < critical_inverse > | ||
+ | * '' | ||
+ | * '' | ||
+ | * < 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. | ||
+ | |||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
* < | * < | ||
* < | * < | ||
* < | * < | ||
* < | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < '' | ||
+ | * '' | ||
+ | * < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。 | ||
- | **実行例:** | + | **Description**: A network module will be created in an agent with the module name, module type, agent name where it will be created and the module address specified. Optionally, it can be given a port number, a description, |
- | perl pandora_manage.pl / | + | **説明**: ネットワークモジュールを、モジュール名、モジュール タイプ、作成先のエージェント名、および指定されたモジュール アドレスを使用してエージェント内に作成します。 オプションで、ポート番号、説明、最小値および最大値、保存倍率、秒単位の間隔、警告状態の最小および最大値、障害状態の最小および最大値、およびデータの保存を指定できます。 |
+ | |||
+ | The default values are '' | ||
+ | |||
+ | 最大値、最小値、保存データ、保存倍率のデフォルト値は '' | ||
+ | |||
+ | The port number is optional, since ICMP type modules do not require it. For all other types, a module must be specified. | ||
+ | |||
+ | ポート番号はオプションで、モジュールの種類がICMPの場合は必要ありません。他のタイプでは、必要であれば指定します。 | ||
+ | |||
+ | **Example (see [[# | ||
+ | |||
+ | **例 ([[# | ||
+ | |||
+ | Simple example for state scaling: | ||
+ | |||
+ | 状態スケーリングの簡単な例: | ||
+ | |||
+ | <code bash> | ||
+ | pandora_manage | ||
+ | </ | ||
+ | |||
+ | Another example: | ||
+ | |||
+ | 他の例: | ||
+ | |||
+ | <code bash> | ||
+ | pandora_manage | ||
+ | |||
+ | </ | ||
==== --create_network_component ==== | ==== --create_network_component ==== | ||
行 1783: | 行 1983: | ||
==== --create_snmp_module ==== | ==== --create_snmp_module ==== | ||
- | **Parameters:** < | + | **Required parameters**: |
- | **オプションパラメーター:** < | + | **必須パラメータ**: |
+ | |||
+ | | ||
+ | * < module_type > | ||
+ | * < agent_name > | ||
+ | * < module_address > | ||
+ | * < module_port > | ||
+ | * < version > | ||
+ | |||
+ | | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | |||
+ | **Optional parameters**: | ||
+ | |||
+ | **オプションパラメータ**: | ||
+ | |||
+ | * < community > | ||
+ | * < oid > | ||
+ | * < description > | ||
+ | * < module_group > | ||
+ | * < 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_auth_pass > | ||
+ | * < ff_threshold> | ||
+ | * < warning_str > | ||
+ | * < critical_str > | ||
+ | * < unknown_events > | ||
+ | * < each_ff > | ||
+ | * < ff_threshold_normal > | ||
+ | * < ff_threshold_warning > | ||
+ | * < ff_threshold_critical > | ||
+ | * < timeout > | ||
+ | * < retries > | ||
+ | * '' | ||
+ | * '' | ||
+ | * < critical_instructions > | ||
+ | * < warning_instructions > | ||
+ | * < unknown_instructions > | ||
+ | * < warning_inverse > | ||
+ | * < critical_inverse > | ||
+ | * < 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. | ||
+ | |||
+ | * < | ||
+ | * <oid> | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * <保存倍率> | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * '' | ||
+ | * '' | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。 | ||
+ | |||
+ | **Description**: | ||
**説明:** エージェントに指定したモジュール名モジュールのタイプで、アドレス、ポート番号、SNMP バージョンを指定した snmp のモジュールが作成されます。オプションで、コミュニティ、OID、説明、モジュールグループ、最小および最大値、初期データ、秒単位の間隔、障害と判断する最小および最大値、保存データ、また、snmp3 のメソッドやパスワードなどを指定できます。 | **説明:** エージェントに指定したモジュール名モジュールのタイプで、アドレス、ポート番号、SNMP バージョンを指定した snmp のモジュールが作成されます。オプションで、コミュニティ、OID、説明、モジュールグループ、最小および最大値、初期データ、秒単位の間隔、障害と判断する最小および最大値、保存データ、また、snmp3 のメソッドやパスワードなどを指定できます。 | ||
- | 最小、最大、保存データおよび、初期データのデフォルト値は | + | The default values are '' |
- | **実行例: | + | 最小、最大、データの保存および、保存倍率のデフォルト値は '' |
- | < | + | **Example (see [[# |
- | perl pandora_manage.pl / | + | |
+ | **例 ([[# | ||
+ | |||
+ | Simple example for state scaling: | ||
+ | |||
+ | 状態スケーリングの簡単な例: | ||
+ | |||
+ | < | ||
+ | pandora_manage | ||
+ | </ | ||
+ | |||
+ | Another example: | ||
+ | |||
+ | 他の例: | ||
+ | |||
+ | <code bash> | ||
+ | pandora_manage | ||
</ | </ | ||
行 1800: | 行 2112: | ||
==== --create_plugin_module ==== | ==== --create_plugin_module ==== | ||
- | **オプションパラメーター: | + | **Required parameters**: |
- | **説明:** アドレス、関連するポート、プラグイン名を指定して、エージェントにプラグインモジュールを作成します。オプションで、説明、モジュールグループ、最小および最大値、初期データ、秒単位の間隔、警告と判断する最小および最大値、障害と判断する最小および最大値、保存データを指定できます。 | + | **必須パラメータ**: |
- | 最小、最大、保存データおよび初期データのデフォルトは 0で、間隔は 300 です。 | + | * < module_name > |
+ | * < module_type > | ||
+ | * < agent_name > | ||
+ | * < module_address > | ||
+ | * < module_port > numerical value between '' | ||
+ | * < plugin_name > | ||
+ | * < user > | ||
+ | * < password > | ||
+ | * < parameters > | ||
- | **注意:** | + | |
+ | | ||
+ | | ||
+ | | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
- | 以下のパラメータは、Pandora バージョン 5 およびそれ以降のみです。 | + | **Parámetros opcionales**: |
- | | + | |
- | 以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。 | + | **オプションパラメータ**: |
+ | |||
+ | * < description > | ||
+ | * < module_group > | ||
+ | * < min > | ||
+ | * < 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_treshold_warning > | ||
+ | * < ff_threshold_critical > | ||
+ | * < timeout > | ||
+ | * < critical_instructions > | ||
+ | * < warning_instructions > | ||
+ | * < unknown_instructions > | ||
+ | * < warning_inverse > | ||
+ | * < critical_inverse > | ||
+ | * '' | ||
+ | * '' | ||
+ | * < 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. | ||
+ | |||
+ | * < | ||
+ | * <モジュールグループ> | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
* < | * < | ||
* < | * < | ||
* < | * < | ||
* < | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * '' | ||
+ | * '' | ||
+ | * < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。 | ||
- | **実行例:** | + | **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, |
- | perl pandora_manage.pl / | + | **説明**: // |
+ | |||
+ | The default values are '' | ||
+ | |||
+ | 最小、最大、データの保存および保存倍率のデフォルトは '' | ||
+ | |||
+ | **Example (see [[# | ||
+ | |||
+ | **例 ([[# | ||
+ | |||
+ | Simple example for state scaling: | ||
+ | |||
+ | 状態スケーリングの簡単な例: | ||
+ | |||
+ | <code bash> | ||
+ | pandora_manage | ||
+ | |||
+ | </ | ||
+ | |||
+ | Another example: | ||
+ | |||
+ | 他の例: | ||
+ | |||
+ | <code bash> | ||
+ | pandora_manage | ||
+ | |||
+ | </ | ||
==== --get_module_group ==== | ==== --get_module_group ==== |