Import LDIF File (QgldImportLdif)



Required Parameter Group:





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(*)


Threadsafe: No

The Import LDIF File (QgldImportLdif) API imports directory server data from a Lightweight Directory Access Protocol Data Interchange Format (LDIF) file.

The Directory Services server must be stopped to use this API. To stop the server, use the End TCP/IP Server (ENDTCPSVR SVR(*DIRSRV)) command.

or provide the correct administrator DN and password.

Directory Authority
The caller must provide the administrator DN and password if the caller does not have *ALLOBJ and *IOSYSCFG special authorities.
Object Authorities
The caller must have Execute (*X) authority to each directory in the path name preceding the name of the LDIF file.
The caller must have Read (*R) authority to the LDIF file.

Required Parameter Group

Input data

INPUT; CHAR(*)

Input data required to identify the LDIF file and the administrator name and password. 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 data. The possible format name follows:

LDIF0100
Import LDIF file.

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 section. For details about the fields in each format, see Field Descriptions.

LDIF0100 Format


Offset Type Field
Dec Hex
0 0 BINARY(4) Offset to LDIF file
4 4 BINARY(4) Length of LDIF file
8 8 BINARY(4) Offset to administrator 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


CHAR(*) LDIF file


CHAR(*) Administrator DN


CHAR(*) Administrator password

Field Descriptions

Administrator DN. The distinguished name of the server administrator. This field is specified in UCS-2 (CCSID 13488).

Administrator password. The password for the server administrator. This field is specified in UCS-2 (CCSID 13488).

LDIF file. The integrated file system path name of the LDIF file to be used. This field is specified in UCS-2 (CCSID 13488).

Length of administrator DN. The length, in Unicode characters, of the administrator DN field.

Length of administrator password. The length, in Unicode characters, of the administrator password field.

Length of LDIF file. The length, in Unicode characters, of the LDIF file field.

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 LDIF file. The offset, in bytes, from the start of the input data to the LDIF file field.

Error Messages

GLD0125 E
Directory Services failed for reason code &4.
GLD0202 E
Administrator DN or password not correct.
GLD0213 E
Error opening or creating file.
GLD0215 E
Server has not been configured.
GLD0218 E
*ALLOBJ and *IOSYSCFG special authorities required.
GLD0225 E
&1 items added to directory, &2 items not added.
GLD0226 E
LDAP server is read-only.


Top | LDAP APIs List
APIs by category

[Information Center Home Page | Feedback ] [Legal | AS/400 Glossary]