Pandora FMS のコマンドラインインタフェース (CLI) [wiki.pandorafms.jp]

この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。
====== Pandora FMS のコマンドラインインタフェース (CLI) ====== 

{{indexmenu_n>3}}

[[ja:documentation:start|Pandora FMS ドキュメント一覧に戻る]]

===== Pandora FMS CLI =====

The Pandora FMS CLI (Command-Line Interface) is used for making calls in command line on the file:

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

<file>
/usr/share/pandora_server/util/pandora_manage.pl

</file>

This method is specially useful to integrate applications of thirds parts with Pandora FMS through automated tasks. Basically, it consists on one call with the parameters formated to do and action such as the creation an elimination of one agent, one module or one user, among other things.

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

**Community version**:

**オープンソース版**:

The CLI is a file in Perl language, to call CLI:

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

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


</code>

<code bash>

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

</code>

With backslash ''\'' as a line connector:

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

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


</code>

**Enterprise version**:

**Enterprise 版**:

<WRAP center round important 75%> If you are an **Enterprise** customer, you will need to use the binary executable instead of the ''.pl'', since there are some enterprise features that may not work properly with the ''.pl''. Just run ''pandora_manage'' to get started. </WRAP>

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

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


</code>

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

With backslash ''\'' as a line connector:

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

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


</code>

<WRAP center round info 75%> All examples shown here, unless implicitly stated otherwise, refer to the Enterprise version ( ''pandora_manage'' ). </WRAP>\\

<WRAP center round info 75%> ここに示しているすべての例は、特に明記されていない限り、Enterprise 版 ('' pandora_manage'') を想定しています。</WRAP>

==== 書式 ====

  * All parameters, mandatory or optional, can be delimited with single quotation marks.
  * Quotation marks are especially useful when a parameter has spaces, e.g. '''My Agent'''.
  * Also if you need to omit some mandatory parameter you can use two single quotes together. If strictly necessary, an  ''[ERROR] Error:''  message will be displayed followed by a description of the error. **In the case of optional parameters**, if there are several and you need to specify only the second and/or third and/or etcetera, use two single quotation marks together to indicate the empty optional parameters.
  * Some parameters are case sensitive, //others are case insensitive//. For example, when [[:en:documentation:08_technical_reference:03_anexo_cli#create_agent|creating an agent]] the name of the PFMS server must be strictly the same, however the name of the primary group to which the agent will belong can be in upper and/or lower case and if there is a match the group will be assigned.
  * You can use the alias of an agent, instead of its name itself, by means of the ''use_alias'' parameter **at the end of the command line**.

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

==== ヘルプ ====

To obtain general help with the Pandora FMS CLI you only need to writte:

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

<code>
perl pandora_manage.pl --h

</code>

To obtain help of one specific option, it would be enough with putting this option without parameters (this for the options that use parameters).

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

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user

</code>

===== エージェント =====
==== --create_agent ====

**Required parameters ([[#syntax|syntax]])**:

**必須パラメータ ([[#書式|書式]])**:

  * < agent name > Returns error if the name exists (see < alias as name >).
  * < operating system > 
  * < group name > Must match an existing OS (case insensitive) otherwise it will be registered without any group.
  * < server name > Be case sensitive, otherwise the value of the field will be left null //without any warning//. **You must verify that the agent has been assigned to a server.**

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

**Optional parameters:**

**オプションパラメータ:**

  * < IP address or URL >
  * < description > If you omit the description ''Created by < server name >'' will be added (regardless of whether the specified server exists or not).
  * < interval > In seconds, default value: 300.
  * < alias as name > The default value is ''1'' and with this value the agent alias will be the same as the agent name. If you want the name to be randomly generated, use ''0''.

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

**Description:**

**説明:**

An agent will be created with the specified name, operating system, group and server. Optionally, it can be given an address (IP address or name), a description and an interval in seconds.

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

**Example (see [[#pandora_fms_cli|call]] and [[#syntax|syntax]]):**

**例 ( [[#pandora_fms_cli|呼び出し]] および [[#書式|書式]] を参照):**

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

</code>

==== --update_agent ====

**Mandatory parameters:**
  * < name_of_agent >
  * < field >
  * < new_value >

**必須パラメータ:**
  * < エージェント名 >
  * < フィールド >
  * < 新たな値 >

**Optional parameters:**
  * ''use_alias''

**オプションパラメータ:**
  * ''use_alias''

**Description:** A single given <field> of an existent agent will be updated. The possible fields are the following:

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

<WRAP group><WRAP half column>

  * ''agent_name''
  * ''address''
  * ''description''
  * ''group_name''
  * ''interval''
  * ''os_name''
</WRAP> <WRAP half column>

  * ''disabled'' ( ''0''  for activate it, ''1'' for inactivate it).
  * ''parent_name''
  * ''cascade_protection'' ( ''0''  for inactivate it, ''1''  for activate it).
  * ''icon_path''
  * ''update_gis_data'' ( ''0''  for inactivate it, ''1''  for activate it).
  * ''custom_id''

</WRAP></WRAP>

<WRAP group><WRAP half column>

  * ''agent_name''
  * ''address''
  * ''description''
  * ''group_name''
  * ''interval''
  * ''os_name''
</WRAP> <WRAP half column>

  * ''disabled'' ( ''0'' で有効化、 ''1'' で無効化)
  * ''parent_name''
  * ''cascade_protection'' ( ''0'' で無効化、''1'' で有効化)
  * ''icon_path''
  * ''update_gis_data'' ( ''0'' で無効化、''1'' で有効化)
  * ''custom_id''

</WRAP></WRAP>

<WRAP center round tip 60%>To identify the agent by its alias instead of its name, use ''use_alias''  just at the end.</WRAP> \\ 

<WRAP center round tip 60%>エージェントを名前ではなく別名で指定する場合は、最後に ''use_alias'' を指定します。</WRAP>\\

**実行例:**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' agent_name 'Agent 2'

</code>

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

</code>

==== --agent_update_custom_fields ====

<WRAP center round info 60%>Version NG 758 or later.</WRAP>\\

<WRAP center round info 60%>バージョン NG 758 以上</WRAP>

**Parameters:** <id_agent> <type_field> <field_to_change> <new_value>

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

   - ''id_agent''  → agent identifier.
  - ''type_field''  → field type which can be ''0''  if it is a text type or ''1''  if it is a combobox (select) type composed of several options. In this case it checks if the option you want to update, if it exists it changes it and if not it returns a message that the field does not match:{{  :wiki:pfms-08_technical_reference-03_anexo_cli-agent_update_custom_fields-img01.png  }}
  - ''field_to_change''  → name of the field to be updated.
  - ''new_value''  → the value of the field to be updated.

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

**Description:**  updates the custom fields of an agent.

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

The answers of which they are composed are:

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

  * **ERROR**:
      - If the agent does not exist.
      - If the field does not exist.
      - In the event that the ''new_value''  of a combo does not match the ones you have preset.
      - If you were unable to update the field.
  * **INFO**:
      - Updating the ''X''  field with the agent id ''Y''.
      - Correctly updated.

　* **ERROR**:
    - エージェントが存在しない場合。
    - フィールドが存在しない場合。
    - 選択ボックスの ''new_value ''が事前に設定したものと一致しない場合。
    - フィールドを更新できなかった場合。
  * **INFO**:
    - Updating the ''X'' field with the agent id ''Y''.
    - Correctly updated.

**Examples:**

**例:**

TEXT TYPE:

テキストタイプ:

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

</code>

COMBO TYPE:

選択肢タイプ:

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

</code>

{{  :wiki:pfms-08_technical_reference-03_anexo_cli-agent_update_custom_fields-img02.png  }}

==== --delete_agent ====

**Mandatory parameter:**

**必須パラメータ:**

   * < agent_name >

   * < エージェント名 >

**Optional parameter:**

**オプションパラメータ:**

  * ''use_alias''
      * Note that agent aliases can be repeated and you can delete several agents in one step.

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

**説明:** 

The agent(s) will be deleted by passing its name or alias as a parameter.

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

**実行例:**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf \
    --delete_agent 'My Agent' \
    use_alias


</code>

{{  :wiki:pfms-pandora_manage--delete_agent-use_alias.png  }}


==== --disable_group ====

**Manadory parameter:**

**必須パラメータ:**

   * < group_name >

   * < グループ名 >

**説明:** 

Disable all agents from an entire group. The [[:en:documentation:04_using:11_managing_and_administration#groups_in_pandora_fms|agents of the group]] considered as parameter will be disabled with the execution of this option.

グループの全エージェントを無効化します。[[:ja:documentation:04_using:11_managing_and_administration#pandora_fms_のグループ|グループのエージェント]] は、このオプションの実行により無効になります。

<WRAP center round important 60%>If we pass ''All'' as group, all agents from all groups will be disabled.</WRAP>

<WRAP center round important 60%>グループ名に ''All'' を指定した場合、すべてのグループのエージェントが無効化されます。</WRAP>

**実行例:**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --disable_group Firewalls


</code>

{{  :wiki:pfms-pandora_manage_--disable_group-example_1.png  }}

==== --enable_group ====

**Mandatory parameter:**

   * < group_name >

**必須パラメータ:**

   * < グループ名 >

**説明:**

The agents of the group considered as parameter will be disabled with the execution of this option. If you pass '''All''' as group all agents from all groups will be enabled.

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

**実行例:**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --enable_group firewalls


</code>

{{  :wiki:pfms-pandora_manage_--enable_group-example_1.png  }}

==== --create_group ====

**Mandatory parameters:**

**必須パラメータ:**

   * < group_name >

   * < グループ名 >

**Optional paramaters:**

**オプションパラメータ:**

  * < parent_group_name >
  * < icon >
      * ''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''
  * < description >

  * < 親グループ名 >
  * < アイコン >
      * ''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''
  * < 説明 >

**説明:**

A new group will be created if it doesn't exist and optionally, can be assigned a parent group, a icon (the icon name without extension, choose one from list above) and description. The parent group by default is '''All''' and the default icon is empty string (without icon).

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

<WRAP center round info 60%>

If you need to add a description:

  * If you will not use parent group set ''All''  as fill parameter.
  * If no icon is to be used, place an empty string (two single quotes together) as the filler parameter.

</WRAP> \\

<WRAP center round info 60%>

説明を追加する必要がある場合、

  * 親グループを使用しないときは '''All''' を使用します。
  * アイコンを使用しないときは空の文字列(二つのシングルクォーテーション)をパラメータに指定します。。

</WRAP> \\

**実行例:**

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

</code>

==== --delete_group ====

**Mandatory parameter:**

**必須パラメータ:**

   * < group_name >

   * < グループ名 >

**説明:**

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

<WRAP center round important 60%>

Every agent belongs to indicated group will be deleted too.

</WRAP>

<WRAP center round important 60%>
指定のグループに属する全エージェントも削除されます。
</WRAP>

**実行例:**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf –-delete_group 'Group name'

</code>

==== --update_group ====

**Mandatory parameters:**

**必須パラメータ:**

   * < group_id >

   * < グループID >

**Optional parameters:**

** オプションパラメータ:**

  * < group_name_to_modify >
  * < parent_group_name >
  * < icon >
      * ''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''
  * < description >

  * < 修正するグループ名 >
  * < 親グループ名 >
  * < アイコン >
      * ''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''
  * < 説明 >

**Description:**  A group is modified by its numerical identifier. Parameters that can be modified:

  * Name group.
  * Name group parent
  * Icon (only name, without extension, choose one from list above).
  * Description.

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

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

<WRAP center round tip 60%>

  * You can use the " [[:en:documentation:08_technical_reference:03_anexo_cli#get_agent_group_id|get_agent_group_id]] " function to find the id of the group of any agent.
  * At Web console go to menu ►**Profiles**→ **Manage agent groups** and take number id.

</WRAP>

<WRAP center round tip 60%>

  * エージェントのグループ ID を見つけるには、[[:ja:documentation:08_technical_reference:03_anexo_cli#get_agent_group_id|get_agent_group_id]] を利用できます。
  * ウェブコンソールのメニューで **プロファイル(Profiles)** → **エージェントグループ管理(Manage agent groups)** へ行き、ID 番号を確認します。

</WRAP>

<WRAP center round important 60%>

You must type exactly same existing parameters for only modify description field.

</WRAP> \\

<WRAP center round important 60%>
説明フィールドを変更する場合にのみ、まったく同じ既存のパラメーターを入力する必要があります。
</WRAP>

**実行例:**

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


</code>

==== --stop_downtime ====

**Mandatory parameter:**

**必須パラメータ:**

   * < downtime_name >

   * < 計画停止名 >

**Description:**

**説明:**

Stop a planned downtime. If the downtime is finished, a message will be showed. Returning messages:

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

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

**実行例:**

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --stop_downtime 'Downtime name'

</code>
==== --get_agent_status ====

**Required parameter:**

**必須パラメータ:**

   * < agent_name >

   * < エージェント名 >

**Optional parameter:**

**オプションパラメータ:**

  * ''use_agent_alias''

<WRAP center round tip 60%>
To identify the agent by its alias instead of its name, use ''use_agent_alias''  right at the end.

</WRAP>

<WRAP center round tip 60%>
エージェントを名前の代わりの別名で指定する場合は、''use_agent_alias'' を最後に付けます。

</WRAP>

**Description:**  Get the status of a given agent by its name or alias.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_status 'agent name'


</code>

==== --get_agent_group ====

**Required parameter:**

**必須パラメータ:**

   * < agent_name >

   * < エージェント名 >

**Optional parameter:**

**オプションパラメータ:**

  * ''use_agent_alias''

<WRAP center round tip 60%>
To identify the agent by its alias instead of its name, use ''use_agent_alias''  right at the end.

</WRAP>

<WRAP center round tip 60%>
エージェントを名前の代わりの別名で指定する場合は、''use_agent_alias'' を最後に付けます。

</WRAP>

**Description:**  Get the group of a given agent by its name or alias.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_group 'agent_name'


</code>

==== --get_agent_group_id ====

**Required parameter:**

**必須パラメータ:**

   * < agent_name >

   * < エージェント名 >

**Optional parameter:**

**オプションパラメータ:**

  * ''use_agent_alias''
 
<WRAP center round tip 60%>
To identify the agent by its alias instead of its name, use ''use_agent_alias''  right at the end.

</WRAP>

<WRAP center round tip 60%>
エージェントを名前の代わりの別名で指定する場合は、''use_agent_alias'' を最後に付けます。

</WRAP>

**Description:**  Get the identification group of a given agent by its name or alias.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_group_id 'agent name'


</code>

==== --get_agent_modules ====

**Required parameter:**

**必須パラメータ:**

   * < agent_name >

   * < エージェント名 >

**Optional parameter:**

**オプションパラメータ:**

  * ''use_agent_alias''
 
<WRAP center round tip 60%>
To identify the agent by its alias instead of its name, use ''use_agent_alias''  right at the end.

</WRAP>

<WRAP center round tip 60%>
エージェントを名前の代わりの別名で指定する場合は、''use_agent_alias'' を最後に付けます。

</WRAP>

**Description:**  Get the modules (identifications and names, separated by a comma) of a given agent by its name or alias.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_modules 'agent name'


</code>

==== --get_agents ====

**Required parameter:** None. To get help for such a command you can use (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):

**必須パラメータ:** なし。以下でコマンドのヘルプを確認できます([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):

<code bash>
 pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' '' '' '' ''


</code>

You will get the following response indicating that it exceeds the number of parameters:

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

<code bash>
[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.


</code>

**Optional parameters:** Allow filtering the list of agents in a serialized format where the order matters, use two single quotes to skip parameter(s). They are numbered here for better control and visualization:

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

   - < [[:en:documentation:04_using:11_managing_and_administration#group_creation|group_name]] >
  - < [[:en:documentation:04_using:12_console_setup#operating_systems|os_name]] >
  - < status > Posible values: ''critical'', ''warning'', ''unknown'', ''normal''.
  - < number_max_of_modules >
  - < key_string > Allows filtering by agent name (or agent alias if you add at the end ''use_agent_alias''  ).
  - < policy_name >
  - ''use_agent_alias''

  - < [[:ja:documentation:04_using:11_managing_and_administration#グループ作成|グループ名]] >
  - < [[:ja:documentation:04_using:12_console_setup#オペレーティングシステム|OS 名]] >
  - < 状態 > 指定可能な値: ''critical'', ''warning'', ''unknown'', ''normal''.
  - < モジュールの最大数 >
  - < キー文字列 > エージェント名(または、''use_agent_alias'' を指定した場合は別名)でフィルタリングできます。
  - < ポリシー名 >
  - ''use_agent_alias''

**Description:**  Get all agents (without parameters) or agents according to a filter.

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

**Examples (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

  * Get all agents in the ''Network''  group:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Network' '' '' '' '' ''


</code>

  * Get all the agents that have ''Linux''  as operating system:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' 'Linux' '' '' '' ''


</code>

  * Obtain all agents whose status is ''normal'':

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' 'normal' '' '' ''


</code>

  * Obtain all agents with zero modules (no modules at all):

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '0' '' ''


</code>

  * Get all agents with zero modules in the ''Servers''  group:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Servers' '' '' '0' '' ''


</code>

  * Get all agents that contain the word ''test''  in their alias:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' 'test' '' use_agent_alias


</code>


==== --get_agents_id_name_by_alias ====

**Parameters:** <agent_alias> [ ''strict'' ]

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

**Description:** List id and alias of agents matching given alias. Using ''strict'' limits search only to exact alias.

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

**Example:**

**実行例:**

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

</code>

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

**Parameters:** None.

**パラメーター:** なし

**Description:**

**説明:**

   - The misconfigured configuration files will be listed by searching the main //tokens//:
     * ''server_ip''
     * ''server_path''
     * ''temporary''
     * ''logfile''
   - In case there are corrupt files that cannot be opened: ''[WARN] Can't open file < path_file >''.
   - In case of not finding the file in the path: ''[WARN] File not exist < path_file >''.
   - In case the configuration files are correct (according to the //tokens// of the first point): ''[INFO] No bad files found''

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

**Examples:**

**例:**

<code bash>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_bad_conf_files

</code>

Example output:

出力例:

{{ :wiki:pfms-open-perl_pandora_manage_pl-get_bad_conf_files.png }}

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

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

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

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

**実行例:**

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --create_downtime ====

**Parameters:** <downtime_name> <description> <date_from> <date_to> <id_group> <monday (0|1)> <tuesday (0|1)><wednesday (0|1)> <thursday (0|1)> <friday (0|1)> <saturday (0|1)> <sunday (0|1)> <periodically_time_from HH:MM:SS><periodically_time_to HH:MM:SS> <periodically_day_from> <periodically_day_to><type_downtime> <type_execution> <type_periodicity> <id_user>

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

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

<WRAP center round important 75%>

  * You must have configured data API in ''pandora_server.conf''.
  * The date format must be ''MM/DD/YYYY''  (Month/Day/Year) for this call to work properly.

</WRAP>

<WRAP center round important 75%>

  * ''pandora_server.conf'' にて、API の設定が必要です。
  * 正しく動作させるためには、日付のフォーマットは ''MM/DD/YYYY'' (月/日/年) である必要があります。

</WRAP>


**例:**

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

</code>

==== --add_item_downtime ====

**Mandatory parameters:**

**必須パラメータ**

   * < id_parada_planificada >
  * < id_agente1,id_agente2,id_agente3,…,id_agenteN >
  * < nombre_módulo1,nombre_módulo2,nombre_módulo3,…,nombre_móduloN >

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

**Description:**

**説明:**

Records will be added to a scheduled stop with the submitted data. Write the list of agent identifiers and the list of module names without leaving spaces between the commas that separate the components of both lists. If a module name contains spaces, enclose the module name in two single quotes. If two or more agents are passed, it is assumed by default that you want to add common modules, otherwise it will display a warning message.

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] and [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --add_item_downtime 1 1 Status,'Available Memory'


</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --get_all_planned_downtimes ====

**Mandatory parameters:**

**必須パラメータ:**

   * < name_to_search >

   * < 検索名 >

**Optional parameters:**

**オプションパラメータ:**

  * < id_group >
  * < type_downtime >
      * ''quiet''
      * ''disable_agents''
      * ''disable_agents_alert''
  * < type_execution >
      * ''once''
      * ''periodically''
  * < type_periodicity >
      * ''weekly''
      * ''monthly''

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

**Description:**

**説明:**

List all matches of planned downtime. See [[:en:documentation:04_using:11_managing_and_administration#scheduled_downtimes|Scheduled downtimes]] options.

マッチした全計画停止一覧を出力します。[[:ja:documentation:04_using:11_managing_and_administration#計画停止|計画停止]] オプションを参照してください。

**例:**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_all_planned_downtimes ''

</code>

==== --get_planned_downtimes_items ====

**Mandatory parameters:**

**必須パラメータ**

   * < name_to_search >

   * < 検索する名前 >

**Optional parameters:**

**オプションパラメータ**

  * < id_group >
  * < type_downtime >
      * ''quiet''
      * ''disable_agents''
      * ''disable_agents_alert''
  * < type_execution >
      * ''once''
      * ''periodically''
  * < type_periodicity >
      * ''weekly''
      * ''monthly''

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

**説明:**

List all of items that matches planned downtime name. See [[:en:documentation:04_using:11_managing_and_administration#scheduled_downtimes|Scheduled downtimes]] options.

マッチした計画停止のアイテム一覧を出力します。[[:ja:documentation:04_using:11_managing_and_administration#計画停止|計画停止]] オプションを参照してください。

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_planned_downtimes_items 'Name downtime'

</code>

==== --set_planned_downtimes_deleted ====

**必須パラメータ:**

   * < id_planned_downtime >

   * < 計画停止ID >

**Description:**

**説明:**

Delete a planned downtime especified by ID. Some return messages:

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

''This planned downtime is deleted''

''Problems with this planned downtime''

''The scheduled downtime is still being executed''

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted 7

</code>


==== --set_disabled_and_standby ====

<WRAP center round info 60%>

[[https://pandorafms.com/en/prices/?o=dwpfms|{{:wiki:icono-modulo-enterprise.png?23x23  |Enterprise version}}]] Only for Metaconsole and Nodes.

</WRAP>\\

<WRAP center round info 60%>

[[https://pandorafms.com/en/prices/?o=dwpfms|{{:wiki:icono-modulo-enterprise.png?23x23  |Enterprise 版}}]] メタコンソールおよびノードのみ

</WRAP>\\

**Required parameters:**

**必須パラメータ:**

   * < id_agent >
  * //For Metaconsole// < id_metaconsole >, //for nodes//  put any value, is indifferent.

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

**Optional parameter:**

**オプションパラメータ:**

  * < value> By default ''1''  for enable agent, ''0''  for disabled.

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

**Description:** Disable an agent and, if it has remote configuration, set to standby mode.

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するようにするためには、''pandora_server.conf'' にて次の API パラメータの設定([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイルの項目]])が必要です。 : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

  * Example to enable an agent from the node:

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

<code bash>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1

</code>

  * Example to disable an agent from the node:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0

</code>

  * Example to enable an agent from the metaconsole:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1

</code>

  * Example to disable an agent from the metaconsole:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>
==== --reset_agent_counts ====

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

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

**実行例:**

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

==== --insert_gis_data ====

**Mandatory parameters:**

**必須パラメータ:**

   * < id_of_agent >
  * < latitude >
  * < longitude >
  * < altitude >

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

**Optional parameters:**

**オプションパラメータ:**

  * <font inherit/inherit;;inherit;;rgb(251, 250, 249)>None.</font>

  * <font inherit/inherit;;inherit;;rgb(251, 250, 249)>なし</font>

**Description:**  Updates an [[:en:documentation:03_monitoring:20_gis|agent's GIS data]].

**説明:** [[:ja:documentation:03_monitoring:20_gis|エージェントの GIS データ]]を更新します。

**Examples (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_agent 1 2 3 4


</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --get_gis_agent ====

**Mandatory parameters:**

**必須パラメータ:**

   * < agent_id >

  * < エージェントID >

**Optional parameters:**

**オプションパラメータ:**

  * <font inherit/inherit;;inherit;;rgb(251, 250, 249)>None.</font>

  * <font inherit/inherit;;inherit;;rgb(251, 250, 249)>なし</font>

**Description:**  Gets an [[:en:documentation:03_monitoring:20_gis|agent's GIS data]].

**説明:** [[:ja:documentation:03_monitoring:20_gis|エージェントの GIS データ]]を取得します。

**Examples (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_gis_agent 1


</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --cli_agent_set_os ====

**Mandatory parameters:**

**必須パラメータ:**

   * < agent_id >
   * < operating_system_id >
   * < operating_system_version >

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

**Optional parameters:**

**オプションパラメータ:**

  * None.

  * なし。

**Description:**  Add or change [[:en:documentation:04_using:12_console_setup#operating_systems|operating system (and obsolescence)]] to an agent.

**説明:** エージェントの [[:ja:documentation:04_using:12_console_setup#operating_systems|オペレーティングシステム (およびそのバージョン)]] を追加または変更します。

**Examples (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --cli_agent_set_os 7 3 'Ubuntu 16.04'
</code>

===== モジュール =====
==== --create_data_module ====

**Required parameters:**

**必須パラメータ:**

   * < module_name >
  * < module_type >
  * < agent_name >

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

**Optional parameters:**

**オプションパラメータ:**

  - < description >
  - < module_group >
  - < min >
  - < max >
  - < post_process >
  - < interval >
  - < warning_min >
  - < warning_max >
  - < critical_min >
  - < critical_max >
  - < history_data >
  - < definition_file >
  - < warning_string >
  - < critical_string >
  - < enable_unknown_events >
  - < ff_threshold >
  - < each_ff >
  - < ff_threshold_normal >
  - < ff_threshold_warning >
  - < ff_threshold_critical >
  - < ff_timeout >
  - < warning_inverse >
  - < critical_inverse >
  - < critical_instructions >
  - < warning_instructions >
  - < unknown_instructions >
  - ''use_agent_alias'': For the agent search use the agent alias instead of the agent name.
  - ''ignore_unknown'': Discards the unknown state calculation, so that the module will never change to that state and will always keep the last known state.
  - < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

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

**Description:**  A module kind data will be created in an agent with the module name, kind of module and name of the agent where it will be created. Optionally it will be possible to give a description, the module group, etc.

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

The default values are ''0'' for the minimum and maximum values, history_data and post_process; ''300'' for interval.

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

**Example (see [[#pandora_fms_cli|call]] and [[#syntax|syntax]]):**

**例 ([[#pandora_fms_cli|呼び出し]]および[[#書式|書式]] を参照):**

Simple example for state scaling:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_data_module data_module_test generic_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001
</code>

Complex example, the module definition file will contain something like this:

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

<code>

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

</code>

<code bash>

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'

</code>

<WRAP center round info 60%>

If you introduce a different name or kind between the parameters and the file definition, the fixed on the file will have priority.

</WRAP>

<WRAP center round info 60%>

パラメータとファイル定義で別の名前や種類を指定すると、ファイルの設定が優先されます。

</WRAP>

==== --create_web_module ====

**Required parameters**:

**必須パラメータ**:

  * < module_name >
  * < module_kind >
  * < agent_name >

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

**Optional parameters**:

**オプションパラメータ**:

  - < description >
  - < module_group >
  - < min >
  - < max >
  - < post_process >
  - < interval >
  - < warning_min >
  - < warning_max >
  - < critical_min >
  - < critical_max >
  - < history_data >
  - < retries >
  - < requests >
  - < agent_browser_id >
  - < auth_server >
  - < auth_realm >
  - < definition_file >
  - < proxy_url >
  - < proxy_auth_login >
  - < proxy_auth_password >
  - < warning_str >
  - < critical_str >
  - < enable_unknown_events >
  - < ff_threshold >
  - < each_ff >
  - < ff_threshold_normal >
  - < ff_threshold_warning >
  - < ff_threshold_critical >
  - < ff_timeout >
  - < warning_inverse >
  - < critical_inverse >
  - < critical_instructions >
  - < warning_instructions >
  - < unknown_instructions >
  - < ''use_agent_alias'' >: For the agent search use the agent alias instead of the agent name.
  - < ''ignore_unknown'' >: Discards the unknown state calculation, so that the module will never change to that state and will always keep the last known state.
  - < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

  - <説明>
  - <モジュールグループ>
  - <最小値>
  - <最大値>
  - <倍率>
  - <間隔>
  - <警告状態の最小値>
  - <警告状態の最大値>
  - <障害状態の最小値>
  - <障害状態の最大値>
  - <保存データ>
  - <再実行>
  - <リクエスト>
  - <エージェントブラウザID>
  - <認証サーバ>
  - <認証レルム>
  - <ファイル定義>
  - <プロキシURL>
  - <プロキシログイン名>
  - <プロキシパスワード>
  - <警告文字列>
  - <障害文字列>
  - <不明イベントの有効化>
  - <連続抑制回数>
  - <個別状態変化の利用>
  - <正常移行時連続抑制回数>
  - <警告移行時連続抑制回数>
  - <障害移行時連続抑制回数>
  - <連続抑制タイムアウト>
  - <警告判定の反転>
  - <障害判定の反転>
  - <障害手順>
  - <警告手順>
  - <不明手順>
  - < ''use_agent_alias'' >
  - ''ignore_unknown'': 不明な状態の計算を行わず、モジュールがその状態に変更されることはなく、常に最後の既知の状態を保持します。
  - < 警告状態に留まる回数 > モジュールが警告状態に留まる連続間隔の最大数を指定することにより、状態のスケーリングを可能にします。 この値を超えると、モジュールは障害状態にエスカレートします。

**Description:** A web data module will be created in an agent with the module name, kind of module and name of the agent where it will be created  (see parameter ''use_agent_alias'') . Optionally it will be possible to give a description, the module group, min and max values, a post_process value, an interval in seconds, min and max warning values, min and max critical values, a history data value and one module definition file among others.

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

**Example (see [[#pandora_fms_cli|call]] and [[#syntax|syntax]]):**

**例 ([[#pandora_fms_cli|呼び出し]]および[[#書式|書式]] を参照):**

Simple example for state scaling:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_web_module web_module_test web_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

</code>

As a complex example, the module definition file will contain something like this:

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

<code>
task_begin
get http://pandorafms.com
task_end

</code>

<code bash>
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'

</code>

==== --create_network_module ====

**Required parameters**:

**必須パラメータ**:

  * < module_name >
  * < module_type >
  * < agent_name >
  * < module_address >

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

**Optional parameters**:

**オプションパラメータ**:

  * < module_port > numerical value between ''1'' and ''65535''.
  * < description >
  * < module_group >
  * < min >
  * < max >
  * < post_process >
  * < interval >
  * < warning_min >
  * < warning_max >
  * < critical_min >
  * < critical_max >
  * < history_data >
  * < ff_threshold >
  * < warning_str >
  * < critical_str >
  * < enable_unknown_events >
  * < each_ff >
  * < ff_threshold_normal >
  * < ff_treshold_warning >
  * < ff_threshold_critical >
  * < timeout >
  * < retries >
  * < critical_instructions >
  * < warning_instructions >
  * < unknown_instructions >
  * < warning_inverse >
  * < critical_inverse >
  * ''use_agent_alias'' to search for the agent by its alias instead of its name.
  * ''ignore_unknown'' Discards the unknown state calculation, so that the module will never change to that state and will always keep the last known state.
  * < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

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

**Description**: A network module will be created in an agent with the module name, module type, agent name where it will be created and the module address specified. Optionally, it can be given a port number, a description, minimum and maximum values, a post processing ' value, an interval in seconds, minimum and maximum warning values, minimum and maximum criticality values, and a historical data value.

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

The default values are ''0'' for minimum and maximum, ''history_data'' and ''post_process'' and ''300'' seconds for the interval.

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

The port number is optional, since ICMP type modules do not require it. For all other types, a module must be specified.

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

**Example (see [[#pandora_fms_cli|call]] and [[#syntax|syntax]]):**

**例 ([[#pandora_fms_cli|呼び出し]]および[[#書式|書式]] を参照):**

Simple example for state scaling:

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

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

Another example:

他の例:

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

</code>

==== --create_network_component ====
**オプションパラメータ:** <ネットワークコンポーネント名> <ネットワークコンポーネントグループ> <ネットワークコンポーネントタイプ> [<説明> <間隔> <最大値> <最小値> <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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --create_snmp_module ====

**Required parameters**:

**必須パラメータ**:

  * < module_name >
  * < module_type >
  * < agent_name >
  * < module_address >
  * < module_port >
  * < version >

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

**Optional parameters**:

**オプションパラメータ**:

  * < community >
  * < oid >
  * < description >
  * < module_group >
  * < min >
  * < max >
  * < post_process >
  * < interval >
  * < warning_min >
  * < warning_max >
  * < critical_min >
  * < critical_max >
  * < history_data >
  * < snmp3_priv_method >
  * < snmp3_priv_pass >
  * < snmp3_sec_level >
  * < snmp3_auth_method >
  * < snmp3_auth_user >
  * < snmp3_auth_pass >
  * < ff_threshold>
  * < warning_str >
  * < critical_str >
  * < unknown_events >
  * < each_ff >
  * < ff_threshold_normal >
  * < ff_threshold_warning >
  * < ff_threshold_critical >
  * < timeout >
  * < retries >
  * ''use_alias'' to search for the agent by its alias instead of its name.
  * ''ignore_unknown'' Discards the unknown state calculation, so that the module will never change to that state and will always keep the last known state.
  * < critical_instructions >
  * < warning_instructions >
  * < unknown_instructions >
  * < warning_inverse >
  * < critical_inverse >
  * < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

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

**Description**: An SNMP type module will be created in an agent with the module name, module type, name of the agent where it will be created, the module address, the associated port and the SNMP version specified. Optionally, a community name, OID, description, module group, minimum and maximum values, post processing value, interval in seconds, minimum and maximum warning values, minimum and maximum criticality values, and SNMP 3 parameters such as methods, passwords, etc. can be provided.

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

The default values are ''0'' for minimum and maximum, ''history_data'' and ''post_process'' and 300 seconds for the interval.

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

**Example (see [[#pandora_fms_cli|call]] and [[#syntax|syntax]]):**

**例 ([[#pandora_fms_cli|呼び出し]]および[[#書式|書式]] を参照):**

Simple example for state scaling:

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

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

Another example:

他の例:

<code bash>
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'

</code>

==== --create_plugin_module ====

**Required parameters**:

**必須パラメータ**:

  * < module_name >
  * < module_type >
  * < agent_name >
  * < module_address >
  * < module_port > numerical value between ''1'' and ''65535''.
  * < plugin_name >
  * < user >
  * < password >
  * < parameters >

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

**Parámetros opcionales**:

**オプションパラメータ**:

  * < description >
  * < module_group >
  * < min >
  * < max >
  * < post_process >
  * < interval >
  * < warning_min >
  * < warning_max >
  * < critical_min >
  * < critical_max >
  * < history_data >
  * < ff_threshold >
  * < warning_str >
  * < critical_str >
  * < enable_unknown_events >
  * < each_ff >
  * < ff_threshold_normal >
  * < ff_treshold_warning >
  * < ff_threshold_critical >
  * < timeout > 
  * < critical_instructions >
  * < warning_instructions >
  * < unknown_instructions >
  * < warning_inverse >
  * < critical_inverse > 
  * ''use_agent_alias'' to search for the agent by its alias instead of its name.
  * ''ignore_unknown'' Discards the unknown state calculation, so that the module will never change to that state and will always keep the last known state.
  * < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

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

**Description**: A module of type //plugin// will be created in an agent with the module name, module type, name of the agent where it will be created, the module address, the associated port and the corresponding plugin name. Optionally, a description, the module group, minimum and maximum values, a post processing value, an interval in seconds, minimum and maximum warning values, minimum and maximum criticality values, among other optional values, can be provided.

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

The default values are ''0'' for minimum and maximum, ''history_data'' and ''post_process'' and ''300'' for the interval.

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

**Example (see [[#pandora_fms_cli|call]] and [[#syntax|syntax]]):**

**例 ([[#pandora_fms_cli|呼び出し]]および[[#書式|書式]] を参照):**

Simple example for state scaling:

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module plugin_module_test generic_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 "1" "DNS Plugin" "admin" "pandora" "100" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

</code>

Another example:

他の例:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module 'My module' generic_data 'Mi agente' 192.168.12.123 8080 myplugin myuser mypass 'param1 param2 param3' 'Descripcion del modulo' 'General' 1 3 0 300 0 0 0 0 1

</code>

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

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

**実行例:**

  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_group "grupo de módulos"

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

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

**実行例:**

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

==== --module_group_synch ====
**オプションパラメータ:** <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"

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

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

<code>
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 <オプション>
</code>

<オプション> に利用可能なパラメータは以下の通りです。
  * <オプション> = <source_agent1>,<operator>,<source_module1> <source_agent2>,<operator>,<source_module2> 
  * <オプション> = <source_agent1>,<operator>,<source_module1> <operator>,<fixed_value>

**例**

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

最初の例では、//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

==== --delete_module ====

**Mandatory parameters:**

**必須パラメータ:**

   * < module_name >
  * < agent_name >

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

**Optional parameter:**

** オプションパラメータ:**

  * ''use_alias''

**Description:**  A module will be removed from an agent by passing the name of both as a parameter. In case this module is in a local agent, it will also be deleted from the configuration file if the Enterprise version is available. From version 771 on wards, the //descendants//  of the deleted module are deleted recursively.

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

**Examples (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ( [[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]] および [[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --delete_module 'My module' 'My agent'

</code>

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

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

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

**実行例:**

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

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

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

**実行例:**

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

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

==== --add_tag_to_module ====

**Parameters:**  <agent_name> <module_name> <tag_name>

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

**Description:**  Add a tag to the given module.

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

**Example:**

**実行例:**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --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_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'

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

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

**実行例:**

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

===== アラート =====
==== --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> 
    * **例**: 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" "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

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --create_alert_command ====
(バージョン 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","","","","","",""]'

==== --get_alert_commands ====
(バージョン 5.0 以上)

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

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

**実行例:**

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

==== --validate_alert ====

**Parameters:** <template_name> <agent_id> <module_id> [ ''use_alias'' ]

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

**Description:** Validate an alert given a template name, an agent ID and a module ID. Instead use only an agent ID you may use name agent with last parameter ''use_alias'' (maybe for validate multiple alerts).

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

**Example:**

**実行例:**

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

</code>

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

==== --set_event_storm_protection ====

**Parameters:** <value>

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

**Description:** Enable (''1'') or disable (''0'') [[:en:documentation:04_using:01_alerts#cascade_protection|event storm protection]].

**説明:** [[:ja:documentation:04_using/12_console_setup#一般設定|イベントストーム保護]] を有効化(''1'')または無効化(''0'')します。

**Example:**

**実行例:**

<code>

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

</code>

===== ユーザ =====
==== --create_user ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameters:**

**必須パラメータ:**

   * < id_user >
  * < password >
  * < is_admin >

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

**Optional parameters:**

**オプションパラメータ:**

  * < comments >

  * < コメント >

**Description:**

**説明:**

A user will be created with the user ID (which will also be the user name) and the password received. In addition a binary value ( < is_admin > ''0''  false or ''1''  true) will be received specifying whether the user will be an [[:en:documentation:01_understanding:03_glossary#superadmin|superadmin]] or not. Optionally a comment about the created user can be added.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

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


</code>
==== --delete_user ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameter:**

**必須パラメータ:**

   * <id_user >

   * < ユーザ名 >

**Description:**

**説明:**

An user will be eliminated giving its name as parameter.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --delete_user user02

</code>

==== --update_user ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameters:**

**必須パラメータ:**

   * < id_user >
  * < field_to_update >
  * < new_value >

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

**Description:**

**説明:**

A given field of an existent user will be updated. The possible fields are the following:

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

  * ''email''.
  * ''phone''.
  * ''is_admin'' ¿Is [[:en:documentation:01_understanding:03_glossary#superadmin|superadmin]]? (''0''  false,''1''  true).
  * ''language''  , possible values:
      * ''default'', English US.
      * ''ca'', Catalan.
      * ''en_GB'', English UK.
      * ''es'', Spanish.
      * ''fr'', French.
      * ''ru'', Russian.
      * ''ja'', Japanese.
      * ''zh_CN''  , Chinese.
  * ''id_skin''  (only works in Enterprise version) Change skin graphical for user.
  * ''comments''.
  * ''fullname''.
  * ''password''.

  * ''email''.
  * ''phone''.
  * ''is_admin'' [[:ja:documentation:01_understanding:03_glossary#スーパー管理者|スーパー管理者]] (''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''.

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_user 'user 9500' password 'XYZ'

</code>

==== --enable_user ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>


**Required parameter:**

**必須パラメータ:**

   * < user_id >

   * < ユーザ名 >

**Description:**

**説明:**

An existent user will be enabled. If it's already enabled, will showed only a message.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --enable_user 'user 9500'


</code>


==== --disable_user ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameter:**

**必須パラメータ:**

   * < user_id >

   * < ユーザ名 >

**Description:**

**説明:**

An existent user will be disabled. If it's already disabled, will showed only a message.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'user 9500'


</code>

==== --create_profile ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameters:**

**必須パラメータ:**

   * < profile_name >
  * < rights_list > Use ''1''  or ''0''  for otorgate or deny right, respectively. They are numbered so:
      - AR View agents.
      - AW Edit agents.
      - AD Disable agents.
      - LW Edit alerts.
      - LM Manage alerts.
      - UM Manage users.
      - DM Manage database.
      - ER View events.
      - EW Edit events.
      - EM Manage events.
      - RR View reports.
      - RW Edit reports.
      - RM Manage reports.
      - MR View network maps.
      - MW Edit network maps.
      - MM Manage network maps.
      - VR View visual console.
      - VW Edit visual console.
      - VM Manage visual console.
      - PM Pandora FMS management.
      - **NR**  View NCM data.
      - **NW**  Operate NCM -you must include **NR**-.
      - **NM**  Manage NCM -you must include **NW**  and **NR**-.

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

**Descripción:**

**説明:**

A new profile will be created by passing the profile name and permissions as parameters. <wrap em>All fields are required.</wrap>

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

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


</code>

==== --update_profile ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameters:**

**必須パラメータ:**

   * < profile_name >
  * < rights_list > Use ''1''  or ''0''  for otorgate or deny right, respectively. They are numbered so:
      - AR View agents.
      - AW Edit agents.
      - AD Disable agents.
      - LW Edit alerts.
      - LM Manage alerts.
      - UM Manage users.
      - DM Manage database.
      - ER View events.
      - EW Edit events.
      - EM Manage events.
      - RR View reports.
      - RW Edit reports.
      - RM Manage reports.
      - MR View network maps.
      - MW Edit network maps.
      - MM Manage network maps.
      - VR View visual console.
      - VW Edit visual console.
      - VM Manage visual console.
      - PM Pandora FMS management.
      - **NR**  View NCM data.
      - **NW**  Operate NCM -you must include **NR**-.
      - **NM**  Manage NCM -you must include **NW**  and **NR**-.

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

**Descripción:**

**説明:**

A existent profile will be updated by passing the profile name and permissions as parameters. <wrap em>All fields are required.</wrap>

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

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


</code>

==== --add_profile ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameters:**

**必須パラメータ:**

   * < id_user >
  * < profile_name >
  * < group_name >

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

**Description:**

**説明:**

A profile will be added to an user giving it as parameter the names of user, profile an group on which they will have the privileges of this profile. You should specify the group ''All''  if you want that the profile has validity on all groups.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile usuario002 'Group coordinator' All

</code>

==== --add_tag_to_user_profile ====

**Parameters:** <user_id> <tag_name> <group_name> <profile_name>

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

**Description:** Add a tag to the given user profile.

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

**Example:**

**実行例:**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --delete_profile ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameters:**

**必須パラメータ:**

   * < id_user >
  * < profile_name >
  * < group_name >

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

**Description:**

**説明:**

An user profile will be deleted giving it as parameter the names of user, profile and group on which the profiles has the priviledges. If the profile to delete is associated to the ''All''  group, we should specify as group ''All''.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --delete_profile user02 'Chief Operator' Applications

</code>

==== --add_profile_to_user ====

<WRAP center round info 60%>

NG 766 version or later: This function also works in Metaconsole.

</WRAP>

<WRAP center round info 60%>

バージョン NG 766 以降: この機能はメタコンソールでも動作します。

</WRAP>

**Required parameters:**

**必須パラメータ:**

   * < id_user >
  * < profile_name >

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

**Optinal parameter:**

**オプションパラメータ:**

  * < group_name >

  * < グループ名 >

**Description:**

**説明:**

Add a existing profile in group to a user. If the group is not provided, the grupo will be ''All''.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile_to_user 'user01' 'Chief Operator' 'Network'

</code>

==== --disable_eacl ====
**オプションパラメーター:** なし

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

**実行例:**

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_eacl

</code>

==== --enable_eacl ====
**オプションパラメーター:** なし

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

**実行例:**

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_eacl

</code>
==== --disable_double_auth ====
**オプションパラメータ:** <ユーザID>

**Description:** The [[:en:documentation:04_using:12_console_setup#double_authentication|double authentication]] will be disabled for the specified user.

**説明:** 特定ユーザに対して[[:ja:documentation:04_using:12_console_setup#二段階認証|二段階認証]]を無効化します。

**実行例:**

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

===== イベント =====
==== --create_event ====

**Mandatory parameters**:

** 必須パラメータ**:

   * Event name.
  * Event type. You can take any of these values:
      * ''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''  .
  * Group name.

  * イベント名。
  * イベントタイプ。以下のいずれかを指定できます。
      * ''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''
  * グループ名。

**Optinal parameters**:

**オプションパラメータ**:

  * Agent name.
  * Module name.
  * Event state  (''0''  if it **isn't**  validated, ''1'' if is validated and ''2'' in process).
  * Severity: ''0''  (Maintenance), ''1''  (Informational), ''2''  (Normal), ''3''  (Warning), ''4''  (Critical), ''5''  (Minor) y ''6''  (Major).
  * Template name in the case that is would be associated to one alert.
  * User name.
  * Comment.
  * Source.
  * Extra id.
  * Tags: Format should be < tag > < url >,< tag > < url > You can add multiple tags separated by commas. //It is important that there are no spaces between the comma and the next label.//
  * Custom data: Custom data should be entered as a JSON document. For example: ''{"Location": "Office", "Priority": 42}''  .
  * Force creation of agent (//bool//): If the agent name parameter refers to an agent that does not exist, it will be created.
  * Critical instructions: Add the instructions to be performed in the case of a critical condition
  * Warning instructions: Add the instructions to be performed in the case of a warning condition
  * Unknown instructions: Add the instructions to perform in case of going to unknown state
  * Usar alias del agente, utilice textualmente ''use_alias''. //Se deben especificar dos comillas simples juntas, sin espacio entre ellas) si utiliza el siguiente parámetro a continuación//.
  * **Metaconsole: **Server identifier (Enterprise version only).

  * エージェント名
  * モジュール名
  * イベントの状態 (''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 版のみ).

**Description**:

**説明**:

An event will be created with these data: the name and kind of the event, name of the module, agent and group associated.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

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


</code>

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

**Required parameters:**

**必須パラメータ:**

   * < id_event >
  * < id_user >
  * < comment >

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

**Description:**

**説明:**

Add a comment to an event.

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

**Example (see [[:en:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|call]] and [[:en:documentation:08_technical_reference:03_anexo_cli#syntax|syntax]]):**

**例 ([[:ja:documentation:08_technical_reference:03_anexo_cli#pandora_fms_cli|呼び出し]]および[[:ja:documentation:08_technical_reference:03_anexo_cli#書式|書式]] を参照):**

<code>

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

</code>

In this example, comment ''TEXT'' by ''admin'' will be added to the event whose identifier is ''1234''.

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

==== --event_in_progress ====

**Parameters:** <id_event>

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

**Description:** Set event in progress.

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

**Example:**

**実行例:**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

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

**実行例:**

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

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

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

このコマンドは 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'

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

==== --recreate_collection ====

{{:wiki:icono-modulo-enterprise.png?23x23  |Version Enterprise}}**Parameters:** <collection_id>

{{:wiki:icono-modulo-enterprise.png?23x23  |Enterprise 版}}**オプションパラメータ:** <コレクションID>

**Description:** Recreate the files of a collection. Returns ''[INFO] Collection recreated successfully.'' otherwise ''[ERROR] Collection not recreated.''

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

**Example:**

**実行例:**

<code>

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

</code>

==== --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 ====
**オプションパラメーター:** なし

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

**実行例:**

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_not_policy_modules

</code>
==== --remove_agent_from_policy ====
**オプションパラメータ:** <id_policy> <id_agent>

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

**実行例:**

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

==== --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 ファイルが必要です。

<code>
 User 1,Password 1,0
 User 2,Password 2,0
 User 3,Password 3,0
 User Admin,Password Admin,1
</code>

ファイル名は、'/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 ====

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

==== --start_snmptrapd ====

**Parameters:** Nothing.

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

Starts the ''snmptrapd'' process on the traps server. In case it is already started, it terminates the service (**kill** command) and runs it again, deleting all the traps located in the exchange log (by default ''/var/log/pandora/pandora_snmptrapd.log'').

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

**Example:**

**実行例:**

<code>
pandora_manage /etc/pandora/pandora_server.conf --start_snmptrapd

</code>

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

**Description:** You can create a graph with these elements. Two or more modules must be separated with <separator> wich always must be specified, even for a single module. //All parameters are required, but some of them can be empty by singles quotes.// Their default values are:

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

   * Width: ''550''.
  * Height: ''210''.
  * Period: ''86400''  (seconds).
  * Events: ''0''.
  * Graph type: ''0''.
  * Id group: ''0''.

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

**実行例:**

<code>
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' ';'

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

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

**実行例:**

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

</code>

{{  :wiki:pfms-08_technical_reference-03_anexo_cli-edit_custom_graph-img01.png  }}
==== --add_modules_to_graph ====
**オプションパラメータ:** <グラフID> <モジュール> <セパレータ>

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

**実行例:**

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

</code>

{{  :wiki:pfms-08_technical_reference-03_anexo_cli-add_modules_to_graph-img01.png  }}


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

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

**実行例:**

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

</code>

{{  :wiki:pfms-08_technical_reference-03_anexo_cli-delete_modules_to_graph-img01.png  }}


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

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

**実行例:**

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

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --add_cluster_agent ====
**オプションパラメータ:** <json_data_base64:[{"id":5,"id_agent":2},{"id":5,"id_agent":3}]>

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

**実行例 :**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --add_cluster_item (アクティブ / アクティブ) ====

**オプションパラメータ:**

JSON data with this fields:

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

  * ''name''  : (string value).
  * ''id_cluster''  : (numeric value).
  * ''type''  : ''AA''  (means "**Active/Active**").
  * ''critical_limit''  : (numeric value).
  * ''warning_limit''  : (numeric value).

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

**Example JSON:**

**JSON の例:**

<code>
[
  {
    "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
  }
]

</code>

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

<WRAP center round important 60%>It is absolutely necessary that JSON data is encoded on base 64.</WRAP>

<WRAP center round important 60%>base64 で JSON データがエンコードされている必要があります。</WRAP>

**実行例 :**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --add_cluster_item (アクティブ / スタンバイ) ====
**オプションパラメータ:** 

JSON data with this fields:

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

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

**Example JSON:**

**JSON の例:**

<code>
[
  {
    "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
  }
]

</code>

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

<WRAP center round important 60%>It is absolutely necessary that JSON data is encoded on base 64.</WRAP>

<WRAP center round important 60%>base64 で JSON データがエンコードされている必要があります。</WRAP>

**実行例 :**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

==== --get_cluster_status ====

**Parameters:** <id_cluster>

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

**Description:** Getting cluster status.

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

**Example:**

**実行例 :**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

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

**実行例:**

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

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

**実行例:**

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

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

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

**実行例:**

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

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

===== ビジュアルコンソール =====
==== --create_visual_console ====
**オプションパラメータ:** <名前> <背景> <幅> <高さ> <グループ> <モード> [<要素の位置> <背景色> <要素>] 

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

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

**例 (auto_creation):**

<code>

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"}]'

</code>

**例 (static_objects):**

<code>
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"}]'

</code>

==== --edit_visual_console ====
**オプションパラメータ:** <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"}]'


==== --delete_visual_console ====
**オプションパラメータ:** <ID>

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

**例:**

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

==== --delete_visual_console_objects ====
**オプションパラメータ:** <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

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

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

**例:**

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

==== --export_json_visual_console ====
**オプションパラメータ:** <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


===== その他 =====



==== --locate_agent ====

{{:wiki:icono-modulo-enterprise.png?23x23  |Enterprise version}}**Parameters:** <agent_name> [ ''use_alias'' ] .

{{:wiki:icono-modulo-enterprise.png?23x23  |Enterprise 版}}**オプションパラメータ:** <エージェント名> [ ''user_alias'' ]]

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

**例:**

<code>

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

</code>



==== --create_tag ====

**Parameters:** <tag_name> <tag_description> [ <tag_url> ] [ <tag_email> ]

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

**Description:** Create a new tag. Tag name and tag description are obligatory.

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

**Example:**

**実行例:**

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

</code>

<WRAP center round important 75%>

For it to be carried out correctly, the API configuration parameters will need to be filled in ''pandora_server.conf''  ([[:en:documentation:02_installation:04_configuration#configuration_file_elements|configuration file elements]]) : ''console_api_pass''  , ''console_pass''  , ''console_user''  y ''console_api_url''  .

</WRAP>

<WRAP center round important 75%>

正しく動作するためには、''pandora_server.conf'' 内に API の設定が必要です。([[:ja:documentation:02_installation:04_configuration#設定ファイルの項目|設定ファイル内の項目]]) : ''console_api_pass''  , ''console_pass''  , ''console_user'' および ''console_api_url''

</WRAP>

===== OBSOLETE =====

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

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

**オプションパラメータ:** <user_name_1,user_name_2,..user_name_n> <server_name> [<profile_mode> <group_name> <profile_1,profile_2..,profile2> <create_groups>]

**説明:** メタコンソールから 1つ以上のユーザをノードへ同期します。最初のパラメータには、カンマ区切りで同期したいユーザを指定します。2つ目のパラメータには、同期したいノードの名前を指定します。オプションで以下を指定できます。

  *  1つまたは複数のユーザのオリジナルのプロファイルまたは複数のプロファイルをコピーしたい場合は (0) を指定します。別のプロファイルと新しいグループをコピーしたい場合は (1) を指定し、以下のパラメータを指定します。 デフォルトは 0 です。
  *  グループの名前。すべてのグループでユーザを有効にしたい場合は、'全て' グループを指定します。
  *  カンマ区切りの割り当てたいプロファイル。
  *  指定のノードにグループが存在しない場合、メタコンソールのそれをコピーする場合は(1)。空にする場合は(0)。デフォルトは 0 です。


**実行例:**

  perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_synch_user "usuario1,usuario2" "nodo1" "1" "All" "Chief operator,Group coordinator" "0"

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

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

[[ja:documentation:start|Pandora FMS ドキュメント一覧に戻る]]


===== (OBSOLETE) =====

==== エージェント (概要) ====

You may use agent alias instead agent name itself by using ''use_alias'' parameter **at the end of line** command.

コマンドの最後に ''use_alias'' パラメータを使用すると、エージェント名の代わりにエージェントの別名を使用できます。

   - ''create_agent'': Create an agent.
  - ''update_agent'': Update an agent field.
  - ''agent_update_custom_fields'': Update agent custom fields.
  - ''delete_agent'': Delete an agent.
  - ''disable_group'': Disable all agents from one group.
  - ''enable_group'': Enable all agents from one group.
  - ''create_group'': Create a group.
  - ''delete_group'': Delete a group.
  - ''update_group'': Update a group.
  - ''stop_downtime'': Stop a planned downtime.
  - ''get_agent_status'': Get the status of a given agent.
  - ''get_agent_group'': Get the group name of a given agent.
  - ''get_agent_modules'': Get the module list of a given agent.
  - ''get_agents'': Get list of agents with optative filter parameters.
  - ''get_agents_id_name_by_alias'': List id and alias of agents matching given alias.
  - ''delete_conf_file'': Delete a local conf of a given agent.
  - ''clean_conf_file'': Clean a local config file of a given agent deleting all modules, policies and collections data.
  - ''get_bad_conf_files'': Get the files bad configured (without essential tokens).
  - ''migration_agent_queue'': migrate an agent from one node to another with the Metaconsole (Enterprise version only).
  - ''migration_agent'': see if there is an agent in the migration queue (Enterprise version only).
  - ''set_disabled_and_standby'': Disable an agent and put it in standby mode (Enterprise version only).
  - ''reset_agent_counts'': Updates module counts and alert counts.

  - ''--create_agent'': エージェントを作成
  - ''--update_agent'': エージェントのフィールドを更新
  - ''--agent_update_custom_fields'': エージェントのカスタムフィールドを更新
  - ''--delete_agent'': エージェントを削除
  - ''--disable_group'': あるグループ内のすべてのエージェントを無効化
  - ''--enable_group'': あるグループ内のすべてのエージェントを有効化
  - ''--create_group'': グループを作成
  - ''--delete_group'': グループを削除
  - ''--update_group'': グループを更新
  - ''--stop_downtime'': 計画停止を停止
  - ''--get_agent_status'': 指定したエージェントの状態を取得
  - ''--get_agent_group'': 指定したエージェントのグループ名を取得
  - ''--get_agent_modules'': 指定したエージェントのモジュール一覧を取得
  - ''--get_agents'': フィルタパラメータにてエージェントの一覧を取得
  - ''--get_agents_id_name_by_alias'': 指定した別名にマッチするエージェントの ID 別名の一覧を取得
  - ''--delete_conf_file'': 指定したエージェントのローカル設定を削除
  - ''--clean_conf_file'': 指定したエージェントの設定から全モジュール、ポリシー、コレクションを削除
  - ''--get_bad_conf_files'': 不正な設定ファイルを取得(必須設定を除く)
  - ''--migration_agent_queue'': エージェントをあるノードから別のノードに移行します(メタコンソールのみ)
  - ''--migration_agent'': 移行キューにエージェントがあるかどうかを確認します(メタコンソールのみ)
  - ''--set_disabled_and_standby'': エージェントを無効化およびスタンバイモードにします(Enterprise 版)
  - ''--reset_agent_counts'': モジュールおよびエージェントカウントを更新します。

==== モジュール (概要) ====

  - ''create_data_module'': Add one data module to one agent.
  - ''create_web_module'': Add one web module to one agent.
  - ''create_network_module'': Add one network module to one agent.
  - ''create_network_component'': Create a new network component.
  - ''create_snmp_module'': Add one SNMP module to one agent.
  - ''create_plugin_module'': Add one module kind plugin to one agent.
  - ''get_module_group'': Displays the filtered groups of available modules.
  - ''create_module_group'': Create a group (module type).
  - ''module_group_synch'': Synchronize group of modules from the Metaconsole (Enterprise version only).
  - ''delete_module'': Delete one module from one agent.
  - ''data_module'': Insert data to one module.
  - ''get_module_data'': Show data from one module in the last X seconds (interval) in CSV format.
  - ''get_module_id'': Show id from one module.
  - ''get_module_custom_id'': Shows the Custom ID of a module.
  - ''set_module_custom_id'': Set the Custom ID of a module. //If it is left blank it will remove the content that would have existed previously leaving the field empty//.
  - ''delete_data'': Delete the historic data from a module, from the modules of one agent or from the modules of the agents of one group.
  - ''update_module'': Update one module field.

  - ''--create_data_module'': エージェントにデータモジュールを追加
  - ''--create_web_module'': エージェントに Webモジュールを追加
  - ''--create_network_module'': エージェントにネットワークモジュールを追加
  - ''--create_network_component'': 新たなネットワークコンポーネントを作成
  - ''--create_snmp_module'': エージェントに SNMP モジュールを追加
  - ''--create_plugin_module'': エージェントにプラグインモジュールを追加
  - ''--get_module_group'': 存在するモジュールのフィルタしたグループを表示
  - ''--create_module_group'': グループを作成 (モジュールタイプ)
  - ''--module_group_synch'': メタコンソールからモジュールのグループを同期
  - ''--delete_module'': エージェントからモジュールを削除
  - ''--data_module'': モジュールにデータを追加
  - ''--get_module_data'': 直近の X 秒間のモジュールデータを CSV フォーマットで表示
  - ''--get_module_id'': 一つのモジュールの ID を表示
  - ''--get_module_custom_id'': モジュールのカスタム ID を表示
  - ''--set_module_custom_id'': モジュールのカスタム ID を設定。空白にすると、設定されていた内容が削除され、フィールドは空になります。
  - ''--delete_data'': 収集データ、エージェントのモジュール、または、グループのエージェントモジュールを削除
  - ''--update_module'': モジュールのフィールドを更新

==== アラート (概要) ====


  - ''create_template_module'': Add an alert template to an agent.
  - ''delete_template_module'': Delete an alert template from an agent.
  - ''create_template_action'': Create an action to one agent.
  - ''delete_template_action'': Delete an action from an agent.
  - ''disable_alerts'': Disable alerts in all groups.
  - ''enable_alerts'': Enable alerts in all groups.
  - ''create_alert_template'': Create an alert template.
  - ''delete_alert_template'': Delete an alert template.
  - ''update_alert_template'': Update field of an alert template.
  - ''get_alert_actions'': Allows to visualize the actions of alerts.
  - ''get_alert_actions_meta'': Allows to visualize the actions of node alerts from the Metaconsole (Enterprise version only).
  - ''create_alert_command'': Creates an alert command.
  - ''get_alert_commands'': Allows to visualize alert commands.
  - ''validate_all_alerts'': Validates all the alerts.

  - ''--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'': アラートテンプレートのフィールド更新
  - ''--get_alert_actions'': アラートのアクションを表示
  - ''--get_alert_actions_meta'': メタコンソールからノードアラートのアクションを表示 (メタコンソールのみ)
  - ''--create_alert_command'': アラートコマンドを作成
  - ''--get_alert_commands'': アラートコマンドを表示
  - ''--validate_all_alerts'': 全アラートの承諾

==== ユーザ (概要) ====

  - ''create_user'': Create one user.
  - ''delete_user'': Delete one user.
  - ''update_user'': Update field of a user.
  - ''enable_user'': Enable a given user.
  - ''disable_user'': Disable a given user.
  - ''create_profile'': Create a new profile.
  - ''update_profile'': Update a profile.
  - ''add_profile'': Add a profile to an user.
  - ''add_tag_to_user_profile'': Add a tag to the given user profile.
  - ''delete_profile'': Delete a profile from an user.
  - ''add_profile_to_user'': Add a profile to a user in a group
  - ''disable_eacl'': Disable the ACL Enterprise system.
  - ''enable_eacl'': Enable the ACL Enterprise system.

  - ''--create_user'': ユーザの作成
  - ''--delete_user'': ユーザの削除
  - ''--update_user'': ユーザのフィールド更新
  - ''--enable_user'': ユーザを有効化
  - ''--disable_user'': ユーザを無効化
  - ''--create_profile'': プロファイルを追加
  - ''--update_profile'': プロファイルを更新
  - ''--add_profile'': ユーザにプロファイルを追加
  - ''--add_tag_to_user_profile'': 指定したユーザプロファイルへタグを追加
  - ''--delete_profile'': ユーザからプロファイルを削除
  - ''--add_profile_to_user'': グループ内のユーザへのプロファイルの追加
  - ''--disable_eacl'': Enterprise ACL の無効化
  - ''--enable_eacl'': Enterprise ACL の有効化

==== イベント (概要) ====

  - ''create_event'': Create an event.
  - ''validate_event'': Validate an event.
  - ''validate_event_id'': Validate an event given a event id.
  - ''get_event_info'': Display info about a event given a event id.
  - ''event_in_progress'': Set event in progress.

  - ''--create_event'': イベントの作成
  - ''--validate_event'': イベントの承諾
  - ''--validate_event_id'': 指定したイベントIDのイベントの承諾
  - ''--get_event_info'': 指定したイベントIDのイベント情報の表示
  - ''--event_in_progress'': イベントを処理中に設定




==== ポリシー (概要) ====

  - ''create_policy'': Create a policy.
  - ''apply_policy'': Force the application of a policy.
  - ''apply_all_policies'': Add to the application queue all the policies.
  - ''add_agent_to_policy'': Add an agent to a policy.
  - ''add_collection_to_policy'': Add a collection to a policy.
  - ''recreate_collection'': Recreate the files of a collection.
  - ''create_policy_data_module_from_local_component'': Create a data module from a local component to a policy.
  - ''delete_not_policy_modules'': Delete all the modules not associated to policies from the conf file.
  - ''remove_agent_from_policy'': Remove an agent from a policy.
  - ''disable_policy_alerts'': Disable all the alerts from a policy.
  - ''create_policy_data_module'': Create a policy data module.
  - ''create_policy_web_module'': Create a policy web module.
  - ''create_policy_network_module'': Create a policy network module.
  - ''create_policy_snmp_module'': Create a policy SNMP module.
  - ''create_policy_plugin_module'': Create a policy plugin module.
  - ''validate_policy_alerts'': Validate all the alerts of a given policy.
  - ''get_policy_modules'': Get the module list of a policy.
  - ''get_policies'': Get all the policies (without parameters) or the policies of a given agent (agent name as parameter).

  - ''--create_policy'': ポリシーの作成
  - ''--apply_policy'': ポリシーの強制適用
  - ''--apply_all_policies'': 全てのポリシーへの適用
  - ''--add_agent_to_policy'': ポリシーにエージェントを追加
  - ''--add_collection_to_policy'': ポリシーにコレクションを追加
  - ''--recreate_collection'': コレクションファイルを再作成
  - ''--create_policy_data_module_from_local_component'': ローカルコンポーネントから、ポリシーにデータモジュールを作成
  - ''--delete_not_policy_modules'': 設定ファイルからポリシーに割り当てられていないモジュールを削除
  - ''--remove_agent_from_policy'': ポリシーからエージェントを削除
  - ''--disable_policy_alerts'': ポリシーから全てのアラートを無効化
  - ''--create_policy_data_module'': ポリシーデータモジュールの作成
  - ''--create_policy_web_module'': ポリシー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'': Execute any CLI option using macros from a CSV file.
  - ''create_snmp_trap'': Creates a trap with a name which will be displayed in the trap console.
  - ''start_snmptrapd'': Start the ''snmptrapd''  process on the traps server.

  - ''--exec_from_file'': CSV ファイルからマクロを読み込んで CLI を実行する
  - ''--create_snmp_trap'': トラップコンソールに表示される名前でトラップを作成します。
  - ''--start_snmptrapd'': トラップサーバで、''snmptrapd'' プロセスを開始します。


==== ビジュアルコンソール (概要) ====

  - ''create_visual_console'': Create a visual console in pandora following the indicated scheme.
  - ''edit_visual_console'': Edit a visual console in pandora following the indicated scheme.
  - ''delete_visual_console'': Eliminate a visual console and all its associated elements.
  - ''delete_visual_console_objects'': Remove elements associated with a visual console following a filter.
  - ''duplicate_visual_console'': Duplicate a visual console as many times as indicated.
  - ''export_json_visual_console'': Exports a visual console and its elements to JSON format.

  - ''--create_visual_console'': 指定したスキームに従って、pandora でビジュアルコンソールを作成
  - ''--edit_visual_console'': 指定したスキームに従って、pandoraでビジュアルコンソールを編集
  - ''--delete_visual_console'': ビジュアルコンソールと関連する全要素を削除
  - ''--delete_visual_console_objects'': フィルタに従ってビジュアルコンソールに関連する要素を削除
  - ''--duplicate_visual_console'': 指定した数ビジュアルコンソールを複製
  - ''--export_json_visual_console'': JSON フォーマットでビジュアルコンソールとその要素をエクスポート

==== グラフ (概要) ====

  - ''create_custom_graph'': A graph will be created with the specified elements.
  - ''edit_custom_graph'': A graph with the specified elements will be edited.
  - ''add_modules_to_graph'': The modules specified in the selected chart will be added.
  - ''delete_modules_to_graph'': The modules specified in the selected chart will be deleted.

  - ''--create_custom_graph'': 指定した要素でグラフを作成
  - ''--edit_custom_graph'': 指定した要素でグラフを編集
  - ''--add_modules_to_graph'': 選択したグラフで指定されたモジュールを追加
  - ''--delete_modules_to_graph'': 選択したグラフで指定されたモジュールを削除

==== クラスタ (概要) ====

  - ''new_cluster'': A cluster with the specified parameters and their associated elements will be created.
  - ''add_cluster_agent'': A specific agent will be added to the specified cluster.
  - ''add_cluster_item''  (active / active): Adding item to cluster.
  - ''add_cluster_item''  (active / pasive): Adding item to cluster.
  - ''get_cluster_status'': Getting cluster status.
  - ''delete_cluster'': A cluster will be deleted.
  - ''delete_cluster_agent'': An agent added to a cluster will be disassociated.
  - ''delete_cluster_item'': A cluster item will be deleted.

  - ''--new_cluster'': 指定されたパラメータとそれに関連する要素を持つクラスターを作成
  - ''--add_cluster_agent'': 指定のクラスタへ特定のエージェントを追加
  - ''--add_cluster_item''  (アクティブ / アクティブ): クラスタへのアイテム追加
  - ''--add_cluster_item''  (アクティブ / スタンバイ): クラスタへのアイテム追加
  - ''--get_cluster_status'': クラスタの状態取得
  - ''--delete_cluster'': クラスタを削除
  - ''--delete_cluster_agent'': クラスタに追加されたエージェントの関連付け解除
  - ''--delete_cluster_item'': クラスタアイテムの削除

==== その他 (概要) ====

  - ''locate_agent'': Searches for an agent in the nodes of a Metaconsole and returns its ID.
  - ''create_tag'': Create a new tag.

  - ''--locate_agent'': メタコンソールのノードでエージェントを検索し、その ID を返す
  - ''--create_tag'': 新規タグの作成