List Directory Server Attributes (QgldLstDirSvrA)



Required Parameter Group:




1
Qualified user space name
Input
Char(20)
2
Format name
Input
Char(8)
3
Error code
I/O
Char(*)


Threadsafe: No

The List Directory Server Attributes (QgldLstDirSvrA) API retrieves a list of directory server attributes including the following:

User Space Library Authority
*EXECUTE
User Space Lock
An exclusive, no-read lock is obtained on the list space.

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

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.

Format name

INPUT; CHAR(8)

The content and format of the data to be retrieved. The possible format names follow:

LSVR0200
Retrieve a list of suffixes on the server.
LSVR0300
Retrieve a list of database indexes maintained by the server.
LSVR0500
Retrieve a list of network server publishing attributes associated with the LDAP server.
LSVR0600
Retrieve a list of referral servers.

See Format of Output 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 Output Data

The user space will contain:

For details about the user area and generic header, see . 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.

LSVR0200 Format

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

LSVR0300 Format

The LSVR0300 format is used to retrieve information about database indexes maintained by the server. The indexes are used to speed up retrieval of objects when a directory server client searches for specified object attributes.

Starting with V4R5M0, this format is not supported. Database index information is to be retrieved using an LDAP client or the Directory Management Tool (DMT) starting with V4R5M0.
Offset Type Field
Dec Hex
0 0 BINARY(4) Displacement to next entry
4 4 BINARY(4) Displacement to attribute name
8 8 BINARY(4) Length of attribute name
12 C BINARY(4) Index type
16 10 BINARY(4) Reserved


CHAR(*) Attribute name

LSVR0500 Format

The LSVR0500 format is used to retrieve the network server publishing attributes associated with the server.
Offset Type Field
Dec Hex
0 0 BINARY(4) Displacement to next entry
16 10 BINARY(4) Displacement to publishing agent name
12 C BINARY(4) Length of publishing agent name
16 10 BINARY(4) Displacement to server name
20 14 BINARY(4) Length of server name
24 18 BINARY(4) Displacement to bind DN
28 1C BINARY(4) Length of bind DN
32 20 BINARY(4) LDAP port number
36 24 BINARY(4) Connection type
40 28 BINARY(4) Displacement to parent distinguished name
44 2C BINARY(4) Length of parent distinguished name
48 30 BINARY(4) Publishing agent disabled
52 34 BINARY(4) Reserved


CHAR(*) Publishing agent name


CHAR(*) Server name


CHAR(*) Bind DN


CHAR(*) Parent distinguished name

LSVR0600 Format

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.

Field Descriptions

Attribute name. The name of a directory object attribute for which database indexes will be maintained. This field is specified in UCS-2 (CCSID 13488). The following special value may also be returned:

*DEFAULT
The rules for this attribute apply to all attributes for which no explicit rules have been defined.

Bind DN. A distinguished name to use when publishing objects to the directory. This field is specified in UCS-2 (CCSID 13488).

Connection type. The type of connection to use to the LDAP server. The following values may be returned:

1
Nonsecure
2
Secured, using SSL

Displacement to attribute name. The displacement, in bytes, from the start of the current entry to the attribute name field.

Displacement to bind DN. The displacement, in bytes, from the start of the current entry to the bind DN field.

Displacement to next entry. The displacement, in bytes, from the start of the current entry to the next entry.

Displacement to parent distinguished name. The displacement, in bytes, from the start of the current entry to the parent distinguished name field.

Displacement to publishing agent name. The displacement, in bytes, from the start of the current entry to the publishing agent name field.

Displacement to referral server URL. The displacement, in bytes, from the start of the current entry to the referral server URL field.

Displacement to server name. The displacement, in bytes, from the start of the current entry to the server name 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.

Index type. The kind of database indexes that will be created for an attribute. Creating database indexes improved the performance of directory searches on those attributes. The following values may be returned:

0
No indexes will be created for the attribute.
1
Equal

LDAP port number. The LDAP server's TCP/IP port.

Length of attribute name. The length, in Unicode characters, of the attribute name field.

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

Length of parent distinguished name. The length, in Unicode characters, of the parent distinguished name field.

Length of publishing agent name. The length, in Unicode characters, of the publishing agent name field.

Length of referral server URL. The length, in Unicode characters, of the referral server URL field.

Length of server name. The length, in Unicode characters, of the server name field.

Length of suffix. The length, in Unicode characters, of the suffix field.

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

Parent distinguished name. The parent distinguished name to be used. This field is specified in UCS-2 (CCSID 13488).

Publishing agent name. The agent which will publish information to a directory server and parent distinguished name. This field is specified in UCS-2 (CCSID 13488).

Publishing agent disabled. Indicates whether or not the publishing agent is disabled. The configuration data still exists, but publishing has been disabled for the publishing agent. The following values may be returned:

0
The publishing agent is enabled.
1
The publishing agent is disabled.

Referral server URL. The uniform resource locator (URL) of the referral server. This field is specified in UCS-2 (CCSID 13488).

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

Server name. The name of the server. This field is specified in UCS-2 (CCSID 13488).

Suffix. The directory name for the starting point of a directory information tree. This field is specified in UCS-2 (CCSID 13488).

Error Messages

CPF24B4 E
Severe error while addressing parameter list.
GLD0215 E
Server has not been configured.
GLD022F E
Format not supported.

Top | LDAP APIs List
APIs by category
[Information Center Home Page | Feedback ] [Legal | AS/400 Glossary]