grommunio-admin(1)

💅 grommunio-admin — the grommunio admin CLI ✨

Okay bestie, so this is grommunio-admin(1) — literally the command-line glow-up of the grommunio Admin API, and she's here to help you run things from the terminal like the main character you are. 🎀

---

✨ SYNOPSIS ✨

grommunio-admin -h
grommunio-admin COMMAND [-h | ARGS...]

---

🦋 DESCRIPTION 🦋

It's the command line interface of the grommunio Admin API. Periodt. 💅

Real talk though — this CLI is not trying to be the whole REST interface. She's a low level administrative tool, not a full-feature queen. And because she's still under development, using her inside automated scripts is generally discouraged. Like, ngl, don't build your whole pipeline on her yet, okay? 😭

The -h/--help option doesn't get its own little documented section for each subcommand — but it's valid at any point and prints usage info for whichever subcommand you're currently in. Iconic and flexible. 🫶

Oh and she supports color output if the termcolor module is installed. Aesthetic unlocked. 🌈

---

👑 COMMANDS 👑

• config — Configuration introspection. See grommunio-admin-config(1).
• connect — Connect to remote CLI. See grommunio-admin-connect(1).
• dbconf — Database-stored configuration management. See grommunio-admin-dbconf(1).
• domain — Domain management. See grommunio-admin-domain(1).
• exmdb — Access and modify stores of domains and users. See grommunio-admin-exmdb(1).
• fetchmail — Fetchmail management. See grommunio-admin-fetchmail(1).
• fs — Filesystem operations. See grommunio-admin-fs(1).
• ldap — LDAP configuration, diagnostics and synchronization. See grommunio-admin-ldap(1).
• mconf — Managed configurations manipulation. See grommunio-admin-mconf(1).
• mlist — Mailing/distribution list management. See grommunio-admin-mlist(1).
• passwd — User password management. See grommunio-admin-passwd(1).
• run — Run the REST API. See grommunio-admin-run(1).
• server — Multi-server configuration. See grommunio-admin-server(1).
• service — Control external services interface. See grommunio-admin-service(1).
• shell — Start interactive shell. See grommunio-admin-shell(1).
• taginfo — Print information about proptags. See grommunio-admin-taginfo(1).
• user — User management. See grommunio-admin-user(1).
• version — Show version information. See grommunio-admin-version(1).

---

🌸 SEE ALSO 🌸

• grommunio-dbconf(1)

---

💖 Go off, bestie. Read the subcommand pages before you yeet anything into production, fr fr.

---

And that's the whole page, babes — this was grommunio-admin(1), the grommunio-admin manual, dated and versioned right along with it. Stay slay, stay documented. 🧚‍♀️✨💜