grommunio-admin-connect(1)

📦 version 1.18, in alpine 3.24

💅 grommunio-admin-connect (manual page, section 1)

okay so real talk: grommunio-admin-connect is the glow-up of "i want to run CLI commands but, like, somewhere else." it lives in manual section 1, and it's about to be your new hyperfixation. 🦋

✨ Name ✨

grommunio-admin connect — connect to a remote CLI. that's it. that's the vibe. basically you're facetiming another server and telling it what to do. 💅

🌸 Synopsis 🌸

grommunio-admin connect [-c COMMAND] [--no-verify] [--redirect-fs
[--auto-save (local|remote|discard|print)]] [-v] [HOST [USER
[PASSWORD]]]

🎀 Description 🎀

so you connect to a remote server so you can invoke CLI commands on it. main character energy, honestly. 🫶

but bestie, there are prerequisites, and no we can't skip them:

  • you need a running admin API with active remote CLI 👑
  • and a user that has SystemAdminPermission — no permission, no party
⚠️ important heads-up: the remote CLI currently uses a REST interface, and a REST interface does not provide a standard input. so any command that relies on user interaction? literally useless. it's giving "talking to a wall." 💀 don't fight it, just don't write those commands.

🌈 Options 🌈

  • HOST — the host you're connecting to, in the format protocol://hostname:port, where protocol is either http or https. if you leave it out, the protocol gets auto-detected, and https takes precedence over http (as it should, queen behavior). no port specified? defaults kick in: 8080 for http and 8443 for https. hostname can be a resolvable host name, an IPv4 address, or an IPv6 address in brackets. default hostname is localhost. 💖
  • PASSWORD — the password for authentication. default is to prompt you for it. 🔐
  • USER — the user for authentication. default is admin. 👑
  • --auto-save ACTION — picks the automatic action for received files when filesystem redirection is enabled. the possible actions are, and i quote the lineup:
    • discard — discard any received file 🙈
    • local — save at local path 💾
    • print — print file contents to stdout and discard 🖨️
    • remote — save at path reported from remote server 🌐
  • -c, --command — execute the command on the remote server and exit, instead of starting an interactive shell. one and done, no small talk. ⚡
  • --no-verify — keep going with https even if the TLS certificate presented by the server is invalid. required if the server uses a self-signed certificate that is not installed on the system. use with caution, bestie, i'm serious. 🚨
  • -p, --password — prompt for the password even when connecting to localhost. sometimes you just want to be asked, y'know? 🎀
  • --redirect-fs — redirect CLI initiated file operations to the local filesystem. see the Filesystem Emulation section for the details, i got you. 📂
  • -v, --verbose — print more detailed information about the connection process. perfect for when you need to know everything that's happening. 🔍

🧚 Filesystem Emulation 🧚

when the --redirect-fs option is given, CLI initiated file operations get performed in an emulated filesystem, and written files get sent back to the client. it's giving "pretend filesystem, real results." ✨

💀 but note: this only applies to files which are opened by CLI operations. module-level operations (e.g. loading of configurations) are unaffected — they don't play by these rules.

files received from the remote server can then be viewed or saved locally. your call, main character. 🫶

⭐ See Also ⭐

and that's the whole page, bestie 💖 this was grommunio-admin-connect(1), manual section 1 — go forth, connect remotely, and slay responsibly. 🎀🦋🌸

📦 where this page comes from