Fonctionnement

Les commandes

Les commandes sont passées via un terminal directement sur le serveur :

# bm-cli help
BlueMind CLI 3.1.32767
usage: bm-cli <command> [<args>]

The most commonly used bm-cli commands are:
    help          Display help information
    maintenance   maintenance task(s)
    tick          tick task(s)

See 'bm-cli help <command>' for more information on a specific command.

Obtenir de l'aide

À tout moment vous pouvez obtenir de l'aide sur une commande et ses options au moyen de "help".

Par exemple "help maintenance" vous présente la commande maintenance et ses diverses actions possibles :

# bm-cli help maintenance
BlueMind CLI 3.1.32767
NAME
        bm-cli maintenance - maintenance task(s)

SYNOPSIS
        bm-cli maintenance
        bm-cli maintenance consolidateIndex [--workers <workers>]
        bm-cli maintenance list [--workers <workers>]
        bm-cli maintenance repair [--dry] [--workers <workers>]
        bm-cli maintenance resetHierarchy [--workers <workers>]

COMMANDS
        With no arguments, List directory entries

        list
            List directory entries
...

Pour obtenir plus de détail sur une sous-commande, il vous suffit de taper la sous-commande à son tour, ici pour obtenir l'aide concernant l'opération de consolidation d'index :

# bm-cli help maintenance consolidateIndex

BlueMind CLI 3.1.32767
NAME
        bm-cli maintenance consolidateIndex - Consolidate a mailbox index

SYNOPSIS
        bm-cli maintenance consolidateIndex [--workers <workers>] [--] <target>

OPTIONS
        --workers <workers>
            run with X workers

        --
            This option can be used to separate command-line options from the
            list of argument, (useful when arguments might be mistaken for
            command-line options

        <target>
            email address or domain name

Exemples pratiques

Réparer la hiérarchie de dossier d'un utilisateur

La commande suivante permet de réparer la hiérarchie de dossier d'un utilisateur ou d'une boîte partagée, par exemple lorsque des dossiers sont présents dans le webmail mais ne sont pas visibles dans un logiciel tiers ou n'apparaissent pas dans les règles de gestion des filtres de l'utilisateur ou de la boîte partagée, ou encore lorsque des dossiers sont visibles mais inaccessibles :

bmcli maintenance resetHierarchie user@domain.net

Effectuer un check&repair global

La commande suivante permet d'effectuer l'opération "valider et réparer" sur l'ensemble des utilisateurs du domaine en utilisant 4 threads :

bm-cli maintenance repair domain.net --numworkers 4

Supprimer les utilisateurs archivés (suspendus) du domaine

Les commandes peuvent être couplées afin d'effectuer plusieurs opérations en une seule fois.

Par exemple, avec la commande ci-dessous on recherche les adresses emails des utilisateurs suspendus :

bm-cli user get domain.net --archived --email

Il est alors possible de coupler le retour de cette commande avec une commande "delete" afin de supprimer les utilisateurs retournés :

bm-cli user get domain.net --archived --email | xargs bm-cli delete

Mettre à jour la configuration tick

Lorsque l'outil de monitoring Bm-Tick est installé, il est possible d'effectuer des tâches d'administration sur celui-ci. Par exemple, vous pouvez redéployer la configuration sur l'ensemble des serveurs du domaine avec la commande suivante :

# bm-cli tick reconfigure

# bm-cli tick reconfigure --dry