Pandora:Documentation ja:Anexo CLI

From Pandora FMS Wiki

Jump to: navigation, search

Pandora FMS ドキュメント一覧に戻る

Contents

Pandora FMS CLI

Pandora FMS CLI(コマンドラインインタフェース)はコマンドラインから /util/pandora_manage.pl を実行することで利用できます。 コマンドラインインタフェースは特に自動化されたタスクにおいてサードパーティ製のアプリケーションとPandora FMSを統合する場合に便利です。 基本的には、パラメーターを指定して実行することで、エージェントやモジュールやユーザの作成・削除といった作業を行います。

コマンドラインインタフェースはPerlスクリプトなので、以下のように簡単に実行することができます。

perl pandora_manage.pl <pandora_server.confをフルパスで指定> <オプション> <オプションのパラメーター>

Template warning.png

Enterprise版ユーザの方は、.pl の代わりにバイナリ実行ファイルを利用する必要があります。.pl ではいくつかの Enterprise 版の機能が動作しません。pandora_manage を実行してください。

 


Enterprise 版のみ:

pandora_manage <pandora_server.conf パス> <オプション> <オプションパラメータ>

Pandora FMS コマンドラインインタフェースには以下のオプションを指定できます:

  • エージェント
    • --create_agent: エージェントを作成
    • --update_agent: エージェントのフィールドを更新
    • --delete_agent: エージェントを削除
    • --disable_group: あるグループ内のすべてのエージェントを無効化
    • --enable_group: あるグループ内のすべてのエージェントを有効化
    • --create_group: グループを作成
    • --delete_group: グループを削除
    • --update_group: グループを更新
    • --stop_downtime: 計画停止を停止
    • --get_agent_group: 指定したエージェントのグループ名を取得
    • --get_agent_modules: 指定したエージェントのモジュール一覧を取得
    • --get_agents: フィルタパラメータにてエージェントの一覧を取得
    • --delete_conf_file: 指定したエージェントのローカル設定を削除
    • --clean_conf_file: 指定したエージェントの設定から全モジュール、ポリシー、コレクションを削除
    • --get_bad_conf_files: 不正な設定ファイルを取得(必須設定を除く)
  • モジュール
    • --create_data_module: エージェントにデータモジュールを追加
    • --create_web_module: エージェントに Webモジュールを追加
    • --create_network_module: エージェントにネットワークモジュールを追加
    • --create_snmp_module: エージェントに SNMP モジュールを追加
    • --create_plugin_module: エージェントにプラグインモジュールを追加
    • --delete_module: エージェントからモジュールを削除
    • --data_module: モジュールにデータを追加
    • --get_module_data: 直近の X 秒間のモジュールデータを CSV フォーマットで表示
    • --get_module_id: Show id from one module.
    • --delete_data 収集データ、エージェントのモジュール、または、グループのエージェントモジュールを削除
    • --update_module: モジュールのフィールドを更新
  • アラート
    • --create_template_module: エージェントにアラートテンプレートを追加
    • --delete_template_module: エージェントからアラートテンプレートを削除
    • --create_template_action: エージェントにアクションを作成
    • --delete_template_action: エージェントからアクションを削除
    • --disable_alerts: すべてグループ内のアラートを無効化
    • --enable_alerts: すべてグループ内のアラートを有効化
    • --create_alert_template: アラートテンプレートの作成
    • --delete_alert_template: アラートテンプレートの削除
    • --update_alert_template: アラートテンプレートのフィールド更新
    • --validate_all_alerts: 全アラートの承諾
  • ユーザ
    • --create_user: ユーザの作成
    • --delete_user: ユーザの削除
    • --update_user: ユーザのフィールド更新
    • --enable_user: ユーザを有効化
    • --disable_user: ユーザを無効化
    • --add_profile: ユーザにプロファイルを追加
    • --create_profile: Create a new profile
    • --delete_profile: ユーザからプロファイルを削除
    • --add_profile_to_user: グループ内のユーザへのプロファイルの追加
    • --disable_eacl: Enterprise ACL の無効化
    • --enable_eacl: Enterprise ACL の有効化
  • イベント
    • --create_event: イベントの作成
    • --validate_event: イベントの承諾
    • --validate_event_id: 指定したイベントIDのイベントの承諾
    • --get_event_info:指定したイベントIDのイベント情報の表示
  • インシデント
    • --create_incident インシデントの作成
  • ポリシー
    • --apply_policy: ポリシーの強制適用
    • --apply_all_policies: 全てのポリシーへの適用
    • --add_agent_to_policy: ポリシーにエージェントを追加
    • --delete_not_policy_modules 設定ファイルからポリシーに割り当てられていないモジュールを削除
    • --disable_policy_alerts: ポリシーから全てのアラートを無効化
    • --create_policy_data_module: ポリシーデータモジュールの作成
    • --create_policy_web_module_from_local_component: ローカルコンポーネントからの Webモジュールをポリシーに作成
    • --create_policy_network_module: ポリシーネットワークモジュールの作成
    • --create_policy_snmp_module: ポリシー SNMP モジュールの作成
    • --create_policy_plugin_module: ポリシープラグインモジュールの作成
    • --validate_policy_alerts: 指定したポリシーの全アラートの承諾
    • --get_policy_modules: ポリシーのモジュール一覧の取得
    • --get_policies: 全てのポリシーの取得(パラメータ無しの場合)または、指定したエージェントのポリシーの取得(パラメータにエージェント名を指定した場合)
  • ツール
    • --exec_from_file: CSV ファイルからマクロを読み込んで CLI を実行する

エージェント

--create_agent

オプションパラメーター: <エージェント名> <オペレーティングシステム> <グループ名> <サーバ名> [<アドレス> <説明> <間隔>]

説明: オプションパラメーターで指定された名前、オペレーティングシステム、グループ名、サーバ名のエージェントを作成します。オプションで、アドレス(IPアドレスもしくはFQDN)、説明、間隔(単位は秒。デフォルトは300)を指定することもできます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_agent 'My agent' Windows Databases Central-Server 192.168.12.123 'Agent description' 600

--update_agent

(バージョン 5.0 以上)

オプションパラメーター: <エージェント名> <フィールド> <新たな値>

説明: 指定したエージェントのフィールドを更新します。フィールドに設定可能な値は、agent_name, address, description, group_name, interval, os_name, disabled, parent_name, cascade_protection, icon_path, update_gis_data, custom_id です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_agent 'Agent name' group_name 'Network'

--delete_agent

オプションパラメーター: <エージェント名>

説明: オプションパラメーターで指定されたエージェントを削除します

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_agent 'My agent'

--disable_group

オプションパラメーター: <グループ名>

説明: オプションパラメーターで指定されたグループのエージェントが無効化されます。グループ名に'All'を指定した場合、すべてのグループのエージェントが無効化されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_group Firewalls

--enable_group

オプションパラメーター: <グループ名>

説明: オプションパラメーターで指定されたグループのエージェントが有効化されます。グループ名に'All'を指定すると、すべてのグループのエージェントが有効化されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_group All

--create_group

オプションパラメーター: <グループ名> [<親グループ名> <アイコン> <説明>]

説明: 新たなグループを作成します。オプションで、親グループ、アイコン、説明を指定できます。アイコンは、拡張子を除いたファイル名で指定します。親グループのデフォルトは「全て」、アイコンのデフォルトは空文字列(アイコン指定なし)です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_group 'New group' 'Parent group'

--delete_group

オプションパラメーター: <グループ名>

説明: グループ名で指定したグループを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_group 'New group'

--update_group

オプションパラメーター: <グループID> [<グループ名> <親グループ名> <アイコン> <説明>]

説明: グループIDで指定したグループを編集します(グループの ID は、get_agent group_id にて確認できます)。パラメータは名前で指定し、以降アイコンと説明を指定します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_group 18 'Test' 'Web' 'SpiderMan' 'Description'

--stop_downtime

(バージョン 5.0 以上)

オプションパラメーター: <計画停止名>

説明: 計画停止を停止します。計画停止が終了している場合は、メッセージを表示します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --show_downtime 'Downtime name'

--get_agent_group

(バージョン 5.0 以上)

オプションパラメーター: <エージェント名>

説明: 指定したエージェントのグループ名を取得します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group 'Agent name'

--get_agent_group_id

(>=5.1)

オプションパラメータ: <エージェント名>

説明: 指定したエージェントのグループIDを取得します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group 'Agent name'

--get_agent_modules

(バージョン 5.0 以上)

オプションパラメーター: <エージェント名>

説明: 指定したエージェントのモジュールリスト(id と名前)を取得します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_modules 'Agent name'

--get_agents

(バージョン 5.0 以上)

オプションパラメーター: [<グループ名> <OS名> <状態> <最大モジュール> <フィルター文字列> <ポリシー名>]

説明: オプションでフィルタを設定して、エージェントの一覧を取得します。

<状態> に指定できる値は、critical, warning, unknown, normal です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents 'Network' 'Linux' 'critical'   'Policy name'

--delete_conf_file

オプションパラメーター: <エージェント名>

説明: エージェントの設定ファイルを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_conf_file 'Agent name'

--clean_conf_file

オプションパラメーター: [<エージェント名>]

説明: 一つまたは全て(パラメータを指定しない場合)のエージェントの設定ファイルを、クリーンな状態(全てのモジュール、ポリシー、ファイルコレクションおよびコメント削除)にします。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --clean_conf_file 'Agent name'

--get_bad_conf_files

オプションパラメーター: なし

説明: 不正な設定ファイル一覧(server_ip,server_path,temporal,logfileを除く)を表示します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_bad_conf_files

--create_downtime

(>=5.1)

オプションパラメータ: <計画停止名> <説明> <開始日時> <終了日時> <グループID> <月> <火> <水> <木> <金> <土> <日> <定期開始時間> <定期終了時間> <定期開始日> <定期終了日> <計画停止のタイプ> <実行タイプ> <実行タイミングタイプ>

説明: 計画停止を作成します。pandora_server.conf 内に API の設定が必要です。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_downtime Testing Testing 05/07/2015 06/07/2015 0 1 1 1 1 1 1 1 17:06:00 19:06:00 1 31 quiet periodically weekly

--add_item_planned_downtime

(>=5.1)

オプションパラメータ: <計画停止ID> <エージェントID1,エージェントID2,エージェントID3...エージェントIDn> <モジュール名1,モジュール名2,モジュール名3...モジュール名n>

説明: 計画停止にアイテムを追加します。pandora_server.conf 内に API の設定が必要です。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_item_downtime 1 1 'Status','AvailableMemory'

--get_all_planned_downtimes

(>=5.1)

オプションパラメータ: <名前> [<グループID> <計画停止タイプ> <実行タイプ> <実行タイミングタイプ>]

説明: マッチした全計画停止一覧を出力します。

例: perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_all_planned_downtimes testing 0

--planned_downtimes_items

(>=5.1)

オプションパラメータ: <名前> [<グループID> <計画停止タイプ> <実行タイプ> <実行タイミングタイプ>]

説明: マッチした計画停止のアイテム一覧を出力します。

例: perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_planned_downtimes_items testing 0

--set_planned_downtimes_deleted

(>=5.1)

オプションパラメータ: <名前>

説明: 計画停止を削除します。

例: perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted test

モジュール

--create_data_module

オプションパラメーター: <モジュール名> <モジュールの種類> <エージェント名> [<説明> <モジュールグループ> <最小値> <最大値> <初期データ> <間隔> <警告状態の最小値> <警告状態の最大値> <障害状態の最小値> <障害状態の最大値> <保存データ> <定義ファイル> <警告文字列> <障害文字列> <不明イベントの有効化> <連続抑制回数> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <連続抑制タイムアウト> <連続抑制タイムアウト> <障害手順> <警告手順> <不明手順>]

説明: オプションパラメーターで指定したモジュール名、モジュールの種類、作成済みのエージェント名を使用して、エージェントにデータモジュールを作成します。オプションで説明、モジュールグループ、最小値と最大値、初期データ、間隔(単位は秒)、警告状態の最大値と最小値、障害状態の最大値と最小値、保存データ、モジュール定義ファイルを指定することができます。

モジュール定義ファイルは以下のように記述されます:

module_begin
module_name My module
module_type generic_data
module_exec cat /proc/meminfo  | grep MemFree | awk '{ print $2 }'
module_end

保存データ、初期データ、最大値と最小値のデフォルト値は0で、間隔のデフォルト値は300です。

注意:

以下のパラメータは、Pandora バージョン 5 およびそれ以降のみです。

  • <不明イベントの有効化>

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <連続抑制回数>
  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>
  • <連続抑制タイムアウト>

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module 'My module' generic_data 'My agent' 'module description' 'General' 1 3 0 300 0 0 0 0 1 /home/user/filedefinition

オプションパラメーターと定義ファイルでモジュール名やモジュールの種類が異なった場合は、定義ファイル中の値が優先されます。

--create_web_module

オプションパラメータ: <モジュール名> <モジュールの種類> <エージェント名> [<説明> <モジュールグループ> <最小値> <最大値> <初期データ> <間隔> <警告状態の最小値> <警告状態の最大値> <障害状態の最小値> <障害状態の最大値> <保存データ> <定義ファイル> <警告文字列> <障害文字列> <不明イベントの有効化> <連続抑制回数> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <連続抑制タイムアウト> <障害手順> <警告手順> <不明手順>]

説明: 指定のモジュール名、モジュールの種類で、指定のエージェントに Webモジュールが作成されます。オプションで、説明、モジュールグループ、最小値、最大値、初期値、秒単位の間隔、警告の最小・最大値、障害の最小・最大値、保存データおよび、モジュール定義ファイルなどを指定できます。

モジュール定義ファイルは、次のような内容です。

task_begin
get http://pandorafms.com
task_end

最小と最大値、保存データおよび、初期値のデフォルトは 0です。また間隔のデフォルトは 300です。

注意:

以下のパラメータは、Pandora バージョン 5以降でのみ利用可能です。

  • <不明イベントの有効化>

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <連続抑制回数>
  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>
  • <連続抑制タイムアウト>


例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_web_module 'My module' web_data 'My agent' 'module description' 'General' 1 3 0 300 0 0 0 0 1 /home/user/filedefinition 'string for warning' 'string for critical' 

パラメータと定義ファイルで異なる指定をすると、ファイルの方が優先されます。

--create_network_module

オプションパラメーター: <モジュール名> <モジュールの種類> <エージェント名> <アドレス> [<ポート番号> <説明> <モジュールグループ> <最小値> <最大値> <初期データ> <間隔> <警告状態の最小値> <警告状態の最大値> <障害状態の最小値> <警告状態の最大値> <データの保存> <連続抑制回数> <警告文字列> <障害文字列> <不明イベントの有効化> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <障害手順> <警告手順> <不明手順>]

説明:

オプションパラメーターで指定したモジュール名、モジュールの種類、作成済みのエージェント名、指定されたアドレスでエージェントにネットワークモジュールを作成します。

最大値と最小値、保存データ、初期データのデフォルト値は0、間隔のデフォルト値は300です。

ポート番号はオプションで、モジュールの種類がICMPの場合は必要ありません。他のタイプでは、必要であれば指定します。

注意:

以下のパラメータは、Pandora バージョン 5 およびそれ以降のみです。

  • <不明イベントの有効化>

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module 'My module' remote_tcp 'My agent' 192.168.12.123 8080 'Module description' 'General' 1 3 0 300 0 0 0 0 1

--create_snmp_module

オプションパラメーター: <モジュール名> <モジュールの種類> <エージェント名> <アドレス> <ポート番号> <SNMPバージョン> [<SNMPコミュニティ名> <oid> <説明> <モジュールグループ> <最小値> <最大値> <初期データ> <間隔> <警告状態の最小値> <警告状態の最大値> <障害状態の最小値> <障害状態の最大値> <データの保存> <SNMPv3の暗号化方式> <SNMPv3の暗号化パスワード> <SNMPv3のセキュリティレベル> <SNMPv3の認証方式> <SNMPv3の認証ユーザ> <SNMPv3のの認証パスワード> <連続抑制回数> <警告文字列> <障害文字列> <不明イベントの有効化> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <障害手順> <警告手順> <不明手順>]

説明: エージェントに指定したモジュール名モジュールのタイプで、アドレス、ポート番号、SNMP バージョンを指定した snmp のモジュールが作成されます。オプションで、コミュニティ、OID、説明、モジュールグループ、最小および最大値、初期データ、秒単位の間隔、障害と判断する最小および最大値、保存データ、また、snmp3 のメソッドやパスワードなどを指定できます。

最小、最大、保存データおよび、初期データのデフォルト値は 0 で、間隔は 300です。

注意:

以下のパラメータは、Pandora バージョン 5 およびそれ以降のみです。

  • <不明イベントの有効化>

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_module 'My module' remote_snmp_inc 'My agent' 192.168.12.123 8080 1 mycommunity myoid 'Module description'

--create_plugin_module

オプションパラメーター: <モジュール名> <モジュールの種類> <エージェント名> <アドレス> <ポート番号> <プラグイン名> <ユーザ> <パスワード> <パラメーター> [<説明> <モジュールグループ> <最小値> <最大値> <初期データ> <間隔> <警告状態の最小値> <警告状態の最大値> <障害状態の最小値> <障害状態の最大値> <データの保存> <連続抑制回数> <警告文字列> <障害文字列> <不明イベントの有効化> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <障害手順> <警告手順> <不明手順>]

説明: アドレス、関連するポート、プラグイン名を指定して、エージェントにプラグインモジュールを作成します。オプションで、説明、モジュールグループ、最小および最大値、初期データ、秒単位の間隔、警告と判断する最小および最大値、障害と判断する最小および最大値、保存データを指定できます。

最小、最大、保存データおよび初期データのデフォルトは 0で、間隔は 300 です。

注意:

以下のパラメータは、Pandora バージョン 5 およびそれ以降のみです。

  • <不明イベントの有効化>

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>

実行例:

perl pandora_manage.pl /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

--create_module_group

オプションパラメータ: <モジュールグループ名>

説明: "モジュールグループ名" で指定した名前でモジュールグループを作成します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_module_group 'My module group'

--create_synthetic

オプションパラメータ: <モジュール名> <統合タイプ> <エージェント名> <オプション>

ここで、<統合タイプ> は、"arithmetic" または "average" です。

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent <オプション>
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent <オプション>

<オプション> に利用可能なパラメータは以下の通りです。

  • <オプション> = <source_agent1>,<operator>,<source_module1> <source_agent2>,<operator>,<source_module2>
  • <オプション> = <source_agent1>,<operator>,<source_module1> <operator>,<fixed_value>

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent my_agent,+,my_module my_agent2,-,my_module2
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent my_agent,+,my_module *,10
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent my_agent,x,my_module my_agent,x,my_module2

最初の例では、example_agent というエージェントで、example_module という名前の arithmetic タイプモジュールを作成します。これは、my_module - my_module2 の結果を扱います。 2つ目の例では、example_agent というエージェントで、example_module という名前の arithmetic タイプモジュールを作成します。これは、my_module * 10 の結果を扱います。 3つ目の例ででは、example_agent というエージェントで、example_module という名前の average タイプモジュールを作成します。これは、my_modulemy_module2 の平均値を扱います。

最初の演算子(上記の例でいうところの my_agentmy_module の間の +)は無視され計算には利用されませんが、ツールの内部構造上必要です。次の 2つ目の演算子が統合モジュールの動作をさせるためにとても重要です。上記の例では、my_agent2my_module2 の間または、右側の 10 という値の前にある "-" または "*" です。 設定可能な演算子は次の通りです。

  • + 足し算
  • - 引き算
  • * 掛け算
  • / 割り算
  • x 平均。この演算子は average タイプの場合のみ利用できます。

注意:

Pandora 5.1 SP4 およびそれ以上で利用できます。

例:

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic memory_sum arithmetic nodo51sp3 production1,+,AvailableMemory production2,+,AvailableMemory
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic traffic_difference arithmetic nodo51sp3 nodo51sp3,+,InputTraffic nodo51sp3,-,OutputTraffic

--delete_module

オプションパラメーター: <モジュール名> <エージェント名>

説明: オプションパラメーターで指定したモジュールをエージェントから削除します

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_module 'Mi modulo' 'Mi agente'

--data_module

オプションパラメーター: <サーバー名> <エージェント名> <モジュール名> <モジュールの種類> [<データ時間>]

説明: サーバ名、エージェント名、モジュール名、モジュールの種類を指定して、エージェントモジュールにデータを送信します。オプションで、24時間のフォーマット (YYYY-MM-DD HH:mm) でデータの時間を送信できます。このパラメータが指定されていない場合は、現在のデータが表示されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --data_module Servidor-General 'Mi agente' 'Mi modulo' 'generic_data' '2010-05-31 15:53'

--get_module_data

オプションパラメーター: <エージェント名> <モジュール名> <間隔> [<csvセパレータ>]

説明: 直近の X 秒間のモジュールのデータを CSV フォーマットで返します。デフォルトのセパレータは ';' です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_data 'agent name' 'module name' 86400 ':'

--get_module_id

オプションパラメータ: <エージェントID> <モジュール名>

説明: エージェントのモジュールIDが返ります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_id 4 'host alive'

--delete_data

オプションパラメーター: <モジュール名> <エージェント名> | -a <エージェント名> | -g <グループ名>

説明: モジュール名とエージェント名を指定し、保存データから該当モジュールの全データを削除します。'-a' オプションを指定した場合は、エージェントの全モジュールのデータを削除します。また、'-g' オプションとグループ名を指定した場合は、グループに属する全エージェントのモジュールのデータを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_data -a 'Mi agente'

この例では、'Mi agente' というエージェントの全てのモジュールのデータを削除します。

--update_module

オプションパラメーター: <モジュール名> <エージェント名> <更新フィールド> <新たな値>

説明: データモジュールの指定フィールドを更新します。モジュールタイプによって更新可能なフィールドは異なります。

設定可能なフィールドは次の通りです。

  • 共通: module_name, agent_name, description, module_group, min, max, post_process, history_data(データの保存), interval, warning_min, warning_max, critical_min, critical_max, warning_str, critical_str, ff_threshold(連続抑制回数), each_ff(個別状態変化の利用), ff_threshold_normal(正常移行時連続抑制回数), ff_threshold_warning(警告移行時連続抑制回数), ff_threshold_critical(障害移行時連続抑制回数). critical_instructions, warning_instructions, unknown_instructions
  • データサーバモジュール: ff_timeout(連続抑制タイムアウト)
  • ネットワークモジュール: module_address, module_port
  • SNMPモジュール: module_address, module_port, version, community, oid, snmp3_priv_method, snmp3_priv_pass, snmp3_sec_level, snmp3_auth_method, snmp3_auth_user, snmp3_priv_pass
  • プラグインモジュール: module_address, module_port, plugin_name, user, password, parameters

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_data_module 'Module name' 'Agent name' description 'New description'

--get_agents_module_current_data

(バージョン 5.0 以上)

オプションパラメータ: <モジュール名>

説明: 指定した名前でエージェントおよび現在の全モジュールのデータを取得します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_module_current_data 'Module name'

--create_network_module_from_component

(バージョン 5.0 以上)

オプションパラメータ: <エージェント名> <コンポーネント名>

説明: 指定したエージェントにネットワークコンポーネントから新たなネットワークモジュールを作成します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module_from_component 'Agent name'

--create_data_module_from_local_component

(バージョン 5.1 以上)

オプションパラメータ: <エージェント名> <コンポーネント名>

説明: 指定したエージェントにローカルコンポーネントから新たなデータモジュールを作成します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module_from_local_component 'Agent name' 'My local component'

--create_web_module_from_local_component

(バージョン 6.1 以上)

オプションパラメータ: <エージェント名> <コンポーネント名>

説明: ローカルコンポーネントから、指定のエージェントに新たな webモジュールを作成します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_web_module_from_local_component 'Agent name' 'My local component'

--create_local_component

(バージョン 5.1 以上)

オプションパラメータ: <コンポーネント名> <データ> [<説明> <OSのID> <OSバージョン> <ネットワークコンポーネントグループID> <タイプ> <最小> <最大> <モジュール間隔> <モジュールグループID> <データの保存> <警告最小値> <警告最大値> <警告文字列> <障害最小値> <障害最大値> <障害文字列> <連続抑制回数> <保存倍率> <ユニット> <ウィザードレベル> <障害手順> <警告手順> <不明手順> <障害反転> <警告反転> <カテゴリID> <不明イベント> <タグ> <正常時連続抑制回数> <傾向時連続抑制回数> <障害時連続抑制回数> <個別連続抑制回数の利用> <連続抑制タイムアウト>]

説明: 新たなローカルコンポーネントを作成します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_local_component 'New local component' 'module_begin\nmodule_name name\nmodule_type generic_data\nmodule_exec exec\nmodule_end'

アラート

--create_template_module

オプションパラメーター: <テンプレート名> <モジュール名> <エージェント名>

説明: オプションパラメーターで指定したテンプレート名、モジュール名、エージェント名に従って、テンプレートをエージェントモジュールに割り当てます

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_module plantilla001 'Mi modulo' 'Mi agente'

--delete_template_module

オプションパラメーター: <テンプレート名> <モジュール名> <エージェント名>

説明: パラメータにテンプレート名、モジュール名、エージェント名を指定して、エージェントのモジュールテンプレートを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_module plantilla001 'Mi modulo' 'Mi agente'

--create_template_action

オプションパラメーター: <アクション名> <テンプレート名> <モジュール名> <エージェント名> [<アラートの最小値> <アラートの最大値>]

説明: パラメータにアラートを構成するアクション名、テンプレート名、モジュール名、エージェント名を指定して、アラートにアクションを追加します。オプションで、アラートの最大と最小値(デフォルトは0)を指定することもできます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_action acción012 plantilla001 'Mi modulo' 'Mi agente' 0 4

--delete_template_action

オプションパラメーター: <アクション名> <テンプレート名> <モジュール名> <エージェント名>

説明: アラートを構成するアクション名、テンプレート名、モジュール名、エージェント名をパラメータに指定して、アラートに割り当てられたアクションを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_action acción012 plantilla001 'Mi modulo' 'Mi agente'

--disable_alerts

オプションパラメーター: なし

説明: すべてのアラートが無効化されます。一部のアラートを無効化している状態ですべてのアラートを有効化すると、無効化していた一部のアラートについても有効化されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_alerts

--enable_alerts

オプションパラメーター: なし

説明: すべてのアラートが有効化されます。一部のアラートを有効化している状態で、すべてのアラートを無効化すると、有効化していた一部のアラートについても無効化されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_alerts

--create_alert_template

オプションパラメーター: <テンプレート名> <連続状態タイプ> <開始時間> <終了時間> [<説明> <グループ名> <フィールド1> <フィールド2> <フィールド3> <優先度> <デフォルトアクション> <曜日> <時間閾値> <最小アラート数> <最大アラート数> <復旧アラート> <復旧フィールド2> <復旧フィールド3> <状態タイプセパレータ>]

説明: アラートテンプレートを作成します。

フィールド <連続状態タイプ> は、セパレータ(デフォルトでは ';')で分割されたテンプレートのオプションタイプです。セパレータは、オプションにデフォルトのセパレータ文字を含んでいる場合に競合するのを防ぐために、<状態タイプセパレータ> で変更することができます。

次のような設定が可能です。

注意: この例では、デフォルトのセパレータである ';' を利用しています。また、matches_value フィールドは、指定した値にマッチしたりマッチしなかったときにアラートが発生した場合にセットされるデータです。

  • 正規表現:
    • 書式: <type>;<matches_value>;<value>
    • : regex;1;stopped|error (正規表現 'stopped|error' にマッチした時にアラートが発生)
  • 最大と最小:
    • 書式: <type>;<matches_value>;<min_value>;<max_value>
    • : max_min;0;30;50 (値が 30-50 の範囲外になった時にアラートが発生)
  • 最大:
    • 書式: <type>;<max_value>
    • : max;70 (値が 70以上になった時にアラートが発生)
  • 最小:
    • 書式: <type>;<min_value>
    • : min;30 (値が 30未満になった時にアラートが発生)
  • 同じ値:
    • 書式: <type>;<value>
    • : equal;0 (値が 0 になった時にアラート発生)
  • 異なる値:
    • 書式: <type>;<value>
    • : not_equal;100 (値が 100以外になった時にアラート発生)
  • 警告状態:
    • 書式: <type>
    • : warning (警告状態になった時にアラート発生)
  • 障害状態:
    • 書式: <type>
    • : critical (障害状態になった時にアラート発生)
  • 不明状態:
    • 書式: <type>
    • : unknown (不明状態になった時にアラート発生)
  • 変化時:
    • 書式: <type>;<matches_value>
    • : onchange;1 (値が変化した時にアラート発生)
  • 常時:
    • 書式: <type>
    • : always (常にアラート発生)

フィールド <曜日> には、アラートが有効になる曜日をバイナリで指定します。例えば、0000011 であれば、土曜と日曜にアラートが有効になります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf.2011-10-25 --create_alert_template 'template name' "max_min@1@3@5" 09:00 18:00 "Email will be sended when the value is in the interval 3-5, between 9AM and 6PM, and only the Mondays. Separator is forced to @" "Unknown" "mail@mail.com" "subject" "message" 3 "Mail to XXX" 1000000 38600 1 2 0   @

--delete_alert_template

(バージョン 5.0 以上)

オプションパラメーター: <テンプレート名>

説明: アラートテンプレートを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_alert_template 'Template name'

--update_alert_template

(バージョン 5.0 以上)

オプションパラメーター: <テンプレート名> <更新フィールド> <新たな値>

説明: アラートテンプレートの指定したフィールドを更新します。指定可能なフィールドは、name, description, type, matches_value, value, min_value, max_value, time_threshold(0-1), time_from, time_to, monday(0-1), tuesday(0-1), wednesday(0-1), thursday(0-1), friday(0-1), saturday(0-1), sunday(0-1), min_alerts, max_alerts, recovery_notify(0-1), field1, field2, field3, recovery_field2, recovery_field3, priority(0-4), default_action, group_name です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_alert_template 'Template name' priority 4

--validate_all_alerts

(バージョン 5.0 以上)

オプションパラメーター: なし

説明: 全てのアラートを承諾します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_all_alerts

--create_special_day

(バージョン 5.1 以上)

オプションパラメーター: <特別日> <同一日> <説明> <グループ名>

説明: 特別日を設定します。same_day に設定可能なのは、monday, tuesday, wednesday, thursday, friday, saturday と sunday です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_special_day 2014-05-03 sunday Desc All

--delete_special_day

(バージョン 5.1 以上)

オプションパラメーター: <特別日>

説明: 指定した特別日を削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_special_day 2014-05-03

--update_special_day

(バージョン 5.1 以上)

オプションパラメーター: <特別日> <変更するフィールド> <新しい値>

説明: 指定した特別日の指定したフィールドの値を更新します。フィールドに指定できる値は、same_day, description と group_name です。same_day を指定した場合、新しい値に設定できるのは、monday, tuesday, wednesday, thursday, friday, saturday と sunday です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_special_day 2014-05-03 same_day monday

ユーザ

--create_user

オプションパラメーター: <ユーザー名> <パスワード> <管理者フラグ> [<コメント>]

説明: パラメータに指定したユーザ名およびパスワードでユーザを作成します。ユーザが管理者かそうでないかも指定します。オプションで作成するユーザのコメントも設定できます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user user002 'renardo' 0 'This user has renardo as password'

--delete_user

オプションパラメーター: <ユーザ名>

説明: 指定した名前のユーザを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_user usuario002

--update_user

(バージョン 5.0 以上)

オプションパラメーター: <ユーザID> <更新フィールド> <新しい値>

説明: ユーザの指定したフィールドの値を更新します。更新フィールドに指定できるのは、email, phone, is_admin (0-1), language, id_skin, flash_chart (0-1), comments, fullname, password です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'User Id' password 'New password'

--enable_user

(バージョン 5.0 以上)

オプションパラメーター: <ユーザID>

説明: ユーザを有効にします。すでに有効になっているユーザの場合は、メッセージの表示のみを行います。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_user 'User id'

--disable_user

(バージョン 5.0 以上)

オプションパラメーター: <ユーザID>

説明: ユーザを無効にします。すでに無効になっているユーザの場合は、メッセージ表示のみを行います。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'User id'

--create_profile

オプションパラメーター: <<プロファイル名> <インシデント表示> <インシデント編集> <いインシデント管理> <エージェント表示> <エージェント編集> <エージェント無効化> <アラート編集> <アラート管理> <ユーザ管理> <データベース管理> <イベント表示> <イベント編集> <イベント管理> <レポート表示> <レポート編集> <レポート管理> <マップ表示> <マップ編集> <マップ管理> <ビジュアルコンソール表示> <ビジュアルコンソール編集> <ビジュアルコンソール管理> <pandora管理>

説明: 指定したプロファイル名とパーミッションで新たなプロファイルを作成します。全フィールド必須です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_profile 'newProfile' 1 0 1 1 0 0 0 1 1 1 1 1 1 0 0 1 0 0 0 1 1 1 1

--add_profile

オプションパラメーター: <ユーザー名> <プロファイル名> <グループ>

説明: ユーザ名、プロファイル、プロファイルに権限を持つグループを指定し、ユーザにプロファイルを追加します。すべてのグループでプロファイルを設定したい場合は、グループに 'All' を指定します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile usuario002 'Group coordinator' All

--delete_profile

オプションパラメーター: <ユーザ名> <プロファイル名> <グループ>

説明: ユーザ名、プロファイルおよびプロファイルに権限を持ったグループを指定して、ユーザプロファイルを削除します。全てのグループでプロファイルを削除するには、グループに "All" を指定します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_profile usuario002 'Chief Operator' Applications

--add_profile_to_user

(バージョン 5.0 以上)

オプションパラメーター: <ユーザID> <プロファイル名> [<グループ名>]

説明: グループ内のユーザにプロファイルを割り当てます。グループを指定しなかった場合は、'全て'グループになります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'User Id' 'Chief Operator' 'Network'

--disable_aecl

オプションパラメーター: なし

説明: エンタープライズ ACL システムが無効化されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_eacl

--enable_aecl

オプションパラメーター: なし

説明: エンタープライズ ACL システムが有効化されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_eacl

--disable_double_auth

オプションパラメータ: <ユーザID>

説明: 特定ユーザに対して二段階認証を無効化します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_double_auth 'admin'

イベント

--create_event

オプションパラメーター: <イベント名> <イベントタイプ> <グループ名> [<エージェント名> <モジュール名> <イベントの状態> <重要度> <テンプレート名> <ユーザ名> <コメント> <ソース> <拡張ID> <tags> <custom_data>]

説明: イベント名、イベントの種類、エージェント名、モジュール名、グループ名を指定して、イベントを作成します。オプションで以下のイベントの状態を指定できます。

  • エージェント名
  • モジュール名
  • イベントの状態 (0で未承諾、1で承諾済)
  • 重要度 (1から4)
  • アラートに関連付けるテンプレート名
  • ユーザ名
  • コメント
  • ソース
  • 拡張ID
  • タグ: フォーマットは、<tag> <url>,<tag> <url>です。
    複数のタグをカンマ区切りで追加できます。
  • カスタムデータ: カスタムデータは JSON形式で入力する必要があります。たとえば、'{"Location": "Office", "Priority": 42}' です。

注意: イベントタイプは次のいずれかを指定できます: unknown, alert_fired, alert_recovered, alert_ceased, alert_manual_validation, recon_host_detected, system, error, new_agent, going_up_warning, going_up_criticalgoing_down_warning, going_down_normal, going_down_critical, going_up_normal, configuration_change

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_event ' CLI Event' system Firewalls 'My agent' 'My module' 0 4 Template004

--validate_event

オプションパラメーター: <エージェント名> <モジュール名> <開始日時> <終了日時> <ユーザ名> <重要度> <テンプレート名>

説明: フィルターにマッチする全イベントを承諾します。フィルタは、エージェント名、モジュール名、開始日時、終了日時、ユーザ名、重要度および、関連づけられたテンプレート名を指定できます。

パラメータは複数組み合わせることができます。利用しないパラメータは、カンマ('')だけを指定して空にします。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event 'Mi agente' 'Mi modulo' '' '2010-06-02 22:02'

この例では、'My agent' というエージェントの 'Mi module' というモジュールで、2010年6月2日 22:02 以前の全イベントを承諾します。2つの日時を指定するとその間のイベントのみを対象にすることができ、開始日時のみを指定すればそれ以降全てを指定することもできます。

--validate_event_id

(バージョン 5.0 以上)

オプションパラメーター: <イベントID>

説明: イベントを承諾します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event_id 1894

この例では、ID が 1894 のイベントを承諾します。

--get_event_info

(バージョン 5.0 以上)

オプションパラメーター: <イベントID> [<セパレータ>]

説明: 指定した ID のイベント情報を表示します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_event_info 1894

この例では、ID が 1894 のイベント情報を表示します。フィールドは | で分割されます。

--add_event_comment

(バージョン 5.1 以上)

オプションパラメーター: <イベントID> <ユーザ名> <コメント>

説明: イベントのコメントを追加します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_event_comment 1234 admin TEXT

この例では、ID が 1234 のイベントにコメント 'TEXT' を admin ユーザとして追加します。

インシデント

--create_incident

(バージョン 5.0 以上)

オプションパラメーター: <タイトル> <説明> <ソース> <状態> <優先度> <グループ> [<所有者>]

0: Active incident; 1: Active incident with comments; 2: Rejected incident ; 3: Expired incident; 13: Closed incident

説明: タイトル、説明、ソース、状態、優先度、グループおよび、オプションで所有者を指定して、インシデントを作成します。

優先度は、次の数値で指定します。

0:情報; 1:低い; 2:中間; 3:重要; 4:とても重要; 5:メンテナンス

状態は、次の数値で指定します。

0:有効なインシデント; 1:有効でコメント付きのインシデント; 2:却下したインシデント; 3:期限切れインシデント; 13:クローズしたインシデント

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_incident 'Incident' 'Incident Description' 'Other data source' 3 2 'id_owner_user'

ポリシー

--create_policy

オプションパラメータ: <ポリシー名> <グループ> <説明>

説明: 指定のポリシー名、グループ、説明で、ポリシーを作成します。"説明" は必須ではありません。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy 'My policy' 'My group' 'Description'

--apply_policy

オプションパラメーター: <ポリシー名>

説明: パラメータに指定したポリシーを強制的に割り当てます。ポリシーモジュールの作成は、ポリシー適用プロセスで扱われます。関連づけられたすべてのエージェントではまた、ポリシーアラートの作成は作成済モジュールで実施されます。さらに、変更はエージェントの設定ファイルに対して行われます。設定ファイルは、作成したモジュールおよびポリシーに関連付けられたコレクションを追加するためのポリシーを持つことができます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_policy 'Mi politica'

--apply_all_policies

(バージョン 5.0 以上)

オプションパラメーター: なし

説明: 全てのポリシーの適用をキューに入れます。サーバは、キューを確認しポリシーを適用します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_all_policies

--add_agent_to_policy

(バージョン 5.0 以上)

オプションパラメーター: <エージェント名> <ポリシー名>

説明: 作成済のポリシーに作成済のエージェントを追加します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_agent_to_policy 'Agent name' 'Policy name'

--add_collection_to_policy

オプションパラメータ: <ポリシー名> <コレクション名>

説明: 既存のコレクションを既存のポリシーに追加します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_collection_to_policy 'Policy name' 'Collection name'

--create_policy_data_module_from_local_component

オプションパラメータ: <ポリシー名> <コンポーネント名>

説明: ポリシーにローカルコンポーネントからモジュールを作成します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module_from_local_component 'Policy name' 'Component name'

--delete_not_policy_modules

オプションパラメーター: なし

説明: データベースおよびエージェント設定ファイル(存在する場合)から、ポリシーに属さない全モジュールを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_nor_policy_modules

--disable_policy_alerts

オプションパラメーター: <ポリシー名>

説明: パラメータで渡したポリシーの全アラートを無効にします。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_policy_alerts 'My policy'

--create_policy_data_module

(バージョン 5.0 以上)

オプションパラメーター: <ポリシー名> <モジュール名> <モジュールタイプ> [<説明> <モジュールグループ> <最小> <最大> <ポストプロセス> <間隔> <警告最小値> <警告最大値> <障害最小値> <障害最大値> <データ保存> <データ設定> <警告文字列> <障害文字列> <不明イベントの有効化> <連続抑制回数> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <連続抑制タイムアウト> <障害手順> <警告手順> <不明手順>]

説明: ポリシーデータモジュールを作成します。デフォルトの値は、--create_data_module オプションと同じです。

注意:

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <連続抑制回数>
  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>
  • <連続抑制タイムアウト>

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module 'policy name' 'module name' generic_proc 'module description' 'group name' 0 100 0 300 30 60 61 100 0 "module_begin\nmodule_name modname\nmodule_end" 'string for warning' 'string for critical'

--create_policy_network_module

(バージョン 5.0 以上)

オプションパラメーター: <ポリシー名> <モジュール名> <モジュールタイプ> [<モジュールポート> <説明> <モジュールグループ> <最小> <最大> <ポストプロセス> <間隔> <警告の最小値> <警告の最大値> <障害の最小値> <障害の最大値> <データ保存> <連続抑制回数> <警告文字列> <障害文字列> <不明イベントの有効化> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <障害手順> <警告手順> <不明手順>]

説明: ポリシーネットワークモジュールを作成します。デフォルトの値は、--create_network_module オプションと同じです。

注意:

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_network_module 'policy name' 'module name' remote_icmp_proc 22 'module description' 'group name' 0 100 0 300 30 60 61 100 0 0 'string for warning' 'string for critical'

--create_policy_snmp_module

(バージョン 5.0 以上)

オプションパラメーター: <ポリシー名> <モジュール名> <モジュールタイプ> <モジュールポート> <バージョン> [<コミュニティ> <OID> <説明> <モジュールグループ> <最小> <最大> <ポストプロセス> <間隔> <警告の最小値> <警告の最大値> <障害の最小値> <障害の最大値> <データの保存> <snmp3_priv_method> <snmp3_priv_pass> <snmp3_sec_level> <snmp3認証手法> <snmp3認証ユーザ> <snmp3_priv_pass> <連続抑制回数> <警告文字列> <障害文字列> <不明イベントの有効化> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <障害手順> <警告手順> <不明手順>]

説明: ポリシー SNMP モジュールを作成します。デフォルトの値は、--create_snmp_module オプションと同じです。

注意:

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_snmp_module 'policy name' 'module name' remote_snmp_inc 8080 1 mycommunity myoid 'Module description'

--create_policy_plugin_module

(バージョン 5.0 以上)

オプションパラメーター: <ポリシー名> <モジュール名> <モジュールの種類> <モジュールポート> <プラグイン名> <ユーザ> <パスワード> <パラメータ> [<説明> <モジュールグループ> <最小> <最大> <ポストプロセス> <間隔> <警告の最小値> <警告の最大値> <障害の最小値> <障害の最大値> <データの保存> <警告文字列> <障害文字列> <不明イベントの有効化> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連続抑制回数> <障害手順> <警告手順> <不明手順>]

説明: ポリシープラグインモジュールを作成します。デフォルトの値は、--create_plugin_module オプションと同じです。

注意:

以下のパラメータは、Pandora バージョン 5.1 およびそれ以降のみです。

  • <個別状態変化の利用>
  • <正常移行時連続抑制回数>
  • <警告移行時連続抑制回数>
  • <障害移行時連続抑制回数>

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_plugin_module 'policy name' 'module name' generic_data 22 myplugin myuser mypass 'param1 param2 param3' 'Module description' 'General' 1 3 0 300 0 0 0 0 1 'string for warning' 'string for critical'

--validate_policy_alerts

(バージョン 5.0 以上)

オプションパラメーター: <ポリシー名>

説明: 指定したポリシーの全アラートを承諾します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_policy_alerts 'Policy name'

--get_policy_modules

(バージョン 5.0 以上)

オプションパラメーター: <ポリシー名>

説明: 指定したポリシーのモジュールリスト(id と名前)を取得します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policy_modules 'Policy name'

--get_policies

(バージョン 5.0 以上)

オプションパラメーター: [<エージェント名>]

説明: 全てのポリシー(パラメータ無しの場合)または、指定したエージェントのポリシーを取得します(パラメータにエージェントを指定します)。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policies 'Agent name'

Netflow

--create_netflow_filter

(>=5.0)

オプションパラメーター: <ファイル名> <グループ名> <フィルター> <集約方法> <出力フォーマット>

説明: Netflow フィルタを作成します。

集約方法に指定可能なパラメータ: dstip,dstport,none,proto,srcip,srcport 出力フォーマットに指定可能なパラメータ: kilobytes,kilobytespersecond,megabytes,megabytespersecond

実行例:

Netflow フィルタを作成するには、次のコマンドを実行します。

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_netflow_filter "Filter name" Network "host 192.168.50.3 OR host 192.168.50.4 or HOST 192.168.50.6" dstport kilobytes

ツール

--exec_from_file

(バージョン 5.0 以上)

オプションパラメーター: <ファイルパス> <実行オプション> <オプションパラメータ>

説明: このオプションで、CSV ファイルから読み込んだマクロで CLI を実行します。マクロの数は、CSV ファイルのカラム数になります。それぞれのマクロは、__FIELD1__ , __FIELD2__ , __FIELD3__ といった形式になります。

実行例: CSV ファイルから、ユーザを作成します。

次のような CSV ファイルが必要です。

User 1,Password 1,0
User 2,Password 2,0
User 3,Password 3,0
User Admin,Password Admin,1

ファイル名は、'/tmp/users_csv' です。

--create_user を次のオプションをつけて実行します。<ユーザ名> <ユーザパスワード> <管理者フラグ> <コメント>

次のように実行します。

perl pandora_manage.pl /etc/pandora/pandora_server.conf --exec_from_file /tmp/users_csv create_user __FIELD1__ __FIELD2__ __FIELD3__ 'User created with exec_from_file option from CLI'

注意: CSV カラム内にカンマを含める操作には対応していません。

--create_snmp_trap

(バージョン 5.0 以上)

オプションパラメーター: <ファイルパス> <名前> <OID> <説明> <重要度>

名前: snmp トラップコンソールで表示されます。

OID: SNMP トラップのメイン OID。

重要度: 次の数値: 0(メンテナンス)、1(情報)、2(正常)、3(警告)、4(障害)、5(マイナー)、6(メジャー)

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_trap Cisco_FAN_Crash 1.3.3.3.2.12.3.3.4.1 "Something happen with the FAN inside the CISCO device, probably a failure" 3

グラフ

--create_custom_graph

オプションパラメータ: <名前> <説明> <ユーザ> <グループID> <幅> <高さ> <イベント> <グラフタイプ> <期間> <モジュール> <セパレータ>

説明 指定のパラメータでグラフを作成できます。すべてのパラメータ指定が必要ですが、シングルクォートで囲って空を指定することはできます。デフォルト値は次の通りです。

幅: 550, 高さ: 210, 期間 86400 (秒), イベント: 0, グラフタイプ: 0, グループID: 0

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_custom_graph 'My graph' 'Created by CLI' 'admin' 0 '' '' 0 2 '' '1;2;5;30' ';'

--edit_custom_graph

オプションパラメータ: <グラフID> <名前> <説明> <ユーザ> <グループID> <幅> <高さ> <イベント> <グラフタイプ> <期間>

説明: 指定の値でグラフを編集できます。すべてのパラメータ指定が必要ですが、シングルクォートで囲って空を指定することはできます。空を指定した場合は既存の値が保持されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_custom_graph 12 '' 'edit graph by CLI' '' '' '' '' '' '' 25200

--add_modules_to_graph

オプションパラメータ: <グラフID> <モジュール> <セパレータ>

説明: 指定のモジュールがグラフに追加されます。全パラメータを指定する必要があります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_modules_to_graph 12 '25,26' ','

--delete_modules_to_graph

オプションパラメータ: <グラフID> <モジュール> <セパレータ>

説明: 指定のモジュールがグラフから削除されます。全パラメータを指定する必要があります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_modules_to_graph 12 '1,25,26' ','

その他

--meta_get_agent_group

オプションパラメータ: <ホスト> <APIパスワード> <ユーザ> <パスワード> <エージェント名>

説明: エージェントグループ名を返します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group http://127.0.0.1/pandora_console 1234 admin pandora NAS

--meta_get_agent_group_id

オプションパラメータ: <ホスト> <APIパスワード> <ユーザ> <パスワード> <エージェント名)

説明: エージェントのグループIDを返します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group_id http://127.0.0.1/pandora_console 1234 admin pandora NAS

--meta_delete_agent

オプションパラメータ: <ホスト> <APIパスワード> <ユーザ> <パスワード> <エージェント名>

説明: メタコンソールおよびノード上のエージェントを削除します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_delete_agent http://127.0.0.1/pandora_console 1234 admin pandora NAS

--locate_agent

オプションパラメータ: <エージェント名>

説明: エージェントを管理しているノードIDを返します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --locate_agent NAS

--meta_set_create_group

オプションパラメータ: <ホストURL> <APIパスワード> <ユーザ> <パスワード> <グループ名> (<アイコン名> | "<アイコン名>|<親グループID>")

説明: グループを作成し、新たなグループIDを返します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group http://127.0.0.1/pandora_console 1234 admin pandora salamanca "world|14"
perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group http://127.0.0.1/pandora_console 1234 admin pandora salamanca world

ヘルプ

Pandora FMS コマンドラインインタフェースの一般的なヘルプは以下のコマンドで表示されます。

perl pandora_manage.pl --h

ある特定のオプションのヘルプを表示したい場合は、そのオプションをオプションパラメータなしで 指定(オプションパラメータをとるオプションの場合)して実行ことで表示されます。

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user