LDAP-UX Client Services B.04.15 with Microsoft Windows Active Directory Server Administrator's Guide (edition 8)

NOTE: To support non-interactive use of the ldapuglist, ldapugadd, ldapugmod and
ldapugdel commands, you can use the LDAP_BINDDN and LDAP_BINDCRED environment
variables to specify an LDAP administrator's identity and password, and use the LDAP_UGCRED
environment variable to specify the user's or group's password being created or modified. To
prevent exposure of these environment variables, you must unset them after use. The shells(4)
command history log may contain copies of the executed commands that show setting of these
variables. You must protect access to a shell’s history file. Specification of the LDAP administrator’s
credentials on the command line is not allowed, because information about the currently running
processes can be exposed externally from the session. Using the -P command option eliminates
the LDAP_BINDDN and LDAP_BINDCRED environment variables by interactively prompting for
the required administrator's credentials. Using the -PP command option eliminates LDAP_UGCRED
by interactively prompting for the required password of the user or group being created or
modified.
Return Value Formats
Upon exit, ldapuglist, ldapugadd, ldapugmod, ldapugdel or ldapcfinfo returns a 0
(zero) exit status if no errors or warnings are encountered. A non-zero exit status is returned and
one or more messages are logged to stderr if these tools encounter an error or warnings. Messages
follow the below format:
ERROR: <code>:
<message>
or
WARNING: <code>:
<message>
Leading extra white space may be inserted to improve readability and follow 80 column screen
formatting. <code> is a programmatically parsable error key-string, while <message> is
human-readable text.
Common Return Codes
Table C-5 lists common return codes used by ldapuglist, ldapugadd, ldapugmod, ldapugdel
and ldapcfinfo.
For detailed information on a list of specific return codes for each tool, see the “Specific Return
Codes for ldapuglist”, “Specific Return Codes for ldapugadd”, “Specific Return Codes for
ldapugmod”, “Specific Return Codes for ldapugdel” or “Specific Return Codes for ldapcfinfo”
sections.
Table C-5 Common Return Codes
MessageReturn Code
Unable to initialize LDAP-UX library backend.
LDAP_INIT_FAILED
Cannot read the ldapux_profile.bin file.GET_LDAP_CONFIG_FAILED
Cannot reset the port number.
REPLACE_PORT_FAILED
The specified authentication method is invalid.
INVALID_AUTH_MATHOD
Unable to read input from stdin for the specified command option
value.
READ_INPUT_FAILED
The LDAP_BINDDN environment variable is set, but
LDAP_BINDCRED is not set.
GETENV_FAILED
The bind Password has expired.
BIND_PASSWORD_EXPIRED
The specified bind credential is invalid.
BIND_INVALID_CRED
LDAP-UX failed to bind to the LDAP directory server.
BIND_ERR
172 Command, Tool, Schema Extension Utility, and Migration Script Reference