Configure Directory Server (QgldCfgDirSvr) API

The Configure Directory Server (QgldCfgDirSvr) API creates the initial directory server configuration. This includes identifying the library that will contain the underlying database objects, the administrator of the server, and the initial set of suffixes to be present on the server.

Starting with V6R1M0, this API is being deprecated. It is still supported with the V5R4M0 level of function but will no longer be enhanced. You should now use the QgldCfgDirSvrInst API.

Authorities and Locks

*ALLOBJ and *IOSYSCFG special authority is required to use this API.

Required Parameter Group

Input data

INPUT; CHAR(*)

Data that describes the desired directory server configuration. The content and format of this structure are determined by the format name. See Format of Input Data for a description of these formats.

Length of input data

INPUT; BINARY(4)

The length of the input data structure.

Format name

INPUT; CHAR(8)

The content and format of the input configuration data. The possible format name follows:

CFGD0100

Configure Directory Server.

See Format of Input Data for a description of these formats.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

Format of Input Data

For details about the format of the input data, see the following sections. For details about the fields in each format, see Field Descriptions.

CFGD0100 Format

This format is used to provide initial configuration data about the directory server.

Field Descriptions

Administrator DN. The distinguished name of a directory object that has access to all objects in the directory. This field is specified in UTF-16 (CCSID 13488).

Administrator password. The password used when you connect to the directory as the administrator. This field is specified in UTF-16 (CCSID 13488).

Database path. The path to an existing library containing the directory database objects. This is an integrated file system path name, for example, /QSYS.LIB/QDIRSRV.LIB. The library can exist in a system ASP or a basic user ASP (ASP value of 1 to 32). Also the library can exist in an independent ASP (ASP value greater than 32). This field is specified in UTF-16 (CCSID 13488).

Displacement to next suffix. The displacement, in bytes, from the start of the current suffix entry to the next suffix entry.

Displacement to suffix name. The displacement, in bytes, from the start of the current suffix entry to the suffix name field.

Length of administrator DN. The length, in UTF-16 (CCSID 13488) characters, of the administrator DN

Length of administrator password. The length, in UTF-16 (CCSID 13488) characters, of the administrator password field.

Length of database path. The length, in UTF-16 (CCSID 13488) characters, of the database path field.

Length of suffix name. The length, in UTF-16 (CCSID 13488) characters, of the suffix name field.

Number of suffixes. The number of suffixes present in the suffix list.

Offset to administrator DN. The offset, in bytes, from the start of the input data to the administrator DN field.

Offset to administrator password. The offset, in bytes, from the start of the input data to the administrator password field.

Offset to database path. The offset, in bytes, from the start of the input data to the database path field.

Offset to suffixes. The offset, in bytes, from the start of the input data to the list of suffixes.

Reserved. A reserved field. This field must be set to zero.

Suffixes. The list of suffixes to be present on the server. At least one must be present in the initial configuration.

Suffix name. The distinguished name of the root of a directory tree present on the server.This field is specified in UTF-16 (CCSID 13488).

Error Messages

[ Back to top | UNIX-Type APIs | APIs by category ]