De nombreuses instructions disponibles dans l'interface utilisateur graphique de MailStore Client peuvent également être exécutées à l'aide du shell de gestion de MailStore, un client de ligne de commande qui est automatiquement inclus lors de l'installation de MailStore Server et MailStore Client.
Le shell de gestion est utile lorsque aucune interface utilisateur graphique n'est disponible (par exemple si vous utilisez telnet ou ssh) ou pour l'intégration de scripts (par exemple des fichiers batch) qui sont exécutés manuellement ou automatiquement.
Outre les commandes côté client, Management Shell offre également un accès aux commandes côté serveur de l'API d'administration du serveur MailStore . La sortie des commandes côté serveur est au format JSON.
Démarrage de Management Shell dans MailStore Client
Le Management Shell peut être démarré directement depuis MailStore: Connectez-vous au Client MailStore en tant qu'administrateur et cliquez sur Outils d'administration> API de gestion> Invite de commandes .
La taille de la police peut être ajustée en maintenant la touche Ctrl enfoncée et en utilisant la molette de la souris ou en appuyant sur + et - : Maintenez la touche Ctrl enfoncée et appuyez sur 0 pour réinitialiser la taille de la police.
Utilisation de MailStoreCmd.exe en mode non interactif
En mode non interactif, le shell de gestion se connecte avec les données d'accès transmises, exécute la commande transmise et se termine automatiquement lors de l'exécution. Si la connexion et l'exécution de la commande ont réussi, le code de sortie (ERRORLEVEL) du processus est défini sur 0 (zéro), sinon il est défini sur toute valeur autre que 0. MailStoreCmd.exe se trouve dans le répertoire d'installation du serveur MailStore. MailStoreCmdSilent.exe fait de même, mais n'ouvre pas de fenêtre de console.
Les informations de connexion pour votre installation se trouvent dans la tâche planifiée d'un profil d'archivage du type Programmes de messagerie électronique ou Fichiers de messagerie électronique .
Il existe plusieurs façons de transmettre les informations d'identification à MailStoreCmd.exe .
Pour lire les informations d'identification à partir du gestionnaire d'informations d'identification Windows, elles doivent d'abord y être stockées. Le client MailStore fait cela automatiquement lors de la création d'une tâche planifiée dans le planificateur de tâches Windows. Cette méthode empêche la lecture des mots de passe facilement par des personnes non autorisées.
MailStoreCmd.exe --h = <serveur> --cred = <utilisateur> @ <serveur / adresse IP> --pkv3 = <thumbprint> -c <command> [--param1 = <value> --param2 = <value > ...]
Les informations d'identification peuvent également être transmises sous forme de texte brut.
MailStoreCmd.exe --h = <serveur> --u = <utilisateur> --p = <mot de passe> --pkv3 = <thumbprint> -c <command> [--param1 = <value> --param2 = <value > ...]
Les paramètres de ligne de commande ci-dessous sont obligatoires, suivis de paramètres de commande API supplémentaires si nécessaire.
Paramètre | La description |
---|---|
--h | Le nom de la machine du serveur MailStore auquel MailStoreCmd.exe se connecter. |
--pkv3 | L'empreinte de clé publique (facultative), qui garantit l'identité du serveur MailStore. |
--u | Nom d'utilisateur |
--p | Mot de passe |
--cred | Alternative à --u et --p , le mot de passe est lu à partir du gestionnaire d'informations d'identification Windows. Le paramètre doit être entré dans from <user> @ <server / ip address>. |
--nologo | Optionnel. Empêche l'affichage du logo. |
--o | Optionnel. Redirige la sortie vers un fichier donné. Lorsque ce paramètre est donné, aucune sortie n'est envoyée à la console. |
-c | La commande réelle suit (mode non interactif). |
Aperçu des commandes
Commandes côté client
Trouvez une liste de toutes les commandes côté client ci-dessous.
clear
Efface les textes actuellement affichés pour améliorer la visibilité.
debug-conn
Active le protocole de débogage pour les connexions IMAP et HTTP pendant l'archivage pour le processus client MailStore en cours d'exécution.
debuglog-browse
Ouvre l'explorateur de fichiers et affiche le répertoire du journal de débogage de MailStore .
debuglog-enable, debuglog-disable
Active ou désactive le protocole de débogage global (dans la portée de l'ordinateur).
export-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--[property]="value"]
Exécute un profil d'exportation. Les paramètres suivants sont pris en charge:
--name | --id | nom ou ID du profil d'exportation à exécuter |
--verbose | active un affichage d'état détaillé sur la console |
--[property] | Remplace la propriété donnée d'un profil. Les propriétés internes peuvent être affichées, en sélectionnant un profil d'exportation et en appuyant sur CTRL + SHIFT + P . Le nom de la propriété doit être entre parenthèses. Plusieurs propriétés peuvent être modifiées en répétant le paramètre. |
export-list
Affiche une liste de tous les profils d'exportation existants (ID et nom de profil).
help
Affiche une liste de toutes les commandes disponibles et de leurs paramètres.
import-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--user=<username>] [--[property]="value"]
Exécute le profil d'archivage. Les paramètres suivants sont pris en charge:
--name | --id | nom ou ID du profil d'importation à exécuter |
--verbose | active un affichage d'état détaillé sur la console |
--user | archive utilisateur pour stocker les e-mails archivés |
--[property] | Remplace la propriété donnée d'un profil. Les propriétés internes peuvent être affichées, en sélectionnant un profil d'archivage et en appuyant sur CTRL + SHIFT + P . Le nom de la propriété doit être entre parenthèses. Plusieurs propriétés peuvent être modifiées en répétant le paramètre. |
import-list [--user=<username>]
Affiche une liste de tous les profils d'archivage existants (ID et nom de profil).
livelog-client-disable, livelog-client-enable, livelog-server-disable, livelog-server-enable
Active ou désactive le protocole de débogage en direct du serveur MailStore ou du client MailStore. Le protocole en direct peut être visualisé avec DebugView de Sysinternal. DebugView doit être démarré avec des privilèges élevés et il doit être configuré pour capturer les événements Global Win 32 .
store-setprop --name=<name> [--value=true/false]
Modifie la valeur d'une propriété globale
--name | Nom de la propriété globale |
--value | Valeur de la propriété globale |
Les propriétés globales suivantes sont prises en charge:
Nom | Version | Valeurs | Défaut |
---|---|---|---|
public.arcclient.skipMimeContentConversionFailed | 8 | true = Les erreurs Exchange MimeContentConversionFailed sont ignorées et ne sont pas traitées comme une erreur d'archivage. false = Les erreurs Exchange MimeContentConversionFailed sont traitées comme des erreurs d'archivage. | faux |
public.arcclient.skipVirusDetected | 8.1 | true = Exchange ErrorVirusDetected Les erreurs détectées sont ignorées et ne sont pas traitées comme une erreur d'archivage. false = Exchange ErrorVirusDetected Les erreurs détectées sont traitées comme des erreurs d'archivage. | faux |
public.arcclient.skipEwsErrorItemNotFound | dix | true = Les erreurs Exchange ErrorItemNotFound sont ignorées et ne sont pas traitées comme une erreur d'archivage. false = Les erreurs Exchange ErrorItemNotFound sont traitées comme des erreurs d'archivage. | faux |
public.backup.hideNotDetectedWarningMessage | 11 | true = Les messages d'avertissement de sauvegarde ne sont pas affichés sur le tableau de bord. false = Les messages d'avertissement de sauvegarde sont affichés sur le tableau de bord. | faux |
user-list
Afficher la liste des utilisateurs.
Commandes côté serveur
Vous trouverez un aperçu de toutes les commandes côté serveur disponibles sous Référence des fonctions .
Les paramètres des commandes côté serveur sont sensibles à la casse et doivent être saisis avec deux tirets (-). Les valeurs booléennes doivent être entrées comme vrai ou faux . Les chaînes contenant des espaces blancs doivent être placées entre guillemets.
Exemples:
GetProfiles --raw=true
Répertorie tous les profils d'archivage et d'exportation.
GetUserInfo --userName="alexis.page"
Répertorie les propriétés de l'utilisateur alexis.page .
GetJobResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneId="$Local" --jobId=1
Répertorie les résultats du travail avec l'ID 1 de l'année 2018.
GetWorkerResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneID="$Local" --profileID=1
Répertorie les résultats du profil d'archivage avec l'ID 1 de l'année 2018. La commande GetWorkerResults est la seule commande où le paramètre timeZoneID est écrit avec un D majuscule .
RunProfile --id=1
Démarre le profil d'archivage ou d'exportation avec l'ID 1.