Registers Directory Server instances with an Admin Server

SYNOPSIS [--options] -- [args]


Registers existing Directory Server instances with an existing Admin Server. This command does the set up necessary for the use of the Console to manage the Directory Server instances you are registering. You can register remote Directory Server instances to a local Admin Server, as well as register local Directory Server instances with a remote Admin Server - this allows a single console/Admin Server to manage all your Directory Servers on your network.

Use this command with the --update option after an upgrade to refresh
 the server information (version, build number, etc.) in the Console.

Can be run in interactive mode with different levels of verbosity, or in silent mode with parameters supplied in a .inf format file or on the command line.


A summary of options is included below:
This message
Print the version and exit
Turn on debugging
Use silent setup - no user input
Use the file 'name' in .inf format to supply the default answers
Do not delete the temporary .inf file generated by this program
Log setup messages to this file - otherwise, a temp file will be used
Update an existing installation (e.g. after upgrading packages)
(update only) keep going despite errors (also --force)

For all options, you can also use the short name e.g. -h, -d, etc. For the -d argument, specifying it more than once will increase the debug level e.g. -ddddd

args: You can supply default .inf data in this format:





Values passed in this manner will override values in an .inf file given with the -f argument.

Silent Mode (.inf file)

Here is an example of an .inf file that registers a local Directory Server instance with a remote server over SSL:

FullMachineName= localhost.localdomain
SuiteSpotUserID= nobody
SuiteSpotGroup= nobody
ConfigDirectoryAdminID= admin
ConfigDirectoryAdminPwd= admin
ConfigDirectoryLdapURL= ldap://localhost.localdomain:389/o=NetscapeRoot

Port= 9830
ServerAdminID= admin
ServerAdminPwd= password

configinst= slapd-localhost::cn=directory manager::password
instance= slapd-replica::cn=directory manager::password
remoteport= 636
remotebinddn= cn=directory manager
remotebindpw= password
localcertdir= /etc/dirsrv/slapd-localhost
admindn= uid=admin,ou=Administrators,ou=TopologyManagement,o=NetscapeRoot
adminpw= password
destination= remote

The above .inf will install a local admin server and then store its configuration (o=netscaperoot) in the "config" instance. The second local Directory Server instance, slapd-replica, is also added the configuration server. Then this server's configuration to added to the remote configuration server on

The [register] directive parameter descriptions:


INSTANCE = The server where the existing configuration exists, or the server where you want to add the configuration to. The value takes the form of slapd-INSTANCE.
BIND_DN = The root DN, usually ``cn=directory manager'', for the local configuration server.
PASSWORD = the root DN password.

INSTANCE = Additional local Directory Server instance that should be added to the configuration server. The value takes the form of slapd-INSTANCE.
BIND_DN = The root DN, usually ``cn=directory manager'', for the local server.
PASSWORD = the root DN password.

This is an optional parameter for specifying other local Directory Server instances to register with the configuration server.

remotehost = The FQDN of the remote server. This is either the rmeote server we
registering with, or the remote server that is being registered with the local configuration server.
remoteport = The port of the remote server.
remotebinddn = The bind DN, preferrably the root DN, to connect to the remote server.
remotebinddn = The password for the remotebinddn entry.
localcertdir = The directory of the certificate database files (e.g. cert8.db, key3.db). This
optional parameter is only used if connecting to the remote server over SSL.
admindomain = The admin domain of the remote configuration server.
admindn = The local administrator DN for o=netscaperoot
adminpw = The local administrator password.
destination = local, or remote

local = Registers the remote server with the local configuration server.
remote = Registers the local server with the remote configuration server.

AUTHOR was written by the 389 Project.


Report bugs to


Copyright © 2010 Red Hat, Inc.
This is free software. You may redistribute copies of it under the terms of the Directory Server license found in the LICENSE file of this software distribution. This license is essentially the GNU General Public License version 2 with an exception for plug-in distribution.