1ipa-replica-install(1) IPA Manual Pages ipa-replica-install(1)
2
6 ipa-replica-install - Create an IPA replica
7
9 ipa-replica-install [OPTION]...
10
12 Configures a new IPA server that is a replica of the server. Once it
13 has been created it is an exact copy of the original IPA server and is
14 an equal master. Changes made to any master are automatically repli‐
15 cated to other masters.
16 Domain level 0 is not supported anymore.
18 To create a replica, the machine only needs to be enrolled in the IPA
20 domain first. This process of turning the IPA client into a replica is
21 also referred to as replica promotion.
22 If you're starting with an existing IPA client, simply run
24 ipa-replica-install to have it promoted into a replica. The NTP config‐
25 uration cannot be updated during client promotion.
26 To promote a blank machine into a replica, you have two options, you
28 can either run ipa-client-install in a separate step, or pass the en‐
29 rollment related options to the ipa-replica-install (see CLIENT ENROLL‐
30 MENT OPTIONS). In the latter case, ipa-replica-install will join the
31 machine to the IPA realm automatically and will proceed with the promo‐
32 tion step.
33 If the installation fails you may need to run ipa-server-install
35 --uninstall and ipa-client-install before running ipa-replica-install
36 again.
37 The installation will fail if the host you are installing the replica
39 on exists as a host in IPA or an existing replication agreement exists
40 (for example, from a previously failed installation).
41 A replica should only be installed on the same or higher version of IPA
43 on the remote system.
44
46 OPTIONS
47 -P, --principal
48 The user principal which will be used to promote the client to
49 the replica and enroll the client itself, if necessary.
50 -w, --admin-password
52 The Kerberos password for the given principal.
53 CLIENT ENROLLMENT OPTIONS
56 To install client and promote it to replica using a host keytab or One
57 Time Password, the host needs to be a member of ipaservers group. This
58 requires to create a host entry and add it to the host group prior
59 replica installation.
60 --server, --domain, --realm options are autodiscovered via DNS records
62 by default. See manual page ipa-client-install(1) for further details
63 about these options.
64 -p PASSWORD, --password=PASSWORD
67 One Time Password for joining a machine to the IPA realm.
68 -k, --keytab
70 Path to host keytab.
71 --server
73 The fully qualified domain name of the IPA server to enroll to.
74 The IPA server must provide the CA role if --setup-ca option is
75 specified, and the KRA role if --setup-kra option is specified.
76 -n, --domain=DOMAIN
78 The primary DNS domain of an existing IPA deployment, e.g. exam‐
79 ple.com. This DNS domain should contain the SRV records gener‐
80 ated by the IPA server installer.
81 -r, --realm=REALM_NAME
83 The Kerberos realm of an existing IPA deployment.
84 --hostname
86 The hostname of this machine (FQDN). If specified, the hostname
87 will be set and the system configuration will be updated to per‐
88 sist over reboot.
89 --force-join
91 Join the host even if it is already enrolled.
92 BASIC OPTIONS
95 --ip-address=IP_ADDRESS
96 The IP address of this server. If this address does not match
97 the address the host resolves to and --setup-dns is not selected
98 the installation will fail. If the server hostname is not re‐
99 solvable, a record for the hostname and IP_ADDRESS is added to
100 /etc/hosts. This option can be used multiple times to specify
101 more IP addresses of the server (e.g. multihomed and/or dual‐
102 stacked server).
103 --mkhomedir
105 Create home directories for users on their first login
106 --ntp-server=NTP_SERVER
108 Configure chronyd to use this NTP server. This option can be
109 used multiple times and it is used to specify exactly one time
110 server.
111 --ntp-pool=NTP_SERVER_POOL
113 Configure chronyd to use this NTP server pool. This option is
114 meant to be pool of multiple servers resolved as one host name.
115 This pool's servers may vary but pool address will be still same
116 and chrony will choose only one server from this pool.
117 -N, --no-ntp
119 Do not configure NTP client (chronyd).
120 --no-ui-redirect
122 Do not automatically redirect to the Web UI.
123 --ssh-trust-dns
125 Configure OpenSSH client to trust DNS SSHFP records.
126 --no-ssh
128 Do not configure OpenSSH client.
129 --no-sshd
131 Do not configure OpenSSH server.
132 --subid
134 Configure SSSD as data source for subid.
135 --skip-conncheck
137 Skip connection check to remote master
138 -d, --debug
140 Enable debug logging when more verbose output is needed
141 -U, --unattended
143 An unattended installation that will never prompt for user input
144 --dirsrv-config-file
146 The path to LDIF file that will be used to modify configuration
147 of dse.ldif during installation of the directory server instance
148 CERTIFICATE SYSTEM OPTIONS
151 --setup-ca
152 Install and configure a CA on this replica. If a CA is not con‐
153 figured then certificate operations will be forwarded to a mas‐
154 ter with a CA installed.
155 --no-pkinit
157 Disables pkinit setup steps.
158 --dirsrv-cert-file=FILE
160 File containing the Directory Server SSL certificate and private
161 key
162 --http-cert-file=FILE
164 File containing the Apache Server SSL certificate and private
165 key
166 --pkinit-cert-file=FILE
168 File containing the Kerberos KDC SSL certificate and private key
169 --dirsrv-pin=PIN
171 The password to unlock the Directory Server private key
172 --http-pin=PIN
174 The password to unlock the Apache Server private key
175 --pkinit-pin=PIN
177 The password to unlock the Kerberos KDC private key
178 --dirsrv-cert-name=NAME
180 Name of the Directory Server SSL certificate to install
181 --http-cert-name=NAME
183 Name of the Apache Server SSL certificate to install
184 --pkinit-cert-name=NAME
186 Name of the Kerberos KDC SSL certificate to install
187 --pki-config-override=FILE
189 File containing overrides for CA and KRA installation.
190 --skip-schema-check
192 Skip check for updated CA DS schema on the remote master
193 SECRET MANAGEMENT OPTIONS
196 --setup-kra
197 Install and configure a KRA on this replica. If a KRA is not
198 configured then vault operations will be forwarded to a master
199 with a KRA installed.
200 DNS OPTIONS
203 --setup-dns
204 Configure an integrated DNS server, create a primary DNS zone
205 (name specified by --domain or taken from an existing deploy‐
206 ment), and fill it with service records necessary for IPA de‐
207 ployment. In cases where the IPA server name does not belong to
208 the primary DNS domain and is not resolvable using DNS, create a
209 DNS zone containing the IPA server name as well.
210 This option requires that you either specify at least one DNS
212 forwarder through the --forwarder option or use the --no-for‐
213 warders option.
214 Note that you can set up a DNS at any time after the initial IPA
216 server install by running ipa-dns-install (see ipa-dns-in‐
217 stall(1)). IPA DNS cannot be uninstalled.
218 --forwarder=IP_ADDRESS
220 Add a DNS forwarder to the DNS configuration. You can use this
221 option multiple times to specify more forwarders, but at least
222 one must be provided, unless the --no-forwarders option is spec‐
223 ified.
224 --no-forwarders
226 Do not add any DNS forwarders. Root DNS servers will be used in‐
227 stead.
228 --auto-forwarders
230 Add DNS forwarders configured in /etc/resolv.conf to the list of
231 forwarders used by IPA DNS.
232 --forward-policy=first|only
234 DNS forwarding policy for global forwarders specified using
235 other options. Defaults to first if no IP address belonging to
236 a private or reserved ranges is detected on local interfaces
237 (RFC 6303). Defaults to only if a private IP address is de‐
238 tected.
239 --reverse-zone=REVERSE_ZONE
241 The reverse DNS zone to use. This option can be used multiple
242 times to specify multiple reverse zones.
243 --no-reverse
245 Do not create new reverse DNS zone. If a reverse DNS zone al‐
246 ready exists for the subnet, it will be used.
247 --auto-reverse
249 Create necessary reverse zones
250 --allow-zone-overlap
252 Create DNS zone even if it already exists
253 --no-host-dns
255 Do not use DNS for hostname lookup during installation
256 --no-dns-sshfp
258 Do not automatically create DNS SSHFP records.
259 --no-dnssec-validation
261 Disable DNSSEC validation on this server.
262 SID GENERATION OPTIONS
265 --netbios-name=NETBIOS_NAME
266 The NetBIOS name for the IPA domain. If not provided then this
267 is determined based on the leading component of the DNS domain
268 name. Running ipa-adtrust-install for a second time with a dif‐
269 ferent NetBIOS name will change the name. Please note that
270 changing the NetBIOS name might break existing trust relation‐
271 ships to other domains.
272 --add-sids
274 Add SIDs to existing users and groups as on of final steps of
275 the ipa-adtrust-install run. If there a many existing users and
276 groups and a couple of replicas in the environment this opera‐
277 tion might lead to a high replication traffic and a performance
278 degradation of all IPA servers in the environment. To avoid this
279 the SID generation can be run after ipa-adtrust-install is run
280 and scheduled independently. To start this task you have to load
281 an edited version of ipa-sidgen-task-run.ldif with the ldapmod‐
282 ify command info the directory server.
283 --rid-base=RID_BASE
285 First RID value of the local domain. The first Posix ID of the
286 local domain will be assigned to this RID, the second to RID+1
287 etc. See the online help of the idrange CLI for details.
288 --secondary-rid-base=SECONDARY_RID_BASE
290 Start value of the secondary RID range, which is only used in
291 the case a user and a group share numerically the same Posix ID.
292 See the online help of the idrange CLI for details.
293 AD TRUST OPTIONS
296 --setup-adtrust
297 Configure AD Trust capability on a replica.
298 --add-agents
300 Add IPA masters to the list that allows to serve information
301 about users from trusted forests. Starting with IPA 4.2, a regu‐
302 lar IPA master can provide this information to SSSD clients. IPA
303 masters aren't added to the list automatically as restart of the
304 LDAP service on each of them is required. The host where
305 ipa-adtrust-install is being run is added automatically.
306 Note that IPA masters where ipa-adtrust-install wasn't run, can
308 serve information about users from trusted forests only if they
309 are enabled via ipa-adtrust-install run on any other IPA master.
310 At least SSSD version 1.13 on IPA master is required to be able
311 to perform as a trust agent.
312 --enable-compat
314 Enables support for trusted domains users for old clients
315 through Schema Compatibility plugin. SSSD supports trusted do‐
316 mains natively starting with version 1.9. For platforms that
317 lack SSSD or run older SSSD version one needs to use this op‐
318 tion. When enabled, slapi-nis package needs to be installed and
319 schema-compat-plugin will be configured to provide lookup of
320 users and groups from trusted domains via SSSD on IPA server.
321 These users and groups will be available under cn=users,cn=com‐
322 pat,$SUFFIX and cn=groups,cn=compat,$SUFFIX trees. SSSD will
323 normalize names of users and groups to lower case.
324 In addition to providing these users and groups through the com‐
326 pat tree, this option enables authentication over LDAP for
327 trusted domain users with DN under compat tree, i.e. using bind
328 DN uid=administrator@ad.domain,cn=users,cn=compat,$SUFFIX.
329 LDAP authentication performed by the compat tree is done via PAM
331 'system-auth' service. This service exists by default on Linux
332 systems and is provided by pam package as /etc/pam.d/sys‐
333 tem-auth. If your IPA install does not have default HBAC rule
334 'allow_all' enabled, then make sure to define in IPA special
335 service called 'system-auth' and create an HBAC rule to allow
336 access to anyone to this rule on IPA masters.
337 As 'system-auth' PAM service is not used directly by any other
339 application, it is safe to use it for trusted domain users via
340 compatibility path.
341
343 0 if the command was successful
344 1 if an error occurred
346 3 if the host exists in the IPA server or a replication agreement to
348 the remote master already exists
349 4 if the remote master specified for enrollment does not provide re‐
351 quired services such as CA or KRA
352IPA Dec 19 2016 ipa-replica-install(1)