環境変数のリスト

環境変数を使用して、実行時のエージェントの動作を制御します。

「環境変数」ページを使用して、環境変数をエージェントに組み込むことができます。Windows システムの場合、環境変数はエージェントの KXXENV ファイルで定義されています。UNIX および Linux システムの場合、これらの変数はエージェントの $CANDLEHOME/config/XX.ini ファイルで定義できます。XX は 2 文字の製品コードです。新しい設定を有効にするには、エージェントを再始動する必要があります。

注: C シェルを実行するリモート・システムで環境変数が正しく設定されていません。環境変数を使用する場合は、異なるシェルを使用してください。

表 1. 環境変数. 環境変数、そのデフォルト値、有効な値の範囲、および各変数の説明がリストされている表
環境変数	デフォルト値	有効な値	説明
`CDP_ATTRIBUTE_GROUP_REFRESH_INTERVAL`	適用できません	負ではない整数	指定された特定の属性グループがバックグラウンドで更新される間隔 (秒数)。この変数は、`CDP_DP_REFRESH_INTERVAL` と同様に機能します。ただし、指定された属性グループのみを対象とします。実際の属性グループ名が大文字でなくても、変数名の中の属性グループ名は大文字である必要があります。
`CDP_DP_CACHE_TTL`	`55`	1 以上の整数。	属性グループについて収集されたデータは、この秒数の間、キャッシュの中に入れられます。この時間間隔中に同じデータが繰り返し要求された場合は、このデータのキャッシュ・コピーが返されます。この値は、エージェント内のすべての属性グループに適用されます。
`CDP_ATTRIBUTE_GROUP_CACHE_TTL`	`CDP_DP_CACHE_TTL` の値。	1 以上の整数。	特定の指定された属性グループについて収集されたデータは、この秒数だけ、キャッシュに格納されます。この時間間隔中に同じデータが繰り返し要求された場合は、このデータのキャッシュ・コピーが返されます。この値は、指定されたグループの `CDP_DP_CACHE_TTL` の値を上書きします。実際の属性グループ名が大文字でなくても、変数名の中の属性グループ名は大文字である必要があります。
`CDP_DP_IMPATIENT_COLLECTOR_TIMEOUT`	サブノードが定義されている場合は `5`。それ以外は設定されません	任意の正の整数	データ収集が行われるのを待機する秒数。この時間が経過するとタイムアウトになり、キャッシュ・データが失効している場合でも、そのキャッシュ・データが返されます。(キャッシュされているデータは、`CDP_DP_CACHE_TTL` 秒経過すると、失効となります。) この変数が設定されていない場合、エージェントはデータ収集が完了するまで待機します。この待機は場合により Tivoli® Enterprise Portal のタイムアウトとなり、待機は中止されます。スレッド・プールが構成されていない場合、この変数は無視され、データ収集は同期で実行されます。
`CDP_DP_REFRESH_INTERVAL`	サブノードが定義されている場合は `60`。それ以外は設定されません	負ではない整数	属性グループがバックグラウンドで更新される間隔 (秒数)。この変数が設定されていないか、または 0 に設定される場合、バックグラウンド更新は使用不可にされます。スレッド・プールが構成されている場合 (変数 `CDP_DP_THREAD_POOL_SIZE` を参照)、属性グループは並行して最新表示できます。スレッド・プールがない場合、更新は順次行われるため、長時間かかることがあります。論理的にスレッド・プール・サイズ 1 に相当します。
`CDP_DP_THREAD_POOL_SIZE`	サブノードが定義されている場合は `15`。それ以外は設定されません	負ではない整数	`CDP_DP_REFRESH_INTERVAL` で定義された間隔で、バックグラウンドでデータ収集を実行するために作成されたスレッドの数。この変数が設定されていないか、または 0 に設定される場合、スレッド・プールはありません。 `CDP_DP_THREAD_POOL_SIZE` に 1 よりも大きな値を設定し、かつ `CDP_DP_REFRESH_INTERVAL` に 0 を設定した場合、`CDP_DP_THREAD_POOL_SIZE` の値が無視され、要求した場合にのみデータ収集が実行されます。「スレッド・プールの状況」属性グループは、スレッド・プールがどのように実行されているかを示します。最善の結果を得るために、「スレッド・プールの状況」を使用して、スレッド・プール・サイズおよび最新表示間隔を調整します。デフォルトでは、この属性グループの照会はエージェントのナビゲーター・ツリーに表示されません。エージェントのカスタム・ワークスペースに照会を組み込む必要はありません。ただし、「スレッド・プールの状況」照会を基本エージェント・レベルのワークスペース・ビューに割り当てることにより、容易に表示させることができます。
`CDP_JDBC_MAX_ROWS`	`1000`	任意の正の整数	JDBC データ・プロバイダーが返すデータ行の最大数。結果セットに含まれるデータ行がこの行数を超える場合は、この最大値までのデータのみが処理されます。IBM® Tivoli Monitoring に返されるデータが多くなりすぎないように照会を作成できます。
`CDP_NT_EVENT_LOG_GET_ALL_ENTRIES_FIRST_TIME`	`NO`	YES、NO	YES に設定した場合、エージェントは Windows イベント・ログのすべてのイベントを送信します。NO に設定した場合、 Windows イベント・ログの新しいイベントのみが送信されます。
`CDP_NT_EVENT_LOG_CACHE_TIMEOUT`	`3600`	300 以上の整数。	Windows イベント・ログのイベントがエージェントによってキャッシュされる秒数。イベント・ログ属性グループが照会されると、キャッシュにあるすべてのイベントが返されます。注: この変数は、現在は使用されていません。`CDP_PURE_EVENT_CACHE_SIZE` 変数を使用してください。
`CDP_PURE_EVENT_CACHE_SIZE`	`100`	1 以上の正の整数。	キャッシュに入れるイベントの最大数。新規レコードを処理するために構成されているログ・ファイル・データ・ソース、Windows イベント・ログ属性グループに対して適用されます。また、JMX モニターおよび通知に対しても適用されます。ログにあるそれぞれの新規レコードについて、イベントが送信されます。この環境変数により、エージェントがキャッシュに入れるイベントの数が定義されます。属性グループが照会されると、キャッシュ内の値が返されます。
`CDP_DP_ACTION_TIMEOUT`	`20` 秒	1 以上の正の整数。	エージェントによるアクション実行の処理が完了するのを待つ秒数。
`CDP_DP_SCRIPT_TIMEOUT`	`30` 秒	10 以上の正の整数。	スクリプト・ベースの属性グループが開始したプログラムが完了するのを待つ秒数。
`CDP_DP_PING_TIMEOUT`	`30` 秒	10 以上の正の整数。	コマンドの戻りコードが開始したプログラムが完了するのを待つ秒数。注: この変数は、ICMP ping データ・プロバイダーとは関連していません。
`CDP_SNMP_MAX_RETRIES`	`2`	任意の正の整数	SNMP 要求の送信を再試行する回数。応答を受信しない場合、SNMP エージェントに送信される要求の総数は、この値に 1 を加えた数です。
`CDP_SNMP_RESPONSE_TIMEOUT`	`2` 秒	任意の正の整数	各 SNMP 要求がタイムアウトになるまで待機する秒数。属性グループの行は、それぞれ別個の要求です。このタイムアウト値は、応答を待機する秒数です。この秒数が経過した後、再試行が実行されます。単一のデータ行の合計タイムアウトは、(`CDP_SNMP_MAX_RETRIES` + 1) * `CDP_SNMP_RESPONSE_TIMEOUT` になります。デフォルトの合計タイムアウト値は (2+1) * 2 = 6 秒になります。
`CDP_DP_HOSTNAME`	最初にインストールしたネットワーク・インターフェースの名前	IP アドレスまたはホスト名	複数インターフェース・システムの優先ホスト名 (ネットワーク・インターフェース) を設定します。この環境変数は、エージェントがその listen ポートをデフォルト以外のネットワーク・インターフェース・アドレスにバインドする場合に使用します。SNMP データ・プロバイダーで使用されます。ソケットのデータ・ソースの場合、この変数は `CDP_DP_ALLOW_REMOTE` も設定されている場合に適用されます。
`CDP_SNMP_ALLOW_DECREASING_OIDS`	`NO`	YES、NO	YES に設定されている場合、SNMP データ・プロバイダーは戻された OID が増加しているかどうかを検査しません。モニター対象エージェントでは、一般にこの検査で捕捉される問題が発生することがあるため、YES に設定する際には十分に注意してください。
`KUMP_DP_COPY_MODE_SAMPLE_INTERVAL`	`60`	待機時間 (秒)	ログ・ファイル・データ・プロバイダーの場合に、エージェントが「ファイルがサンプリングされたときにすべてのレコードを処理」と定義されているときにファイル内容を再読み取りするまでの待機時間を指定します。この時間は秒単位で指定します。
`KUMP_MAXPROCESS`	`100%`	5-100%	ログ・ファイル・データ・プロバイダーの場合に、ファイル・データの処理に使用する最大プロセッサー使用量を指定します。値の範囲は 5 から 100 パーセントです。デフォルトは 100% です。
`KUMP_DP_SAMPLE_FACTOR`	`5`	負ではない整数	ログ・ファイル・データ・プロバイダーの場合、Agent Builder で「ファイルがサンプリングされたときにすべてのレコードを処理」を選択する際に、サンプリング係数を設定します。この待機時間により、パターンのスキャンがログに記録される前に、複数のレコードにわたるパターンが確実に書き込まれます。
`KUMP_DP_EVENT`	`5`	負ではない整数	ログ・ファイル・データ・プロバイダーの場合に、イベント・データのサンプリング頻度を秒単位で設定します。
`KUMP_DP_FILE_EXIST_WAIT`	`YES`	YES、NO	ログ・ファイル・データ・プロバイダーの場合に、モニター対象ファイルがないか空であることが検出されたときにファイル・モニター・スレッドの実行を継続することを指定します。スレッドは、ファイルが作成されるまで待機し、数秒ごとに再確認し、ファイルが使用可能になった時点でモニターを開始または再開します。
`KUMP_DP_FILE_SWITCH_CHECK_INTERVAL`	`600`	負ではない整数	ログ・ファイル・データ・プロバイダーが、動的ファイル名サポートが有効の場合に切り替え先として使用する別のモニター・ファイルを検索する頻度 (秒単位)。
`KUMP_DP_FILE_ROW_PAUSE_INCREMENT`	なし	負ではない整数	ログ・ファイル・データ・プロバイダーの場合、ファイル・モニター・スレッドが一時停止する前に読み取るファイル・レコードの数を指定します。この一時停止の目的は、前の更新を処理できるようにすることです。この環境変数を使用するのは、モニター対象ファイルが大量の新規レコードを受け取り、一部のレコード更新が失われる可能性がある場合に限ります。
`CDP_COLLECTION_TIMEOUT`	`60` 秒	任意の正の整数	別のプロセスで開始されたデータ・コレクターからの応答をエージェントが待機する秒数。このようなデータ・コレクターの例としては、JMX、JDBC、HTTP、および SOAP データ・コレクターがあります。
`CDP_SSH_TEMP_DIRECTORY`	`.` (ピリオド)	リモート・システム上の任意の有効なパス・ストリング	SSH 対応スクリプト・データ・プロバイダーの場合に、リモート・システム上の場所を指定します。エージェントに付属するスクリプト・ファイルは、この場所にアップロードされます。相対的な場所は、ユーザーのホーム・ディレクトリーを基準としています。デフォルトの `.` (ピリオド) は、ユーザーのホーム・ディレクトリーを示します。
`CDP_SSH_DEL_COMMAND`	`rm -Rf`	リモート・システム上の任意の有効な削除コマンド・ストリング	SSH 対応スクリプト・データ・プロバイダーの場合に、エージェントとともに提供されたアップロード済みのスクリプト・ファイルを削除するために開始するコマンドを指定します。
`CDP_SNMP_SEND_DELAY_ FACTOR`	`0` ミリ秒	任意の正の整数	最初の SNMP 送信を 0 から指定の時間 (ミリ秒単位) まで遅延します。この変数が使用可能になるのは、スレッド・プールも使用可能な場合のみです。この遅延はすべての送信に適用されるわけではなく、属性グループによって行われる最初の送信のみに適用されます。この変数は、複数の要求を同時に受信するときにモニター対象デバイスが正常に応答しなくなる場合に役立ちます。
`CDP_ICMP_PING_REFRESH_INTERVAL`	`60` 秒	1 以上の整数	デバイス・リスト・ファイルにあるシステムがこの間隔で ping されます。ping に時間がかかりすぎる場合は、再度 ping が開始される前に、必ず `CDP_PING_MIN_INTERVAL_DELAY` 秒以上の遅延が設けられます。データはこの設定よりも低い頻度でリフレッシュされます。デバイス・リスト・ファイルの項目数および応答を受信するまでの時間に基づいて、より低い頻度でデータをリフレッシュできます。
`CDP_ICMP_PING_MIN_INTERVAL_DELAY`	`30` 秒	1 以上 `CDP` ping リフレッシュ間隔未満の任意の整数	デバイス・リスト・ファイルにあるデバイスに ping した後、少なくともこの秒数が経過するまでは、次の ping リフレッシュ間隔は開始しません。
`CDP_ICMP_PING_BURST`	`10`	0 以上の整数	`CDP_ICMP_PING_BURST_DELAY` 変数で指定された時間だけエージェントが一時停止するまでに ping を送信する回数。0 の値を指定すると、この機能が無効になります。
`CDP_ICMP_PING_BURST_DELAY`	`10`	0 以上の整数	`CDP_ICMP_PING_BURST` 変数で定義された設定数の ping を送信した後、待機する時間 (ミリ秒単位)。0 の値を指定すると、この機能が無効になります。
`CDP_ICMP_PING_TIMEOUT`	`2000` ミリ秒	1 以上の整数	ping 応答を待機する時間 (ミリ秒単位)。この設定は、試行される各 ping に適用されます。ホストごとに ping が 3 回試行されます。3 回の試行で応答を受け取らなかった場合は、応答待機時間合計は `CDP_ICMP_PING_TIMEOUT` に 3 を掛けた値になります。デフォルトでは、この値は 6000 ミリ秒です。`CDP_ICMP_PING_TIMEOUT` の値を変更すると、「現行の応答時間」属性のデフォルトの `TIMEOUT` 列挙が今後適用されなくなります。`TIMEOUT` 列挙を、`CDP_ICMP_PING_TIMEOUT` の新しい値に 3 を掛けた値に変更してください。
`CDP_JDBC_CONNECTIONLESS`	`false`	true、false	true に設定すると、データ収集試行の後、毎回 JDBC 接続が閉じられます。つまり、データを収集するごとに、毎回すべての属性グループが専用の接続を作成します。この変数を有効にした場合、接続は再利用されません。false に設定すると、データベースに対して 1 つの接続が作成され、複数の属性グループの間でその接続が共有されます。
`CDP_SSH_EXCLUDED_ ENVIRONMENT_VARIABLES`	なし	環境変数名をコンマで区切ったリスト	SSH 対応スクリプト・データ・プロバイダーの場合に、リモート・システムの環境変数に設定しないローカル環境変数のセットを指定します。
`CDP_DP_EVENT_LOG_MAX_BACKLOG_TIME`	`0` 秒	0、1、または 1 よりも大きな任意の整数。	これを 0 に設定し、`CDP_DP_EVENT_LOG_MAX_BACKLOG_EVENTS` を 1 以上の整数に設定しない場合、エージェントのシャットダウン中に生成されたイベントは処理されません。0 はデフォルトです。これを 1 に設定し、`CDP_DP_EVENT_LOG_MAX_BACKLOG_EVENTS` を 1 よりも大きい整数に設定しない場合、エージェントのシャットダウン中に生成されたすべてのイベントが処理されます。これを 1 よりも大きい値に設定し、`CDP_DP_EVENT_LOG_MAX_BACKLOG_EVENTS` を 1 よりも大きい値に設定しない場合、その値 (現在のコンピューター時間の秒単位の値) 内に生成されたイベントが処理されます。例えば、始動時にこの値が 300 に設定されている場合、エージェントは現在時刻で 300 秒以内に生成されるすべてのイベントを処理します。 `CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` と `CDP_DP_EVENT_LOG_MAX _BACKLOG_EVENTS` の両方の変数に 1 よりも大きい値を入力すると、指定されている期間内に生成されるイベント、または指定されている数のイベントのいずれかが処理されます。選択される変数は、最初に一致した変数です。
`CDP_DP_EVENT_LOG_ Windows_Event_Log_MAX_BACKLOG_TIME`	`0` 秒 (エージェントのシャットダウン中に消失したイベントは処理されません)	0、1、または 1 よりも大きな任意の整数。	以下のように設定される場合
`CDP_DP_EVENT_LOG_ MAX_BACKLOG_EVENTS`	`0` イベント	0、1、または 1 よりも大きな任意の整数。	これを 0 に設定し、`CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` 変数を 1 以上の整数に設定しない場合、エージェントのシャットダウン中に生成されたイベントは処理されません。0 はデフォルトです。これを 1 に設定し、`CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` 変数を 1 よりも大きい整数に設定しない場合、エージェントのシャットダウン中に生成されたすべてのイベントが処理されます。これを 1 よりも大きい値に設定し、`CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` を 1 よりも大きい値に設定しない場合、エージェントのシャットダウン中に生成されるイベントのうち、指定されている数以下のイベントが処理されます。例えばこの値が 200 に設定されている場合、エージェントの始動時に、始動直前までに生成された 200 個のイベントが処理されます。 `CDP_DP_EVENT_LOG_MAX_BACKLOG _EVENTS` と `CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` の両方に 1 よりも大きい値を入力した場合、指定されている数のイベント、または指定されている期間内に生成されるイベントのいずれかが処理されます。選択される変数は、最初に一致した変数です。
`CDP_DP_EVENT_LOG_ Windows_Event_Log_MAX_BACKLOG_EVENTS`	`0` イベント (エージェントのシャットダウン中に消失したイベントは処理されません)	0 または 1 以上の整数	以下のように設定される場合
`CDP_HTTP_READ_TIMEOUT`	`10`	任意の正の整数	HTTP 要求に対する応答を待機する秒数。
`CDP_JAT_THREAD_POOL_SIZE`	`15`	任意の正の整数	Java™ プロバイダーによりデータ収集要求を処理するために使用されるスレッドの数。このスレッド・プールが役立つプロバイダーは、JMX、JDBC、HTTP、および SOAP データ・プロバイダーです。
`CDP_HTML_OBJECTS_THREAD_ POOL_SIZE`	`10`	任意の正の整数	HTTP データ・プロバイダーでモニターされる URL で検出されたページ・オブジェクトをダウンロードするために使用されるスレッドの数。
`CDP_HTTP_SOAP_MAX_ROWS`	`500`	任意の正の整数	HTTP SOAP データ・プロバイダーにより返される行の最大数。
`CDP_DP_ALLOW_REMOTE`	`NO`	`いいえ、はい`	YES に設定すると、エージェントはリモート・ソケット接続を許可します。NO に設定すると、エージェントはローカル・ホストからのソケット接続のみを許可します。NO がデフォルトです。
`CDP_DP_INITIAL_COLLECTION_ DELAY`	可変	任意の正の整数	エージェントが開始した後に、スレッド・プールがそのスケジュールされたデータ収集を開始するまでの秒数。