5.4 Upgrading an existing Driver

The following sections provide information to help you upgrade an existing driver:

5.4.1 What’s New in Version 5.1.0.0?

Identity Manager 4.7 provides support for MapDB 3.0.5. To ensure that your driver works correctly with Identity Manager 4.7 engine, see Working with MapDB 3.0.5.

5.4.2 Working with MapDB 3.0.5

NetIQ recommends that you review the following sections before upgrading your driver to work with Identity Manager 4.7 engine:

Understanding Identity Manager 4.7 Engine Support for Driver Versions

  • Drivers shipped with Identity Manager 4.7 are compatible with Identity Manager 4.7 Engine or Remote Loader. You must perform the following actions to complete the driver upgrade:

    1. Upgrade the Identity Manager Engine.

    2. (Conditional) Upgrade the Remote Loader.

    3. Upgrade the driver.

    4. Manually remove the MapDB state cache files from the Identity Vault’s DIB directory. For more information, see Manually Removing the MapDB Cache Files.

  • Drivers shipped before Identity Manager 4.7 are not compatible with Identity Manager 4.7 Engine or Remote Loader.

  • Drivers shipped with Identity Manager 4.7 are not backward compatible with Identity Manager 4.6.x Engine or Remote Loader.

  • Drivers shipped with Identity Manager 4.7 are not backward compatible with Identity Manager 4.5.x Engine or Remote Loader.

Manually Removing the MapDB Cache Files

The Identity Manager engine upgrade process removes the existing MapDB driver work cache files (dx*) from the Identity Vault’s DIB directory (/var/opt/novell/eDirectory/data/dib or C:\Novell\NDS\DIBFiles). You must manually remove the existing MapDB state cache files for the driver after upgrading Identity Manager and the driver from a version prior to Identity Manager 4.7:

<Azure driver name>_obj.db.*

where * is the name of the state cache file for the driver. For example, <Azure driver name>_obj.db.t or <Azure driver name>_obj.db.p

This action ensures that your driver works correctly with Identity Manager 4.7 engine.

5.4.3 Upgrading the Driver

The driver upgrade process involves upgrading the installed driver packages and updating the existing driver files. These are independent tasks and can be separately planned for a driver. For example, you can update the driver packages and choose not to update the driver files at the same time. However, you are recommended to complete all the update steps within a short amount of time to ensure that the driver has the latest updates.

Before starting the upgrade process, ensure that you have taken a back-up of the current driver configuration.

Upgrading the Installed Packages

  1. Download the latest available packages.

    To configure Designer to automatically read the package updates when a new version of a package is available, click Windows > Preferences > NetIQ > Package Manager > Online Updates in Designer. However, if you need to add a custom package to the Package Catalog, you can import the package .jar file. For more information about creating custom packages, see Developing Packages in the NetIQ Designer for Identity Manager Administration Guide.

  2. Upgrade the installed packages.

    1. Open the project containing the driver.

    2. Right-click the driver for which you want to upgrade an installed package, then click Driver > Properties.

    3. Click Packages.

      If there is a newer version of a package, there is check mark displayed in the Upgrades column.

    4. Click Select Operation for the package that indicates there is an upgrade available.

    5. From the drop-down list, click Upgrade.

    6. Select the version that you want to upgrade to, then click OK.

      NOTE:Designer lists all versions available for upgrade.

    7. Click Apply.

    8. (Conditional) Fill in the fields with appropriate information to upgrade the package, then click Next.

      Depending on which package you selected to upgrade, you must fill in the required information to upgrade the package.

    9. Read the summary of the packages that will be installed, then click Finish.

    10. Review the upgraded package, then click OK to close the Package Management page.

      For detailed information, see the Upgrading Installed Packages in the NetIQ Designer for Identity Manager Administration Guide.

Updating the Driver Files

This section provides general instructions for updating the driver files. For information about updating the driver files to a specific version, search for that driver patch in the Patch Finder Download Page and follow the instructions from the Readme file that accompanies the driver patch release.

To update the driver files:

  1. Stop the driver instance by using iManager, Designer, or dxcmd by performing one of the following actions:

    • If the driver is running locally, stop the driver instance and the Identity Vault.

    • If the driver is running with a Remote Loader instance, stop the driver and the Remote Loader instance.

    For example, go to a command prompt on Linux and run ndsmanage stopall

  2. Download the driver patch file to a temporary folder on your server.

  3. Extract the contents of the driver patch file.

  4. Update the driver files:

    • Linux: Open a command prompt and run the following command to upgrade the existing RPM:

      rpm -Uvh <Driver Patch File Temporary Location>/linux/netiq-DXMLRESTAzure.rpm

    • Windows: Navigate to the <Extracted Driver Patch File Temporary Location>\windows folder and perform the following actions:

      • Copy the DXMLRESTAzureConfig.jar and DXMLRESTAzureShim.jar files to <IdentityManager installation>\NDS\lib or <IdentityManager installation>\RemoteLoader\<architecture>\lib folder.

      • Copy the DXMLRESTAzureUtil.jar file to <IdentityManager installation>\DirXMLUtilities\restazure\util folder.

  5. (Conditional) If the driver is running locally, start the Identity Vault and the driver instance.

    For example, open a command prompt on Linux and run ndsmanage startall

  6. (Conditional) If the driver is running with a Remote Loader, start the Remote Loader and the driver instance.