grommunio-admin-domain(1)

📦 version 1.18, in alpine 3.24

🎀 Name 🎀

okay so this is the grommunio-admin-domain(1) manual page for grommunio-admin domain, and it is literally all about Domain management 💅 bestie, if you're here to show off domains or mess with them, you are in exactly the right place 🫶

✨ Synopsis ✨

here's the exact shape of every subcommand — no cap, keep the commands exactly like this:

grommunio-admin domain create [--create-role] [--homeserver HOMESERVER]
[--no-defaults] [--skip-adaptor-reload] [<FIELDS>] -u MAXUSER DOMAINNAME
grommunio-admin domain delete DOMAINSPEC
grommunio-admin domain list [-f FIELD=<value>] [-s FIELD] [DOMAINSPEC]
grommunio-admin domain modify [<FIELDS>] DOMAINSPEC
grommunio-admin domain purge [--files] [-y] DOMAINSPEC
grommunio-admin domain query [-f ATTRIBUTE=<value>] [--format FORMAT]
[--separator SEPARATOR] [-s FIELD] [ATTRIBUTE ...]
grommunio-admin domain recover DOMAINSPEC
grommunio-admin domain show [-f FIELD=<value>] [-s FIELD] DOMAINSPEC

🌸 Description 🌸

this is the subcommand for showing and manipulating domains. like, domain management is the whole vibe 💖

💖 Commands 💖

  • create — make a brand-new domain ✨
  • delete — soft-delete a domain, so it's not fully gone-gone yet 🙈
  • list — list domains, bestie 📋
  • modify — modify a domain 🛠️
  • purge — permanently delete a domain 💀
  • query — query domain attributes 🔍
  • recover — recover a soft-deleted domain, slay 💅
  • show — show detailed information about a domain 👑

🦋 Options 🦋

  • ATTRIBUTE — attributes to query. available attributes are ID, activeUsers, address, adminName, chat, chatID, displayname, domainStatus, domainname, endDay, homedir, homeserverID, inactiveUsers, maxUser, orgID, tel and title 💖 if no attributes are specified, ID, domainname and domainStatus are shown.
  • DOMAINNAME — complete name of the domain 🌸
  • DOMAINSPEC — domain name prefix or domain ID 🎀
  • --create-role — automatically create a domain administrator role for the new domain 👑
  • --files — also delete files from disk 🗂️
  • -f FIELD=<value>, --filter FIELD=<value> — filter expression in the form of field=value. can be specified multiple times to refine the filter 🔍
  • --format FORMAT — output format. can be one of csv, json-flat, json-kv, json-object, json-structured and pretty. default is pretty ✨
  • --homeserver HOMESERVER — ID of the homeserver to place the domain on 🖥️
  • --no-defaults — do not apply configured default values 🙅‍♀️
  • --separator SEPARATOR — string to use for column separation (csv and pretty only). must have length 1 if format is csv. default is "," for csv and " " for pretty 🎀
  • -s FIELD, --sort FIELD — sort by field. can be given multiple times 📊
  • -y, --yes — assume yes instead of prompting 👍

🍓 Fields 🍓

  • --address ADDRESS — content of address field 🏠
  • --adminName ADMINNAME — name of the domain administrator or primary contact 👤
  • --endDay ENDDAY — date of domain expiration in YYYY-MM-DD format 📅
  • --orgID ID — ID of the organization to assign the domain to 🏢
  • --tel TEL — telephone number of domain administrator or primary contact ☎️
  • -u MAXUSER, --maxUser MAXUSER — maximum number of users in the domain 👥

🌈 See Also 🌈

cute sign-off, bestie 🫶 the footer of this page was just grommunio-admin-domain(1) — no source/version or date was listed, so I am not making one up 💜✨

📦 where this page comes from