ipa-test-task(1)

💖 ipa-test-task — FreeIPA Manual Pages edition 💖

okay bestie, welcome to ipa-test-task(1), a page straight out of the FreeIPA Manual Pages. grab a strawberry 🍓 and let's get into it.

---

✨ NAME ✨

ipa-test-task — run a task for FreeIPA testing 🧚

---

✨ SYNOPSIS ✨

ipa-test-task -h
ipa-test-task [global-options] TASK [task-options]

---

✨ DESCRIPTION ✨

So basically: this runs a task using your FreeIPA integration testing configuration. It's a tool meant to live inside scripts that test FreeIPA functionality, okay? If you wanna know about the config side of things, go read ipa-test-config(1) for the FreeIPA integration test configuration.

⚠️ NO CAP, LISTEN TO ME: this tool should never be run in a production environment. It is not designed with security in mind. Not even a little. Do not do it. 🙈

---

✨ GLOBAL OPTIONS ✨

• -h, --help — prints out the command's usage and dips. and if you drop it after a subcommand? it prints that subcommand's usage message instead. cute, right? 💅
• --with-beakerlib — turns on BeakerLib integration. log messages get reported through beakerlib(1) commands. heads up though: this option requires an active BeakerLib phase. no phase, no vibes. 🎀

---

✨ SUBCOMMANDS ✨

like. there are so many. let's go one by one, no skipping, we're doing all of them 🫶

• ipa-test-task install-master [--host HOST] — installs an initial IPA server on the host you give it, or on the configured master if you didn't pass --host.
• ipa-test-task install-replica [--master MASTER] HOST — installs an IPA replica on the given host. it gets initialized from the IPA server you name with --master, or from the configured master if --master isn't there.
• ipa-test-task install-client [--master MASTER] HOST — installs an IPA client on the given host. same deal: initialized from the IPA server in --master, or the configured master if you skipped --master.
• ipa-test-task connect-replica HOST1 HOST2 — creates a replication agreement between two given replicas. matchmaker energy 🔥
• ipa-test-task disconnect-replica HOST1 HOST2 — removes a replication agreement between two given replicas. it's giving breakup era 💀
• ipa-test-task uninstall-server [HOST [HOST ...]] — uninstalls an IPA server (master or replica) on the given host(s), and restores the host(s) to the state they were in before installation. no host given? then it uninstalls all configured masters and replicas. and if no server is installed on a host, it just does nothing there. respectful. 😌
• ipa-test-task uninstall-client [HOST [HOST ...]] — uninstalls an IPA client on the given host(s), and restores the host(s) to their pre-installation state. no host given? uninstalls all configured clients. if no client is installed on a host, it does nothing on that host.
• ipa-test-task uninstall-all — uninstalls IPA from all configured master, replica and client hosts. it's exactly equivalent to running uninstall-server and uninstall-client with no arguments. the everything shower of cleanup 🚿
• ipa-test-task cleanup [HOST [HOST ...]] — restores system configuration (stuff like /etc/resolv.conf) on the given hosts back to its pre-installation state. no hosts given? it cleans up all configured hosts. lowkey though, this functionality is already included in the uninstall-* subcommands and is rarely useful on its own.
• ipa-test-task install-topo [--skip-master] [--skip-clients] [--master M] [--replicas R1 [R2...]] [--clients C1 [C2 ...]] TOPO — installs a whole bunch of FreeIPA servers and clients in the given topology. want the list of available topologies? run the list-topos subcommand, bestie.

Unless --skip-master is given, an initial server is installed on the host you pass to --master, or on the configured master if --master is missing.

Replicas get installed according to the selected topology on the hosts in --replicas, or on all configured replicas if you didn't give that option.

Unless --skip-clients is given, clients get installed on the hosts in --clients, or on all configured clients if --clients isn't given. and the servers used for client installation are selected in a round-robin fashion. rotating like a playlist 🔄

• ipa-test-task list-topos — lists the topologies available for the install-topo subcommand. window shopping ✨
• ipa-test-task install-adtrust HOST — runs ipa-adtrust-install on the IPA and generates SIDs for the entries in IPA.
• ipa-test-task configure-dns-for-trust HOST AD — configures the IPA DNS for trust based on the relationship of the domains. note: AD DNS needs to be set up manually. that part's on you, babe.
• ipa-test-task establish-trust-with-ad HOST AD — establishes trust with Active Directory. the trust type gets detected depending on whether the AD has SfU (Services for Unix) support. iykyk
• ipa-test-task remove-trust-with-ad HOST AD — removes trust with Active Directory. also removes the associated ID range. it's giving closure 🌈
• ipa-test-task configure-auth-to-local-rule HOST AD — configures the auth_to_local rule in /etc/krb5.conf
• ipa-test-task clear-sssd-cache HOST — clears the SSSD cache by removing the cache files. then restarts SSSD. fresh start, clean slate 🌸
• ipa-test-task setup-sssd-debugging HOST — sets up SSSD debugging. and restarts SSSD. 🔍
• ipa-test-task sync-time HOST SERVER — syncs the time with the remote server. please note that this function leaves chronyd stopped. like, it does not turn it back on. heads up!! ⏰
• ipa-test-task add-a-records-in-master-domain MASTER — adds A records to the IPA master for all the hosts in the master domain.
• ipa-test-task add-a-record MASTER HOST — adds an A record for the host to the IPA master.

---

✨ EXIT STATUS ✨

• 0 if the command was successful 🎉
• nonzero if an error occurred 😭

---

✨ REFERENCES ✨

a full description of the FreeIPA integration testing framework is available at http://www.freeipa.org/page/V3/Integration_testing 📚

---

that's the whole page, bestie!! this one's from the FreeIPA crew, dated Aug 29 2013, and it's literally titled ipa-test-task(1) — slay, go test some things, just not in prod 💖✨🎀🦋