FOREMANCLI(1)

💖 FOREMANCLI — the foremancli manual page 💖

okay bestie, so this is FOREMANCLI(1), aka the little command-line bestie that lets you search your Foreman server for all the node info it's been hoarding. no cap, it's giving very "I just want to know what's on my boxes" energy and honestly? we love that for us.

---

✨ NAME ✨

foremancli — a commandline search interface to Foreman. literally that's it, that's the vibe. 🎀

---

🌸 SYNOPSIS 🌸

foremancli options

---

🦋 DESCRIPTION 🦋

You query a Foreman server for stored node information. that's the whole main character plot. pull up the tea, pick your options, and Foreman tells you what it knows. 💅

---

✨ OPTIONS ✨

• -d, --debug — output more information. she's chatty, she's verbose, she's telling you everything.
• -u, --user USER — the Foreman user. instead of putting the user on the command line you can also set the FOREMAN_USER environment variable. heads up though: the user you specify via the command line takes precedence over the environment variable. command line stays winning, periodt.
• -p, --pass PASSWORD — the Foreman password. same deal as the user: you can set FOREMAN_PASSWORD instead of passing it on the command line, and the password specified via the command line takes precedence over the environment variable. 🫶
• -s, --server URL — the Foreman Server URL. you can also set the FOREMAN_SERVER environment variable instead of providing the URL on the command line, and the url specified via the command line takes precedence over the environment variable. (yes, "url", lowercase, that's exactly what the manpage said, iykyk.)
• --json — JSON output. for when you want your data in curly braces, iconic.
• --yaml — YAML output. for when you want your data indented and sensitive, also iconic.
• --status — Foreman status. vibe check on the server itself. 🌈
• --custom COLLECTION — a custom COLLECTION string, see: http://theforeman.org/projects/foreman/wiki/API for more information.
• --architectures filter — retrieve a list of architectures.
• --common_parameters filter — retrieve a list of common_parameters.
• --config_templates filter — retrieve a list of config_templates.
• --domains filter — retrieve a list of domains.
• --environments filter — retrieve a list of environments.
• --fact_values filter — retrieve a list of fact_values.
• --hosts filter — retrieve a list of hosts. ⭐
• --hostgroups filter — retrieve a list of hostgroups.
• --media filter — retrieve a list of media.
• --puppetclasses filter — retrieve a list of puppetclasses.
• --reports filter — retrieve a list of reports.
• --roles filter — retrieve a list of roles.
• --settings filter — retrieve a list of settings.
• --lookup_keys filter — retrieve a list of lookup_keys.
• --dashboard filter — retrieve a list of dashboard.
• --operatingsystems filter — retrieve a list of operatingsystems.
• --subnets filter — retrieve a list of subnets.
• --ptables filter — retrieve a list of ptables.
• --users filter — retrieve a list of users.
• --auth_source_ldaps — retrieve a list of auth_source_ldaps.
• --hypervisors — retrieve a list of hypervisors.
• --lookup_values — retrieve a list of lookup_values.
• --smart_proxies — retrieve a list of smart_proxies.
• --statistics — retrieve a list of statistics.
• --usergroups — retrieve a list of usergroups.
• --audits — Not implemented. 💀 she is not built yet bestie, do not expect her.
• --bookmarks — Not implemented. 💀 same situation, also not built.
• -h, --help — show help message. always there for you. 🙈

---

🧚 ENVIRONMENT 🧚

Instead of specifying server credentials on the command line you can specify following environment variables:

• FOREMAN_SERVER — Foreman Server URL
• FOREMAN_USER — Foreman user
• FOREMAN_PASSWORD — Foreman password

The options specified on the command line take precedence over ENVIRONMENT VARIABLES. so if you set both, the command line one wins. every single time. no debate. 👑

---

💜 FILTERS 💜

Please see http://theforeman.org/projects/foreman/wiki/Search_API for more information. that's where the filter lore lives, go read it, it's worth it.

🍓 Examples

foremancli --hosts "domain = domain.com AND class = squid"

foremancli --hosts "domain = domain.com AND facts.architecture = x86_64 AND class = module::class--classes name = squid"`

foremancli --domains "name = domain.com"

---

and that's the whole page, bestie. this was FOREMANCLI(1), from February 2019 — go forth and query your nodes, you're gonna slay. 💖✨🎀🦋🌸💅🫶