doveadm-cluster-user

NAME

doveadm-cluster-user - Utility actions for Palomar users

SYNOPSIS

doveadm [GLOBAL OPTIONS] cluster user access [ -u user | -A | -f file | --no-userdb-lookup] [ -i ]

doveadm [GLOBAL OPTIONS] cluster user delete user

doveadm [GLOBAL OPTIONS] cluster user move [ --direct ] [ --site site ] user group [ failover group ]

doveadm [GLOBAL OPTIONS] cluster user status user

DESCRIPTION

doveadm cluster user can be used to run actions that interact with Palomar users.

COMMANDS

cluster user access

doveadm [GLOBAL OPTIONS] cluster user access [ -u user | -A | -F file | --no-userdb-lookup] [ -i ]

Perform cluster lookup for the user (or users). Displays the host name or IP address of the backend which the user ended up. This command can be run from either a proxy or a backend. This command is also used internally to finish user moves.

You can use the -i parameter to display backend's IP rather than host name.

cluster user delete

doveadm [GLOBAL OPTIONS] cluster user delete user

Deletes a user record from GeoDB.

cluster user move

doveadm [GLOBAL OPTIONS] cluster user move [ --direct ] [ --site site ] user group [ failover group ]

Initiates moving user to a different user group which will finish in background. The move is initialized by updating the moving_* fields in GeoDB. The next time the user is accessed triggers the actual moving by the original backend. This user access is also automatically triggered by running doveadm cluster user access command.

--direct will update the user's new site/group immediately to GeoDB without performing any user moving. This is intended for testing purposes only, and should not be used.

cluster user status

doveadm [GLOBAL OPTIONS] cluster user status user

Displays status information of a user.

SEE ALSO

doveadm-cluster(1)