Delete Directory Server Instance (QgldDltDirSvrInst) API


  Required Parameter Group:

1 Instance name Input Char(8)
2 Input data Input Char(*)
3 Length of input data Input Binary(4)
4 Format name Input Char(8)
5 Error code I/O Char(*)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDUAPI

  Threadsafe: No

The Delete Directory Server Instance (QgldDltDirSvrInst) API deletes the configuration file, configuration directory, configuration library, and schema of an existing directory server instance. This optionally includes deleting the libraries that contains the underlying database objects and the change log database.


Authorities and Locks

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


Required Parameter Group

Instance name
Input; CHAR(8)

Contains the name of the Directory Server instance to be deleted.

Input data
INPUT; CHAR(*)

Data that describes the extent of the delete. 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:

DLTD0100 Delete 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.


DLTD0100 Format

This format is used to indicate if the databases for the directory server are to be deleted.

Offset Type Field
Dec Hex
0 0 BINARY(4) Delete database files
4 4 BINARY(4) Reserved


Field Descriptions

Delete database files. Whether the database objects are to be deleted.

0 The directory server database library and change log database library will not be deleted.
1 The directory server database library and change log database library will be deleted.

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


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3C1D E Length specified in parameter &1 not valid.
CPF3C21 E Format name &1 is not valid.
GLD0203 E IBM® Directory Server &1 name is not valid.
GLD0215 E IBM Tivoli® Directory Server server has not been configured.
GLD021C E *ALLOBJ and *IOSYSCFG special authority required.
GLD0276 E Server instance &1 cannot be deleted while the server is active.



API introduced: V6R1

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