1REGISTER-DS-ADMIN.PL(8) System Manager's Manual REGISTER-DS-ADMIN.PL(8)
2
6 register-ds-admin.pl - Registers Directory Server instances with an
7 Admin Server
8
10 register-ds-admin.pl [--options] -- [args]
11
13 Registers existing Directory Server instances with an existing Admin
14 Server. This command does the set up necessary for the use of the Con‐
15 sole to manage the Directory Server instances you are registering. You
16 can register local Directory Server instances with a local Configura‐
17 tion Directory Server/Admin Server. You can also create an Admin
18 Server and register standalone instances with it. You can register
19 remote Directory Server instances to the local Admin Server, as well as
20 register local Directory Server instances with a remote Admin Server -
21 this allows a single Console/Admin Server to manage all the Directory
22 Servers in your network.
23 Use this command with the --update option after an upgrade to refresh
25 the server information (version, build number, etc.) in the Console.
26 Can be run in interactive mode with different levels of verbosity, or
28 in silent mode with parameters supplied in a .inf format file or on the
29 command line.
30
32 A summary of options is included below:
33 --help This message
35 --version
37 Print the version and exit
38 --debug
40 Turn on debugging
41 --silent
43 Use silent setup - no user input
44 --file=name
46 Use the file 'name' in .inf format to supply the default answers
47 --keepcache
49 Do not delete the temporary .inf file generated by this program
50 --logfile
52 Log setup messages to this file - otherwise, a temp file will be
53 used
54 --update
56 Update an existing installation (e.g. after upgrading packages)
57 --continue
59 (update only) keep going despite errors (also --force)
60 For all options, you can also use the short name e.g. -h, -d, etc. For
62 the -d argument, specifying it more than once will increase the debug
63 level e.g. -ddddd
64 args: You can supply default .inf data in this format:
66 section.param=value
68 e.g.
70 General.FullMachineName=foo.example.com
72 or
74 "slapd.Suffix=dc=example,dc=com"
76 Values passed in this manner will override values in an .inf file given
78 with the -f argument.
79
82 The .inf file use three directives depending on what you want to do:
83 [General], [admin], and [register]. The [admin] section is only needed
84 if an Admin Server needs to be installed on the local system.
85 Here is an example of creating an Admin Server, and turning a stand‐
87 alone Directory Server instance into a configuration instance. In this
88 case we need the [General], [admin], and [register] directives
89 [General]
91 FullMachineName= localhost.localdomain
92 SuiteSpotUserID= dirsrv
93 SuiteSpotGroup= dirsrv
94 AdminDomain= redhat.com
95 ConfigDirectoryAdminID= admin
96 ConfigDirectoryAdminPwd= admin
97 ConfigDirectoryLdapURL= ldap://localhost.localdo‐
98 main:389/o=NetscapeRoot
99 [admin]
101 Port= 9830
102 ServerIpAddress= 127.0.0.1
103 ServerAdminID= admin
104 ServerAdminPwd= password
105 [register]
107 configinst= slapd-localhost::cn=directory manager::password
108 Here is an example of an .inf file that registers two local Directory
111 Server instances (slapi-replica, slapd-instance2) with the local Con‐
112 figuration Directory Server (slapd-localhost).
113 [General]
115 FullMachineName= localhost.localdomain
116 SuiteSpotUserID= dirsrv
117 SuiteSpotGroup= dirsrv
118 AdminDomain= redhat.com
119 ConfigDirectoryAdminID= admin
120 ConfigDirectoryAdminPwd= admin
121 ConfigDirectoryLdapURL= ldap://localhost.localdo‐
122 main:389/o=NetscapeRoot
123 [register]
125 configinst= slapd-localhost::cn=directory manager::password
126 localinst= slapd-instance2::cn=directory manager::password
127 localinst= slapd-replica::cn=directory manager::password
128 This example will add the slapd-replica instance to the local configu‐
131 ration server. Then this server's configuration to added to the remote
132 configuration server on ldap.redhat.com
133 [General]
135 FullMachineName= localhost.localdomain
136 SuiteSpotUserID= dirsrv
137 SuiteSpotGroup= dirsrv
138 AdminDomain= redhat.com
139 ConfigDirectoryAdminID= admin
140 ConfigDirectoryAdminPwd= admin
141 ConfigDirectoryLdapURL= ldap://localhost.localdo‐
142 main:389/o=NetscapeRoot
143 [register]
145 configinst= slapd-localhost::cn=directory manager::password
146 localinst= slapd-replica::cn=directory manager::password
147 localcertdir= /etc/dirsrv/slapd-localhost
148 remotehost= ldap.redhat.com
149 remoteport= 636
150 remotebinddn= cn=directory manager
151 remotebindpw= password
152 admindomain= redhat.com
153 admindn= uid=admin,ou=Administrators,ou=TopologyManage‐
154 ment,o=NetscapeRoot
155 adminpw= password
156 destination= remote
157 The [register] directive parameter descriptions:
159 configinst = INSTANCE::BIND_DN::PASSWORD
161 INSTANCE = The server where the existing configuration exists,
163 or the server where you want to add the configuration to. The
164 value takes the form of slapd-INSTANCE.
165 BIND_DN = The root DN, usually “cn=directory manager”, for the
166 local configuration server.
167 PASSWORD = the root DN password.
168 localinst = INSTANCE::BIND_DN::PASSWORD
170 The parameters are the same as 'configinst'. This argument is
172 required for local registerations.
173 remotehost = The FQDN of the remote server. This is either the rmeote
175 server we
176 registering with, or the remote server that is being registered
177 with the local configuration server.
178 remoteport = The port of the remote server.
180 localcertdir = The directory of the certificate database files (e.g.
182 cert8.db, key3.db). This optional parameter is only used if connecting
183 to the remote server over SSL.
184 remotebinddn = The bind DN, preferrably the root DN, to connect to the
186 remote server.
187 remotebinddn = The password for the remotebinddn entry.
189 admindomain = This is the Admin Domain for the server that is being
191 registered. If registering the local server to the remote server, it
192 would be the domain from the local server. If registering a remote
193 server to the local configuration server, it would be the Admin Domain
194 from the remote server.
195 admindn = The local administrator DN for o=netscaperoot
197 adminpw = The local administrator password.
199 destination = local, or remote
201 local = Registers the remote server with the local configuration
203 server.
204 remote = Registers the local server with the remote configura‐
205 tion server.
206
208 register-ds-admin.pl was written by the 389 Project.
209
211 Report bugs to http://bugzilla.redhat.com.
212
214 Copyright © 2010 Red Hat, Inc.
215 This is free software. You may redistribute copies of it under the
216 terms of the Directory Server license found in the LICENSE file of this
217 software distribution. This license is essentially the GNU General
218 Public License version 2 with an exception for plug-in distribution.
219 Jun 8, 2010 REGISTER-DS-ADMIN.PL(8)