MailStore Server Management Shell: Unterschied zwischen den Versionen

[unmarkierte Version][gesichtete Version]
(44 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
 
Die Management Shell ist einerseits dann nützlich, wenn keine grafische Umgebung zur Verfügung steht (z.B. bei Verwendung von telnet oder ssh), andererseits zur Einbindung in automatisch oder manuell gestartete Scripts (z.B. Batchdateien).
 
Die Management Shell ist einerseits dann nützlich, wenn keine grafische Umgebung zur Verfügung steht (z.B. bei Verwendung von telnet oder ssh), andererseits zur Einbindung in automatisch oder manuell gestartete Scripts (z.B. Batchdateien).
  
−
= Möglichkeit 1: Die Management Shell aus MailStore heraus starten =
+
Neben den Client-seitigen Befehlen (''Client-side Commands'') stellt die Management Shell auch einen Zugriff auf die Server-seitigen Befehle (''Server-side Commands'') der [[Administration API - Using the API|MailStore Server Administration API]] bereit. Die Ausgabe der Server-seitigen Befehle erfolgt im JSON-Format.
  
−
Sie können die Management Shell direkt aus MailStore heraus starten. Melden Sie sich dazu als MailStore-Administrator über den MailStore Client an und klicken Sie auf ''Verwaltung'' > ''Verschiedenes'' und dann auf ''Management Shell''.
+
== Die Management Shell aus MailStore heraus starten ==
 +
Sie können die Management Shell direkt aus MailStore heraus starten. Melden Sie sich dazu als MailStore-Administrator über den MailStore Client an und klicken Sie auf ''Verwaltung > Management API > Eingabeaufforderung''.
  
 
[[File:tech_mscmd_01.png|center|500px]]
 
[[File:tech_mscmd_01.png|center|500px]]
  
−
= Möglichkeit 2: Die Management Shell über MailStoreCmd.exe starten =
+
Die Schriftgröße der Management Shell kann durch Halten der Strg-Taste und Drehen des Mausrads oder + und - auf der Tastatur angepasst werden. Halten der Strg-Taste und 0 setzt die Schriftgröße zurück.
−
Starten Sie die Management Shell im interaktiven Modus, indem Sie <code>MailStoreCmd.exe</code> ohne Übergabe von Parametern ausführen. Nach erfolgreicher Anmeldung empfängt MailStore Ihre Befehle. Geben Sie ''exit'' ein, um sich abzumelden und die Management Shell zu beenden.
 
  
−
[[File:tech_mscmd_02.png|center|500px]]
+
== MailStoreCmd.exe im nicht-interaktiven Modus verwenden ==
 +
Im nicht-interaktiven Modus führt die Management Shell eine Anmeldung mit übergebenen Anmeldeinformationen durch, führt einen ebenfalls übergebenen Befehl aus und beendet sich daraufhin automatisch. Der Exit Code (ERRORLEVEL) des Prozesses wird auf 0 gesetzt, wenn Anmeldung und Befehl erfolgreich ausgeführt werden konnten, sonst auf einen Wert ungleich 0. Die MailStoreCmd.exe befindet sich im Installationsverzeichnis von MailStore Server. Die ebenfalls vorhandene MailStoreCmdSilent.exe macht dasselbe, öffnet jedoch kein sichtbares Kommandozeilenfenster.
  
−
= MailStoreCmd.exe im nicht-interaktiven Modus verwenden =
+
Es gibt mehrere Möglichkeiten, Anmeldedaten an MailStoreCmd.exe zu übergeben.
  
−
Im nicht-interaktiven Modus führt die Management Shell eine Anmeldung mit übergebenen Anmeldeinformationen durch, führt einen ebenfalls übergebenen Befehl aus und beendet sich daraufhin automatisch. Der Exit Code (ERRORLEVEL) des Prozesses wird auf 0 gesetzt, wenn Anmeldung und Befehl erfolgreich ausgeführt werden konnten, sonst auf einen Wert ungleich 0.
+
Bei der Verwendung des Parameters ''cred'', liest MailStoreCmd die Zugangsdaten aus der Windows-Anmeldeinformationsverwaltung. Diese Methode verhindert, dass Zugangsdaten einfach von Dritten eingesehen werden können. Die Anmeldedaten können dann wie folgt verwendet werden:
  
−
Um den nicht-interaktiven Modus zu verwenden, übergeben Sie die Parameter wie folgt:
+
  MailStoreCmd.exe --h=<server> --cred=<user>@<server/IP-Adresse> --pkv3=<thumbprint> -c  <command> [--param1=<value> --param2=<value> ...]
  
−
MailStoreCmd.exe --h="localhost" --pkv3="23:18:06:3f:24:7d:f3:83"  --u="admin" --p="admin"
+
Die passenden Werte für die Parameter ''cred'' und ''pkv3'' erhalten Sie, wenn Sie ein Archivierungsprofil aus der Rubrik E-Mail-Programme oder E-Mail-Dateien erstellen. Dieses Profil muss nicht funktional sein. Dann klicken Sie mit der rechten Maustaste auf das Archivierungsprofil und wählen ''Task erstellen auf <COMPUTERNAME>'' und anschließend auf ''Cmd kopieren''. Dadurch legt der MailStore Client die Zugangsdaten des angemeldeten Benutzers in der Windows-Anmeldeinformationsverwaltung und das MailStore Kommando für diese Aufgabe in der Zwischenablage ab.
−
-c <Tatsächlicher Befehl und Parameter>
 
  
−
Im Folgenden werden die einzelnen Parameter beschrieben
+
Wenn Sie sich nun den Inhalt der Zwischenablage anzeigen lassen, sehen Sie die Werte für ''cred'' und ''pkv3''. Falls ''pkv3'' nicht gesetzt sein sollte, wird dem Zertifikat auch ohne Angabe dieses Wertes vertraut und muss im nicht-interaktiven Modus nicht angegeben werden.
 +
Das temporär erzeugte Archivierungsprofil kann wieder gelöscht werden.
  
−
<code>--h="localhost"</code><br/>
+
Die Zugangsdaten sind in der Windows-Anmeldeinformationsverwaltung unter Windows-Anmeldeinformationen > Generische Anmeldeinformationen > MailStore_E18FE535-FFFB-4079-A385-B1A6FC78E927_cmdline_<user@server> gespeichert und können dort gegebenenfalls wieder gelöscht werden.
−
Der Rechnername des MailStore Server, mit welchem sich <code>MailStoreCmd.exe</code> verbinden soll.
 
  
−
--pkv3="..."
+
Falls bereits einen geplanten Task für ein derartiges Profil auf diesem Computer existiert, können die Werde für ''cred'' und ''pkv3'' diesem entnommen werden, ohne das ein temporäres Profil erstellt werden muss.
−
Optionaler Fingerabdruck (Public Key Fingerprint), der die Identität des MailStore Server sicherstellt.
 
  
−
--u="admin"
+
Die Anmeldedaten können auch im Klartext übergeben werden.
−
Benutzername
 
  
−
  --p="admin"
+
  MailStoreCmd.exe --h=<server> --u=<user> --p=<password> --pkv3=<thumbprint> -c  <command> [--param1=<value> --param2=<value> ...]
−
Kennwort
 
  
−
-c
+
Im Folgenden werden die einzelnen Parameter beschrieben
−
Es folgt der tatsächliche Befehl (nicht-interaktiver Modus)
 
−
 
 
−
= Befehlsübersicht =
 
  
−
  backup --target=<targetdirectory> [--nosync] [--skipreadonly] [--filegroups=1,2,...,4]
+
{| class="wikitable"
−
 
+
! width=100px | Parameter  
−
Erstellt eine Archiv-Datensicherung. Folgende Parameter werden unterstützt:
+
! width=100% | Beschreibung
−
 
 
−
{| width=80% |
 
 
|-
 
|-
−
| scope="col" width="20%" | <code>--target</code>
+
| <code>--h</code>
−
| Zielverzeichnis für die Datensicherung
+
| Der Rechnername des MailStore Server, mit welchem sich MailStoreCmd.exe verbinden soll.
 
|-
 
|-
−
| <code>--nosync</code>
+
| <code>--pkv3</code>
−
| Alle Dateien kopieren, nicht nur neue oder geänderte
+
| Fingerabdruck (Public Key Fingerprint), der die Identität des MailStore Server sicherstellt.
 
|-
 
|-
−
| <code>--skipreadonly</code>
+
| <code>--u</code>
−
| Als Schreibgeschützt markierte Dateigruppen überspringen
+
| Benutzername
 +
|-
 +
| <code>--p</code>
 +
| Kennwort
 +
|-
 +
| <code>--cred</code>
 +
| Alternative zu <code>--u</code> und <code>--p</code>, das Kennwort wird aus der Windows-Anmeldeinformationsverwaltung gelesen. Der Parameter ist in der Form <user>@<server/IP-Adresse> anzugeben.
 +
|-
 +
| <code>--nologo</code>
 +
| Optional. Unterdrückt die Anzeige des Logos.
 +
|-
 +
| <code>--o</code>
 +
| Optional. Leitet die Ausgabe in die angegebene Datei um. Es erscheint dann keine Ausgabe im Konsolenfenster.
 
|-
 
|-
−
| <code>--filegroups=1,2,...,4</code>
+
| <code>-c</code>
−
| Nur angegebene Dateigruppen sichern
+
| Es folgt der tatsächliche Befehl.
−
|}  
+
|}
 +
 
 +
== Befehlsübersicht ==
 +
 
 +
=== Client-seitige Befehle ===
 +
 
 +
Im folgenden finden Sie eine Befehlsübersicht der Client-seitigen Befehle.
  
 
   clear
 
   clear
Zeile 65: Zeile 75:
 
Löscht die angezeigten Texte und erhöht so die Übersichtlichkeit
 
Löscht die angezeigten Texte und erhöht so die Übersichtlichkeit
  
−
   debug-console,  debuglog-browse,  debuglog-disable,  debuglog-enable
+
   debug-conn
 +
 
 +
Aktiviert das Verbindungsprotokoll für IMAP und HTTP Verbindungen während der Archivierung für den aktuell laufenden MailStore Client Prozess.
  
−
Aktiviert das globale (rechnerweite) Debugprotokoll, zeigt es an oder deaktiviert es.
+
  debuglog-browse
  
−
   export-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--[property]="value"]
+
Öffnet das Debug-Protokoll-Verzeichnis im Datei-Explorer.
 +
 
 +
  debuglog-enable,  debuglog-disable
 +
 
 +
Aktiviert oder deaktiviert das globale (rechnerweite) Debugprotokoll.
 +
 
 +
   export-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--[property]="value"]
  
 
Führt ein Export-Profil aus. Folgende Parameter werden unterstützt:
 
Führt ein Export-Profil aus. Folgende Parameter werden unterstützt:
  
−
{| width=80% |
+
{| width=100% |
 
|-
 
|-
 
| scope="col" width="20%" | <code>--name</code> <nowiki>|</nowiki> <code>--id</code>
 
| scope="col" width="20%" | <code>--name</code> <nowiki>|</nowiki> <code>--id</code>
Zeile 82: Zeile 100:
 
|-
 
|-
 
| <code>--[property]</code>
 
| <code>--[property]</code>
−
| Überschreibt die angegebene interne Property eines Profils. Die internen Properties lassen sich anzeigen, in dem man ein Exportsprofil aus der Liste auswählt und die Tastenkombination STRG + SHIFT + P drückt. Der Name der Property muss in eckigen Klammern geschrieben werden. Es können beliebig viele Properties angegeben werden.
+
| Überschreibt die angegebene interne Property eines Profils. Die internen Properties lassen sich anzeigen, in dem man ein Exportsprofil aus der Liste auswählt und die Tastenkombination <code>STRG + SHIFT + P</code> drückt. Der Name der Property muss in eckigen Klammern geschrieben werden. Es können beliebig viele Properties angegeben werden.
 
|}
 
|}
  
Zeile 91: Zeile 109:
 
   help
 
   help
  
−
Zeigt eine Liste aller verfügbaren Befehle und deren Parameter
+
Zeigt eine Liste aller verfügbaren Client- als auch Server-seitigen Befehle und deren Parameter
−
 
 
−
  filegroup-attach --directory=<directory>
 
−
 
 
−
Über diesen Befehl kann eine mit <code>filegroup-detach</code> aus MailStore entfernte Dateigruppe wieder neu hinzugefügt werden.
 
−
 
 
−
  filegroup-create --directory=<directory>
 
−
 
 
−
Erstellt eine neue Dateigruppe am mit <directory> angegebenen Ort.
 
−
 
 
−
  filegroup-detach --gid=<filegroupid>
 
−
 
 
−
Über die Funktion ''Verwaltung -> Speicherorte'' kann eine Dateigruppe mit dem Status deaktiviert versehen werden. Die Dateigruppe und die darin enthaltenen E-Mails stehen dann bis zur Aktivierung nicht mehr zur Verfügung. Die Dateigruppe bleibt jedoch als vorhandene Dateigruppe aufgelistet. Über den Admin-Konsolen-Befehl <code>filegroup-detach</code> wird eine Dateigruppe vollkommen aus MailStore entfernt (nicht aber physikalisch auf der Festplatte gelöscht).
 
−
 
 
−
  filegroup-upgrade --gid=<filegroupid>
 
−
 
 
−
Upgrade der mit <filegroupid> angegebenen Dateigruppe auf die neuste Version.
 
−
 
 
−
  filegroup-verify --gid=<filegroupid>
 
−
 
 
−
Startet eine Überprüfung des mit <filegroupid> angegebenen Dateigruppe.
 
−
 
 
−
  index-rebuild [--folder=<userfolder>] --gid=<filegroupid>
 
−
 
 
−
Baut den Volltextindex der mit <filegroupid> angegebenen Dateigruppe neu auf. Ist <userfolder> angegeben wird der Index nur für dieses Benutzerarchiv neu aufgebaut.
 
  
 
   import-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--user=<username>] [--[property]="value"]
 
   import-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--user=<username>] [--[property]="value"]
Zeile 121: Zeile 115:
 
Führt das Archivierungsprofil aus. Folgende Parameter werden unterstützt:
 
Führt das Archivierungsprofil aus. Folgende Parameter werden unterstützt:
  
−
{| width=80% |
+
{| width=100% |
 
|-
 
|-
 
| scope="col" width="20%" | <code>--name</code> <nowiki>|</nowiki> <code>--id</code>
 
| scope="col" width="20%" | <code>--name</code> <nowiki>|</nowiki> <code>--id</code>
Zeile 133: Zeile 127:
 
|-
 
|-
 
| <code>--[property]</code>
 
| <code>--[property]</code>
−
| Überschreibt die angegebene interne Property eines Profils. Die internen Properties lassen sich anzeigen, in dem man ein Archivierungsprofil aus der Liste auswählt und die Tastenkombination STRG + SHIFT + P drückt. Der Name der Property muss in eckigen Klammern geschrieben werden. Es können beliebig viele Properties angegeben werden.
+
| Überschreibt die angegebene interne Property eines Profils. Die internen Properties lassen sich anzeigen, in dem man ein Archivierungsprofil aus der Liste auswählt und die Tastenkombination <code>STRG + SHIFT + P</code> drückt. Der Name der Property muss in eckigen Klammern geschrieben werden. Es können beliebig viele Properties angegeben werden.
 
|}
 
|}
  
Zeile 140: Zeile 134:
 
Zeigt alle erstellten Archivierungsprofil an (ID und Name des Profils).
 
Zeigt alle erstellten Archivierungsprofil an (ID und Name des Profils).
  
−
   maintain-db [--gid=<filegroupid>] --command=[backup-restore|sweep]
+
   livelog-client-disable,  livelog-client-enable,  livelog-server-disable,  livelog-server-enable
  
−
Im Kapitel [[Wartung und Reparatur]] finden Sie weitere Informationen zu diesem Befehl.
+
Aktiviert oder deaktiviert das Echtzeitprotokoll für MailStore Server bzw. MailStore Client. Das Protokoll kann u.A. mit Sysinterals DebugView betrachtet werden. DebugView muss mit Administratorrechten ausgeführt werden, weiterhin müssen ''Global Win 32'' Ereignisse erfasst werden.
  
−
   process-info
+
   store-setprop --name=<name> --value=true/false
  
−
Dieser Befehl gibt Informationen zum MailStore-Windows-Prozess aus.
+
Ändert eine globale Einstellung
  
−
  rpc-info
+
{| width=100% |
 +
|-
 +
| scope="col" width="20%" | <code>--name</code>
 +
| Name der zu ändernden globalen Einstellung
 +
|-
 +
| <code>--value</code>
 +
| Wert der globalen Einstellung
 +
|}
  
−
Dieser Befehl gibt Informationen zur Verbindung mit dem MailStore-Server-Prozess aus.
+
Folgende globale Einstellungen werden unterstützt:
  
−
  session-logout
+
{| width="100%" border="0" cellpadding="0" cellspacing="0"
 +
|-
 +
! scope="col" width="20%" bgcolor="#cccccc" | Name
 +
! scope="col" bgcolor="#cccccc" | Version
 +
! scope="col" bgcolor="#cccccc" | Werte
 +
! scope="col" bgcolor="#cccccc" | Standardwert
 +
|-
 +
| scope="col" width="20%" align="left" valign="top" | public.arcclient.skipMimeContentConversionFailed
 +
| align="center" valign="top" | 8
 +
| ''true'' = Exchange ''MimeContentConversionFailed''-Fehler werden ignoriert und nicht als Fehler bei der Archivierung angesehen.<br/><br/>
 +
''false'' = Exchange ''MimeContentConversionFailed''-Fehler werden als Fehler bei der Archivierung angesehen.
 +
| align="center" valign="top" | false
 +
|-
 +
| scope="col" width="20%" align="left" valign="top" | public.arcclient.skipVirusDetected
 +
| align="center" valign="top" | 8.1
 +
| ''true'' = Exchange ''ErrorVirusDetected''-Fehler werden ignoriert und nicht als Fehler bei der Archivierung angesehen.<br/><br/>
 +
''false'' = Exchange ''ErrorVirusDetected''-Fehler werden als Fehler bei der Archivierung angesehen.
 +
| align="center" valign="top" | false
 +
|-
 +
| scope="col" width="20%" align="left" valign="top" | public.arcclient.skipEwsErrorItemNotFound
 +
| align="center" valign="top" | 10
 +
| ''true'' = Exchange ''ErrorItemNotFound''-Fehler werden ignoriert und nicht als Fehler bei der Archivierung angesehen.<br/><br/>
 +
''false'' = Exchange ''ErrorItemNotFound''-Fehler werden als Fehler bei der Archivierung angesehen.
 +
| align="center" valign="top" | false
 +
|-
 +
| scope="col" width="20%" align="left" valign="top" | public.backup.hideNotDetectedWarningMessage
 +
| align="center" valign="top" | 11
 +
| ''true'' = Backup Warnungen werden nicht auf dem Dashboard angezeigt.<br/><br/>
 +
''false'' = Backup Warnungen werden auf dem Dashboard angezeigt.
 +
| align="center" valign="top" | false
 +
|}
  
 +
  user-list
  
−
  statistics-refresh
+
Zeigt eine Liste aller MailStore Benutzer an.
−
 
 
−
Berechnet alle Statistiken neu.
 
−
 
 
−
  store-getprop --name=<propertyname>
 
−
 
 
−
  store-setprop --name=<propertyname> [--value=<value>]
 
−
 
 
−
 
 
−
  user-add --name=<username> --pwd=<password>
 
−
 
 
−
Füge einen neuen MailStore-integrierten Benutzer hinzu und setzte das Passwort.
 
−
 
 
−
  user-info [--name=<username>]
 
−
 
 
−
Gibt Informationen über den derzeit angemeldeten Benutzer aus. Ist --name angegeben werden Informationen über den Benutzer <username> ausgegeben.
 
  
−
  user-list
+
=== Server-seitige Befehle ===
  
−
Zeigt die Liste alle Benutzer an.
+
Eine Übersicht der Server-seitigen Befehle finden Sie unter [[Administration API - Function Reference|Function Reference]] (englisch).  
  
−
  user-set-folder-access [--name=<username>] --folder=<folder> [--access=rwd]
+
Die Parameter der Server-seitigen Befehle sind case sensitive und müssen in der Management Shell mit zwei Bindestrichen (--) angegeben werde. Boolesche Variablen müssen als ''true'' oder ''false'' angegeben werden. Zeichenketten, die Leerzeichen enthalten, müssen in Anführungszeichen gesetzt werden.
  
−
Setze Zugriffsberechtigungen für den Benutzer <username> auf den Ordner <folder>. Der Parameter --access kann einen oder eine Kombination aus folgenden Werten annehmen: Lesen (r), Schreiben (w) and Löschen (d).
+
'''Beispiele:'''
  
−
  user-set-password [--name=<username>] --pwd=<password>
+
GetProfiles --raw=true
 +
Listet alle Archivierungs- und Exportprofile auf.
  
−
Setzt das Passwort für Benutzer <username> auf <password>.
+
GetUserInfo --userName="alexis.page"
 +
Listet die Eigenschaften der Benutzerin ''alexis.page'' auf.
  
−
  user-set-rights [--name=<username>] [--rights=alcimend]
+
GetJobResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneId="$Local" --jobId=1
 +
Listet die Ergebnisse des Jobs mit der ID 1 aus dem Jahr 2018 auf.
  
−
Setze Richte für Benutzer <username>. Der Parameter --rights kann einen oder eine Kombination der folgenden Werte annehmen:
+
GetWorkerResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneID="$Local" --profileID=1
 +
Listet die Ergebnisse des Archivierungsprofiles mit der ID 1 aus dem Jahr 2018 auf. Der Parameter ''timeZoneID'' wird nur beim Befehl ''GetWorkerResults'' mit großem ''D'' geschrieben.
  
−
{| width=80% |
+
RunProfile --id=1
−
|-
+
Startet das Archivierungs- oder Exportprofile mit der ID 1.
−
| <code>a</code>
 
−
| Administrator (Vollzugriff)
 
−
|-
 
−
| <code>l</code>
 
−
| Anmelden
 
−
|-
 
−
| <code>c</code>
 
−
| Passwort ändern
 
−
|-
 
−
| <code>i</code>
 
−
| Import Profil ausführen (E-Mails archivieren)
 
−
|-
 
−
| <code>m</code>
 
−
| Bestehenden Import-Profil bearbeiten
 
−
|-
 
−
| <code>e</code>
 
−
| Export Profile ausführen
 
−
|-
 
−
| <code>n</code>
 
−
| Bestehenden Export-Profil bearebeiten
 
−
|-
 
−
| <code>d</code>
 
−
| E-Mails löschen
 
−
|}
 
  
 +
[[de:MailStore_Server_Management_Shell]]
 
[[en:MailStore_Server_Management_Shell]]
 
[[en:MailStore_Server_Management_Shell]]

Version vom 17. März 2021, 14:08 Uhr

Viele Befehle des grafischen MailStore Clients lassen sich auch über die Management Shell durchführen, welche bei der Installation von MailStore Server und MailStore Client automatisch mitkopiert wird.

Die Management Shell ist einerseits dann nützlich, wenn keine grafische Umgebung zur Verfügung steht (z.B. bei Verwendung von telnet oder ssh), andererseits zur Einbindung in automatisch oder manuell gestartete Scripts (z.B. Batchdateien).

Neben den Client-seitigen Befehlen (Client-side Commands) stellt die Management Shell auch einen Zugriff auf die Server-seitigen Befehle (Server-side Commands) der MailStore Server Administration API bereit. Die Ausgabe der Server-seitigen Befehle erfolgt im JSON-Format.

Die Management Shell aus MailStore heraus starten

Sie können die Management Shell direkt aus MailStore heraus starten. Melden Sie sich dazu als MailStore-Administrator über den MailStore Client an und klicken Sie auf Verwaltung > Management API > Eingabeaufforderung.

Tech mscmd 01.png

Die Schriftgröße der Management Shell kann durch Halten der Strg-Taste und Drehen des Mausrads oder + und - auf der Tastatur angepasst werden. Halten der Strg-Taste und 0 setzt die Schriftgröße zurück.

MailStoreCmd.exe im nicht-interaktiven Modus verwenden

Im nicht-interaktiven Modus führt die Management Shell eine Anmeldung mit übergebenen Anmeldeinformationen durch, führt einen ebenfalls übergebenen Befehl aus und beendet sich daraufhin automatisch. Der Exit Code (ERRORLEVEL) des Prozesses wird auf 0 gesetzt, wenn Anmeldung und Befehl erfolgreich ausgeführt werden konnten, sonst auf einen Wert ungleich 0. Die MailStoreCmd.exe befindet sich im Installationsverzeichnis von MailStore Server. Die ebenfalls vorhandene MailStoreCmdSilent.exe macht dasselbe, öffnet jedoch kein sichtbares Kommandozeilenfenster.

Es gibt mehrere Möglichkeiten, Anmeldedaten an MailStoreCmd.exe zu übergeben.

Bei der Verwendung des Parameters cred, liest MailStoreCmd die Zugangsdaten aus der Windows-Anmeldeinformationsverwaltung. Diese Methode verhindert, dass Zugangsdaten einfach von Dritten eingesehen werden können. Die Anmeldedaten können dann wie folgt verwendet werden: 

 MailStoreCmd.exe --h=<server> --cred=<user>@<server/IP-Adresse> --pkv3=<thumbprint> -c  <command> [--param1=<value> --param2=<value> ...]

Die passenden Werte für die Parameter cred und pkv3 erhalten Sie, wenn Sie ein Archivierungsprofil aus der Rubrik E-Mail-Programme oder E-Mail-Dateien erstellen. Dieses Profil muss nicht funktional sein. Dann klicken Sie mit der rechten Maustaste auf das Archivierungsprofil und wählen Task erstellen auf <COMPUTERNAME> und anschließend auf Cmd kopieren. Dadurch legt der MailStore Client die Zugangsdaten des angemeldeten Benutzers in der Windows-Anmeldeinformationsverwaltung und das MailStore Kommando für diese Aufgabe in der Zwischenablage ab.

Wenn Sie sich nun den Inhalt der Zwischenablage anzeigen lassen, sehen Sie die Werte für cred und pkv3. Falls pkv3 nicht gesetzt sein sollte, wird dem Zertifikat auch ohne Angabe dieses Wertes vertraut und muss im nicht-interaktiven Modus nicht angegeben werden. Das temporär erzeugte Archivierungsprofil kann wieder gelöscht werden.

Die Zugangsdaten sind in der Windows-Anmeldeinformationsverwaltung unter Windows-Anmeldeinformationen > Generische Anmeldeinformationen > MailStore_E18FE535-FFFB-4079-A385-B1A6FC78E927_cmdline_<user@server> gespeichert und können dort gegebenenfalls wieder gelöscht werden.

Falls bereits einen geplanten Task für ein derartiges Profil auf diesem Computer existiert, können die Werde für cred und pkv3 diesem entnommen werden, ohne das ein temporäres Profil erstellt werden muss.

Die Anmeldedaten können auch im Klartext übergeben werden. 

MailStoreCmd.exe --h=<server> --u=<user> --p=<password> --pkv3=<thumbprint> -c  <command> [--param1=<value> --param2=<value> ...]

Im Folgenden werden die einzelnen Parameter beschrieben

Parameter Beschreibung
--h Der Rechnername des MailStore Server, mit welchem sich MailStoreCmd.exe verbinden soll.
--pkv3 Fingerabdruck (Public Key Fingerprint), der die Identität des MailStore Server sicherstellt.
--u Benutzername
--p Kennwort
--cred Alternative zu --u und --p, das Kennwort wird aus der Windows-Anmeldeinformationsverwaltung gelesen. Der Parameter ist in der Form <user>@<server/IP-Adresse> anzugeben.
--nologo Optional. Unterdrückt die Anzeige des Logos.
--o Optional. Leitet die Ausgabe in die angegebene Datei um. Es erscheint dann keine Ausgabe im Konsolenfenster.
-c Es folgt der tatsächliche Befehl.

Befehlsübersicht

Client-seitige Befehle

Im folgenden finden Sie eine Befehlsübersicht der Client-seitigen Befehle. 

 clear

Löscht die angezeigten Texte und erhöht so die Übersichtlichkeit 

 debug-conn

Aktiviert das Verbindungsprotokoll für IMAP und HTTP Verbindungen während der Archivierung für den aktuell laufenden MailStore Client Prozess. 

 debuglog-browse

Öffnet das Debug-Protokoll-Verzeichnis im Datei-Explorer. 

 debuglog-enable,  debuglog-disable

Aktiviert oder deaktiviert das globale (rechnerweite) Debugprotokoll. 

 export-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--[property]="value"]

Führt ein Export-Profil aus. Folgende Parameter werden unterstützt:

--name | --id Name oder ID des auszuführenden Profils
--verbose aktiviert eine detaillierte Statusausgabe auf der Konsole
--[property] Überschreibt die angegebene interne Property eines Profils. Die internen Properties lassen sich anzeigen, in dem man ein Exportsprofil aus der Liste auswählt und die Tastenkombination STRG + SHIFT + P drückt. Der Name der Property muss in eckigen Klammern geschrieben werden. Es können beliebig viele Properties angegeben werden. 
 export-list

Zeigt alle erstellten Exportprofile an (ID und Name des Profils). 

 help

Zeigt eine Liste aller verfügbaren Client- als auch Server-seitigen Befehle und deren Parameter 

 import-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--user=<username>] [--[property]="value"]

Führt das Archivierungsprofil aus. Folgende Parameter werden unterstützt:

--name | --id Name oder ID des auszuführenden Archivierungsprofils
--verbose ktiviert eine detaillierte Statusausgabe auf der Konsole
--user Benutzerarchiv in dem die archivierten E-Mails gespeichert werden
--[property] Überschreibt die angegebene interne Property eines Profils. Die internen Properties lassen sich anzeigen, in dem man ein Archivierungsprofil aus der Liste auswählt und die Tastenkombination STRG + SHIFT + P drückt. Der Name der Property muss in eckigen Klammern geschrieben werden. Es können beliebig viele Properties angegeben werden. 
 import-list [--user=<username>]

Zeigt alle erstellten Archivierungsprofil an (ID und Name des Profils). 

 livelog-client-disable,  livelog-client-enable,  livelog-server-disable,  livelog-server-enable

Aktiviert oder deaktiviert das Echtzeitprotokoll für MailStore Server bzw. MailStore Client. Das Protokoll kann u.A. mit Sysinterals DebugView betrachtet werden. DebugView muss mit Administratorrechten ausgeführt werden, weiterhin müssen Global Win 32 Ereignisse erfasst werden. 

 store-setprop --name=<name> --value=true/false

Ändert eine globale Einstellung

--name Name der zu ändernden globalen Einstellung
--value Wert der globalen Einstellung

Folgende globale Einstellungen werden unterstützt:

Name Version Werte Standardwert
public.arcclient.skipMimeContentConversionFailed 8 true = Exchange MimeContentConversionFailed-Fehler werden ignoriert und nicht als Fehler bei der Archivierung angesehen.

false = Exchange MimeContentConversionFailed-Fehler werden als Fehler bei der Archivierung angesehen.

false
public.arcclient.skipVirusDetected 8.1 true = Exchange ErrorVirusDetected-Fehler werden ignoriert und nicht als Fehler bei der Archivierung angesehen.

false = Exchange ErrorVirusDetected-Fehler werden als Fehler bei der Archivierung angesehen.

false
public.arcclient.skipEwsErrorItemNotFound 10 true = Exchange ErrorItemNotFound-Fehler werden ignoriert und nicht als Fehler bei der Archivierung angesehen.

false = Exchange ErrorItemNotFound-Fehler werden als Fehler bei der Archivierung angesehen.

false
public.backup.hideNotDetectedWarningMessage 11 true = Backup Warnungen werden nicht auf dem Dashboard angezeigt.

false = Backup Warnungen werden auf dem Dashboard angezeigt.

false 
 user-list

Zeigt eine Liste aller MailStore Benutzer an.

Server-seitige Befehle

Eine Übersicht der Server-seitigen Befehle finden Sie unter Function Reference (englisch).

Die Parameter der Server-seitigen Befehle sind case sensitive und müssen in der Management Shell mit zwei Bindestrichen (--) angegeben werde. Boolesche Variablen müssen als true oder false angegeben werden. Zeichenketten, die Leerzeichen enthalten, müssen in Anführungszeichen gesetzt werden.

Beispiele: 

GetProfiles --raw=true

Listet alle Archivierungs- und Exportprofile auf. 

GetUserInfo --userName="alexis.page"

Listet die Eigenschaften der Benutzerin alexis.page auf. 

GetJobResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneId="$Local" --jobId=1

Listet die Ergebnisse des Jobs mit der ID 1 aus dem Jahr 2018 auf. 

GetWorkerResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneID="$Local" --profileID=1

Listet die Ergebnisse des Archivierungsprofiles mit der ID 1 aus dem Jahr 2018 auf. Der Parameter timeZoneID wird nur beim Befehl GetWorkerResults mit großem D geschrieben. 

RunProfile --id=1

Startet das Archivierungs- oder Exportprofile mit der ID 1.

Abgerufen von „https://help.mailstore.com/de/server/index.php?title=MailStore_Server_Management_Shell&oldid=8476“