| 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 Instance Attributes (QgldLstDirSvrInstA) API retrieves a list of directory server attributes including the following:
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:
| LSVR0200 | Retrieve a list of suffixes on the server. |
| LSVR0600 | Retrieve a list of referral servers. |
| LSVR0800 | Retrieve a list of IP addresses |
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.
Contains the name of the Directory Server instance. If a NULL pointer or blanks is specified, the default instance name, QUSRDIR is used.
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.
The LSVR0200 format is used to retrieve a list of the directory suffixes present on this server.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Displacement to next entry |
| 4 | 4 | BINARY(4) | Displacement to suffix |
| 8 | 8 | BINARY(4) | Length of suffix |
| 12 | C | BINARY(4) | Reserved |
| CHAR(*) | Suffix | ||
The LSVR0600 format is used to retrieve a list of referral servers.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Displacement to next entry |
| 4 | 4 | BINARY(4) | Displacement to referral server URL |
| 8 | 8 | BINARY(4) | Length of referral server URL. |
| 12 | C | BINARY(4) | Reserved |
| CHAR(*) | Referral server URL. | ||
The LSVR0800 format is used to retrieve a list of the IP addresses to which the directory server connects.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Displacement to next entry |
| 4 | 4 | BINARY(4) | Displacement to IP address |
| 8 | 8 | BINARY(4) | Length of IP address |
| CHAR(*) | IP address | ||
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.
Displacement to referral server URL. The displacement, in bytes, from the start of the current entry to the referral server URL field.
Displacement to suffix. The displacement, in bytes, from the start of the current entry to the suffix.
Format name specified. The format name specified on the call to this API.
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 is not allowed. An IPv4 address is expressed in standard dotted-decimal form www.xxx.yyy.zzz; for example, 130.99.128.1. 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 example, ::9.130.4.169). 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 returned:
| *ALL | All IP addresses defined on the local system will be bound to the server. |
Length of IP address. The length, in UTF-16 (CCSID 13488) characters, of the IP address field.
Length of referral server URL. The length, in UTF-16 (CCSID 13488) characters, of the referral server URL field.
Length of suffix. The length, in UTF-16 (CCSID 13488) characters, of the suffix field.
Referral server URL. The uniform resource locator (URL) of the referral server. This field is specified in UTF-16 (CCSID 13488).
Reserved. A reserved field. This field must be set to zero.
Suffix. The directory name for the starting point of a directory information tree.This field is specified in UTF-16 (CCSID 13488).
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| GLD0215 E | Server has not been configured. |
| GLD022F E | Format not supported. |