| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Error code | I/O | Char(*) |
| 5 | Instance name | Input | Char(8) |
The List Directory Server Instances (QgldLstDirSvrs) API retrieves a list of directory server instances.
The user space that is to receive the created list. The first 10 characters contain the user space name, and the second 10 characters contain the name of the library where the user space is located. The content and format of this space is determined by the format name. See Format of Output Data for a description of these formats.
The content and format of the data to be retrieved. The possible format names follow:
| LSVR0100 | Retrieve a list of directory server names. |
See Format of Output 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.
The user space contains:
For details about the user area and generic header, see User spaces. For details about the remaining items, see the following sections. For detailed descriptions of the fields in the list that is returned, see Field Descriptions.
When you retrieve list entry information from the list space, do not use the entry size that is returned in the generic header. Instead, use the displacement to next entry field that is returned in each list entry. If you do not use the displacement to next entry field, the results may not be valid.
If there are no directory server instances configured, the number of entries will be 0.
The LSVR0100 format is used to retrieve a list of the names of directory server instances present on this system.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Displacement to next entry |
| 4 | 4 | BINARY(4) | Displacement to server instance name |
| 8 | 8 | BINARY(4) | Length of server instance name |
| 12 | C | BINARY(4) | Server instance status |
| 16 | 10 | BINARY(4) | Displacement to server instance description |
| 20 | 14 | BINARY(4) | Length of server instance description |
| 24 | 18 | BINARY(4) | LDAP server port |
| 28 | 1C | BINARY(4) | Encrypted port number |
| 32 | 20 | BINARY(4) | Reserved |
| CHAR(*) | Server instance name | ||
| CHAR(*) | Server instance description | ||
Displacement to next entry. The displacement, in bytes, from the start of the current entry to the next entry. A zero displacement indicates this is the last entry.
Displacement to server instance description. The displacement, in bytes, from the start of the current entry to the server instance description field.
Displacement to server instance name. The displacement, in bytes, from the start of the current entry to the server instance name field.
Format name specified. The format name specified on the call to this API.
Encrypted port number. The port number to use for encrypted connections.
LDAP port number. The LDAP server's TCP port.
Length of server instance description. The length, in UTF-16 (CCSID 13488) characters, of the server instance description field.
Length of server instance name. The length, in UTF-16 (CCSID 13488) characters, of the server instance name field.
Reserved. A reserved field. This field must be set to zero.
Server instance description. The description of the server instance. This field is specified in UTF-16 (CCSID 13488).
Server instance name. The name of the server instance. This field is specified in UTF-16 (CCSID 13488).
Server instance status. The status of the server instance.
| 0 | The server instance is not active. |
| 1 | The server instance is active. |
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| GLD0215 E | Server has not been configured. |
| GLD022F E | Format not supported. |
| GLD0272 E | Server migration to an instance failed. |
| GLD0273 E | Server migration to latest version failed. |