Retrieve Directory Server Attributes (QgldRtvDirSvrA)



Required Parameter Group:





1
Receiver variable
Output
Char(*)
2
Length of receiver variable
Input
Binary(4)
3
Format name
Input
Char(8)
4
Error code
I/O
Char(*)


Threadsafe: No

The Retrieve Directory Server Attributes (QgldRtvDirSvrA) API retrieves information about the directory server configuration. It can be used to retrieve information about:

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The variable to receive output data. See Format of Output Data for a description of the format of the output data associated with a specific format name.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable area.

Format name

INPUT; CHAR(8)

The format name identifying the type of information to be retrieved. The possible format names follow:

RSVR0100
Basic server configuration
RSVR0400
Attributes for publishing users in an LDAP directory

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

For details about the format of the output data, see the following sections. For details about the fields in each format, see Field Descriptions.

RSVR0100 Format

This format is used to retrieve basic server configuration information.
Offset Type Field
Dec Hex
0 0 BINARY(4) Bytes returned
4 4 BINARY(4) Bytes available
8 8 BINARY(4) Version
12 C BINARY(4) Read only
16 10 BINARY(4) Server is replica
20 14 BINARY(4) Security
24 18 BINARY(4) Unencrypted port number
28 1C BINARY(4) Encrypted port number
32 20 BINARY(4) Current cipher protocols
36 24 BINARY(4) Installed cipher protocols
40 28 BINARY(4) Search time limit
44 2C BINARY(4) Search size limit
48 30 BINARY(4) Maximum connections
52 34 BINARY(4) Reserved
56 38 BINARY(4) Referral port
60 3C BINARY(4) Password format
64 40 BINARY(4) Offset to referral server
68 44 BINARY(4) Length of referral server
72 48 BINARY(4) Offset to administrator distinguished name (DN)
76 4C BINARY(4) Length of administrator DN
80 50 BINARY(4) Offset to update DN
84 54 BINARY(4) Length of update DN
88 58 BINARY(4) Reserved
92 5C BINARY(4) Reserved
96 60 BINARY(4) Offset to database path
100 64 BINARY(4) Length of database path
104 68 BINARY(4) Reserved
108 6C BINARY(4) SSL authentication method
112 70 BINARY(4) Number of database connections
116 74 BINARY(4) Schema checking level
120 78 BINARY(4) Offset to master server URL
124 7C BINARY(4) Length of master server URL
128 80 BINARY(4) Change log indicator
132 84 BINARY(4) Maximum number of change log entries
136 88 BINARY(4) Terminate idle connections


CHAR(*) Referral server


CHAR(*) Administrator DN


CHAR(*) Update DN


CHAR(*) Database path


CHAR(*) Master server URL

RSVR0400 Format

This format is used to retrieve the attributes for publishing users in an LDAP directory. User information from the system distribution directory can be published to an LDAP server by the Synchronize System Distribution Directory to LDAP (QGLDSSDD) API and from AS/400 Operations Navigator. The publishing attributes define how to publish user information.
Offset Type Field
Dec Hex
0 0 BINARY(4) Bytes returned
4 4 BINARY(4) Bytes available
8 8 BINARY(4) Offset to server name
12 C BINARY(4) Length of server name
16 10 BINARY(4) LDAP port number
20 14 BINARY(4) Connection type
24 18 BINARY(4) Offset to parent distinguished name.
28 1C BINARY(4) Length of parent distinguished name.


CHAR(*) Server name


CHAR(*) Parent distinguished name.

Field Descriptions

Administrator DN. A distinguished name (DN) that has access to all objects in the directory. This field is specified in UCS-2 (CCSID 13488).

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Change log indicator. The indicator of whether a change log exists for entries that have been added, changed and deleted. The following values may be specified:

0
No, a change log does not exist
1
Yes, a change log exists

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

1
Nonsecure
2
Secured, using SSL

Current cipher protocols. The cipher protocols that the server allows when using encrypted connections. The value is the sum of zero or more of the following values:

0x0100
Triple Data Encryption Standard (DES) Secure Hash Algorithm (SHA) (U.S.)
0x0200
DES SHA (U.S)
0x0400
Rivest Cipher 4 (RC4) SHA (U.S.)
0x0800
RC4 Message Digest (MD) 5 (U.S.)
0x1000
RC2 MD5 (export)
0x2000
RC4 MD5 (export)

Database path. The integrated file system path name of the library containing the directory database. This field is specified in UCS-2 (CCSID 13488).

Encrypted port number. The port number to use for encrypted connections. The standard port number for encrypted connections is 636.

Installed cipher protocols. The cipher protocols installed on the system. Refer to the current cipher protocols field for a description of the values.

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

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

Length of database path. The length, in Unicode characters, of the database path field.

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

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

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

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

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

Master server URL. The uniform resource locator (URL) of the master server. This field is specified in UCS-2 (CCSID 13488). The following special value may be returned:

*NONE
No value is specified.

Maximum connections. Returns the maximum number of simultaneous connections that can be established with the server. The following special value may be specified:

0
Do not limit the number of connections.

Maximum number of change log entries. The maximum number of change log entries that can be stored. If the maximum is reached, the change log entries will be deleted starting with the oldest entry. This value only valid if 'Change log indicator' is set to 1. The following special values may be specified:

0
The number of change log entries is not limited.

Number of database connections. The number of database connections used by the server.

Offset to administrator DN. The offset, in bytes, from the start of the receiver variable to the administrator DN field.

Offset to database path. The offset, in bytes, from the start of the receiver variable to the database path field.

Offset to master server URL. The offset, in bytes, from the start of the receiver variable to the master server URL field.

Offset to parent distinguished name. The offset, in bytes, from the start of the receiver variable to the parent distinguished name field.

Offset to referral server. The offset, in bytes, from the start of the receiver variable to the referral server field.

Offset to server name. The offset, in bytes, from the start of the receiver variable to the server name field.

Offset to update DN. The offset, in bytes, from the start of the receiver variable to the update DN field.

Parent distinguished name. The parent distinguished name for published objects. For example, if the parent distinguished name is "ou=rochester, o=ibm, c=us", a published directory object for user John Smith might be "cn=john smith, ou=rochester, o=ibm, c=us". This field is specified in UCS-2 (CCSID 13488).

Password format. The format of the encrypted password. The following values may be specified:

1
Unencrypted.
2
SHA. (Default)
3
MD5.
4
Crypt (The password is one-way hashed using a modified DES algorithm. The "crypt" algorithm originally was used by many Unix operating systems for password protection.)

Read only. Whether the directory server allows changes to be made to the directory contents. The following values may be specified:

0
The directory server is not read only. Updates are allowed to the directory.
1
The directory server is read only. Updates are not allowed to the directory.

Referral port. An optional port number to be returned to a client when a request is made for a directory object that does not reside on this server. The referral port and referral server together are used to form a referral URL. The following special value may be specified:

0
No port number is returned as part of the referral.

Referral server. The IP name of a server to return to a client when a request is made for a directory object that does not reside on this server. This field is specified in UCS-2 (CCSID 13488). The referral port and referral server are used together to form a referral URL. The following special value may be specified:

*NONE
No value is specified.

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

Schema checking level. The level of schema checking performed by the server. The following values may be specified:

0
None.
1
LDAP version 2.
2
LDAP version 3 strict.
3
LDAP version 3 lenient.

Search size limit. The maximum number of entries that the server will return for a given search request. The following special value may be specified:

0
Do not limit the number of entries returned.

Search time limit. The maximum time, in seconds, that the server will spend performing a given search request. The following special value may be specified:

0
Do not limit the search time.

Security. Whether the server is to use encrypted connections. The following values may be specified:

1
Allow unencrypted connections only.
2
Allow encrypted connections only.
3
Allow both encrypted and unencrypted connections.

Note: SSL is used for encrypted connections to the server.

Server is replica. Whether the server is a master server or a replica server. The following values may be specified:

0
The server is a master server for the directory suffixes present on the server.
1
The server is a replica server for the directory suffixes present on the server.

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

SSL authentication method. The method used during SSL authentication. The following values may be specified:

1
Server authentication.
3
Server and client authentication.

Terminate idle connections. The server will terminate idle connections when necessary. The following values may be specified:

0
Do not terminate idle connections.
1
Terminate idle connections.

Unencrypted port number. The port number to be used for unencrypted connections. The standard port number is 389.

Update DN. The distinguished name that the master server must use when propagating directory updates to this replica server. This field is specified in UCS-2 (CCSID 13488). The following value may be specified:

*NONE
No value is specified.

Use encrypted connections. Whether this server should use encrypted connections when making updates to the replica server. The following values may be specified:

0
Use unencrypted connections.
1
Use encrypted connections.

Version. Returns the version of the LDAP server.

Error Messages

CPFA314 E
Memory allocation error.
GLD0215 E
Server has not been configured.

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