Search K
Appearance
doveadm-cluster-user(1) - 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 backend [--direct] user dest-host
doveadm [GLOBAL OPTIONS] cluster user move site [--direct] [--keep-preferred] user dest-site
doveadm [GLOBAL OPTIONS] cluster user move status
doveadm [GLOBAL OPTIONS] cluster user batch move backend [--id id] [--min-last-moved age] --count usersdest-host [dest-host ...]
doveadm [GLOBAL OPTIONS] cluster user batch move site [--id id] [--min-last-moved age] [--keep-preferred] --count users dest-site [dest-site ...]
doveadm [GLOBAL OPTIONS] cluster user batch move stop
doveadm [GLOBAL OPTIONS] cluster user batch move status
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 backend
doveadm [GLOBAL OPTIONS] cluster user move backend [--direct] user dest-host
Initiates moving user to a different backend. The move is added to the queue of user moves, and it will finish on background. This command only moves the user from the backend where it is run from, i.e. the command should be run on the user's current backend.
--direct will update the user's new backend immediately to GeoDB without performing any user moving (kicking of existing sessions or flushing metacache). This is intended for testing and troubleshooting purposes only, and should not be normally used.
cluster user move site
doveadm [GLOBAL OPTIONS] cluster user move site [--direct] [--keep-preferred] user dest-site
Initiates moving user to a different site. The move is added to the queue of user moves, and it will finish on background. This command only moves the user from the backend where it is run from, i.e. the command should be run on the user's current backend.
--direct will update the user's new site immediately to GeoDB without performing any user moving (kicking of existing sessions or flushing metacache). This is intended for testing and troubleshooting purposes only, and should not be normally used.
--keep-preferred disables changing the user's preferred site. This is used to temporarily move users to different sites, e.g. for load-balancing purposes.
cluster user move status
Output the status of the current user move queue.
cluster user batch move backend
doveadm [GLOBAL OPTIONS] cluster user batch move backend [--id id] [--min-last-moved age] --count usersdest-host [dest-host ...]
Initiates moving a number of users to different backends which will finish in background. If the command is run again while a batch (backend or site) move is already in progress, the previous batch move is aborted.
The user moves are equally distributed to the list of given destination backends.
--id specifies a UUID for the move operation. By default a new ID is generated. The moving status is visible in GeoDB's move_* fields.
--min-last-moved specifies a time interval (e.g. "1 hour") for the minimum age of the user's last-moved timestamp. This is used to avoid moving the same users too often.
cluster user batch move site
doveadm [GLOBAL OPTIONS] cluster user batch move site [--id id] [--min-last-moved age] [--keep-preferred] --count users dest-site [dest-site ...]
Initiates moving a number of users to different sites which will finish in background. If the command is run again while a batch (backend or site) move is already in progress, the previous batch move is aborted.
The user moves are equally distributed to the list of given destination sites.
--id specifies a UUID for the move operation. By default a new ID is generated. The moving status is visible in GeoDB's move_* fields.
--min-last-moved specifies a time interval (e.g. "1 hour") for the minimum age of the user's last-moved timestamp. This is used to avoid moving the same users too often.
--keep-preferred disables changing the users' preferred sites. This is used to temporarily move users to different sites, e.g. for load-balancing purposes.
cluster user batch move stop
Stop the currently running user batch move.
cluster user batch move status
Output the status of the currently running user batch move.
cluster user status
doveadm [GLOBAL OPTIONS] cluster user status user
Displays status information of a user.