差分
このページの2つのバージョン間の差分を表示します。
両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン | ||
ja:documentation:pandorafms:technical_reference:12_disco_development [2025/09/12 22:46] – [config_steps ブロック] junichi | ja:documentation:pandorafms:technical_reference:12_disco_development [2025/09/12 23:01] (現在) – [CUSTOM_FIELDS ブロック] junichi | ||
---|---|---|---|
行 217: | 行 217: | ||
* **exec**: | * **exec**: | ||
- | | + | |
* Defines the format of the executions that the Pandora FMS server must perform for the plugin tasks. | * Defines the format of the executions that the Pandora FMS server must perform for the plugin tasks. | ||
* This parameter is an **array** whose keys will be positional, that is, they can be indicated with numbers or not indicated. | * This parameter is an **array** whose keys will be positional, that is, they can be indicated with numbers or not indicated. | ||
行 353: | 行 353: | ||
[discovery_extension_definition] | [discovery_extension_definition] | ||
- | ; Mandatory | + | ; Required |
; Defines discovery application short name | ; Defines discovery application short name | ||
; Short name must be unique | ; Short name must be unique | ||
行 360: | 行 360: | ||
short_name = DISCOVERY_APPLICATION_UNIQUE_NAME | short_name = DISCOVERY_APPLICATION_UNIQUE_NAME | ||
- | ; Mandatory | + | ; Required |
; Defines the section where application will be shown in console | ; Defines the section where application will be shown in console | ||
; Possible values: | ; Possible values: | ||
行 369: | 行 369: | ||
section = app | section = app | ||
- | ; Mandatory | + | ; Required |
; Defines discovery application name, shown in console | ; Defines discovery application name, shown in console | ||
name = DISCOVERY_APPLICATION_NAME | name = DISCOVERY_APPLICATION_NAME | ||
- | ; Mandatory | + | ; Required |
; Defines discovery application version, shown in console | ; Defines discovery application version, shown in console | ||
行 390: | 行 390: | ||
execution_file[_EXEC_MACRO_N_] = SCRIPT.pl | execution_file[_EXEC_MACRO_N_] = SCRIPT.pl | ||
- | ; Mandatory | + | ; Required |
; Defines execution for discovery server | ; Defines execution for discovery server | ||
; Several executions can be defined | ; Several executions can be defined | ||
行 673: | 行 673: | ||
* **file**: | * **file**: | ||
- | | + | |
* Defines the contents for temporary configuration files that can be used during the executions of the Pandora FMS server and console. | * Defines the contents for temporary configuration files that can be used during the executions of the Pandora FMS server and console. | ||
* This parameter is an **array** whose keys will be **valid macros** that will be used to indicate the use of temporary files in the plugin. | * This parameter is an **array** whose keys will be **valid macros** that will be used to indicate the use of temporary files in the plugin. | ||
行 705: | 行 705: | ||
[tempfile_confs] | [tempfile_confs] | ||
- | ; Mandatory | + | ; Required |
; Defines the content for the temporary file | ; Defines the content for the temporary file | ||
; File will be used where temporary file macro is specified during executions | ; File will be used where temporary file macro is specified during executions | ||
行 737: | 行 737: | ||
* **macro**: | * **macro**: | ||
- | | + | |
* Defines the macros in which the task configuration values will be stored. | * Defines the macros in which the task configuration values will be stored. | ||
- | * **mandatory_field**: | + | * **required_field**: |
* Optional. | * Optional. | ||
- | * Defines by means of **BOOL** type values if the configuration field of the form must have a mandatory | + | * Defines by means of **BOOL** type values if the configuration field of the form must have a required |
* The keys used must exist in the **macro** array of this block. | * The keys used must exist in the **macro** array of this block. | ||
* By default all fields are required. | * By default all fields are required. | ||
- | * Even though they are mandatory, the **multiselect** and **tree** type fields admit that elements cannot be selected. | + | * Even though they are required, the **multiselect** and **tree** type fields admit that elements cannot be selected. |
* **name**: | * **name**: | ||
- | | + | |
* Defines the names of the form configuration fields. | * Defines the names of the form configuration fields. | ||
* The keys used must exist in the **macro** array of this block. | * The keys used must exist in the **macro** array of this block. | ||
行 754: | 行 754: | ||
* The keys used must exist in the **macro** array of this block. | * The keys used must exist in the **macro** array of this block. | ||
* **type**: | * **type**: | ||
- | | + | |
* Defines the types of the form configuration fields. | * Defines the types of the form configuration fields. | ||
* The keys used must exist in the **macro** array of this block. | * The keys used must exist in the **macro** array of this block. | ||
行 808: | 行 808: | ||
* 必須。 | * 必須。 | ||
* タスク設定値が保存されるマクロを定義します。 | * タスク設定値が保存されるマクロを定義します。 | ||
- | * **mandatory_field**: | + | * **required_field**: |
* オプション。 | * オプション。 | ||
* フォームの設定フィールドに必須の値が必要かどうかを **BOOL** 型の値を使用して定義します。 | * フォームの設定フィールドに必須の値が必要かどうかを **BOOL** 型の値を使用して定義します。 | ||
行 918: | 行 918: | ||
name[4] = Max threads | name[4] = Max threads | ||
type[4] = number | type[4] = number | ||
- | mandatory_field[4] = false | + | required_field[4] = false |
macro[5] = _param5_ | macro[5] = _param5_ | ||
行 956: | 行 956: | ||
[CUSTOM_FIELDS_N] | [CUSTOM_FIELDS_N] | ||
- | ; Mandatory | + | ; Required |
; Defines configuration field unique macro | ; Defines configuration field unique macro | ||
; Macros can be used for script executions, using their value in place | ; Macros can be used for script executions, using their value in place | ||
行 963: | 行 963: | ||
; Optional | ; Optional | ||
- | ; Defines if configuration field is mandatory | + | ; Defines if configuration field is required |
- | ; By default all configuration fields are mandatory | + | ; By default all configuration fields are required |
- | mandatory_field[N] = BOOL | + | required_field[N] = BOOL |
- | ; Mandatory | + | ; Required |
; Defines configuration field name to be displayed in console | ; Defines configuration field name to be displayed in console | ||
; Macro will be used as name if this field is empty | ; Macro will be used as name if this field is empty | ||
行 979: | 行 979: | ||
tip[N] = FIELD_TIP | tip[N] = FIELD_TIP | ||
- | ; Mandatory | + | ; Required |
; Defines the field type to be displayed in console | ; Defines the field type to be displayed in console | ||
; Possible values: | ; Possible values: | ||
行 1009: | 行 1009: | ||
encrypt_on_true[N] = _FIELD_MACRO_N_ | encrypt_on_true[N] = _FIELD_MACRO_N_ | ||
- | ; Mandatory | + | ; Required |
; Defines select data to be displayed in console | ; Defines select data to be displayed in console | ||
; Possible values: | ; Possible values: | ||
行 1035: | 行 1035: | ||
select_data[N] = FIELD_DATA | select_data[N] = FIELD_DATA | ||
- | ; Mandatory | + | ; Required |
; Defines tree data to be displayed in console | ; Defines tree data to be displayed in console | ||
; tree fields value is a comma separated list of selected values | ; tree fields value is a comma separated list of selected values | ||
行 1050: | 行 1050: | ||
* **option**: | * **option**: | ||
- | | + | |
* Defines the options of a custom selector. | * Defines the options of a custom selector. | ||
* This parameter is an **array** whose keys are the values of the custom selector options, and its values are the texts displayed for each option in the custom selector. | * This parameter is an **array** whose keys are the values of the custom selector options, and its values are the texts displayed for each option in the custom selector. | ||
行 1083: | 行 1083: | ||
[CUSTOM_SELECT_N] | [CUSTOM_SELECT_N] | ||
- | ; Mandatory | + | ; Required |
; Defines the value-text pair for the select or multiselect | ; Defines the value-text pair for the select or multiselect | ||
; Several value-text pairs can be defined | ; Several value-text pairs can be defined | ||
行 1114: | 行 1114: | ||
* **name**: | * **name**: | ||
- | | + | |
* Defines the names of the different elements of this level of the tree. | * Defines the names of the different elements of this level of the tree. | ||
* **selectable**: | * **selectable**: | ||
行 1227: | 行 1227: | ||
[CUSTOM_TREE_DATA_N] | [CUSTOM_TREE_DATA_N] | ||
- | ; Mandatory | + | ; Required |
; Defines the name for the tree element | ; Defines the name for the tree element | ||
; Several names can be defined | ; Several names can be defined | ||
行 1250: | 行 1250: | ||
macro[N] = FIELD_MACRO_N | macro[N] = FIELD_MACRO_N | ||
- | ; Mandatory | + | ; Required |
; Defines the value for the tree element | ; Defines the value for the tree element | ||
; Several values can be defined | ; Several values can be defined | ||
行 1530: | 行 1530: | ||
; | ; | ||
- | ; Mandatory | + | ; Required |
; Defines global application data | ; Defines global application data | ||
[discovery_extension_definition] | [discovery_extension_definition] | ||
- | ; Mandatory | + | ; Required |
; Defines discovery application short name | ; Defines discovery application short name | ||
; Short name must be unique | ; Short name must be unique | ||
行 1542: | 行 1542: | ||
short_name = DISCOVERY_APPLICATION_UNIQUE_NAME | short_name = DISCOVERY_APPLICATION_UNIQUE_NAME | ||
- | ; Mandatory | + | ; Required |
; Defines the section where application will be shown in console | ; Defines the section where application will be shown in console | ||
; Possible values: | ; Possible values: | ||
行 1551: | 行 1551: | ||
section = app | section = app | ||
- | ; Mandatory | + | ; Required |
; Defines discovery application name, shown in console | ; Defines discovery application name, shown in console | ||
name = DISCOVERY_APPLICATION_NAME | name = DISCOVERY_APPLICATION_NAME | ||
- | ; Mandatory | + | ; Required |
; Defines discovery application version, shown in console | ; Defines discovery application version, shown in console | ||
行 1572: | 行 1572: | ||
execution_file[_EXEC_MACRO_N_] = SCRIPT.pl | execution_file[_EXEC_MACRO_N_] = SCRIPT.pl | ||
- | ; Mandatory | + | ; Required |
; Defines execution for discovery server | ; Defines execution for discovery server | ||
; Several executions can be defined | ; Several executions can be defined | ||
行 1629: | 行 1629: | ||
; Several steps can be defined using a different key (N) | ; Several steps can be defined using a different key (N) | ||
- | ; Mandatory | + | ; Required |
; Defines configuration step name | ; Defines configuration step name | ||
name[N] = STEP_NAME | name[N] = STEP_NAME | ||
- | ; Mandatory | + | ; Required |
; Defines configuration fields retrieved to console by a command execution | ; Defines configuration fields retrieved to console by a command execution | ||
; execution_file scripts can be used to retrieve data | ; execution_file scripts can be used to retrieve data | ||
行 1641: | 行 1641: | ||
; { | ; { | ||
; " | ; " | ||
- | ; "mandatory_field": " | + | ; "required_field": " |
; " | ; " | ||
; " | ; " | ||
行 1688: | 行 1688: | ||
script_data_fields[N] = CONSOLE_EXECUTION_FIELDS | script_data_fields[N] = CONSOLE_EXECUTION_FIELDS | ||
- | ; Mandatory | + | ; Required |
; Defines custom configuration fields | ; Defines custom configuration fields | ||
行 1700: | 行 1700: | ||
; | ; | ||
- | ; Mandatory | + | ; Required |
; Defines custom configuration fields to be used by configuration steps | ; Defines custom configuration fields to be used by configuration steps | ||
[CUSTOM_FIELDS_N] | [CUSTOM_FIELDS_N] | ||
- | ; Mandatory | + | ; Required |
; Defines configuration field unique macro | ; Defines configuration field unique macro | ||
; Macros can be used for script executions, using their value in place | ; Macros can be used for script executions, using their value in place | ||
行 1712: | 行 1712: | ||
; Optional | ; Optional | ||
- | ; Defines if configuration field is mandatory | + | ; Defines if configuration field is required |
- | ; By default all configuration fields are mandatory | + | ; By default all configuration fields are required |
- | mandatory_field[N] = BOOL | + | required_field[N] = BOOL |
- | ; Mandatory | + | ; Required |
; Defines configuration field name to be displayed in console | ; Defines configuration field name to be displayed in console | ||
; Macro will be used as name if this field is empty | ; Macro will be used as name if this field is empty | ||
行 1728: | 行 1728: | ||
tip[N] = FIELD_TIP | tip[N] = FIELD_TIP | ||
- | ; Mandatory | + | ; Required |
; Defines the field type to be displayed in console | ; Defines the field type to be displayed in console | ||
; Possible values: | ; Possible values: | ||
行 1758: | 行 1758: | ||
encrypt_on_true[N] = _FIELD_MACRO_N_ | encrypt_on_true[N] = _FIELD_MACRO_N_ | ||
- | ; Mandatory | + | ; Required |
; Defines select data to be displayed in console | ; Defines select data to be displayed in console | ||
; Possible values: | ; Possible values: | ||
行 1784: | 行 1784: | ||
select_data[N] = FIELD_DATA | select_data[N] = FIELD_DATA | ||
- | ; Mandatory | + | ; Required |
; Defines tree data to be displayed in console | ; Defines tree data to be displayed in console | ||
; tree fields value is a comma separated list of selected values | ; tree fields value is a comma separated list of selected values | ||
行 1792: | 行 1792: | ||
; | ; | ||
- | ; Mandatory | + | ; Required |
; Defines custom tree values to be used by configuration fields | ; Defines custom tree values to be used by configuration fields | ||
[CUSTOM_TREE_DATA_N] | [CUSTOM_TREE_DATA_N] | ||
- | ; Mandatory | + | ; Required |
; Defines the name for the tree element | ; Defines the name for the tree element | ||
; Several names can be defined | ; Several names can be defined | ||
行 1820: | 行 1820: | ||
macro[N] = FIELD_MACRO_N | macro[N] = FIELD_MACRO_N | ||
- | ; Mandatory | + | ; Required |
; Defines the value for the tree element | ; Defines the value for the tree element | ||
; Several values can be defined | ; Several values can be defined | ||
行 1835: | 行 1835: | ||
; | ; | ||
- | ; Mandatory | + | ; Required |
; Defines custom select or multiselect values to be used by configuration fields | ; Defines custom select or multiselect values to be used by configuration fields | ||
[CUSTOM_SELECT_N] | [CUSTOM_SELECT_N] | ||
- | ; Mandatory | + | ; Required |
; Defines the value-text pair for the select or multiselect | ; Defines the value-text pair for the select or multiselect | ||
; Several value-text pairs can be defined | ; Several value-text pairs can be defined | ||
行 1853: | 行 1853: | ||
[tempfile_confs] | [tempfile_confs] | ||
- | ; Mandatory | + | ; Required |
; Defines the content for the temporary file | ; Defines the content for the temporary file | ||
; File will be used where temporary file macro is specified during executions | ; File will be used where temporary file macro is specified during executions | ||
行 1942: | 行 1942: | ||
name[4] = Max threads | name[4] = Max threads | ||
type[4] = number | type[4] = number | ||
- | mandatory_field[4] = false | + | required_field[4] = false |
macro[5] = _param5_ | macro[5] = _param5_ |