Command line options are used for three purposes with the Identity Manager Remote Loader. Certain command line options specify the parameters for a remote loader instance that is hosting a Identity Manager application shim. These options include specifying the shim module or class, the connection parameters used for communicating with the remote interface shim on the Identity Manager server, trace level, and so on.Other command line options are used to send commands to a remote loader instance that is hosting an Identity Manager application shim. These options include opening and closing the trace window and unloading the remote loader.Still other options are used for certain configuration purposes. These options include setting the passwords and installing and uninstalling a remote loader instance as a Win32 service.
|
Option |
Secondary Name |
Parameter |
Description |
|---|---|---|---|
|
-class |
-cl |
Java class name |
Specifies the Java class name of the Identity Manager application shim that is to be hosted. The class option and the module option are mutually exclusive. Example: -class com.novell.nds.dirxml.driver. ldap.LDAPDriverShim -cl com.novell.nds.dirxml.driver. ldap.LDAPDriverShim |
|
-commandport |
-cp |
port number |
Specifies the TCP/IP port that the remote loader instance will use 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 will communicate with the instance 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 be run on the same server hosting different driver instances by specifying different connection ports and command ports. Example: -commandport 8001 -cp 8001 |
|
-config |
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 Identity Manager 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 be run on the same server hosting different driver instances by specifying different connection ports and command ports. Example: -connection "port=8091 rootfile= server1.pem" -conn "port=8091 rootfile= server1.pem" |
|
-datadir |
-dd |
data directory |
Sets the directory for data files used by the Remote Loader. This option causes the rdxml process to change its current directory to the specified directory. This means trace files and other files that do not have an explicit path specified will be created in the specified data directory. Example: -datadir /var/opt/novell/dirxml/rdxml/data -dd /var/opt/novell/dirxml/rdxml/data |
|
-description |
-desc |
short description |
Specifies a short description string that will be used for Nsure Audit logging. Example: -description SAP -desc SAP |
|
-help |
None |
The help is shown. 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 is not necessary. Example: -java -j |
|
-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 Identity Manager application shims. Example: -javadebugport 8080 -jdp 8080 |
|
-javaparam |
-jp |
java environment parameter |
Specifies that the specified Java environment parameters are set to the specified values. The supported parameters are DHOST_JVM_ADD_CLASSPATH (for additional jar files to be loaded alongwith the ones in standard IDM classpath), DHOST_JVM_INITIAL_HEAP, DHOST_JVM_MAX_HEAP and DHOST_JVM_OPTIONS. You can specify a single Java environment parameter or multiple Java environment parameters, as necessary for your environment. You can also specify multiple values for a parameter by enclosing the parameter in quotation marks. Example: -javaparam DHOST_JVM_MAX_HEAP=512M -jp DHOST_JVM_MAX_HEAP=512M -jp "DHOST_JVM_OPTIONS=-Dfile.encoding=utf-8 -Duser.language=en" |
|
-module |
-m |
modulename |
Specifies the module containing the Identity Manager application shim that is to be hosted. The module option and the class option are mutually exclusive. Example: -module /usr/lib/nds-modules/libcskeldrv.so.0.0.0 -m /usr/lib/nds-modules/libcskeldrv.so.0.0.0 |
|
-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 (unload, tracechange, etc.) is specified and the password option is not specified the user will be prompted to enter the password for the loader that is the target of the command. Example: -password novell4 -p novell4 |
|
-piddir |
-pd |
pidfile directory |
Sets the directory for the process id file (pidfile) used by the Remote Loader process. The pidfile exists primarily for use by SysV-style init scripts. If not specified, the pidfile directory defaults to /var/run, or, if the Remote Loader is run by a user without sufficient rights to open the pidfile for reading and writing in /var/run, then the current directory is used. (See also -datadir). Example: -piddir /var/opt/novell/dirxml/rdxml/data -pd /var/opt/novell/dirxml/rdxml/data |
|
-setpasswords |
-sp |
None, or password password |
Specifies the password for the remote loader instance and the password of the DirXML-Driver object of the remote interface shim with which the Remote Loader will communicate.The first password in the optional arguments is the password for the Remote Loader. The second password in the optional arguments is the password for the DirXML-Driver object associated with the remote interface shim on the Identity Manager server.Either no password or both passwords must be specified. If no password is specified the Remote Loader will prompt for the passwords.This is a configuration option. Using this option configures the Remote Loader instance with the passwords specified but does not load an Identity Manager application shim or communicate with another loader instance. Example: -setpasswords novell4 fishlips3 -sp novell4 fishlips3 |
|
-trace |
-t |
integer |
Specifies the trace level. This is only used when hosting an application shim. Trace levels correspond to those used on the Identity Manager server. Example: -trace 3 -t 3 |
|
-tracechange |
-tc |
integer |
Specifies the command to change the trace level of a Remote Loader instance that is hosting an application shim. Trace levels correspond to those used on the Identity Manager server. Example: -tracechange 1 -tc 1 |
|
-tracefile |
-tf |
filename |
Specifies a file to which to write trace messages. Trace messages will be written to the file if the trace level is greater than zero. Trace messages will be written to the file even if the trace window is not open. Example: -tracefile /tmp/trace.txt -tf /tmp/trace.txt |
|
-tracefilechange |
-tfc |
None, or filename |
Command 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 will cause the hosting instance to close any trace file being used. Example: -tracefilechange /tmp/newtrace.txt -tfc /tmp/newtrace.txt |
|
-tracefilemax |
-tfm |
size |
Specifies the approximate maximum size that trace file data may occupy on disk. If this option is specified there will be 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, and may be specified using the suffixes 'K', 'M', or 'G' for kilobytes, megabytes, or gigabytes, respectively.Note that if the trace file data is larger than the specified maximum when the Remote Loader is started then the trace file data will remain larger than the specified maximum until roll-over is completed through all 10 files. Example: -tracefilemax 25M -tfm 25M |
|
-unload |
-u |
None |
Unload the Remote Loader instance. If the Remote Loader is running as a Win32 Service this will stop the service. Example: -unload -u |