Configuration file parameters

Configuration file parameters that apply to the HCD LDAP backend are set in the database section of the HCD LDAP backend in the IBM Tivoli Directory Server for z/OS configuration file ds.conf. Any parameter which is not known by the IBM Tivoli Directory Server for z/OS itself is passed to the HCD LDAP backend. The following list shows the supported parameters:

MinHcdInstances int

Specifies the minimum number of HCD instances started during startup of the HCD LDAP backend.

Default:

1

Range:

1-10

Constraints:

Must be less than or equal to the numerical value of MaxHcdInstances

For example, MinHcdInstances 1 causes the HCD LDAP backend to start exactly one initial HCD instance.

MaxHcdInstances int

Specifies the maximum number of HCD instances which can be used simultaneously by the HCD LDAP backend. The HCD LDAP backend will start new HCD instances dynamically if they are needed and if the maximum number has not already been reached.

Default:

3

Range:

1-10

Constraints:

Must be greater than or equal to the numerical value of MinHcdInstances

For example, MaxHcdInstances 3 will allow the HCD LDAP backend to use a maximum of three HCD instances simultaneously.

AllowSwitchTime int

Specifies the idle time in seconds after which the user ID of an HCD instance may be changed.

Default:

30

Range:

1-120

Constraints:

Must be less than the numerical value of ForceSwitchTime.

For example, AllowSwitchTime 30 will ensure that an HCD instance must be idle for at least thirty seconds before the HCD LDAP backend is allowed to switch the HCD instance to a different user ID.

ForceSwitchTime int

Specifies the idle time in seconds after which the user ID of an HCD instance is unconditionally reset. If a new request on behalf of this user ID arrives, this or any other free HCD instance has to be switched to that user ID.

Default:

600

Range:

60-3600

Constraints:

Must be greater than the numerical value of AllowSwitchTime.

Exception:

If the value specified for ForceSwitchTime is 0, a forced reset of the user ID will not be performed.

For example, ForceSwitchTime 600 will ensure that the user ID of an HCD instance is reset by the HCD LDAP backend after an idle time of 600 seconds (10 minutes) of the HCD instance

TransactionRollbackTime int

Specifies the idle time (in seconds) of an LDAP client after which a transaction, running on behalf of this LDAP client is rolled back automatically.

Default:

3600

Range:

10-3600

For example, TransactionRollbackTime 3600 will ensure that the HCD LDAP backend automatically rolls back a transaction which is still open on behalf of an LDAP client which has been idle for 3600 seconds (one hour).

Trace on|off

Determines whether the HCD instance running on behalf of the HCD LDAP backend generates an HCD trace (see HCD trace facility). Each HCD instance generates its own trace.

Default:

off

TraceDsnSuffix name

Specifies the suffix of the data set names where the traces of the HCD instances are to be written to. The effective name of the trace data set of one particular HCD instance is determined by concatenating the user ID associated with the HCD instance with the suffix.

Default:

HCD.TRACE

Constraints:

Only valid data set names with a maximum of 35 characters can be used. Note that the suffix must not be empty.

For example, assume you have set the TraceDsnSuffix to LDAP.HCD.TRACE and that you have specified Trace on. If an HCD instance now performs an LDAP request on behalf of user ID TEST and is, therefore, switched to this user ID, it will open the trace data set with name 'TEST.LDAP.HCD.TRACE' and DISP=OLD. This data set is then used for tracing the operations of the HCD instance.

Profile on|off

Determines whether the HCD instances running on behalf of the HCD LDAP backend will use an HCD profile on startup or user ID switch (see Defining an HCD profile). Each HCD instance uses its own profile, depending on the user ID which the HCD instance is currently related to.

Default:

off

ProfileDsnSuffix name

Specifies the suffix of the profile data set name used by the HCD instances. The effective name of the profile data set of one particular HCD instance is determined by concatenating the user ID associated with the HCD instance with the suffix.

Default:

HCD.PROFILE

Constraints:

Only valid data set names with a maximum of 35 characters can be used. Note that the suffix must not be empty.

For example, assume you have set ProfileDsnSuffix to LDAP.HCD.PROFILE and you have specified Profile on, If an HCD instance now performs an LDAP request on behalf of user ID TEST and is thus switched to this user ID, it will open the profile data set with name 'TEST.LDAP.HCD.PROFILE' and DISP=SHR. The contents of the data set will be read and the HCD instance will be set up accordingly.

TransformAttributeValues on|off

Specifies whether the values of the attributes hcdIodfDescription and hcdDescription are interpreted as being in IBM-939 or not. In general, these values are interpreted as being in IBM-037. It is important to have the correct setting because the IBM Tivoli Directory Server for z/OS communicates with LDAP clients using UTF-8 representation and the HCD LDAP backend has to convert attribute values appropriately.

Default:

off