Pandora FMS のコマンドラインインタフェース (CLI)

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

Pandora FMS CLI(コマンドラインインタフェース)はコマンドラインから以下を実行することで利用できます。

/usr/share/pandora_server/util/pandora_manage.pl

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

オープンソース版:

コマンドラインインタフェースは Perl スクリプトで、次のように実行します。

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

バックスラッシュ \ で行をつなげます。

perl pandora_manage.pl \
    <pandora_server.conf path > \
    <option > \
    <option parameters > \
    [ optional parameters ]

Enterprise 版:

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

バックスラッシュ \ で行をつなげます。

pandora_manage \
    <pandora_server.conf path> \
    <option> \
    <option parameters> \
    [ optional parameters ]

• 必須またはオプションのすべてのパラメーターは、シングルクォーテーションで区切ることができます。
• クォーテーションは、パラメーターにスペースが含まれている場合に特に便利です。 例: 'My Agent'
• また、必須パラメータを省略する必要がある場合は、2 つのシングルクォーテーションを一緒に使用できます。 厳密に必要な場合は、[ERROR] Error: というメッセージが表示され、その後にエラーの説明が続きます。 オプションパラメータの場合、いくつかあり、2 番目または 3 番目などのみを指定する必要がある場合は、2 つのシングルクォーテーションを一緒に使用することにより、空のオプションパラメータを示します。
• いくつかのパラメータは大文字・小文字を区別します。それ以外は区別しません。 例えば、エージェント作成 の場合、Pandora FMS サーバの名前は厳密に同じでなければなりませんが、エージェントが属するプライマリグループの名前は 大文字・小文字で、いずれか一致すればそのグループが割り当てられます。
• コマンドラインの最後で use_alias パラメータを使用すると、エージェント名の代わりにエージェントの別名を使用できます。

Pandora FMS CLI の一般的なヘルプを表示するには、次のようにします。

perl pandora_manage.pl --h

1つの特定のオプションのヘルプを表示するには、そのオプションをパラメータなしで実 行するだけです(パラメータを使用するオプションの場合)。

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

必須パラメータ (書式):

• < エージェント名 > 名前がすでに存在する場合はエラーを返します。( < 別名を名前にする > を参照)
• < OS >
• < グループ名 > 登録済の OS と一致する必要があります (大文字と小文字は区別されません)。そうでない場合は、グループなしで登録されます。
• < サーバ名> 大文字と小文字を区別します。一致しないと、フィールド値は警告なしに null のままになります。 エージェントがサーバに割り当てられていることを確認してください。

オプションパラメータ:

• < IPアドレスまたは URL >
• < 説明 > 記述を省略した場合は Created by <サーバ名> が追加されます(指定したサーバの存在の有無に関係ありません)。
• < 間隔 > 秒単位、デフォルト値: 300。
• < 別名を名前にする > デフォルト値は 1 で、この値を使用すると、エージェントの別名はエージェント名と同じになります。名前をランダムに生成したい場合は、0 を使用します。

説明:

指定された名前、オペレーティングシステム、グループ名、サーバ名のエージェントを作成します。オプションで、アドレス (IP アドレスまたは名前)、説明、秒単位の間隔を指定できます。

例 ( 呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --create_agent \
    'My agent' AIX Databases Central-Server \
    192.168.12.123 'Agent description' '' 0

必須パラメータ:

• < エージェント名 >
• < フィールド >
• < 新たな値 >

オプションパラメータ:

• use_alias

説明: 指定したエージェントの単一のフィールドを更新します。フィールドに設定可能な値は次の通りです。

実行例:

pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' agent_name 'Agent 2'

pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' description 'New note' \
    use_alias

オプションパラメーター: <id_agent> <type_field> <field_to_change> <new_value>

1. id_agent → エージェントID
2. type_field → フィールドのタイプで、テキストの場合は 0、複数オプションお選択ボックスは 1 です。この例の場合、更新するオプションがあるかどうかをチェックし、存在する場合は変更し、存在しない場合はフィールドが一致しないというメッセージを返します。:
3. field_to_change → 更新するフィールドの名前
4. new_value → 更新するフィールドの値

説明: エージェントのカスタムフィールドを更新します。

次のような応答があります。

　* ERROR:

1. エージェントが存在しない場合。
2. フィールドが存在しない場合。
3. 選択ボックスの new_value が事前に設定したものと一致しない場合。
4. フィールドを更新できなかった場合。

• INFO:

1. Updating the X field with the agent id Y.
2. Correctly updated.

例:

テキストタイプ:

pandora_manage /etc/pandora/pandora_server.conf --agent_update_custom_fields 1 0 'Serial number' 'john'

選択肢タイプ:

pandora_manage /etc/pandora/pandora_server.conf --agent_update_custom_fields 1 1 'Names' 'john'

必須パラメータ:

• < エージェント名 >

オプションパラメータ:

• user_alias
  • エージェントの別名は繰り返すことができ、一度に複数のエージェントを削除できることに注意してください。

説明:

パラメータで名前または別名で指定されたエージェントを削除します。

実行例:

pandora_manage /etc/pandora/pandora_server.conf \
    --delete_agent 'My Agent' \
    use_alias

必須パラメータ:

• < グループ名 >

説明:

グループの全エージェントを無効化します。グループのエージェント は、このオプションの実行により無効になります。

実行例:

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

必須パラメータ:

• < グループ名 >

説明:

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

実行例:

pandora_manage /etc/pandora/pandora_server.conf --enable_group firewalls

必須パラメータ:

• < グループ名 >

オプションパラメータ:

• < 親グループ名 >
• < アイコン >
  • applications
  • application_osx
  • application_osx_terminal
  • bricks
  • chart_organisation
  • clock
  • computer
  • database
  • database_gear
  • docker
  • drive_network
  • email
  • eye
  • firewall
  • heart
  • house
  • images
  • lightning
  • lock
  • network
  • plugin
  • printer
  • server_database
  • transmit
  • vmware
  • without_group
  • world
• < 説明 >

説明:

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

実行例:

pandora_manage /etc/pandora/pandora_server.conf --create_group \
    'New group name' \
    Web computer 'New description.'

必須パラメータ:

• < グループ名 >

説明:

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

実行例:

pandora_manage /etc/pandora/pandora_server.conf –-delete_group 'Group name'

必須パラメータ:

• < グループID >

オプションパラメータ:

• < 修正するグループ名 >
• < 親グループ名 >
• < アイコン >
  • applications
  • application_osx
  • application_osx_terminal
  • bricks
  • chart_organisation
  • clock
  • computer
  • database
  • database_gear
  • docker
  • drive_network
  • email
  • eye
  • firewall
  • heart
  • house
  • images
  • lightning
  • lock
  • network
  • plugin
  • printer
  • server_database
  • transmit
  • vmware
  • without_group
  • world
• < 説明 >

説明: グループIDで指定したグループを編集します。指定可能なパラメータは次の通りです。

• グループ名
• 親グループ名
• アイコン (名前のみ、拡張子無し、上記のリストから選択します)
• 説明

実行例:

pandora_manage /etc/pandora/pandora_server.conf –update_group 18 \
    'Group name' 'Web' 'transmit' 'Description'

必須パラメータ:

• < 計画停止名 >

説明:

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

• [ERROR] Planned_downtime < downtime_name > cannot be stopped.
• [INFO] Planned_downtime < downtime_name > is already stopped.
• [INFO] Stopping planned downtime < downtime_name >

実行例:

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

必須パラメータ:

• < エージェント名 >

オプションパラメータ:

• use_agent_alias

説明: 名前または別名で特定のエージェントのステータスを取得します。

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_status 'agent name'

必須パラメータ:

• < エージェント名 >

オプションパラメータ:

• use_agent_alias

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

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_group 'agent_name'

必須パラメータ:

• < エージェント名 >

オプションパラメータ:

• use_agent_alias

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

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_group_id 'agent name'

必須パラメータ:

• < エージェント名 >

オプションパラメータ:

• use_agent_alias

説明: 名前や別名で指定されたエージェントのモジュール(カンマで区切られた ID と名前)を取得します。

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_modules 'agent name'

必須パラメータ: なし。以下でコマンドのヘルプを確認できます(呼び出し および 書式 を参照):

 pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' '' '' '' ''

パラメーターの数を超えている場合は、次の応答が返されます。

[ERROR] Parameters error: 8 received | 0-7 necessary.
 
Pandora FMS CLI 7.0NG.764 Build 220930 Copyright (c) 2013-2021 Artica ST
This program is Free Software, licensed under the terms of GPL License v2
You can download latest versions and documentation at http://www.pandorafms.org
 
[*] Pandora FMS Enterprise module loaded.
 
Available options for --get_agents:
 
        --get_agents [<group_name> <os_name> <status> <max_modules> <filter_substring> <policy_name> <use_alias>] : Get
          list of agents with optative filter parameters.

オプションパラメータ: 指定の順序通りの連続したパラメータでエージェントのリストをフィルタリングできます。パラメーターをスキップするには、2 つのシングルクォーテーションを使用します。 ここでは、わかりやすいように番号を付けています。

1. < グループ名 >
2. < OS 名 >
3. < 状態 > 指定可能な値: critical, warning, unknown, normal.
4. < モジュールの最大数 >
5. < キー文字列 > エージェント名(または、use_agent_alias を指定した場合は別名)でフィルタリングできます。
6. < ポリシー名 >
7. use_agent_alias

説明: すべてのエージェント(パラメータ無しの場合)またはフィルタしたエージェントを取得します。

例 (呼び出し および 書式 を参照):

• Network グループの全エージェントの取得:

pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Network' '' '' '' '' ''

• オペレーティングシステムが Linux の全エージェントを取得:

pandora_manage /etc/pandora/pandora_server.conf --get_agents '' 'Linux' '' '' '' ''

• normal (正常) 状態の全エージェントを取得:

pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' 'normal' '' '' ''

• モジュール数が 0 の(モジュールが無い)全エージェントを取得:

pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '0' '' ''

• Servers グループ内のモジュールが無い全エージェントを取得:

pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Servers' '' '' '0' '' ''

• 別名に test を含む全エージェントを取得:

pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' 'test' '' use_agent_alias

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

説明: 指定された別名に一致するエージェントの ID と別名を一覧表示します。 strict を使用すると、検索は正確な別名のみに制限されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_id_name_by_alias 'station'

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

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

実行例:

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

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

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

実行例:

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

パラメーター: なし

説明:

1. 正しく設定されていない設定ファイルが、メインの トークン を検索することによりリストされます。
   • server_ip
   • server_path
   • temporary
   • logfile
2. 開くことができない破損したファイルがある場合: [WARN] Can't open file < path_file >
3. 指定したパスにファイルが見つからなかった場合: [WARN] File not exist < path_file >
4. 設定ファイルが正しい場合 (最初のポイントの トークン に従って): [INFO] No bad files found

例:

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

出力例:

(>= 7.21) メタコンソールのみ

オプションパラメーター: [マイグレートするエージェントID][ソースノード名][移 行先ノード名][オプションパラメータ、デフォルトは 0 でヒストリDBも移行します。1 の場合は通常の DB のみ以降します]

説明: エージェントをあるノードから他のノードへ移動するために、マイグレーションキューへ追加します。メタコンソール用のコマンドです。正しく実行するためには、pandora_server.conf で API 設定パラメータが設定されている必要があります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent_queue 1 nodo1 nodo2 0

(>= 7.21) メタコンソールのみ

オプションパラメーター: [確認するエージェントのID]

説明: エージェントが、エージェントマイグレーションテーブル内に存在するかどうかを true または false で返します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent 1

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

説明: 計画停止を作成します。

例:

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

必須パラメータ

• < 計画停止ID >
• < エージェントID1,エージェントID2,エージェントID3,…,エージェントIDn >
• < モジュール名1,モジュール名2,モジュール名3,…,モジュール名n >

説明:

指定したデータに基づき、計画停止にレコードを追加します。エージェント ID のリストとモジュール名のリストは、各要素をカンマで区切りスペースを入れずに書きます。モジュール名にスペースが含まれている場合は、モジュール名を 2 つのシングルクォーテーションで囲みます。 2 つ以上のエージェントが渡された場合、デフォルトでは、共通モジュールを追加すると想定されます。それ以外の場合は、警告メッセージが表示されます。

例 (呼び出し and 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --add_item_downtime 1 1 Status,'Available Memory'

必須パラメータ:

• < 検索名 >

オプションパラメータ:

• < グループID >
• < 計画停止のタイプ >
  • quiet
  • disable_agents
  • disable_agents_alert
• < 実行タイプ >
  • once
  • periodically
• < 定期実行タイプ >
  • weekly
  • monthly

説明:

マッチした全計画停止一覧を出力します。計画停止 オプションを参照してください。

例:

pandora_manage /etc/pandora/pandora_server.conf --get_all_planned_downtimes ''

必須パラメータ

• < 検索する名前 >

オプションパラメータ

• < グループID >
• < 計画停止タイプ >
  • quiet
  • disable_agents
  • disable_agents_alert
• < 実行タイプ >
  • once
  • periodically
• < 実行タイミングタイプ >
  • weekly
  • monthly

説明:

マッチした計画停止のアイテム一覧を出力します。計画停止 オプションを参照してください。

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --get_planned_downtimes_items 'Name downtime'

必須パラメータ:

• < 計画停止ID >

説明:

指定した ID の計画停止を削除します。以下の応答があります。

This planned downtime is deleted

Problems with this planned downtime

The scheduled downtime is still being executed

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted 7

必須パラメータ:

• < エージェントID >
• メタコンソールの場合: < メタコンソール ID >、ノードの場合: 任意の値(考慮されません)

オプションパラメータ:

• < 値 > デフォルトは 1 でエージェント有効化、0 で無効化。

説明: エージェントを無効化し、リモート設定の場合はスタンバイモードに設定します。

例 (呼び出し および 書式 を参照):

• ノードからエージェントを有効化する例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1

• ノードからエージェントを無効化する例:

pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0

• メタコンソールからエージェントを有効化する例:

pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1

• メタコンソールからエージェントを無効化する例:

pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0

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

説明: 指定のエージェントのモジュールおよびエージェントカウントを同期します。すべてのエージェントを同期したい場合は、最初のパラメータを “All” にする必要があ ります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --reset_agent_counts "All"

必須パラメータ:

• < エージェントID >
• < 緯度 >
• < 経度 >
• < 高度 >

オプションパラメータ:

• なし

説明: エージェントの GIS データを更新します。

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --update_agent 1 2 3 4

必須パラメータ:

• < エージェントID >

オプションパラメータ:

• なし

説明: エージェントの GIS データを取得します。

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --get_gis_agent 1

必須パラメータ:

• < エージェントID >
• < オペレーティングシステムID >
• < オペレーティングシステムバージョン >

オプションパラメータ:

• なし。

説明: エージェントの オペレーティングシステム (およびそのバージョン) を追加または変更します。

例 (呼び出し および 書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --cli_agent_set_os 7 3 'Ubuntu 16.04'

必須パラメータ:

• < モジュール名 >
• < モジュールタイプ >
• < エージェント名 >

オプションパラメータ:

1. < 説明 >
2. < モジュールグループ >
3. < 最小値 >
4. < 最大値 >
5. < 保存倍率 >
6. < 間隔 >
7. < 警告状態の最小値 >
8. < 警告状態の最大値 >
9. < 障害状態の最小値 >
10. < 障害状態の最大値 >
11. < データの保存 >
12. < 定義ファイル >
13. < 警告文字列 >
14. < 障害文字列 >
15. < 不明イベントの有効化 >
16. < 連続抑制回数 >
17. < 個別状態変化の利用 >
18. < 正常移行時連続抑制回数 >
19. < 警告移行時連続抑制回数 >
20. < 障害移行時連続抑制回数 >
21. < 連続抑制タイムアウト >
22. < 警告の反転 >
23. < 障害の反転 >
24. < 障害手順 >
25. < 警告手順 >
26. < 不明手順 >
27. use_agent_alias エージェントの検索に、エージェント名の代わりにエージェントの別名を使用します。
28. ignore_unknown: 不明な状態の計算を行わず、モジュールがその状態に変更されることはなく、常に最後の既知の状態を保持します。
29. < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。

説明: モジュール名、モジュールの種類、および作成されるエージェントの名前を指定して、エージェントにデータサーバモジュールを作成します。 必要に応じて、説明、モジュール グループなどを指定できます。

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

例 (呼び出しおよび書式 を参照):

状態スケーリングの簡単な例:

pandora_manage /etc/pandora/pandora_server.conf --create_data_module data_module_test generic_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

複雑な例では、モジュール定義ファイルには次のような内容が含まれます。

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

pandora_manage /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/definition_file 'warning text' 'critical text'

必須パラメータ:

• < モジュール名 >
• < モジュールの種類 >
• < エージェント名 >

オプションパラメータ:

1. <説明>
2. <モジュールグループ>
3. <最小値>
4. <最大値>
5. <倍率>
6. <間隔>
7. <警告状態の最小値>
8. <警告状態の最大値>
9. <障害状態の最小値>
10. <障害状態の最大値>
11. <保存データ>
12. <再実行>
13. <リクエスト>
14. <エージェントブラウザID>
15. <認証サーバ>
16. <認証レルム>
17. <ファイル定義>
18. <プロキシURL>
19. <プロキシログイン名>
20. <プロキシパスワード>
21. <警告文字列>
22. <障害文字列>
23. <不明イベントの有効化>
24. <連続抑制回数>
25. <個別状態変化の利用>
26. <正常移行時連続抑制回数>
27. <警告移行時連続抑制回数>
28. <障害移行時連続抑制回数>
29. <連続抑制タイムアウト>
30. <警告判定の反転>
31. <障害判定の反転>
32. <障害手順>
33. <警告手順>
34. <不明手順>
35. < use_agent_alias >
36. ignore_unknown: 不明な状態の計算を行わず、モジュールがその状態に変更されることはなく、常に最後の既知の状態を保持します。
37. < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。

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

例 (呼び出しおよび書式 を参照):

状態スケーリングの簡単な例:

pandora_manage /etc/pandora/pandora_server.conf --create_web_module web_module_test web_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

複雑な例として、モジュール定義ファイルには次のような内容が含まれます。

task_begin
get http://pandorafms.com
task_end

pandora_manage /etc/pandora/pandora_server.conf --create_web_module 'module_name' web_data 'pandorafms' 'Module description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public /home/user/file_definition 'http://proxy.url' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warning_instructions' 'unknown_instructions'

必須パラメータ:

• < モジュール名 >
• < モジュールの種類 >
• < エージェント名 >
• < アドレス >

オプションパラメータ:

• <ポート番号> 1 から 65535 までの数値。
• <説明>
• <モジュールグループ>
• <最小値>
• <最大値>
• <保存倍率>
• <間隔>
• <警告状態の最小値>
• <警告状態の最大値>
• <障害状態の最小値>
• <障害状態の最大値>
• <データの保存>
• <連続抑制回数>
• <警告文字列>
• <障害文字列>
• <不明イベントの有効化>
• <個別状態変化の利用>
• <正常移行時連続抑制回数>
• <警告移行時連続抑制回数>
• <障害移行時連続抑制回数>
• <障害手順>
• <警告手順>
• <不明手順>
• <警告の反転>
• <障害の反転>
• <エージェントの別名の利用>
• < use_agent_alias > 名前ではなく別名でエージェントを検索します。
• ignore_unknown: 不明な状態の計算を行わず、モジュールがその状態に変更されることはなく、常に最後の既知の状態を保持します。
• < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。

説明: ネットワークモジュールを、モジュール名、モジュール タイプ、作成先のエージェント名、および指定されたモジュール アドレスを使用してエージェント内に作成します。 オプションで、ポート番号、説明、最小値および最大値、保存倍率、秒単位の間隔、警告状態の最小および最大値、障害状態の最小および最大値、およびデータの保存を指定できます。

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

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

例 (呼び出しおよび書式 を参照):

状態スケーリングの簡単な例:

pandora_manage /etc/pandora/pandora_server.conf --create_network_module net_module_test remote_tcp 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 "1" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

他の例:

pandora_manage /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

オプションパラメータ: <ネットワークコンポーネント名> <ネットワークコンポーネントグループ> <ネットワークコンポーネントタイプ> [<説明> <間隔> <最大値> <最小値> <SNMPコミュニティ> <モジュールグループID> <最大タイムアウト> <データの保存> < 警告状態の最小値> <警告状態の最大値> <警告状態の文字列> <障害状態の最小値> <障害状態の最大値> <障害状態の文字列> <連続抑制回数> <保存倍率> <不明イベント> <個別 状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回数> <障害移行時連 続抑制回数>]

説明:

ネットワークコンポーネントを作成します。オプションで、ポート、説明、最大および最小値、保存倍率、秒単位の間隔、警告状態の最小・最大値、障害状態の最小・最大値、データ保存の有無などを指定できます。

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

ポートはオプションです。ICMP モジュールでは不要です。その他は、設定をする必要が あります。

注意:

以下のパラメータは、Pandora バージョン 5 以降にあります。

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

以下のパラメータは、Pandora バージョン 5.1 以降にあります。

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

実行例:

perl /tmp/pandorafms/pandora_server/util/pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_component "example_name" 2 7

必須パラメータ:

• <モジュール名>
• <モジュールタイプ>
• <エージェント名>
• <アドレス>
• <ポート番号>
• <SNMPバージョン>

オプションパラメータ:

• <SNMPコミュニティ名>
• <oid>
• <説明>
• <モジュールグループ>
• <最小値>
• <最大値>
• <保存倍率>
• <間隔>
• <警告状態の最小値>
• <警告状態の最大値>
• <障害状態の最小値>
• <障害状態の最大値>
• <データの保存>
• <SNMPv3の暗号化方式>
• <SNMPv3の暗号化パスワード>
• <SNMPv3のセキュリティレベル>
• <SNMPv3の認証方式>
• <SNMPv3の認証ユーザ>
• <SNMPv3のの認証パスワード>
• <連続抑制回数>
• <警告文字列>
• <障害文字列>
• <不明イベントの有効化>
• <個別状態変化の利用>
• <正常移行時連続抑制回数>
• <警告移行時連続抑制回数>
• <障害移行時連続抑制回数>
• <タイムアウト>
• <リトライ>
• use_alias 名前ではなく別名でエージェントを検索します。
• ignore_unknown: 不明な状態の計算を行わず、モジュールがその状態に変更されることはなく、常に最後の既知の状態を保持します。
• <障害手順>
• <警告手順>
• <不明手順>
• <警告の反転>
• <障害の反転>
• < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。

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

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

例 (呼び出しおよび書式 を参照):

状態スケーリングの簡単な例:

pandora_manage /etc/pandora/pandora_server.conf --create_snmp_module snmp_module_test remote_snmp_inc 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 "1" "3" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

他の例:

pandora_manage /etc/pandora/pandora_server.conf --create_snmp_module 'My module' remote_snmp_inc 'My agent' 192.168.12.123 8080 1 my_comunnity my_oid 'Module description'

必須パラメータ:

• <モジュール名>
• <モジュールの種類>
• <エージェント名>
• <アドレス>
• <ポート番号>
• <プラグイン名>
• <ユーザ>
• <パスワード>
• <パラメーター>

オプションパラメータ:

• <説明>
• <モジュールグループ>
• <最小値>
• <最大値>
• <保存倍率>
• <間隔>
• <警告状態の最小値>
• <警告状態の最大値>
• <障害状態の最小値>
• <障害状態の最大値>
• <データの保存>
• <連続抑制回数>
• <警告文字列>
• <障害文字列>
• <不明イベントの有効化>
• <個別状態変化の利用>
• <正常移行時連続抑制回数>
• <警告移行時連続抑制回数>
• <障害移行時連続抑制回数>
• <障害手順>
• <警告手順>
• <不明手順>
• <警告の反転>
• <障害の反転>
• use_agent_alias 名前ではなく別名でエージェントを検索します。
• ignore_unknown: 不明な状態の計算を行わず、モジュールがその状態に変更されることはなく、常に最後の既知の状態を保持します。
• < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。

説明: プラグイン タイプのモジュールは、モジュール名、モジュールタイプ、作成されるエージェントの名前、モジュールアドレス、関連付けられたポート、および対応するプラグイン名を指定してエージェント内に作成されます。 オプションで、説明、モジュールグループ、最小値と最大値、保存倍率、秒単位の間隔、警告の最小と最大値、障害の最小と最大値、その他のオプションの値を指定できます。

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

例 (呼び出しおよび書式 を参照):

状態スケーリングの簡単な例:

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 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

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

説明: 存在するモジュールグループを表示します。グループ名またはその一部でフィルタリングできます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_group "grupo de modulos"

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

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

実行例:

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

オプションパラメータ: <server_name_1|server_name_2|…server_name_n> [return_type]

説明: モジュールグループを、 “|” で区切られた、最初のパラメータで指定された ノードと同期します。オプションとして、2つ目のパラメータで応答フォーマット(csv または json)を指定できます。デフォルトは、csv フォーマットです。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --module_group_synch "server_name1|server_name2|server_name3" "json"

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

ここで、<統合タイプ> は、“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_module と my_module2 の平均値を扱います。

最初の演算子(上記の例でいうところの my_agent と my_module の間の +)は無 視され計算には利用されませんが、ツールの内部構造上必要です。次の 2つ目の演算子が統合モジュールの動作をさせるためにとても重要です。上記の例では、my_agent2 と my_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

必須パラメータ:

• < モジュール名 >
• < エージェント名 >

オプションパラメータ:

• use_alias

説明: 両方の名前をパラメーターとして渡すことにより、エージェントからモジュールを削除します。このモジュールがローカルエージェントにある場合、Enterprise 版が利用可能であれば、設定ファイルからも削除されます。 バージョン 771 以降では、削除されたモジュールの 子 も再帰的に削除されます。

例 ( 呼び出し および 書式 を参照):

pandora_manage.pl /etc/pandora/pandora_server.conf --delete_module 'My module' 'My agent'

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

説明: サーバ名、エージェント名、モジュール名、モジュールの種類を指定して、エージェントモジュールにデータを送信します。オプションで、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'

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

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

実行例:

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

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

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

実行例:

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

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

説明: 指定のエージェントモジュールの カスタムID の値が返ります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_custom_id 4

オプションパラメータ: <エージェントモジュールID> [<カスタムID>]

説明: 指定のエージェントモジュールの カスタムID を設定します。空白を指定すると、設定されている値が削除されます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_module_custom_id 4 '21'

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

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

実行例:

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

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

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

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

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

• 共通: 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'

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

説明: 指定のモジュールにタグを追加します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_module 'Agent name' 'Module name' 'Tag name'

(バージョン 5.0 以上)

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

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

実行例:

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

(バージョン 5.0 以上)

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

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

実行例:

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

(バージョン 5.1 以上)

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

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

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module_from_local_component 'Agent name' 'My 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'

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

説明: このモジュールテンプレートは、ネットワークモジュールに関連するアグリゲーションです。 このテンプレートは、各モジュールを 1つずつ組み込む必要なく、エー ジェントに直接適用できます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_module_template 1 1

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

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

実行例:

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

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

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

実行例:

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

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

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

実行例:

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

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

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

実行例:

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

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

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

実行例:

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

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

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

実行例:

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

オプションパラメーター: <テンプレート名> <連続状態タイプ> <開始時間> <終了時間> [<説明> <グループ名> <フィールド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>
  • 例: not_normal (正常状態ではなくなった時にアラート発生)
• 不明状態:
  • 書式: <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" "[email protected]" "subject" "message" 3 "Mail to XXX" 1000000 38600 1 2 0   @

(バージョン 5.0 以上)

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

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

実行例:

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

(バージョン 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

(バージョン 5.0 以上)

オプションパラメータ: [<action_name> <separator> <return_type>]

説明:全アラートアクションを返します。オプションとして名前で結果をフィルタリ ングできます。オプションとして、2つ目のパラメータでセパレータを指定し、3つ目のパラメータで出力形式(csv, json, string)を指定できます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions 'Action 1' ';' 'json'

(バージョン 5.0 以上) Template:メタコンソール

オプションパラメータ: [<server_name> <action_name> <separator> <return_type>]

説明: メタコンソールの全アラートアクションを返します。オプションとして、ノードの名前またはアクションの名前で結果をフィルタリングできます。オプションとして、2つ目のパラメータでセパレータを指定し、3つ目のパラメータで出力形式(csv, json, string)を指定できます。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions_meta  'Action 1' ';' 'json'

(バージョン 5.0 以上)

オプションパラメータ: <name> <command> [<group name> <description> <internal> <field_description> <field_value>]

説明: 指定の名前とコマンドデータで、コマンドが作成されます。オプションで以下を指定できます。

• グループ名。指定しない場合は、'全て' グループに割り当てられます。
• コマンドの説明
• 内部 (1-0)
• フィールドの説明。これは次のフォーマットです:
  '[“descr1”,“descr2”,“descr3”,“descr4”,“descr5”]'.
• フィールドの値。これは次のフォーマットです: [“val1”,“val2”,“val3”,“val4”,“val5”].

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf  --create_alert_command 'PRUEBA' 'command' 'All' 'Desc' '1' '["des1","des2","des3","","des5","","","","",""]' '["val1","val2","val3","val4","","","","","",""]'

(バージョン 5.0 以上)

オプションパラメータ: [<name> <command> <group name> <description> <internal>]

説明: 全アラートを表示します。オプションとして、名前、コマンド、グループ、説明、内部かどうか(1-0)で結果をフィルタリングできます。名前、コマンド、説明でのフ ィルタでは、完全一致である必要はありません。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf  --get_alert_commands "command_name"

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

説明: テンプレート名、エージェントID、モジュールIDを指定してアラートを承諾します。 最後のパラメータに use_alias を指定した場合は、エージェントIDの部分にエージェント名を使用できます(複数のアラート承諾に便利です)。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf  --validate_alert 7 10 15

(バージョン 5.0 以上)

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

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

実行例:

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

(バージョン 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

(バージョン 5.1 以上)

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

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

実行例:

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

(バージョン 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

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

説明: イベントストーム保護 を有効化(1)または無効化(0)します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_event_storm_protection 1

必須パラメータ:

• < ユーザ名 >
• < パスワード >
• < 管理者フラグ >

オプションパラメータ:

• < コメント >

説明:

パラメータに指定したユーザ名およびパスワードでユーザを作成します。ユーザがスーパー管理者かそうでないか(< 管理者フラグ> 0 で非管理者、1 で管理者)も指定します。オプションで作成するユーザのコメントも設定できます。

例 (呼び出しおよび書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --create_user user9500 'user 9500' 0 'This user has the password "user 9500"'

必須パラメータ:

• < ユーザ名 >

説明:

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

例 (呼び出しおよび書式 を参照):

pandora_manage.pl /etc/pandora/pandora_server.conf --delete_user user02

必須パラメータ:

• < ユーザ名 >
• < 更新フィールド >
• < 新しい値 >

説明:

ユーザの指定したフィールドの値を更新します。更新フィールドに指定できるのは次の通りです。

• email.
• phone.
• is_admin スーパー管理者 (0 非管理者, 1 管理者)
• language , とり得る値:
  • default, English US.
  • ca, Catalan.
  • en_GB, English UK.
  • es, Spanish.
  • fr, French.
  • ru, Russian.
  • ja, Japanese.
  • zh_CN , Chinese.
• id_skin (Enterprise 版でのみ動作します) ユーザのスキンを変更します。
• comments.
• fullname.
• password.

例 (呼び出しおよび書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --update_user 'user 9500' password 'XYZ'

必須パラメータ:

• < ユーザ名 >

説明:

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

例 (呼び出しおよび書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --enable_user 'user 9500'

必須パラメータ:

• < ユーザ名 >

説明:

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

例 (呼び出しおよび書式 を参照):

pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'user 9500'

必須パラメータ:

• < プロファイル名 >
• < 権限リスト > 権限を与えるかどうかは 1 または 0 で指定します。次の順番です。
  1. AR エージェント表示
  2. AW エージェント編集
  3. AD エージェント無効化
  4. LW アラート編集
  5. LM アラート管理
  6. UM ユーザ管理
  7. DM データベース管理
  8. ER イベント表示
  9. EW イベント編集
  10. EM イベント管理
  11. RR レポート表示
  12. RW レポート編集
  13. RM レポート管理
  14. MR ネットワークマップ表示
  15. MW ネットワークマップ編集
  16. MM ネットワークマップ管理
  17. VR ビジュアルコンソール表示
  18. VW ビジュアルコンソール編集
  19. VM ビジュアルコンソール管理
  20. PM Pandora FMS 管理
  21. NR NCM データ表示
  22. NW NCM 操作 -NR を含める必要があります-
  23. NM NCM 管理 -NW および NR を含める必要があります-

説明:

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

例 (呼び出しおよび書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --create_profile Profile01 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

必須パラメータ:

• < プロファイル名 >
• < 権限リスト > 権限を与えるかどうかは 1 または 0 で指定します。次の順番です。
  1. AR エージェント表示
  2. AW エージェント編集
  3. AD エージェント無効化
  4. LW アラート編集
  5. LM アラート管理
  6. UM ユーザ管理
  7. DM データベース管理
  8. ER イベント表示
  9. EW イベント編集
  10. EM イベント管理
  11. RR レポート表示
  12. RW レポート編集
  13. RM レポート管理
  14. MR ネットワークマップ表示
  15. MW ネットワークマップ編集
  16. MM ネットワークマップ管理
  17. VR ビジュアルコンソール表示
  18. VW ビジュアルコンソール編集
  19. VM ビジュアルコンソール管理
  20. PM Pandora FMS 管理
  21. NR NCM データ表示
  22. NW NCM 操作 -NR を含める必要があります-
  23. NM NCM 管理 -NW および NR を含める必要があります-

説明:

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

例 (呼び出しおよび書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --update_profile Profile01 1 0 1 0 1 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0

必須パラメータ:

• < ユーザ名 >
• < プロファイル名 >
• < グループ名 >

説明:

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

例 (呼び出しおよび書式 を参照):

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

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

説明: 指定のユーザプロファイルへタグを追加します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_user_profile '7' 'new tag' 'All' 'Profile for user 7'

必須パラメータ:

• < ユーザ名 >
• < プロファイル名 >
• < グループ名 >

説明:

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

例 (呼び出しおよび書式 を参照):

pandora_manage /etc/pandora/pandora_server.conf --delete_profile user02 'Chief Operator' Applications

必須パラメータ:

• < ユーザ名 >
• < プロファイル名 >

オプションパラメータ:

• < グループ名 >

説明:

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

例 (呼び出しおよび書式 を参照):

pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile_to_user 'user01' 'Chief Operator' 'Network'

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

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

実行例:

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

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

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

実行例:

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

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

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

実行例:

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

必須パラメータ:

• イベント名。
• イベントタイプ。以下のいずれかを指定できます。
  • unknown , alert_fired , alert_recovered , alert_ceased , alert_manual_validation , recon_host_detected , system , error , new_agent , going_up_warning , going_up_critical , going_down_normal , going_down_warning, going_down_critical , going_up_normal , configuration_change
• グループ名。

オプションパラメータ:

• エージェント名
• モジュール名
• イベントの状態 (0 承諾*されていない*場合、1 承諾済、2 処理中)
• 重要度: 0 (メンテナンス), 1 (情報), 2 (正常), 3 (警告), 4 (障害), 5 (マイナー), 6 (メジャー)
• アラートに関連付けるテンプレート名
• ユーザ名
• コメント
• ソース
• 拡張 ID
• タグ: フォーマットは < tag > < url >,< tag > < url > である必要があります。複数のタグをカンマ区切りで追加できます。 カンマと次のラベルの間にスペースを入れないことが重要です。
• カスタムデータ: カスタムデータは JSON形式で入力する必要があります。たとえば、'{“Location”: “Office”, “Priority”: 42}' です。
• 強制エージェント作成(bool): エージェント名パラメータが存在しない場合に、エージェントを作成するかどうかです。
• 障害手順: 障害時の手順を追加します。
• 警告手順: 警告時の手順を追加します。
• 不明手順: 不明時の手順を追加します。
• 別名の利用: エージェント名の代わりにの別名を利用する場合は use_alias を指定します。別名はシングルクォーテーションで囲います。
• メタコンソール: サーバ ID (Enterprise 版のみ).

説明:

イベントは、イベントの名前と種類、モジュールの名前、関連付けられたエージェントとグループのデータで作成されます。

例 (呼び出しおよび書式 を参照):

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

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

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

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

実行例:

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つの日時を指定するとその間のイベントのみを対象にすることができ、開始日時のみを指定すればそれ以降全てを指定することもできます。

(バージョン 5.0 以上)

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

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

実行例:

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

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

(バージョン 5.0 以上)

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

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

実行例:

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

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

必須パラメータ:

• < イベント ID >
• < ユーザ名 >
• < コメント >

説明:

イベントにコメントを追加します。

例 (呼び出しおよび書式 を参照):

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

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

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

説明: イベントを処理中にします。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --event_in_progress 123

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

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

実行例:

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

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

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

このコマンドは API を通して動作するため、以下のパラメータが必要です。

• id =<ポリシーID> (必須)
• id2 =<エージェントID> (オプション) other パラメーターで示されるエージェント の ID または名前。空の場合、ポリシーはすべてのエージェントに適用されます。
• other =<連続パラメータ>
  • <name_agent (Boolean)> エージェントが ID (0) または名前 (1) のどちらで示されるか。
  • <server_id> (メタコンソールの場合は必須) ポリシーが適用されるサーバの ID。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_policy 'policy_id' 'agent_id' 'other1|other2'

(バージョン 5.0 以上)

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

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

実行例:

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

(バージョン 5.0 以上)

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

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

実行例:

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

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

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

実行例:

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

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

説明: コレクションのファイルを再作成します。 通常は [INFO] Collection recreated successfully. を返します。エラーの場合は、[ERROR] Collection not recreated. を返します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --recreate_collection 7

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

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

実行例:

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

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

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

実行例:

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

オプションパラメータ: <id_policy> <id_agent>

説明: エージェントをポリシーから削除します。ポリシーの ID および削除するエージェントの ID を指定する必要があります。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --remove_agent_from_policy '11' '2'

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

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

実行例:

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

(バージョン 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'

(バージョン 7.0 以上)

オプションパラメーター: <ポリシー名> <モジュール名> <モジュールタイプ> [<説 明> <モジュールグループ> <最小> <最大> <倍率> <間隔> <警告最小値> <警告最大値> <障害最小値> <障害最大値> <データ保存> <再実行> <リクエスト> <エージェントブラウ ザID> <認証サーバ> <認証レルム> <設定データ> <プロキシURL> <プロキシ認証ログイン> <プロキシ認証パスワード> <警告文字列> <障害文字列> <不明イベントの有効化> <連 続抑制回数> <個別状態変化の利用> <正常移行時連続抑制回数> <警告移行時連続抑制回 数> <障害移行時連続抑制回数> <連続抑制タイムアウト> <警告反転> <障害反転> <障害 手順> <警告手順> <不明手順>]

説明: ポリシーウェブモジュールを作成します。デフォルト値は、–create_web_module と同じです。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_web_module 'policy_name' 'module_name' web_data 'module_description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public "module_begin\nmodule_name modname\nmodule_end" 'http://proxy.url' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warninng_instructions' 'unknown_instructions'

(バージョン 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'

(バージョン 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'

(バージョン 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'

(バージョン 5.0 以上)

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

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

実行例:

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

(バージョン 5.0 以上)

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

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

実行例:

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

(バージョン 5.0 以上)

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

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

実行例:

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

(>= 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

(バージョン 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 カラム内にカンマを含める操作には対応していません。

オプションパラメーター: <ファイルパス> <名前> <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

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

トラップサーバで snmptrapd プロセスを開始します。すでに起動している場合は、サービス停止(kill コマンド)後に再実行し、ログ(デフォルトは /var/log/pandora/pandora_snmptrapd.log)にあるすべてのトラップを削除します。

実行例:

pandora_manage /etc/pandora/pandora_server.conf --start_snmptrapd

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

説明 指定のパラメータでグラフを作成できます。2つ以上のモジュールは <セパレータ> で区切る必要があり、単一のモジュールであっても常に指定する必要があります。 すべてのパラメータ指定が必要ですが、シングルクォートで囲って空を指定することはできます。 デフォルト値は次の通りです。

• 幅: 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' ';'

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

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

実行例:

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

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

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

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_modules_to_graph 2 '1015,1017' ','

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

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

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf –delete_modules_to_graph 2 '1015,1017' ','

オプションパラメータ: <クラスタ名> <クラスタタイプ> <説明> <グループID>

説明: 指定したパラメータのクラスタおよび関連要素を作成します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --new_cluster cluster1 AA description 12

オプションパラメータ: <json_data_base64:[{“id”:5,“id_agent”:2},{“id”:5,“id_agent”:3}]>

説明: 指定のクラスタに指定のエージェントを追加します。base64 で JSON データ がエンコードされている必要があります。

実行例 :

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ ===

オプションパラメータ:

以下のフィールドの JSON データ:

• name : (文字列)
• id_cluster : (数値)
• type : AA (“アクティブ/アクティブ” を意味します)
• critical_limit : (数値)
• warning_limit : (数値)

JSON の例:

[
  {
    "name": "Swap_Used",
    "id_cluster": 5,
    "type": "AA",
    "critical_limit": 80,
    "warning_limit": 60
  },
  {
    "name": "TCP_Connections",
    "id_cluster": 5,
    "type": "AA",
    "critical_limit": 80,
    "warning_limit": 60
  }
]

説明: 指定のクラスタに指定のモジュールをアイテムとして追加します。

実行例 :

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent WwogIHsKICAgICJuYW1lIjogIlN3YXBfVXNlZCIsCiAgICAiaWRfY2x1c3RlciI6IDUsCiAgICAidHlwZSI6ICJBQSIsCiAgICAiY3JpdGljYWxfbGltaXQiOiA4MCwKICAgICJ3YXJuaW5nX2xpbWl0IjogNjAKICB9LAogIHsKICAgICJuYW1lIjogIlRDUF9Db25uZWN0aW9ucyIsCiAgICAiaWRfY2x1c3RlciI6IDUsCiAgICAidHlwZSI6ICJBQSIsCiAgICAiY3JpdGljYWxfbGltaXQiOiA4MCwKICAgICJ3YXJuaW5nX2xpbWl0IjogNjAKICB9Cl0=

オプションパラメータ:

以下のフィールドの JSON データ:

• name : (文字列)
• id_cluster : (数値)
• type : AP (“アクティブ/スタンバイ” を意味します)
• critical_limit : (数値)
• warning_limit : (数値)

JSON の例:

[
  {
    "name": "DiskUsed_/proc/kcore",
    "id_cluster": 5,
    "type": "AP",
    "is_critical": 1
  },
  {
    "name": "DiskUsed_/proc/sched_debug",
    "id_cluster": 5,
    "type": "AP",
    "is_critical": 1
  }
]

説明: 指定のクラスタに指定のモジュールをアイテムとして追加します。

実行例 :

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_item WwogIHsKICAgICJuYW1lIjogIkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwKICAgICJpZF9jbHVzdGVyIjogNSwKICAgICJ0eXBlIjogIkFQIiwKICAgICJpc19jcml0aWNhbCI6IDEKICB9LAogIHsKICAgICJuYW1lIjogIkRpc2tVc2VkXy9wcm9jL3NjaGVkX2RlYnVnIiwKICAgICJpZF9jbHVzdGVyIjogNSwKICAgICJ0eXBlIjogIkFQIiwKICAgICJpc19jcml0aWNhbCI6IDEKICB9Cl0=

オプションパラメータ: <クラスタID>

説明: クラスタの状態を取得します。

実行例 :

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_cluster_status 7

オプションパラメータ: <クラスタID>

説明: クラスタを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1

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

説明: クラスタに追加されているエージェントを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_agent 1 1

オプションパラメータ: <アイテムID>

説明: クラスタアイテムを削除します。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1

オプションパラメータ: <名前> <背景> <幅> <高さ> <グループ> <モード> [<要素の位置> <背景色> <要素>]

説明: 指定のパラメータおよび関連する要素でビジュアルコンソールを作成します。スクリプトが起動されるシェルにエラーが発生する可能性があるため、JSON　はシングルクオートで囲む必要があります。

“データの挿入:” モードには、 'static_objects' と 'auto_creation' という値を指定 することができます。前者は要素を配置する位置を考慮せずに要素を作成しますが、要素の位置は json に記述されている情報が使用されます。 モードが 'auto_creation' の場合は、座標タペストリー（以下の例で説明する形式の 'position_to_locate_elements' フィールド）を設定する必要があり、アルゴリズムは各要素の位置とサイズを自動的に設定します。

例 (auto_creation):

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'auto_creation' '{"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}' '#FFF' '[{"image": "_engine","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

例 (static_objects):

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'static_objects' "" '#FFF' '[{"image": "_engine","pos_x":100,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","pos_x":400,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

オプションパラメータ: <ID> [<名前> <背景> <幅> <高さ> <グループ> <モード> < 要素の位置> <背景色> <要素>]

説明: 指定のパラメータおよび関連する要素のジュアルコンソールを編集します。スクリプトが起動されるシェルにエラーが発生する可能性があるため、JSON　はシングルクオートで囲む必要があります。

例 (auto_creation):

perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited'     'auto_creation' {"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}  '[{"id":103,"image": "_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

例 (static_objects):

perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited'     'static_objects'   '[{"id":103,"image": "_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

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

説明: 指定のパラメータおよび関連する要素のジュアルコンソールを削除します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console 1

オプションパラメータ: <ID> <モード> <モードID>

説明: ビジュアルコンソールに関連する要素をフィルタで削除します。モードには、“type”, “image”, “id_agent”, “id_agente_modulo”, “id_group”, “type_graph” のいずれかを指定する必要があります。それぞれ順番に、タイプID、画像名、エージェントID、モジュールID、グループID、グラフタイプ(塗り潰し、線など…)です。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console_objects 1 'id_agent' 1

オプションパラメータ: <ID> <数> [prefix]

説明: 表示されているビジュアルコンソールを指定数複製します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --duplicate_visual_console 1 10 'test console 2'

オプションパラメータ: <ID> [<パス> <要素ID>]

説明: ビジュアルコンソールとその要素を json 形式でファイルにエクスポートします。また、関連する要素の ID を追加して後で編集することもできます。

データに関して: フィールド “with_element_id” は 1 か 0 を指定することができ 、ID を含むかどうかを表します。

例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --export_json_visual_console 1 '/tmp' 1

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

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

例:

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

オプションパラメータ: <タグ名> <タグの説明> [ <タグURL> ] [ <タグemail> ]

説明: 新たなタグを作成します。タグ名とタグの説明は必須です。

実行例:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_tag 'New tag name' 'Your description'

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