Option |
Secondary Name |
Parameter |
Description |
-class
|
-cl
|
Java class name |
Specifies the Java class name of the DirXML application shim that is to be hosted. The class
option and the module option are mutually exclusive.
Example:
|
-commandport
|
-cp
|
port number |
Specify 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:
|
-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:
|
|
-connection
|
-conn
|
connection configuration string |
The connection configuration string specifies the connection
parameters for the connection to the DirXML server running the
DirXML 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:
|
-description
|
-desc
|
short description |
Specify a short description string that will be used for the trace window title and for
Nsure Audit logging.
Example:
|
-help
|
-?
|
None |
Display this help.
Example:
|
-java
|
-j
|
None |
Specify 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:
|
-javadebugport
|
-jdp
|
port number |
Specify that the remote loader instance is to enable Java debugging on the specified port.
This is useful for developers of DirXML application shims.
Example:
|
-module
|
-m
|
modulename |
Specifies the module containing the DirXML application shim that is to be hosted. The module
option and the class option are mutually exclusive.
Example:
|
-password
|
-p
|
password |
Specify 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:
|
-service
|
-serv
|
None, or install | uninstall |
To install an instance as a service the install argument is used, together
with any other arguments necessary to host an application shim. For example, the arguments
used must include module, any may include connection, commandport,
etc. Note that this option installs the Win32 service; this option does not start the service.
To uninstall an instance running as a service the uninstall argument is used,
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:
|
-setpasswords
|
-sp
|
None, or password password |
Specify 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 DirXML 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 a DirXML application shim
or communicate with another loader instance.
Example:
|
-trace
|
-t
|
integer |
Specify the trace level. This is only used when hosting an application shim.
Trace levels correspond to those used on the DirXML server.
Example:
|
-tracechange
|
-tc
|
integer |
Command a remote loader instance that is hosting an application shim to
change its trace level.
Trace levels correspond to those used on the DirXML server.
Example:
|
-tracefile
|
-tf
|
filename |
Specify 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:
|
-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:
|
-tracefilemax
|
-tfm
|
size |
Specify 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:
|
-unload
|
-u
|
None |
Unload the remote loader instance. If the remote loader is running
as a Win32 Service this will stop the service.
Example:
|
-window
|
-w
|
on | off |
Turn the trace window on or off in a remote loader instance.
Example:
|
-wizard
|
-wiz
|
None |
Launches the configuration wizard. Note that 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 will be initialized with values from the configuration
file and the wizard can be used to change the configuration without editing the configuration
file directly.
Example:
|
Option |
Parameter |
Description |
address
|
IP address |
Specifies that the remote loader will listen 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. If address is not specified the remote loader will
listen on all local IP addresses.
Example:
|
keypass
|
keypass |
Used only for DirXML application shims contained in .jar files.
Specifies the password for the Java keystore specified by the keystore parameter.
Example:
|
keystore
|
keystore |
Used only for DirXML 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 will typically be the Certificate Authority
of the eDirectory tree that is hosting the remote interface shim.
Example:
|
port
|
decimal port number |
Specifies the TCP/IP port on which the remote loader will listen for connections from the
remote interface shim.
Example:
|
rootfile
|
filename |
Used only for DirXML application shims contained in .dll files.
Specifies the file containing the trusted root certificate of the issuer of the certificate used
by the remote interface shim. This will typically be the Certificate Authority of the eDirectory tree
that is hosting the remote interface shim. The certificate file must be in Base 64 format (PEM).
Example:
|
Option |
Parameter |
Description |
hostname
|
host name or ip address |
Specifies the address or name of the machine on which the remote loader will run.
Example:
|
kmo
|
Key Name |
Specifies the Key Name of the Key Material Object containing the keys and certificate used for SSL.
Example:
|
port
|
TCP port number |
Specifies the port on which the remote loader will accept connections from the remote interface shim.
Example:
|
dirxml_remote
dirxml_remote -config config8000.txt
dirxml_remote -config config.txt -u
dirxml_remote -config config.txt -service install