Tivoli Enterprise Portal Server environment variables

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 Portal Server environment variables

The table in this section lists the Tivoli Enterprise Portal 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 Portal Server environment variables
Variable Value type Purpose
DSUSER1 Y or N Part of a set of 9 variables DSUSER1...DSUSER9 that you can set using the tacmd configureportalserver command. See the IBM Tivoli Monitoring Administrator's Guide.
KBB_RAS1 Trace specification string
Default tracing level:
KBB_RAS1=ERROR

Diagnosing client request problems:
KBB_RAS1=ERROR (UNIT:ctsql IN ER)
(UNIT:ctdata IN ER)

Diagnosing client or Tivoli Enterprise Monitoring
Server interaction problems: KBB_RAS1=ERROR
(UNIT:ctsql IN ER) (UNIT:ctdata IN ER)
(UNIT:ctcmw IN ER) (UNIT:kv4 IN ER)

Diagnosing SQL generation problems:
KBB_RAS1=ERROR (UNIT:ctsql IN ER)
(UNIT:ctdata IN ER) (UNIT:ctreport ALL)

Diagnosing login problems: KBB_RAS1=ERROR
(UNIT:ctsql IN ER) (UNIT:ctdata IN ER)
(UNIT:ctauth ALL)
KDH_SERVICEPOINT Service point string 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>.

KD8_VIEWMODEL_THREAD_
POOL_SIZE
positive integer greater than 1 It is not recommended to change the value of this parameter. This value specifies the number of threads available to compute DataProvider model data. A value too high or too small can cause the DataProvider to fail. It should be changed only by the IBM Tivoli Monitoring Administrator if the DataProvider is operating in a high traffic environment, that is a lot of users or requests in a small period of time. This value must be set in kfwenv (Windows) or in cq.ini (UNIX/Linux). Follow these steps to change the value of KD8_VIEWMODEL_THREAD_POOL_SIZE:

Make a backup copy of the cq.ini or kfwenv file.

Change the value of KD8_VIEWMODEL_THREAD_POOL_SIZE

Restart the Tivoli Enterprise Portal Server.

In general, accept the default value of this parameter.
KD8_VM_IMPORT_ID user ID Disable the importing of View Models all together or control which users can import View Models.
When a Dashboard user logs in, a View Model import request is sent to the dashboard data provider. View Models in the data provider define the characteristics of what data the Dashboards can display. This occurs once and it happens automatically. Any Dashboard update requiring an updated View Model also happens automatically.
This variable is optional and not set by default, which means any Dashboard user that has been authenticated can import View Models. To control which user is allowed to do the import, set this variable to a particular ID such as KD8_VM_IMPORT_ID=user1. To disable all users from doing an import of View Models, set KD8_VM_IMPORT_ID=$nouser@ or any name that you know does not match a Dashboard user ID.
KD8_VM_IMPORT_ID is set in the following file:

On Windows: <ITM_HOME>\CNPS\kfwenv
For example: C:\IBM\ITM\CNPS\kfwenv

On Linux/UNIX: <ITM_HOME>/config/cq.ini
For example: /opt/IBM/ITM/config
You must restart the Tivoli Enterprise Portal Server after changing the value of KD8_VM_IMPORT_ID.

KFW_CMW_SITUATION_
ADMIN_SUPPRESS
Y or N To prevent an event from appearing in the situation event console after its situation was stopped.

KFW_CMW_SITUATION_
FANOUT_SUPPRESS
Y or N To enable or disable the broadcast of administration events without an origin node (for example, stopped events) to all managed systems connected to the event's thrunode. Default is Y.
When KFW_CMW_SITUATION_ADMIN_SUPPRESS=N, you must define KFW_CMW_SITUATION_FANOUT_SUPPRESS as N to clear the stopped event in the Situation Event Console after a restart.

KFW_CMW_SPECIAL_HUB_
ENTERPRISE=N
Y or N Default is N. When set to Y, associates situations to the Tivoli Enterprise Portal Server.

KFW_DATABUS_INPUT_TRACE_
IGNORE_HEARTBEAT
Y or N Default is N. Reduces trace volume by skipping client heartbeat requests when (UNIT:ctdata IN ER) request tracing is used.

KFW_DATABUS_QUERY_
VERBOSE
Y or N Default is N. Tivoli Enterprise Portal Server client side response time and request life cycle tracing.
KFW_FIPS_ENFORCED Y or N Default is N. The monitoring server and agent components of the Tivoli Management Services are already FIPS compliant. This variable specifies whether the encryption methods used by the portal server should comply with the Federal Information Processing Standard (FIPS) 140–2 specification. If your environment must conform to the FIPS 140–2 standard, specify Y.
KFW_INHIBIT_OPSLOG_FROM_
RAS
Message ID string
Specifies a list of Message IDs to turn off information messages in the Tivoli Enterprise Server log. For example, to turn off the following KFW1353I message:
KFW1353I Take action 'xxxxxxx' executed on 
<nodename> by <userid> from <ip address>
You specify the message ID as follows:
KFW_INHIBIT_OPSLOG_FROM_RAS=KFW1353I 
To turn off multiple information messages specify the message ID's as follows:
KFW_INHIBIT_OPSLOG_FROM_RAS=KFW1353I KFW1010I 
KFW1100I
KFW_IOR_IHS_HTTP_PORT
port number
You must set this variable to indicate the redirected port number you want to use. Add the following statement to the cq.ini file associated with the Tivoli Enterprise Portal Server, and then recycle the Tivoli Enterprise Portal Server before re-testing:
KFW_IOR_IHS_HTTP_PORT=<port#>
Replace <port#> with the redirected port number you want to use, for example 8080.
This is only one of the variables you need to set in order to reconfigure the HTTP port. See Control port number assignments.
KFW_MIGRATE_CMS Y or N Default is N. When set to Y, causes initial migration of managed objects and user IDs from the monitoring server the first time the Tivoli Enterprise Portal Server starts after installation.
KFW_MIGRATE_FORCE Y or N Default is N. When set to Y, SQL seed files are processed even if the date, time, or size of the files have not changed since prior seeding. This occurs when running the buildpresentation.bat file (Windows), and when running the InstallPresentation.sh file or reconfiguring the Tivoli Enterprise Portal Server (UNIX/Linux). To be effective, this value must be set in kfwalone (Windows) or in cq.ini or lnxenvnocms (UNIX/Linux).
KFW_MIGRATE_VERBOSE Y or N Default is N. When set to Y, provides greater detail about operations performed in migrate.log when seeding the Tivoli Enterprise Portal Server database. This occurs when running the buildpresentation.bat file (Windows), and when running the InstallPresentation.sh file or reconfiguring the Tivoli Enterprise Portal Server (UNIX/Linux). To be effective, this value must be set in kfwalone (Windows) or in cq.ini or lnxenvnocms (UNIX/Linux).
KFW_ORBPARM
Message ID string
To restrict the portal server to using AES 128 bit encryption algorithms, set the following property in cq.ini:
KFW_ORBPARM=-Dvbroker.security.cipherList=TLS_
ECDH_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDH_RSA_
WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA 
If the Tivoli Enterprise Portal Server is running on Windows, add this environment variable to the kfwenv file and restart the Tivoli Enterprise Portal Server.
KFW_REPORT_FIND_
WAREHOUSE_AT_STARTUP
Y or N Default is Y. When set to Y, the portal server queries the data warehouse during startup. If set to N, the warehouse will be initialized at the first deliberate query instead of pre-initialized.
KFW_REPORT_ROW_LIMIT positive integer or 0 Default is 100000. Set this variable to limit the number of rows returned for a report request. A KFWITM574W warning message displays in the view indicating the result set was truncated. Set to 0 to disable. This variable affects only report requests when the user selects the "return all rows" option on the View Properties window.
KFW_REPORT_TERM_ BREAK_POINT Y or N Default is N. When set to Y, specifies the point where a historical request selects from short-term or long-term history data.
KFW_REPORT_WITH_UR Y or N Default is N. When set to Y, it appends "with UR" to the SQL statement against the DB2 Tivoli Data Warehouse or Summarization and Pruning table issued by the Tivoli Enterprise Portal Server. It does not lock out the row and tables in the database; and allows other commands access to the Warehouse database at the same time.
KFW_SQL_VERBOSE Y or N Default is N. When set to Y, provides RAS1 trace of each SQL statement issued by the Tivoli Enterprise Portal Server to the Tivoli Enterprise Monitoring Server or to the DB2/ODBC data source. The use of this variable is deprecated because the same capability is available using the standard RAS1 trace setting "KBB_RAS1=ERROR (UNIT:ctsql IN ER)"
MSG_MODE kms or MSG2 Specify kms if you want to use IBM Tivoli Monitoring Operations Logging. Specify MSG2 to use MSG2 logging.
TEPS_FIPS_MODE Y or N Default is N. This variable specifies whether the encryption methods used by the tacmd command-line interface should comply with the Federal Information Processing Standard (FIPS) 140–2 specification. If your environment must conform to the FIPS 140–2 standard, specify Y.
TEPS_SDA Y or N N disables the self-describing agent capability at the portal server, whereas Y enables it. The self-describing agent capability is enabled by default at the portal server.
Do not specify YES or NO; instead, always specify Y or N.
TEPS_MANIFEST_PATH Any valid path
The location where you want the portal server to store the manifest and JAR files it collects from the self-describing agents. This parameter is normally set during component installation. Use the following steps:

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 Portal 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 TEPS_MANIFEST_PATH is ITMinstall_dir\cnps\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 <install_dir>/config/ directory.

Open the cq.config file.

The default file location that is set for TEPS_MANIFEST_PATH is ITMinstall_dir/arch/cq/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

+
Search Tips | Advanced Search

Variable	Value type	Purpose
DSUSER1	Y or N	Part of a set of 9 variables DSUSER1...DSUSER9 that you can set using the tacmd configureportalserver command. See the IBM Tivoli Monitoring Administrator's Guide.
KBB_RAS1	Trace specification string	Default tracing level: KBB_RAS1=ERROR Diagnosing client request problems: KBB_RAS1=ERROR (UNIT:ctsql IN ER) (UNIT:ctdata IN ER) Diagnosing client or Tivoli Enterprise Monitoring Server interaction problems: KBB_RAS1=ERROR (UNIT:ctsql IN ER) (UNIT:ctdata IN ER) (UNIT:ctcmw IN ER) (UNIT:kv4 IN ER) Diagnosing SQL generation problems: KBB_RAS1=ERROR (UNIT:ctsql IN ER) (UNIT:ctdata IN ER) (UNIT:ctreport ALL) Diagnosing login problems: KBB_RAS1=ERROR (UNIT:ctsql IN ER) (UNIT:ctdata IN ER) (UNIT:ctauth ALL)
KDH_SERVICEPOINT	Service point string	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>.
KD8_VIEWMODEL_THREAD_ POOL_SIZE	positive integer greater than 1	It is not recommended to change the value of this parameter. This value specifies the number of threads available to compute DataProvider model data. A value too high or too small can cause the DataProvider to fail. It should be changed only by the IBM Tivoli Monitoring Administrator if the DataProvider is operating in a high traffic environment, that is a lot of users or requests in a small period of time. This value must be set in kfwenv (Windows) or in cq.ini (UNIX/Linux). Follow these steps to change the value of KD8_VIEWMODEL_THREAD_POOL_SIZE: Make a backup copy of the cq.ini or kfwenv file. Change the value of KD8_VIEWMODEL_THREAD_POOL_SIZE Restart the Tivoli Enterprise Portal Server. In general, accept the default value of this parameter.
KD8_VM_IMPORT_ID	user ID	Disable the importing of View Models all together or control which users can import View Models. When a Dashboard user logs in, a View Model import request is sent to the dashboard data provider. View Models in the data provider define the characteristics of what data the Dashboards can display. This occurs once and it happens automatically. Any Dashboard update requiring an updated View Model also happens automatically. This variable is optional and not set by default, which means any Dashboard user that has been authenticated can import View Models. To control which user is allowed to do the import, set this variable to a particular ID such as KD8_VM_IMPORT_ID=user1. To disable all users from doing an import of View Models, set KD8_VM_IMPORT_ID=$nouser@ or any name that you know does not match a Dashboard user ID. KD8_VM_IMPORT_ID is set in the following file: On Windows: <ITM_HOME>\CNPS\kfwenv For example: C:\IBM\ITM\CNPS\kfwenv On Linux/UNIX: <ITM_HOME>/config/cq.ini For example: /opt/IBM/ITM/config You must restart the Tivoli Enterprise Portal Server after changing the value of KD8_VM_IMPORT_ID.
KFW_CMW_SITUATION_ ADMIN_SUPPRESS	Y or N	To prevent an event from appearing in the situation event console after its situation was stopped.
KFW_CMW_SITUATION_ FANOUT_SUPPRESS	Y or N	To enable or disable the broadcast of administration events without an origin node (for example, stopped events) to all managed systems connected to the event's thrunode. Default is Y. When KFW_CMW_SITUATION_ADMIN_SUPPRESS=N, you must define KFW_CMW_SITUATION_FANOUT_SUPPRESS as N to clear the stopped event in the Situation Event Console after a restart.
KFW_CMW_SPECIAL_HUB_ ENTERPRISE=N	Y or N	Default is N. When set to Y, associates situations to the Tivoli Enterprise Portal Server.
KFW_DATABUS_INPUT_TRACE_ IGNORE_HEARTBEAT	Y or N	Default is N. Reduces trace volume by skipping client heartbeat requests when (UNIT:ctdata IN ER) request tracing is used.
KFW_DATABUS_QUERY_ VERBOSE	Y or N	Default is N. Tivoli Enterprise Portal Server client side response time and request life cycle tracing.
KFW_FIPS_ENFORCED	Y or N	Default is N. The monitoring server and agent components of the Tivoli Management Services are already FIPS compliant. This variable specifies whether the encryption methods used by the portal server should comply with the Federal Information Processing Standard (FIPS) 140–2 specification. If your environment must conform to the FIPS 140–2 standard, specify Y.
KFW_INHIBIT_OPSLOG_FROM_ RAS	Message ID string	Specifies a list of Message IDs to turn off information messages in the Tivoli Enterprise Server log. For example, to turn off the following KFW1353I message: KFW1353I Take action 'xxxxxxx' executed on <nodename> by <userid> from <ip address> You specify the message ID as follows: KFW_INHIBIT_OPSLOG_FROM_RAS=KFW1353I To turn off multiple information messages specify the message ID's as follows: KFW_INHIBIT_OPSLOG_FROM_RAS=KFW1353I KFW1010I KFW1100I
KFW_IOR_IHS_HTTP_PORT	port number	You must set this variable to indicate the redirected port number you want to use. Add the following statement to the cq.ini file associated with the Tivoli Enterprise Portal Server, and then recycle the Tivoli Enterprise Portal Server before re-testing: KFW_IOR_IHS_HTTP_PORT=<port#> Replace <port#> with the redirected port number you want to use, for example 8080. This is only one of the variables you need to set in order to reconfigure the HTTP port. See Control port number assignments.
KFW_MIGRATE_CMS	Y or N	Default is N. When set to Y, causes initial migration of managed objects and user IDs from the monitoring server the first time the Tivoli Enterprise Portal Server starts after installation.
KFW_MIGRATE_FORCE	Y or N	Default is N. When set to Y, SQL seed files are processed even if the date, time, or size of the files have not changed since prior seeding. This occurs when running the buildpresentation.bat file (Windows), and when running the InstallPresentation.sh file or reconfiguring the Tivoli Enterprise Portal Server (UNIX/Linux). To be effective, this value must be set in kfwalone (Windows) or in cq.ini or lnxenvnocms (UNIX/Linux).
KFW_MIGRATE_VERBOSE	Y or N	Default is N. When set to Y, provides greater detail about operations performed in migrate.log when seeding the Tivoli Enterprise Portal Server database. This occurs when running the buildpresentation.bat file (Windows), and when running the InstallPresentation.sh file or reconfiguring the Tivoli Enterprise Portal Server (UNIX/Linux). To be effective, this value must be set in kfwalone (Windows) or in cq.ini or lnxenvnocms (UNIX/Linux).
KFW_ORBPARM	Message ID string	To restrict the portal server to using AES 128 bit encryption algorithms, set the following property in cq.ini: KFW_ORBPARM=-Dvbroker.security.cipherList=TLS_ ECDH_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDH_RSA_ WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA If the Tivoli Enterprise Portal Server is running on Windows, add this environment variable to the kfwenv file and restart the Tivoli Enterprise Portal Server.
KFW_REPORT_FIND_ WAREHOUSE_AT_STARTUP	Y or N	Default is Y. When set to Y, the portal server queries the data warehouse during startup. If set to N, the warehouse will be initialized at the first deliberate query instead of pre-initialized.
KFW_REPORT_ROW_LIMIT	positive integer or 0	Default is 100000. Set this variable to limit the number of rows returned for a report request. A KFWITM574W warning message displays in the view indicating the result set was truncated. Set to 0 to disable. This variable affects only report requests when the user selects the "return all rows" option on the View Properties window.
KFW_REPORT_TERM_ BREAK_POINT	Y or N	Default is N. When set to Y, specifies the point where a historical request selects from short-term or long-term history data.
KFW_REPORT_WITH_UR	Y or N	Default is N. When set to Y, it appends "with UR" to the SQL statement against the DB2 Tivoli Data Warehouse or Summarization and Pruning table issued by the Tivoli Enterprise Portal Server. It does not lock out the row and tables in the database; and allows other commands access to the Warehouse database at the same time.
KFW_SQL_VERBOSE	Y or N	Default is N. When set to Y, provides RAS1 trace of each SQL statement issued by the Tivoli Enterprise Portal Server to the Tivoli Enterprise Monitoring Server or to the DB2/ODBC data source. The use of this variable is deprecated because the same capability is available using the standard RAS1 trace setting "KBB_RAS1=ERROR (UNIT:ctsql IN ER)"
MSG_MODE	kms or MSG2	Specify kms if you want to use IBM Tivoli Monitoring Operations Logging. Specify MSG2 to use MSG2 logging.
TEPS_FIPS_MODE	Y or N	Default is N. This variable specifies whether the encryption methods used by the tacmd command-line interface should comply with the Federal Information Processing Standard (FIPS) 140–2 specification. If your environment must conform to the FIPS 140–2 standard, specify Y.
TEPS_SDA	Y or N	N disables the self-describing agent capability at the portal server, whereas Y enables it. The self-describing agent capability is enabled by default at the portal server. Do not specify YES or NO; instead, always specify Y or N.
TEPS_MANIFEST_PATH	Any valid path	The location where you want the portal server to store the manifest and JAR files it collects from the self-describing agents. This parameter is normally set during component installation. Use the following steps: 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 Portal 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 TEPS_MANIFEST_PATH is ITMinstall_dir\cnps\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 <install_dir>/config/ directory. Open the cq.config file. The default file location that is set for TEPS_MANIFEST_PATH is ITMinstall_dir/arch/cq/support where ITMinstall_dir is the directory where you installed the product. You can change this location if you want to do so.