KOPANO-CLI(8)

📦 version 8.7.0, in ubuntu jammy

💖 KOPANO-CLI 💖

NAME

kopano-cli — bestie, it's literally The Kopano Command-line Interface, and it's about to be your new fave ✨

SYNOPSIS

kopano-cli [OPTION...]

DESCRIPTION

okay so listen 🫶 kopano-cli is your main character tool for managing a whole Kopano server (a cluster, no less 💅). We're talking users, stores, groups and companies — the whole friend group.

That means listing, creating and deleting objects, and also changing settings like quota limits, delegation, out-of-office settings, and store- and folder-level permissions. She does it all, periodt. 👑

OPTIONS ✨

  • --active {yes|no} — change or specify if a user is active. Should be combined with --user (and optionally --create).
  • --add-admin NAME — add the specified user as a "remote-admin" for the company you gave with --company.
  • --add-company-quota-recipient NAME — add the specified user to companyquota recipients for the company you gave with --company.
  • --add-delegation NAME — add the specified delegation (flags) to the user you gave with --user. The syntax for the delegation (flags) is 'user:flag1,flag2,..' where user is a user name, and the flags are optionally chosen from: see_private, send_copy. The first one means delegates can see private items 💀, and the second means meeting requests and responses also get sent to the delegates.
  • --add-feature NAME — enable the specified feature for the user you gave with --user.
  • --add-permission NAME — add the specified permissions to the store of the user you gave with --user. Can be used with --folder to add permissions for a specific folder. The syntax for permissions is 'member:right1,right..' where member is a group or user name, and the rights are chosen from: read_items, create_items, create_subfolders, edit_own, edit_all, delete_own, delete_all, folder_owner, folder_contact and folder_visible. So fr, to add certain permissions to the inbox of user user2, on the inbox of user user1: --user user1 --folder Inbox --add-permission user2:read_items,folder_visible. The colon is optional btw, no stress.
  • --add-sendas NAME — allow the specified user to "send as" the user you gave with --user.
  • --add-userquota-recipient NAME — add the specified user to userquota recipients for the company you gave with --company.
  • --add-view NAME — add the specified company as a remote-viewer of the address book.
  • --add-user NAME — add the specified user to the group you gave with --group.
  • --admin NAME — make the specified user an administrator of the company you gave with --company.
  • --admin-level N — change or specify the admin level for the user you gave with --user. A value of 1 means the user is an administrator, and 2 means the user is a system administrator. big girl energy 🔥
  • --clear-cache — clear all server caches. bye bye cache 🧹
  • --company, -C NAME — specify a company. With no further arguments, this shows info about the given company. Can also be combined with stuff like --list-users.
  • --config, -c FILE — load configuration settings from the specified file.
  • --create — create an object. Must be combined with --user, --group or --company. Can be combined with options like --fullname, --email and --password. Heads up though: this does not work with an external source such as LDAP. 🙈
  • --create-store — create and hook a store. With no further arguments, a public store is created for the current company or server. Can be combined with --company (to create a company public store) and --user (to create a user store).
  • --debug — enable debug mode, meaning full tracebacks get shown in addition to error messages. (iykyk, the full tracebacks are a lot 🫠)
  • --delete — delete an object. Must be combined with --user, --group or --company. Also note: this does not work with an external source such as LDAP.
  • --email NAME — change or specify an object's email address. Can be used with --user or --group (and optionally --create).
  • --folder, -f PATH — specify a folder. Can be used in combination with e.g. --add-permission, to add permissions for a specific folder. --recursive.
  • --fullname NAME — change or specify an object's full name. Can be used with --user, --group or --company (and optionally --create).
  • --group, -G NAME — specify a group. With no further arguments, this shows info about the given group. Can also be combined with e.g. --list-users.
  • --hook-store GUID — hook a store with the specified GUID. With no further arguments, this hooks the public store. Can be combined with --company (to hook the public store) and --user (to hook the user store).
  • --hook-archive GUID — hook the archive store with the specified GUID. Should be used together with --user.
  • --lang LANG — specify the language new stores get created in, which determines e.g. the name of the inbox.
  • --mr-accept {yes|no} — change or specify if meeting requests are automatically accepted (by the script specified in dagent.cfg). Should be combined with --user.
  • --mr-accept-conflicts {yes|no} — change or specify if overlapping meeting requests are automatically declined by the accept script. Should be combined with --user.
  • --mr-accept-recurring {yes|no} — change or specify if recurring meeting requests are automatically declined by the accept script. Should be combined with --user.
  • --list-users — list users. With no further arguments, this lists all users. Can also be combined with e.g. --company and --group.
  • --list-groups — list groups. With no further arguments, this lists all groups. Can also be combined with e.g. --company.
  • --list-companies — list companies.
  • --list-orphans — list orphans, meaning stores that aren't currently hooked to a user or public store. 🥺
  • --name NAME — change or specify an object's name. Can be used with --user, --group or --company (and optionally --create).
  • --ooo {yes|no} — enable or disable out-of-office replies for the user you gave with --user.
  • --ooo-clear — clear out-of-office settings for the user you gave with --user.
  • --ooo-subject NAME — change or specify the out-of-office subject for the user you gave with --user.
  • --ooo-message PATH — change or specify the out-of-office message for the user you gave with --user, by pointing at a file that contains the message.
  • --ooo-from NAME — change or specify the out-of-office from date for the user you gave with --user.
  • --ooo-until NAME — change or specify the out-of-office until date for the user you gave with --user.
  • --password NAME — change or specify a user password. Should be used together with --user (and optionally --create).
  • --password-prompt — change or specify a user password via a prompt. Should be used together with --user (and optionally --create).
  • --purge-softdelete N — purge items marked as softdeleted more than N days ago.
  • --purge-deferred — purge all items in the deferred update table.
  • --quota-override {yes|no} — override server quota limits for the user you gave with --user or the company you gave with --company.
  • --quota-hard N — change or specify the hard quota limit at the specified number of megabytes (MB). Should be used with --user or --company.
  • --quota-soft N — change or specify the soft quota limit at the specified number of megabytes (MB). Should be used with --user or --company.
  • --quota-warn N — change or specify the warn quota limit at the specified number of megabytes (MB). Should be used with --user or --company.
  • --remove-store GUID — remove the orphaned store with the specified GUID.
  • --remove-admin NAME — remove the specified user as a "remote-admin" for the company you gave with --company.
  • --remove-company-quota-recipient NAME — remove the specified user from companyquota recipients for the company you gave with --company.
  • --remove-delegation NAME — remove a delegation (flags) for the user you gave with --user. The syntax is the one described for the --add-delegation option.
  • --remove-feature NAME — disable the specified feature for the user you gave with --user.
  • --remove-permission NAME — remove the specified permissions from the store of the user you gave with --user. Can be used with --folder to remove permissions for a specific folder. The syntax is the one described for the --add-permission option.
  • --remove-sendas NAME — disallow the specified user to "send as" the user you gave with --user.
  • --remove-userquota-recipient NAME — remove the specified user from userquota recipients for the company you gave with --company.
  • --remove-view NAME — remove the specified company as a remote-viewer of the address book.
  • --remove-user NAME — remove the specified user from the group you gave with --group.
  • --reset-folder-count — reset folder counts for all folders of the user you gave with --user.
  • --send-only-to-delegates {yes|no} — when sending meeting requests and responses to delegates, only send them to the delegates.
  • --server-socket, -s SOCKET — connect to the storage server through the specified socket.
  • --ssl-key, -k FILE — specify the SSL key file.
  • --ssl-pass, -p PASSWORD — specify the SSL key password.
  • --store, -S GUID — specify a store. To specify a public store, use "public" or "public@companyname".
  • --sync — synchronize users, groups and companies with an external source (such as LDAP).
  • --unhook-archive — unhook the archive store. Should be combined with --user.
  • --unhook-store — unhook a store. With no further arguments, the public store gets unhooked. Can be combined with --company (to unhook the public store) or --user (to unhook the user store).
  • --user, -u NAME — specify a user. With no further arguments, this shows info about the given user.
  • --user-count — output user statistics, like active and non-active users and the total user count. 📊

EXAMPLES 🌸

To create a new user:

kopano-cli --create -u john --fullname "john doe" --password john
--email john@doe.com

To modify the password and e-mail address:

kopano-cli -u john --password john --email john@doe.com

To set out of office for a user:

kopano-cli -u john --ooo-active yes --ooo-subject "On vacation" --ooo-
message /etc/kopano/ooo/vacation.html

To delete a user:

kopano-cli --delete -u john

To set permission on a calendar folder:

kopano-cli -u john --folder Calendar --add-permission
everyone:read_items,folder_visible

To set permission on a store:

kopano-cli -u john --add-permission joe:read_items,folder_visible

👑 AUTHOR 👑

Bestie. This whole entire thing — every flag, every byte, every little - — was Written by Kopano. ✨

That's it. That's the whole author section. No mysterious anonymous committee, no "several people over the years", no shadowy cabal of manpage gremlins 🧚 — just Kopano, holding it down, being the main character of this documentation fr fr 💅

Lowkey iconic of them, ngl. Whoever Kopano is, they sat down and documented all of this so you wouldn't have to guess, and that is genuinely a public service 🫶 so if you ever meet them, say thank you. Or don't, I'm not your mom. But it's giving thoughtful. 🌸

and that's a wrap on the whole page, bestie!! 🎀🦋💖

This gorgeous little document is Kopano 8 ✨, dated June 2017 ⭐, and you found it filed under KOPANO-CLI(8) — the big 8 meaning she lives in the system-administration section of your man pages, where the real ones hang out 👑🔧

Go forth, run your commands, read your man pages, and stay slaying. 💜🌈🎀

📦 where this page comes from