Ein Enterprise Server Workspace kann eine große Bandbreite wertvoller Daten enthalten, darunter definierte Benutzer, Gruppen, LDAP-Sync-Aufgaben, Designdaten (einschließlich Projekten, Komponenten, Modellen und Vorlagen) sowie Konfigurationen für PLS- und NIS-Services (und typischerweise auch eine Reihe erworbener Produkte und Erweiterungen sowie definierte Deployment-Pakete für Letztere). Eine wesentliche Voraussetzung, um die langfristige Integrität dieser Daten sicherzustellen, ist deren Sicherung. Die Standardinstallation von Enterprise Server umfasst ein Backup- und Restore-Tool, auf das über eine Eingabeaufforderung zugegriffen wird.
Der Standardspeicherort des Backup-Tools befindet sich im Ordner \Program Files (x86)\Altium\Altium365\Tools\BackupTool.
Der Name des Backup-Tools lautet avbackup.exe.
-
Wenn sich das Tool avbackup.exe nicht im Standardpfad – \Program Files (x86)\Altium\Altium365\Tools\BackupTool – befindet, können während einer Wiederherstellung Fehler/Ausnahmen auftreten.
-
Das standalone Health Monitor tool (avhealth.exe) muss bei der Verwendung des Backup-Tools (sowohl im Backup- als auch im Restore-Modus) geschlossen sein, da beide Tools Zugriff auf die Datenbankdatei des Enterprise Server benötigen.
-
Es wird dringend empfohlen, dass Benutzer während der Backup- und Restore-Vorgänge, die Zugriff auf die Datenbank des Workspace erfordern, nicht mit dem Workspace verbunden sind und ihn nicht verwenden. Als Workspace-Administrator können Sie Benutzer bei Bedarf zwangsweise abmelden, indem Sie ihre aktuelle Workspace-Sitzung über die Seite Sessions der Browseroberfläche (Admin – Sessions) beenden. Weitere Informationen finden Sie auf der Seite Sessions page.
-
Die Wiederherstellung eines Backups ist nur in dieselbe Version von Enterprise Server möglich, aus der dieses Backup erstellt wurde. In diesem Zusammenhang kann es sinnvoll sein, das Installationsprogramm für diesen Enterprise Server und die zugehörigen Lizenzdateien zusammen mit dem Backup-ZIP-Archiv aufzubewahren.
Das Backup-Tool verwendet den Volume Shadow Copy Service (VSS), um eine Schattenkopie des Volumes zu erstellen, auf dem sich die Serverdaten befinden (auch eine Konfiguration, bei der Revisionen auf einem separaten Volume gespeichert werden, wird unterstützt). Mit VSS stoppt das Backup-Tool die Services, erstellt eine Schattenkopie, startet die Services wieder und führt dann die Datensicherung mithilfe der erstellten Schattenkopie durch. Dieser Ansatz minimiert die Server-Ausfallzeit (den Zeitraum zwischen dem Stoppen und dem Starten der Services) und wird standardmäßig verwendet. Tritt beim Erstellen einer Schattenkopie ein Fehler auf, verwendet das Backup-Tool einen Ansatz ohne Erstellung einer Schattenkopie (dies kann auch explizit mit dem Schalter --skip-shadow-copy aktiviert werden).
Zugriff auf das Backup-Tool
So verwenden Sie das Tool:
-
Starten Sie eine Windows-Eingabeaufforderung.
Sie müssen die Eingabeaufforderung im Administratormodus ausführen, um das Backup- und Restore-Tool verwenden zu können. Wenn Sie keine CMD-Eingabeaufforderung als Windows-Administrator ausführen, führt der Versuch, einen Befehl zum Sichern oder Wiederherstellen Ihres Enterprise Server auszuführen, zu der eindeutigen Meldung: Access Denied. Administrator permissions are needed to use the selected options. Use an administrator command prompt to complete these tasks.
-
Navigieren Sie zum richtigen Ordner. Bei einer Standardinstallation auf dem Laufwerk C des Host-Computers ist dies: cd C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\
-
Um das Tool auszuführen und die verfügbaren Optionen aufzulisten, geben Sie an der Eingabeaufforderung Folgendes ein: avbackup ?
In einigen Windows-Versionen ist es nicht möglich, mit Ctrl+V in eine Eingabeaufforderung einzufügen, aber Sie können über das Rechtsklick-Menü einfügen. Kopieren Sie die erforderlichen Zeichenfolgen zuerst und fügen Sie sie dann mit dieser Technik ein, um Zeit zu sparen und Fehler zu vermeiden.

Zugriff auf das Backup-Tool über eine Eingabeaufforderung (als Administrator ausgeführt).
Beachten Sie ?; wenn dies eingeschlossen wird, wird Hilfe zu den im Backup-Tool verfügbaren Funktionen angezeigt:
-
backup – Daten in ein ZIP-Archiv sichern.
-
restore – Daten aus einem ZIP-Archiv wiederherstellen. Der Restore Point wird automatisch erstellt.
-
help – den Hilfebildschirm anzeigen (? kann anstelle der Zeichenfolge help verwendet werden).
Inhalt des ZIP-Archivs
Das Tool sichert den gesamten Enterprise Server und die Benutzerdaten, einschließlich:
-
Vollständige Datenbanksicherung, einschließlich: aller Daten-Items (Modelle, Komponenten, verwaltete Schaltpläne, Vorlagen, freigegebene Designs usw.), Benutzer, Gruppen, über den Network Installation Service erworbene Installationen und LDAP-Sync-Einstellungen.
-
Alle Revisionen des Vorstehenden.
-
Repositories und enthaltene Workspace-Designs.
-
Suchindex.
-
Benutzerdefinierte (Custom-)Einstellungen.
Backup-Syntax und Schalter
Die folgenden Schalter sind verfügbar, wenn die Backup-Funktion des Tools verwendet wird:
avbackup backup -z [-t] [-h] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – Pfad und Dateiname der zu erstellenden Ziel-ZIP-Datei. In Anführungszeichen setzen, wenn die Zeichenfolge Leerzeichen enthält. Dieser Schalter ist erforderlich.
-
-t, --test – wenn dieser Schalter angegeben wird, wird die ZIP-Datei nach dem Backup getestet.
-
-h, --hash – wenn dieser Schalter angegeben wird, wird eine MD5-Hash-Datei (*.md5) erstellt.
-
-i – vollständiger Pfad zur Datei LocalVault.ini des Enterprise Server, die Informationen zum Speicherort der zu sichernden Enterprise-Server-Daten bereitstellt. Der Standardpfad dieser Datei ist C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Wenn dieser Schalter nicht angegeben wird, versucht das Tool, die Datei automatisch anhand dieses Standardinstallationsorts zu finden. In Anführungszeichen setzen, wenn die Zeichenfolge Leerzeichen enthält.
-
-m – ermöglicht es Ihnen festzulegen, ob der Backup-Vorgang still ausgeführt werden soll (-m silent, der Standardmodus) oder ob im Fehlerfall ein Dialogfeld eingeblendet werden soll, das zum Wiederholen auffordert (-m dialog). Wenn dieser Schalter nicht angegeben wird, wird der stille Modus verwendet.
-
-d, --debug – wenn dieser Schalter angegeben wird, wird der Debug-Modus verwendet, wodurch mehr Protokolle zu Diagnosezwecken und zur Weitergabe an Altium Engineers erstellt werden.
-
-c – ermöglicht es Ihnen, die Komprimierungsstufe der Ziel-ZIP-Datei anzugeben. Verwenden Sie eine Zahl von 0 bis 9. Sie können auch die folgenden Werte verwenden:
-
Default – entspricht der Komprimierungsstufe 6 (wird verwendet, wenn dieser Schalter nicht angegeben wird)
-
None – entspricht der Komprimierungsstufe 0
-
BestSpeed – entspricht der Komprimierungsstufe 1
-
BestCompression – entspricht der Komprimierungsstufe 9.
-
--split – wenn dieser Schalter angegeben wird, werden zusätzlich zur ZIP-Datei für die übrigen Daten separate ZIP-Dateien für Repositories und Revisionen (ohne Komprimierung) erstellt.
-
--skip-shadow-copy – wenn dieser Schalter angegeben wird, wird keine Schattenkopie erstellt. Beachten Sie, dass sich die Server-Ausfallzeit (der Zeitraum zwischen dem Stoppen und dem Starten der Services) erhöht, wenn dieser Schalter verwendet wird.
Wenn Sie nur avbackup backup eingeben, werden diese Schalter als hilfreiche Übersicht aufgelistet.

Verfügbare Schalter bei Verwendung des Tools im Backup-Modus.
Backup Example
Der folgende Eintrag sichert den Enterprise Server still in die Datei mit dem Namen 02102024_Backup.zip und schreibt die Datei in den Ordner C:\Backups\Altium Enterprise Server\:
avbackup backup -z "C:\Backups\Altium Enterprise Server\02102024_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium365\LocalVault.ini"
Alle angegebenen Ordner müssen bereits vorhanden sein. Außerdem werden vorhandene Dateien überschrieben, wenn die neue Datei denselben Namen wie eine vorhandene Datei hat.

Das Ergebnis der Ausführung des Beispiel-Backup-Befehls.
Restore-Syntax und Schalter
Die folgenden Schalter sind verfügbar, wenn die Restore-Funktion des Tools verwendet wird:
avbackup restore -z [--skip-backup] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – Pfad und Dateiname der Backup-ZIP-Datei, aus der wiederhergestellt werden soll. In Anführungszeichen setzen, wenn die Zeichenfolge Leerzeichen enthält. Dieser Schalter ist erforderlich.
-
--skip-backup – ermöglicht es Ihnen, das Erstellen eines Restore Points vor Beginn der Wiederherstellung des Enterprise Server zu überspringen. Verwenden Sie dies mit Vorsicht, da bei einem Fehlschlagen der Datenwiederherstellung kein Rollback möglich ist.
-
-i – vollständiger Pfad zur Datei LocalVault.ini des Enterprise Server, die Informationen zu den Speicherorten bereitstellt, an denen die Enterprise-Server-Daten wiederhergestellt werden sollen. Der Standardpfad dieser Datei ist C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Wenn dieser Schalter nicht angegeben wird, versucht das Tool, die Datei automatisch anhand dieses Standardinstallationsorts zu finden. In Anführungszeichen setzen, wenn die Zeichenfolge Leerzeichen enthält.
-
-m – ermöglicht es Ihnen festzulegen, ob der Restore-Vorgang still ausgeführt werden soll (-m silent, der Standardmodus) oder ob im Fehlerfall ein Dialogfeld eingeblendet werden soll, das zum Wiederholen auffordert (-m dialog). Wenn dieser Schalter nicht angegeben wird, wird der stille Modus verwendet.
-
-d, --debug – wenn dieser Schalter angegeben wird, wird der Debug-Modus verwendet, wodurch mehr Protokolle zu Diagnosezwecken und zur Weitergabe an Altium Engineers erstellt werden.
-
-c – ermöglicht es Ihnen, die Komprimierungsstufe der Ziel-ZIP-Datei für den Restore Point (ein Backup der aktuellen Enterprise-Server-Installation) anzugeben. Verwenden Sie eine Zahl von 0 bis 9. Sie können auch die folgenden Werte verwenden:
-
Default – entspricht der Komprimierungsstufe 6 (wird verwendet, wenn dieser Schalter nicht angegeben wird)
-
None – entspricht der Komprimierungsstufe 0
-
BestSpeed – entspricht der Komprimierungsstufe 1
-
BestCompression – entspricht der Komprimierungsstufe 9.
-
--split – wenn dieser Schalter angegeben wird, werden zusätzlich zur ZIP-Datei für die übrigen Daten für den Restore Point (ein Backup der aktuellen Enterprise-Server-Installation) separate ZIP-Dateien für Repositories und Revisionen (ohne Komprimierung) erstellt.
-
--skip-shadow-copy – wenn dieser Schalter angegeben wird, wird für den Restore Point (ein Backup der aktuellen Enterprise-Server-Installation) keine Schattenkopie erstellt. Beachten Sie, dass sich die Server-Ausfallzeit (der Zeitraum zwischen dem Stoppen und dem Starten der Services) erhöht, wenn dieser Schalter verwendet wird.
Wenn Sie nur avbackup restore eingeben, werden diese Schalter als hilfreiche Übersicht aufgelistet.

Verfügbare Schalter bei Verwendung des Tools im Restore-Modus.
Wenn eine *.md5Hash-Datei für die Backup-ZIP-Datei vorhanden ist, aus der wiederhergestellt werden soll (die Datei *.md5 befindet sich im selben Ordner wie die ZIP-Datei und ist nach der ZIP-Datei benannt, d. h. <ZipFileName>.zip.md5), wird ihr Hash vor der Wiederherstellung geprüft.
Restore Example
Der folgende Eintrag stellt den Enterprise Server mithilfe der Backup-ZIP-Datei mit dem Namen 30082022_Backup.zip, die im Ordner C:\Backups\Altium Enterprise Server\ gespeichert ist, im Hintergrund wieder her:
avbackup restore -z "C:\Backups\Altium Enterprise Server\30082022_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium365\LocalVault.ini"

Das Ergebnis der Ausführung des Beispielbefehls zur Wiederherstellung. Beachten Sie, dass das Tool zunächst einen Wiederherstellungspunkt erstellt (ein Backup der aktuellen Enterprise-Server-Installation), bevor die Wiederherstellung durchgeführt wird.
Wiederherstellungspunkt
Das Backup-Tool erstellt automatisch einen Wiederherstellungspunkt, bevor mit der Wiederherstellung des Enterprise Server begonnen wird (wenn --skip-backup nicht für die Wiederherstellung verwendet wurde). Dazu führt das Backup-Tool eine Sicherung des vorhandenen Enterprise Server durch und kopiert die Wiederherstellungs-ZIP an den folgenden Speicherort:
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\Backups\
Die ZIP-Datei wird im folgenden Format benannt: Backup_<Date>_<Time>.zip.
Fehler während Backup oder Wiederherstellung
Fehler, die während eines Backups oder einer Wiederherstellung auftreten, werden direkt im CMD-Fenster zusammen mit vollständigen Pfadangaben zur Fehlerprotokolldatei angezeigt:
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\errors.log

Beim Sichern oder Wiederherstellen Ihres Enterprise Server werden Details zu allen Fehlern sowie der vollständige Pfad zur Datei errors.log direkt im CMD-Fenster angezeigt.