Parameters in property files

The KXX_FCP_SCRIPT_DEFINITIONS directory contains a list of *.properties files. Each property file contains a list of scripts to run with respective properties in the form of key=value. The properties that can be defined (case-insensitive) are:

ATTRIBUTE_NAME

Required - string max 256 characters. A name of your choice that defines a specific script and its attributes. The characters that can be used for the ATTRIBUTE NAME name can be alphanumeric and only the underscore can be used as a special character. If other special characters (a space or blank) are used, they are converted to underscore (_). When multiple scripts are listed inside the same property file, more, different ATTRIBUTE_NAME must be defined (one for each script). It must be the first value that is specified for each defined script and delimits the start of the properties set for the specific script until the next ATTRIBUTE_NAME.

SCRIPT_PATH_WITH_PARMS

Required - string max 512 characters. This parameter defines the full path to the script with parameters, which are separated by a blank. No special characters can be used in the script path name. Values containing blanks must be enclosed in single (') or double quotation marks ("). Environment variables can be passed, but only enclosed in ${...} for all the operating systems. Environment variables must be available in the OS agent process context.

EXECUTION_FREQUENCY

Optional - default value is 60 seconds. This parameter defines the script execution frequency.

CUSTOM_NAME

Optional - string max 256 characters. This parameter can be used for a description of the script.

IS_ACTIVE

Optional - true|false The default value is true. It activates the script. If false, the script is not run.

DISABLE_USE_AGENT_SYNC

Optional - true|false The default value is false. If true, the EXECUTION_FREQUENCY of the script is respected also if the global variable KXX_FCP_SCRIPT_SYNC_INTERVALS is set to USE_AGENT.

KILL_AFTER_TIMEOUT

Optional - true|false The default value is defined by the CDP_DP_KILL_ORPHAN_SCRIPTS variable. When true, the script is ended after timeout. A timeout occurs when script execution is greater than the value specified by CDP_DP_SCRIPT_TIMEOUT parameter in OS agent configuration file. Otherwise, it is ignored. In both cases, no data is collected. Note when KILL_AFTER_TIMEOUT is set, only the script that is defined in property file is ended and not child processes (if any) created by the script. This feature is not supported by Solaris™ and Windows™ 32-bit OS agents and any timing out scripts are abandoned.

Output rows that are returned by a script are parsed.

The script returns a standard output (called as first token). When the script returns more values in the output row, they are added as more tokens. A maximum of five strings, five integers and five floats following a predefined syntax.

OUTPUT_TYPE

STRING|INTEGER|FLOAT - Optional - default value is string. It defines the type of the first token that is returned by each row of the script; OUTPUT_TYPE can be:

• STRING (default) - strings up to 2048 characters. When used, the "Standard_Output_String" attribute of KXX_Custom_Scripts_Rtm_Smp is completed by the first token.
• INTEGER - allows getting numeric values between -9223372036854775806 and 9223372036854775806. When used, the "Standard_Output_Integer" attribute of KXX_Custom_Scripts_Rtm_Smp is completed by the first token.
• FLOAT - allows getting numeric values between -92233720368547758.06 and 92233720368547758.06, with two decimal precisions. When used, the "Standard_Output_Float" attribute of KXX_Custom_Scripts_Rtm_Smp is completed by the first token.

TOKEN_TYPES

STRING|INTEGER|FLOAT - Optional - It defines the output type of more tokens after the first one. The user can define a maximum of five strings, five integers and 5 floats. It is a list of types that are separated by commas: <token_type>,<token_type>,… token_type can be empty or one from (case-insensitive):

• - STRING or S
• - INTEGER or I
• - FLOAT or F

• If TOKEN_TYPES is empty, the corresponding token is skipped.

  Examples of the same valid layouts:

• - TOKEN_TYPES=S,I,S,,,F,,F,F
• - TOKEN_TYPES=String,integer,S,,,Float,,f,FLOAT

TOKEN_LABELS

STRING - Optional - Maximum 16 characters each label. It defines the labels of the tokens that are defined in TOKEN_TYPES. This value is a list of token labels that are separated by commas, and must correspond to the tokens defined by TOKEN_TYPES. For example:

• TOKEN_TYPES=S,I,S,,,F,,F,F
• TOKEN_LABELS=Cpu Name,Cpu number,Description,,,value 1,,value 2,value 3
• TOKEN_LABELS is ignored if TOKEN_TYPES is not set.

TOKEN_SEPARATOR

Optional - default semicolon ";" It sets the string to be used as separator to split the output row in tokens. It is ignored if TOKEN_TYPES is not set. Empty value (blank) is accepted as separator and multiple consecutive blanks in output rows are considered as a single one.

The following two parameters allow filtering the rows output of a script. They are applied by the OS agent only to the first token and they must be used together:

FILTER_VALUE

Optional. The value used for comparison. It is required if FILTER_OPERATOR is defined. If the OUTPUT_TYPE is a string, the filter value must reflect exactly the string value that is returned by the script that is intended to be filtered, without any additional quotation marks (no wildcards allowed).

FILTER_OPERATOR

Optional. The operator used for the comparison. It is required if FILTER_VALUE is defined. Accepted FILTER_OPERATOR values include:

• = (equal to)
• != (not equal to)
• > (larger than) only for numeric type
• >= (not lower than) only for numeric type
• < (less than) only for numeric type
• <= (not bigger than) only for numeric type