环境变量列表

使用环境变量来控制代理程序运行时行为。

通过使用“环境变量”页面，可以将环境变量构建到代理程序中。在 Windows 系统上，环境变量在代理程序的 KXXENV 文件中定义。在 UNIX 和 Linux 系统上，可以在代理程序的 $CANDLEHOME/config/XX.ini 文件中定义这些变量。XX 是两字母产品代码。代理程序必须重新启动才能使新设置生效。

注：未在运行 C Shell 的远程系统上正确设置环境变量。如果要使用环境变量，请使用其他 shell。

表 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` 的值并按需进行数据收集。 Thread Pool Status 属性组显示线程池是如何运行的。使用 Thread Pool Status 来调整线程池大小和刷新时间间隔以获得最佳结果。缺省情况下，该属性组的查询不会在代理程序导航器树上显示。您可能会忘记在代理程序的定制工作空间中包含查询。但是，可以通过将 Thread Pool Status 查询指定到基本代理程序级别工作空间视图进行轻松查看。
`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 代理程序的请求总数是该值加一。
`CDP_SNMP_RESPONSE_TIMEOUT`	`2` 秒	任何正整数	等待每个 SNMP 请求超时的秒数。属性组中的每行表示一个单独的请求。此超时值是在进行重试前等待响应的秒数。单行数据的总超时为 (`CDP_SNMP_MAX_RETRIES` + 1) * `CDP_SNMP_RESPONSE_TIMEOUT`。总的缺省超时值是 (2+1) * 2 = 6 秒。
`CDP_DP_HOSTNAME`	安装的第一个网络接口的名称	IP 地址或主机名	在多接口系统上设置首选主机名（网络接口）。如果代理程序将其侦听端口绑定到非缺省网络接口地址，那么请使用此环境变量。此环境变量由 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 尝试。系统会对每个主机尝试 3 次 Ping 操作。如果 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，那么建立与数据库的一个连接后，属性组之间将共享该连接。
`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`	`NO 和 YES`	如果设置为 YES，代理程序将允许远程套接字连接。如果设置为 NO，代理程序将只允许来自本地主机的套接字连接。NO 是缺省值。
`CDP_DP_INITIAL_COLLECTION_ DELAY`	不固定	任何正整数	代理程序启动之后，线程池开始其调度的数据收集之前的秒数。