VSI LDAP for OpenVMS

V2.6-3 Release Notes

November 2022

Based on OpenLDAP 2.6.3

VSI LDAP V2.6-3 for OpenVMS IA64

VSI-I64VMS-LDAP-V0206-3-1.PCSI

----------------------------------------------------------

VMS Software, Inc. is pleased to provide you with the latest release of 
VSI LDAP for OpenVMS. VSI LDAP (Lightweight Directory Access Protocol) 
is based on the 2.6.3 release from the OpenLDAP Group.

See http://www.openldap.org for information about OpenLDAP.

There are post installation activities that need to be performed. This includes
the following items that are described in detail:

- Ensuring LDAP startup and logical name creation files are executed

- Updating or copying the necessary startup, shutdown, and configuration files
  from the installed template files

- Running the Installation Verification Program (IVP)

The LDAP installation creates the following directory structure and files in 
PCSI$DESTINATION, which defaults to SYS$SYSDEVICE:[VMS$COMMON]:

    [LDAP]                     top-level LDAP directory
    [LDAP.BIN.IA64]   tools for the platform
    [LDAP.CONF]                configuration files and directory
    [LDAP.CONF.SLAPD_D]        default configuration directory
    [LDAP.DOC]                 ldap.org provided documentation & information
    [LDAP.INCLUDE]             C Header (.H) files
    [LDAP.LIB.IA64]   images for the platform
    [LDAP.MODULES.IA64] modules images for the platform
    [LDAP.SCHEMA]              server administration schemas and ldifs
    [LDAP.TEST]                test scripts
    [LDAP.TEST.DATA]           test data
    [LDAP.TEST.IA64]  binaries for tests
    [LDAP.VAR]                 server work directory
    [LDAP.VAR.OPENLDAP-DATA]   server database directory

    [SYS$STARTUP]              startup and shutdown files 
    [SYSHLP]                   release notes
    [SYSHLP.EXAMPLES.LDAP]     LDAP examples
    [SYSTEST]                  LDAP$IVP.COM

* Note: Each system will have only one xxx.PLATFORM.DIR, depending on the 
        architecture of the system.
        
By default OpenLDAP will be installed in SYS$SYSDEVICE:[VMS$COMMON]. If you wish to install 
the software in an alternative location this can be achieved using the /DESTINATION qualifier 
with the PRODUCT INSTALL command to specify the desired location; however it is important 
to note that an additional manual step will then be required to complete the installation. 
Specifically, when an alternative destination is specified, start-up, shutdown, and related 
command procedures will be placed into subdirectories residing under the specified destination 
directory. 
If you wish to run these files from your standard SYS$STARTUP and SYS$MANAGER directories 
they will need to be copied from the destination subdirectories into the appropriate locations.


LDAP startup, shutdown, and logical names
-------------------------------------------
Add LDAP$DEFINE_LOGICALS.COM to SYS$MANAGER:SYSTARTUP_VMS.COM to define LDAP$ logical
names and install shareable images. 

For example:

   $ if f$search("sys$startup:ldap$define_logicals.com") .nes. ""
   $ then
   $    @sys$startup:ldap$define_logicals.com
   $ endif

The LDAP$STARTUP.COM startup command procedure in the above example will 
automatically define the LDAP$ executive-mode logical names in the SYSTEM 
logical name table and logical names for shareable images that reside 
in the [LDAP.LIB.IA64] directory.

Also, add LDAP$DEASSIGN_LOGICALS.COM to SYS$MANAGER:SYSHUTDWN.COM to remove installed 
images and deassign the LDAP$ logical names at system shutdown.

For example:

   $ if f$search("sys$startup:ldap$deassign_logicals.com") .nes. ""
   $ then
   $    @sys$startup:ldap$deassign_logicals.com
   $ endif

The LDAP$STARTUP.COM command procedure starts up the LDAP server using the current
server configuration that resides in the [LDAP.CONF] directory
The LDAP$SHUTDOWN.COM command procedure shutting down the LDAP server.
These command procedures can be also added into the SYSTARTUP_VMS.COM and SYSHUTDWN.COM
accordingly.

LDAP server debug level
-------------------------------------------
Define LDAP$DEBUG logical to set server debug level.
For example for full dedug info:

$ define LDAP$DEBUG "-1"

LDAP Symbols
--------------
LDAP foreign symbols are defined with the LDAP command procedure
SYS$STARTUP:LDAP$SETUP.COM as follows:

$ @SYS$STARTUP:LDAP$SETUP.COM


Installation Verification Procedure (IVP)
-----------------------------------------
Normally the Installation Verification Procedure (IVP) is executed when 
LDAP is installed. To run the LDAP IVP manually, type the following 
command:

$ @SYS$TEST:LDAP$IVP.COM

Note that the IVP would not be executed at installation time if the 
PCSI qualifier /NOTEST was utilized.

Restrictions
------------
Backends turned off in the OpenVMS version:
ndb   - MySQL NDB Cluster backend
perl  - Perl backend
sql   - SQL backend
wt    - Wired Tiger backend
sasl  - Cyrus SASL

Untested functionality:
dirsync  - requires working with MSAD
dsee     - requires working with Directory Server Enterprise Edition

Known issues
------------
This OpenVMS version works incorrectly with hotp, remoteauth overlays.
It also has an issue with delta consumer config synchronization.

Removing LDAP
---------------
To remove LDAP from the system disk or destination directory, type
the following command:

$ PRODUCT REMOVE LDAP

Note that some files may remain and will not be removed when the VSI LDAP 
product is removed. These are generated files such as LDAP$IVP.LOG that 
gets created by running the IVP test program.