grommunio-admin-service(1)

📦 version 1.18, in alpine 3.24

💖 NAME 💖

Okay bestie, this is the grommunio-admin-service(1) page — aka grommunio-admin service, the grommunio-admin external service interface control. It's giving backend-connection main character energy, but make it organized. 💅

✨ SYNOPSIS ✨

grommunio-admin service [-r] load SERVICE [ARGS ...]
grommunio-admin service [-v] status [SERVICE [SERVICE [...]]]

🦋 DESCRIPTION 🦋

So grommunio-admin connects to several external services to either provide means of configuration via API (e.g. grommunio chat) or to retrieve additional information (e.g. LDAP). No cap. 💖

grommunio-admin service is the command you use to introspect the connection status of these services. It's literally the vibe check for your service connections. ✨

Bestie, important note: the CLI runs separately from the API backend. If introspection of the running server instance is required, use the connect command to access the server instance. 🫶

As of version 1.9, each service acts as a blueprint for parameterized instances. Currently only the LDAP service supports parameters, allowing for organization-specific ldap connections. Iconic. 👑

Each instance has a state, reflecting the connection status. The following states are used:

  • UNLOADED — the service has not been loaded yet. It will be loaded automatically when needed.
  • LOADED — the service has been initialized successfully. Slay.
  • UNAVAILABLE — an error occurred that indicates that the service is not available, but might become available in the future. No reload is necessary to reconnect.
  • SUSPENDED — Àn error occurred that indicates that the service is not available, but might become available in the future. The service will be reloaded automatically on next usage.
  • ERROR — the service is not available either because initialization failed or because to man errors occurred. It will remain unavailable until reloaded manually.
  • DISABLED — the service has been manually disabled (either by configuration or command).

🛠️ COMMANDS 🛠️

load

Load or reload services. Only services in UNLOADED or SUSPENDED state will be affected unless the --reload option is given. Periodt.

status

Show status of all services. The way that this just tells you what's up with everything? Obsessed. 💅

🎀 OPTIONS 🎀

  • SERVICE — name of the service.
  • -r, --reload — force reload of service.
  • -v, --verbose — show more information.

🌈 SERVICES 🌈

The following services are currently connected via the service interface:

  • chat — grommunio chat. Connected via REST interface.
  • exmdb — gromox exmdb provider (gromox-http). Connected via custom TCP protocol.
  • ldap — External LDAP service. Connected via LDAP(s).
  • redis — Redis instance (used by grommunio sync). Connected via redis driver (TCP).
  • systemd — Systemd shell execution.

💜 SEE ALSO 💜

Cute sign-off, bestie: this is grommunio-admin-service(1) — the footer on this page is just the manual name, with no extra source/version/date line, so that's the whole page. May all your services be LOADED, and may your vibe check always pass. 💅✨💖

📦 where this page comes from