grommunio-admin

Name

grommunio-admin — grommunio admin CLI

Synopsis

grommunio-admin -h

grommunio-admin COMMAND [-h | ARGS…]

Description

Command line interface of the grommunio Admin API.

The CLI is not intended to provide the full functionality of the REST interface, but rather a low level administrative tool.

As the CLI is still under development, usage in automated scripts is generally discouraged.

The -h/--help option is not documented separately for each subcommand, but is valid at any point and prints usage information for the current subcommand.

The CLI supports color output if the termcolor module is installed.

Commands

config

Configuration introspection. See grommunio-admin-config.

connect

Connect to remote CLI. See grommunio-admin-connect

dbconf

Database-stored configuration management. See grommunio-admin-dbconf.

domain

Domain management. See grommunio-admin-domain.

exmdb

Access and modify stores of domains and users. See grommunio-admin-exmdb.

fetchmail

Fetchmail management. See grommunio-admin-fetchmail.

fs

Filesystem operations. See grommunio-admin-fs.

ldap

LDAP configuration, diagnostics and synchronization. See grommunio-admin-ldap.

mconf

Managed configurations manipulation. See grommunio-admin-mconf.

mlist

Mailing/distribution list management. See grommunio-admin-mlist.

passwd

User password management. See grommunio-admin-passwd.

run

Run the REST API. See grommunio-admin-run.

server

Multi-server configuration. See grommunio-admin-server

service

Control external services interface. See grommunio-admin-service

shell

Start interactive shell. See grommunio-admin-shell.

taginfo

Print information about proptags. See grommunio-admin-taginfo.

user

User management. See grommunio-admin-user.

version

Show version information. See grommunio-admin-version.