4.5 Configuring Driver Sets

A driver set is a container that holds Identity Manager drivers. Only one driver set can be active on a server at a time. As a result, all active drivers must be grouped into the same driver set. To view or change settings, double-click a driver set in the Modeler.

4.5.1 Driver Set General Options

When you create an Identity Vault, a driver set is added to the vault by default.

Figure 4-4 A Driver Set in an Identity Vault

You can add other driver sets by dragging the Driver Set object from the palette to the Modeler.

From the General page, you can specify or change driver set values.

Figure 4-5 Driver Set Properties

Table 4-4 Driver Set Settings




The name of the Driver Set object (for example, DriverSet1.)

Create a new partition on this driver set

We recommend that you select this option. For details, see “Planning the Technical Details of your Identity Manager Implementation” in the XYZ Guide.

Deploy context

The Identity Vault assigns the default DN container value to all driver sets. If you specify a DN container here on the Driver Set object, that setting takes precedence over the Identity Vault setting.

You can manually enter this value or browse for it.

4.5.2 Driver Set Global Configuration Values

Global configuration values (GCVs) are settings that are similar to driver parameters. Global configuration values can be specified for a driver set as well as an individual driver. If a driver does not have a GCV, the driver inherits the value for that GCV from the driver set.

GCVs allow you to specify settings for Identity Manager features such as password synchronization and driver heartbeat, as well as settings that are specific to the function of an individual driver configuration. Some GCVs are provided with the drivers, but you can also add your own. You can refer to these values in a policy to help you customize your driver configuration.

To view or change the driver set's GCV settings, double-click the driver set. From the Global Configuration Values page, you can add, edit, or remove values, or edit the XML file for the driver set. To select a value, click on the value or the control field to the right of the value’s name. Use the Add, Edit, Remove, and Edit XML buttons at the bottom of the page.

For more information on global configuration values, see Section 4.7.2, Driver Global Configuration Values.

4.5.3 Java Environment Parameters

The Java Environment Paramaters enable you to configure the Java virtual machine (JVM) on the Metadirectory server asociated with the driver set. The parameters apply only if the driver set is associated with a Metadirectory server that is version 3.6 or newer.

Table 4-5 Java Environment Parameters Settings



Classpath Additions

Specifies additional paths for the JVM to search for package (.jar) and class (.class) files. Using this parameter is the same as using the java -classpath command. When entering multiple class paths, separate them with a semi colon (;) for a Windows JVM and a colon (:) for Unix/Linux JVMs.

JVM Options

Specifies additional options to use with the JVM. Refer to your JVM documentation for valid options.

Initial Heap Size

Specifies the initial (minimum) heap size available to the JVM. Increasing the initial hap size can improve startup time and performance. Enter a numeric value followed by g, m, or k (case insensitive). If no letter size is specified, the size defaults to bytes. Using this parameter is the same as using the java -Xms command.

Refer to your JVM documentation for information about the JVMs default initial heap size.

Maximum Heap Size

Specifies the maximum heap size available to the JVM. Enter a numeric value followed by g, m, or k (case insensitive). If no letter size is specified, the size defaults to bytes. Using this parameter is the same as using the java -Xmx command.

Refer to your JVM documentation for information about the JVMs default maximum heap size.

4.5.4 Driver Set Log Levels

The Driver Set Log Level options enable you to view high-level information. For lower-level information, use the Trace option.

Figure 4-6 Driver Set Options for Logging

By default, logging is turned off. To track errors, messages, or events, change the default.

  1. Double-click the driver set.

  2. Select Driver Set Log Level.

  3. Select a logging option.

    The log option that you select determines which messages are available in the log.

  4. To configure audit instrumentation, select Log specific events, click the event selector button, select events, then click OK.

    The Update only the last log time option updates the time stamp to indicate the last activity of the driver.

  5. Specify the number of entries in the log.

    The default is 50 entries (lines) in the log. If you want a longer history, increase the number.

  6. Save changes by clicking OK.

The driver set log contains messages from the engine when it tries to start or stop drivers. To view the log, use iManager. Select the Status Log icon above the Identity Vault in the Identity Manager Overview.

4.5.5 Driver Set Named Passwords

The Named Passwords property page allows you to manage (add, edit, delete) named passwords for the selected driver set. When defined in the driver set, named passwords are available to all drivers in the driver set.

NOTE:If you create a named password of the same name in both the driver set and a driver in the driver set, the named password settings in the driver take precedence.

You can define named passwords on both drivers and driver sets. For more information about named passwords, see Section 4.7.6, Driver Named Passwords.

4.5.6 Driver Set Server List

After adding one or more servers to the Identity Vault, you can view or change the driver set’s server association.

Figure 4-7 Server List

Select a server in the Available Servers list, then use the arrows to move the server to the Selected Server list. If a server is not in the Available Servers list, you must first add it by editing the Identity Vault properties. See Section 4.3, Configuring Identity Vaults.

4.5.7 Driver Set Trace

Although a driver set has nothing to trace, you can add a trace level to a driver set. The Trace setting specifies a trace level used with all drivers associated with the driver set.

With the trace set, DS Trace displays Identity Manager and DirXML® events as the engine processes the events. The trace level affects each driver in the driver set. Use the trace level for troubleshooting issues with the drivers when they are deployed. DS Trace displays the output of the specified trace level.

WARNING:You should use the trace level only for testing or for troubleshooting driver issues. Setting a driver trace level on a production driver can cause Identity Manager server to process events slowly.

To set a driver set’s trace characteristics:

  1. In the Outline view or Modeler, right-click the driver set, then select Properties.

  2. In the driver properties, select Trace in the left navigation area.

  3. On the Trace page, specify the trace settings for the driver set, then click OK.

Table 4-6 Driver Set Trace Settings



Trace level

The IDM engine supports the following trace levels:

  • Trace level 0: Displays fatal messages, errors, warnings and successes.

  • Trace levels 1: Displays informational messages in addition to the information from Trace level 0.

  • Trace level 2: Displays contents of XML documents in addition to the information from Trace level 1.

  • Trace level 3: Displays policy information in addition to the information from Trace level 2.

XSL Trace Level

DS Trace displays XSL events. Set this trace level only when troubleshooting XSL style sheets. If you do not want to see XSL information, set the level to 0.

Java Debug Port

Allows developers to attach a Java debugger.

Trace File

When a value is set in this field, all Java information for the driver is written to file. The value for this field is the path for that file.

As long as the file is specified, Java information is written to this file. If you do not need to debug Java, leave this field blank.

Trace File Encoding

The trace file uses the system’s default encoding. You can specify another encoding if desired.

This option is only available if the driver set is associated with a server that is version 3.6 or newer.

Trace File Size Limit

Sets a limit for the Java trace file. Select Unlimited to allow the file to grow to fill the disk.

The following methods help you capture and save Identity Manager trace information.


Open the Control Panel, select NDS Services, then click DS Trace.DLM > Start. A window named NDS Server Trace Utility opens.

To set the filters to capture the DirXML trace information:

  1. Click Edit > Options > Clear All.

  2. Click the boxes next to DirXML and DirXML Drivers, then click OK.

To save the information to a file:

  1. Click File > New.

    A dialog box prompts for a filename.

  2. Enter a filename with the extension of .log.

  3. To stop capturing information, click File > Close.

    The file is saved.


Use the ndstrace command at the console to display the Identity Manager events. The exit command quits the trace utility.

Table 4-7 ndstrace Commands



Set ndstrace=nodebug

Turns off all trace flags.

Set ndstrace on

Displays trace messages to the console.

Set ndstrace file on

Captures trace message to the ndstrace.log file in the /var/nds directory.

Set ndstrace file off

Stops capturing trace messages to the file.

Set ndstrace=+dxml

Displays the Identity Manager events

Set ndstrace=+dvrs

Displays the Identity Manager driver events.


Use iMonitor to get DS Trace information from a Web browser.

Table 4-8 Platforms and Commands for Web Browsers







  1. Access iMonitor from http://server_ip:8008/nds (the default port).

  2. Click Trace Configuration.

  3. Click Clear All.

  4. Click DirXML and DirXML Drivers.

  5. Click Trace On, then click Trace History.

  6. Click the Current document icon to view the live trace.