1ipa-server-install(1) FreeIPA Manual Pages ipa-server-install(1)
2
6 ipa-server-install - Configure an IPA server
7
9 ipa-server-install [OPTION]...
10
12 Configures the services needed by an IPA server. This includes setting
13 up a Kerberos Key Distribution Center (KDC) and a Kadmin daemon with an
14 LDAP back-end, configuring Apache, configuring NTP and optionally con‐
15 figuring and starting an LDAP-backed DNS server. By default a dog‐
16 tag-based CA will be configured to issue server certificates.
17
20 BASIC OPTIONS
21 -r REALM_NAME, --realm=REALM_NAME
22 The Kerberos realm name for the new IPA deployment.
23 It is strongly recommended to use an upper-cased name of the
25 primary DNS domain name of your IPA deployment. You will not be
26 able to establish trust with Active Directory unless the realm
27 name is the upper-cased domain name.
28 The realm name cannot be changed after the installation.
30 -n DOMAIN_NAME, --domain=DOMAIN_NAME
32 The primary DNS domain of the IPA deployment, e.g. example.com.
33 This DNS domain should contain the SRV records generated by the
34 IPA server installer. The specified DNS domain must not contain
35 DNS records of any other LDAP or Kerberos based management sys‐
36 tem (like Active Directory or MIT Kerberos).
37 It is strongly recommended to use a lower-cased name of the IPA
39 Kerberos realm name.
40 The primary DNS domain name cannot be changed after the instal‐
42 lation.
43 -p DM_PASSWORD, --ds-password=DM_PASSWORD
45 The password to be used by the Directory Server for the Direc‐
46 tory Manager user.
47 -a ADMIN_PASSWORD, --admin-password=ADMIN_PASSWORD
49 The password for the IPA admin user.
50 --mkhomedir
52 Create home directories for users on their first login.
53 --hostname=HOST_NAME
55 The fully-qualified DNS name of this server.
56 --ip-address=IP_ADDRESS
58 The IP address of this server. If this address does not match
59 the address the host resolves to and --setup-dns is not
60 selected, the installation will fail. If the server hostname is
61 not resolvable, a record for the hostname and IP_ADDRESS is
62 added to /etc/hosts. This option can be used multiple times to
63 specify more IP addresses of the server (e.g. multihomed and/or
64 dualstacked server).
65 Configure chronyd to use this NTP server. This option can be used mul‐
67 tiple times and it is used to specify exactly one time server.
68 --ntp-server=NTP_SERVER
70 Configure chronyd to use this NTP server. This option can be
71 used multiple times and it is used to specify exactly one time
72 server.
73 --ntp-pool=NTP_SERVER_POOL
75 Configure chronyd to use this NTP server pool. This option is
76 meant to be pool of multiple servers resolved as one host name.
77 This pool's servers may vary but pool address will be still same
78 and chrony will choose only one server from this pool.
79 -N, --no-ntp
81 Do not configure NTP client (chronyd).
82 --idstart=IDSTART
84 The starting user and group id number (default random).
85 --idmax=IDMAX
87 The maximum user and group id number (default: idstart+199999).
88 If set to zero, the default value will be used.
89 --no-hbac-allow
91 Don't install allow_all HBAC rule. This rule lets any user from
92 any host access any service on any other host. It is expected
93 that users will remove this rule before moving to production.
94 --ignore-topology-disconnect
96 Ignore errors reported when IPA server uninstall would lead to
97 disconnected topology.
98 --ignore-last-of-role
100 Ignore errors reported when IPA server uninstall would lead to
101 removal of last CA/DNS server or DNSSec master.
102 --no-ui-redirect
104 Do not automatically redirect to the Web UI.
105 --ssh-trust-dns
107 Configure OpenSSH client to trust DNS SSHFP records.
108 --no-ssh
110 Do not configure OpenSSH client.
111 --no-sshd
113 Do not configure OpenSSH server.
114 -d, --debug
116 Enable debug logging when more verbose output is needed.
117 -U, --unattended
119 An unattended installation that will never prompt for user
120 input.
121 --dirsrv-config-file
123 The path to LDIF file that will be used to modify configuration
124 of dse.ldif during installation of the directory server
125 instance.
126 CERTIFICATE SYSTEM OPTIONS
129 --external-ca
130 Generate a CSR for the IPA CA certificate to be signed by an
131 external CA.
132 --external-ca-type=TYPE
134 Type of the external CA. Possible values are "generic", "ms-cs".
135 Default value is "generic". Use "ms-cs" to include the template
136 name required by Microsoft Certificate Services (MS CS) in the
137 generated CSR (see --external-ca-profile for full details).
138 --external-ca-profile=PROFILE_SPEC
141 Specify the certificate profile or template to use at the exter‐
142 nal CA.
143 When --external-ca-type is "ms-cs" the following specifiers may
145 be used:
146 <oid>:<majorVersion>[:<minorVersion>]
149 Specify a certificate template by OID and major version,
150 optionally also specifying minor version.
151 <name> Specify a certificate template by name. The name cannot
153 contain any : characters and cannot be an OID (otherwise
154 the OID-based template specifier syntax takes prece‐
155 dence).
156 default
158 If no template is specified, the template name "SubCA" is
159 used.
160 --external-cert-file=FILE
163 File containing the IPA CA certificate and the external CA cer‐
164 tificate chain. The file is accepted in PEM and DER certificate
165 and PKCS#7 certificate chain formats. This option may be used
166 multiple times.
167 --no-pkinit
169 Disables pkinit setup steps.
170 --dirsrv-cert-file=FILE
172 File containing the Directory Server SSL certificate and private
173 key. The files are accepted in PEM and DER certificate, PKCS#7
174 certificate chain, PKCS#8 and raw private key and PKCS#12 for‐
175 mats. This option may be used multiple times.
176 --http-cert-file=FILE
178 File containing the Apache Server SSL certificate and private
179 key. The files are accepted in PEM and DER certificate, PKCS#7
180 certificate chain, PKCS#8 and raw private key and PKCS#12 for‐
181 mats. This option may be used multiple times.
182 --pkinit-cert-file=FILE
184 File containing the Kerberos KDC SSL certificate and private
185 key. The files are accepted in PEM and DER certificate, PKCS#7
186 certificate chain, PKCS#8 and raw private key and PKCS#12 for‐
187 mats. This option may be used multiple times.
188 --dirsrv-pin=PIN
190 The password to unlock the Directory Server private key.
191 --http-pin=PIN
193 The password to unlock the Apache Server private key.
194 --pkinit-pin=PIN
196 The password to unlock the Kerberos KDC private key.
197 --dirsrv-cert-name=NAME
199 Name of the Directory Server SSL certificate to install.
200 --http-cert-name=NAME
202 Name of the Apache Server SSL certificate to install.
203 --pkinit-cert-name=NAME
205 Name of the Kerberos KDC SSL certificate to install.
206 --ca-cert-file=FILE
208 File containing the CA certificate of the CA which issued the
209 Directory Server, Apache Server and Kerberos KDC certificates.
210 The file is accepted in PEM and DER certificate and PKCS#7 cer‐
211 tificate chain formats. This option may be used multiple times.
212 Use this option if the CA certificate is not present in the cer‐
213 tificate files.
214 --ca-subject=SUBJECT
216 The CA certificate subject DN (default CN=Certificate Author‐
217 ity,O=REALM.NAME). RDNs are in LDAP order (most specific RDN
218 first).
219 --subject-base=SUBJECT
221 The subject base for certificates issued by IPA (default
222 O=REALM.NAME). RDNs are in LDAP order (most specific RDN first).
223 --ca-signing-algorithm=ALGORITHM
225 Signing algorithm of the IPA CA certificate. Possible values are
226 SHA1withRSA, SHA256withRSA, SHA512withRSA. Default value is
227 SHA256withRSA. Use this option with --external-ca if the exter‐
228 nal CA does not support the default signing algorithm.
229 SECRET MANAGEMENT OPTIONS
232 --setup-kra
233 Install and configure a KRA on this server.
234 DNS OPTIONS
237 IPA provides an integrated DNS server which can be used to simplify IPA
238 deployment. If you decide to use it, IPA will automatically maintain
239 SRV and other service records when you change your topology.
240 The DNS component in FreeIPA is optional and you may choose to manage
242 all your DNS records manually on another third party DNS server. IPA
243 DNS is not a general-purpose DNS server. If you need advanced features
244 like DNS views, do not deploy IPA DNS.
245 --setup-dns
248 Configure an integrated DNS server, create DNS zone specified by
249 --domain, and fill it with service records necessary for IPA
250 deployment. In cases where the IPA server name does not belong
251 to the primary DNS domain and is not resolvable using DNS, cre‐
252 ate a DNS zone containing the IPA server name as well.
253 This option requires that you either specify at least one DNS
255 forwarder through the --forwarder option or use the --no-for‐
256 warders option.
257 Note that you can set up a DNS at any time after the initial IPA
259 server install by running ipa-dns-install (see ipa-dns-
260 install(1)). IPA DNS cannot be uninstalled.
261 --forwarder=IP_ADDRESS
264 Add a DNS forwarder to the DNS configuration. You can use this
265 option multiple times to specify more forwarders, but at least
266 one must be provided, unless the --no-forwarders option is spec‐
267 ified.
268 --no-forwarders
270 Do not add any DNS forwarders. Root DNS servers will be used
271 instead.
272 --auto-forwarders
274 Add DNS forwarders configured in /etc/resolv.conf to the list of
275 forwarders used by IPA DNS.
276 --forward-policy=first|only
278 DNS forwarding policy for global forwarders specified using
279 other options. Defaults to first if no IP address belonging to
280 a private or reserved ranges is detected on local interfaces
281 (RFC 6303). Defaults to only if a private IP address is
282 detected.
283 --reverse-zone=REVERSE_ZONE
285 The reverse DNS zone to use. This option can be used multiple
286 times to specify multiple reverse zones.
287 --no-reverse
289 Do not create reverse DNS zone.
290 --auto-reverse
292 Try to resolve reverse records and reverse zones for server IP
293 addresses. If neither is resolvable, creates the reverse zones.
294 --zonemgr
296 The e-mail address of the DNS zone manager. Defaults to hostmas‐
297 ter@DOMAIN
298 --no-host-dns
300 Do not use DNS for hostname lookup during installation.
301 --no-dns-sshfp
303 Do not automatically create DNS SSHFP records.
304 --no-dnssec-validation
306 Disable DNSSEC validation on this server.
307 --allow-zone-overlap
309 Allow creation of (reverse) zone even if the zone is already
310 resolvable. Using this option is discouraged as it result in
311 later problems with domain name resolution.
312 AD TRUST OPTIONS
315 --setup-adtrust
316 Configure AD Trust capability.
317 --netbios-name=NETBIOS_NAME
319 The NetBIOS name for the IPA domain. If not provided, this is
320 determined based on the leading component of the DNS domain
321 name. Running ipa-adtrust-install for a second time with a dif‐
322 ferent NetBIOS name will change the name. Please note that
323 changing the NetBIOS name might break existing trust relation‐
324 ships to other domains.
325 --rid-base=RID_BASE
327 First RID value of the local domain. The first POSIX ID of the
328 local domain will be assigned to this RID, the second to RID+1
329 etc. See the online help of the idrange CLI for details.
330 --secondary-rid-base=SECONDARY_RID_BASE
332 Start value of the secondary RID range, which is only used in
333 the case a user and a group share numerically the same POSIX ID.
334 See the online help of the idrange CLI for details.
335 --enable-compat
337 Enables support for trusted domains users for old clients
338 through Schema Compatibility plugin. SSSD supports trusted
339 domains natively starting with version 1.9. For platforms that
340 lack SSSD or run older SSSD version one needs to use this
341 option. When enabled, slapi-nis package needs to be installed
342 and schema-compat-plugin will be configured to provide lookup of
343 users and groups from trusted domains via SSSD on IPA server.
344 These users and groups will be available under cn=users,cn=com‐
345 pat,$SUFFIX and cn=groups,cn=compat,$SUFFIX trees. SSSD will
346 normalize names of users and groups to lower case.
347 In addition to providing these users and groups through the com‐
349 pat tree, this option enables authentication over LDAP for
350 trusted domain users with DN under compat tree, i.e. using bind
351 DN uid=administrator@ad.domain,cn=users,cn=compat,$SUFFIX.
352 LDAP authentication performed by the compat tree is done via PAM
354 'system-auth' service. This service exists by default on Linux
355 systems and is provided by pam package as /etc/pam.d/sys‐
356 tem-auth. If your IPA install does not have default HBAC rule
357 'allow_all' enabled, then make sure to define in IPA special
358 service called 'system-auth' and create an HBAC rule to allow
359 access to anyone to this rule on IPA masters.
360 As 'system-auth' PAM service is not used directly by any other
362 application, it is safe to use it for trusted domain users via
363 compatibility path.
364 UNINSTALL OPTIONS
367 --uninstall
368 Uninstall an existing IPA installation.
369 -U, --unattended
371 An unattended uninstallation that will never prompt for user
372 input.
373
376 -P MASTER_PASSWORD, --master-password=MASTER_PASSWORD
377 The kerberos master password (normally autogenerated).
378
381 0 if the (un)installation was successful
382 1 if an error occurred
384
387 ipa-dns-install(1) ipa-adtrust-install(1)
388FreeIPA Feb 17 2017 ipa-server-install(1)