IBM Tivoli Monitoring > Version 6.3 Fix Pack 2 > Installation Guides > Installation Guide > Agent configuration and environment variables > Environment variables
IBM Tivoli Monitoring, Version 6.3 Fix Pack 2
Tivoli Enterprise Monitoring Server environment variables
The table in this section lists the Tivoli Enterprise Monitoring Server environment variables. For instructions about changing an environment variable, see Editing your environment configuration settings in the IBM Tivoli Monitoring Administrator's Guide.
Tivoli Enterprise Monitoring Server environment variables
Variable Purpose ATTRLIB Specifies the Tivoli Enterprise Monitoring Server attribute (ATR) files directory. CANDLE_HOME The directory where the product was installed. CLEARDEPLOYSTATUSFREQ Specifies a schedule for the he periodic removal of completed transactions from the Tivoli Enterprise Monitoring Server's Deployment Status table. Enabling this feature allows you to review completed deployment transactions at opportune times as well as reduce the amount of Tivoli Enterprise Monitoring Server overhead by maintaining a modest table size. You can enable this feature at Tivoli Enterprise Monitor Server startup by adding the variable to the Tivoli Enterprise Monitoring Server's environment file: CLEARDEPLOYSTATUSFREQ=XWhere X = number of hours between the automated clearing of the Deployment Status table. If X is zero (0) or this environment variable is not specified in the configuration file, automatic clearing of the table is disabled. Valid values are zero (0) to 720.
CMS_BINPATH Specifies the Tivoli Enterprise Monitoring Server binary files directory. CMS_EXTERNALBROKERS Specifies whether there are internal brokers. CMS_FTO Specifies whether to use Tivoli Enterprise Monitoring Server Hot Standby. CMS_MSGBASE Applies to is/5 platform Tivoli Enterprise Monitoring Agent only. Specify the MSG2 message file for Tivoli Enterprise Monitoring Agent framework messages. CMS_NODEID The Tivoli Enterprise Monitoring Server IBM Tivoli Monitoring Node ID. CMS_NODE_VALIDATION Enables the rejection of incorrect managed system names. DEPLOYQUEUESIZE Specifies the maximum number of requests that the request queue on the agent deployment controller. DEPLOYTHREADPOOLSIZE Specifies the number of threads that are available to the deployment controller. DEPOTHOME Specifies the root directory of the agent depot on the file system. KDC_GLBSITES Specifies the Tivoli Enterprise Monitoring Server global sites network file with Tivoli Enterprise Monitoring Server Hub host names. KDH_SERVICEPOINT Specifies an alternate service point string, which labels an ITM process in the IBM Tivoli Monitoring Service Index web page. If not specified, the service point string defaults to <process-owner>.<system-name>_<product-code>. KDS_CATLGLIB Specifies the catalog library. KDS_HUB Specifies that this Tivoli Enterprise Monitoring Server is a Hub Tivoli Enterprise Monitoring Server (*LOCAL) or Remote Tivoli Enterprise Monitoring Server (*REMOTE). KDS_NCS Whether to use IBM Tivoli Monitoring network lookup services. KDS_RULELIB Specifies the rule library. KDS_RUN Specifies Tivoli Enterprise Monitoring Server components or probes to run at Tivoli Enterprise Monitoring Server startup. KDS_START Specifies Tivoli Enterprise Monitoring Server KDS component startup. KDS_VALIDATE Whether to use Tivoli Enterprise Monitoring Server authentication. KGE_EXPIRE_INTERVAL_ENTITY KGE_EXPIRE_INTERVAL_PERMIT
If you set KMS_SECURITY_COMPATIBILITY_MODE=N for strict command security, it means that the sending and receiving system clocks must be synchronized with a delta of less than 75 minutes. Note that this 75 minute restriction does accommodate timezone differential. The restriction only applies to system clocks whose Coordinated Universal Time (UTC) values are off by more than 75 minutes; it does not apply to systems whose local times are different. If the time delta exceeds 75 minutes, a command request will be marked as expired when it reaches the destination, and it will fail to execute. If you have remote agent endpoints whose system clocks are widely divergent from their connecting monitoring server, and you cannot readily change the agent clocks, then you can add these two environment variables to the Tivoli Enterprise Monitoring Server:
- KGE_EXPIRE_INTERVAL_ENTITY=nnn
- KGE_EXPIRE_INTERVAL_PERMIT=nnn
Where nnn is the time delta expressed in minutes of system clock differential between the Tivoli Enterprise Monitoring Server and its connecting agent. If, for example, the agent's system clock was 6 hours ahead of the Tivoli Enterprise Monitoring Server system clock, you would add these two environment variables to the Tivoli Enterprise Monitoring Server and set the minute values to a number greater than 360 (60 * 6). The minute values in both environment variables should be the same.
KGLCB_FSYNC_ENABLED Whether to enable UNIX or Linux fsync calls. KGL_CBTBUFCNT Specifies Tivoli Enterprise Monitoring Server internal table buffer count. KGL_CBTBUFSZ Specifies Tivoli Enterprise Monitoring Server internal table buffer size. KGL_KEYRING_FILE Specifies LDAP authentication SSL GSKit keyring file. KGL_KEYRING_LABEL Specifies LDAP authentication SSL GSKit keyring label. KGL_KEYRING_PASSWORD Specifies LDAP authentication SSL GSKit keyring password. KGL_KEYRING_STASH Specifies LDAP authentication SSL GSKit keyring password stash file. KGL_KGLMSGBASE Specifies the Tivoli Enterprise Monitoring Server KGL message file directory. KGL_LDAP_BASE LDAP authentication LDAP search base. KGL_LDAP_BIND_ID LDAP authentication LDAP server bind Distinguished Name (DN). KGL_LDAP_BIND_PASSWORD LDAP authentication LDAP server bind password. KGL_LDAP_HOST_NAME LDAP authentication LDAP server host name. KGL_LDAP_PORT LDAP authentication LDAP server port. KGL_LDAP_SSL_ENABLED Whether to use LDAP SSL communications. KGL_LDAP_USER_FILTER LDAP authentication user filter. KGL_LDAP_VALIDATE Whether to use LDAP authentication. KGL_MSG2_EVENTLOG Whether to format Event Log. KGL_MSG2_UNIVERSAL Whether to enable Universal Messages. KGL_TRC1 Whether to enable the error log. KHD_HISTRETENTION Optional. Specifies the default retention period in hours for the short-term history files (default is 24 hours). This value can be used to reduce the amount of data that is kept on disk after a successful upload to the warehouse is performed. Specify KHD_HISTRETENTION=0 to delete the short term binary file after the export is complete. Deleting the short term binary file prevents space concerns and also speeds up the process of reading the files. After the short term binary file is deleted, you will not see short-term data in the Tivoli Enterprise Portal. If you set KHD_HISTRETENTION=0, then you must also change the variable KFW_REPORT_TERM_BREAK_POINT in the portal server environment file to ensure that historical queries in the portal server work correctly.
KIB_MAXCOLS Tivoli Enterprise Monitoring Server internal dictionary column maximum. KMS_DISABLE_TEC_EMITTER TEC Emitter to be disabled. KMS_EVAL_REFLEX_AT_TEMS When set to Y, this variable maximizes your level of duper optimization. You might want to increase your level of duper optimization if you have a large amount of reflex actions executing at your managed systems (agents). At each monitoring server in your environment, set KMS_EVAL_REFLEX_AT_TEMS=Y to cause the evaluations of the actions to be handled by duper on the monitoring server, while the actions are still directed to the managed systems. KMS_OMTEC_ GLOBALIZATION_LOC TEC Integration Globalization locale. KMS_OMTEC_INTEGRATION TEC Integration enabled. KMS_SECURITY_COMPATIBILITY_
MODEMonitor agents running the Tivoli Enterprise Management Agent framework at version 6.3 or later use security tokens to validate that the request originated from a V6.3 or later monitoring server or portal server in the Tivoli Monitoring environment. The monitoring agents also extract the identity of the user who initiated the request from the security token so that the User ID can be included in an audit record. The 32 character encryption key that is configured for each monitoring component is used to encrypt and decrypt the security token and must be the same for all components in your monitoring environment. The KMS_SECURITY_COMPATIBILITY_MODE variable (Default=Y) is intended to help with customer migration to Tivoli Monitoring V6.3 by allowing a pre-V6.3 component to initiate a take action and execute command request that does not include a security token. If the Y value is set, the Tivoli Enterprise Monitoring Server will generate a default security token so that the take action and execute command request can still be processed successfully at the monitoring agent endpoints connected to that monitoring server.
KMS_SECURITY_COMPATIBILITY_MODE=Y also ensures that Take Action and execute command requests can be processed if the system clocks are not synchronized to Coordinated Universal Time (UTC) across the systems with monitoring servers, the portal server, and monitoring agents.
KMS_SECURITY_COMPATIBILITY_MODE=Y also has another property. If local cryptographic functions are not available, for example, because the Integrated Cryptographic Services Facility (ICSF) was not configured on a z/OS monitoring server, then that monitoring server would in effect disable security token checking and still allow commands to be executed at the monitoring agent endpoints. This property of the 'Y' setting is intended to give you time to implement cryptographic support on all of the IBM Tivoli Monitoring systems.
However, if the value is set to N, the Tivoli Enterprise Monitoring Server will not generate a default security token for the monitoring agents connected to it. Therefore, if a monitoring agent is running V6.3 or later of the Tivoli Enterprise Management Agent framework, it will reject a Take Action or execute command request that originated from a monitoring server or portal server that did not generate a security token or if the security token has expired because clocks are not synchronized. The default expiration time for a security token is 75 minutes. To change the expiration time for the security token, change the values of the KGE_EXPIRE_INTERVAL_ENTITY and KGE_EXPIRE_INTERVAL_PERMIT environment variables.
It is recommended that once all of the IBM Tivoli Monitoring server components have been migrated to V6.3, the clocks are synchronized to Coordinated Universal Time (UTC) across your monitoring server, portal server, and monitoring agent components, and cryptographic functions are available on all of your monitoring servers, you should set this environment variable to N. This will ensure that every take action and execute command request originates from a trusted source that has provided a valid security token.
KPX_WAREHOUSE_LOCATION Allows a fixed warehouse route for the agents connected to that Tivoli Enterprise Monitoring Server when the usage of the Global Location Broker default algorithm is not supported. It is a list of fully qualified, semicolon delimited network names such as: KPX_WAREHOUSE_LOCATION= family_protocol: #network_address[port_number]; ...
KPX_WAREHOUSE_REGCHK Number of minutes to wait between rechecking the Global Location Broker for any warehouse proxy agent registration changes. The default value is set to 60 minutes. KSH_DIRECTORY Specifies the Tivoli Enterprise Monitoring Server SOAP server HTML files directory. KT1_TEMS_SECURE YES is required for the tacmd commands, putfile, getfile, and executecommand. Also required when executeaction is issued with advanced options. Not required when issuing executeaction to agent without advanced options. MSG_MODE Specify kms if you want to use IBM Tivoli Monitoring Operations Logging. Specify MSG2 to use MSG2 logging. NLS1_LOCALEDIR The directory of the locale file. RKDSCATL Specifies the Tivoli Enterprise Monitoring Server catalogue (CAT) files directory. SQLLIB Specifies the Tivoli Enterprise Monitoring Server seeding and query (SQL) files directory. TIMEOUT Specifies the time in seconds that Agent Deployment tool has to complete a task. If the tool does not complete in the task in the time specified by the TIMEOUT value, the task is terminated. The default value is 600 seconds. KMS_SDA N disables the self-describing agent capability and Y enables it. By default, the self-describing agent capability is disabled at the hub monitoring server. Self-describing agent environment variables are enabled by default for remote monitoring servers, portal servers, and self-describing agent enabled agents. However, these components disable self-describing agent capability if connected to a hub monitoring server that has the self-describing agent capability disabled. Enabling or disabling the self-describing agent capability at the hub monitoring server controls the capability across all components, but you can disable the capability individually at a remote monitoring server, portal server, or agent. You must restart the hub monitoring server for a change in the KMS_SDA variable to take effect. Do not specify YES or NO; instead, always specify Y or N.
KMS_SDM_HUB_WAIT_TIMEOUT Number of seconds that the Remote Tivoli Enterprise Monitoring Server waits for the hub monitoring server to complete a self-describing agent installation request initiated by this Remote Tivoli Enterprise Monitoring Server. If the hub monitoring server does not complete the self-describing agent installation request within this time interval, the Remote Tivoli Enterprise Monitoring Server gives up waiting for completion and returns a status of KFASDM_ST_Server_TimedOut to the agent. One or more self-describing agents will continue to retry the self-describing agent installation for this product until the hub monitoring server product installation is confirmed. A valid value is a number in seconds greater than or equal to 180. The default value is 180 seconds. This parameter is an internal parameter that you might use, in a rare situation, to fine-tune the self-describing agent capability. In general, accept the default value of this variable.
KMS_TAPPLOG_MAX_QUEUED_
EVENTSDo not change this value unless directed to do so by IBM Software Support. This variable determines the maximum number of application support installation event notifications that are stored in the TAPPLOGT notification queue. Modifying this value might result in a loss of self-describing agent installation change notices and unpredictable self-describing agent results. A valid value is a number greater than or equal to 20. The default value is 100. This parameter is an internal parameter that you might use, in a rare situation, to fine-tune the self-describing agent capability. In general, accept the default value of this variable.
KMS_CONFIG_PROP_USE_CACHE Do not change this value unless directed to do so by IBM Software Support. When set to Y, this variable directs the Tivoli Enterprise Monitoring Server self-describing agent installation manager to use the local Tivoli Enterprise Monitoring Server internal cache mechanism of the application support installation records table to speed up self-describing agent operations. When set to N, operations against the application support installation records table use only the TEMS KEY1 database I/O routines and bypass the table internal cache. This might slow down self-describing agent operations. This parameter is an internal parameter that you might use, in a rare situation, to fine-tune the self-describing agent capability. In general, accept the default value of this variable. SOAP_IS_SECURE Enable this variable requires all users who submit CT_EMail or CT_Export requests to know the monitoring server credentials. By default this variable is disabled. TEMS_JAVA_BINPATH This variable locates the JAVA installation path within the z/OS USS environment. See Configure the Tivoli Enterprise Monitoring Server on z/OS. TEMS_MANIFEST_PATH=file_loc The location where you want the monitoring server to store the manifest and JAR files it collects from the self-describing agents. You must set this parameter to enable the self-describing capability. This parameter is normally set during component installation. Use the following steps to set the location where you want the monitoring server to store the manifest and JAR files:
- On Windows:
- On the computer where the monitoring server is installed, click Start → Programs → IBM Tivoli Monitoring → Manage Tivoli Monitoring Services.
- Right-click Tivoli Enterprise Monitoring Server and click Advanced→ Edit Variables.
- When you are asked if you want to stop the service, answer Yes.
- The default file location that is set for TEMS_MANIFEST_PATH is ITMinstall_dir\CMS\support where ITMinstall_dir is the directory where you installed the product. You can change this location if you want to do so.
- On Linux or UNIX:
- On the computer where the monitoring server is installed, change to the ITMinstall_dir/config/ directory.
- Open the tems_hostname_ms_tems_name.config file.
- The default file location that is set for TEMS_MANIFEST_PATH is ITMinstall_dir/tables/<TEMS_NAME>/support where ITMinstall_dir is the directory where you installed the product. You can change this location if you want to do so.
Parent topic:
Environment variables