doveadm-cluster-site

NAME

doveadm-cluster-site - Utility actions for Palomar site

SYNOPSIS

doveadm [GLOBAL OPTIONS] cluster site add [ --id id ] [ --tag tag ] [ --load-balancer host ] name

doveadm [GLOBAL OPTIONS] cluster site remove name

doveadm [GLOBAL OPTIONS] cluster site update [ --status online|offline|standby|evacuate ] [ --load-balancer host ] --self | name

doveadm [GLOBAL OPTIONS] cluster site status name

doveadm [GLOBAL OPTIONS] cluster site list

doveadm [GLOBAL OPTIONS] cluster site init [ --update ] --self | name

DESCRIPTION

doveadm cluster site can be used to run actions that interact with and modify Palomar sites.

COMMANDS

cluster site add

doveadm [GLOBAL OPTIONS] cluster site add [ --id id ] [ --tag tag ] [ --load-balancer host ] name

Adds a new site to cluster. Load balancer is the host or IP address where another site's proxy connects to do site to site connections.

New sites are added in online state. UUID should not be used unless you are re-adding the same site.

cluster site remove

doveadm [GLOBAL OPTIONS] cluster site remove name

Remove a site. This currently has no safety checks, so be sure to remove first all of the site's backends and remove it from all users' preferred sites.

cluster site update

doveadm [GLOBAL OPTIONS] cluster site update [ --status online|offline|standby|evacuate ] [ --load-balancer host ] --self | name

Update site status and load balancer. The --self parameter can be used to target the local site.

cluster site list

doveadm [GLOBAL OPTIONS] cluster site list

List all sites.

cluster site init

doveadm [GLOBAL OPTIONS] cluster site init [ --update] --self | name

Initialise site by creating cluster_default_group_count user groups. The --self parameter can be used to target the local site.

If --update is passed this command removes existing groups and recreates them. Users get their users_groups unassigned when running with --update.

SITE STATUS

Online

The site is reachable and accepts connections.

Offline

The site is unreachable.

Standby

The site is reachable, but does not accept connections.

Evacuate

The site is being evacuated of all users.

SEE ALSO

doveadm-cluster(1)