ASP 
number for database ASP number for change log database| 1 | Input data | Input | Char(*) |
| 2 | Length of input data | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
| 5 | Instance name | Input | Char(8) |
The Configure Directory Server Instance (QgldCfgDirSvrInst) API creates a directory server instance. This includes identifying the library that will contain the underlying database objects, the administrator of the server instance, and the initial set of suffixes to be present on the server instance.
*ALLOBJ and *IOSYSCFG special authority is required to use this API.
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.
The length of the input data structure.
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.
The structure in which to return error information. For the format of the structure, see Error code parameter.
Contains the name of the Directory Server instance to be created. If a NULL pointer or blanks is specified, the default instance name, QUSRDIR is used.
For details about the format of the input data, see the following sections. For details about the fields in each format, see Field Descriptions.
This format is used to provide initial configuration data about the directory server.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to database path |
| 4 | 4 | BINARY(4) | Length of database path |
| 8 | 8 | BINARY(4) | Offset to administrator distinguished name (DN) |
| 12 | C | BINARY(4) | Length of administrator DN |
| 16 | 10 | BINARY(4) | Offset to administrator password |
| 20 | 14 | BINARY(4) | Length of administrator password |
| 24 | 18 | BINARY(4) | Offset to suffixes |
| 28 | 1C | BINARY(4) | Number of suffixes |
| 32 | 20 | BINARY(4) | Level indicator |
| 36 | 24 | BINARY(4) | Create database |
| 40 | 28 | BINARY(4) | ASP number for database |
| 44 | 2C | BINARY(4) | Offset to change log database path |
| 48 | 30 | BINARY(4) | Length of change log database path |
| 52 | 34 | BINARY(4) | Create change log database |
| 56 | 38 | BINARY(4) | ASP number for change log database |
| 60 | 3C | BINARY(4) | Offset to IP addresses |
| 64 | 40 | BINARY(4) | Number of IP addresses |
| 68 | 44 | BINARY(4) | Nonencrypted port number |
| 72 | 48 | BINARY(4) | Encrypted port number |
| 76 | 4C | BINARY(4) | Autostart |
| 80 | 50 | BINARY(4) | Offset to server instance description |
| 84 | 54 | BINARY(4) | Length of server instance description |
| CHAR(*) | Database path | ||
| CHAR(*) | Administrator DN | ||
| CHAR(*) | Administrator password | ||
| CHAR(*) | Change log database path | ||
| CHAR(*) | Server instance description | ||
| Suffixes: | |||
| 0 | 0 | BINARY(4) | Displacement to next suffix |
| 4 | 4 | BINARY(4) | Displacement to suffix name |
| 8 | 8 | BINARY(4) | Length of suffix name |
| CHAR(*) | Suffix name | ||
| IP addresses: | |||
| 0 | 0 | BINARY(4) | Displacement to next suffix |
| 4 | 4 | BINARY(4) | Displacement to IP address |
| 8 | 8 | BINARY(4) | Length of IP address |
| CHAR(*) | IP address | ||
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).
ASP number for database. Specifies the number of the
auxiliary storage pool (ASP) where storage for the directory
database library is allocated. This is only used if the Create database field is
set to Yes. If not specified, the default is 1. If the create database field is
set to No, this field must be set to 0.
255 that is the number of the system
or basic user ASP.
ASP number for change log database. Specifies the
number of the auxiliary storage pool (ASP) where storage
for the directory change log database library is allocated. This is only used
if the Create change log database field is set to Yes. If not specified, the
default is 1. If the create change log database field is set to No, this field
must be set to 0.
255 that is the number of the system
or basic user ASP.
Autostart. Indicates if the instance starts automatically. The default for this field is 0, do not automatically start.
| 0 | No, do not automatically start |
| 1 | Yes, automatically start |
Change log database path. The path to a library to contain
the change log database objects. This is an integrated file system path name,
for example, /QSYS.LIB/QDIRSRV.LIB. If an existing library is to be used, 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). If you do not want a change
log, specify the length and offset to this field of 0.
Create database. Whether the database object is to be created or if it must previously exist. The default for this field is 0, the database will not be created.
| 0 | No, the database will not be created, it must previously exist |
| 1 | Yes, the database will be created, it cannot previously exist |
Create change log database. Whether the change log database object is to be created or if it must previously exist. The default for this field is 0, the change log database will not be created.
| 0 | No, the change log database will not be created, it must previously exist |
| 1 | Yes, the change log database will be created, it cannot previously exist |
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 IP address. The displacement, in bytes, from the start of the current entry to the IP address field.
Displacement to next entry. The displacement, in bytes, from the start of the current entry to the next entry in the input data.
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.
Encrypted port number. The port number to use for encrypted connections. The standard port number for encrypted connections (SSL) is 636. Valid port numbers are in the range 1 to 65535. The default port number is 636.
IP address. The IPv4 or IPv6 address of the client for which the directory server will accept connections. The IP address must already exist to be specified. A value of hexadecimal zeroes and leading zeroes are not allowed. An IPv4 address is expressed in standard dotted-decimal form www.xxx.yyy.zzz. An IPv6 address always has at least one occurrence of a colon (':') in the format. Some possible IPv6 address formats would be: ::x (for example, ::1) or ::w.xxx.y.zzz. For further IPv6 examples and explanation, refer to the Usage Notes section in the Convert IPv4 and IPv6 Addresses Between Text and Binary Form (inet_pton) API. This field is specified in UTF-16 (CCSID 13488).
The following special value may be specified:
| *ALL | All IP addresses defined on the local system will be bound to the server. |
IP addresses. The list of IP addresses to use. A value of "*ALL" will mean to use all IP addresses on the system and must be the only value when used. Otherwise, this is a list of unique IP addresses and at least 1 must be present or a value of *ALL must be used. If this field is not included, the default will be to use all IP addresses on the system.
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 change log database path. The length, in UTF-16 (CCSID 13488) characters, of the change log database path field. The default is 0, no change log database path specified.
Length of database path. The length, in UTF-16 (CCSID 13488) characters, of the database path field.
Length of IP address. The length, in UTF-16 (CCSID 13488) characters, of the IP address field.
Length of server instance description. The length, in UTF-16 (CCSID 13488) characters, of the server instance description field. The default is 0, no description..
Length of suffix name. The length, in UTF-16 (CCSID 13488) characters, of the suffix name field.
Level indicator. The level indicator of the data supplied for a format. See the format descriptions for possible uses and values of this field.
Nonencrypted port number. The port number to be used for nonencrypted connections. The standard port number is 389. Valid port numbers are in the range 1 to 65535. The default nonencrypted port number is 389.
Number of suffixes. The number of suffixes present in the suffix list.
Number of IP addresses. The number of IP addresses present in the IP address list. The default is 0, no IP addresses specified.
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 change log database path. The offset, in bytes, from the start of the input data to the change log database path field. The default is 0, no change log database path.
Offset to database path. The offset, in bytes, from the start of the input data to the database path field.
Offset to IP addresses. The offset, in bytes, from the start of the input data to the list of IP addresses. The default is 0, no IP addresses provided.
Offset to server instance description. The offset, in bytes, from the start of the input data to the server instance description. The default is 0, no description.
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.
Server instance description. The server instance description for the server instance. This field is specified in UTF-16 (CCSID 13488). If not specified, there will be no server instance description.
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).
| Message ID | Error Message Text |
|---|---|
| CPF2209 E | Library &1 not found. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C17 E | Error occurred with input data parameter. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPFA0DB E | Object name not a QSYS object. |
| CPFA314 E | Memory allocation error. |
| GLD0201 E | Directory Server Instance already exists. |
| GLD0203 E | IBM® Directory Server &1 name is not valid. |
| GLD0205 E | Administrator DN not valid. |
| GLD0206 E | Administrator Password not valid. |
| GLD020A E | Suffix not valid. |
| GLD0211 E | Value &1 was specified at offset &2 in input format &3 and is not valid. |
| GLD0217 E | A value was specified in list entry &1 that is not valid. Reason code &2. |
| GLD021C E | *ALLOBJ and *IOSYSCFG special authority required. |
| GLD0222 E | Length &1 specified in input data is not valid. |
| GLD0223 E | Database path not valid. |
| GLD0228 E | Validation list not created. |
| GLD022A E | Server configuration cannot be modified while the server is active. |
| GLD0232 E | Configuration cannot contain overlapping suffixes. |
| GLD0233 E | Cannot set database library to &1. |
| GLD0235 E | IP address &1 is not valid. |
| GLD0236 E | Database library must be in system ASP or basic user ASP. |
| GLD0243 E | Change Log path not valid. |
| GLD0244 E | Database library &1 already exists. |
| GLD0245 E | Configuration library &1 already exists. |
| GLD0247 E | Error translating administrator password. |
| GLD0248 E | Database ASP number is not valid. |
| GLD0249 E | Change log database ASP number is not valid. |
| GLD0250 E | Internal error creating server instance &1. |
| GLD0251 E | IP address &1 is not valid. |
| GLD0252 E | Server instance directory already exists. |
| GLD0253 E | Error copying file for instance &1. |
| GLD0272 E | Server migration to instance failed. |