ja:documentation:pandorafms:technical_reference:02_annex_externalapi

差分

このページの2つのバージョン間の差分を表示します。

この比較画面へのリンク

両方とも前のリビジョン 前のリビジョン
次のリビジョン		 前のリビジョン
ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2024/09/08 13:59] – [set add_module_in_conf] junichija:documentation:pandorafms:technical_reference:02_annex_externalapi [2024/11/09 23:22] (現在) – [get special_days] junichi
行 755: 行 755:
 == get agent_module_name_last_value_alias == == get agent_module_name_last_value_alias ==
  
->= 7.0NG+<WRAP center round box 90%>
  
-モジュールの最新の値を返します。このモジュールは、パラメータ id で渡されるエージェントの別名と、パラメータ id2 で渡されるモジュール名でフィルタされます。other  パラメータで、アプリケーションが利用するエラーコードおよび、範囲を超えたモジュールの値を追加することができます。+This feature also works in Command Center (Metaconsole).
  
-書式:+</WRAP>
  
-  * op=get (必須) +<WRAP center round box 90%>
-  * op2=agent_module_name_last_value_alias (必須) +
-  * id=<英数字>(必須) エージェント名。 +
-  * id2=<英数字> (必須) モジュール名。 +
-  * other=<返すエラー> (オプション) (通常DBには記録されない)エラー時に返したいもの。 +
-      * エラーコードは次の通りです: +
-        * 'error_message' テキストのエラーメッセージ。 +
-        * 'error_value'<セパレータ><コードまたは値> このコードまたはエラーの値が返ります。ただし、other_mode=url_encode_separator_<セパレータ> のように、 'other_mode' でセパレータを指定する必要があります。+
  
-**例**+この機能はコマンドセンター (メタコンソール) でも動作します。
  
-<code> +</WRAP> 
-http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value_alias&id=miguel-portatil&id2=cpu_user+ 
 +Returns the last value of a module, which is selected by alias of the agent passed by the ''id'' parameter and the module name passed by the ''id2'' parameter. With the ''other'' parameter you can add the error code for an external application to detect this value outside the range of values that can be the module. 
 + 
 +モジュールの最新の値を返します。このモジュールは、パラメータ ''id'' で渡されるエージェントの別名と、パラメータ ''id2'' で渡されるモジュール名でフィルタされます。''other''  パラメータで、アプリケーションが利用するエラーコードおよび、範囲を超えたモジュールの値を追加することができます。 
 + 
 +[[#ks2|Call syntax]]: 
 + 
 +[[#ks2|書式]]: 
 + 
 +  * ''op=get'' (required). 
 +  * ''op2=agent_module_name_last_value_alias'' (required). 
 +  * ''id=''< alphanumeric > (required): Contains the agent's alias. 
 +  * ''id2=''< alphanumeric > (required): Contains the module name. 
 +  * ''other_mode=url_encode_separator_''< separator > (optional). 
 +  * ''other=''< error_return > (optional): To return response if there is an error (usually not found the module in the databases): 
 + 
 +  - error_message : Returns error in a text message. 
 +  - error_value< separator >< value_or_code > : Returns that error code or value.  
 + 
 +  * ''op=get'' (必須) 
 +  * ''op2=agent_module_name_last_value_alias'' (必須) 
 +  * ''id=''<英数字>(必須) エージェント名。 
 +  * ''id2=''<英数字> (必須) モジュール名。 
 +  * ''other_mode=url_encode_separator_''< セパレータ > (オプション) 
 +  * ''other=''<返すエラー> (オプション) (通常DBには記録されない)エラー時に返したいもの。 
 + 
 +  - error_message: テキストのエラーメッセージ。 
 +  - error_value<セパレータ><コードまたは値>: このコードまたはエラーの値が返ります。 
 + 
 +**Example (see [[#ks2|syntax of the call]])**: 
 + 
 +**例 ([[#ks2|書式]]を参照)**: 
 + 
 +<code bash> 
 +…/include/api.php?op=get&op2=agent_module_name_last_value_alias&id=pandorafms&id2=Memory_Used&apipass=1234&user=admin&pass=pandora
  
 </code> </code>
行 1708: 行 1735:
 == get special_days == == get special_days ==
  
->= 5.1+Returns a list with special days. It allows to specify a field separator, being these:
  
-特別日一覧を返します。+特別日のリストを返します。次のデータを表示するためのフィールド区切り文字を指定できます:
  
-書式:+  - Numerical ID of the special day. 
 +  - Numerical ID of the calendar to which this special day belongs. 
 +  - Numerical ID of the group to which the special day belongs. 
 +  - Date of the special day in the format ''YYYY-MM-DD''. 
 +  - Numeric ID of the same day of the week configured for that special day. 
 +  - Description of the special day.
  
-  * op=get (必須) +  - 特別日の数値 ID。 
-  * op2=special_days (必須) +  - この特別日が属するカレンダーの数値 ID。 
-  * other=<csvセパレータ> (オプション) CSVのセパレータ+  - 特別日が属するグループの数値 ID。 
 +  - 特別日の日付 (形式は ''YYYY-MM-DD'')。 
 +  - その特別日に設定されている同じ曜日の数値 ID。 
 +  - 特別日の説明。
  
-**例**+[[#ks2|Call syntax]]:
  
-<code> +[[#ks2|書式]]: 
-http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=special_days+ 
 +  * ''op=get''  (required). 
 +  * ''op2=special_days'' (required). 
 +  * ''other=''< csv separator > (optional). 
 + 
 +  * ''op=get'' (必須) 
 +  * ''op2=special_days'' (必須) 
 +  * ''other=''<csvセパレータ> (オプション) 
 + 
 +**Example (see [[#ks2|call syntax]]):** 
 + 
 +**例 ([[#ks2|書式]]を参照):** 
 + 
 +<code bash> 
 +…/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=special_days
  
 </code> </code>
行 5912: 行 5961:
  
 == set delete_module_in_conf == == set delete_module_in_conf ==
- 
->= 5.0 (エンタープライズ版のみ) 
  
 ローカルモジュールの設定を削除します。 ローカルモジュールの設定を削除します。
行 5934: 行 5981:
  
 == set update_module_in_conf == == set update_module_in_conf ==
- 
->= 5.0 (エンタープライズ版のみ) 
  
 ローカルモジュールの設定を更新します。 ローカルモジュールの設定を更新します。
行 5980: 行 6025:
 <WRAP center round tip 50%> <WRAP center round tip 50%>
  
-This feature also works in Metaconsole.+This feature also works in Command Center (Metaconsole).
  
 </WRAP> </WRAP>
行 5986: 行 6031:
 <WRAP center round tip 50%> <WRAP center round tip 50%>
  
-この機能は、Metaconsole でも使えます。+この機能は、コマンドセンター(メタコンソール)でも使えます。
  
 </WRAP> </WRAP>
  
-[[:en:documentation:08_technical_reference:02_annex_externalapi#pandora_fms_external_api|Call syntaxis]]:+[[#ks2|Call syntax]]:
  
-[[:ja:documentation:08_technical_reference:02_annex_externalapi#pandora_fms_外部_api|書式]]:+[[#ks2|書式]]:
  
   * ''op=set''  (required).   * ''op=set''  (required).
行 6034: 行 6079:
       * < tags > (string type).       * < tags > (string type).
       * < custom_data> **Custom data should be a base64 encoded JSON document**.       * < custom_data> **Custom data should be a base64 encoded JSON document**.
-      * < server_id > (//only for Metaconsole//) The id of the child node. +      * < server_id > (//only for Command Center (Metaconsole)//) The id of the child node. 
-      * <id_extra> (alphanumeric type).+      * <id_extra> (alphanumeric type, see , véase [[en:documentation:pandorafms:management_and_operation:12_console_setup#ks1_1|Keep in process status for new events with extra ID]]).
  
   * ''op=set'' (必須)   * ''op=set'' (必須)
行 6077: 行 6122:
       * < タグ > (文字列)       * < タグ > (文字列)
       * < カスタムデータ > **base64 でエンコードした JSON 形式でなければいけません**       * < カスタムデータ > **base64 でエンコードした JSON 形式でなければいけません**
-      * < サーバ ID > (//メタコンソールのみ//) 子ノードの ID です。 +      * < サーバ ID > (//コマンドセンター(メタコンソール)のみ//) 子ノードの ID です。 
-      * <extra ID> (英数字)+      * <extra ID> (英数字、[[ja:documentation:pandorafms:management_and_operation:12_console_setup#一般設定|追加IDを持つ新しいイベントの処理ステータスを維持]] を参照。)
  
-**Example (** **[[:en:documentation:08_technical_reference:02_annex_externalapi#pandora_fms_external_api|see call syntaxis]]****): **+**Example (** **[[#ks2|see call syntax]]****): **
  
-**例** ([[:ja:documentation:08_technical_reference:02_annex_externalapi#pandora_fms_外部_api|書式]]を参照):+**例** ([[#ks2|書式]]を参照):
  
 The event to be created has the following custom JSON data: The event to be created has the following custom JSON data:
行 6107: 行 6152:
 イベントにコメントを追加します。 イベントにコメントを追加します。
  
-<WRAP center round tip 60%> これはメタコンソールでも利用できます。 </WRAP>+<WRAP center round tip 90%> 
 + 
 +This feature also works in Command Center (Metaconsole). 
 + 
 +</WRAP> 
 + 
 +<WRAP center round tip 90%> 
 + 
 +この機能はコマンドセンター (メタコンソール) でも動作します。 
 + 
 +</WRAP>
  
 書式: 書式:
  
-  * op=set (必須) +  * ''op=set''  (required). 
-  * op2=create_event (必須) +  * ''op2=add_event_comment''  (required). 
-  * other=<連続パラメータ> (必須) 次の順番でイベントデータを指定します: +  * ''id=''< id_event > (required, numeric type). 
-      * <コメント> (必須)+  * ''other=''< serialized_parameters > (required) are the comment to be added and, if used in Command Center (Metaconsole), the numerical identifier of the node, data serialized as follows: 
 +      * < comment > (required, string type). 
 +      * < separator > (//optional, for Command Center -Metaconsole- use//). 
 +      * < id_node > (//optional, for Command Center -Metaconsole- use//). 
 +  * ''url_encode_separator_''< separator >:[[#ks2|See call syntax]].
  
-<WRAP center round tip 60%> メタコンソールで利用するには、"string" の後に "true" をパラメータで指定してください。 </WRAP>+  * ''op=set'' (必須) 
 +  * ''op2=add_event_comment'' (必須) 
 +  * ''id='' < イベントID > (必須、数値) 
 +  * ''other='' <連続パラメータ> (必須) 次の順番でイベントデータを指定します: 
 +      * < コメント > (必須、文字列) 
 +      * < セパレータ> (//オプション、コマンドセンター(メタコンソール)で使用//)。 
 +      * < ノードID > (//オプション、コマンドセンター(メタコンソール)で使用//)。 
 +  * ''url_encode_separator_''< セパレータ >:[[#ks2|呼出書式を参照]]
  
-**例**+<WRAP center round tip 90%>
  
-  * ノード +**Command Center (Metaconsole) usage**: 
-<code>+ 
 +  * NG 762 version an earlier: After the comment and the separator you must enter the parameter ''true''. 
 +  * NG 766 version and later: After the comment and the separator you must enter the numerical identifier of the node. 
 + 
 +This node identifier can be obtained by accessing the [[:en:documentation:pandorafms:command_center:04_command|Command Center]]: 
 + 
 +{{  :wiki:pfms-metaconsole-command_center_node_identificator.png  }} 
 + 
 +</WRAP> 
 + 
 +<WRAP center round tip 90%> 
 + 
 +**コマンドセンター (メタコンソール) の使用法**: 
 + 
 +  * NG 762 バージョン以前: コメントと区切り文字の後に、パラメータ ''true'' を入力する必要があります。\ 
 +  * NG 766 バージョン以降: コメントと区切り文字の後に、ノードの数値識別子を入力する必要があります。 
 + 
 +このノード識別子は、[[:ja:documentation:pandorafms:command_center:04_command|コマンドセンター]]にアクセスすることで取得できます。 
 + 
 +{{  :wiki:pfms-metaconsole-command_center_node_identificator.png  }} 
 + 
 +</WRAP> 
 + 
 +**Examples ([[#ks2|see call syntax]])** 
 +  * Node (event id is ''7''  and comment is ''comment''): 
 + 
 +**例 ([[#ks2|呼出書式を参照]])** 
 +  * ノード (イベント ID は ''7'' 、コメントは ''comment''): 
 + 
 +<code bash> 
 +../include/api.php?op=set&op2=add_event_comment&id=7&other=comment&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
  
-http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora 
  
 </code> </code>
  
-  * メタコンソール +  * Command Center (Metaconsole) (**NG 766 and later**, the event identifier is ''1'', the comment is ''comment''  and the node identifier is ''3''): 
-<code>+ 
 +  * コマンドセンター (メタコンソール) (**NG 766 以降**、イベント識別子は ''1''、コメントは ''comment''、ノード識別子は ''3''): 
 + 
 +<code bash> 
 +../include/api.php?op=set&op2=add_event_comment&id=1&other=comment|3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
  
-http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string|true&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora 
  
 </code> </code>
行 6138: 行 6236:
 API を通してイベントを更新します。 API を通してイベントを更新します。
  
-<WRAP center round tip 60%> この機能は、メタコンソールでも利用できます。 </WRAP>+<WRAP center round tip 90%> 
 + 
 +This feature can be also used in the Command Center (Metaconsole). 
 + 
 +</WRAP> 
 + 
 +<WRAP center round tip 90%> 
 + 
 +この機能はコマンドセンター (メタコンソール) でも使用できます。 
 + 
 +</WRAP>
  
 書式: 書式:
行 6208: 行 6316:
 </code> </code>
  
-  * メタコンソール:+  * Command Center (Metaconsole): 
 + 
 +  * コマンドセンター(メタコンソール):
 <code> <code>
  
行 6597: 行 6707:
  
 http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|periodically|weekly|admin&other_mode=url_encode_separator_| http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|periodically|weekly|admin&other_mode=url_encode_separator_|
 +
 +</code>
 +
 +== set planned_downtimes_edit ==
 +
 +>= 754
 +
 +Edit a planned stop.
 +
 +計画停止を編集します。
 +
 +  * ''op=set''  .
 +  * ''op2=planned_downtimes_edit''  .
 +  * ''id=''  planned shutdown identifier.
 +  * ''other=''  all parameters are optional:
 +      * <name>
 +      * <description>
 +      * <date from>
 +      * <date to>
 +      * <time from>
 +      * <time to>
 +      * <id group>
 +      * <monday>
 +      * <tuesday>
 +      * <wednesday>
 +      * <thursday>
 +      * <friday>
 +      * <saturday>
 +      * <sunday>
 +      * <periodically_day_from>
 +      * <periodically_day_to>
 +      * <stop type>
 +      * <ejecution type>
 +      * <periodicity type>
 +
 +  * ''op=set'' 
 +  * ''op2=planned_downtimes_edit'' 
 +  * ''id=''  計画停止ID
 +  * ''other=''  全てのパラメータはオプションです。
 +      * <名前>
 +      * <説明>
 +      * <開始日>
 +      * <終了日>
 +      * <開始時刻>
 +      * <終了時刻>
 +      * <グループID>
 +      * <月>
 +      * <火>
 +      * <水>
 +      * <木>
 +      * <金>
 +      * <土>
 +      * <日>
 +      * <定期実行開始日>
 +      * <定期実行終了日>
 +      * <計画停止タイプ>
 +      * <実行タイプ>
 +      * <定期実行タイプ>
 +
 +<WRAP center round important 90%>
 +
 +The date format must be YYYYY/MM/DD (year/month/day) for this call to work properly.
 +
 +</WRAP>
 +
 +<WRAP center round important 90%>
 +
 +この呼び出しが正しく機能するには、日付形式が YYYY/MM/DD (年/月/日) である必要があります。
 +
 +</WRAP>
 +
 +**Example:**
 +
 +**例:**
 +
 +<code>
 +http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_edit&apipass=1234&user=admin&pass=pandora&id=2&other=testing2|test2| 2022/05/10|2022/06/12|19:03:03|19:55:00|0|0|0|0|0|0|0|0|1|31|quiet|once|weekly&other_mode=url_encode_separator_|
 +
 +</code>
 +
 +== set planned_downtimes_add_agents ==
 +
 +>= 754
 +
 +Add Agents to the planned stop.
 +
 +計画停止にエージェントを追加します。
 +
 +  * ''op=set''  .
 +  * ''op2=planned_downtimes_agents''  .
 +  * ''id=''planned stop identifier.
 +  * ''other=''identifier of each Agent separated by semicolons:
 +      * <id_agent**1**;id_agent**2**;id_agent**3**;….id_agent**n**;>
 +
 +  * ''op=set'' 
 +  * ''op2=planned_downtimes_agents''  
 +  * ''id='' 計画停止ID
 +  * ''other='' セミコロンで区切ったエージェントID:
 +      * <id_agent**1**;id_agent**2**;id_agent**3**;….id_agent**n**;>
 +
 +**Example:**
 +
 +**例:**
 +
 +<code>
 +http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_add_agents&apipass=1234&user=admin&pass=pandora&id=4&other=1;2;3&other_mode=url_encode_separator_|
 +
 +</code>
 +
 +== set planned_downtimes_delete_agents ==
 +
 +>= 754
 +
 +Removes Agents (and the Modules of those agents) from the planned shutdown.
 +
 +計画停止からエージェント (およびそれらのエージェントのモジュール) を削除します。
 +
 +  * ''op=set''  .
 +  * ''op2=planned_downtimes_delete_agents''  .
 +  * ''id=''planned stop identifier.
 +  * ''other=''identifier of each Agent separated by semicolons:
 +      * <id_agent**1**;id_agent**2**;id_agent**3**;….id_agent**n**;>
 +
 +  * ''op=set'' 
 +  * ''op2=planned_downtimes_delete_agents'' 
 +  * ''id='' 計画停止ID
 +  * ''other='' セミコロンで区切ったエージェントID:
 +      * <id_agent**1**;id_agent**2**;id_agent**3**;….id_agent**n**;>
 +
 +**Example:**
 +
 +**例:**
 +
 +<code>
 +
 +http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_delete_agents&apipass=1234&user=admin&pass=pandora&id=4&other=1;2;3&other_mode=url_encode_separator_|
  
 </code> </code>
行 6795: 行 7041:
 >= 7 >= 7
  
-ライセンスキーをメタコンソールへ追加し、ノードへ同期します。+It adds license key to the Command Center (Metaconsole) and performs the synchronization with nodes. 
 + 
 +ライセンスキーをコマンドセンター(メタコンソール)へ追加し、ノードへ同期します。
  
   * op=set   * op=set
行 7497: 行 7745:
  
 書式: 書式:
 +
 +  * op=set (required)
 +  * op2=disabled_and_standby (required)
 +  * id=<agent id> (required). In the Command Center (Metaconsole), it is the id of the agent, that is to say, the id of the node.
 +  * id2=<id del nodo> (required in the Command Center (Metaconsole), not needed in the node)
 +  * other=<valor> (optional) Value (0 to enable and 1 to disable) of the new status. If no value is specified, it disables the agent.
  
   * op=set (必須)   * op=set (必須)
   * op2=disabled_and_standby (必須)   * op2=disabled_and_standby (必須)
-  * id=<エージェント ID> (必須) メタコンソールでは tagente の ID で、つまりノー ド ID です。 +  * id=<エージェント ID> (必須) コマンドセンター(メタコンソール)ではエージェントの ID で、つまりノー ド ID です。 
-  * id2=<ノード ID> (メタコンソールでは必須、ノードでは不要)+  * id2=<ノード ID> (コマンドセンター(メタコンソール)では必須、ノードでは不要)
   * other=<値> (オプション) 新たな状態(0 で有効化、1 で無効化)です。値を指定しない場合は、エージェントは無効化されます。   * other=<値> (オプション) 新たな状態(0 で有効化、1 で無効化)です。値を指定しない場合は、エージェントは無効化されます。
  
行 8255: 行 8509:
   * ''id='' < id_event >  (required, numerical value).   * ''id='' < id_event >  (required, numerical value).
   * ''id2='' < id_custom_event >  (required, alphanumeric value).   * ''id2='' < id_custom_event >  (required, alphanumeric value).
 +  * ''other=''< id_node > If running in **Command Center** (Metaconsole), the node identifier. Default value ''0'' (Command Center).
  
   * ''op=get''  (必須)   * ''op=get''  (必須)
行 8260: 行 8515:
   * ''id='' < id_event >  (必須、数値)   * ''id='' < id_event >  (必須、数値)
   * ''id2='' < id_custom_event >  (必須、文字列)   * ''id2='' < id_custom_event >  (必須、文字列)
 +  * ''other=''< id_node > **コマンドセンター** (メタコンソール) で実行している場合は、ノード識別子。デフォルト値は ''0'' (コマンドセンター) です。
  
 **Example (see [[#pandora_fms_external_api|call syntax]])**: **Example (see [[#pandora_fms_external_api|call syntax]])**:
行 8269: 行 8525:
 </code> </code>
  
 +Example for a node in **Command Center**:
 +
 +**コマンドセンター** のノードの例:
 +
 +<code bash>
 +…/include/api.php?op=set&op2=event_custom_id&id=3831949&id2=Test123&other=1&apipass=1234&user=admin&pass=pandora
 +</code>
  
 ==== 例 ==== ==== 例 ====
  • ja/documentation/pandorafms/technical_reference/02_annex_externalapi.1725803969.txt.gz
  • 最終更新: 2024/09/08 13:59
  • by junichi