環境變數清單

使用環境變數來控制代理程式在執行時期的行為。

可以使用「環境變數」頁面將環境變數建置於代理程式內。 在 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 的值並隨需應變執行資料收集。

「執行緒儲存區狀態」屬性群組會顯示執行緒儲存區的執行方式。 請使用「執行緒儲存區狀態」來調整執行緒儲存區大小及更新間隔,以取得最佳結果。 依預設,對此屬性群組的查詢不會顯示在代理程式導覽器樹狀結構中。 您可能會忘了在代理程式的自訂工作區中併入查詢。 不過,您可以很容易地檢視它,方法是透過將「執行緒儲存區狀態」查詢指定給基本代理程式層次工作區視圖。

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 的正整數。 等待程式(由 Script 型屬性群組所啟動)執行完畢的秒數。
CDP_DP_PING_TIMEOUT 30 任何大於或等於 10 的正整數。 等待程式(由指令回覆碼所啟動)執行完畢的秒數。
註: 此變數與 ICMP 連線測試資料提供者無關。
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 位址或主機名稱 在多重介面系統上設定偏好的主機名稱(網路介面)。 如果代理程式將其接聽埠連結至非預設的網路介面位址,則使用這個環境變數。 由 SNMP 資料提供者使用。

對於 Socket 資料來源,若還設定了 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 的 Script 資料提供者,請指定遠端系統上的位置。 隨代理程式提供的 Script 檔會上傳至此位置。 相對位置相對於使用者的起始目錄。 預設值 . (句點)表示使用者的起始目錄。
CDP_SSH_DEL_COMMAND rm -Rf 遠端系統上的任何有效刪除指令字串 若為啟用 SSH 的 Script 資料提供者,請指定指令以開始刪除隨代理程式提供的已上傳 Script 檔。
CDP_SNMP_SEND_DELAY_
FACTOR
0 毫秒 任何正整數 起始 SNMP 傳送會延遲 0 至指定的毫秒數。 僅當也啟用執行緒儲存區時,才會啟用此變數。 延遲不會套用至所有傳送,僅套用至屬性群組進行的第一個傳送。 如果正在受監視的裝置同時收到多個要求,可能有時無法正確回應,則此變數有用。
CDP_ICMP_PING_REFRESH_INTERVAL 60 任何大於或等於 1 的整數 位於裝置清單檔案中的系統會依此間隔進行連線測試。 如果連線測試佔用過多時間,則重新開始連線測試之前,至少一律有 CDP_PING_MIN_INTERVAL_DELAY 秒延遲。 資料更新頻率不會比此設定更高。 可以根據裝置清單檔案中的項目數與收到回應所需的時間,將更新頻率降為更低。
CDP_ICMP_PING_MIN_INTERVAL_DELAY 30 任何大於或等於 1 並小於 CDP 連線測試更新間隔的整數 對裝置清單檔案中的裝置進行連線測試之後,至少需要經歷此秒數才能開始下一次連線測試更新間隔。
CDP_ICMP_PING_BURST 10 任何大於或等於 0 的整數 代理程式暫停 CDP_ICMP_PING_BURST_DELAY 變數指定的時間量之前,傳送的連線測試數。 值 0 表示停用此項函數。
CDP_ICMP_PING_BURST_DELAY 10 任何大於或等於 0 的整數 傳送 CDP_ICMP_PING_BURST 變數定義的一組連線測試數之後等待的時間量(毫秒)。 值 0 表示停用此項函數。
CDP_ICMP_PING_TIMEOUT 2000 毫秒 任何大於或等於 1 的整數 等待連線測試回應的毫秒數。 此設定套用至所進行的每一次連線測試嘗試。 已針對每一個主機進行三次連線測試嘗試。 如果從任何一次嘗試中都未接收到任何回應,則等待回覆的時間總計是 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 的 Script 資料提供者,指定不得在遠端系統環境內設定的一組區域環境變數。
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,則代理程式容許遠端 Socket 連線。 如果設為 No,則代理程式僅容許來自本端主機的 Socket 連線。 預設值是 No。
CDP_DP_INITIAL_COLLECTION_
DELAY
各有不同 任何正整數 代理程式啟動之後到執行緒儲存區開始其排定的資料收集的秒數。