Windows NT-Based Directory Server Operations

The Directory Server for Windows runs as an Windows service. If used, the Windows Directory Server will start at boot time by default. However configuration and operational control is available via the Windows Directory Server command line program xtsdssvc.

The xtsdssvc program can be used to perform the following tasks:

  • Register the Directory Server as a Windows service.

  • Unregister the Directory Server service and remove the recorded startup parameters.

  • Start the service.

  • Stop the service.

  • Obtain a status of the service.

  • Set the Directory Server parameters.

Note the Windows Services control panel applet can be used to start and stop the service as well. The Directory Server Windows service name is "Software AG Directory Server".

This document covers the following topics:

xtsdssvc Parameters

The following parameters can be passed to xtsdssvc:

Parameter Description 
-help
 Prints the help message. 
-register
 Registers the Software AG Directory Server service. It will be started at the next system boot. 
-unregister
 Removes the Software AG Directory Server service from the database of all registered services. Also removes all registry entries belonging to the Software AG Directory Server service. 
-start
 Starts the Software AG Directory Server service. 
-stop
 Stops the Software AG Directory Server service. 
-status
 Prints the status of the Software AG Directory Server service and displays the current configuration parameters. 
-name STRING
 Sets the serverDirectory Server name, where STRING is the name. This is not the same as the Software AG Directory Server Windows service name. The default value is "XTSDIR". 
-port NUMBER
 Sets the Directory Server listen port, where NUMBER is the port number. A value of "0" (zero) means that the value assigned to the well-known name SAGXTSDSport will be used. If SAGXTSDSport is not defined, port number "4952" will be used. The default value is "0". 
-directory STRING
 Sets the type of Directory Server to be used, where STRING is the Directory Server type. The default value is "INIDIR". 
-dirparms STRING
 Sets the parameters required by the selected Directory Server, where STRING indicates the Directory Server parameters applicable to the type of Directory Server defined in the -directory parameter. The default value is "file=C:\Documents and Settings\All Users\Application Data\Software AG\xtsurl.cfg". 
-logdir STRING

Specifies the directory to contain the Directory Server trace log controlled by the -trace parameter (described below). Enclose value in double quotes if the directory name contains spaces.

The default value set by the installation is "C:\Documents and Settings\All Users\Application Data\Software AG\".

If null, the log will be written to "%SystemRoot%\system32".

The log filename is xtsnnnnn.log, where nnnnn is a sequential number 

-trace NUMBER

Sets the trace level to be used by the Directory Server, where NUMBER indicates the trace level.

The default value is "0".

Specify "65534" to obtain full tracing.

Specifying "65535" results in an internal buffer trace only, do not specify "65535",unless specifically instructed to do so.

The Software AG Directory Server Windows service should be stopped and restarted when changing the trace value. 

-debug NUMBER

Indicates whether service control manager related debugging output should be produced.

The default value is "0".

NUMBER should be set to "0" (output not produced) or "1" (output produced).

The output is written to the Windows System Event Log.

xtsdssvc Sample Commands

The following examples illustrate how to perform various tasks using the xtsdssvc command:

Task Sample Command
Register Directory Server xtsdssvc -register

Parameters should be set before registering the server.

Unregister Directory Server xtsdssvc -unregister
Query status of Directory Server xtsdssvc -status
Start Directory Server xtsdssvc -start
Stop Directory Server xtsdssvc -stop
Set Directory Server parameters xtsdssvc -name xtsdir -port 0 -directory INIDIR -dirparms "file=C:\Documents and Settings\All Users\Application Data\Software AG\xtsurl.cfg" -trace0 -debug0

Note:
You can also use a Windows program item to check the status of the Directory Server. Select the following items from the Windows Start Menu: Programs>Software AG Directory Server>Directory Server Status.