ipa-replica-install(1)

💖 ipa-replica-install — the ipa-replica-install(1) glow-up 💖

okay bestie, so this is the IPA Manual Pages page for ipa-replica-install, and it's literally about making a whole new IPA replica. buckle up, it's a long one, but we're getting through it together 🫶

---

✨ NAME ✨

ipa-replica-install — Create an IPA replica. that's it, that's the job 💅

---

🌸 SYNOPSIS 🌸

ipa-replica-install [OPTION]...

---

🦋 DESCRIPTION 🦋

so what this does is configure a brand-new IPA server that's a replica of your existing server. once it's made, it is literally an exact copy of the original IPA server, and it counts as an equal master. any changes you make to any master get automatically replicated out to all the other masters. no cap ✨

⚠️ heads up: Domain level 0 is not supported anymore. rip to the old days, it's gone.

to make a replica, the machine only needs to be enrolled in the IPA domain first. this whole process of turning an IPA client into a replica is also called replica promotion. it's giving glow-up energy, honestly 👑

if you're starting from an existing IPA client, just run ipa-replica-install and it gets promoted into a replica, easy. but — the NTP configuration cannot be updated during client promotion. noted, don't @ me.

if you wanna promote a blank machine into a replica, you've got two options, bestie:

1. run ipa-client-install in a separate step first, or
2. pass the enrollment-related options straight to ipa-replica-install (peep CLIENT ENROLLMENT OPTIONS below).

in that second case, ipa-replica-install will join the machine to the IPA realm automatically and then proceed with the promotion step. iconic multi-tasking ✨

if the installation fails, you may need to run ipa-server-install --uninstall and ipa-client-install before running ipa-replica-install again. it's a whole reset-the-vibe ritual 😭

💀 the installation will fail if the host you're installing the replica on already exists as a host in IPA, or if an existing replication agreement already exists (for example, from a previously failed installation). it's giving "you can't sit with us."

also — a replica should only be installed on the same or higher version of IPA on the remote system. don't downgrade, that's not the vibe.

---

💅 OPTIONS 💅

🎀 OPTIONS 🎀

• -P, --principal — the user principal that'll be used to promote the client to the replica, and to enroll the client itself if that's needed.
• -w, --admin-password — the Kerberos password for the given principal.

🫶 CLIENT ENROLLMENT OPTIONS 🫶

okay so to install a client and promote it to a replica using a host keytab or a One Time Password, the host needs to be a member of the ipaservers group. that means you gotta create a host entry and add it to the host group before the replica installation. prep work, bestie, do it early 💖

--server, --domain, and --realm options are autodiscovered via DNS records by default. for more deets on these options, see the manual page ipa-client-install(1).

• -p PASSWORD, --password=PASSWORD — One Time Password for joining a machine to the IPA realm.
• -k, --keytab — path to host keytab.
• --server — the fully qualified domain name of the IPA server to enroll to. the IPA server must provide the CA role if the --setup-ca option is specified, and the KRA role if the --setup-kra option is specified.
• -n, --domain=DOMAIN — the primary DNS domain of an existing IPA deployment, e.g. example.com. this DNS domain should contain the SRV records generated by the IPA server installer.
• -r, --realm=REALM_NAME — the Kerberos realm of an existing IPA deployment.
• --hostname — the hostname of this machine (FQDN). if specified, the hostname will be set and the system configuration will be updated to persist over reboot.
• --force-join — join the host even if it's already enrolled. pushy but valid.

🌈 BASIC OPTIONS 🌈

• --ip-address=IP_ADDRESS — the IP address of this server. if this address doesn't match the address the host resolves to and --setup-dns isn't selected, the installation will fail. if the server hostname isn't resolvable, a record for the hostname and IP_ADDRESS gets added to /etc/hosts. this option can be used multiple times to specify more IP addresses of the server (e.g. multihomed and/or dualstacked server). go off, multiple IPs 💅
• --mkhomedir — create home directories for users on their first login.
• --ntp-server=NTP_SERVER — configure chronyd to use this NTP server. this option can be used multiple times, and it is used to specify exactly one time server.
• --ntp-pool=NTP_SERVER_POOL — configure chronyd to use this NTP server pool. this option is meant to be a pool of multiple servers resolved as one host name. the pool's servers may vary, but the pool address will still be the same, and chrony will choose only one server from this pool.
• -N, --no-ntp — do not configure NTP client (chronyd).
• --no-ui-redirect — do not automatically redirect to the Web UI.
• --ssh-trust-dns — configure OpenSSH client to trust DNS SSHFP records.
• --no-ssh — do not configure OpenSSH client.
• --no-sshd — do not configure OpenSSH server.
• --subid — configure SSSD as data source for subid.
• --skip-conncheck — skip connection check to remote master.
• --skip-mem-check — skip checking for minimum required memory.
• -d, --debug — enable debug logging when more verbose output is needed.
• -U, --unattended — an unattended installation that will never prompt for user input. no questions asked, literally 🫶
• --dirsrv-config-file — the path to an LDIF file that will be used to modify the configuration of dse.ldif during installation of the directory server instance.

👑 CERTIFICATE SYSTEM OPTIONS 👑

• --setup-ca — install and configure a CA on this replica. if a CA is not configured, then certificate operations will be forwarded to a master that has a CA installed.
• --no-pkinit — disables pkinit setup steps.
• --dirsrv-cert-file=FILE — file containing the Directory Server SSL certificate and private key.
• --http-cert-file=FILE — file containing the Apache Server SSL certificate and private key.
• --pkinit-cert-file=FILE — file containing the Kerberos KDC SSL certificate and private key.
• --dirsrv-pin=PIN — the password to unlock the Directory Server private key.
• --http-pin=PIN — the password to unlock the Apache Server private key.
• --pkinit-pin=PIN — the password to unlock the Kerberos KDC private key.
• --dirsrv-cert-name=NAME — name of the Directory Server SSL certificate to install.
• --http-cert-name=NAME — name of the Apache Server SSL certificate to install.
• --pkinit-cert-name=NAME — name of the Kerberos KDC SSL certificate to install.
• --pki-config-override=FILE — file containing overrides for CA and KRA installation.
• --skip-schema-check — skip check for updated CA DS schema on the remote master.

🧚 HSM OPTIONS 🧚

the token name will be used from the existing topology. cute, it inherits ✨

• --token-library-path=TOKEN_LIBRARY_PATH — the full path to the PKCS#11 shared library needed to access the HSM device. if the path is identical to the original install, then this does not need to be provided.
• --token-password=TOKEN_PASSWORD — the PKCS#11 token password for the HSM.
• --token-password-file=TOKEN_PASSWORD_FILE — the full path to a file containing the PKCS#11 token password.

🔐 SECRET MANAGEMENT OPTIONS 🔐

• --setup-kra — install and configure a KRA on this replica. if a KRA is not configured, then vault operations will be forwarded to a master that has a KRA installed.

🌐 DNS OPTIONS 🌐

• --setup-dns — configure an integrated DNS server, create a primary DNS zone (name specified by --domain or taken from an existing deployment), and fill it with service records necessary for IPA deployment. in cases where the IPA server name does not belong to the primary DNS domain and isn't resolvable using DNS, create a DNS zone containing the IPA server name as well.

this option requires that you either specify at least one DNS forwarder through the --forwarder option or use the --no-forwarders option. no forwarders, no setup, fr fr.

note that you can set up a DNS at any time after the initial IPA server install by running ipa-dns-install (see ipa-dns-install(1)).

💀 IPA DNS cannot be uninstalled. once it's in, it's in. periodt.

• --forwarder=IP_ADDRESS — add a DNS forwarder to the DNS configuration. you can use this option multiple times to specify more forwarders, but at least one must be provided, unless the --no-forwarders option is specified.
• --no-forwarders — do not add any DNS forwarders. root DNS servers will be used instead.
• --auto-forwarders — add DNS forwarders configured in /etc/resolv.conf to the list of forwarders used by IPA DNS.
• --forward-policy=first|only — DNS forwarding policy for global forwarders specified using other options. defaults to first if no IP address belonging to a private or reserved ranges is detected on local interfaces (RFC 6303). defaults to only if a private IP address is detected.
• --reverse-zone=REVERSE_ZONE — the reverse DNS zone to use. this option can be used multiple times to specify multiple reverse zones.
• --no-reverse — do not create a new reverse DNS zone. if a reverse DNS zone already exists for the subnet, it will be used.
• --auto-reverse — create necessary reverse zones.
• --allow-zone-overlap — create DNS zone even if it already exists.
• --no-host-dns — do not use DNS for hostname lookup during installation.
• --no-dns-sshfp — do not automatically create DNS SSHFP records.
• --no-dnssec-validation — disable DNSSEC validation on this server.
• --dns-over-tls — configure DNS over TLS.
• --dot-forwarder=IP_ADDRESS#HOSTNAME — add a DNS-over-TLS-enabled forwarder in the format of ip#hostname, e.g.: 1.2.3.4#dns.example.com. this option can be used multiple times.
• --dns-over-tls-cert=FILE — certificate to use for DNS over TLS. if empty, a new certificate will be requested from IPA CA.
• --dns-over-tls-key=FILE — key for the certificate specified in --dns-over-tls-key.
• --dns-policy=relaxed|enforced — encrypted DNS policy. if enforced, DNS communications will only be allowed through the configured encrypted DNS methods. if relaxed, unencrypted DNS queries will be allowed.

⭐ SID GENERATION OPTIONS ⭐

• --netbios-name=NETBIOS_NAME — the NetBIOS name for the IPA domain. if not provided, then this is determined based on the leading component of the DNS domain name. running ipa-adtrust-install for a second time with a different NetBIOS name will change the name.

🙈 please note that changing the NetBIOS name might break existing trust relationships to other domains. be careful, bestie, that's a real one.

---

more coming, don't go anywhere — part 2 is loading… 🌸

• --add-sids — okay bestie, this one adds SIDs to existing users and groups as one of the final steps of the ipa-adtrust-install run. 💖 But heads up: if there are many existing users and groups and a couple of replicas in the environment, this operation might lead to high replication traffic and performance degradation of all IPA servers in the environment. 😭 To avoid this, the SID generation can be run after ipa-adtrust-install is run and scheduled independently. To start this task you have to load an edited version of ipa-sidgen-task-run.ldif with the ldapmodify command into the directory server. ✨
• --rid-base=RID_BASE — this sets the first RID value of the local domain. The first Posix ID of the local domain will be assigned to this RID, the second to RID+1, etc. See the online help of the idrange CLI for details. 👑
• --secondary-rid-base=SECONDARY_RID_BASE — start value of the secondary RID range, which is only used in the case a user and a group share numerically the same Posix ID. See the online help of the idrange CLI for details. 🦋

🛡️ AD TRUST OPTIONS 🛡️

• --setup-adtrust — configure AD Trust capability on a replica. slay. ✨
• --add-agents — add IPA masters to the list that allows to serve information about users from trusted forests. Starting with IPA 4.2, a regular IPA master can provide this information to SSSD clients. IPA masters aren't added to the list automatically as restart of the LDAP service on each of them is required. The host where ipa-adtrust-install is being run is added automatically. 💅

Note that IPA masters where ipa-adtrust-install wasn't run can serve information about users from trusted forests only if they are enabled via ipa-adtrust-install run on any other IPA master. At least SSSD version 1.13 on IPA master is required to be able to perform as a trust agent. 🫶

• --enable-compat — enables support for trusted domains users for old clients through Schema Compatibility plugin. SSSD supports trusted domains natively starting with version 1.9. For platforms that lack SSSD or run older SSSD version one needs to use this option. When enabled, slapi-nis package needs to be installed and schema-compat-plugin will be configured to provide lookup of users and groups from trusted domains via SSSD on IPA server. These users and groups will be available under cn=users,cn=compat,$SUFFIX and cn=groups,cn=compat,$SUFFIX trees. SSSD will normalize names of users and groups to lower case. 🌸

In addition to providing these users and groups through the compat tree, this option enables authentication over LDAP for trusted domain users with DN under compat tree, i.e. using bind DN uid=administrator@ad.domain,cn=users,cn=compat,$SUFFIX. 🔥

LDAP authentication performed by the compat tree is done via PAM 'system-auth' service. This service exists by default on Linux systems and is provided by pam package as /etc/pam.d/system-auth. If your IPA install does not have default HBAC rule 'allow_all' enabled, then make sure to define in IPA special service called 'system-auth' and create an HBAC rule to allow access to anyone to this rule on IPA masters. 👑

As 'system-auth' PAM service is not used directly by any other application, it is safe to use it for trusted domain users via compatibility path. 💖

---

🚪 EXIT STATUS 🚪

• 0 if the command was successful. ✨
• 1 if an error occurred. 😭
• 3 if the host exists in the IPA server or a replication agreement to the remote master already exists. 💀
• 4 if the remote master specified for enrollment does not provide required services such as CA or KRA. 🚫

---

That's the whole vibe, bestie. This page came from IPA, dated Dec 19 2016, and it's the manual for ipa-replica-install(1) — now go slay your replica install. 💅✨