The DirXML® Dxcmd command-line utility allows you to use a command-line interface to manage the driver.

The primary use of this utility is to allow you to create platform-specific scripts to manage the driver.

We have also noticed that if a driver is "stuck" in a shutdown state, the Dxcmd "stop" will often work when nothing else will.

The utility and scripts are installed on all platforms during the Identity Manager installation. The utility is installed to the following locations:

  • Windows: \Novell\Nds\dxcmd.bat
  • UNIX/Linux: /opt/novell/eDirectory/bin/dxcmd

Data you will need to know#

When you are using the Dxcmd in the command-line mode, there are values returned that you will need to know about. We summarize them below:

More options#

Usage: java com.novell.nds.dirxml.util.DxCommand [configuration] [actions]

If no actions are specified interactive mode is used.

    -user <user name>
    -host <name or IP address>
    -password <user password>
    -port <port number>
    -cert <X.509 DER certificate filename>
    -dnform <slash|qualified-slash|dot|qualified-dot|ldap> (force dn form)
    -version <n.n[.n[.n]]>                 (force engine version for testing)
    -nossl                                 (use clear socket for LDAP)
    -keystore <keystore path and filename> (for LDAP SSL)
    -storepass <keystore password>         (for LDAP SSL)
    -q                                     (quiet mode)
    -v                                     (verbose mode)
    -s                                     (write result to stdout)
    -?                                     (show this message)
    -help                                  (show this message)

    -start <driver dn>
    -stop <driver dn>
    -getstate <driver dn>
    -getstartoption <driver dn>
    -setstartoption <driver dn> <disabled|manual|auto> <resync|noresync>
    -getcachelimit <driver dn>
    -setcachelimit <driver dn> <0 or positive integer>
    -migrateapp <driver dn> <filename>
    -setshimpassword <driver dn> <password>
    -clearshimpassword <driver dn>
    -setremoteloaderpassword <driver dn> <password>
    -clearremoteloaderpassword <driver dn>
    -sendcommand <driver dn> <input filename> <output filename>
    -sendevent <driver dn> <input filename> <output filename>
    -queueevent <driver dn> <input filename>
    -setlogevents <dn> <integer ...>
    -clearlogevents <dn>
    -setdriverset <driver set dn>
    -initdriverobject <dn>
    -setnamedpassword <driver, driverset or job dn> <name> <password> [description]
    -clearnamedpassword <driver, driverset or job dn> <name>
    -clearallnamedpasswords <driver or job dn>
    -getdriverstats <driver dn> <output filename>
    -resetdriverstats <driver dn>
    -startjob <job dn>
    -abortjob <job dn>
    -getjobrunningstate <job dn>
    -getjobenabledstate <job dn>
    -getjobnextruntime <job dn>
    -updatejob <job dn>
    -getcachetransactions <driver dn> <position token> <transaction count> <output filename>
    -resyncdriver <driver dn> <minimum time for resync(dd/mm/yyyy hh:mm AM/PM) >

Examples of using Dxcmd#

To obtain the version of DirXML:

dxcmd -host dirxmlhost.example.com -user cn=admin,ou=admins,ou=esc,dc=willeke,dc=com -password 'xxxxx' -getversion

DirXML version is SE.
Driver set CN=Driver Set,OU=DirXML,OU=esc,dc=nationwidedir,dc=test is associated with the server.


dxcmd -v -host dirxmlhost.example.com -user 'ccn=admin,ou=admins,ou=esc,dc=willeke,dc=com' -password 'xxxxx' -getdriverstats 'cn=IDV to Internal Auth.cn=DriverSet.ou=DirXML.ou=esc.dc=willeke.dc=com' /home/willej1/temp.xml


dxcmd -s -q -host dirxmlhost.example.com -user 'ccn=admin,ou=admins,ou=esc,dc=willeke,dc=com' -password 'xxxxx' -getstate 'cn=LDAPDriver,cn=DriverSet,ou=DirXML,ou=esc,dc=willeke.dc=com'
Adding the -v -q will output only the value for the DirXML-State


dxcmd -s -q -host dirxmlhost.example.com -user 'cn=admin,ou=admins,ou=esc,dc=willeke,dc=com' -password 'xxxxx' -stop 'cn=LDAPDriver,cn=DriverSet,ou=DirXML,ou=esc,dc=willeke.dc=com'


dxcmd -host dirxmlhost.example.com -user 'cn=admin,ou=admins,ou=esc,dc=willeke,dc=com' -password 'xxxxx' -start 'cn=LDAPDriver,cn=DriverSet,ou=DirXML,ou=esc,dc=willeke.dc=com'
NOT using the the -q -s parameters requires that you check the "Return Code" echo $? to determine the result of the command.



More Information#

There might be more information for this subject on one of the following: