個人用ツール

Pandora:Documentation ja:Annex ExternalAPI

提供: Pandora FMS Wiki JP

移動先: 案内, 検索

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

目次

Pandora FMS 外部 API

The Pandora FMS external API is used doing remote calls (through HTTP9 on the file /include/api.php. This is the method that has been defined in Pandora FMS to integrate applications from third parts with Pandora FMS. It basically consist on a call with the parameters formated to receive a value or a list of values that after its application it will use to do operations.

Pandora FMS 外部 API は、(/include/api.php に対して HTTP アクセスすることにより) リモート操作に利用します。 これは、Pandora FMS 外から操作するアプリケーションを作成できるように、Pandora FMS に用意されている手法です。基本的に、アプリケーションからの操作で、指定したフォーマットのパラメータで値を受け渡します。

A call to the API.php is as simple as this:

API.php の呼び出しは、次のように単純です。

http://<instalación Pandora Console>/include/api.php<parametros>
http://<pandoraコンソールのインストールパス>/include/api.php<パラメータ>

The API only can receive the following parameters:

API は次のパラメータのみ受け取ることができます。

  • op (compulsory): is the first parameter that specify the nature of the operation, which could be "get" or "set" or "help":
  • op (必須): 最初のパラメータで、操作の種類を指定します。"get"、"set"、"help" のいずれかを指定できます。
  • get: returns a value or values.
  • get: 値を取得します。
  • set: send a value or values.
  • set: 値を設定します。
  • help: returns a little help from the calls
  • help: 小さなヘルプを返します。
  • op2 (compulsory): the call with an explanatory name of the one that works.
  • op2 (必須): 処理の名前を指定します。
  • id (optional): first parameter of the call.
  • id (オプション): 1番目のパラメータです。
  • id2 (optional): second parameter of the call.
  • id2 (オプション): 2番目のパラメータです。
  • other (optional): third parameter of the call, sometimes it could be a list of serial values..
  • other (オプション): 3番目のパラメータです。連続したデータリストの場合もあります。
  • other_mode (optional): format of the serial. list of posible values:
  • other_mode (オプション): 連続データのフォーマットです。指定可能な値は次の通りです。
  • url_encode: el valor de other es un alfanumérico formateado como UrlEncode.
  • url_encode: 文字列フォーマットです。UrlEncode
  • url_encode_separator_<separador>:the value will be a serial value list with the divider character, for example:
  • url_encode_separator_<セパレータ>:複数の値を分割する文字を指定します。例えば、次の通りです。
...other=peras|melones|sandias&other_mode=url_encode_separator_|
  • returnType (optional): return format of the value or values. The current available values are:
  • returnType (オプション): 値の取得フォーマットです。設定可能な値は次の通りです。
  • string: returns the value as it is as an alphanumeric one.
  • string: 英数字として値を返します。
  • csv:return the values as a CSV separated by default with the ";" character (fields) and with CR (files)
  • csv:デフォルトで ";" および改行で区切られた CSV で値を返します。
  • csv_head: returns same as with "csv" except that it adds a first file with the field names to return.
  • csv_head: "csv" と同様ですが、最初にフィールド名を返します。

セキュリティ

At the moment, the security is based on an IPs list that will have access to the tool. And it will be configured as we could see at the image, in the Pandora Console configuration options.

現時点では、セキュリティはツールにアクセスする IP アドレスリストに基づいています。以下に示す画面のように Pandora コンソールの設定オプションで設定できます。

If you introduce the character * in the box text, the ACL check will be omitted relegating the security to the protocol and to the environment. In the same way, the character * can be used as wildcard. In example. 183.234.33.*

* 文字を設定すると、IP による ACL チェックは省略され、プロトコルおよび環境によるセキュリティのみに下がります。同様に、*' 文字はワイルドカードとして利用できます。例えば、183.234.33.* などです。

500px

You can also set a password for the actions of the API.

API の操作にパスワードを設定することもできます。

In order to setup the password it is necessary to follow these steps:

パスワードを設定するには、次の手順を行う必要があります。

  • apipass: Api password configured in the console. You can do it in the following configuration view (Administration>Setup>):
  • APIパスワード: コンソールでAPIパスワードを設定します。これは次の設定画面 (システム管理(Administration) > 設定(Setup))で設定できます。

Nota: Before the 4.0.2 version, this parameter was pass

注意: 4.0.2 より前のバージョンでは、このパラメータは、パスワード(pass) です。


650px


To access to the actions of the API, is necessary give a valid user and pass of Pandora FMS, too.

APIにアクセスするには、Pandora FMS の正しいユーザとパスワードも必要です。

  • user: Valid user of Pandora FMS
  • user: Pandora FMS の正しいユーザ
  • pass: The password of the given user
  • pass: 指定したユーザのパスワード

Note: In the API calls the passwords are uncodified. So please be careful and use SSL connections to avoid sniffers. The API allows POST petitions to codify it when use SSL/HTTPS.

注意: API呼び出しではパスワードは暗号化されていません。キャプチャされないように SSL 通信を使うなど注意してください。API では SSL/HTTPS を使って POST できます。

戻り値

When the API denies the access, a simple string "auth error" is returned.

API へのアクセスができなかった場合は、単純に "auth error" という文字が出力されます。

In this case, is provided the API password 1234 and the access credentials are user: admin and password: pandora.

ここでは、API パスワードが 1234 で、アクセスユーザが admin、そのパスワードが pandora とします。

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

Access conditions:

  • The origin IP is in the ACLs IP list
  • The API password is not setted or is 1234
  • The user admin exists and their password is pandora

アクセスできるための条件は次の通りです。

  • ACL の IP 一覧にアクセスもとの IP が設定されている。
  • API パスワードが設定されていないか、1234 である。
  • ユーザ admin が存在し、そのパスワードが pandora である。

セキュリティ処理の流れ

Starting from version 4.0.2, the API will have several security improvements, and this is implemented by three factors:

バージョン 4.0.2 から、API ではいくつかのセキュリティの改善が行われています。これは、次の 3つの要素で実装されています。

  • IP filtering. Only listed / filtered IP will be allowed to connect the API.
  • IPフィルタリング。リストに設定された IP から API への接続ができます。
  • Global API password, if defined, needed to use the API.
  • グローバル API パスワード。定義されている場合は、API を利用する場合に必要です。
  • User & Password in the console, need to be valid and have permissions to perform the operation requested.
  • コンソールのユーザとパスワード。要求した操作を実行する正しい権限が必要です。

This is explained in this workflow:

以下に処理の流れを示します。


400px


API における新規呼び出し拡張

To develop new calls for the API you have to consider that:

API の新たな呼び出しを開発するには、以下を考慮してください。

  • The call has to be inscribed as a function in the file <instalación Pandora Console>/include/functions_api.php .
  • 呼び出しは <Pandoraコンソールインストール場所>/include/functions_api.php ファイル内の関数として実装されます。
  • The call should be a mix of "get", "set" or "help" and the name of your new call, trying to be coherent with the operation, as for example:function get&ltnombre_llamada>(parametros) .
  • 呼び出しは、"get"、"set"、または、"help" と新たな呼び出し名の組み合わせで、操作とつじつまが合うようにします。例えば、function get<呼び出し名>(パラメータ) です。
  • The parameters that the call will receive should be all, even when your call does not use them and of course could have any name.These are :
  • 全てを利用しない場合でも、任意の名前で良いですが、呼び出しパラメータは次に示す全てを受け渡す必要があります。
  • id: first operator or parameter, contains an string.
  • id: 1番目の操作またはパラメータで、文字列を含みます。
  • id2: second operator or parameter, contains an string.
  • id2: 2番目の操作またはパラメータで、文字列を含みます。
  • other: rest of operators or parameters, containes as an array of two positions:
  • other: 残りの操作またはパラメータで、以下の2種類の配列を含みます。
  • $other['type']: that could be string or array.
  • $other['type']: 文字列または配列です。
  • $other['data']: that will be an string with the parameter or an array of numeric index with the past parameters.
  • $other['data']: パラメータを持った文字列または、パラメータの数値インデックスの配列です。
  • returnType: string that specify the kind of return that the call will have. It is usually transparent for you, but you could use or modify it if necessary.
  • returnType: 呼び出しの戻値の種類を指定する文字列です。通常は透過的ですが必要であれば編集できます。

Pandora FMS 拡張からの新たな API 呼び出し

Is possible to create new API calls without use /include/functions_api.php. The way is adding into a Pandora FMS extension directory a file with the following name: <extension_name>.api.php and into this file create the desired functions with the same considerations of the standard API but with "apiextension" prefix instead of "api".

/include/functions_api.php を利用せずに新たな API 呼び出しを作成することができます。それには、Pandora FMS の extension ディレクトリに <extension_name>.api.php という名前でファイルを追加し、標準の API と同じように欲しい関数を作成します。ただし、プリフィックスは、"api" ではなく、"apiextension" です。

For example, having an extension called "module_groups" with the path <Pandora installation>/extensions/module_groups we must create a file called module_groups.api.php into this directory.

例えば、<Pandora installation>/extensions/module_groups に "module_groups" という名前の拡張を作る場合は、module_groups.php というファイルをそのディレクトリに作成します。

Into this file will be the desired functions, for example a function to get the number of modules in a group. This function must have a name like: "apiextension_get_groupmodules".

このファイルに、例えば、グループのモジュール数を取得する関数などの欲しい関数を入れます。この関数の名前は、"apiextension_get_groupmodules" といった名前である必要があります。

関数例

In this function have been used imaginary functions.

以下に示すのは、関数の例です。

function apiextension_get_groupmodules($group_name) {
    $group_id = group_id_from_name($group_name);
    if($group_id == false) {
       echo 'Group doesnt exist';
       return;
    }

    $number_of_modules = group_modules($group_id);
    echo $number_of_modules;
}

呼び出し例

This call example gets the number of modules of the group "Servers"

この呼び出し例では、"Servers" グループのモジュール数を取得します。

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=extension&ext_name=module_groups&ext_function=groupmodules&id=Servers&apipass=1234&user=admin&pass=pandora

API 関数

The following functions could be used in the function code of your call:

API 関数内では、以下の関数を利用できます。

  • returnError(typeError, returnType): gives back an error in an standardized way for all calls.
  • returnError(typeError, returnType): 全ての呼び出しに対して標準化したエラーを返します。
  • typeError: by now 'id_not_found' or null.
  • typeError: 現在のところ、'id_not_found' または null です。
  • returnType: by now 'string' or error message.
  • returnType: 現在のところ、'string' またはエラーメッセージです。
  • returnData(returnType, data, separator): is the function that returns the API call data.
  • returnData(returnType, data, separator): API の呼び出しデータを返す関数です。
  • returnType: that could be 'string', 'csv', 'csv_head'
  • returnType: 'string', 'csv', 'csv_head' のいずれかです。
  • data: is an array that contains the data, as well as its format. It has the following fields:
  • data: データおよびその形式を含んだ配列です。次のフィールドがあります。
  • 'type' (compulsory): that could be 'string' and 'array'.
  • 'type' (必須): 'string' および 'array' です。
  • 'list_index' (optional): contains a numeric index array containing the alphanumeric index that are wanted to take out through exit.
  • 'list_index' (オプション): 終了時に引き渡す英数字インデックスを含む数値インデックスの配列です。
  • 'data' (compulsory): contains and string with the data or an array of alphanumeric index or numeric index with the data.
  • 'data' (必須): データの内容または、英数字インデックスの配列、または、データと数値インデックスです。

function get_module_last_value($idAgentModule, $trash1, $other = ';', $returnType)
{
	$sql = sprintf('SELECT datos FROM tagente_estado WHERE id_agente_modulo = %d', $idAgentModule);
	$value = get_db_value_sql($sql);
	if ($value === false) {
		switch ($other['type']) {
			case 'string':
				switch ($other['data']) {
					case 'error_message':
					default:
						returnError('id_not_found', $returnType);
					break;
				}
				break;
			case 'array':
				switch ($other['data'][0]) {
					case 'error_value':
						returnData($returnType, array('type' => 'string', 'data' => $other['data'][1]));
						break;
				}
				break;
		}
	}
	else {
		$data = array('type' => 'string', 'data' => $value);
		returnData($returnType, $data);
	}
}

API 呼び出し

They are divided in two groups, depending on if they get back or write data in Pandora FMS.

Pandora FMS に対して読み出しか書き込みかによって、2つの種類に分けられます。

情報取得

Returns the version of Pandora Console in a similar way of the call get test but without check the API connection.

Pandora コンソールのバージョンを返します。get test と似ていますが、API 接続のチェックをしません。

This call is useful to verify that this path allows a Pandora FMS installation and to retrieve the version before the authentication.

これは、Pandora FMS のインストールパスの確認と、認証前にバージョンを確認するのに便利です。

The returned info can be retrieved from the login screen, so it doesn't be considered a security vulnerability.

返される情報はログイン画面から確認することができるものであるため、セキュリティ上の脆弱性にはなりません。

http://127.0.0.1/pandora_console/include/api.php?info=version

A return sample could be: Pandora FMS v5.0 - PC131015

返される値は、Pandora FMS v5.0 - PC131015 といったものです。

読み出し

It gets back the required data.

データを読み出します。

get test

Call syntax: Without parameters

書式: パラメータ無し

This example will return OK

以下の例では、OK を返します。

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=test

get all_agents

Call syntax:

  • op=get (compulsory)
  • op2=all_agents (compulsory)
  • return_type= csv or json (compulsory)
  • other=<parámetros serializados> (optional) serialized parameters to filter the agent search:
  • <filter_so>
  • <filter_group>
  • <filter_module_states>
  • <filter_alias>
  • <filter_policy>
  • <csv_separator>

書式:

  • op=get (必須)
  • op2=all_agents (必須)
  • return_type=csv または json (必須)
  • other=<連続パラメータ> (オプション) 検索するエージェントをフィルタするためのパラメータ列:
  • <filter_so>
  • <filter_group>
  • <filter_module_states>
  • <filter_alias>
  • <filter_policy>
  • <csv_separator>

This example will return all agents which id_os is equal to 1, id_group equal to 2, state equal to warning, their agents will contain 'j', and the policy associated equal to 2.

この例では、OS ID が 1、グループ ID が 2、状態が警告、エージェント名に 'j' を含み、関連付けられたポリシーが 2 の全エージェントを返します。

CSV の例: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
JSON の例: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

get module_last_value

Call syntax:

  • op=get (compulsory)
  • op2=module_last_value (compulsory)
  • id=<índice> (compulsory) should be an index of an agent module.
  • other=<retorno error> (optional) that you want to it gives back if there is an error(usually not located in the database.
  • Error return code are:
  • 'error_message' returns an error in a text message.
  • 'error_value'<separador><código o valor&gt gives back this code or error value. But it is necessary to enclose it with 'other_mode',like other_mode=url_encode_separator_<separador&gt to put the divider on other.

書式:

  • op=get (必須)
  • op2=module_last_value (必須)
  • id=<インデックス> (必須) エージェントモジュールのインデックスである必要があります。
  • other=<返すエラー> (オプション) (通常データベースに記録されない)エラーが発生したときに、返したいもの。
  • エラーコードは次の通りです:
  • 'error_message' テキストでエラーメッセージを返します。
  • 'error_value'<セパレータ><コードまたは値> エラーの値を返します。ただし、other_mode=url_encode_separator_<セパレータ> のように、分割するためのセパレータを 'other_mode' で設定する必要があります。
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=63&other=error_value|0&other_mode=url_encode_separator_|
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62

get agent_module_name_last_value

Call Syntaxis:

  • op=get (compulsory)
  • op2=agent_module_name_last_value (compulsory)
  • id=<alfanumerico>(compulsory) contains the agent name.
  • id2=<alfanumerico> (compulsory) contains the module name.
  • other=<retorno error> (optional) that you want to return if there is an error ( that usually has not been found in the DB).
  • Codes of error return are:
  • 'error_message' returns error in a text message.
  • 'error_value'<separador><código o valor&gt gives back this code or error value,but it is necessary that it comes with 'other_mode' such as other_mode=url_encode_separator_<separador&gt to use the divider in other.

書式:

  • op=get (必須)
  • op2=agent_module_name_last_value (必須)
  • id=<英数字>(必須) エージェント名。
  • id2=<英数字> (必須) モジュール名。
  • other=<返すエラー> (オプション) (通常DBには記録されない)エラー時に返したいもの。
  • エラーコードは次の通りです:
  • 'error_message' テキストのエラーメッセージ。
  • 'error_value'<セパレータ><コードまたは値> このコードまたはエラーの値が返ります。ただし、other_mode=url_encode_separator_<セパレータ> のように、 'other_mode' でセパレータを指定する必要があります。
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=miguel-portatil&id2=cpu_user

get agent_module_name_last_value_alias

>= 7.0NG

Returns the last value of module. This module is filtered by the agent alias pass as parameter id and module name pass as parameter id2. With the other parameter you can add a error code that your application knows and it is out range of module values.

モジュールの最新の値を返します。このモジュールは、パラメータ id で渡されるエージェントの別名と、パラメータ id2 で渡されるモジュール名でフィルタされます。other パラメータで、アプリケーションが利用するエラーコードおよび、範囲を超えたモジュールの値を追加することができます。

Call Syntax:

  • op=get (compulsory)
  • op2=agent_module_name_last_value_alias (compulsory)
  • id=<alphanumeric>(compulsory) contains the agent alias.
  • id2=<alphanumeric> (compulsory) contains the module name.
  • other=<error return> (optional) that you want to return if there is an error ( that usually has not been found in the DB).
  • Codes of error return are:
  • 'error_message' returns error in a text message.
  • 'error_value'<separator><code or value&gt gives back this code or error value,but it is necessary that it comes with 'other_mode' such as other_mode=url_encode_separator_<separator&gt to use the divider in other.

書式:

  • op=get (必須)
  • op2=agent_module_name_last_value_alias (必須)
  • id=<英数字>(必須) エージェント名。
  • id2=<英数字> (必須) モジュール名。
  • other=<返すエラー> (オプション) (通常DBには記録されない)エラー時に返したいもの。
  • エラーコードは次の通りです:
  • 'error_message' テキストのエラーメッセージ。
  • 'error_value'<セパレータ><コードまたは値> このコードまたはエラーの値が返ります。ただし、other_mode=url_encode_separator_<セパレータ> のように、 'other_mode' でセパレータを指定する必要があります。
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

get module_value_all_agents

Call syntax:

  • op=get (compulsory)
  • op2=module_value_all_agents (compulsory)
  • id=<name of the agent> (compulsory) This is the agent name.

書式:

  • op=get (必須)
  • op2=module_value_all_agents (必須)
  • id=<エージェント名> (必須) エージェント名です。
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_value_all_agents&id=example_module_name

get agent_modules

Sintaxis de la llamada:

  • op=get (compulsory)
  • op2=agent_modules (compulsory)
  • return_type=<csv> (compulsory) Output format.
  • other=<serialized values> (compulsory) Serialized values in order to filter by agent:
  • <id_agent>

It's necessary to complete 'other_mode' parameter in this way other_mode=url_encode_separator_<separador> in order to configure separator in other field.

書式:

  • op=get (必須)
  • op2=agent_modules (必須)
  • return_type=<csv> (必須) 出力書式
  • other=<複数の数値> (必須) エージェントでフィルタするための複数の数値:
  • <エージェントID>

次のように、セパレータを設定するために 'other_mode' パラメータを設定する必要があります。 other_mode=url_encode_separator_<セパレータ>

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|

get module_id

Returns the id of a module of an agent.

エージェントのモジュール ID を返します。

Call syntax:

書式:

  • op=get (compulsory)
  • op2=module_id (compulsory)
  • id=id agent (compulsory)
  • other=module name (compulsory)
  • op=get (必須)
  • op2=module_id (必須)
  • id=id agent (必須)
  • other=module name (必須)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_id&id=5&other=Host%20Alive&apipass=1234&user=admin&pass=pandora

get locate_agent

Get id server whare agent is located, and print all the result like a csv.

エージェントが存在するサーバ ID を取得し、すべての結果を csv で出力します。

Call syntax:

書式:

  • op=get (compulsory)
  • op2=locate_agent (compulsory)
  • return_type=<csv> (compulsory) Output format.
  • id=id_agent (compulsory)
  • other_mode= other_mode=url_encode_separator_<separator&gt (compulsory)
  • op=get (必須)
  • op2=locate_agent (必須)
  • return_type=<csv> (必須) 出力フォーマット
  • id=id_agent (必須)
  • other_mode= other_mode=url_encode_separator_<separator&gt (必須)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=locate_agent&return_type=csv&apipass=1234&user=admin&pass=pandora&id=Pepito&other_mode=url_encode_separator_%7C

get policies

Call syntax:

  • op=get (compulsory)
  • op2=policies (compulsory)
  • return_type=<csv> (compulsory)
  • other=<serialized values> (optional) Serialized values for filter policy by policy agent:
  • <id_agent>

書式:

  • op=get (必須)
  • op2=policies (必須)
  • return_type=<csv> (必須)
  • other=<複数の値> (オプション) ポリシーエージェントによってポリシーをフィルタするための複数の値:
  • <エージェントID>
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|

get tree_agents

Call Syntax:

  • op=get (compulsory)
  • op2=tree_agents (compulsory)
  • return_type=<tipo retorno> (compulsory) that could be 'csv' or 'csv_head'.
  • other=<string o parámetros serializados> (optional)in this case could be the divider or a parameter list in order and separated by the divider character. We are going to examine the two cases:
  • <separador> The divider "yes" of the 'csv'.
  • <separador csv>|<character that replaces the CR|<campos 1>,<campos 2>,<campos N>it will compose the following parameters in order( the divider character '|' could be specified in "other_mode"):
  • <separador csv>: divider of the fields in the CSV.
  • <character that replaces the CR> character that will be replaced if it finds in any returned character the character RC in order to avoid the ambiguity with the standard use of the RC character to specify registers/files in the CSV. If you pass an string in other, the substitute character is the blank space.
  • <fields 1>,<fields2>,<fields N&gt :the fields to show in the CSV are:
  • type_row
  • group_id
  • group_name
  • group_parent
  • disabled
  • custom_id
  • group_description
  • group_contact
  • group_other
  • agent_id
  • alias
  • agent_direction
  • agent_commentary
  • agent_id_group
  • agent_last_contact
  • agent_mode
  • agent_interval
  • agent_id_os
  • agent_os_version
  • agent_version
  • agent_last_remote_contact
  • agent_disabled
  • agent_id_parent
  • agent_custom_id
  • agent_server_name
  • agent_cascade_protection
  • agent_name
  • module_id_agent_modulo
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
  • module_critical_inverse (only in version 6.0SP1 or later)
  • module_warning_inverse (only in version 6.0SP1 or later)
  • alert_id_agent_module
  • alert_id_alert_template
  • alert_internal_counter
  • alert_last_fired
  • alert_last_reference
  • alert_times_fired
  • alert_disabled
  • alert_force_execution
  • alert_id_alert_action
  • alert_type
  • alert_value
  • alert_matches_value
  • alert_max_value
  • alert_min_value
  • alert_time_threshold
  • alert_max_alerts
  • alert_min_alerts
  • alert_time_from
  • alert_time_to
  • alert_monday
  • alert_tuesday
  • alert_wednesday
  • alert_thursday
  • alert_friday
  • alert_saturday
  • alert_sunday
  • alert_recovery_notify
  • alert_field2_recovery
  • alert_field3_recovery
  • alert_id_alert_template_module
  • alert_fires_min
  • alert_fires_max
  • alert_id_alert_command
  • alert_command
  • alert_internal
  • alert_template_modules_id
  • alert_templates_id
  • alert_template_module_actions_id
  • alert_actions_id
  • alert_commands_id
  • alert_templates_name
  • alert_actions_name
  • alert_commands_name
  • alert_templates_description
  • alert_commands_description
  • alert_template_modules_priority
  • alert_templates_priority
  • alert_templates_field1
  • alert_actions_field1
  • alert_templates_field2
  • alert_actions_field2
  • alert_templates_field3
  • alert_actions_field3
  • alert_templates_id_group
  • alert_actions_id_group'

書式:

  • op=get (必須)
  • op2=tree_agents (必須)
  • return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
  • other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。以下に2つのケースを示します。:
  • <セパレータ> CSV のセパレータ
  • <CSVセパレータ>|<CR と置き換える文字>|<フィールド1>,<フィールド2>,<フィールドN>これは、次のパラメータを構成します。(セパレータ文字として '|' を "other_mode" で指定できます。):
  • <CSVセパレータ>: CSV のフィールドセパレータ
  • <CR と置き換える文字> CSVファイル内に改行コードを見つけた場合に、通常の改行の意味で利用している場合と曖昧になるのを避けるために、それを置き換える文字です。文字列を渡すと、スペースに置換されます。
  • <フィールド1>,<フィールド2>,<フィールドN> :CSV に指定できるフィールドは次の通りです:
  • type_row
  • group_id
  • group_name
  • group_parent
  • disabled
  • custom_id
  • group_description
  • group_contact
  • group_other
  • agent_id
  • agent_alias
  • agent_direction
  • agent_commentary
  • agent_id_group
  • agent_last_contact
  • agent_mode
  • agent_interval
  • agent_id_os
  • agent_os_version
  • agent_version
  • agent_last_remote_contact
  • agent_disabled
  • agent_id_parent
  • agent_custom_id
  • agent_server_name
  • agent_cascade_protection
  • agent_name
  • module_id_agent_modulo
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
  • module_critical_inverse (only in version 6.0SP1 or later)
  • module_warning_inverse (only in version 6.0SP1 or later)
  • alert_id_agent_module
  • alert_id_alert_template
  • alert_internal_counter
  • alert_last_fired
  • alert_last_reference
  • alert_times_fired
  • alert_disabled
  • alert_force_execution
  • alert_id_alert_action
  • alert_type
  • alert_value
  • alert_matches_value
  • alert_max_value
  • alert_min_value
  • alert_time_threshold
  • alert_max_alerts
  • alert_min_alerts
  • alert_time_from
  • alert_time_to
  • alert_monday
  • alert_tuesday
  • alert_wednesday
  • alert_thursday
  • alert_friday
  • alert_saturday
  • alert_sunday
  • alert_recovery_notify
  • alert_field2_recovery
  • alert_field3_recovery
  • alert_id_alert_template_module
  • alert_fires_min
  • alert_fires_max
  • alert_id_alert_command
  • alert_command
  • alert_internal
  • alert_template_modules_id
  • alert_templates_id
  • alert_template_module_actions_id
  • alert_actions_id
  • alert_commands_id
  • alert_templates_name
  • alert_actions_name
  • alert_commands_name
  • alert_templates_description
  • alert_commands_description
  • alert_template_modules_priority
  • alert_templates_priority
  • alert_templates_field1
  • alert_actions_field1
  • alert_templates_field2
  • alert_actions_field2
  • alert_templates_field3
  • alert_actions_field3
  • alert_templates_id_group
  • alert_actions_id_group'
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;|%20|type_row,group_id,agent_name&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

get module_data

Call syntax:

  • op=set (compulsory)
  • op2=module_data (compulsory)
  • id=<id_modulo> (compulsory)
  • other_mode=url_encode_separator_<separator> (compulsory)
  • other=<serialized parameters> (optional)
  • The CSV divider character (point by default)
  • The period (in seconds)
  • Start time (<year><month><day>T<hour>:<minute>)
  • End time (<year><month><day>T<hour>:<minute>)

書式:

  • op=set (必須)
  • op2=module_data (必須)
  • id=<モジュールID> (必須)
  • other_mode=url_encode_separator_<セパレータ> (必須)
  • other=<連続パラメータ> (オプション)
  • CSV の区切り文字
  • 間隔 (秒)
  • 開始日時 (<年><月><日>T<時間>:<分>)
  • 終了日時 (<年><月><日>T<時間>:<分>)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_data&id=17&other=;|604800|20121201T13:40|20171215T13:40&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

get graph_module_data

Returns the chart of a module as a image file, this chart is generated with the same method of static graphs of Pandora. It is necesary pass the width, height, period, label and start date of chart (knowing in Pandora the date indicated in graphs always is the end of data) all of they into the other parameter.

モジュールのグラフを画像ファイルで返します。このグラフは、Pandora の静的グラフと同じ手法で生成されます。グラフの幅、高さ、期間、ラベル、開始日(データの終わりがグラフに表示される最後になります)をパラメータに指定する必要があります。

Call syntax:

  • op=set (compulsory)
  • op2=module_data (compulsory)
  • id=<id_modulo> (compulsory)
  • other=<parámetros serializados> (compulsory), are the following in this order:
  • <period>
  • <width>
  • <height>
  • <label>
  • <start_date>

書式:

  • op=set (必須)
  • op2=module_data (必須)
  • id=<モジュールID> (必須)
  • other=<連続パラメータ> (必須), 順番に次のデータを指定します:
  • <期間>
  • <幅>
  • <高さ>
  • <ラベル>
  • <開始日>
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=graph_module_data&id=17&other=604800|555|245|pepito|2009-12-07&other_mode=url_encode_separator_|

get events

Returns a list of events filtered by the other parameter.

other パラメータでフィルタしたイベントの一覧を返します。

テンプレート:メタコンソール

Call syntax:

  • op=get (compulsory)
  • op2=events (compulsory)
  • return_type=csv (compulsory)
  • other_mode=url_encode_separator_| (optional)
  • other=<serialized parameters> (optional).Are the following in this order:
  • <separator>
  • <criticity> From 0 to 4
  • <agent name>
  • <module name>
  • <alert template name>
  • <user>
  • <numeric interval minimum level > in unix timestamp
  • <numeric interval maximum level > in unix timestamp
  • <status>
  • <event substring>
  • <register limit>
  • <offset register>
  • <optional style [total|more_criticity]> (total - returns the number of the records, more_criticity - returns the biggest value of criticity)
  • <event type> unknown, alert_fired, alert_recovered,.. or its substring. you can also use 'not_normal'.

書式:

  • op=get (必須)
  • op2=events (必須)
  • return_type=csv (必須)
  • other_mode=url_encode_separator_| (オプション)
  • other=<連続したパラメータ> (オプション) 次の順番でパラメータを指定します:
  • <セパレータ>
  • <重要度> 0 から 4
  • <エージェント名>
  • <モジュール名>
  • <アラートテンプレート名>
  • <ユーザ>
  • <開始時間> UNIXタイムにて
  • <終了時間> UNIXタイムにて
  • <状態>
  • <イベントに含まれる文字列>
  • <表示上限数>
  • <表示オフセット>
  • <形式オプション [total|more_criticity]> (total - 該当レコード数を返す, more_criticity - 該当レコード中の重要度の最も大きい値を返す)
  • <イベントタイプ> unknown, alert_fired, alert_recovered など(部分文字列も可) または、not_normal
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&other_mode=url_encode_separator_|&return_type=csv&other=;|2|SERVER|CPU|template_alert00||1274715715|127471781&apipass=1234&user=admin&pass=pandora
Full usage example

Sample event #1 report this information:

951140;3998;0;14;0;2012-06-23 22:51:28;Module CheckPandora (0.00) is going to 
CRITICAL;1340484688;going_up_critical;8176;0;4;;;RemoteAgent;Aerin;transmit;Going down to critical 
state;http://firefly.artica.es/pandora_demo//images/b_red.png;Critical;http://firefly.artica.es/pandora_demo//
images/status_sets/default/severity_critical.png 

Most of the fields, match the fields in the dababase, try to do this query using the SQL manager at pandora:

select * from tevento order by id_evento DESC limit 100;

You will see the fields are like this:

  • Field 1 - ID event number (incremental)
  • Field 2 - ID agent
  • Field 3 - ID user which validate the event
  • Field 4 - ID Group (numerical)
  • Field 5 - Status (0 - new, 1 validated... see more in docs about status codes)
  • Field 6 - Timestamp (human string timestamp)
  • Field 7 - Event description (pure text)
  • Field 8 - utimestamp (Unix timestamp, numerical seconds since 1970)
  • Field 9 - event type, tokens representing event type with fixed strings
  • Field 10 - ID agent_module the numerical ID of the module with raise this event. It depends on the event type a new_agent event type do not come with any value here (0). Later the API will get the name, you dont need to call again the api to "resolve" the name by asking with the ID.
  • Field 11- Id alert. THe same with F10
  • Field 12 - Criticity (values), check out the docs to see the codes.
  • Field 13 - User comments (if provided by the user)
  • Field 14 - Tags

Now comes the API aditional fields, not in DB:

  • Field 15 - Agent name
  • Field 16 - Group name
  • Field 17 - Group image name.
  • Field 18 - Long description of the event type
  • Field 19 - URL to image representing the event status (red ball)
  • Field 20 - Description of the event criticity (Field 12)
  • Field 21 - URL to image representing the criticity.
取得情報の例

例えば、次のような情報が得られます。

951140;3998;0;14;0;2012-06-23 22:51:28;Module CheckPandora (0.00) is going to 
CRITICAL;1340484688;going_up_critical;8176;0;4;;;RemoteAgent;Aerin;transmit;Going down to critical 
state;http://firefly.artica.es/pandora_demo//images/b_red.png;Critical;http://firefly.artica.es/pandora_demo//
images/status_sets/default/severity_critical.png 

取得したデータの多くは、データベースの対応テーブルに保存されている値そのものです。 試しに、SQL マネージャーから次のクエリを実行してみてください。

select * from tevento order by id_evento DESC limit 100;

取得したデータの各フィールドは次の通り;

  • フィールド1 - イベントID (自動インクリメント)
  • フィールド2 - エージェントID
  • フィールド3 - イベントを承諾したユーザーのユーザーID
  • フィールド4 - グループID
  • フィールド5 - 状態 (0 - 新規, 1 - 承諾済み, など.. 詳細は、状態コードの記述を参照)
  • フィールド6 - タイムスタンプ (可読文字列)
  • フィールド7 - イベント文字列
  • フィールド8 - unixタイムスタンプ (1970年1月1日からの経過秒数)
  • フィールド9 - イベントタイプ (イベントタイプを表す固定文字列)
  • フィールド10 - モジュールID (イベントが発生したモジュールに割り当てられた数値。例えば new_agent の場合など、イベントタイプによっては 0 が返る。この後記載している通り、取得データにはモジュール名も含まれるので、追加で API を呼んでモジュールID をモジュール名に変換する必要はない)
  • フィールド11- アラートID。モジュールID と同様にイベントタイプによっては 0 が返る
  • フィールド12 - 重要度 (数値、詳細は、重要度の記述を参照)
  • フィールド13 - ユーザーコメント (ユーザー指定があった場合)
  • フィールド14 - タグ

これ以降は、同テーブル外からの追加情報;

  • フィールド15 - エージェント名
  • フィールド16 - グループ名
  • フィールド17 - グループに対するイメージファイル名
  • フィールド18 - イベントタイプに対する説明
  • フィールド19 - 障害状態を示す赤いボールイメージの URL
  • フィールド20 - (フィールド12の)重要度に対する説明
  • フィールド21 - 重要度を表すイメージの URL

get all_alert_templates

Call syntax:

  • op=get (compulsory)
  • op2=all_alert_templates (compulsory)
  • other=cvs_separator (optional)

書式:

  • op=get (必須)
  • op2=all_alert_templates (必須)
  • other=cvs_separator (オプション)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;

get all_alert_commands

Returns all the alert commands.

全アラートコマンドを返します。

Call syntax:

  • op=get (required)
  • op2=all_alert_commands (required)

書式:

  • op=get (必須)
  • op2=all_alert_commands (必須)
http://localhost/pandora_console/include/api.php?op=get&op2=all_alert_commands&return_type=csv&other=$&apipass=1234&user=admin&pass=pandora

get module_groups

Call syntax:

  • op=get (compulsory)
  • op2=module_groups (compulsory)
  • other=cvs_separator (optional)

書式:

  • op=get (必須)
  • op2=module_groups (必須)
  • other=cvs_separator (オプション)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;

get plugins

Call syntax:

  • op=get (compulsory)
  • op2=plugins (compulsory)
  • other=cvs_separator (optional)

書式:

  • op=get (必須)
  • op2=plugins (必須)
  • other=cvs_separator (オプション)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;

get tags

Call syntax:

  • op=get (compulsory)
  • op2=tags (compulsory)
  • return_type=csv (compulsory)

書式:

  • op=get (必須)
  • op2=tags (必須)
  • return_type=csv (必須)

This example will return all tags in the system.

この例では、システムの全てのタグを返します。

http://localhost/pandora_console/include/api.php?op=get&op2=tags&return_type=csv

get module_from_conf

>= 5.0 (Only Enterprise)

>= 5.0 (エンタープライズ版のみ)

Call syntax:

  • op=get (mandatory)
  • op2=update_module_in_conf (mandatory)
  • id=<id agente> (mandatory)
  • id2=<nombre módulo> (mandatory)

書式:

  • op=get (必須)
  • op2=update_module_in_conf (必須)
  • id=<エージェントID> (必須)
  • id2=<モジュール名> (必須)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_from_conf&user=admin&pass=pandora&id=9043&id2=example_name

Si no se encuentra el módulo se retornará cadena vacía.

モジュールが見つからない場合は、空の文字列を返します。

get total_modules

Total modules by group.

グループの全モジュール。

Call syntax:

  • op=get (mandatory)
  • op2=total_modules (mandatory)
  • id=<id group> (mandatory)

書式:

  • op=get (必須)
  • op2=total_modules (必須)
  • id=<グループID> (必須)
http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora

get total_agents

Total agents by group.

グループの全エージェント

Call syntax:

  • op=get (mandatory)
  • op2=total_agents (mandatory)
  • id=<id group> (mandatory)

書式:

  • op=get (必須)
  • op2=total_agents (必須)
  • id=<グループID> (必須)
http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora

get agent_name

Agent name for a given id

指定した ID のエージェント名

Call syntax:

  • op=get (mandatory)
  • op2=agent_name (mandatory)
  • id=<id agent> (mandatory)

書式:

  • op=get (必須)
  • op2=agent_name (必須)
  • id=<エージェントID> (必須)
http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora

get agent_alias

>= 7.0NG

Agent alias for a given id

指定した ID のエージェントの別名を取得します。

Call syntax:

  • op=get (mandatory)
  • op2=agent_alias (mandatory)
  • id=<id agent> (mandatory)
  • id2=<id node> (obligatory in the meta console, unnecessary in the node)

書式:

  • op=get (必須)
  • op2=agent_alias (必須)
  • id=<エージェントID> (必須)
  • id2=<ノードID> (メタコンソールでは必須、ノードでは不要)

Node:

ノード:

http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora

Metaconsole:

メタコンソール:

http://localhost/pandora_console/enterprise/meta/include/api.php?op=get&op2=agent_alias&id=1&id2=1&apipass=1234&user=admin&pass=pandora

get module_name

Module name for a given id.

指定した ID のモジュール名

Call syntax:

  • op=get (mandatory)
  • op2=module_name (mandatory)
  • id=<id module> (mandatory)

書式:

  • op=get (必須)
  • op2=module_name (必須)
  • id=<モジュールID> (必須)
http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora

get alert_action_by_group

Total alert execution with an action by group.

指定したグループにおよびアクションにおいて、実行された全アラート

Call syntax:

  • op=get (mandatory)
  • op2=alert_action_by_group (mandatory)
  • id=<id group> (mandatory)
  • id2=<id action> (mandatory)

書式:

  • op=get (必須)
  • op2=alert_action_by_group (必須)
  • id=<グループID> (必須)
  • id2=<アクションID> (必須)
http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora

get alert_actions

List of alert actions

アラートアクションの一覧を取得します。

Call syntax:

  • op=get (required)
  • op2=alert_actions (required)
  • return_type=<return type> (required) which can be 'csv' or 'json'.
  • other=<serialized parameters> (optional):
  • <action_name> (optional)
  • <separator> (optional)

書式:

  • op=get (必須)
  • op2=alert_actions (必須)
  • return_type=<return type> (必須) 'csv' または 'json' を指定できます。
  • other=<連続パラメータ> (オプション):
  • <action_name> (オプション)
  • <separator> (オプション)
http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions&apipass=1234&user=admin&pass=pandora&other=Create|&other_mode=url_encode_separator_|&return_type=json

get alert_actions_meta

この機能はメタコンソールのみです。


List of node alert actions from Metaconsole.

テンプレート:メタコンソール メタコンソールから、ノードのアラートアクションの一覧を取得します。

Call syntax:

  • op=get (required)
  • op2=alert_actions_meta (required)
  • return_type=<return type> (required) which can be 'csv' o 'json'.
  • other=<serialized parameters> (optional):
  • <server_name> (optional)
  • <action_name> (optional)
  • <separator> (optional)

書式:

  • op=get (必須)
  • op2=alert_actions_meta (必須)
  • return_type=<return type> (必須) 'csv' または 'json' を指定できます。
  • other=<連続パラメータ> (オプション):
  • <server_name> (オプション)
  • <action_name> (オプション)
  • <separator> (オプション)
http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions_meta&apipass=1234&user=admin&pass=pandora&other=nodo|Create|&other_mode=url_encode_separator_|&return_type=json

get event_info

Call syntax:

  • op=get (mandatory)
  • op2=event_info (mandatory)
  • id=<id_event> (mandatory)

書式:

  • op=get (必須)
  • op2=event_info (必須)
  • id=<イベントID> (必須)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora

get tactical_view

Call syntax:

  • op=get (mandatory)
  • op2=tactical_view (mandatory)

書式:

  • op=get (必須)
  • op2=tactical_view (必須)
<nowoki>http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora</nowiki>

get pandora_servers

>= 5.0

call syntax:

  • op=get (compulsory)
  • op2=pandora_servers (compulsory)
  • other=cvs_separator (optional)

バージョン 5.0 かそれ以降

書式:

  • op=get (必須)
  • op2=pandora_servers (必須)
  • other=cvs_separator (オプション)
Example
http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora

It returns the fields in this order:

  • name
  • status (1 - up, 0 - down)
  • type (human readable string)
  • master (1 - master, 0 - not master)
  • running modules
  • total modules
  • max delay (sec)
  • delayed modules
  • threads
  • queued_modules
  • timestamp of update (human readable string)

次の順番で値が返ります。

  • サーバ名
  • 状態 (1 - 稼働, 0 - 停止)
  • サーバタイプ (文字列)
  • マスターサーバかどうか (1 - マスターサーバ, 0 - マスターサーバではない)
  • 稼働中のモジュール数
  • 該当する全モジュール数
  • 最大遅延(秒)
  • 遅延モジュール数
  • スレッド数
  • 現在キューに溜まっているモジュール数
  • 最終更新日時 (文字列)

get custom_field_id

>= 5.0

Call syntax:

  • op=get (mandatory)
  • op2=custom_field_id (mandatory)
  • other=<serialized parameters> (mandatory) in this case custom field name
  • <name> (mandatory)

書式:

  • op=get (必須)
  • op2=custom_field_id (必須)
  • other=<連続パラメータ> (必須) カスタムフィールド名です
  • <名前> (必須)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=custom_field_id&other=mycustomfield&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

get gis_agent

>= 5.0

Return the last gis agent data.

エージェントの最新の gis データを返します。

Sintax call:

書式:

  • op=set (compulsory)
  • op2=gis_agent (compulsory)
  • id=<index> (compulsory) agent index.
  • op=set (必須)
  • op2=gis_agent (必須)
  • id=<id> (必衰) エージェントID
http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1

get special_days

>= 5.1

Return special day's list.

特別日一覧を返します。

Sintax call:

書式:

  • op=set (compulsory)
  • op2=special_days (compulsory)
  • other=<csv separator> (optional) CSV separator
  • op=set (必須)
  • op2=gis_agent (必須)
  • other=<csvセパレータ> (オプション) CSVのセパレータ
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=special_days

get module_properties

>= 5.1SP2

Returns a list of module properties. The list could be filtered by the parameter.

モジュールのプロパティ一覧を返します。出力する項目は other で指定できます。


Call Syntax:

  • op=get (compulsory)
  • op2=module_properties (compulsory)
  • id=module-id (compulsory)
  • return_type=<return kind> (compulsory) that could be 'csv' or 'csv_head'.
  • other=<string or serialized parameters> (optional) in this case could be the divider or a parameter list in order and separated by the divider character. We are going to examine the two cases:

書式:

  • op=get (必須)
  • op2=module_properties (必須)
  • id=モジュールID。 (必須)
  • return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
  • other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。以下に2つのケースを示します。:
  • <separator> The divider "yes" of the 'csv'.
  • <separator csv>|<character that replaces the CR|<fields 1>,<fields 2>,<fields N>it will compose the following parameters in order( the divider character '|' could be specified in "other_mode"):
  • <separator csv>: divider of the fields in the CSV.
  • <character that replaces the CR> character that will be replaced if it finds in any returned character the character RC in order to avoid the ambiguity with the standard use of the RC character to specify registers/files in the CSV. If you pass an string in other, the substitute character is the blank space.
  • <fields 1>,<fields2>,<fields N> :the fields to output in CSV are:
  • <セパレータ> CSV のセパレータ
  • <CSVセパレータ>|<CR と置き換える文字>|<フィールド1>,<フィールド2>,<フィールドN>これは、次のパラメータを構成します。(セパレータ文字として '|' を "other_mode" で指定できます。):
  • <CSVセパレータ>: CSV のフィールドセパレータ
  • <CR と置き換える文字> CSVファイル内に改行コードを見つけた場合に、通常の改行の意味で利用している場合と曖昧になるのを避けるために、それを置き換える文字です。文字列を渡すと、スペースに置換されます。
  • <フィールド1>,<フィールド2>,<フィールドN> :CSV に指定できるフィールドは次の通りです:
  • module_id_agent_modulo
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=6233&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=1103&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

get module_properties_by_name

>= 5.1SP2

Returns a list of module properties. The list could be filtered by the parameter.

モジュールのプロパティ一覧を返します。出力する項目は other で指定できます。

Call Syntax:

  • op=get (compulsory)
  • op2=module_properties_by_name (compulsory)
  • id=agent_name (compulsory)
  • id2=agentmodule_name (compulsory)
  • return_type=<return kind> (compulsory) that could be 'csv' or 'csv_head'.
  • other=<string or serialized parameters> (optional) in this case could be the divider or a parameter list in order and separated by the divider character. (the same as 'get module_properties'. For details, see 'get module_properties')

書式:

  • op=get (必須)
  • op2=module_properties_by_name (必須)
  • id=エージェント名。 (必須)
  • id2=モジュール名。 (必須)
  • return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
  • other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。(get_module_properties と同じです。詳しくは、get_module_properties を参照してください)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

get module_properties_by_alias

>= 7.0NG

Returns a list of module properties. The list could be filtered by the parameter.

モジュールプロパティの一覧を返します。一覧はパラメータでフィルタできます。

Call Syntax:

  • op=get (compulsory)
  • op2=module_properties_by_alias (compulsory)
  • id=agent_alias (compulsory)
  • id2=agentmodule_name (compulsory)
  • return_type=<return kind> (compulsory) that could be 'csv' or 'csv_head'.
  • other=<string or serialized parameters> (optional) in this case could be the divider or a parameter list in order and separated by the divider character. (the same as 'get module_properties'. For details, see 'get module_properties')

書式:

  • op=get (必須)
  • op2=module_properties_by_alias (必須)
  • id=agent_alias (必須)
  • id2=agentmodule_name (必須)
  • return_type=<戻りタイプ> (必須) 'csv' または 'csv_head' を指定できます。
  • other=<文字列またはパラメータの並び> (オプション) セパレータ文字によって分割されたパラメータリストです。(get_module_properties と同じです。詳しくは、get_module_properties を参照してください)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_alias&id=pandorafms&id2=Memory_Used&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

get module_graph

>= 6.0

Returns a module graph encoded with base64.

base64 でエンコードされたモジュールグラフを返します。

Call Syntax:

  • op=get (compulsory)
  • op2=module_graph (compulsory)
  • id=<module id> (compulsory)
  • other=<period in seconds> (optional) 3600 by default (1 hour). Period of time used in the data recovery.

書式:

  • op=get (必須)
  • op2=module_graph (必須)
  • id=<モジュールID> (必須)
  • other=<秒単位の間隔> (オプション) デフォルトは 3600 (1時間)です。 時間間隔はデータリカバリに使われます。
http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=5&other=3600%7C1&other_mode=url_encode_separator_%7C&apipass=1234&api=1&user=admin&pass=pandora

get all_planned_downtimes

>= 5.1

Return all matches of planned downtime.

マッチした全計画停止を返します。

op=get op2=all_planned_downtimes return_type=csv other=<name> <group> <type_downtime> <type_execution> <type_periodicity> (for filter)

書式:

  • op=get
  • op2=all_planned_downtimes
  • return_type=csv
  • other=<名前> <グループ> <計画停止タイプ> <実行タイプ> <実行タイミングタイプ> (フィルタ)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

get planned_downtimes_items

>= 5.1

Return all matches of planned downtime items.

マッチした全計画停止を返します。

op=get op2=planned_downtimes_items return_type=csv other=<name> <group> <type_downtime> <type_execution> <type_periodicity> (for filter)

書式:

  • op=get
  • op2=planned_downtimes_items
  • return_type=csv
  • other=<名前> <グループ> <計画停止タイプ> <実行タイプ> <実行タイミングタイプ> (フィルタ)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

get id_group_agent_by_name

>= 5.1

Return the group id of an agent.

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

Call Syntax:

  • op=get
  • op2=id_group_agent_by_name
  • other=<string or serialized parameters> Agent name and filtering parameters (optional)
  • <agent_name>

書式:

  • op=get
  • op2=id_group_agent_by_name
  • other=<文字列または連続パラメータ> エージェント名およびフィルタリングパラメータ (オプション)
  • <エージェント名>
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40


get id_group_agent_by_alias

>= 7.0NG

Return the group id of an agent.

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

Call Syntax:

  • op=get
  • op2=id_group_agent_by_alias
  • other=<string or serialized parameters> Agent alias and filtering parameters (optional)
  • <agent_alias>

書式:

  • op=get
  • op2=id_group_agent_by_alias
  • other=<文字列または連続パラメータ> エージェントの別名およびフィルタリングパラメータ (オプション)
  • <エージェントの別名>
 http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

get group_agent_by_name

>= 5.1

Return the group name for a agent.

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

Call Syntax:

  • op=get
  • op2=group_agent_by_name
  • other=<string or serialized parameters> Agent name and filtering parameters (optional).
  • <agent_name>

書式:

  • op=get
  • op2=group_agent_by_name
  • other=<文字列または連続パラメータ> エージェント名およびフィルタリングパラメータ (オプション)
  • <エージェント名>
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40

get group_agent_by_alias

>= 7.0NG

Return the group name for a agent.

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

Call Syntax:

  • op=get
  • op2=group_agent_by_alias
  • other=<string or serialized parameters> Agent alias and filtering parameters (optional).
  • <agent_alias>

書式:

  • op=get
  • op2=group_agent_by_alias
  • other=<文字列または連続パラメータ> エージェントの別名およびフィルタリングパラメータ (オプション)
  • <エージェントの別名>
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

get group_id_by_name

>= 7.0NG

Retorna el id de grupo a partir del nombre.

名前からグループ ID を返します。

Sintaxis de la llamada:

  • op=get
  • op2=group_id_by_name
  • other=<parámetros único> (obligatorio):
  • <group_name>

書式:

  • op=get
  • op2=group_id_by_name
  • other=<単一パラメータ> (必須):
  • <グループ名>
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_id_by_name&other=Servers

get get_timezone

>= 7.0NG

Retorna el timezone con el que está configurado pandora.

Pandora に設定されているタイムゾーンを返します。

Sintaxis de la llamada:

  • op=get
  • op2=timezone

書式:

  • op=get
  • op2=timezone
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone

get cluster_status

>= 7.0

Returns the cluster status by id

ID ごとのクラスタ状態を返します。

  • op=get
  • op2=cluster_status
  • id=cluster id

書式:

  • op=get
  • op2=cluster_status
  • id=<クラスタID>
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_status&id=1&apipass=1234&user=admin&pass=pandora

get cluster_id_by_name

>= 7.0

Returns the id of the cluster by name

名前からクラスタの ID を返します。

  • op=get
  • op2=cluster_id_by_name
  • id=cluster name
  • op=get
  • op2=cluster_id_by_name
  • id=<クラスタ名>
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_id_by_name&id=paco&apipass=1234&user=admin&pass=pandora

get agents_id_name_by_cluster_id

>= 7.0

Returns the id => cluster agents names by the cluster id

クラスタ ID から、ID => クラスタエージェント名を返します。

  • op=get
  • op2=agents_id_name_by_cluster_id
  • id=cluster id
  • op=get
  • op2=agents_id_name_by_cluster_id
  • id=<クラスタID>
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

get agents_id_name_by_cluster_name

>= 7.0 Returns the id => cluster agents names by the cluster name

クラスタ名から、ID => クラスタエージェント名を返します。

  • op=get
  • op2=agents_id_name_by_cluster_name
  • id=cluster id
  • op=get
  • op2=agents_id_name_by_cluster_name
  • id=<クラスタ名>
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_name&id=paco&apipass=1234&user=admin&pass=pandora

get modules_id_name_by_cluster_id

>= 7.0

Returns the id => all the module names of the cluster agents by the cluster id

クラスタ ID から、ID => クラスタエージェントの全モジュール名を返します。

  • op=get
  • op2=modules_id_name_by_cluster_id
  • id=cluster id
  • op=get
  • op2=modules_id_name_by_cluster_id
  • id=<クラスタID>
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

get modules_id_name_by_cluster_name

>= 7.0

Returns the id => all the module names of the cluster agents by the cluster name

クラスタ名から、ID => クラスタエージェントの全モジュール名を返します。

  • op=get
  • op2=modules_id_name_by_cluster_name
  • id=cluster name
  • op=get
  • op2=modules_id_name_by_cluster_name
  • id=<クラスタ名>
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_name&id=paco&apipass=1234&user=admin&pass=pandora

get cluster_items

>= 7.0

Returns the items of a json object with the format: item id => (name,id,module_agent,type,pcrit,pwarn), by the cluster id

クラスタ ID から、アイテムID => (name,id,module_agent,type,pcrit,pwarn) のフォーマットで json オブジェクトの要素を返します。

pcrit: % for the critic state if its AA or 1 o 0 if its AP

pwarn: % for the warning state if its AA or null if its AP

  • op=get
  • op2=cluster_items
  • id=cluster id
  • op=get
  • op2=cluster_items
  • id=<クラスタID>
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_items&id=1&apipass=1234&user=admin&pass=pandora

get policy

>= 7.0NG. 725

Returns all data from a policy. If no policy id is specified, it will return all data from all policies.

ポリシーから全データを返します。ポリシー ID が指定されていない場合は、全ポリシーから全データを返します。

Call syntax:

  • op=get
  • op2=policy
  • id=id_policy (optional)
  • return_type=(json, csv, string).

書式:

  • op=get
  • op2=policy
  • id=<ポリシーID> (オプション)
  • return_type=(json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.

get collections_policy

>= 7.0NG. 725

Returns all colections of a policy. If no policy id is specified, it returns all colections of all policies.

ポリシーの全コレクションを返します。ポリシー ID が指定されていない場合は、全ポリシーの全コレクションを返します。

Call syntax:

  • op=get
  • op2=collections_policy
  • id=id_policy (optional)
  • return_type=(json, csv, string).

書式:

  • op=get
  • op2=collections_policy
  • id=<ポリシーID> (オプション)
  • return_type=(json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

get plugins_policy

>= 7.0NG. 725

Returns all plugins of a policy. If no policy id is specified, it returns all plugins of all policies.

ポリシーの全プラグインを返します。ポリシー ID が指定されていない場合は、全ポリシーの全プラグインを返します。

Call syntax:

  • op=get
  • op2=plugins_policy
  • id=id_policy (optional)
  • return_type=(json, csv, string).

書式:

  • op=get
  • op2=plugins_policy
  • id=<ポリシーID> (オプション)
  • return_type=(json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

get inventory_policy

>= 7.0NG. 725

Returns all inventory modules of a policy. If no policy id is specified, it returns all inventory modules of all policies.

ポリシーのインベントリモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全インベントリモジュールを返します。

Call syntax:

  • op=get
  • op2=inventory_policy
  • id=id_policy (optional)
  • return_type=(json, csv, string).

書式:

  • op=get
  • op2=inventory_policy
  • id=<ポリシーID> (オプション)
  • return_type=(json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=inventory_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

get unlinking_policy

>= 7.0NG. 725

Returns all unlinked modules of a policy. If no policy id is specified, it returns all unlinked modules of all policies.

ポリシーの全未リンクモジュールを返します。ポリシー ID が指定されていない場合は、全ポリシーの全未リンクモジュールを返します。

Call syntax:

  • op=get
  • op2=unlinking_policy
  • id=id_policy(optional)
  • return_type=(json, csv, string).

書式:

  • op=get
  • op2=unlinking_policy
  • id=<ポリシーID> (オプション)
  • return_type=(json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

get alerts_policy

>= 7.0NG. 725

Returns the alerts of a policy, taking into account:

次の点を考慮して、ポリシーのアラートを返します。

  • If a policy id is specified, it returns the alerts of that policy. If not, it returns all alerts of all policies.
  • If the type of alert is specified:(three options).
    • 0: it shows all by default.
    • 1: Shows only the normal alerts.
    • 2: Shows only the external alerts.
  • ポリシー ID が指定されていれば、ポリシーのアラートを返します。そうでなければ、全ポリシーの全アラートを返します。
  • アラートのタイプを指定されている場合: (オプションは 3つあります)
    • 0: すべてを表示します(デフォルト)
    • 1: 通常アラートのみ表示します
    • 2: 外部アラートのみ表示します

Call syntax:

  • op=get
  • op2=alerts_policy
  • id=id_policy(optional).
  • id2= 0:all(by default), 1:normal, 2:external.
  • return_type=(json, csv, string).

書式:

  • op=get
  • op2=alerts_policy
  • id=<ポリシーID> (オプション)
  • id2= 0:すべて(デフォルト), 1:通常, 2:外部
  • return_type=(json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id2=2.

get alerts_actions_policy

>= 7.0NG. 725

Returns all actions of the alerts of a policy, taking into account:

以下を考慮して、ポリシーのアラートの全アクションを返します。

  • If a policy id is specified, it returns the actions of the alerts of that policy. If not, it returns all the actions of all the alerts of all policies.
  • If an alert id is specified, it returns the action of that alert.
  • ポリシー ID が指定されている場合は、そのポリシーのアラートのアクションを返します。指定されていない場合は、全ポリシーの全アラートの全アクションを返します。
  • アラート ID が指定されている場合は、そのアラートのアクションを返します。

Sintaxis de la llamada:

  • op = get
  • op2 = alerts_actions_policy
  • id = id_policy(optional).
  • id2 = id_policy_alert(optional).
  • return_type=(json, csv, string).

書式:

  • op = get
  • op2 = alerts_actions_policy
  • id = <ポリシーID> (オプション)
  • id2 = <ポリシーアラートID> (オプション)
  • return_type=(json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=1&id2=3

get agents_policy

>= 7.0NG. 725

Returns all agent of a policy. If no policy id is specified, it returns all agents of all policies.

ポリシーの全エージェントを返します。ポリシー ID が指定されていない場合は、全ポリシーの全エージェントを返します。

Call syntax:

  • op = get
  • op2 = agents_policy
  • id = id_policy(optional)
  • return_type = (json, csv, string).

書式:

  • op = get
  • op2 = agents_policy
  • id = <ポリシーID> (オプション)
  • return_type = (json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=agents_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

get groups_policy

>= 7.0NG. 725

Returns all groups of a policy. If no policy id is specified, it returns all groups of all policies.

ポリシーの全グループを返します。ポリシー ID が指定されていない場合は、全ポリシーの全グループを返します。

Call syntax:

  • op = get
  • op2 = groups_policy
  • id = id_policy(optional)
  • return_type = (json, csv, string).

書式:

  • op = get
  • op2 = groups_policy
  • id = <ポリシーID> (オプション)
  • return_type = (json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=groups_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

get queue_policy

>= 7.0NG. 725

Returns the queue of a policy. If no id policy is specified, its returns all queues of all policies.

ポリシーのキューを返します。ポリシー ID が指定されていない場合は、全ポリシーの全キューを返します。

Call syntax:

  • op = get
  • op2 = queue_policy
  • id = id_policy(optional)
  • return_type = (json, csv, string).

書式:

  • op = get
  • op2 = queue_policy
  • id = <ポリシーID> (オプション)
  • return_type = (json, csv, string).
http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json

get traps

>= 7.0NG. 728

Devuelve los traps de origen especificado, también puedes filtrar por timestamp y otros datos.

指定されたソーストラップを返します。また、タイムスタンプやその他のデータをフィルタリングすることもできます。

Sintaxis de la llamada:

  • op = get
  • op2 = traps
  • other=<parámetros opcionales>:
  • <timestamp>
  • <limit>
  • <offset>
  • <status>
  • <oid_custom>

書式:

  • op = get
  • op2 = traps
  • other=<オプションパラメータ>:
  • <timestamp>
  • <limit>
  • <offset>
  • <status>
  • <oid_custom>
https://localhost/pandora_console/include/api.php?op=get&op2=traps&other=1537128000%7C9000%7C0%7C1%7C.1.2.3.6.4&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

get event_responses

Returns the response list of events the user has access to in Pandora FMS.

Pandora FMS でユーザがアクセスするイベント応答の一覧を返します。

Call syntax:

  • op=get (required)
  • op2=event_reponses (required)
  • return_type=csv|json (required)

書式:

  • op=get (必須)
  • op2=event_reponses (必須)
  • return_type=csv|json (必須)

This example will return all system event responses in csv format.

この例では、csv フォーマットで全システムイベント応答を返します。

http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora

get users

Returns the list of Pandora FMS' users.

Pandora FMS のユーザ一覧を返します。

Call syntax:

  • op=get (required)
  • op2=users (required)
  • return_type=csv|json (required)

書式:

  • op=get (必須)
  • op2=users (必須)
  • return_type=csv|json (必須)

This example will return all users in csv format.

この例では、全ユーザを CSV フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=users&return_type=csv&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_&

get list all user

この機能はメタコンソールのみです。


It lists all Pandora FMS users.

全 Pandora FMS ユーザ一覧を出力します。

Call syntax:

  • op=get (required)
  • op2=list_all_user(required)
  • return_type=csv|json (required)

書式:

  • op=get (必須)
  • op2=list_all_user(必須)
  • return_type=csv|json (必須)

It can return Json or CSV, this return is remarked through the URL. Only the type of return is remarked, it does not use any specific variable

Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 応答タイプのみの指定で、その他変数は使用しません。

http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora

get info user name

この機能はメタコンソールのみです。


It lists user data.

ユーザデータの一覧を返します。

Call syntax:

  • op=get (required)
  • op2=list_all_user(required)
  • return_type=csv|json (required)
  • other= usernarme (requiered)

書式:

  • op=get (必須)
  • op2=list_all_user(必須)
  • return_type=csv|json (必須)
  • other= usernarme (必須)

It obtains all the information about a specific user. It can return Json or CSV. This return is specified through the URL Only the username is used to obtain said information:

指定のユーザに関するすべての情報を取得します。 Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 応答タイプのみの指定で、その他変数は使用しません。

http://localhost/pandora_console/include/api.php?op=get&op2=info_user_name&return_type=json&other=admin&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

get user_profiles_info

Returns the list of Pandora FMS' user profiles.

Pandora FMS のユーザプロファイル一覧を返します。

Call syntax:

  • op=get (required)
  • op2=user_profiles_info (required)
  • return_type=csv|json (required)

書式:

  • op=get (必須)
  • op2=user_profiles_info (必須)
  • return_type=csv|json (必須)

This example will return all system user profiles in json format.

この例では、全システムユーザプロファイルを json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=json&apipass=1234&user=admin&pass=pandora

get migrate_agent

>= 7.21 ONLY METACONSOLE

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

Mira si existe en la cola de migración de agentes un agente determinado devolviendo los datos de tmigration_queue

エージェントマイグレーションキューに、指定のエージェントが存在するかを確認します。

  • op=get
  • op2=migrate_agent
  • id=id_agente a migrar
  • return_type = string, json, etc
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&return_type=json

get language

>= 7.0NG 730

Returns the language with which Pandora FMS is configured.

Pandora FMS に設定されている言語を返します。

Call syntax:

  • op=get
  • op2=language

書式:

  • op=get
  • op2=language
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language

get session_timeout

>= 7.0NG 730

Returns the session time with which Pandora FMS is configured.

Pandora FMS に設定されたセッションタイムアウトを返します。

Call syntax:

  • op=get
  • op2=session_timeout

書式:

  • op=get
  • op2=session_timeout
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=session_timeout

get groups

>= 7.0NG 732

Returns the existing groups.

存在するグループを返します。

Call syntax:

  • op=get
  • op2=groups
  • other=<optional parameters>:
  • <csv_separator>: ';' by default.
  • <return_all_group>: returns the group 'All'.
  • <return_all_columns>: returns all columns.

書式:

  • op=get
  • op2=groups
  • other=<オプションパラメータ>:
  • <csv_separator>: デフォルトは ';'。
  • <return_all_group>: 'すべて' グループを返します。
  • <return_all_columns>: 全カラムを返します。
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=groups&other=;%7C1%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

get filter user group

この機能はメタコンソールのみです。


It obtains user groups through filtering.

フィルタリングを行ったユーザグループを取得します。

Call syntax:

  • op=get (requiered)
  • op2=filter_user_group (requiered)
  • return_type=csv|json(requiered)
  • other= id group(requiered)|Enabled or not(Disabled)(requiered)

書式:

  • op=get (必須)
  • op2=filter_user_group (必須)
  • return_type=csv|json(必須)
  • other= id group(必須)|Enabled or not(Disabled)(必須)


It can return Json or CSV. This return is remarked through the URL. Be careful, one of the two variables (group id or Enabled) may be empty, but at least one of them should be filled out.

Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 2つの変数(グループIDまたは有効化)の 1つは空ですが、少なくとも 1つは入力する必要があることに注意してください。

http://localhost/pandora_console/include/api.php?op=get&op2=filter_user_group&return_type=json&other=0|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

get inventory_modules

Returns the list of Pandora inventory modules.

Pandora インベントリモジュールの一覧を返します。

Call syntax:

  • op=get (required)
  • op2=inventory_modules (required)
  • return_type=csv|json (required)

書式:

  • op=get (必須)
  • op2=inventory_modules (必須)
  • return_type=csv|json (必須)

This example will return information from all of the system's inventories in json format.

この例では、全インベントリの情報を json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora

get list_collections

Returns the list of all the collections in Pandora.

Pandora の全コレクションの一覧を返します。

Call syntax:

  • op=get (required)
  • op2=list_collections (required)

書式:

  • op=get (必須)
  • op2=list_collections (必須)

This example will return information from all collections in json format.

この例では、全コレクションの情報を json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=list_collections&apipass=1234&user=admin&pass=pandora

get list_collection_files

Returns the list of all the files in a collection. If the collection id is not passed, it will return all files from all collections.

コレクション内の全ファイル一覧を返します。コレクション ID を指定しなかった場合、全コレクションの全ファイルを返します。

Call syntax:

  • op=get (required)
  • op2=list_collections_files (required)
  • id=id_collection

書式:

  • op=get (必須)
  • op2=list_collections_files (必須)
  • id=id_collection

This example will return the names of all files in a collection in json format.

この例では、コレクション内の全ファイル名を json フォーマットで返します。

http://localhost/pandora_console/include/api.php?op=get&op2=list_collection_files&id=1&apipass=1234&user=admin&pass=pandora

get all_event_filters

Returns the list of existing event filters.

存在するイベントフィルタの一覧を返します。

Call syntax:

  • op=get (required)
  • op2=all_event_filters (required)
  • other=cvs_separator (optional)

書式:

  • op=get (必須)
  • op2=all_event_filters (必須)
  • other=cvs_separator (オプション)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_event_filters&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

設定

Send data

データを送信します。

set new_agent

Create a new agent with the data passed as parameters.

パラメータで指定した内容で新たなエージェントを作成します。

Call syntax:

  • op=set (compulsory)
  • op2=new_agent (compulsory)
  • other=<parámetros serializados> (compulsory).They are the agent configuration and data, serial in the following order:
  • <nombre_agente>
  • <ip>
  • <id_parent>
  • <id_group>
  • <cascade_protection>
  • <cascade_protection_module>
  • <interval_sec>
  • <id_os>
  • <name_server>
  • <custom_id>
  • <learning_mode>
  • <disabled>
  • <description>

書式:

  • op=set (必須)
  • op2=new_agent (必須)
  • other=<連続したパラメータ> (必須) エージェントの設定とデータを次の順番に指定します。
  • <エージェント名>
  • <IP>
  • <親エージェントのID>
  • <グループID>
  • <関連障害検知抑制>
  • <間隔(秒)>
  • <OSのID>
  • <サーバ名>
  • <カスタムID>
  • <学習モード>
  • <無効化>
  • <説明>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_agent&other=agente_nombre|1.1.1.1|0|4|0|30|8|miguel-portatil||0|0|la%20descripcion&other_mode=url_encode_separator_|
  • Note: If alias_as_name is 1, the agent name will be the same as the alias. If it is 0, the agent name will be automatically generated.
  • 注意: alias_as_name が 1 の場合はエージェント名は別名と同じです。0 の場合はエージェント名は自動的に生成されます。

Set update_agent

Update a new agent with the data passed as parameters.

パラメータで渡したデータで、新たなエージェントを更新します。

Call syntax:

書式:

  • op=set (compulsory)
  • op2=update_agent (compulsory)
  • id=<id_agent> (compulsory)
  • other=<serialized parameters> (compulsory).They are the agent configuration and data, serial in the following order:
  • <agent_name>
  • <ip>
  • <id_parent>
  • <id_group>
  • <cascade_protection>
  • <interval_sec>
  • <id_os>
  • <name_server>
  • <custom_id>
  • <learning_mode>
  • <disabled>
  • <description>
  • op=set (必須)
  • op2=update_agent (必須)
  • id=<エージェントID> (必須)
  • other=<連続パラメータ> (必須) エージェントの設定データで次の順番で設定します。
  • <エージェント名>
  • <ip>
  • <親ID>
  • <グループID>
  • <関連障害検知抑制>
  • <間隔(秒)>
  • <OSのID>
  • <サーバ名>
  • <カスタムID>
  • <学習モード>
  • <無効化>
  • <説明>
http://127.0.0.1/pandora_console/include/api.php?id=5&op=set&op2=update_agent&other=agente_nombre|1.1.1.1|0|4|0|30|8|10||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set delete_agent

Delete a agent that passed the name as paramete

指定した名前のエージェントを削除します。

Call syntax:

  • op=set (compulsory)
  • op2=delete_agent (compulsory)
  • id=<name_agent> (compulsory) should be an agent name.

書式:

  • op=set (必須)
  • op2=delete_agent (必須)
  • id=<エージェント名> (必須) エージェント名でなければいけません。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo

set create_module_template

Create a alert from a template pass as id parameter, in the module pass as id into other and agent pass as id into the other.

id に指定したテンプレート、other に指定したエージェント、モジュール ID から、アラートを作成します。

Call syntax:

  • op=set (compulsory)
  • op2=create_module_template (compulsory)
  • id=<id_template> (compulsory) should be a template id.
  • other=<id_module>|<id_agent>

書式:

  • op=set (必須)
  • op2=create_module_template (必須)
  • id=<テンプレートID> (必須) テンプレートIDでなければいけません。
  • other=<id_module>|<id_agent>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_module_template&id=1&other=1|10&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set apply_module_template

Apply module template to agent

モジュールテンプレートをエージェントへ適用します。

Module template are an agrupation which contain network check modules. This templates can be applied directly to agents, avoiding add modules one by one.

モジュールテンプレートは、ネットワークモジュールを集めたものです。このテンプレートは、直接エージェントに適用することができ、モジュールを一つ一つ追加する必要はありません。

Call sintax:

  • op=set (compulsory)
  • op2=apply_module_template (compulsory)
  • id<id_template> (compulsory) id of the template that will be applied on the module.
  • id2<id_agente> (compulsory) id of the agent in which the modules will be created.

書式:

  • op=set (必須)
  • op2=apply_module_template (必須)
  • id<id_template> (必須) 適用されるテンプレートの ID
  • id2<id_agente> (必須) モジュールが作成されるエージェントの ID
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_module_template&id=2&id2=2&apipass=1234&user=admin&pass=pandora

set create_network_module

Create a network module from the data pass as parameters.

指定のパラメータでネットワークモジュールを作成します。

Call syntax:

  • op=set (compulsory)
  • op2=create_network_module (compulsory)
  • id=<nombre_agente> (compulsory) should be an agent name.
  • other=<parámetros serializados> (compulsory)are the module configuration an data,serialized in the following order:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <tcp_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min>
  • <max>
  • <custom_id>
  • <description>
  • <enable_unknown_events> (only in version 5 or later)
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <critical_inverse> (only in version 6.0SP1 or later)
  • <warning_inverse> (only in version 6.0SP1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=create_network_module (必須)
  • id=<エージェント名> (必須) エージェント名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番で指定するモジュール設定パラメータです。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告の文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害の文字列>
  • <連続抑制回数>
  • <ヒストリーデータ>
  • <対象IP>
  • <TCPポート>
  • <snmpコミュニティ>
  • <snmp OID>
  • <モジュール間隔>
  • <データ保存倍率>
  • <最小>
  • <最大>
  • <カスタムID>
  • <説明>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害条件の反転> (バージョン 6.0SP1 以降のみ)
  • <警告条件の反転> (バージョン 6.0SP1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_network_module&id=pepito&other=prueba|0|7|1|0|0|0|0|0|1|127.0.0.1|0||0|180|0|0|0||latency%20ping&other_mode=url_encode_separator_|

set create_plugin_module

Create a module plugin with the data passed as parameters.

指定のパラメータでプラグインモジュールを作成します。

Call sintax:

  • op=set (compulsory)
  • op2=create_plugin_module (compulsory)
  • id=<agent_name> (compulsory) should be an agent name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <tcp_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <id_plugin>
  • <plugin_user>
  • <plugin_pass>
  • <plugin_parameter>
  • <enable_unknown_events> (only in version 5 or later)
  • <macros> (only in version 5 or later) Should be a base 64 encoded JSON document. The content should be an object formed by objects with the following properties:
    • "macro": Macro name. Should be _field1_, _field2_, ..., _fieldN_.
    • "desc": Descriptive name of the macro.
    • "help": Description of the macro.
    • "value":Value of the macro.
    • "hide": Set to "1" to hide the value of the macro (useful for storing passwords).
Example
{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
   "hide": ""
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
   "hide": ""
 }
}
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=create_plugin_module (必須)
  • id=<エージェント名> (必須) エージェント名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定を指定します。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <ヒストリーデータ>
  • <対象IP>
  • <TCPポート>
  • <snmp コミュニティ>
  • <snmp OID>
  • <モジュール間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <プラグインID>
  • <プラグインユーザ>
  • <プラグインパスワード>
  • <プラグインパラメータ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <マクロ> (バージョン 5 以降のみ) base 64 でエンコードされた JSON 文字列である必要があります。内容は、次のプロパティでまとめたオブジェクトでなければいけません。
    • '"macro": マクロ名。_field1_, _field2_, ..., _fieldN_ でなければいけません。
    • "desc": マクロを表す名前。
    • "help": マクロの説明。
    • "value":マクロの値。
    • "hide": マクロの値を隠す場合は "1" に設定します。(パスワードの記載に便利です)
{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
   "hide": ""
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
   "hide": ""
 }
}
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロを一つのプロパティで表した base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" です。
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_plugin_module&id=pepito&other=prueba|0|1|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|

set create_data_module

Create a module from parameters passed.

指定したパラメータでモジュールを作成します。

Template warning.png

With this call you can add database module data but you cannot modify configuration file of the agents associated to the module.


Template warning.png

このコマンドにてデータベースにモジュールデータを追加できますが、モジュールに関連づけられたエージェントの設定ファイルの編集はできません。


Call sintax:

  • op=set (compulsory)
  • op2=create_data_module (compulsory)
  • id=<agent_name> (compulsory) should be an agent name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <description>
  • <id_module_group>
  • <min_value>
  • <max_value>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <enable_unknown_events> (only in version 5 or later)
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <ff_threshold> (only in version 5.1 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_timeout> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=create_data_module (必須)
  • id=<エージェント名> (必須) エージェント名でなければいけません。
  • other=<連続パラメータ> (必須) モジュールの設定とデータを次の順番で指定します。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <説明>
  • <モジュールグループID>
  • <最小値>
  • <最大値>
  • <データ保存倍率>
  • <モジュールの間隔>
  • <警告の最小値>
  • <警告の最大値>
  • <警告の文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害の文字列>
  • <データの保存>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <連続抑制回数> (バージョン 5.1 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <連続抑制タイムアウト> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_data_module&id=pepito&other=prueba|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0&other_mode=url_encode_separator_|

set create_SNMP_module

Create a SNMP module.

SNMP モジュールを作成します。

Call sintax:

  • op=set (compulsory)
  • op2=create_snmp_module (compulsory)
  • id=<agent_name> (compulsory) should be an agent name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_version>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <snmp3_priv_method [AES|DES]>
  • <snmp3_priv_pass>
  • <snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3_auth_method [MD5|SHA]>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <enable_unknown_events> (only in version 5 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=create_snmp_module (必須)
  • id=<エージェント名> (必須) エージェント名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番で指定するモジュールの設定とデータです。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告の文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害の文字列>
  • <連続抑制回数>
  • <データの保存>
  • <対象IP>
  • <モジュールのポート>
  • <SNMPバージョン>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <SNMPv3 暗号化手法 [AES|DES]>
  • <SNMPv3 暗号化パスワード>
  • <SNMPv3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]>
  • <SNMPv3 認証手法 [MD5|SHA]>
  • <SNMPv3 認証ユーザ>
  • <SNMPv3 認証パスワード>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

Ejemplo 1 (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)

例 1 (SNMP v3, 暗号化手法: AES, 暗号化パスワード: example_priv_passw, セキュリティレベル: authNoPriv, 認証手法:MD5, 認証ユーザ: pepito_user, 認証パスワード: example_priv_passw)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito&other=prueba|0|15|1|10|15||16|18||15|0|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP%20module%20from%20API|AES|example_priv_passw|authNoPriv|MD5|pepito_user|example_auth_passw&other_mode=url_encode_separator_| 

Ejemplo 2 (snmp v: 1)

例 2 (SNMP v1)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito1&other=prueba2|0|15|1|10|15||16|18||15|0|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP module from API&other_mode=url_encode_separator_|

set update_network_module

Update the network module.

ネットワークモジュールを更新します。

Call syntax:

  • op=set (compulsory)
  • op2=update_network_module (compulsory)
  • id=<module_name> (compulsory) should be a module name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min>
  • <max>
  • <custom_id>
  • <description>
  • <disabled_types_event> (only in version 5 or later)
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=update_network_module (必須)
  • id=<モジュール名> (必須) モジュール名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <エージェントID>
  • <無効化>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <対象のIPO>
  • <モジュールのポート>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <イベントタイプの無効化> (バージョン 5 以降のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_network_module&id=example_module_name&other=44|0|2|10|15||16|18||7|0|127.0.0.1|0||0|300|30.00|0|0|0|latency%20ping%20modified%20by%20the%20Api&other_mode=url_encode_separator_|

set update_plugin_module

Update the plugin module.

プラグインモジュールを更新します。

Call sintax:

  • op=set (compulsory)
  • op2=update_plugin_module (compulsory)
  • id=<module_name> (compulsory) should be a module name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <id_plugin>
  • <plugin_user>
  • <plugin_pass>
  • <plugin_parameter>
  • <disabled_types_event> (only in version 5 or later)
  • <macros> (only in version 5 or later) Should be a base 64 encoded JSON document. The content should be an object formed by objects with the following properties:
    • "macro": Macro name. Should be _field1_, _field2_, ..., _fieldN_.
    • "desc": Descriptive name of the macro.
    • "help": Description of the macro.
    • "value":Value of the macro.
Example
{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=update_plugin_module (必須)
  • id=<モジュール名> (必須) モジュール名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <エージェントID>
  • <無効化>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <対象IP>
  • <モジュールのポート>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <プラグインID>
  • <プラグインユーザ>
  • <プラグインパスワード>
  • <プラグインパラメータ>
  • <イベントタイプの無効化> (バージョン 5 以降のみ)
  • <マクロ> (バージョン 5 以降のみ) base 64 でエンコードされた文字列でなければいけません。内容は、次のプロパティで表すオブジェクトを一つにまとめたものでなければいけません。
    • "macro": マクロ名。_field1_, _field2_, ..., _fieldN_ でなければいけません。
    • "desc": マクロを表す名前。
    • "help": マクロの説明。
    • "value":マクロの値。
{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめ base 64 でエンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_plugin_module&id=example_plugin_name&other=44|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|

set update_data_module

Template warning.png

With this call you can add database module data but you cannot modify configuration file of the agents associated to the module.


Template warning.png

これによりデータベースにモジュールデータを追加することはできますが、該当モジュールに関するエージェントの設定ファイルを変更することはできません。


Update the local module.

ローカルモジュールを更新します。

Call sintax:

  • op=set (compulsory)
  • op2=update_data_module (compulsory)
  • id=<module_name> (compulsory) should be a module name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <disabled_types_event> (only in version 5 or later)
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <ff_threshold> (only in version 5.1 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_timeout> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=update_data_module (必須)
  • id=<モジュール名> (必須) モジュール名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <エージェントID>
  • <無効化>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <対象のIP>
  • <モジュールのポート>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <イベントタイプの無効化> (バージョン 5 のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <連続抑制回数> (バージョン 5.1 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <連続抑制タイムアウト> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module&id=example_module_name&other=44|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0&other_mode=url_encode_separator_|

set update_data_module_policy

Update data module in policy and return id from new module.

ポリシーのデータモジュールを更新し、新たなモジュールの ID を返します。

Call sintax:

  • op=set (compulsory)
  • op2=update_data_module (compulsory)
  • id=<id_agent_module> (compulsory) Id of the target policy module.
  • other=<parámetros serializados> (compulsory) are the module configuration and data, serialized in the following order:
  • <id_policy_module>
  • <description>
  • <id_module_group>
  • <min>
  • <max>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <configuration_data>
  • <disabled_types_event> (only in version 5 or later)
  • <module_macros> (only in version 5 or later) hould be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".

書式:

  • op=set (必須)
  • op2=update_data_module (必須)
  • id=<id_agent_module> (必須) 対象のポリシーモジュールID。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。:
  • <ポリシーモジュールID>
  • <説明>
  • <モジュールグループID>
  • <最小>
  • <最大>
  • <事前処理>
  • <モジュールの間隔>
  • <警告の最小値>
  • <警告の最大値>
  • <障害の最小値>
  • <障害の最大値>
  • <障害の文字列>
  • <データの保存>
  • <設定データ>
  • <disabled_types_event> (バージョン 5以降)
  • <モジュールマクロ> (バージョン 5以降) 各マクロに対して 1つのプロパティを持つオブジェクトによって形成された、base64 でエンコードされた JSON ドキュメントである必要があります。JSON フォーマットは、"<マクロ名>": "<マクロの値>" となっている必要があります。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module_policy&id=1&other=10~data%20module%20updated%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_

set update_SNMP_module

Update a SNMP module.

SNMP モジュールを更新します。

Call sintax:

  • op=set (compulsory)
  • op2=update_snmp_module (compulsory)
  • id=<module_name> (compulsory) should be a module name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_version>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <snmp3_priv_method [AES|DES]>
  • <snmp3_priv_pass>
  • <snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3_auth_method [MD5|SHA]>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <disabled_types_event> (only in version 5 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=update_snmp_module (必須)
  • id=<モジュール名> (必須) モジュール名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <エージェントID>
  • <無効化>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <対象のIP>
  • <モジュールのポート>
  • <SNMPバージョン>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <snmp3 暗号化方式 [AES|DES]>
  • <snmp3 暗号化パスワード>
  • <snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3 認証方式 [MD5|SHA]>
  • <snmp3 認証ユーザ>
  • <snmp3 認証パスワード>
  • <イベントタイプの無効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)

Example (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)

例 (SNMPバージョン: 3、snmp3暗号化方式: AES、snmp3暗号化パスワード: example_priv_passw、snmp3セキュリティレベル: authNoPriv、snmp3認証方式:MD5、snmp3認証ユーザ: pepito_user、snmp3認証パスワード: example_priv_passw)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_snmp_module&id=example_snmp_module_name&other=44|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|pepito_user|example_auth_passw&other_mode=url_encode_separator_|

set apply_policy

Apply the policy, passed by id, in one or several agents.

ひとつもしくは複数のエージェントに、ID を指定してポリシーを適用します。

Call syntax:

  • op=set (required)
  • op2=apply_policy (required)
  • id=<id_policy> (required)
  • id2=<id_agent> (optional) Id or name of the agent as indicated in the other parameter. If it is empty, the policy will be applied to all the agents of this.
  • other=<serialized parameters>
  • <name_agent (Boolean)> Indicates if the agent will be sent by Id (0) or by name (1).
  • <server_id> (required if using Metaconsole) Id of the server in which the policy will be applied.
  • <return>

書式:

  • op=set (必須)
  • op2=apply_policy (必須)
  • id=<id_policy> (必須)
  • id2=<id_agent> (オプション) 他のパラメータに示されているエージェントのIDまたは名前。 空の場合、ポリシーはすべてのエージェントに適用されます。
  • other=<連続パラメータ>
  • <name_agent (Boolean)> エージェントを ID(0) で指定するか、名前(1) で指定するかを示します。
  • <server_id> (メタコンソールの場合必要です) ポリシーを適用するサーバの ID です。
  • <return>
http://192.168.70.102/pandora_console/include/api.php?op=set&op2=apply_policy&id=22&id2=3e&other=0|1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set apply_all_policies

Apply all policies that are in Pandora.

Pandora 内にある全ポリシーを適用します。

Call syntax:

  • op=set (compulsory)
  • op2=apply_all_policies (compulsory)

書式:

  • op=set (必須)
  • op2=apply_all_policies (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies

set add_network_module_policy

Add a network module in the policy pass as id in the parameter.

指定したパラメータで、ポリシーにネットワークモジュールを追加します。

Call syntax:

  • op=set (compulsory)
  • op2=add_network_module_policy (compulsory)
  • id=<id_policy> (compulsory) should be a policy Id.
  • other=<parámetros serializados> (compulsory) are the module configuration and data, serialized in the following order:
  • <id_module_type>
  • <description>
  • <id_module_group>
  • <min_value>
  • <max_value>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <ff_threshold>
  • <disabled>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <custom_id>
  • <enable_unknown_events> (only in version 5 or later)
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=add_network_module_policy (必須)
  • id=<ポリシーID> (必須) ポリシーIDでなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュールタイプID>
  • <説明>
  • <モジュールグループID>
  • <最小値>
  • <最大値>
  • <データ保存倍率>
  • <モジュールの間隔>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <データの保存>
  • <連続抑制回数>
  • <無効化>
  • <モジュールのポート>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <カスタムID>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_network_module_policy&id=1&other=network_module_policy_example_name|6|network%20module%20created%20by%20Api|2|0|0|50.00|180|10|20||21|35||1|15|0|66|||0&other_mode=url_encode_separator_|

set add_plugin_module_policy

Add a plugin module in the policy pass as id in the parameter.

指定したパラメータで、ポリシーにプラグインモジュールを追加します。

Call syntax:

  • op=set (compulsory)
  • op2=add_plugin_module_policy (compulsory)
  • id=<id_policy> (compulsory) should be a policy Id.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <id_plugin>
  • <plugin_user>
  • <plugin_pass>
  • <plugin_parameter>
  • <enable_unknown_events> (only in version 5 or later)
  • <macros> (only in version 5 or later) Should be a base 64 encoded JSON document. The content should be an object formed by objects with the following properties:
    • "macro": Macro name. Should be _field1_, _field2_, ..., _fieldN_.
    • "desc": Descriptive name of the macro.
    • "help": Description of the macro.
    • "value":Value of the macro.
Example
{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=add_plugin_module_policy (必須)
  • id=<ポリシーID> (必須) ポリシーIDでなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <モジュールのポート>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <プラグインID>
  • <プラグインユーザ>
  • <プラグインパスワード>
  • <プラグインパラメータ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <マクロ> (バージョン 5 以降のみ) base 64 でエンコードした JSON 文字列でなければいけません。内容は、次のプロパティのオブジェクトを一つのオブジェクトにまとめた形式でなければいけません。
    • "macro": マクロ名。_field1_, _field2_, ..., _fieldN_ でなければいけません。
    • "desc": マクロを表す名前。
    • "help": マクロの説明。
    • "value":マクロの値。
{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_plugin_module_policy&id=1&other=example%20plugin%20module%20name|0|1|2|0|0||0|0||15|0|66|||300|50.00|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|

set add_data_module_policy

Add a local module in the policy pass as id in the parameter.

指定したパラメータで、ポリシーにローカルモジュールを追加します。

Call syntax:

  • op=set (compulsory)
  • op2=add_data_module_policy (compulsory)
  • id=<id_policy> (compulsory) should be a policy Id.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <name_module>
  • <id_module_type>
  • <description>
  • <id_module_group>
  • <min_value>
  • <max_value>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <configuration_data> This is the definition block of the agent that will be inserted in the config file of the policy agent.
  • <enable_unknown_events> (only in version 5 or later)
  • <module_macros> (only in version 5 or later) Should be a base 64 encoded JSON document formed by an object with one property for each macro. The format of the JSON properties should be "<macro name>": "<macro value>".
  • <ff_threshold> (only in version 5.1 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_timeout> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=add_data_module_policy (必須)
  • id=<ポリシーID> (必須) ポリシーIDでなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュール名>
  • <モジュールタイプID>
  • <説明>
  • <モジュールグループID>
  • <最小値>
  • <最大値>
  • <データ保存倍率>
  • <モジュールの間隔>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <データの保存>
  • <設定データ> ポリシーエージェントの設定ファイルに挿入されるエージェントの定義ブロックです。
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <モジュールマクロ> (バージョン 5 以降のみ) それぞれのマクロのプロパティを一つのオブジェクトにまとめて base 64 エンコードした JSON 文字列でなければいけません。JSON プロパティの書式は、"<macro name>": "<macro value>" でなければいけません。
  • <連続抑制回数> (バージョン 5.1 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <連続抑制タイムアウト> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_data_module_policy&id=1&other=data_module_policy_example_name~2~data%20module%20created%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_~

set add_SNMP_module_policy

Add a SNMP module in the policy pass as id in the parameter.

指定したパラメータで、ポリシーに SNMP モジュールを追加します。

Call syntax:

  • op=set (compulsory)
  • op2=add_snmp_module_policy (compulsory)
  • id=<id_policy> (compulsory) should be a policy Id.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <module_port>
  • <snmp_version>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <snmp3_priv_method [AES|DES]>
  • <snmp3_priv_pass>
  • <snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3_auth_method [MD5|SHA]>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <enable_unknown_events> (only in version 5 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=add_snmp_module_policy (必須)
  • id=<ポリシーID> (必須) ポリシーIDでなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でモジュールの設定とデータを指定します。
  • <モジュール名>
  • <無効化>
  • <モジュールタイプID>
  • <モジュールグループID>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データの保存>
  • <モジュールのポート>
  • <SNMPバージョン>
  • <SNMPコミュニティ>
  • <SNMP OID>
  • <モジュールの間隔>
  • <データ保存倍率>
  • <最小値>
  • <最大値>
  • <カスタムID>
  • <説明>
  • <snmp3 暗号化方式 [AES|DES]>
  • <snmp3 暗号化パスワード>
  • <snmp3 セキュリティレベル [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3 認証方式 [MD5|SHA]>
  • <snmp3 認証ユーザ>
  • <snmp3 認証パスワード>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_snmp_module_policy&id=1&other=example%20SNMP%20module%20name|0|15|2|0|0||0|0||15|1|66|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|pepito_user|example_auth_passw&other_mode=url_encode_separator_|

set add_agent_policy_by_id

It adds an agent to a policy using the agent ID

エージェント ID を用いてポリシーにエージェントを追加します。

Call syntax:

  • op=set (required)
  • op2=add_agent_policy_by_id (mandatory)
  • id=<id_policy> (required). It must be a policy Id.
  • other=<serialized parameters> (required). These are agent configuration and data, serialized in the following order:
  • <id_agent>
  • <id_node> (required when using the Metaconsole). ID of the node the agent you wish to add to the policy belongs to.

書式:

  • op=set (必須)
  • op2=add_agent_policy_by_id (必須)
  • id=<id_policy> (必須) ポリシー ID である必要があります。
  • other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります:
  • <id_agent>
  • <id_node> (メタコンソールの場合は必須) ポリシーに追加するエージェントが属するノードのID。
  • Node:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • ノード:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • Metaconsole:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • メタコンソール:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set add_agent_policy_by_name

It adds an agent to a policy using the agent name.

エージェント名を用いてポリシーへエージェントを追加します。

Call syntax:

  • op=set (required)
  • op2=add_agent_policy_by_name (required)
  • id=<id_policy> (required). It must be a policy Id.
  • other=<serialized parameters> (required). These are agent configuration and data, serialized in the following order:
  • <agent_name>

書式:

  • op=set (必須)
  • op2=add_agent_policy_by_name (必須)
  • id=<id_policy> (必須) ポリシー ID である必要があります。
  • other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります:
  • <agent_name>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set remove_agent_from_policy_by_id

It deletes an agent from a policy using the agent ID.

エージェント ID を用いて、ポリシーからエージェントを削除します。

Call syntax:

  • op=set (required)
  • op2=remove_agent_from_policy_by_id (required)
  • id=<id_política> (required). It must be a policy Id.
  • other=<serialized parameters> (required). These are the agent’s configuration and data, serialized in the following order:
  • <id_agent>
  • <id_node> (required when using the Metaconsole). ID of the node the agent you wish to remove from the policy belongs to.

書式:

  • op=set (必須)
  • op2=remove_agent_from_policy_by_id (必須)
  • id=<id_política> (必須) ポリシー ID である必要があります。
  • other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります:
  • <id_agent>
  • <id_node> (required when using the Metaconsole). ID of the node the agent you wish to remove from the policy belongs to.
必須
  • Node:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=2&other=2&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • ノード:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=2&other=2&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • Metaconsole:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=4&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • メタコンソール:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=4&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set remove_agent_from_policy_by_name

Delete an agent from a policy using the agent name.

エージェント名を用いて、ポリシーからエージェントを削除します。

Call syntax:

  • op=set (required)
  • op2=remove_agent_from_policy_by_name (required)
  • id=<id_policy> (required). It must be a policy Id.
  • other=<serialized parameters> (required). These are the agent’s configuration and data, serialized in the following order:
  • <agent_name>

書式:

  • op=set (必須)
  • op2=remove_agent_from_policy_by_name (必須)
  • id=<id_policy> (必須) ポリシー ID である必要があります。
  • other=<serialized parameters> (必須) エージェント設定とデータで、次の順番で指定する必要があります:
  • <agent_name>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set new_network_component

Create a new network component.

新たなネットワークコンポーネントを作成します。

Call syntax:

  • op=set (compulsory)
  • op2=new_network_component (compulsory)
  • id=<network_component_name> (compulsory) should be the network component name.
  • other=<serialized parameters> (compulsory) are the agent configuration and data of the network component, serialized in the following order:
  • <network_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <snmp_community>
  • <id_module_group>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <network_component_group>
  • <enable_unknown_events> (only in version 5 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=new_network_component (必須)
  • id=<ネットワークコンポーネント名> (必須) ネットワークコンポーネント名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でエージェントの設定とネットワークコンポーネントのデータを指定します。
  • <ネットワークコンポーネントタイプ>
  • <説明>
  • <モジュールの間隔>
  • <最大値>
  • <最小値>
  • <SNMPコミュニティ>
  • <モジュールグループID>
  • <最大タイムアウト>
  • <データの保存>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データ保存倍率>
  • <ネットワークコンポーネントグループ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_network_component&id=example_network_component_name&other=7|network%20component%20created%20by%20Api|300|30|10|public|3||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|

set new_plugin_component

Create a new plugin component.

新たなプラグインコンポーネントを作成します。

Call syntax:

  • op=set (compulsory)
  • op2=new_plugin_component (compulsory)
  • id=<plugin_component_name> (compulsory) should be the plugin component name.
  • other=<serialized parameters> (compulsory) are the agent configuration and data of the plugin component, serialized in the following order:
  • <plugin_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <module_port>
  • <id_module_group>
  • <id_plugin>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <plugin_component_group>
  • <enable_unknown_events> (only in version 5 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=new_plugin_component (必須)
  • id=<プラグインコンポーネント名> (必須) プラグインコンポーネント名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でエージェントの設定とプラグインコンポーネントのデータを指定します。
  • <プラグインコンポーネントタイプ>
  • <説明>
  • <モジュールの間隔>
  • <最大値>
  • <最小値>
  • <モジュールのポート>
  • <モジュールグループID>
  • <プラグインID>
  • <最大タイムアウト>
  • <データの保存>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データ保存倍率>
  • <プラグインコンポーネントグループ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_plugin_component&id=example_plugin_component_name&other=2|plugin%20component%20created%20by%20Api|300|30|10|66|3|2|example_user|example_pass|-p%20max||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|

set new_snmp_component

Create a new SNMP component.

新たな SNMP コンポーネントを作成します。

Sintaxis de la llamada:

  • op=set (compulsory)
  • op2=new_snmp_component (compulsory)
  • id=<snmp_component_name> (compulsory) should be the snmp component name.
  • other=<serialized parameters> (compulsory) are the configuration and data of the snmp component, serialized in the following order:
  • <snmp_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <id_module_group>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <snmp_version>
  • <snmp_oid>
  • <snmp_community>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <module_port>
  • <snmp3_privacy_method>
  • <snmp3_privacy_pass>
  • <snmp3_auth_method>
  • <snmp3_security_level>
  • <snmp_component_group>
  • <enable_unknown_events> (only in version 5 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=new_snmp_component (必須)
  • id=<SNMPコンポーネント名> (必須) SNMPコンポーネント名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番で SNMP コンポーネントの設定とデータを指定します。
  • <SNMPコンポーネントタイプ>
  • <説明>
  • <モジュールの間隔>
  • <最大値>
  • <最小値>
  • <モジュールグループID>
  • <最大タイムアウト>
  • <データの保存>
  • <警告の最小値>
  • <警告の最大値>
  • <警告文字列>
  • <障害の最小値>
  • <障害の最大値>
  • <障害文字列>
  • <連続抑制回数>
  • <データ保存倍率>
  • <SNMPバージョン>
  • <SNMP OID>
  • <SNMPコミュニティ>
  • <snmp3 認証ユーザ>
  • <snmp3 認証パスワード>
  • <モジュールのポート>
  • <snmp3 暗号化手法>
  • <snmp3 暗号化パスワード>
  • <snmp3 認証手法>
  • <snmp3 セキュリティレベル>
  • <SNMPコンポーネントグループ>
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_snmp_component&id=example_snmp_component_name&other=16|SNMP%20component%20created%20by%20Api|300|30|10|3||1|10|20|str|21|30|str1|15|50.00|3|.1.3.6.1.2.1.2.2.1.8.2|public|example_auth_user|example_auth_pass|66|AES|example_priv_pass|MD5|authNoPriv|12&other_mode=url_encode_separator_|

set new_local_component

Create a new local component.

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

Call syntax:

  • op=set (compulsory)
  • op2=new_local_component (compulsory)
  • id=<local_component_name> (compulsory) should be a local component name.
  • other=<serialized parameters> (compulsory) are the configuration and data of the local component, serialized in the following order:
  • <description>
  • <id_os>
  • <local_component_group>
  • <configuration_data> This is the configuration block of the module.
  • <enable_unknown_events> (only in version 5 or later)
  • <ff_threshold> (only in version 5.1 or later)
  • <each_ff> (only in version 5.1 or later)
  • <ff_threshold_normal> (only in version 5.1 or later)
  • <ff_threshold_warning> (only in version 5.1 or later)
  • <ff_threshold_critical> (only in version 5.1 or later)
  • <ff_timeout> (only in version 5.1 or later)
  • <ff_type> (only in version 733 or later)

書式:

  • op=set (必須)
  • op2=new_local_component (必須)
  • id=<ローカルコンポーネント名> (必須) ローカルコンポーネント名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でローカルコンポーネントの設定とデータを指定します。
  • <説明>
  • <OSのID>
  • <ローカルコンポーネントグループ>
  • <設定データ> モジュールの設定ブロックです。
  • <不明イベントの有効化> (バージョン 5 以降のみ)
  • <連続抑制回数> (バージョン 5.1 以降のみ)
  • <個別状態変化の利用> (バージョン 5.1 以降のみ)
  • <正常移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <警告移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <障害移行時連続抑制回数> (バージョン 5.1 以降のみ)
  • <連続抑制タイムアウト> (バージョン 5.1 以降のみ)
  • <ff_type> (バージョン 733 以降のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_local_component&id=example_local_component_name&other=local%20component%20created%20by%20Api~5~12~module_begin%0dmodule_name%20example_local_component_name%0dmodule_type%20generic_data%0dmodule_exec%20ps%20|%20grep%20pid%20|%20wc%20-l%0dmodule_interval%202%0dmodule_end&other_mode=url_encode_separator_~

set create_alert_template

Create a template of alert.

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

Call sintax:

  • op=set (compulsory)
  • op2=create_alert_template (compulsory)
  • id=<template_name> (compulsory) will be the template name.
  • other=<serialized parameters> (compulsory) are the template configuration and data, serialized in the following order:
  • <type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <description>
  • <id_alert_action>
  • <field1>
  • <field2>
  • <field3>
  • <value>
  • <matches_value>
  • <max_value>
  • <min_value>
  • <time_threshold>
  • <max_alerts>
  • <min_alerts>
  • <time_from>
  • <time_to>
  • <monday>
  • <tuesday>
  • <wednesday>
  • <thursday>
  • <friday>
  • <saturday>
  • <sunday>
  • <recovery_notify>
  • <field2_recovery>
  • <field3_recovery>
  • <priority>
  • <id_group>

書式:

  • op=set (必須)
  • op2=create_alert_template (必須)
  • id=<テンプレート名> (必須) テンプレート名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でテンプレートの設定とデータを指定します。
  • <タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <説明>
  • <アラートアクションID>
  • <フィールド1>
  • <フィールド2>
  • <フィールド3>
  • <値>
  • <マッチする値>
  • <最大値>
  • <最小値>
  • <再通知間隔>
  • <最大アラート数>
  • <最小アラート数>
  • <開始時間>
  • <終了時間>
  • <月曜>
  • <火曜>
  • <水曜>
  • <木曜>
  • <金曜>
  • <土曜>
  • <日曜>
  • <復旧アラート>
  • <復旧時のフィールド2>
  • <復旧時のフィールド3>
  • <優先度>
  • <グループID>

Example 1 (condition: regexp =~ /pp/, action: Mail to XXX, max_alert: 10, min_alert: 0, priority: WARNING, group: databases):

例1 (状態: regexp =~ /pp/、アクション: Mail to XXX、最大アラート数: 10、最小アラート数: 0、優先度: 警告、グループ: database):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=pepito&other=regex|template%20based%20in%20regexp|1||||pp|1||||10|0|||||||||||||3&other_mode=url_encode_separator_|

Example 2 (condition: value is not between 5 and 10, max_value: 10.00, min_value: 5.00, time_from: 00:00:00, time_to: 15:00:00, priority: CRITICAL, group: Servers):

例2 (状態: 値が5と10の間以外、最大値: 10.00、最小値: 5.00、開始時間: 00:00:00、終了時間: 15:00:00、優先度: 障害、グループ: Servers):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=template_min_max&other=max_min|template%20based%20in%20range|NULL||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|

set update_alert_template

Update the template alert.

アラートテンプレートを更新します。

Call sintax:

  • op=set (compulsory)
  • op2=update_alert_template (compulsory)
  • id=<id_template> (compulsory) should be a template id.
  • other=<serialized parameters> (compulsory) are the template configuration and data, serialized in the following order:
  • <template_name>
  • <type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <description>
  • <id_alert_action>
  • <field1>
  • <field2>
  • <field3>
  • <value>
  • <matches_value>
  • <max_value>
  • <min_value>
  • <time_threshold>
  • <max_alerts>
  • <min_alerts>
  • <time_from>
  • <time_to>
  • <monday>
  • <tuesday>
  • <wednesday>
  • <thursday>
  • <friday>
  • <saturday>
  • <sunday>
  • <recovery_notify>
  • <field2_recovery>
  • <field3_recovery>
  • <priority>
  • <id_group>

書式:

  • op=set (必須)
  • op2=update_alert_template (必須)
  • id=<テンプレートID> (必須) テンプレートIDでなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でテンプレートの設定とデータを指定します。
  • <テンプレート名>
  • <タイプ [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <説明>
  • <アラートアクションID>
  • <フィールド1>
  • <フィールド2>
  • <フィールド3>
  • <値>
  • <マッチする値>
  • <最大値>
  • <最小値>
  • <再実行間隔>
  • <最大アラート数>
  • <最小アラート数>
  • <開始時間>
  • <終了時間>
  • <月曜>
  • <火曜>
  • <水曜>
  • <木曜>
  • <金曜>
  • <土曜>
  • <日曜>
  • <復旧アラート>
  • <復旧時のフィールド2>
  • <復旧時のフィールド3>
  • <優先度>
  • <グループID>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=38&other=example_template_with_changed_name|onchange|changing%20from%20min_max%20to%20onchange||||||1||||5|1|||1|1|0|1|1|0|0|1|field%20recovery%20example%201|field%20recovery%20example%202|1|8&other_mode=url_encode_separator_|

set delete_alert_template

Delete a alert template and delete the alerts that are using this template.

アラートテンプレートと、テンプレートで使われているアラートを削除します。

Call sintax:

  • op=set (compulsory)
  • op2=delete_alert_template (compulsory)
  • id=<id_template> (compulsory) should be a template id.
  • other=<serialized parameters> (compulsory) are the template configuration and data, serialized in the following order:

書式:

  • op=set (必須)
  • op2=delete_alert_template (必須)
  • id=<テンプレートID> (必須) テンプレートIDでなければいけません。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38

set delete_module_template

Delete a module template.

モジュールテンプレートを削除します。

Call sintax:

  • op=set (compulsory)
  • op2=delete_module_template (compulsory)
  • id=<id_template> (compulsory) should be a template id.
  • other=<serialized parameters> (compulsory) are the template configuration and data, serialized in the following order:

書式:

  • op=set (必須)
  • op2=delete_module_template (必須)
  • id=<テンプレートID> (必須) テンプレートIDでなければいけません。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38

set delete_module_template_by_names

Delete a module template.

モジュールテンプレートを削除します。

Call sintax:

  • op=set (compulsory)
  • op2=delete_module_template_by_names (compulsory)
  • id=<agent name> (compulsory)
  • id2=<alert template name> (compulsory)
  • other=<serialized parameter> (compulsory), are the following in this order:
  • <module name> (compulsory)

書式:

  • op=set (必須)
  • op2=delete_module_template_by_names (必須)
  • id=<エージェント名> (必須)
  • id2=<アラートテンプレート名> (必須)
  • other=<連続パラメータ> (必須) 次の順番でデータを指定します。
  • <モジュール名> (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template_by_names&id=sample-agent&id2=test&other=memfree&apipass=1234&user=admin&pass=pandora

set stop_dowtime

Stop a downtime.

計画停止を停止します。

Call sintax:

  • op=set (compulsory)
  • op2=stop_downtime (compulsory)
  • id=<id_downtime> (compulsory) should be a id downtime.
  • other=<serialized parameters> (compulsory) are the downtime configuration and data, serialized in the following order:

書式:

  • op=set (必須)
  • op2=stop_downtime (必須)
  • id=<計画停止ID> (必須) 計画停止IDでなければいけません。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1

set new_user

Create a new user into Pandora.

Pandora に新たなユーザを作成します。

Call Syntax:

  • op=set (compulsory)
  • op2=new_user (compulsory)
  • id=<nombre_usuario> (compulsory) should be an user name.
  • other=<parámetros serializados> (compulsory) are the module configuration and data, serialized in the following order:
  • <name_module>
  • <fullname>
  • <firstname>
  • <lastname>
  • <middlename>
  • <email>
  • <phone>
  • <languages>
  • <comments>

書式:

  • op=set (必須)
  • op2=new_user (必須)
  • id=<ユーザ名> (必須) ユーザ名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番で設定とデータを指定します。
  • <ユーザ名>
  • <フルネーム>
  • <名前>
  • <名字>
  • <ミドルネーム>
  • <電子メールアドレス>
  • <電話番号>
  • <言語>
  • <コメント>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_user&id=md&other=miguel|de%20dios|matias|kkk|pandora|md@md.com|666|es|descripcion%20y%20esas%20cosas&other_mode=url_encode_separator_|

Set update_user

Update a user selected by the id into the id parameter.

指定した ID のユーザを指定したパラメータで更新します。

Call Syntax:

  • op=set (compulsory)
  • op2=update_user (compulsory)
  • id=<user_name> (compulsory) should be an user name.
  • other=<serialized parameters> (compulsory) are the module configuration and data, serialized in the following order:
  • <fullname>
  • <firstname>
  • <lastname>
  • <middlename>
  • <password>
  • <email>
  • <phone>
  • <languages>
  • <comments>
  • <is_admin>
  • <block_size>
  • <flash_chart>

書式:

  • op=set (必須)
  • op2=update_user (必須)
  • id=<ユーザ名> (必須) ユーザ名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番で設定とデータを指定します。
  • <フルネーム>
  • <名前>
  • <名字>
  • <ミドルネーム>
  • <パスワード>
  • <電子メールアドレス>
  • <電話番号>
  • <言語>
  • <コメント>
  • <管理者>
  • <一画面の表示数>
  • <フラッシュグラフ>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_user&id=example_user_name&other=example_fullname||example_lastname||example_new_passwd|example_email||example_language|example%20comment|1|30|&other_mode=url_encode_separator_|

set delete_user

Delete a selected user.

選択したユーザを削除します。

Call syntax:

  • op=set (compulsory)
  • op2=delete_user (compulsory)
  • id=<nombre_usuario> (compulsory) should be an user name.

書式:

  • op=set (必須)
  • op2=delete_user (必須)
  • id=<ユーザ名> (必須) ユーザ名でなければいけません。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md

Set delete_user_permissions

この機能はメタコンソールのみです。


It deletes user permissions.

ユーザのパーミッションを削除します。

Call syntax:

  • Op = set(requiered)
  • Op2 =delete_user_permission(requiered)
  • Return_type = csv|json(requiered)
  • Other = id profile(requiered)

書式:

  • Op = set(必須)
  • Op2 =delete_user_permission(必須)
  • Return_type = csv|json(必須)
  • Other = id profile(必須)

It deletes user permissions. It can return Json or CSV, this return is remarked through the URL.

ユーザのパーミッションを削除します。 Json または CSV にて返すことができます。この戻り値は URL を介して指定します。

http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_permission&return_type=json&other=2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Set add_permission_user_group

この機能はメタコンソールのみです。


It adds permissions to a user group.

ユーザグループへパーミッションを追加します。

Call syntax:

  • Op = set(requiered)
  • Op2 =add_permission_user_to_group(requiered)
  • Return_type = csv|json(requiered)
  • Other = user id(requiered)|group_id(requiered)|profile id(requiered)|No hierarchy(Optional)| profile id(Optional)

書式:

  • Op = set(必須)
  • Op2 =add_permission_user_to_group(必須)
  • Return_type = csv|json(必須)
  • Other = user id(必須)|group_id(必須)|profile id(必須)|No hierarchy(オプション)| profile id(オプション)

It can return Json or CSV, this return is remarked through the URL. Be careful, no_hierarchy may be empty, if that is the case it takes value 0. Be careful, profile id in the profile_user table may be used if an existing one is going to be modified.

Json または CSV にて返すことができます。この戻り値は URL を介して指定します。 no_hierarchy が空の場合、値が 0 になることに注意してください。 既存のプロファイルを変更する場合は、profile_user テーブルのプロファイルIDが使用されることに注意してください。

http://localhost/pandora_console/include/api.php?op=set&op2=add_permission_user_to_group&return_type=json&other=admin|0|1|1|20&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set enable_disable_user

Enable a disabled user.

ユーザを無効化・有効化します。

Call syntax:

  • op=set (compulsory)
  • op2=enable_disable_user (compulsory)
  • id=<user_name> (compulsory) should be an user name.

書式:

  • op=set (必須)
  • op2=enable_disable_user (必須)
  • id=<ユーザ名> (必須) ユーザ名でなければいけません。

Example 1 (Disable user 'example_name')

例1 (ユーザ 'example_name' を無効化)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=0&other_mode=url_encode_separator_|

Example 2 (Enable user 'example_name')

例2 (ユーザ 'example_name' を有効化)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=1&other_mode=url_encode_separator_|

set meta_synch_user

この機能はメタコンソールのみです。


Syncronizes metaconsole users to the node

ノードへメタコンソールユーザを同期します。

Call syntax:

  • op=set (required)
  • op2=meta_synch_user (required)
  • other=<serialized parameters> (opcional):
  • <user_name_1,user_name_2,user_name_3..> (Nombres de los usuarios separados por comas y sin espacios al inicio o al final, required)
  • <server_name> (required)
  • <profile_mode(1-0)> (opcional)
  • <group_name> (opcional)
  • <profile_1,profile_2,profile_3> (Perfiles separados por comas y sin espacios al principio y al final, opcional)
  • <create_groups(1-0)> (opcional)

書式:

  • op=set (必須)
  • op2=meta_synch_user (必須)
  • other=<連続パラメータ> (オプション):
  • <user_name_1,user_name_2,user_name_3..> (先頭および末尾にスペースを入れずにカンマで区切ったユーザ名, 必須)
  • <server_name> (必須)
  • <profile_mode(1-0)> (オプション)
  • <group_name> (オプション)
  • <profile_1,profile_2,profile_3> (最初と最後にスペースを入れずにカンマで区切ったプロファイル, オプション)
  • <create_groups(1-0)> (オプション)
http://localhost/pandora_console/include/api.php?op=set&op2=meta_synch_user&apipass=1234&user=admin&pass=pandora&other=name1,name2|nodo1|0|||&other_mode=url_encode_separator_|

set create_group

Create a group.

グループを作成します。

Call syntax:

  • op=set (compulsory)
  • op2=create_group (compulsory)
  • id=<group_name> (compulsory) should be a group name.
  • other=<serialized_parameters> (obligatorio), son los siguientes en este orden:
  • <icon name>
  • <parent group id> (opcional)
  • <description> (opcional)
  • <propagate acl> (opcional)
  • <desactivar las alertas> (opcional)
  • <custom id> (opcional)
  • <Informacion de contacto> (opcional)
  • <otra informacion> (opcional)

書式:

  • op=set (必須)
  • op2=create_group (必須)
  • id=<グループ名> (必須) グループ名を指定します。
  • other=<連続パラメータ> (必須) 次の順番で指定します。
  • <アイコン名>
  • <親グループID> (オプション)
  • <説明> (オプション)
  • <ACLの伝播> (オプション)
  • <アラートの無効化> (オプション)
  • <カスタムID> (オプション)
  • <連絡先> (オプション)
  • <その他> (オプション)

Example 1 (with parent group: Servers)

例1 (親グループ: Servers)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name&other=applications|1&other_mode=url_encode_separator_|

Example 2 (without parent group)

例2 (親グループなし)

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name2&other=computer|&other_mode=url_encode_separator_|

set update_group

Update a group.

グループの設定を更新します。

Call syntax:

  • op=set (compulsory)
  • op2=update_group (compulsory)
  • id=<group_id> (compulsory) should be a group id
  • other=<serialized_parameters> (compulsory). Are the following in this order:
  • <group name>
  • <icon name>
  • <parent group id>
  • <description>
  • <propagate acl>
  • <disable alerts>
  • <custom id>
  • <contact info>
  • <other info>

書式:

  • op=set (必須)
  • op2=update_group (必須)
  • id=<グループID> (必須) グループIDを指定します。
  • other=<連続パラメータ> (必須) 次の順番で指定します。
  • <グループ名>
  • <アイコン名>
  • <親グループID>
  • <説明>
  • <ACLの伝播>
  • <アラートの無効化>
  • <カスタムID>
  • <連絡先>
  • <その他>
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_group&id=example_group_id&other=New%20Name|application|2|new%20description|1|0|custom%20id||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set delete_group

Delete a group.

グループを削除します。

Call syntax:

  • op=set (compulsory)
  • op2=delete_group (compulsory)
  • id=<group_id> (compulsory) should be a group id

書式:

  • op=set (必須)
  • op2=update_group (必須)
  • id=<グループID> (必須) グループIDを指定します。
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora

set add_user_profile

Add a profile into user.

ユーザにプロファイルを追加します。

Call syntax:

  • op=set (compulsory)
  • op2=add_user_profile (compulsory)
  • id=<nombre_usuario> (compulsory) should be an user name.
  • other=<parámetros serializados> (compulsory)are the group configuration and data and the profile, serialized in the following order:
  • <grupo>
  • <profile>

書式:

  • op=set (必須)
  • op2=add_user_profile (必須)
  • id=<ユーザ名> (必須) ユーザ名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でグループの設定、プロファイルを指定します。
  • <グループ>
  • <プロファイル>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|

set delete_user_profile

Deattach a profile of user.

ユーザのプロファイルを削します。

Call syntax:

  • op=set (compulsory)
  • op2=delete_user_profile (compulsory)
  • id=<nombre_usuario> (compulsory) should be an user name.
  • other=<parámetros serializados> (compulsory)are the group configuration, data and profile, serialized in the following order:
  • <grupo>
  • <profile>

書式:

  • op=set (必須)
  • op2=delete_user_profile (必須)
  • id=<ユーザ名> (必須) ユーザ名でなければいけません。
  • other=<連続パラメータ> (必須) 次の順番でグループおよびプロファイルを指定します。
  • <グループ>
  • <プロファイル>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|

set new_incident

Create a new incident.

新たなインシデントを作成します。

Call syntax:

  • op=set (compulsory)
  • op2=new_incident (compulsory)
  • other=<parámetros serializados> (compulsory) are the incident configuration and data, serialized in the following order:
  • <title>
  • <description>
  • <origin>
  • <priority>
  • <status>
  • <group>

書式:

  • op=set (必須)
  • op2=new_incident (必須)
  • other=<連続パラメータ> (必須) 次の順番でインシデントの設定とデータを指定します。
  • <タイトル>
  • <説明>
  • <作成者\>
  • <優先度>
  • <状態>
  • <グループ>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_incident&other=titulo|descripcion%20texto|Logfiles|2|10|12&other_mode=url_encode_separator_|

set new_note_incident

Add a note into a incident.

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

Call syntax:

  • op=set (compulsory)
  • op2=new_note_incident (compulsory)
  • id=<id_incidente> (compulsory )the incident id.
  • id2=<nombre_usuario> (compulsory) the user name.
  • other=<nota> (compulsory) is the note codified in url encode.

書式:

  • op=set (必須)
  • op2=new_note_incident (必須)
  • id=<インシデントID> (必須) インシデントのIDです。
  • id2=<ユーザ名> (必須) ユーザ名です。
  • other=<コメント> (必須) URLエンコードされたコメントです。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_note_incident&id=5&id2=miguel&other=una%20nota%20para%20la%20incidencia

set validate_all_alerts

Validate all alerts.

全アラートを承諾します。

Call syntax:

  • op=set (compulsory)
  • op2=validate_all_alerts (compulsory)

書式:

  • op=set (必須)
  • op2=validate_all_alerts (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts

set validate_all_policy_alerts

Validate the alerts created from a policy.

ポリシーから作成されたアラートを承諾します。

Call syntax:

  • op=set (compulsory)
  • op2=validate_all_policy_alerts (compulsory)

書式:

  • op=set (必須)
  • op2=validate_all_policy_alerts (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts

set event_validate_filter

Validate all events that pass the filter pass as parameters.

指定したフィルタにマッチするすべてのイベントを承諾します。

Call syntax:

  • op=set (compulsory)
  • op2=event_validate_filter (compulsory)
  • other_mode=url_encode_separator_|(optional)
  • other=<serialized_parameters> (optional). Are the following in this order:
  • <separator>
  • <criticity> De 0 a 4
  • <agent name>
  • <module name>
  • <alert template name>
  • <user>
  • < numeric interval minimum level> en unix timestamp
  • < numeric interval maximum level> en unix timestamp

書式:

  • op=set (必須)
  • op2=event_validate_filter (必須)
  • other_mode=url_encode_separator_|(オプション)
  • other=<連続パラメータ> (オプション) 次の順番で指定します。
  • <セパレータ>
  • <重要度> 0 から 4
  • <エージェント名>
  • <モジュール名>
  • <アラートテンプレート名>
  • <ユーザ>
  • < 最小レベルの数値間隔> UNIXタイムスタンプ
  • < 最大レベルの数値間隔> UNIXタイムスタンプ
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2

set event_validate_filter_pro

It is the similar to previous call.

前述の API と似たものです。

Call syntax:

  • op=set (compulsory))
  • op2=event_validate_filter_pro (compulsory)
  • other_mode=url_encode_separator_| (optional)
  • other=<serialized parameters> (optional), are the following in this order:
  • <separator>
  • <criticity> From 0 to 4
  • <id agent>
  • <id module>
  • <id agent module alert>
  • <user>
  • <numeric interval minimum level> in unix timestamp
  • <numeric interval maximum level> in unix timestamp

書式:

  • op=set (必須)
  • op2=event_validate_filter_pro (必須)
  • other_mode=url_encode_separator_| (オプション)
  • other=<連続パラメータ> (オプション) 次の順番で指定します。
  • <セパレータ>
  • <重要度> 0 から 4
  • <エージェントID>
  • <モジュールID>
  • <エージェントモジュールアラートID>
  • <ユーザ>
  • <最小レベルの数値間隔> UNIXタイムスタンプ
  • <最大レベルの数値間隔> UNIXタイムスタンプ
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2

set new_alert_template

Apply a new alert from a template and module pass as id agent and name of module.

テンプレートおよび、エージェントIDおよびモジュール名からモジュールを指定して、新たなアラートを適用します。

Call syntax:

  • op=set (ob)
  • op2=new_alert_template (compulsory)
  • id=<agent name> (compulsory)
  • id2=<alert template name> (compulsory)
  • other_mode=url_encode_separator_| (optional)
  • other=<serialized parameter> (optional), are the following in this order:
  • <module name> (compulsory)

書式:

  • op=set (必須)
  • op2=new_alert_template (必須)
  • id=<エージェント名> (必須)
  • id2=<アラートテンプレート名> (必須)
  • other_mode=url_encode_separator_| (オプション)
  • other=<連続パラメータ> (オプション) 次の順番で指定します。
  • <モジュール名> (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_alert_template&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree

set alert_actions

Add actions into a alert.

アラートにアクションを追加します。

Call syntax:

  • op=set (compulsory)
  • op2=alert_actions (compulsory)
  • id=<agent name> (compulsory)
  • id2=<alert template name> (compulsory)
  • other_mode=url_encode_separator_| (optional)
  • other=<serialized parameters> (optional), are the following in this order:
  • <module name> (compulsory)
  • <action name> (compulsory)
  • <fires min > (optional)
  • <fires max > (optional)

書式:

  • op=set (必須)
  • op2=alert_actions (必須)
  • id=<エージェント名> (必須)
  • id2=<アラートテンプレート名> (必須)
  • other_mode=url_encode_separator_| (オプション)
  • other=<連続パラメータ> (オプション) 次の順番で指定します。
  • <モジュール名> (必須)
  • <アクション名> (必須)
  • <開始アラート数> (オプション)
  • <終了アラート数> (オプション)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test|1|3

set alert_commands

Add commands to an alert.

アラートにコマンドを追加します。

Call syntax:

  • op=set (required)
  • op2=alert_commands (required)
  • id=<name of the command> (required)
  • other_mode=url_encode_separator_| (optional)
  • other=<serialized parameters> (required), which are the following in this order:
  • <command> (required)
  • <id_group> (required)
  • <description > (required)
  • <internal > (optional)
  • <field_description_1><field_value_1><field_description_2><field_value_2>...<field_description_n><field_value_n>

書式:

  • op=set (必須)
  • op2=alert_commands (必須)
  • id=<コマンド名> (必須)
  • other_mode=url_encode_separator_| (オプション)
  • other=<連続パラメータ> (必須), 次の順番:
  • <command> (必須)
  • <id_group> (必須)
  • <description > (必須)
  • <internal > (オプション)
  • <field_description_1><field_value_1><field_description_2><field_value_2>...<field_description_n><field_value_n>
http://localhost/pandora_console/include/api.php?op=set&op2=alert_commands&id=PRUEBA1&other=command|0|Desc|1|des1|val1|des2|val2|des3|val3||val4|des5&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set new_module

Create a new module.

新たなモジュールを作成します。

Call Syntax:

  • op=set (compulsory)
  • op2=new_module (compulsory)
  • id=<agent_name> (compulsory)
  • id2=<new module name> (compulsory)
  • other_mode=url_encode_separator_| (optional)
  • other=<serialized parameters> (optional), are the following in this order:
  • <network module kind > (compulsory)
  • <action name> (compulsory)
  • <ip o url > (compulsory)
  • <port > (optional)
  • <description > (optional)
  • <min > (optional)
  • <max > (optional)
  • <post process > (optional)
  • <module interval > (optional)
  • <min warning > (optional)
  • <max warning > (optional)
  • <min critical > (optional)
  • <max critical > (optional)
  • <history data > (optional)
  • <enable_unknown_events> (only in version 5)

書式:

  • op=set (必須)
  • op2=new_module (必須)
  • id=<エージェント名> (必須)
  • id2=<新たなモジュール名> (必須)
  • other_mode=url_encode_separator_| (オプション)
  • other=<連続パラメータ> (オプション) 次の順番で指定します。
  • <ネットワークモジュールの種類> (必須)
  • <アクション名> (必須)
  • <IP または URL> (必須)
  • <ポート> (オプション)
  • <説明> (オプション)
  • <最小値> (オプション)
  • <最大値> (オプション)
  • <データ保存倍率> (オプション)
  • <モジュールの間隔> (オプション)
  • <警告の最小値> (オプション)
  • <警告の最大値> (オプション)
  • <障害の最小値> (オプション)
  • <障害の最大値> (オプション)
  • <データの保存> (オプション)
  • <不明イベントの有効化> (バージョン 5 のみ)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_module&id=miguel-portatil&id2=juanito&other_mode=url_encode_separator_|&other=remote_tcp_string|localhost|33|descripcion%20larga

set delete_module

Delete a module.

モジュールを削除します。

Call syntax:

  • op=set (compulsory)
  • op2=delete_module (compulsory)
  • id=<agent name> (compulsory)
  • id2=<module name> (compulsory)
  • other=simulate (optional)

書式:

  • op=set (必須)
  • op2=delete_module (必須)
  • id=<エージェント名> (必須)
  • id2=<モジュール名> (必須)
  • other=simulate (オプション)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito&other=simulate
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito

set enable_alert

Enable a alert of a agent.

エージェントのアラートを有効化します。

Call syntax

  • op=set (mandatory)
  • op2=enable_alert
  • id=<Agent name> (mandatory)
  • id2=<Module name> (mandatory)
  • other: Alert template name (p.e: Warning event) (mandatory)

書式:

  • op=set (必須)
  • op2=enable_alert
  • id=<エージェント名> (必須)
  • id2=<モジュール名> (必須)
  • other: アラートテンプレート名 (例: Warning イベント) (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=garfio&id2=Status&other=Warning%20condition

set enable_alert_alias

Enable alert of a agent by alias.

エイリアスでエージェントのアラートを有効化します。

Call syntax:


  • op=set (mandatory)
  • op2=enable_alert_alias
  • id=<Agent alias> (mandatory)
  • id2=<Module name> (mandatory)
  • other: Alert template name (p.e: Warning event) (mandatory)

書式:

  • op=set (必須)
  • op2=enable_alert_alias
  • id=<エージェントの別名> (必須)
  • id2=<モジュール名> (必須)
  • other: アラートテンプレート名 (p.e: 警告イベント) (必須)


http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert_alias&id=nova&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

set disable_alert

Disable a alert of a agent.

エージェントのアラートを無効化します。

Call syntax:


  • op=set (mandatory)
  • op2=disable_alert
  • id=<Agent name> (mandatory)
  • id2=<Module name> (mandatory)
  • other: Alert template name (p.e: Warning event) (mandatory)

書式:

  • op=set (必須)
  • op2=disable_alert
  • id=<エージェント名> (必須)
  • id2=<モジュール名> (必須)
  • other: アラートテンプレート名 (例: Warning イベント) (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=garfio&id2=Status&other=Warning%20condition

set disable_alert_alias

Disable a alert of a agent.

エージェントのアラートを無効化します。

Call syntax:

  • op=set (mandatory)
  • op2=disable_alert_alias
  • id=<Agent alias> (mandatory)
  • id2=<Module name> (mandatory)
  • other: Alert template name (p.e: Warning event) (mandatory)

書式:

  • op=set (必須)
  • op2=disable_alert_alias
  • id=<エージェントエイリアス> (必須)
  • id2=<モジュール名> (必須)
  • other: アラートテンプレート名 (例: 警告イベント) (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert_alias&id=nova&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

set enable_module_alerts

Equal to the enable_alert api call.

enable_alert と同じです。

Call syntax:

  • op=set (obligatorio)
  • op2=enable_module_alerts
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)

書式:

  • op=set (必須)
  • op2=enable_module_alerts
  • id=<エージェント名> (必須)
  • id2=<モジュール名> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=garfio&id2=Status

set disable_module_alerts

Equal to the call api disable_alert.

disable_alert と同じです。

Call syntax:

  • op=set (obligatorio)
  • op2=disable_module_alerts
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)

書式:

  • op=set (必須)
  • op2=disable_module_alerts
  • id=<エージェント名> (必須)
  • id2=<モジュール名> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=garfio&id2=Status

set enable_module

Enable the module.

モジュールを有効化します。

Call syntax

  • op=set (mandatory)
  • op2=enable_module
  • id=<Agent name> (mandatory)
  • id2=<Module name> (mandatory)

書式:

  • op=set (必須)
  • op2=enable_module
  • id=<エージェント名> (必須)
  • id2=<モジュール名> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=garfio&id2=Status

set disable_module

Disable the module.

モジュールを無効化します。

Call syntax

  • op=set (mandatory)
  • op2=disable_module
  • id=<Agent name> (mandatory)
  • id2=<Module name> (mandatory)

書式:

  • op=set (必須)
  • op2=disable_module
  • id=<エージェント名> (必須)
  • id2=<モジュール名> (必須)
<nowoki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=garfio&id2=Status</nowiki>

set create_network_module_from_component

Create a new network module from a component.

コンポーネントから新たなネットワークモジュールを作成します。

Sintaxis de la llamada:

  • op=set (mandatory)
  • op2=create_network_module_from_component (mandatory)
  • id=<Nombre del agente> (mandatory)
  • id2=<Nombre del componente> (mandatory)

書式:

  • op=set (必須)
  • op2=create_network_module_from_component (必須)
  • id=<エージェント名> (必須)
  • id2=<コンポーネント名> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=create_network_module_from_component&id=garfio&id2=OS%20Total%20process&apipass=1234&user=admin&pass=pandora

set module_data

Add module value.

モジュールに値を追加します。

Call syntax:

  • op=set (mandatory)
  • op2=module_data (mandatory)
  • id=<id agente módulo> (mandatory)
  • other: module data and timestamp serialized.
    • dato: data which must belong to any Pandora data type.
    • tiempo: could be a specified timestamp of the string "now".

書式:

  • op=set (必須)
  • op2=module_data (必須)
  • id=<エージェントモジュールID> (必須)
  • other: モジュールのデータとタイムスタンプ
    • dato: Pandora のデータタイプ
    • tiempo: タイムスタンプ、"now" を指定できます。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_data&id=14&other_mode=url_encode_separator_|&other=123|now&apipass=1234&user=admin&pass=pandora

set new_module_group

Creates a new module group.

新たなモジュールグループを作成します。

Call syntax:

  • op=set (required)
  • op2=new_module_group (required)
  • id=<name of the module group> (required)

書式:

  • op=set (必須)
  • op2=new_module_group (必須)
  • id=<モジュールグループ名> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora

set module_group_synch

この機能はメタコンソールのみです。


Syncronizes a module group from the Metaconsole.

テンプレート:メタコンソール メタコンソールからモジュールグループを同期します。

Call syntax:

  • op=set (required)
  • op2=module_group_synch (required)
  • other=<serialized parameters> (required) in this case the name of the server(s)that are required to sync with the meta.
  • <server_name_1><server_name_2>...<server_name_n> (required)

書式:

  • op=set (必須)
  • op2=module_group_synch (必須)
  • other=<連続パラメータ> (必須) メタコンソールと同期するサーバの名前が必須です。
  • <server_name_1><server_name_2>...<server_name_n> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=module_group_synch&other=server_name1|server_name2|server_name3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set add_module_in_conf

>= 5.0 (Only Enterprise)

>= 5.0 (エンタープライズ版のみ)

Add the configuration into a local module.

ローカルモジュールに設定を追加します。

Call syntax:

  • op=set (mandatory)
  • op2=add_module_in_conf (mandatory)
  • id=<id agente> (mandatory)
  • id2=<nombre módulo> (mandatory)
  • other: The module data that will be placed in the conf file encoded in base64 (mandatory) (mandatory)

書式:

  • op=set (必須)
  • op2=add_module_in_conf (必須)
  • id=<エージェントID> (必須)
  • id2=<モジュール名> (必須)
  • other: conf ファイルに書くモジュール設定を base64 でエンコードしたもの (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

Will be returned '0' when success, '-1' when error, '-2' if already exists

成功すると '0'、エラー時は '-1'、すでに存在する場合は '-2' を返します。

set delete_module_in_conf

>= 5.0 (Only Enterprise)

>= 5.0 (エンタープライズ版のみ)

Delete a configuration of local module.

ローカルモジュールの設定を削除します。

Call syntax:

  • op=set (mandatory)
  • op2=add_module_in_conf (mandatory)
  • id=<id agente> (mandatory)
  • id2=<module name> (mandatory)

書式:

  • op=set (必須)
  • op2=add_module_in_conf (必須)
  • id=<エージェントID> (必須)
  • id2=<モジュール名> (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&user=admin&pass=pandora&id=9043&id2=example_name

Will be returned '0' when success or '-1' when error

成功すると '0'、エラー時は '-1' を返します。

set update_module_in_conf

>= 5.0 (Only Enterprise)

>= 5.0 (エンタープライズ版のみ)

Update a configuration of local module.

ローカルモジュールの設定を更新します。

Call syntax:

  • op=set (mandatory)
  • op2=update_module_in_conf (mandatory)
  • id=<agent id> (mandatory)
  • id2=<module name> (mandatory)
  • other: The new module data that will be placed in the conf file encoded in base64 (mandatory)

書式:

  • op=set (必須)
  • op2=update_module_in_conf (必須)
  • id=<エージェントID> (必須)
  • id2=<モジュール名> (必須)
  • other: conf ファイル内のモジュール設定を置き換える内容を、base64 でエンコードしたもの。(必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

Will be returned '1' when no changes, '0' when success, '-1' when error, '-2' if doesn't exist

変更が無い場合は '1'、成功すると '0'、エラー時は '-1'、存在しない場合は '-2' を返します。

set create_event

Create a new event into Pandora.

Pandora 内に新たなイベントを作成します。

Call syntax:

  • op=set (mandatory)
  • op2=create_event (mandatory)
  • other=<serialized_parameters> (mandatory) event's configuration data as follows:
  • <event_text> (mandatory)
  • <id_group> (mandatory)
  • <id_agent> (mandatory)
  • <status>
  • <id_user>
  • <evnet_type>
  • <severity>
  • <id_agent_module>
  • <id_alert_am>
  • <critical_instructions>
  • <warning_instructions>
  • <unknown_instructions>
  • <comment>
  • <user_comment>
  • <owner_user>(string)
  • <source>
  • <tags>
  • <custom_data> Custom data should be a base 64 encoded JSON document.

書式:

  • op=set (必須)
  • op2=create_event (必須)
  • other=<連続パラメータ> (必須) 次の順番でイベントデータを指定します:
  • <イベントテキスト> (必須)
  • <グループID> (必須)
  • <エージェントID> (必須)
  • <状態>
  • <ユーザID>
  • <イベントタイプ>
  • <重要度>
  • <エージェントモジュールID>
  • <アラートID>
  • <障害の説明>
  • <警告の説明>
  • <不明の説明>
  • <コメント>
  • <ユーザコマンド>
  • <オーナーユーザ>(文字列)
  • <発生元>
  • <タグ>
  • <カスタムデータ> カスタムデータは、base64 でエンコードされた JSON データである必要があります。
http://127.0.0.1/pandora_trunk/include/api.php?op=set&op2=create_event&other=NewEvent|0|189||apiuser|system|1||||||||VMware||eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set add_event_comment

Add an event comment.

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

Info.png

This call can be also used in Metaconsole


Info.png

これはメタコンソールでも利用できます。


Call syntax:

  • op=set (mandatory)
  • op2=add_event_comment (mandatory)
  • other=<serialized_parameters> (mandatory) event's configuration data as follows:
  • <comment> (mandatory)

書式:

  • op=set (必須)
  • op2=create_event (必須)
  • other=<連続パラメータ> (必須) 次の順番でイベントデータを指定します:
  • <コメント> (必須)

Info.png

Introduce the parameter "true" after "string" to use it in the Metaconsole


Info.png

メタコンソールで利用するには、"string" の後に "true" をパラメータで指定してください。


  • Node
  • ノード
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
  • Metaconsole
  • メタコンソール
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

set create_netflow_filter

(>=5.0)

Create a new filter of netflow.

新たな netflow フィルタを作成します。

Call syntax:

  • op=set (mandatory)
  • op2=create_netflow_filter (mandatory)
  • other=<serialized parameters> (mandatory) filter data in this order:
  • <filter_name> (mandatory)
  • <group_id> (mandatory)
  • <filter> (mandatory)
  • <aggregate_by> (Possible values: dstip,dstport,none,proto,srcip,srcport) (mandatory)
  • <output_format> (Possible values: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (mandatory)

書式:

  • op=set (必須)
  • op2=create_netflow_filter (必須)
  • other=<連続パラメータ> (必須) 次の順番でフィルタデータを指定します:
  • <フィルター名> (必須)
  • <グループID> (必須)
  • <フィルタ> (必須)
  • <集約方法> (設定可能な値: dstip,dstport,none,proto,srcip,srcport) (必須)
  • <出力フォーマット> (設定可能な値: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (必須)
http://127.0.0.1/pandora/include/api.php?op=set&op2=create_netflow_filter&apipass=1234&user=admin&pass=pandora&other=Filter%20name|9|host%20192.168.50.3%20OR%20host%20192.168.50.4%20or%20HOST%20192.168.50.6|dstport|kilobytes&other_mode=url_encode_separator_|

set create_custom_field

>= 5.0

Create a new custom field.

新たなカスタムフィールドを作成します。

Call syntax:

  • op=set (mandatory)
  • op2=create_custom_field (mandatory)
  • other=<serialized parameters> (mandatory) parameters to configure the custom field
  • <name> (mandatory)
  • <flag_display_front> (mandatory; 0 the field will not be displayed on operation view, 1 the field will be displayed)

書式:

  • op=set (必須)
  • op2=create_custom_field (必須)
  • other=<連続パラメータ> (必須) カスタムフィールドを設定するパラメータ
  • <名前> (必須)
  • <フロント表示フラグ> (必須; 0:操作画面でフィールドを表示しない。1:フィールドを表示する。)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_custom_field&other=mycustomfield|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set create_tag

>= 5.0

Create a new tag.

新たなタグを作成します。

Sintaxis de la llamada:

  • op=set (mandatory)
  • op2=create_tag (mandatory)
  • other=<serialized parameters> (mandatory) parameters to configure the tag
  • <name> Tag's name (mandatory)
  • <description> Tag's description
  • <eurl> Tag's URL
  • <email> Tag's email

書式:

  • op=set (必須)
  • op2=create_tag (必須)
  • other=<連続パラメータ> (必須) タグの設定パラメータ
  • <名前> タグ名 (必須)
  • <説明> タグの説明
  • <url> タグの URL
  • <email> タグのメールアドレス
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_tag&other=tag_name|tag_description|tag_url|tag_email&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set enable_disable_agent

Enable / disabled agent.

エージェントを有効化/無効化します。

Call syntax:

  • op=set (compulsory)
  • op2=enable_disable_agent (compulsory)
  • id=<agent_id> (compulsory) should be an agent id.

書式:

  • op=set (必須)
  • op2=enable_disable_agent (必須)
  • id=<エージェントID> (必須) エージェントIDでなければいけません。
  • other=<フラグ> (必須) 有効化する場合は 1、無効化する場合は 0 を指定します。

Example 1 (Disable agent 'example_id')

例1 (エージェント 'example_id' を無効化)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Example 2 (Enable agent 'example_id')

例2 (エージェント 'example_id' を有効化)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set gis_agent_only_position

>= 5.0

Add new position GIS in any agent.

エージェントに、新たな GIS 位置情報を追加します。

Call syntax:

書式:

  • op=set (compulsory)
  • op2=gis_agent_only_position (compulsory)
  • id=<índice> (compulsory) agent index
  • other=<parámetros serializados> (compulsory) params to set position
  • <latitude> Latitude
  • <longitude> Longitude
  • <altitude> Altitude
  • op=set (必須)
  • op2=gis_agent_only_position (必須)
  • id=<id> (必須) エージェントID
  • other=<連続パラメータ> (必須) 位置情報パラメータ
  • <緯度>
  • <経度>
  • <高度>
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0

set gis_agent

>= 5.0

Add the gis data agent.

エージェントに gis データを追加します。

Call syntax:

書式:

  • op=set (compulsory)
  • op2=gis_agent_only_position (compulsory)
  • id=<índice> (compolsory) agent index.
  • other=<parámetros serializados> (compulsory) gis data
  • <latitude>
  • <longitude>
  • <altitude>
  • <ignore_new_gis_data>
  • <manual_placement>
  • <start_timestamp>
  • <end_timestamp>
  • <number_of_packages>
  • <description_save_history>
  • <description_update_gis>
  • <description_first_insert>
  • op=set (必須)
  • op2=gis_agent_only_position (必須)
  • id=<id> (必須) エージェントID
  • other=<連続パラメータ> (必須) gisデータ
  • <緯度>
  • <経度>
  • <高度>
  • <新たなgisデータの無視>
  • <手動位置決め>
  • <開始タイムスタンプ>
  • <終了タイムスタンプ>
  • <データ数>
  • <履歴保存の説明>
  • <gis更新の説明>
  • <初回挿入の説明>

set reset_agent_counts

Updates the count of modules and alerts of an agent.

エージェントのモジュールおよびアラートカウントを更新します。

Call syntax:

  • op=set (required)
  • op2=reset_agent_counts (required)
  • id=<id_agent> (required) must be an agente id or "All".

書式:

  • op=set (必須)
  • op2=reset_agent_counts (必須)
  • id=<id_agent> (必須) エージェント ID もしくは "All" である必要があります。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=reset_agent_counts&apipass=1234&user=admin&pass=pandora&id=All

set create_special_day

>= 5.1

Add new special day.

新たな特別日を追加します。

Call syntax:

書式:

  • op=set (compulsory)
  • op2=create_special_day (compulsory)
  • other=<serialized parameters> (compulsory)
  • <special day> Special day
  • <same day> Same day
  • <description> Description
  • <id_group> Group ID
  • op=set (必須)
  • op2=update_special_day (必須)
  • id=<id> (必須) エージェントID
  • other=<連続パラメータ> (必須)
  • <特別日>
  • <同一の日>
  • <説明>
  • <グループID>
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=create_special_day&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0

set update_special_day

>= 5.1

Update a configuration of special day already defined.

定義済の特別日の設定を更新します。

Call syntax:

書式:

  • op=set (compulsory)
  • op2=update_special_day (compulsory)
  • id=<special day's id> (compulsory)
  • other=<serialized parameters> (compulsory)
  • <special day> Special day
  • <same day> Same day
  • <description> Description
  • <id_group> Group ID
  • op=set (必須)
  • op2=update_special_day (必須)
  • id=<特別日ID> (compulsory)
  • other=<連続パラメータ> (必須)
  • <特別日>
  • <同一の日>
  • <説明>
  • <グループID>
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=update_special_day&id=1&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0

set delete_special_day

>= 5.1

Delete a special day.

特別日を削除。

Call syntax:

書式:

  • op=set (compulsory)
  • op2=delete_special_day (compulsory)
  • id=<special day's id> (compulsory)
  • op=set (必須)
  • op2=update_special_day (必須)
  • id=<特別日ID> (必須)
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=delete_special_day&id=1

set pagerduty_webhook

>= 5.1

Connect PagerDuty notification with Pandora FMS alerts. This call will be set in webhooks option in PagerDuty's service to validate the alerts of Pandora FMS previously linked to Pager Duty when were validated from PagerDuty.

Pandora FMS アラートと PagerDuty 通知を接続します。PagerDuty サービスの webhooks オプションを、PagerDuty からアラートを承諾した場合の動作に対して、あらかじめ PagerDuty にリンクさせた Pandora FMS のアラートの承諾に設定します。

Call syntax:

書式:

  • op=set (compulsory)
  • op2=pagerduty_webhook (compulsory)
  • id=alert (compulsory)
  • op=set (必須)
  • op2=pagerduty_webhook (必須)
  • id=alert (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert

set tag_user_profile

>= 6

Add a tag into a profile for a user.

ユーザのプロファイルにタグを追加します。

Call syntax:

書式:

  • op = set (compulsory)
  • op2 = tag_user_profile (compulsory)
  • id = id_user (compulsory)
  • id2 = id_tag (compulsory)
  • other_mode = url_encode_separator_| (compulsory)
  • other = <id_group>|<id_profile> (compulsory)
  • op = set (必須)
  • op2 = tag_user_profile (必須)
  • id = id_user (必須)
  • id2 = id_tag (必須)
  • other_mode = url_encode_separator_| (必須)
  • other = <id_group>|<id_profile> (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag_user_profile&apipass=1234&user=admin&pass=pandora&id=1&id2=2&other_mode=url_encode_separator_|&other=122|3

set tag

>= 6

Add a tag into your pandora.

pandora にタグを追加します。

Call syntax:

書式:

  • op = set (compulsory)
  • op2 = tag (compulsory)
  • id = name (compulsory)
  • other_mode = url_encode_separator_| (compulsory)
  • other = <description>|<url>|<email>|<phone>
  • op = set (必須)
  • op2 = tag (必須)
  • id = name (必須)
  • other_mode = url_encode_separator_| (必須)
  • other = <description>|<url>|<email>|<phone>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag&apipass=1234&user=admin&pass=pandora&id=test&other_mode=url_encode_separator_|&other="a test"|http://www.artica.es|test@artica.es|01189998819991197253

set add_tag_module

>= 6

Add a tag into a module.

モジュールにタグを追加します。

Call syntax:

書式:

  • op = set (compulsory)
  • op2 = add_tag_module (compulsory)
  • id = id_module (compulsory)
  • id2 = id_tag (compulsory)
  • op = set (必須)
  • op2 = add_tag_module (必須)
  • id = id_module (必須)
  • id2 = id_tag (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2

set remove_tag_module

>= 6

Remove a tag into a module.

モジュールのタグを削除します。

Call syntax:

書式:

  • op = set (compulsory)
  • op2 = add_tag_module (compulsory)
  • id = id_module (compulsory)
  • id2 = id_tag (compulsory)
  • op = set (必須)
  • op2 = add_tag_module (必須)
  • id = id_module (必須)
  • id2 = id_tag (必須)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2

set planned_downtimes_created

>= 5.1

計画停止を作成します

書式:

  • op=set (必須)
  • op2=planned_downtimes_created (必須)
  • other=<連続パラメータ> (必須) 計画停止を作成するパラメータ列:
  • <説明>
  • <開始日時> 一回のみの場合の開始日時
  • <終了日時> 一回のみの場合の終了日時
  • <グループID>
  • <月>
  • <火>
  • <水>
  • <木>
  • <金>
  • <土>
  • <日>
  • <定期実行開始時間>
  • <定期実行終了時間>
  • <定期実行開始日>
  • <定期実行終了日>
  • <タイプ> quit, disabled_agents, disabled_agents_alerts のいずれか
  • <実行> once または periodically
  • <定期実行タイプ> weekly または monthly
  • <ユーザID>

Once:

一回:

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|once|weekly|admin&other_mode=url_encode_separator_|

Periodically:

繰り返し:

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

set planned_downtimes_additem

>= 5.1

計画停止に対象エージェント(および対象モジュール)を追加します

書式:

  • op=set
  • op2=planned_downtimes_additem
  • id=<計画停止ID>
  • other=<連続パラメータ> (必須) 追加対象
  • <エージェントID1;エージェントID2;エージェントID3;...エージェントIDn>
  • <モジュール名1;モジュール名2;モジュール名3;...モジュール名n>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&apipass=1234&user=admin&pass=pandora&id=123&other=1;2;3;4%7CStatus;Unkown_modules%20&other_mode=url_encode_separator_|

set planned_downtimes_deleted

>=5.1

計画停止を削除します。

書式:

  • op=set
  • op2=planned_downtimes_deleted
  • id=<計画停止ID>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted&apipass=1234&user=admin&pass=pandora&id=10

set create_synthetic_module

>=5.1SP4

Add new synthetic module:

  • op=set
  • op2=create_synthetic_module
  • id=Name of agent to add module
  • other= <name_module><synthetic_type><AgentName;Operation;NameModule> OR <AgentName;NameModule> OR <Operation;Value>

新たな統合モジュールを作成します。

書式:

  • op=set
  • op2=create_synthetic_module
  • id=モジュールを追加するエージェント名
  • other= <モジュール名><統合タイプ><エージェント名;演算タイプ;モジュール名> または <エージェント名;モジュール名> または <演算タイプ;値>
    • Data of module:
 In arithmetic creations the firts without operator if you put Agent and module: AgentName;NameModule or this if you will put a value: <Operation;Value>. the rest of data <AgentName;Operation;NameModule> or <Operation;Value>
 average: <AgentName;Operation;NameModule> or <Operation;Value>
    • モジュールのデータ:
 演算設定の場合で、エージェントとモジュール名を指定して演算タイプを指定しない場合: <エージェント名;モジュール名>、値を指定する場合: <演算タイプ;値>. それ以外: <エージェント名;演算タイプ;モジュール名> または <演算タイプ;値>
 平均: <エージェント名;演算タイプ;モジュール名> または <演算タイプ;値>
    • Operation:
 arithmetic: ADD, SUB, MUL, DIV
 average: Only AVG
    • 演算タイプ:
 演算: ADD, SUB, MUL, DIV
 平均: AVG のみ
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=test&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;ADD;Module%20Name2&other_mode=url_encode_separator_|
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=pepito&other=prueba|average|Agent%20Name;AVG;Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|

set create_service

>= 7

Create a new service.

新たなサービスを作成します。

書式:

  • op=set
  • op2=create_service
  • other=<name>;<description>;<id_group>;<critical>;<warning>;<id_agent>;<sla_interval>;<sla_limit>;

<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;

  • op=set
  • op2=create_service
  • id=サービスID
  • other=<名前>;<説明>;<グループID>;<障害>;<警告>;<エージェントID>;<SLA間隔>;<SLA制限>;

<警告モジュールアラートテンプレートID>;<障害モジュールアラートテンプレートID>;<障害モジュールSLAアラートテンプレートID>;

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_service&return_type=json&other=test1%7CDescripcion%7C12%7C1%7C0.5%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set update_service

>= 7

Update a service.

サービスを更新します。

  • op=set
  • op2=update_service
  • id=service id
  • other=<name>;<description>;<id_group>;<critical>;<warning>;<id_agent>;<sla_interval>;<sla_limit>;

<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;

書式:

  • op=set
  • op2=update_service
  • id=サービスID
  • other=<名前>;<説明>;<グループID>;<障害>;<警告>;<エージェントID>;<SLA間隔>;<SLA制限>;

<警告モジュールアラートテンプレートID>;<障害モジュールアラートテンプレートID>;<障害モジュールSLAアラートテンプレートID>;

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_service&return_type=json&id=1&other=test2%7CDescripcion2%7C%7C%7C0.6%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set add_element_service

>= 7

Adds elements to service.

サービスに要素を追加します。

  • op=set
  • op2=add_element_service
  • id=service id
  • other=Json with elements in base64

書式:

  • op=set
  • op2=add_element_service
  • id=サービスID
  • other=base64エンコードした要素のJson

The structure of the json should be as follows:

json の構造は次の通りです。

[{"type":"agent","id":2,"description":"Test1","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"module","id":1,"description":"Test2","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"service","id":3,"description":"Test3","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0}]

In each type, the id field refers to different things:

それぞれのタイプで、ID フィールドは異なるものを参照します。

- If it is of type agent, it is agent id

- If it is of type module, it is agent module id

- If it is service type, it is the service id that we want to add.

- タイプが agent の場合は、エージェント ID です。

- タイプが module の場合は、エージェントモジュール ID です。

- タイプが service の場合は、追加したいサービス ID です。

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_element_service&return_type=json&id=6&other=W3sidHlwZSI6ImFnZW50IiwiaWQiOjIsImRlc2NyaXB0aW9uIjoiamlqaWppIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoibW9kdWxlIiwiaWQiOjEsImRlc2NyaXB0aW9uIjoiSG9sYSBxdWUgdGFsIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoic2VydmljZSIsImlkIjozLCJkZXNjcmlwdGlvbiI6ImplamVqZWplIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH1d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set metaconsole_synch

>= 7

Add license key to metaconsole and synchonize nodes.

ライセンスキーをメタコンソールへ追加し、ノードへ同期します。

  • op=set
  • op2=metaconsole_synch
  • id=License key
http://127.0.0.1/pandora_console/enterprise/meta/include/api.php?op=set&op2=metaconsole_synch&id=LICENSEKEY&apipass=1234&user=admin&pass=pandora

set migrate_agent

>= 7.21 ONLY METACONSOLE

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

Adds a selected agent to the agent migration queue

選択したエージェントをエージェントマイグレーションキューへ追加します。

  • op=set
  • op2=migrate_agent
  • id=id_agent to migrate
  • other=origin node name| destination node name | (true|false) not to migrate historical database
  • other_mode=url_encode_separator_|
  • return_type = string, json, etc
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&other=nova|fringe|0&other_mode=url_encode_separator_|&return_type=string

set new_cluster

>= 7.0

Crea un cluster de agentes

エージェントのクラスタを作成します。

Create a monitoring cluster with agents and items to monitor different nodes.

異なるノードを監視するためのエージェントとアイテムを持つ監視クラスタを作成します。

  • op=set
  • op2=new_cluster
  • other=nombre_cluster| tipo_cluster| descripcion| id_grupo
  • other_mode=url_encode_separator_

書式:

  • op=set
  • op2=new_cluster
  • other=クラスタ名| クラスタタイプ| 説明| グループID
  • other_mode=url_encode_separator_
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_cluster&other=nombre_cluster%7CAA%7Cdescripcion%7C12&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set add_cluster_agent

>= 7.0

Add agent to a cluster

エージェントをクラスタに追加します。

  • op=set
  • op2=add_cluster_agent
  • other=json with elements in base64
  • other_mode=url_encode_separator_

書式:

  • op=set
  • op2=add_cluster_agent
  • other=要素を含む json を base64 エンコードしたもの
  • other_mode=url_encode_separator_

The json structure should be:

json の構造は次の通りです。

[{"id":5,"id_agent":2}, {"id":5,"id_agent":3}]

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set add_cluster_item (アクティブ/アクティブ)

>= 7.0

Adds an active/active item to a cluster

クラスタに、アクティブ/アクティブ アイテムを追加します。

  • op=set
  • op2=add_cluster_item
  • other=json with elements in base64
  • other_mode=url_encode_separator_

書式:

  • op=set
  • op2=add_cluster_item
  • other=要素を含む json を base64 エンコードしたもの
  • other_mode=url_encode_separator_

The json structure should be:

json の構造は次の通りです。

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

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IlN3YXBfVXNlZCIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBQSIsImNyaXRpY2FsX2xpbWl0Ijo4MCwid2FybmluZ19saW1pdCI6NjB9LAp7Im5hbWUiOiJUQ1BfQ29ubmVjdGlvbnMiLCJpZF9jbHVzdGVyIjo1LCJ0eXBlIjoiQUEiLCJjcml0aWNhbF9saW1pdCI6ODAsIndhcm5pbmdfbGltaXQiOjYwfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set add_cluster_item (アクティブ/スタンバイ)

>= 7.0

Adds a passive/actve item to a cluster

クラスタに、アクティブ/スタンバイのアイテムを追加します。

  • op=set
  • op2=add_cluster_item
  • other=json with elements in base64
  • other_mode=url_encode_separator_

書式:

  • op=set
  • op2=add_cluster_item
  • other=要素を含む json を base64 エンコードしたもの
  • other_mode=url_encode_separator_

The json structure should be:

json の構造は次の通りです。

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

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwiaWRfY2x1c3RlciI6NSwidHlwZSI6IkFQIiwiaXNfY3JpdGljYWwiOjF9LAp7Im5hbWUiOiJEaXNrVXNlZF8vcHJvYy9zY2hlZF9kZWJ1ZyIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBUCIsImlzX2NyaXRpY2FsIjoxfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set delete_cluster

>= 7.0

Deletes a cluster.

クラスタを削除します。

  • op=set
  • op2=delete_cluster
  • id=id of the cluster to delete

書式:

  • op=set
  • op2=delete_cluster
  • id=<削除するクラスタID>
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster&id=7&apipass=1234&user=admin&pass=pandora

set delete_cluster_agent

>= 7.0

Disassociates an agent from a cluster

クラスタからエージェントを削除します。

  • op=set
  • op2=delete_cluster_agent
  • other=id_agente| id_cluster|
  • other_mode=url_encode_separator_

書式:

  • op=set
  • op2=delete_cluster_agent
  • other=エージェントID| クラスタID|
  • other_mode=url_encode_separator_
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_agent&other=2%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set delete_cluster_item

>= 7.0

Deletes an item from a cluster

クラスタからアイテムを削除します。

  • op=set
  • op2=delete_cluster_item
  • id=id of item to eliminate

書式:

  • op=set
  • op2=delete_cluster_item
  • id=<削除するアイテムID>
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_item&id=9&apipass=1234&user=admin&pass=pandora

set create_policy

>= 7.0. 725

Create a policy. Its required the policy name, that can not be repeated and the id_group that must exist in the database.

ポリシーを作成します。 ポリシー名を指定する必要があります。複数設定はできません。また、グループ ID がデータベースに存在する必要があります。

  • op = set
  • op2 = create_policy
  • other = policy name (required) | id_del grupo (required) | description;
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = create_policy
  • other = ポリシー名(必須) | グループID(必須) | 説明;
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=create_policy&apipass=1234&user=admin&pass=pandora&other=name%20Policy|11|this%20description&other_mode=url_encode_separator_|&return_type=json

set update_policy

>= 7.0. 725

Update a policy. The policy name can not be repeated and the id_group must exist in the database. Returns 0 (false) or the updated policy id (true).

ポリシーを更新します。 ポリシー名は複数指定できません。また、グループ ID がデータベースに存在する必要があります。0(失敗した場合)または、更新したポリシーID(成功した場合)を返します。

  • op = set
  • op2 = update_policy
  • id = id política
  • other = policy name | id_del grupo | description;
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = update_policy
  • id = ポリシーID
  • other = ポリシー名 | グループID | 説明;
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=update_policy&apipass=1234&user=admin&pass=pandora&id=17&other=policy2|11|this%20description&other_mode=url_encode_separator_|&return_type=json

set delete_policy

>= 7.0. 725

Deletes a policy. Its required to introduce the policy id, which must exist in order to delete it. Returns 0 (false) or 1 (true).

ポリシーを削除します。存在するポリシー ID を指定する必要があります。0(失敗した場合) または、1(成功した場合) を返します。

  • op = set
  • op2 = delete_policy
  • id = policy id
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = delete_policy
  • id = ポリシーID
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=delete_policy&apipass=1234&user=admin&pass=pandora&id=10&return_type=json

set add_collections_policy

>= 7.0. 725

Add a collection to a policy. It is necessary to introduce the policy id and that there is such a policy, as an id, name or short name of the collection you want to add which should exist. Both fields are required. Returns 0 (false) or the id of the collection added to a policy (true).

ポリシーにコレクションを追加します。存在するポリシー ID と、コレクションの名前または短い名前を指定する必要があります。いずれも必須です。 0(失敗した場合) または、ポリシーへ追加したコレクション ID (成功した場合) を返します。

  • op = set
  • op2 = add_collections_policy
  • id = policy id
  • id2 = id, name or short name
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = add_collections_policy
  • id = ポリシー ID
  • id2 = 名前または短い名前
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=add_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=apache_plugin

set remove_collections_policy

>= 7.0. 725

To mark a collection of a policy that is pending deletion is necessary:

  • A policy id and that such a policy exists. Required
  • An id, name or short name of the collection you want to remove which must exist. Required
  • and 0 or 1: where 1 is to mark as pending to be deleted and if it is 0 it removes the pending mark to be deleted. by default, if this field is not added, it will try to mark so that it can be deleted.

ポリシーのコレクションに削除予約を設定します。

  • 存在するポリシー ID を指定する必要があります。
  • 存在するコレクションの名前もしくは短い名前を指定する必要があります。
  • other に 0 か 1 を指定します。1 を指定すると削除予約を設定します。0 を指定すると削除予約を解除します。このフィールドを指定しない場合、デフォルトでは削除予約を設定します。

returns 0 (false) or 1 (true).

0(失敗) または 1(成功) を返します。

  • op = set
  • op2 = remove_collections_policy
  • id = policy id
  • id2 = id, name or short name
  • other = (bool) 0 or 1
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = remove_collections_policy
  • id = ポリシーID
  • id2 = 名前もしくは短い名前
  • other = (bool) 0 または 1
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=remove_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=2&other=1.

set create_plugins_policy

>= 7.0. 725

To add a plugin to a policy is necessary:

  • A policy id and that such a policy exists. Required
  • The plugin string to run. Required

ポリシーにプラグインを追加します。

  • 存在するポリシーIDを指定する必要があります。
  • 実行するプラグイン文字列を指定する必要があります。

returns 0 (false) or the plugin id that's been added to a policy (true).

0(失敗) または、ポリシーへ追加したプラグイン ID (成功)を返します。

  • op = set
  • op2 = create_plugins_policy
  • id = policy id
  • id2 = text string
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = create_plugins_policy
  • id = ポリシーID
  • id2 = テキスト文字列
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=create_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2&id2=echo%201

set delete_plugins_policy

>= 7.0. 725

To remove a plugin from a policy it is necessary:

  • A policy id and that such a policy exists. required
  • A plugin id that you want to remove. required
  • 0 or 1: being 1 mark as pending to be deleted the plugin and if it is 0 remove the pending mark to be deleted by default if not added, this field is marked as pending to be deleted.

returns 0 (false) or 1 (true).

ポリシーからプラグインを削除します。

  • 存在するポリシー ID を指定する必要があります。
  • 削除したいプラグイン ID を指定する必要があります。
  • other に 0 か 1 を指定します。1を指定するとプラグインの削除予約を設定します。0を指定すると削除予約を解除します。このフィールドを指定しない場合、デフォルトでは予約が設定されます。

0(失敗) または 1(成功) を返します。

  • op = set
  • op2 = delete_plugins_policy
  • id = policy id
  • id2 = plugin id
  • other = 0 or 1
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = delete_plugins_policy
  • id = ポリシーID
  • id2 = プラグインID
  • other = 0 または 1
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=delete_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&id2=1&other=1

set linking_policy

>= 7.0. 725

To link an unlinked module of a policy is necessary:

  • An agent id module that is unlinked.

ポリシーに未リンクのモジュールをリンクします。

  • 未リンクのエージェントモジュール ID を指定する必要があります。

returns 0 (false) or 1 (true).

0(失敗) または 1(成功) を返します。

  • op = set
  • op2 = linking_policy
  • id = module agent id
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = linking_policy
  • id = エージェントモジュールID
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=linking_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=28

set create_alerts_policy

>= 7.0. 725

To create policy alerts is necessary:

  • A policy id that must exist (required).
  • A policy module id if it is of normal type is obligatory.
  • A template id that must exist (required).
  • Whether or not it is external 0 (normal), 1 (external). By default it is 0 normal
  • It is obligatory in case of being of external type (1) name of module with which to coincide.

returns 0 (false) or the id of the alert added in the policy (true).

ポリシーアラートを作成します。

  • 存在するポリシー ID を指定する必要があります。
  • 通常のタイプの場合、ポリシーモジュールIDを指定する必要があります。
  • 存在するテンプレートIDを指定する必要があります。
  • 外部かどうかを 0(通常)、1(外部) で設定します。デフォルトは、通常の 0 です。
  • 外部タイプ(1) の場合は、名前を指定する必要があります。

0(失敗) または、ポリシーに追加したアラートID(成功) を返します。

  • op = set
  • op2 = create_alerts_policy
  • id = policy id
  • id2 = policy module id
  • other = policy module id|id template|0 or 1|module name.
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = create_alerts_policy
  • id = ポリシーID
  • id2 = ポリシーモジュールID
  • other = ポリシーモジュールID|テンプレートID|0 または 1|モジュール名
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&other=0|2|1|cpu%20load&other_mode=url_encode_separator_|

set update_alerts_policy

>= 7.0. 725

To update policy alerts is necessary:

  • A policy id that must exist (required).
  • Active 0 | Waiting 1
  • enable 0 | disable 1

returns 0 (false) or the id of the updated alert in the policy (true).

ポリシーアラートを更新します。

  • 存在するポリシーIDを指定する必要があります。
  • アクティブ 0 または、待ち 1 を指定します。
  • 有効化 0 または、無効化 1 を指定します。

0(失敗) もしくは、ポリシーで更新したアラートID(成功)を返します。

  • op = set
  • op2 = update_alerts_policy
  • id = policy id
  • other = 0 or 1 ( activate/deactivate ) | 0 or 1 (enable/disable).
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = update_alerts_policy
  • id = ポリシーID
  • other = 0 または 1 (activate/deactivate ) | 0 または 1 (enable/disable).
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=update_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&other=1|1&other_mode=url_encode_separator_|

set delete_alerts_policy

>= 7.0. 725

To remove an alert from a policy is necessary:

  • A policy alert id that must exist (required).
  • 0 | 1 mark pending removal or not by default if you do not add this field stays at 1
  • Active 0 | Standby 1

returns 0 (false) or 1 (true).

ポリシーからアラートを削除します。

  • 存在するポリシーアラートIDを指定する必要があります。
  • 0 | 1 で削除予約の設定・解除設定をします。このフィールドを指定しない場合、デフォルトは 1 です。
  • アクティブ 0 | スタンバイ 1 を設定します。

0(失敗) または 1(成功) を返します。

  • op = set
  • op2 = delete_alerts_policy
  • id = policy id
  • id2 = 0 or 1.
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = delete_alerts_policy
  • id = ポリシーID
  • id2 = 0 または 1
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=1

set create_alerts_actions_policy

>= 7.0. 725

To add an action to a policy alert is necessary:

  • A policy alert id that must exist (required).
  • A policy action id that must exist (required).
  • You can add a minimum number of shots or a maximum number of shots by default: 0.

returns 0 (false) or the id of the action added to the alert of a policy (true).

ポリシーアラートにアクションを追加します。

  • 存在するポリシーアラートIDを指定する必要があります。
  • 存在するポリシーアクションIDを指定する必要があります。
  • 最低および最大アラート数を設定することができます。デフォルトは 0 です。

0(失敗) または、ポリシーアラートに追加したアクションID(成功) を返します。

  • op = set
  • op2 = create_alerts_action_policy
  • id = policy id
  • id2 = action id
  • other = min fires | max fires
  • other_mode=url_encode_separator_|
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = create_alerts_action_policy
  • id = ポリシーID
  • id2 = アクションID
  • other = 最小アラート数 | 最大アラート数
  • other_mode=url_encode_separator_|
  • return_type = (string, csv, json).
http://172.16.0.2/pandora_console/include/api.php?op=set&op2=create_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4&other=5|2&other_mode=url_encode_separator_|

set delete_alerts_actions_policy

>= 7.0. 725

To remove an action from a policy alert is necessary:

  • A policy alert id that must exist (required).
  • A policy action id that must exist (required).

ポリシーアラートからアクションを削除します。

  • 存在するポリシーアラートIDを指定する必要があります。
  • 存在するポリシーアクションIDを指定する必要があります。
  • op = set
  • op2 = delete_alerts_action_policy
  • id = policy id
  • id2 = action id
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = delete_alerts_action_policy
  • id = ポリシーID
  • id2 = アクションID
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4

set remove_agents_policy

>= 7.0. 725

To remove an agent from a policy is necessary:

  • A policy id that must exist (required).
  • An agent id that must exist (required).

ポリシーからエージェントを削除します。

  • 存在するポリシーIDを指定する必要があります。
  • 存在するエージェントIDを指定する必要があります。
  • op = set
  • op2 = remove_agents_policy
  • id = policy id
  • id2 = group id
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = remove_agents_policy
  • id = ポリシーID
  • id2 = エージェントID
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=remove_agents_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2

set add_groups_policy

>= 7.0. 725

To add a group of a policy is necessary:

  • A policy id that must exist (required).
  • A group id that must exist (required).

ポリシーのグループを追加します。

  • 存在するポリシーIDを指定する必要があります。
  • 存在するグループIDを指定する必要があります。
  • op = set
  • op2 = add_groups_policy
  • id = policy id
  • id2 = group id
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = add_groups_policy
  • id = ポリシーID
  • id2 = グループID
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=add_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=12

set remove_groups_policy

>= 7.0. 725

To remove an agent from a policy is necessary:

  • A policy id that must exist (required).
  • A group id that must exist (required).

ポリシーからグループを削除します。

  • 存在するポリシーIDを指定する必要があります。
  • 存在するグループIDを指定する必要があります。
  • op = set
  • op2 = add_groups_policy
  • id = policy id
  • id2 = group id
  • return_type = (string, csv, json).

書式:

  • op = set
  • op2 = add_groups_policy
  • id = ポリシーID
  • id2 = グループID
  • return_type = (string, csv, json).
http://localhost/pandora_console/include/api.php?op=set&op2=remove_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2

set create_os

>= 7.0. 727

Creates a new operating system with the passed data as parameters.

パラメータで渡したデータで OS を作成します。

Call syntax:

  • op=set (mandatory)
  • op2=create_os (mandatory)
  • other=<serializead parameters> (mandatory) are the system's data, serializead in this order:
  • <name>
  • <description>
  • <icon>

書式:

  • op=set (必須)
  • op2=create_os (必須)
  • other=<連続パラメータ> (必須) 次の順番で指定するデータです。
  • <名前>
  • <説明>
  • <アイコン>


http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_os&other=os_name%7Cos_description%7Cos_icon.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set update_os

>= 7.0. 727

Updates the operating system with the passed data as parameters.

パラメータで渡したデータで OS を更新します。

Call syntax:

  • op=set (mandatory)
  • op2=create_os (mandatory)
  • other=<serializead parameters> (mandatory) are the operating system's data, serializead in this order:
  • <name>
  • <description>
  • <icon>

書式:

  • op=set (必須)
  • op2=create_os (必須)
  • other=<連続パラメータ> (必須) 次の順番で指定するデータです。
  • <名前>
  • <説明>
  • <アイコン>
http://127.0.0.1/pandora_console/include/api.php?id=107&op=set&op2=update_os&other=os_name_to_update%7Cos_description_to_update%7Cos_icon_to_update.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set disabled_and_standby

>= 7.0. 728

Disables an agent and, if it has remote configuration, puts it in standby mode.

エージェントを無効化し、またリモート設定がある場合はスタンバイモードにします。

Call sintax:

  • op=set (obligatory)
  • op2=disabled_and_standby (obligatory)
  • id=<agent id> (obligatory). In the metaconsole it is the id of tagente, that is to say, the id of the node.
  • id2=<id del nodo> (obligatory in the meta console, unnecessary 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 (必須)
  • op2=disabled_and_standby (必須)
  • id=<エージェント ID> (必須) メタコンソールでは tagente の ID で、つまりノード ID です。
  • id2=<ノード ID> (メタコンソールでは必須、ノードでは不要)
  • other=<値> (オプション) 新たな状態(0 で有効化、1 で無効化)です。値を指定しない場合は、エージェントは無効化されます。
http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?id=2&id2=1&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set validate_traps

>= 7.0. 728

Allows to validate traps.

トラップの承諾をします。

  • op = set
  • op2 = validate_traps
  • id = trap id
  • op = set
  • op2 = validate_traps
  • id = トラップID
https://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set delete_traps

>= 7.0. 728

Allows to delete a trap:

トラップを削除します。

  • op = set
  • op2 = delete_traps
  • id = trap id
  • op = set
  • op2 = delete_traps
  • id = トラップID
http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=delete_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set access_process

>= 7.0NG. 728

This function allows to manage the access to a third application from records in the system audit log of pandorafms. It uses different parameters to process one of these registry actions in our application and avoids concurrent access by administrator users. Optionally, it can prohibit access to non-administrator users.

この機能により、Pandora FMS のシステム監査ログにおける、3つ目のレコードのアプリケーションへのアクセスを管理できます。 アプリケーションに登録されたアクションの一つの処理を実行するために異なるパラメータを用い、管理者ユーザによる同時アクセスを回避します。オプションで、管理者以外のユーザーへのアクセスを禁止することもできます。

Call syntax:

  • op = set
  • op2 = access_process
  • other=<required parameters>:
  • <user_id>

書式:

  • op = set
  • op2 = access_process
  • other=<必要なパラメータ>:
  • <ユーザID>

The id of the user trying to access the application, this data is recorded and checked in the audit to filter the access, exit, exploration or navigation of the user through the application.

アプリケーションにアクセスしようとしているユーザーの ID です。このデータは監査で記録およびチェックされ、アプリケーションを介したユーザのアクセス、終了、閲覧、またはナビゲーションをフィルタリングします。

  • <アクション> - (login,logout,exclude,browse)

login: It is used to request access to the application. It deletes the text string "free" and registers our access in the pandorafms audit or returns the text string "denied" if there is another user in the audit records who has previously accessed the system and has not yet logged out. It will also return denied if the administrator-only access parameter is enabled and the user is not.

login: アプリケーションへのアクセスを要求するために使用されます。 テキスト文字列 "free" を削除して Pandora FMS 監査ログにアクセスを登録するか、または以前にシステムにアクセスしたがまだログアウトしていない別のユーザーが監査レコードに含まれている場合は、テキスト文字列 "denied" を返します。 管理者のみのアクセスパラメータが有効になっていて、ユーザが無効になっている場合も、denied を返します。

logout: Logs a user's exit from the application so that other users are again allowed to access.

logout: 他のユーザが再びアクセスを許可されるように、アプリケーションからのユーザのログアウトしたことをログに記録します。

browse: It must be used on all pages of the external application, as it checks whether this user is still the last one to access or be expelled from the application.

browse: このユーザがまだアクセスしているのか、アプリケーションからログアウトさせられたのかをチェックするため、外部アプリケーションのすべてのページで使用する必要があります。

exclude: Expels the currently registered user and registers the access of another that we have sent in the user_id parameter

exclude: 現在登録されているユーザをログアウトさせ、別のユーザーのアクセスを user_id パラメータに登録します。

  • <app ip address>
  • <アプリケーション IP アドレス>

IP address of the application from which you are accessing it. It is registered and checked in the pandorafms audit to check the access status of users in the application.

アクセス元のアプリケーションの IP アドレス。 これは Pandora FMS 監査で登録およびチェックされ、アプリケーション内のユーザのアクセス状況をチェックします。

  • <app name>
  • <アプリケーション名>

Name of the application you are accessing from. It is registered and checked in the pandorafms audit to check the access status of users in the application.

アクセスするアプリケーションの名前。これは Pandora FMS 監査で登録およびチェックされ、アプリケーション内のユーザのアクセス状況をチェックします。

  • <管理者アクセスのみ>

Forbids the access to non-administrator users.

非管理者ユーザのアクセスを禁止します。

例 (適応環境が必要)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=access_process&other=1%7Clogin%7C192.168.50.25%7Cexternal_app%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set create_event_response

Creates a new event response.

新たなイベント応答を作成します。

Call syntax:

  • op=set (required)
  • op2=create_event_response (required)
  • return_type=csv|json (required)
  • other=<serialized parameters> (all required). In this order
  • <name>
  • <description>
  • <target> If the forth parameter (<type>) is command, here it is necessary to indicate the wanted command to execute the response to the event. On the other hand, if it is url, you must indicate the URL you want to access as a response to the event.
  • <type> command or url.
  • <group id> The user must have permissions over the indicated group.
  • <modal window width> In pixels.
  • <modal window height> In pixels.
  • <new window> 1 or 0. Indicates if the URL is show on a new window (1) or on a modal window (0).
  • <parameters> Parameters that complement the execution of the command.
  • <server> Id of the server in which the command is wanted to be executed. For the local console, the value is 0.

書式:

  • op=set (必須)
  • op2=create_event_response (必須)
  • return_type=csv|json (必須)
  • other=<連続パラメータ> (以下の順番ですべて必須)
  • <名前>
  • <説明>
  • <対象> 4つ目のパラメータ (<タイプ>) が command の場合、ここでは、イベントへの応答を実行するために必要なコマンドを指定する必要があります。一方、url の場合は、イベントへの応答としてアクセスしたい URL を指定する必要があります。
  • <タイプ> command または url.
  • <グループID> 指定したグループに対してユーザがアクセス権を持っている必要があります。
  • <モーダルウインドウの幅> ピクセル単位。
  • <モーダルウインドウの高さ> ピクセル単位。
  • <新規ウインドウ> 1 または 0。 URL を新規ウインドウで表示する(1)か、モーダルウインドウで表示する(0)かを指定します。
  • <パラメータ> コマンドの実行を補完するパラメータ。
  • <サーバ> コマンドを実行するサーバの ID。ローカルコンソールの場合、値は 0 です。
http://localhost/pandora_console/include/api.php?op=set&op2=create_event_response&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set update_event_response

Edits an existing event response. The user must have permissions on the group to which the response belongs in order to edit it.

既存のイベント応答を編集します。イベント応答の編集にはそれが所属するグループにユーザがアクセスできる権限を持っている必要があります。

Call syntax:

  • op=set (required)
  • op2=update_event_response (required)
  • return_type=csv|json (required)
  • id=<id of event response> (required)
  • other=<serialized parameters> (optional). In this order
  • <name>
  • <description>
  • <target> If the fourth parameter (<type>) is command, here you have to indicate the command that you want to execute the response to the event. On the other hand, if it is url, you must indicate the URL you want to access as a response to the event.
  • <type> command or url.
  • <group id> The user must have permissions on the indicated group.
  • <modal window width> In pixels.
  • <modal window height> In pixels.
  • <new window> 1 or 0. Indicates whether the URL is displayed in a new window (1) or on a modal window (0).
  • <parameters> Parameters that complement the command's execution.
  • <server> Id of the server where the command is wished to be executed. For the local console the value is 0.

書式:

  • op=set (必須)
  • op2=update_event_response (必須)
  • return_type=csv|json (必須)
  • id=<id of event response> (必須)
  • other=<serialized parameters> (以下の順番でオプション)
  • <名前>
  • <説明>
  • <対象> 4つ目のパラメータ (<タイプ>) が command の場合、ここでは、イベントへの応答を実行するために必要なコマンドを指定する必要があります。一方、url の場合は、イベントへの応答としてアクセスしたい URL を指定する必要があります。
  • <タイプ> command または url.
  • <グループID> 指定したグループに対してユーザがアクセス権を持っている必要があります。
  • <モーダルウインドウの幅> ピクセル単位。
  • <モーダルウインドウの高さ> ピクセル単位。
  • <新規ウインドウ> 1 または 0。 URL を新規ウインドウで表示する(1)か、モーダルウインドウで表示する(0)かを指定します。
  • <パラメータ> コマンドの実行を補完するパラメータ。
  • <サーバ> コマンドを実行するサーバの ID。ローカルコンソールの場合、値は 0 です。
http://localhost/pandora_console/include/api.php?op=set&op2=update_event_response&id=7&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set delete_event_response

Deletes an event response. The user must have permissions on the group to which the response belongs in order to delete it.

イベント応答を削除します。イベント応答の削除にはそれが所属するグループにユーザがアクセスできる権限を持っている必要があります。

Call syntax:

  • op=set (required)
  • op2=delete_event_reponse (required)
  • return_type=csv|json
  • id=<event response id> (required)

書式:

  • op=set (必須)
  • op2=delete_event_reponse (必須)
  • return_type=csv|json
  • id=<イベント応答ID> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=delete_event_response&id=7&apipass=1234&user=admin&pass=pandora

set create_user_profile_info

Creates a new user profile.

新たなユーザプロファイルを作成します。

Call syntax:

  • op=set (required)
  • op2=create_user_profile_info (required)
  • return_type=csv|json (required)
  • other=<serialized parameters> In this order
  • <name> (required)
  • <access bits>: 1 if bit is to be set and 0 if not. They are not required but if no value is specified the bit will be marked as not active. In this order:

IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.

書式:

  • op=set (必須)
  • op2=create_user_profile_info (必須)
  • return_type=csv|json (必須)
  • other=<連続パラメータ> 以下の順番にて
  • <名前> (必須)
  • <アクセスピット>: 設定する場合は 1、しない場合は 0。必須ではありませんが設定しない場合は 0 と同じです。順番は次の通りです。

IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.

Info.png

To know which permissions we should activate, visit the following link.


Info.png

どの権限を有効化すべきかは、 こちらを参照してください。


This example creates a profile that gives a read-only access to Pandora, that is, it is the same as the predefined profile Operator (read).

この例では、Pandora にリードオンリーのプロファイルを作成します。初期設定済の Operator (read) のプロファイルと同じです。

http://localhost/pandora_console/include/api.php?op=set&op2=create_user_profile_info&return_type=json&other=API_profile%7C1%7C0%7C0%7C1%7C0%7C0%7C0%7C0%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set update_user_profile_info

Updates new existing user profile.

既存のユーザプロファイルを更新します。

Call syntax:

  • op=set (required)
  • op2=update_user_profile_info (required)
  • other=<serialized parameters> (all optional) in this order
  • <name>
  • <access bits>: 1 if you want to set the bit and 0 if you want to disable it. If no value is specified, it will not change. In this order:

IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.

書式:

  • op=set (必須)
  • op2=update_user_profile_info (必須)
  • other=<serialized parameters> (オプション) 以下の順番にて
  • <名前>
  • <アクセスビット>: 設定する場合は 1、しない場合は 0。値を指定しなかった場合は変更されません。順番は次の通りです。

IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.

Info.png

To know which permissions we should activate, visit the following link.


Info.png

どの権限を有効化すべきかは、 こちらを参照してください。


In this example we change the name of the profile with ID 6 to API_profile_updated and we give all the permissions (read, write and management) related to agents and we remove the permission to read events.

以下の例では、API_profile_updated という名前の ID 6 のプロファイルに対して、エージェントに関してすべての権限(参照、書き込み、管理)を与えています。また、イベントの参照権限を削除しています。

http://localhost/pandora_console/include/api.php?op=set&op2=update_user_profile_info&return_type=json&id=6&other=API_profile_updated%7C%7C%7C%7C1%7C1%7C1%7C%7C%7C%7C%7C0%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set delete_user_profile_info

Deletes a user profile. It also deletes all assignments from that profile to any user.

ユーザプロファイルを削除します。また該当のプロファイルのユーザへの割り当ても削除します。

Call syntax:

  • op=set (required)
  • op2=delete_user_profile_info (required)
  • return_type=csv|json
  • id=<id del perfil> (required)

書式:

  • op=set (必須)
  • op2=delete_user_profile_info (必須)
  • return_type=csv|json
  • id=<削除するプロファイルID> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_profile_info&return_type=json&id=8&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set create_event_filter

Creates an event filter.

イベントフィルタを作成します。

Call syntax:

  • op=set (required)
  • op2=create_event_filter (required)
  • other=<serialized parameters>. In this order:
  • <id_group_filter>
  • <id_group>
  • <event_type [new_agent|alert_recovered|alert_ceased|alert_fired|configuration_change|error|alert_manual_valdation|critical|normal|warning|not_normal|recon_host_detected|system|unknown|going_unknown]>
  • <severity [0|1|2|3|4|5|6|20|21|34]> (0: Maintenance, 1: Informative, 2: Normal, 3: Warning, 4: Critical, 5: Minor, 6: Principal, 20: Not normal, 21: Critical/Normal, 34: Warning/Critical)
  • <event_status [2|3|0|1]> (0: Only new, 1: only validated, 2: only in process, 3: only not validated)
  • <free_search>
  • <agent_id>
  • <pagination_size [25|50|100|200|500]>
  • <max_hours_old>
  • <id_user_ack>
  • <duplicate [0|1]> (0: All the events, 1: grouped events)
  • <date_from> (format: AAAA/MM/DD)
  • <date_to> (format: AAAA/MM/DD)
  • <events_with_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <events_without_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <alert_events [0|1]> (0: filter by event aletrs, 1: Alert events only)
  • <module_id>
  • <source>
  • <id_extra>
  • <user_comment>

書式:

  • op=set (必須)
  • op2=create_event_filter (必須)
  • other=<連続パラメータ> 以下の順番:
  • <id_group_filter>
  • <id_group>
  • <event_type [new_agent|alert_recovered|alert_ceased|alert_fired|configuration_change|error|alert_manual_valdation|critical|normal|warning|not_normal|recon_host_detected|system|unknown|going_unknown]>
  • <severity [0|1|2|3|4|5|6|20|21|34]> (0: Maintenance, 1: Informative, 2: Normal, 3: Warning, 4: Critical, 5: Minor, 6: Principal, 20: Not normal, 21: Critical/Normal, 34: Warning/Critical)
  • <event_status [2|3|0|1]> (0: Only new, 1: only validated, 2: only in process, 3: only not validated)
  • <free_search>
  • <agent_id>
  • <pagination_size [25|50|100|200|500]>
  • <max_hours_old>
  • <id_user_ack>
  • <duplicate [0|1]> (0: All the events, 1: grouped events)
  • <date_from> (format: AAAA/MM/DD)
  • <date_to> (format: AAAA/MM/DD)
  • <events_with_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <events_without_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <alert_events [0|1]> (0: filter by event aletrs, 1: Alert events only)
  • <module_id>
  • <source>
  • <id_extra>
  • <user_comment>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event_filter&id=test&other=%7C%7Cerror%7C4%7C%7C%7C1%7C%7C12%7C%7C%7C2018-12-09%7C2018-12-13%7C[%226%22]%7C[%2210%22,%226%22,%223%22]%7C1%7C10%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set update_event_filter

Updates an event filter.

イベントフィルタを更新します。

Call syntax:

  • op=set (required)
  • op2=update_event_filter (required)
  • id=<event_filter_id> (required) must be an existing event filter id.
  • other=<serialized parameters> (optional). In this order
  • <id_group_filter>
  • <id_group>
  • <event_type [new_agent|alert_recovered|alert_ceased|alert_fired|configuration_change|error|alert_manual_valdation|critical|normal|warning|not_normal|recon_host_detected|system|unknown|going_unknown]>
  • <severity [0|1|2|3|4|5|6|20|21|34]> (0: Maintenance, 1: Informative, 2: Normal, 3: Warning, 4: Critical, 5: Minor, 6: Principal, 20: Not normal, 21: Critical/Normal, 34: Warning/Critical)
  • <event_status [2|3|0|1]> (0: new only, 1: validated only, 2: in process only, 3: not validated only)
  • <free_search>
  • <agent_id>
  • <pagination_size [25|50|100|200|500]>
  • <max_hours_old>
  • <id_user_ack>
  • <duplicate [0|1]> (0: all events, 1: grouped events)
  • <date_from> (format: AAAA/MM/DD)
  • <date_to> (format: AAAA/MM/DD)
  • <events_with_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <events_without_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <alert_events [0|1]> (0: filter by alert events, 1: alert events only)
  • <module_id>
  • <source>
  • <id_extra>
  • <user_comment>

書式:

  • op=set (必須)
  • op2=update_event_filter (必須)
  • id=<event_filter_id> (必須) 存在するイベントフィルタ ID でなければいけません。
  • other=<連続パラメータ> (オプション) 以下の順番:
  • <id_group_filter>
  • <id_group>
  • <event_type [new_agent|alert_recovered|alert_ceased|alert_fired|configuration_change|error|alert_manual_valdation|critical|normal|warning|not_normal|recon_host_detected|system|unknown|going_unknown]>
  • <severity [0|1|2|3|4|5|6|20|21|34]> (0: Maintenance, 1: Informative, 2: Normal, 3: Warning, 4: Critical, 5: Minor, 6: Principal, 20: Not normal, 21: Critical/Normal, 34: Warning/Critical)
  • <event_status [2|3|0|1]> (0: new only, 1: validated only, 2: in process only, 3: not validated only)
  • <free_search>
  • <agent_id>
  • <pagination_size [25|50|100|200|500]>
  • <max_hours_old>
  • <id_user_ack>
  • <duplicate [0|1]> (0: all events, 1: grouped events)
  • <date_from> (format: AAAA/MM/DD)
  • <date_to> (format: AAAA/MM/DD)
  • <events_with_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <events_without_tags> (format: ["tag_id_1", "tag_id_2", "tag_id_3", "..."])
  • <alert_events [0|1]> (0: filter by alert events, 1: alert events only)
  • <module_id>
  • <source>
  • <id_extra>
  • <user_comment>
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_event_filter&id=195&other=new_name%7C%7C%7Calert_recovered%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set delete_event_filter

Deletes an event filter.

イベントフィルタを削除します。

Call syntax:

  • op=set (required)
  • op2=delete_event_filter (required)
  • id=<event_filter_id> (required) must be an existing event filter id.

書式:

  • op=set (必須)
  • op2=delete_event_filter (必須)
  • id=<event_filter_id> (必須) 存在するイベントフィルタ ID でなければいけません。
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_event_filter&id=38&apipass=1234&user=admin&pass=pandora

set create_inventory_module

Creates a new inventory module.

新たなインベントリモジュールを作成します。

Call syntax:

  • op=set (required)
  • op2=create_inventory_module (required)
  • return_type=csv|json
  • other=<serialized parameters> In this order
  • <name> (required)
  • <description>: (required, but can be empty)
  • <operation system id>: (required). Numerical Id of the table tconfig_os.
  • <interpreter>: (required, but can be empty). If the interpreter is empty, it is interpreted as just a local inventory module.
  • < code >: (required, but can be empty) Script that has to be executed to obtain the inventory data. Must be in base64.
  • < data format >: (required) Header of the extracted data (separated by ;).
  • <block mode>: (required) 1 or 0.

書式:

  • op=set (必須)
  • op2=create_inventory_module (必須)
  • return_type=csv|json
  • other=<連続パラメータ> 以下の順番
  • <name> (必須)
  • <description>: (必須ですが空でも可)
  • <operation system id>: (必須) tconfig_os テーブルの数値 ID です。
  • <interpreter>: (必須ですが空でも可) 空の場合、ローカルインベントリモジュールとして解釈されます。
  • < code >: (必須ですが空でも可) インベントリデータを取得するために実行される スクリプトです。base64 エンコードされている必要があります。
  • < data format >: (必須) 展開されるデータのヘッダーです。(; で区切られます)
  • <block mode>: (必須) 1 または 0

This example creates an inventory module called OS that collects the kernel-name and nodename data from a Linux system.

この例では、Linux システムから kernel-name および nodename というデータを収集する OS というインベントリモジュールを作成します。

http://localhost/pandora_console/include/api.php?op=set&op2=create_inventory_module&return_type=json&other=OS%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set update_inventory_module

Updates an inventory module.

インベントリモジュールを更新します。

Call syntax:

  • op=set (required)
  • op2=update_inventory_module (required)
  • id= inventory module ID (required)
  • return_type=csv|json
  • other=<serialized parameters> In this order
  • <name> (required)
  • <description>: (required, but can be empty)
  • <operation system id>: (required). Numerical Id of the table tconfig_os.
  • <interpreter>: (required, but can be empty). If the interpreter is empty, it is interpreted as just a local inventory module.
  • < code >: (required, but can be empty) Script that has to be executed to obtain the inventory data. Must be in base64.
  • < data format >: (required) Header of the extracted data (separated by ;).
  • <block mode>: (required) 1 or 0.

書式:

  • op=set (必須)
  • op2=update_inventory_module (必須)
  • id= inventory module ID (必須)
  • return_type=csv|json
  • other=<連続パラメータ> 以下の順番
  • <name> (必須)
  • <description>: (必須ですが空でも可)
  • <operation system id>: (必須) tconfig_os テーブルの数値 ID です。
  • <interpreter>: (必須ですが空でも可) 空の場合、ローカルインベントリモジュールとして解釈されます。
  • < code >: (必須ですが空でも可) インベントリデータを取得するために実行される スクリプトです。base64 エンコードされている必要があります。
  • < data format >: (必須) 展開されるデータのヘッダーです。(; で区切られます)
  • <block mode>: (必須) 1 または 0
http://localhost/pandora_console/include/api.php?op=set&op2=update_inventory_module&return_type=json&id=42&other=OS_easy%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set delete_inventory_module

Deletes a user profile. It also deletes all assignments from that profile to any user.

インベントリモジュールを削除します。

Call syntax:

  • op=set (required)
  • op2=delete_inventory_module (required)
  • return_type=csv|json
  • id=<inventory module ID> (required)

書式:

  • op=set (必須)
  • op2=delete_inventory_module (必須)
  • return_type=csv|json
  • id=<inventory module ID> (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=delete_inventory_module&return_type=json&id=42&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

set create_collection

Creates a collection.

コレクションを作成します。

Call syntax:

  • op=set (required)
  • op2=create_collection (required)
  • other=<serialized values> (required) Serialized values to create the collection
  • <name>
  • <short_name>
  • <id_group>
  • <description>

It is necessary to accompany it with 'other_mode' as follows: other_mode=url_encode_separator_<separator> to pass the separator of the serialized values of other.

書式:

  • op=set (必須)
  • op2=create_collection (必須)
  • other=<連続パラメータ> (必須) コレクションを作成するための連続パラメータ
  • <name>
  • <short_name>
  • <id_group>
  • <description>

連続パラメータのセパレータを渡すために、次のように 'other_mode' が必要です: other_mode=url_encode_separator_<separator>

http://localhost/pandora_console/include/api.php?op=set&op2=create_collection&other=test_plugin|test_p|0|test&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

set delete_collection

Eliminates a collection.

コレクションを削除します。

Call syntax:

  • op=set (required)
  • op2=delete_collection (required)
  • id= id_collection (required)

書式:

  • op=set (必須)
  • op2=delete_collection (必須)
  • id= id_collection (必須)
http://localhost/pandora_console/include/api.php?op=set&op2=delete_collection&id=15&apipass=1234&user=admin&pass=pandora

Several examples in several languages about to call Pandora API.

Pandora API を呼び出すためのいくつかの言語での例です。

http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc

PHP

<?php
$ip = '192.168.70.110';
$pandora_url = '/pandora5';
$apipass = '1234';
$user = 'admin';
$password = 'pandora';
$op = 'get';
$op2 = 'all_agents';
$return_type = 'csv';
$other = '';
$other_mode = '';

$url = "http://" . $ip . $pandora_url . "/include/api.php";

$url .= "?";
$url .= "apipass=" . $apipass;
$url .= "&user=" . $user;
$url .= "&pass=" . $password;
$url .= "&op=" . $op;
$url .= "&op2=" . $op2;
if ($id !== '') {
	$url .= "&id=" . $id;
}
if ($id2 !== '') {
	$url .= "&id2=" . $id2;
}
if ($return_type !== '') {
	$url .= "&return_type=" . $return_type;
}
if ($other !== '') {
	$url .= "&other_mode=" . $other_mode;
	$url .= "&other=" . $other;
}

$curlObj = curl_init();
curl_setopt($curlObj, CURLOPT_URL, $url);
curl_setopt($curlObj, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($curlObj);
curl_close($curlObj);

$agents = array();
if (!empty($result)) {
	$lines = explode("\n", $result);
	foreach ($lines as $line) {
		$fields = explode(";", $line);
		
		$agent = array();
		$agent['id_agent'] = $fields[0];
		$agent['name'] = $fields[1];
		$agent['ip'] = $fields[2];
		$agent['description'] = $fields[3];
		$agent['os_name'] = $fields[4];
		$agent['url_address'] = $fields[5];
		
		$agents[] = $agent;
	}
}

print_list_agents($agents);

function print_list_agents($agents) {
	echo "<table border='1' style='empty-cells: show;'>";
	
	echo "<thead>";
	echo "<tr>";
	echo "<th>" . "ID" . "</th>";
	echo "<th>" . "Name" . "</th>";
	echo "<th>" . "IP" . "</th>";
	echo "<th>" . "Description" . "</th>";
	echo "<th>" . "OS" . "</th>";
	echo "<th>" . "URL" . "</th>";
	echo "</tr>";
	echo "</thead>";
	
	foreach ($agents as $agent) {
		echo "<tr>";
		echo "<td>" . $agent['id_agent'] . "</td>";
		echo "<td>" . $agent['name'] . "</td>";
		echo "<td>" . $agent['ip'] . "</td>";
		echo "<td>" . $agent['description'] . "</td>";
		echo "<td>" . $agent['os_name'] . "</td>";
		echo "<td>" . $agent['url_address'] . "</td>";
		echo "</tr>";
	}
	echo "</table>";
}
?>

Python

import pycurl
import cStringIO
import pprint

def main():
	ip = '192.168.70.110'
	pandora_url = '/pandora5'
	apipass = '1234'
	user = 'admin'
	password = 'pandora'
	op = 'get'
	op2 = 'all_agents'
	return_type = 'csv'
	other = ''
	other_mode = ''
	
	url = "http://" + ip  + pandora_url + "/include/api.php"
	
	url += "?"
	url += "apipass=" + apipass
	url += "&user="  + user
	url += "&pass=" + password
	url += "&op=" + op
	url += "&op2=" + op2
	
	buf = cStringIO.StringIO()
	
	c = pycurl.Curl()
	c.setopt(c.URL, url)
	c.setopt(c.WRITEFUNCTION, buf.write)
	c.perform()
	
	output = buf.getvalue()
	buf.close()
	
	lines = output.split("\n")
	agents = []
	for line in lines:
		if not line:
			continue
		
		fields = line.split(";")
		agent = {}
		agent['id_agent'] = fields[0]
		agent['name'] = fields[1]
		agent['ip'] = fields[2]
		agent['description'] = fields[3]
		agent['os_name'] = fields[4]
		agent['url_address'] = fields[5]
		
		agents.append(agent)
	
	for agent in agents:
		print("---- Agent #" + agent['id_agent'] + " ----")
		print("Name: " + agent['name'])
		print("IP: " + agent['ip'])
		print("Description: " + agent['description'])
		print("OS: " + agent['os_name'])
		print("URL: " + agent['url_address'])
		print("")

if __name__ == "__main__":
    main()


Perl

use strict;
use warnings;
use WWW::Curl::Easy;

sub write_callback { 
	my ($chunk,$variable) = @_; 
	
	push @{$variable}, $chunk; 
	return length($chunk);
}

my $ip = '192.168.70.110';
my $pandora_url = '/pandora5';
my $apipass = '1234';
my $user = 'admin';
my $password = 'pandora';
my $op = 'get';
my $op2 = 'all_agents';
my $return_type = 'csv';
my $other = '';
my $other_mode = '';

my $url = "http://" . $ip  . $pandora_url . "/include/api.php";
$url .= "?";
$url .= "apipass=" . $apipass;
$url .= "&user=" . $user;
$url .= "&pass=" . $password;
$url .= "&op=" . $op;
$url .= "&op2=" . $op2;

my @body; 

my $curl = WWW::Curl::Easy->new;
$curl->setopt(CURLOPT_URL, $url);
$curl->setopt(CURLOPT_WRITEFUNCTION, \&write_callback);
$curl->setopt(CURLOPT_FILE, \@body); 
$curl->perform();

my $body=join("",@body); 
my @lines = split("\n", $body);

foreach my $line (@lines) {
	my @fields = split(';', $line);
	
	print("\n---- Agent #" . $fields[0] . " ----");
	print("\nName: " .  $fields[1]);
	print("\nIP: " .  $fields[2]);
	print("\nDescription: " . $fields[3]);
	print("\nOS: "  . $fields[4]);
	print("\n");
}

Ruby

require 'open-uri'

ip = '192.168.70.110'
pandora_url = '/pandora5'
apipass = '1234'
user = 'admin'
password = 'pandora'
op = 'get'
op2 = 'all_agents'
return_type = 'csv'
other = ''
other_mode = ''

url = "http://" + ip  + pandora_url + "/include/api.php"

url += "?"
url += "apipass=" + apipass
url += "&user="  + user
url += "&pass=" + password
url += "&op=" + op
url += "&op2=" + op2

agents = []

open(url) do |content|
	
	content.each do |line|
		agent = {}
		
		tokens = line.split(";")
		
		agent[:id_agent] = tokens[0]
		agent[:name] = tokens[1]
		agent[:ip] = tokens[2]
		agent[:description] = tokens[3]
		agent[:os_name] = tokens[4]
		agent[:url_address] = tokens[5]
		
		agents.push agent
	end
end


agents.each do |agent|
	print("---- Agent #" + (agent[:id_agent] || "") + " ----\n")
	print("Name: " + (agent[:name] || "") + "\n")
	print("IP: " + (agent[:ip] || "") + "\n")
	print("Description: " + (agent[:description] || "") + "\n")
	print("OS: " + (agent[:os_name] || "") + "\n")
	print("URL: " + (agent[:url_address] || "") + "\n")
	print("\n")
end

Lua

require("curl")

local content = "" 

function WriteMemoryCallback(s) 
	content = content .. s
	
	return string.len(s)
end

ip = '192.168.70.110'
pandora_url = '/pandora5'
apipass = '1234'
user = 'admin'
password = 'pandora'
op = 'get'
op2 = 'all_agents'
return_type = 'csv'
other = ''
other_mode = ''

url = "http://" .. ip  .. pandora_url .. "/include/api.php"

url = url .. "?"
url = url .. "apipass=" .. apipass
url = url .. "&user=" .. user
url = url .. "&pass=" .. password
url = url .. "&op=" .. op
url = url .. "&op2=" .. op2

if curl.new then c = curl.new() else c = curl.easy_init() end

c:setopt(curl.OPT_URL, url)
c:setopt(curl.OPT_WRITEFUNCTION, WriteMemoryCallback)

c:perform()

for line in string.gmatch(content, "[^\n]+") do
	line = string.gsub(line, "\n", "")
	
	count = 0
	for field in string.gmatch(line, "[^\;]+") do
		if count == 0 then
			print("---- Agent #" .. field .. " ----")
		end
		if count == 1 then
			print("Name: " .. field)
		end
		if count == 2 then
			print("IP: " .. field)
		end
		if count == 3 then
			print("Description: " .. field)
		end
		if count == 4 then
			print("OS: " .. field)
		end
		if count == 5 then
			print("URL: " .. field)
		end
		
		count = count + 1
	end
	print("")
end

Brainfuck

[-]>[-]<
>+++++++++[<+++++++++>-]<-.
>+++++[<+++++>-]<----.
>++++[<++++>-]<---.
>++++[<---->-]<++.
>+++[<+++>-]<++.
-.
>++++++++[<-------->-]<--.
>+++[<--->-]<---.
>++++++++[<++++++++>-]<++++.
+.
>++++++++[<-------->-]<-----.
>+++++++++[<+++++++++>-]<----.
++.
--.
>+++[<--->-]<+.
>+++[<+++>-]<.
>++[<++>-]<++.
>++[<-->-]<-.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<---.
+.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<+++.
>++++[<---->-]<+.
>+++[<+++>-]<.
>+++[<--->-]<++.
>+++[<+++>-]<-.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<+++.
>+++[<--->-]<--.
----.
>+++[<+++>-]<-.
+++.
-.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<-.
>++++[<---->-]<+.
>++++[<++++>-]<+.
>++++[<---->-]<-.
>++++++++[<-------->-]<-.
>++++++++[<++++++++>-]<++++++++.
>+++[<--->-]<++.
++.
++.
>++++[<++++>-]<---.
>++[<-->-]<--.
+++.
>++++++++[<-------->-]<---.
>+++[<--->-]<---.
>+++++++++[<+++++++++>-]<-.
>+++[<--->-]<--.
>++++[<++++>-]<---.
---.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<+++++.
>+++++[<----->-]<++++.
>+++[<+++>-]<++.
>+++[<--->-]<++.
>++++++++[<-------->-]<-----.
>+++++++++[<+++++++++>-]<----.
>+++[<+++>-]<-.
>++++[<---->-]<--.
>++[<++>-]<+.
>+++[<+++>-]<--.
++++.
>+++++++++[<--------->-]<--.
>++++++++[<++++++++>-]<++++++.
>+++[<+++>-]<+++.
>+++[<--->-]<.
++.
--.
>+++[<+++>-]<--.
>++[<++>-]<+.
>+++[<--->-]<++.
>++[<++>-]<++.
>++[<-->-]<-.
++++.
>++++++++[<-------->-]<-----.

Java (Android)

Please you can see our project (Pandora Event Viewer) in Pandroid Event Viewer source code in SourceForge SVN repository but this is piece of code for get the data of events across the API.

SourceForge の SVN リポジトリ内の Pandroid イベントビューワーソースコード より、我々のプロジェクト(Pandora Event Viwer)を参照すると、API を通してイベントデータを取得する部分のコードがあります。

/**
	 * Performs an http get petition.
	 * 
	 * @param context
	 *            Application context.
	 * @param additionalParameters
	 *            Petition additional parameters
	 * @return Petition result.
	 * @throws IOException
	 *             If there is any problem with the connection.
	 */
	public static String httpGet(Context context,
			List<NameValuePair> additionalParameters) throws IOException {
		SharedPreferences preferences = context.getSharedPreferences(
				context.getString(R.string.const_string_preferences),
				Activity.MODE_PRIVATE);

		String url = preferences.getString("url", "") + "/include/api.php";
		String user = preferences.getString("user", "");
		String password = preferences.getString("password", "");
		String apiPassword = preferences.getString("api_password", "");
		if (url.length() == 0 || user.length() == 0) {
			return "";
		}
		ArrayList<NameValuePair> parameters = new ArrayList<NameValuePair>();
		parameters.add(new BasicNameValuePair("user", user));
		parameters.add(new BasicNameValuePair("pass", password));
		if (apiPassword.length() > 0) {
			parameters.add(new BasicNameValuePair("apipass", apiPassword));
		}
		parameters.addAll(additionalParameters);
		Log.i(TAG, "sent: " + url);
		if (url.toLowerCase().contains("https")) {
			// Secure connection
			return Core.httpsGet(url, parameters);
		} else {
			HttpParams params = new BasicHttpParams();
			HttpConnectionParams.setConnectionTimeout(params,
					CONNECTION_TIMEOUT);
			HttpConnectionParams.setSoTimeout(params, CONNECTION_TIMEOUT);
			DefaultHttpClient httpClient = new DefaultHttpClient(params);
			UrlEncodedFormEntity entity;
			HttpPost httpPost;
			HttpResponse response;
			HttpEntity entityResponse;
			String return_api;
			httpPost = new HttpPost(url);
			entity = new UrlEncodedFormEntity(parameters);
			httpPost.setEntity(entity);
			response = httpClient.execute(httpPost);
			entityResponse = response.getEntity();
			return_api = Core
					.convertStreamToString(entityResponse.getContent());
			Log.i(TAG, "received: " + return_api);
			return return_api;
		}
	}

API.php の今後

Some ideas for the future of api.php are:

今後の api.php では次のようなことを考えています。

  • Increase the API calls group.
  • APIの追加
  • Return and get values in xml, jason...
  • xml や jason 等でのデータの取得
  • Increase the call security for insecure environments.
  • セキュアではない環境向けのセキュリティ強化
  • Improve the code to do it customizable same as with extensions.
  • 拡張と同じようにカスタマイズできるようにする改善
  • Integrate with third tools standards.
  • 他のツール標準との統合