B.0 Options for Configuring a Remote Loader

The options in the following table enable you to configure a Remote Loader.

Table B-1 Remote Loader Options

Option

Secondary Name

Parameter

Description

address

IP address

An optional parameter. Specifies that the Remote Loader listens on a particular local IP address. This is useful if the server hosting the Remote Loader has multiple IP addresses and the Remote Loader must listen on only one of the addresses.

You have three options: address=address number address=’localhost’ Don't use this parameter.

If you don't use the address, the Remote Loader listens on all local IP addresses.

Example: address=137.65.134.83

-class

-cl

Java class name

Specifies the Java class name of the Identity Manager application shim that is to be hosted.

For example, for a Java driver, type one of the following:

-class com.novell.nds.dirxml.driver.ldap.LDAPDriverShim -cl com.novell.nds.dirxml.driver.ldap.LDAPDriverShim

Java uses a keystore to read certificates. The -class option and the -module option are mutually exclusive.

To see a list of the Java class name see Table B-2.

-commandport

-cp

port number

Specifies the TCP/IP port that the Remote Loader instance uses for control purposes. If the Remote Loader instance is hosting an application shim, the command port is the port on which another Remote Loader instance communicates with the instance that is hosting the shim. If the Remote Loader instance is sending a command to an instance that is hosting an application shim, the command port is the port on which the hosting instance is listening. If not specified, the default command port is 8000. Multiple instances of the Remote Loader can run on the same server hosting different driver instances by specifying different connection ports and command ports.

Example:

-commandport 8001 -cp 8001

-config

None

filename

Specifies a configuration file. The configuration file can contain any command line options except config. Options specified on the command line override options specified in the configuration file.

Example:

-config config.txt

-connection

-conn

connection configuration string

Specifies the connection parameters for the connection to the Metadirectory server running the Identity Manager remote interface shim. The default connection method for the Remote Loader is TCP/IP using SSL. The default TCP/IP port for this connection is 8090. Multiple instances of the Remote Loader can run on the same server. Each instance of the Remote Loader hosts a separate Identity Manager application shim instance. Differentiate multiple instances of the Remote Loader by specifying different connection ports and command ports for each Remote Loader instance.

Example:

-connection "port=8091 rootfile=server1.pem" -conn "port=8091 rootfile=server1.pem"

-description

-desc

short description

Specify a short description string (for example, SAP) to be used for the trace window title and for Novell® Audit logging.

Example:

-description SAP -desc SAP

The Remote Loader Console places long forms in the configuration files. You can use either a long form (for example, -description) or a short form (for example, -desc).

fromaddress

None

IP address

The Remote Loader only accepts connections from the specified IP address. Any other connections are not allowed.

Example:

--conn “port=8092 fromaddress=10.0.0.2”

or

-connection “port=8094 fromaddress=metaserver1.company.com”

handshaketimeout

None

number of milliseconds

Increases the time out period of the handshake between the Remote Loader and the Metadirectory engine.

Example:

--connection “port=8093 handshaketimeout=1000”

The value is some integer greater than or equal to zero. Zero means never time out. The non-zero number is the number of milliseconds for the time out to occur. The default value is 1000 milliseconds.

-help

-?

None

Displays help.

Example:

-help

-?

-java

-j

None

Specifies that the passwords are to be set for a Java shim instance. This option is only useful in conjunction with the setpasswords option. If -class is specified with -setpasswords, this option isn't necessary.

-javadebugport

-jdp

Port number

Specifies that the Remote Loader instance is to enable Java debugging on the specified port. This is useful for developers of the Identity Manager application shims.

Example:

-javadebugport 8080

-jdp 8080

keystore

Conditional parameters. Used only for Identity Manager application shims contained in .jar files.

Specifies the filename of the Java keystore that contains the trusted root certificate of the issuer of the certificate used by the remote interface shim. This is typically the Certificate Authority of the eDirectory™ tree that is hosting the remote interface shim.

If you are running SSL and need the Remote Loader to communicate with a Java driver, type a key-value pair:

keystore='keystorename' storepass='password'

NOTE:For more information on creating the keystore option, see Section 3.8.3, Creating a Keystore

-module

-m

modulename

Specifies the module containing the Identity Manager application shim that is to be hosted.

For example, for a native driver, type one of the following:

-module "c:\Novell\RemoteLoader\Exchange5Shim.dll" -m "c:\Novell\RemoteLoader\Exchange5Shim.dll"

or

-module "usr/lib/dirxml/NISDriverShim.so" -m "usr/lib/dirxml/NISDriverShim.so"

The -module option uses a rootfile certificate. The -module option and the -class option are mutually exclusive.

-password

-p

password

Specifies the password for command authentication. This password must be the same as the first password specified with setpasswords for the loader instance being commanded. If a command option (for example, unload or tracechange) is specified and the password option isn't specified, the user is prompted to enter the password for the loader that is the target of the command.

Example:

-password novell4 -p novell4

port

decimal port number

A required parameter. It specifies the TCP/IP port on which the Remote Loader listens for connections from the remote interface shim.

Example:

port=8090

rootfile

A conditional parameter. If you are running SSL and need the Remote Loader to communicate with a native driver, type

rootfile='trusted certname'

-service

-serv

None, or install/uninstall

To install an instance as a service, use the install argument together with any other arguments necessary to host an application shim. For example, the arguments used must include -module, but any argument can include -connection, ‑commandport, and so forth.

This option installs the Win32 service but doesn't start the service.

To uninstall an instance running as a service, use the uninstall argument together with any other arguments necessary to host the application shim.

The no-argument version of this option is only used on the command line to an instance being run as a Win32 service. This is automatically set up when installing an instance as a service.

Example:

-service install

-serv uninstall

This option isn't available on rdxml or the Java Remote Loader.

-setpasswords

-sp

password password

Specifies the password for the Remote Loader instance and the password of the Identity Manager Driver object of the remote interface shim that the Remote Loader communicates with. The first password in the argument is the password for the Remote Loader. The second password in the optional arguments is the password for the Identity Manager Driver object associated with the remote interface shim on the Metadirectory server. Either no password or both passwords must be specified. If no password is specified, the Remote Loader prompts for the passwords. This is a configuration option. Using this option configures the Remote Loader instance with the passwords specified but doesn't load a Identity Manager application shim or communicate with another loader instance.

Example:

-setpasswords novell4 staccato3 -sp novell4 staccato3

-storepass

storepass

Used only for Identity Manager application shims contained in .jar files. Specifies the password for the Java keystore specified by the keystore parameter.

Example:

storepass=mypassword

This option applies only to the Java Remote Loader.

-trace

-t

integer

Specifies the trace level. This is only used when hosting an application shim. Trace levels correspond to those used on the metadirectory server.

Example:

-trace 3 -t 3

-tracechange

-tc

integer

Commands a Remote Loader instance that is hosting an application shim to change its trace level. Trace levels correspond to those used on the metadirectory server.

Example:

-tracechange 1

-tc 1

-tracefile

-tf

filename

Specify a file to write trace messages to. Trace messages are written to the file if the trace level is greater than zero. Trace messages are written to the file even if the trace window is not open.

Example:

-tracefile c:\temp\trace.txt -tf c:\temp\trace.txt

-tracefilechange

-tfc

None, or filename

Commands a remote Loader instance that is hosting an application shim to start using a trace file, or to close one already in use and use a new one. Using the no-argument version of this option causes the hosting instance to close any trace file being used.

Example:

-tracefilechange c:\temp\newtrace.txt

tfc c:\temp\newtrace.txt

-tracefilemax

-tfm

size

Specifies the approximate maximum size that trace file data can occupy on disk. If you specify this option, there is a trace file with the name specified using the tracefile option and up to 9 additional “roll-over” files. The roll-over files are named using the base of the main trace filename plus “_n”, where n is 1 through 9.

The size parameter is the number of bytes. Specify the size by using the suffixes K, M, or G for kilobytes, megabytes, or gigabytes.

If the trace file data is larger than the specified maximum when the Remote Loader is started, the trace file data remains larger than the specified maximum until roll-over is completed through all 10 files

Example:

-tracefilemax 1000M -tfm 1000M

In this example, the trace file can be only 1 GB.

-unload

-u

None

Unloads the Remote Loader instance. If the Remote Loader is running as a Win32 Service, this command stops the service.

Example:

-unload

-u

-window

-w

On/Off

Turns the trace window on or off in a Remote Loader instance.

Example:

-window on

-w off

This option is available only on Windows platforms. It isn't available on the Java Remote Loader.

-wizard

-wiz

None

Launches the Configuration Wizard. Running dirxml_remote.exe with no command line parameters also launches the wizard. This option is useful if a configuration file is also specified. In this case, the wizard starts with values from the configuration file and the wizard can be used to change the configuration without editing the configuration file directly.

Example:

-wizard

-wiz

This option is available only on Windows platforms. It isn't available on the Java Remote Loader.

Table B-2 Java Class Names

Java Class Name

Driver

com.novell.nds.dirxml.driver.avaya.PBXDriverShim

Avaya PBX Driver

com.novell.nds.dirxml.driver.delimitedtext.DelimitedTextDriver

Delimited Text Driver

com.novell.nds.dirxml.driver.nds.DriverShimImpl

eDirectory Driver

com.novell.nds.dirxml.driver.entitlement.EntitlementServiceDriver

Entitlement Services Driver

com.novell.gw.dirxml.driver.gw.GWdriverShim

GroupWise Driver

com.novell.nds.dirxml.driver.jdbc.JDBCDriverShim

JDBC Driver

com.novell.idm.driver.jms.JMSDriverShim

JMS Driver

com.novell.nds.dirxml.driver.ldap.LDAPDriverShim

LDAP Driver

com.novell.nds.dirxml.driver.loopback.LoopbackDriverShim

GenericLoopBack Driver

com.novell.nds.dirxml.driver.manualtask.driver.ManualTaskDriver

Manual Task Driver

com.novell.nds.dirxml.driver.nisdriver.NISDriverShim

NIS Driver

com.novell.nds.dirxml.driver.notes.NotesDriverShim

Notes Driver

com.novell.nds.dirxml.driver.psoftshim.PSOFTDriverShim

PeopleSoft Driver

com.novell.nds.dirxml.driver.SAPShim.SAPDriverShim

SAP HR Driver

com.novell.nds.dirxml.driver.sapusershim.SAPDriverShim

SAP User Management Driver

com.novell.nds.dirxml.driver.sifagent.SIFShim

SIF Driver

com.novell.nds.dirxml.driver.soap.SOAPDriver

Soap Driver

com.novell.idm.driver.ComposerDriverShim

User Appliction

be.opns.dirxml.driver.ars.arsremedydrivershim.ARSDriverShim

Driver for Remedy ARS

com.novell.nds.dirxml.driver.workorder.WorkOrderDriverShim

WorkOrder