プロパティー・ファイル内のパラメーター

カスタム・スクリプトのパラメーターをプロパティー・ファイルに設定できます。

KXX_FCP_SCRIPT_DEFINITIONS ディレクトリーには、*.properties ファイルのリストが含まれています。各プロパティー・ファイルには、実行するスクリプトのリストが、それぞれのプロパティー (key=value の形式) とともに含まれています。定義できるプロパティー (大/小文字を区別しない) は以下のとおりです。

ATTRIBUTE_NAME

必須 - 最大 256 字の文字列。特定のスクリプトとその属性を定義する任意の名前。ATTRIBUTE NAME 名に使用できる文字は、英数字と、特殊文字ではアンダースコアーのみです。その他の特殊文字 (スペースやブランク) を使用すると、それらはアンダースコアーに変換されます。同じプロパティー・ファイル内に複数のスクリプトがリストされている場合は、さらに、異なる ATTRIBUTE_NAME を定義する必要があります (スクリプトごとに 1 つ)。これは、定義済みの各スクリプトに指定される最初の値である必要があり、次の ATTRIBUTE_NAME まで、特定のスクリプトのプロパティー・セットの開始を区切るものです。

SCRIPT_PATH_WITH_PARMS

必須 - 最大 512 字の文字列。このパラメーターは、スクリプトへの絶対パスとパラメーターを定義します。パラメーターはブランクで区切ります。スクリプトのパス名に特殊文字を使用することはできません。ブランクが含まれる値は、単一引用符 (') または二重引用符 (") で囲む必要があります。環境変数を渡すことができますが、どのオペレーティング・システムでも ${...} で囲む必要があります。環境変数は、OS エージェント・プロセスの状況に応じて使用できる必要があります。

EXECUTION_FREQUENCY

オプション - デフォルト値は 60 秒です。このパラメーターは、スクリプトの実行頻度を定義します。

CUSTOM_NAME

オプション - 最大 256 字の文字列。このパラメーターは、スクリプトの説明のために使用できます。

IS_ACTIVE

オプション - true または false。デフォルト値は true です。スクリプトをアクティブ化します。false の場合、スクリプトは実行されません。

DISABLE_USE_AGENT_SYNC

オプション - true または false。デフォルト値は false です。true の場合、グローバル変数である KXX_FCP_SCRIPT_SYNC_INTERVALS が USE_AGENT に設定されていても、スクリプトの EXECUTION_FREQUENCY が考慮されます。

KILL_AFTER_TIMEOUT

オプション - true または false。デフォルト値は CDP_DP_KILL_ORPHAN_SCRIPTS 変数によって定義されます。true の場合、スクリプトはタイムアウト後に終了します。タイムアウトは、スクリプトの実行時間が OS エージェント構成ファイルの CDP_DP_SCRIPT_TIMEOUT パラメーターで指定された値を超えた場合に発生します。それ以外の場合は無視されます。どちらの場合も、データは収集されません。KILL_AFTER_TIMEOUT を設定すると、プロパティー・ファイルに定義されているスクリプトのみが停止され、スクリプトが作成した子プロセス (ある場合) は停止されません。この機能は、Solaris™ と Windows™ 32 ビットの OS エージェントではサポートされません。また、すべてのタイムアウト・スクリプトは放棄されます。

スクリプトによって返される出力行が解析されます。

スクリプトは標準出力 (最初のトークンと呼ばれるもの) を返します。スクリプトが出力行にさらに値を返すと、それらはさらにトークンとして追加されます。定義済みの構文に従って、最大 5 つの文字列、5 つの整数、および 5 つの浮動小数点数です。

OUTPUT_TYPE

STRING|INTEGER|FLOAT - オプション - デフォルト値は STRING です。スクリプトの各行で返される最初のトークンのタイプを定義します。OUTPUT_TYPE は以下の値にすることができます。

STRING (デフォルト) - 最大 2048 字までの文字列。使用する場合、KXX_Custom_Scripts_Rtm_Smp の「Standard_Output_String」属性には、最初のトークンが入力されます。
INTEGER - -9223372036854775806 から 9223372036854775806 までの間の数値を取得できます。使用する場合、KXX_Custom_Scripts_Rtm_Smp の「Standard_Output_Integer」属性には、最初のトークンが入力されます。
FLOAT - -92233720368547758.06 から 92233720368547758.06 の間の数値を、2 桁の小数精度で取得できます。使用する場合、KXX_Custom_Scripts_Rtm_Smp の「Standard_Output_Float」属性には、最初のトークンが入力されます。

TOKEN_TYPES

STRING|INTEGER|FLOAT - オプション - 最初のトークンの後のさらなるトークンの出力タイプを定義します。ユーザーは、最大 5 つの文字列、5 つの整数、および 5 つの浮動小数点を定義できます。これは、コンマで区切ったタイプのリストで、<token_type>,<token_type>,… のようにします。token_type は空か、以下のいずれか (大/小文字を区別しない) にできます。

- STRING または S
- INTEGER または I
- FLOAT または F
TOKEN_TYPES が空の場合、対応するトークンはスキップされます。

効果が同じであるレイアウトの例を以下に示します。
- TOKEN_TYPES=S,I,S,,,F,,F,F
- TOKEN_TYPES=String,integer,S,,,Float,,f,FLOAT

TOKEN_LABELS

STRING - オプション - ラベルごとに最大 16 字。TOKEN_TYPES で定義されているトークンのラベルを定義します。この値は、コンマ区切りのトークン・ラベルのリストであり、TOKEN_TYPES で定義されたトークンに対応する必要があります。例:

TOKEN_TYPES=S,I,S,,,F,,F,F
TOKEN_LABELS=Cpu Name,Cpu number,Description,,,value 1,,value 2,value 3
TOKEN_TYPES が設定されない場合、TOKEN_LABELS は無視されます。

TOKEN_SEPARATOR

オプション - デフォルトはセミコロン「;」。トークンの出力行を分割するための区切り文字として使用する文字列を設定します。TOKEN_TYPES が設定されない場合は無視されます。空の値 (ブランク) は区切り文字として受け入れられますが、出力行内の連続した複数のブランクは単一のブランクと見なされます。

次の 2 つのパラメーターを使用すると、スクリプトの行出力をフィルタリングできます。これらは OS エージェントによって最初のトークンにのみ適用され、2 つ一緒に使用する必要があります。

FILTER_VALUE

オプションです。比較に使用される値。FILTER_OPERATOR が定義されている場合は必須です。OUTPUT_TYPE が文字列の場合、フィルター値は、フィルターを掛ける対象のスクリプトによって返される文字列値を、追加の引用符なしで正確に反映する必要があります (ワイルドカードは使用できません)。

FILTER_OPERATOR

オプションです。比較に使用される演算子。FILTER_VALUE が定義されている場合は必須です。使用できる FILTER_OPERATOR 値は次のとおりです。

= (等しい)
!= (等しくない)
> (より大きい) 数値タイプのみ
>= (より小さくない) 数値タイプのみ
< (より小さい) 数値タイプのみ
<= (より大きくない) 数値タイプのみ