doveadm-cluster-tag(1) - Utility actions for Palomar tag

SYNOPSIS

doveadm [GLOBAL OPTIONS] cluster tag create [--id id] name

doveadm [GLOBAL OPTIONS] cluster tag delete name|id

doveadm [GLOBAL OPTIONS] cluster tag update [--name name] name|id

doveadm [GLOBAL OPTIONS] cluster tag list

DESCRIPTION

doveadm cluster tag can be used to run actions that interact with and modify Palomar tags.

GLOBAL OPTIONS

Global doveadm(1) options:

-D

Enables verbosity and debug messages.

-O

Do not read any config file, just use defaults. The dovecot_storage_version defaults to the latest version, but can be overridden with -o.

-k

Preserve entire environment for doveadm, not just import_environment.

-v

Enables verbosity, including progress counter.

-i instance-name

If using multiple Dovecot instances, choose the config file based on this instance name.

See instance_name for more information.

-c config-file

Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.

-o setting=value

Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.

-f formatter

Specifies the formatter for formatting the output. Supported formatters are:

flow

prints each line with key=value pairs.

json

prints a JSON array of JSON objects.

pager

prints each key: value pair on its own line and separates records with form feed character (^L).

tab

prints a table header followed by tab separated value lines.

table

prints a table header followed by adjusted value lines.

WARNING

Currently there is no checks whether tags are being used or not. Changing a tag UUID, or removing a tag that is in use, can cause problems.

COMMANDS

cluster tag create

doveadm [GLOBAL OPTIONS] cluster tag create [--id id] name

Creates a new tag for cluster. UUID can be provided, if not, it will be generated.

cluster tag delete

doveadm [GLOBAL OPTIONS] cluster tag delete name|id

Remove a tag. This currently has no safety checks, so be sure to first remove all of the tag's sites.

cluster tag update

doveadm [GLOBAL OPTIONS] cluster tag update [--name name] name|id

Change tag name.

cluster tag list

doveadm [GLOBAL OPTIONS] cluster tag list

List all tags.

REPORTING BUGS

Report bugs, including doveconf -n output, to the Dovecot Mailing List dovecot@dovecot.org. Information about reporting bugs is available at: https://dovecot.org/bugreport.html

SEE ALSO

doveadm-cluster(1)