Fonctionnement
Les commandes
Les commandes sont passées via un terminal directement sur le serveur, connecté en ssh par exemple.
Par exemple, une commande permettant de connaître les carnets d'adresses d'un utilisateur :
root@mail:~# bm-cli contact list jdoe@bluemind.loc {"owner":"05E25C2C-3643-4ED2-997C-4A4F39933D18","uid":"book:Contacts_05E25C2C-3643-4ED2-997C-4A4F39933D18","name":"My contacts"} {"owner":"05E25C2C-3643-4ED2-997C-4A4F39933D18","uid":"book:CollectedContacts_05E25C2C-3643-4ED2-997C-4A4F39933D18","name":"Collected contacts"} {"owner":"05E25C2C-3643-4ED2-997C-4A4F39933D18","uid":"408C741B-3FDC-44B6-B1FD-19E79404BFCF","name":"Perso"}
Obtenir de l'aide
Les commandes sont enrichies au fur et à mesure des versions de BlueMind. Il se peut donc que vous ayez plus (ou moins) de commandes selon la version de votre installation.
Il est donc important de se référer à la commande "bm-cli help" afin de savoir quelles sont celles que vous pouvez utiliser.
Par exemple :
# bm-cli help usage: bm-cli <command> [<args>] The most commonly used bm-cli commands are: calendar calendar task(s) contact contact task(s) help Display help information maintenance maintenance task(s) tick tick task(s) user user task(s) See 'bm-cli help <command>' for more information on a specific command.
L'installation, ici en 3.5.11, bénéficie ici des commandes calendar, contact et user qui n'étaient pas présentes sur les versions antérieures.
À tout moment vous pouvez obtenir de l'aide sur une commande, une sous-commande, son usage 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 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>] 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 NAME bm-cli maintenance consolidateIndex - Consolidate a mailbox index SYNOPSIS bm-cli maintenance consolidateIndex [--workers <workers>] [--] <target> OPTIONS --workers <workers> run with X workers ...
Exemples pratiques
Administration & Maintenance
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 --workers 4
Modifier le mot de passe admin0
Pour diverses raisons, techniques ou pratiques (en cas de perte, par exemple), il peut être utile de modifier le mot de passe de l'utilisateur admin0 sans avoir à se loguer dans BlueMind.
La commande suivante permet de le faire sans connaître l'ancien mot de passe :
bm-cli user update admin0@global.virt --password "NewPassword"
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
L'option --dry
permet de tester la commande : l'opération est juste simulée
# bm-cli tick reconfigure --dry
Mettre à jour BlueMind
À partir de BlueMind 4.1, si la souscription le permet et que les paquets adéquats sont installés, la mise à jour de BlueMind peut se faire complètement en ligne de commande, sans passer par l'exécution de l'assistant via navigateur :
aptitude update aptitude upgrade && bm-cli setup upgrade
yum update yum upgrade && bm-cli setup upgrade
Gestion des utilisateurs
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 --display "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 local.lan --display "email" | jq -r '.[].email' > /tmp/archived.txt while read account; do bm-cli user delete --dry $account ;done < /tmp/archived.txt
Opérations sur les calendriers
Partager les calendriers de tous les utilisateurs vers un utilisateur
Il peut s'avérer utile qu'un utilisateur ait des droits d'accès sur les calendriers de tous les autres utilisateurs sans pour autant qu'il soit désigné administrateur (par exemple une secrétaire devant pouvoir voir/créer des événements pour l'ensemble des collaborateurs). Afin d'éviter la tâche laborieuse de passer sur toutes les fiches d'administration des utilisateurs pour activer un partage, il est possible de réaliser cela en ligne de commande.
Cette opération n'est pas réalisable en une seule commande, néanmoins il est possible de réaliser une boucle récupérant l'ensemble des utilisateurs du domaine puis activant un partage pour chacun d'eux :
bm-cli users get domain.net > /tmp/allUser.domain.net while read account; do bm-cli calendar share $account « default » toto@domain.net r;done < /tmp/allUser.domain.net
Opérations sur les contacts
Exemple de procédure pour nettoyer le carnet des collectés d'un utilisateur puis transférer les contacts vers son carnet personnel (en testant au préalable l'import) :
root@mail:~# bm-cli contact list jdoe@bluemind.loc {"owner":"05E25C2C-3643-4ED2-997C-4A4F39933D18","uid":"book:Contacts_05E25C2C-3643-4ED2-997C-4A4F39933D18","name":"My contacts"} {"owner":"05E25C2C-3643-4ED2-997C-4A4F39933D18","uid":"book:CollectedContacts_05E25C2C-3643-4ED2-997C-4A4F39933D18","name":"Collected contacts"} {"owner":"05E25C2C-3643-4ED2-997C-4A4F39933D18","uid":"408C741B-3FDC-44B6-B1FD-19E79404BFCF","name":"Perso"} root@mail:~# bm-cli contact deduplicate jdoe@bluemind.loc --addressbook-uid book:CollectedContacts_05E25C2C-3643-4ED2-997C-4A4F39933D18 2 were removed out of 35 root@mail:~# bm-cli contact export jdoe@bluemind.loc --vcf-file-path /tmp/jdoe-collected.vcf --addressbook-uid book:CollectedContacts_05E25C2C-3643-4ED2-997C-4A4F39933D18 addressbook book:CollectedContacts_05E25C2C-3643-4ED2-997C-4A4F39933D18 of jdoe@bluemind.loc was exported root@mail:~# bm-cli contact import jdoe@bluemind.loc --vcf-file-path /tmp/jdoe-collected.vcf --addressbook-uid 408C741B-3FDC-44B6-B1FD-19E79404BFCF --dry DRY : AddressBook 408C741B-3FDC-44B6-B1FD-19E79404BFCF of jdoe@bluemind.loc was imported root@mail:~# bm-cli contact import jdoe@bluemind.loc --vcf-file-path /tmp/jdoe-collected.vcf --addressbook-uid 408C741B-3FDC-44B6-B1FD-19E79404BFCF AddressBook 408C741B-3FDC-44B6-B1FD-19E79404BFCF of jdoe@bluemind.loc was imported root@mail:~# bm-cli contact reset jdoe@bluemind.loc --addressbook-uid book:CollectedContacts_05E25C2C-3643-4ED2-997C-4A4F39933D18 Addressbook book:CollectedContacts_05E25C2C-3643-4ED2-997C-4A4F39933D18 of jdoe@bluemind.loc was reset