DirX Identity Environment Variables

This chapter is a table that describes the environment variables used by DirX Identity programs and processes. The table includes the variable name and description, the commands and processes that use the variable, and the variable default value, which is used if the variable is not set.

Name	Description	Used by…	Default
DIRX_CLCFG_FILE	Supplies the name of the directory client configuration file.	The metacp command	$DIRXMETAHUB_INST_PATH/ client/conf/dirxcl.cfg
DIRX_CTX_LIMIT	Specifies the maximum memory size of the metacp process in MB.	metacp	Unlimited
DIRX_DEL_TIME	Specifies the time threshold (in hours) for trace and exception message file deletion. Any trace or exception file (LOG, USR, EXC* in the trace file directories), that was created more than DIRX_DEL_TIME before process startup will be deleted.	All processes	No trace file is deleted.
DIRX_LOG_DATASIZE	Supplies the maximum length of data to be logged in a log record.	All processes	1024
DIRX_LOGCFG_FILE	Supplies the name of the log configuration file.	All processes	$DIRXMETAHUB_INST_PATH/ client/conf/dirxlog.cfg
DIRX_MAX_THREADS	Specifies the maximum number of parallel threads. The maximum value is 512.	All processes	128 This value must be adapted according your system configuration.
DIRXMETAHUB_INST_PATH / DIRXIDENTITY_INST_PATH	Supplies the pathname of the base directory in which DirX Identity is installed.	All processes	C:\Program Files\ DirX\Identity (on Windows)
DIRX_SVC_EXTINFO	Specifies the information that is required to evaluate log files that have been generated by non-DirX client or server components such as metacp. Specify the value of the environment variable in the following format: library_name1, <function_table_name1 [,message_table_name1] \|-,message_table_name1> [:library_name2, <function_table_name2 [,message_table_name2] \|-,message_table_name2>] … [:library_nameN, <function_table_nameN [,message_table_nameN] \|-,message_table_nameN>] where: library_name Specifies the name of a dynamic link or shared library with the extension .dll, .so, .sl that contains an additional function or message table. funtion_table_name Specifies the name of the function table that contains the function pointers of additional encoding-/decoding-functions (XDR-functions). message_table_name Specifies the name of the message table that contains all additional serviceability messages. Example: libdirxapi_md,metadir_ids,mdi_msg_table	The metacpdump and metahubdump command	None. The environment variable is set appropriately in the commands.
DIRX_TRUSTED_CA	Specifies the full pathname of the file that contains the server certificates or CA certificates used for SSL binds. (See the description of SSL/TLS Certificate Database the DirX Identity Program Files chapter.)	The metacp obj bind command	When this environment variable is not set, the file $DIRXMETAHUB_INST_PATH/ client/conf/cert8.db is used.
DIRX_SET_TLS_LEVEL_MIN	Specifies the minimum version of the TLS protocol. The valid values are "1.0", "1.1", "1.2" and "1.3".	metacp, IdS-C server	1.0
DIRX_SET_TLS_LEVEL_MAX	Specifies the maximum version of the TLS protocol. The valid values are "1.0", "1.1", "1.2" and "1.3".	metacp, IdS-C server	1.3
DIRX_KEY3DB_FILE	Specifies the full pathname of the file that contains the private keys used for SASL-authenticated binds with the EXTERNAL mechanism. (See the description of SSL/TLS Certificate Database the DirX Identity Program Files chapter.)	The metacp obj bind command	When this environment variable is not set, the file $DIRXMETAHUB_INST_PATH/ client/conf/key3.db is used
DXI_JAVA_HOME	Specifies dxi_java_home in native notation. For Windows platforms, this variable is only defined after execution of a command like this (including quotes): call "%DIRXIDENTITY_INST_PATH%\setdxienv.bat"	Java and keytool processes of DirX Identity. Exceptions (see below)	None. The variable is set appropriately in the environment (Unix platforms) in the file install_path/setdxienv.bat (Windows platforms), respectively.

Name

Description

Used by…

Default

DIRX_CLCFG_FILE

Supplies the name of the directory client configuration file.

The metacp command

$DIRXMETAHUB_INST_PATH/
client/conf/dirxcl.cfg

DIRX_CTX_LIMIT

Specifies the maximum memory size of the metacp process in MB.

metacp

Unlimited

DIRX_DEL_TIME

Specifies the time threshold (in hours) for trace and exception message file deletion. Any trace or exception file (LOG*, USR*, EXC* in the trace file directories), that was created more than DIRX_DEL_TIME before process startup will be deleted.

All processes

No trace file is deleted.

DIRX_LOG_DATASIZE

Supplies the maximum length of data to be logged in a log record.

All processes

1024

DIRX_LOGCFG_FILE

Supplies the name of the log configuration file.

All processes

$DIRXMETAHUB_INST_PATH/
client/conf/dirxlog.cfg

DIRX_MAX_THREADS

Specifies the maximum number of parallel threads.

The maximum value is 512.

All processes

128

This value must be adapted according your system configuration.

DIRXMETAHUB_INST_PATH / DIRXIDENTITY_INST_PATH

Supplies the pathname of the base directory in which DirX Identity is installed.

All processes

C:\Program Files\
DirX\Identity
(on Windows)

DIRX_SVC_EXTINFO

Specifies the information that is required to evaluate log files that have been generated by non-DirX client or server components such as metacp. Specify the value of the environment variable in the following format:

library_name1,
<function_table_name1
[,message_table_name1]

|-,message_table_name1>

[:library_name2,
<function_table_name2
[,message_table_name2]

|-,message_table_name2>]

…

[:library_nameN,
<function_table_nameN
[,message_table_nameN]

|-,message_table_nameN>]

where:

library_name
Specifies the name of a dynamic link or shared library with the extension .dll, .so, .sl that contains an additional function or message table.

funtion_table_name
Specifies the name of the function table that contains the function pointers of additional encoding-/decoding-functions (XDR-functions).

message_table_name
Specifies the name of the message table that contains all additional serviceability messages.

Example:

libdirxapi_md,metadir_ids,mdi_msg_table

The metacpdump and metahubdump command

None.
The environment variable is set appropriately in the commands.

DIRX_TRUSTED_CA

Specifies the full pathname of the file that contains the server certificates or CA certificates used for SSL binds. (See the description of SSL/TLS Certificate Database the DirX Identity Program Files chapter.)

The metacp obj bind command

When this environment variable is not set, the file $DIRXMETAHUB_INST_PATH/
client/conf/cert8.db
is used.

DIRX_SET_TLS_LEVEL_MIN

Specifies the minimum version of the TLS protocol. The valid values are "1.0", "1.1", "1.2" and "1.3".

metacp,

IdS-C server

1.0

DIRX_SET_TLS_LEVEL_MAX

Specifies the maximum version of the TLS protocol. The valid values are "1.0", "1.1", "1.2" and "1.3".

metacp,

IdS-C server

1.3

DIRX_KEY3DB_FILE

Specifies the full pathname of the file that contains the private keys used for SASL-authenticated binds with the EXTERNAL mechanism. (See the description of SSL/TLS Certificate Database the DirX Identity Program Files chapter.)

The metacp obj bind command

When this environment variable is not set, the file $DIRXMETAHUB_INST_PATH/
client/conf/key3.db
is used

DXI_JAVA_HOME

Specifies dxi_java_home in native notation. For Windows platforms, this variable is only defined after execution of a command like this (including quotes):
call "%DIRXIDENTITY_INST_PATH%\setdxienv.bat"

Java and keytool processes of DirX Identity. Exceptions (see below)

None. The variable is set appropriately in the environment (Unix platforms) in the file install_path/setdxienv.bat (Windows platforms), respectively.

The environment variable DXI_JAVA_HOME is not used for these applications:

Java-based Server for Windows and Linux. For these platforms, the Java server uses the configured properties vm and dxi.java.home.bin (Windows only) in the file idmsvc.ini in install_path*/ids-j-technical-domain-name-S*number*/bin* which is created during configuration of a Java-based Server.
Web Applications deployed into Tomcat. The JRE used by these files depends on the Tomcat configuration and can also be the JRE for DirX Identity.

TLS Support

metacp is linked with NSS 3.42 (Network Security Service) that supports TLS1.3. (Note that SSL3.0 has been disabled.).

The accepted range of TLS versions is set to TLS1.0 up to TLS1.3 by default. This range can be restricted with the environment variables DIRX_SET_TLS_LEVEL_MIN and DIRX_SET_TLS_LEVEL_MAX. See the previous table for descriptions of these variables.