Рабочее пространство Enterprise Server может содержать широкий спектр ценных данных, включая определённых пользователей, группы, задачи синхронизации LDAP, данные проектирования (включая проекты, компоненты, модели, шаблоны), а также конфигурации служб PLS и NIS (и, как правило, ряд приобретённых продуктов и расширений, а также определённые пакеты развертывания для последних). Ключевое требование для обеспечения долгосрочной целостности этих данных — создание резервных копий. Стандартная установка Enterprise Server включает инструмент резервного копирования и восстановления, доступный через командную строку.
Расположение инструмента резервного копирования по умолчанию — в папке \Program Files (x86)\Altium\Altium365\Tools\BackupTool.
Имя инструмента резервного копирования — avbackup.exe.
-
Если инструмент avbackup.exe не находится по пути по умолчанию — \Program Files (x86)\Altium\Altium365\Tools\BackupTool — при восстановлении могут возникать ошибки/исключения.
-
Отдельный инструмент standalone Health Monitor tool (avhealth.exe) must быть закрыт при использовании Backup Tool (как в режиме резервного копирования, так и в режиме восстановления), поскольку обоим инструментам требуется доступ к файлу базы данных Enterprise Server.
-
Настоятельно рекомендуется, чтобы пользователи не были подключены к Workspace и не работали в нём во время процессов резервного копирования и восстановления, которым требуется доступ к базе данных Workspace. Как администратор Workspace, при необходимости вы можете принудительно разлогинить пользователей, завершив их текущую сессию Workspace на странице Sessions в интерфейсе браузера (Admin – Sessions). Дополнительные сведения см. на странице Sessions page.
-
Восстановление из резервной копии возможно только в ту же версию Enterprise Server, из которой эта резервная копия была сделана. В этом отношении может быть хорошей идеей хранить установщик этого Enterprise Server и соответствующие файлы лицензии вместе с Zip-архивом резервной копии.
Инструмент резервного копирования использует службу Volume Shadow Copy Service (VSS) для создания теневой копии тома, на котором расположены данные сервера (также поддерживается конфигурация, когда ревизии хранятся на отдельном томе). При использовании VSS инструмент резервного копирования останавливает службы, создаёт теневую копию, запускает службы, а затем выполняет резервное копирование данных, используя созданную теневую копию. Такой подход минимизирует время простоя сервера (период между остановкой и запуском служб) и используется по умолчанию. В случае ошибки при создании теневой копии инструмент резервного копирования будет использовать подход без создания теневой копии (его также можно включить явно с помощью переключателя --skip-shadow-copy).
Доступ к Backup Tool
Чтобы использовать инструмент:
-
Запустите командную строку Windows.
Командную строку необходимо запускать в режиме администратора, чтобы иметь возможность использовать инструмент резервного копирования и восстановления. Если вы запускаете CMD не от имени администратора Windows, попытка выполнить команду резервного копирования или восстановления Enterprise Server приведёт к появлению понятного сообщения: Access Denied. Administrator permissions are needed to use the selected options. Use an administrator command prompt to complete these tasks.
-
Перейдите в нужную папку. Для установки по умолчанию на диске C хост-компьютера это будет: cd C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\
-
Чтобы запустить инструмент и вывести список доступных параметров, введите в командной строке: avbackup ?
В некоторых версиях Windows невозможно вставлять в командную строку с помощью Ctrl+V, но можно вставить через меню правой кнопки мыши. Сначала скопируйте нужные строки, затем вставьте этим способом, чтобы сэкономить время и избежать ошибок.
Доступ к инструменту резервного копирования через командную строку (запущенную от имени администратора).
Обратите внимание на ?: при его добавлении отображается справка по функциям, доступным в инструменте резервного копирования:
-
backup – резервное копирование данных в ZIP-архив.
-
restore – восстановление данных из ZIP-архива. Точка восстановления будет создана автоматически.
-
help – отображение экрана справки (? можно использовать вместо строки help).
Содержимое Zip-архива
Инструмент выполняет резервное копирование всего Enterprise Server и пользовательских данных, включая:
-
Полную резервную копию базы данных, включая: все элементы данных (модели, компоненты, управляемые листы, шаблоны, выпущенные проекты и т. д.), пользователей, группы, установки, полученные через Network Installation Service, и настройки синхронизации LDAP.
-
Все ревизии перечисленного выше.
-
Репозитории и включённые проекты Workspace.
-
Индекс поиска.
-
Пользовательские (кастомные) настройки.
Синтаксис резервного копирования и переключатели
Следующие переключатели доступны при использовании функции резервного копирования инструмента:
avbackup backup -z [-t] [-h] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – путь и имя файла целевого zip-файла, который нужно создать. Если в строке есть пробелы, заключите её в кавычки. Этот переключатель обязателен.
-
-t, --test – если указан этот переключатель, zip-файл будет проверен после резервного копирования.
-
-h, --hash – если указан этот переключатель, будет создан файл хэша MD5 (*.md5).
-
-i – полный путь к файлу LocalVault.ini Enterprise Server, который содержит информацию о расположении данных для резервного копирования Enterprise Server. Путь по умолчанию к этому файлу: C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Если этот переключатель не указан, инструмент попытается найти файл автоматически, исходя из расположения установки по умолчанию. Если в строке есть пробелы, заключите её в кавычки.
-
-m – позволяет определить, должна ли операция резервного копирования выполняться в тихом режиме (-m silent, режим по умолчанию) или должно появляться диалоговое окно с предложением повторить попытку в случае сбоя (-m dialog). Если этот переключатель не указан, будет использован тихий режим.
-
-d, --debug – если указан этот переключатель, будет использован режим отладки, который позволит создавать больше журналов для диагностики и для передачи инженерам Altium.
-
-c – позволяет задать уровень сжатия целевого zip-файла. Используйте число от 0 до 9. Также можно использовать следующие значения:
-
Default – соответствует уровню сжатия 6 (используется, если этот переключатель не указан)
-
None – соответствует уровню сжатия 0
-
BestSpeed – соответствует уровню сжатия 1
-
BestCompression – соответствует уровню сжатия 9.
-
--split – если указан этот переключатель, будут созданы отдельные zip-файлы для репозиториев и ревизий (без сжатия) в дополнение к zip-файлу для остальных данных.
-
--skip-shadow-copy – если указан этот переключатель, теневая копия создаваться не будет. Обратите внимание: при использовании этого переключателя увеличивается время простоя сервера (период между остановкой и запуском служб).
Если ввести только avbackup backup, эти переключатели будут выведены списком в качестве полезной подсказки.
Переключатели, доступные при использовании инструмента в режиме резервного копирования.
Backup Example
Следующая команда в тихом режиме выполнит резервное копирование Enterprise Server в файл с именем 02102024_Backup.zip, записав файл в папку 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"
Все указанные папки должны уже существовать. Кроме того, существующие файлы будут перезаписаны, если новый файл имеет то же имя, что и существующий файл.
Результат выполнения примерной команды резервного копирования.
Синтаксис восстановления и переключатели
Следующие переключатели доступны при использовании функции восстановления инструмента:
avbackup restore -z [--skip-backup] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – путь и имя файла zip-архива резервной копии, из которого нужно восстановить. Если в строке есть пробелы, заключите её в кавычки. Этот переключатель обязателен.
-
--skip-backup – позволяет пропустить создание точки восстановления перед началом восстановления Enterprise Server. Используйте с осторожностью, поскольку при сбое восстановления данных откат будет невозможен.
-
-i – полный путь к файлу LocalVault.ini Enterprise Server, который содержит информацию о расположениях, в которые нужно восстановить данные Enterprise Server. Путь по умолчанию к этому файлу: C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Если этот переключатель не указан, инструмент попытается найти файл автоматически, исходя из расположения установки по умолчанию. Если в строке есть пробелы, заключите её в кавычки.
-
-m – позволяет определить, должна ли операция восстановления выполняться в тихом режиме (-m silent, режим по умолчанию) или должно появляться диалоговое окно с предложением повторить попытку в случае сбоя (-m dialog). Если этот переключатель не указан, будет использован тихий режим.
-
-d, --debug – если указан этот переключатель, будет использован режим отладки, который позволит создавать больше журналов для диагностики и для передачи инженерам Altium.
-
-c – позволяет задать уровень сжатия целевого zip-файла для точки восстановления (резервной копии текущей установки Enterprise Server). Используйте число от 0 до 9. Также можно использовать следующие значения:
-
Default – соответствует уровню сжатия 6 (используется, если этот переключатель не указан)
-
None – соответствует уровню сжатия 0
-
BestSpeed – соответствует уровню сжатия 1
-
BestCompression – соответствует уровню сжатия 9.
-
--split – если указан этот переключатель, будут созданы отдельные zip-файлы для репозиториев и ревизий (без сжатия) в дополнение к zip-файлу для остальных данных — для точки восстановления (резервной копии текущей установки Enterprise Server).
-
--skip-shadow-copy – если указан этот переключатель, теневая копия не будет создаваться для точки восстановления (резервной копии текущей установки Enterprise Server). Обратите внимание: при использовании этого переключателя увеличивается время простоя сервера (период между остановкой и запуском служб).
Если ввести только avbackup restore, эти переключатели будут выведены списком в качестве полезной подсказки.
Переключатели, доступные при использовании инструмента в режиме восстановления.
Если для ZIP-файла резервной копии, из которого выполняется восстановление, существует hash-файл *.md5 (файл *.md5 находится в той же папке, что и ZIP, и назван по имени ZIP-файла, т. е. <ZipFileName>.zip.md5), перед восстановлением будет выполнена проверка его хэша.
Restore Example
Следующая запись выполнит «тихое» восстановление Enterprise Server с использованием ZIP-файла резервной копии с именем 30082022_Backup.zip, который хранится в папке C:\Backups\Altium Enterprise Server\:
avbackup restore -z "C:\Backups\Altium Enterprise Server\30082022_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium365\LocalVault.ini"
Результат выполнения примера команды восстановления. Обратите внимание, что инструмент сначала создаёт точку восстановления (резервную копию текущей установки Enterprise Server), а затем выполняет восстановление.
Точка восстановления
Инструмент резервного копирования автоматически создаёт точку восстановления перед началом восстановления Enterprise Server (если для восстановления не использовался --skip-backup ). Для этого инструмент резервного копирования выполняет резервное копирование существующего Enterprise Server и копирует ZIP восстановления в следующее расположение:
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\Backups\
ZIP именуется в формате: Backup_<Date>_<Time>.zip.
Ошибки при резервном копировании или восстановлении
Ошибки, возникающие при резервном копировании или восстановлении, отображаются непосредственно в окне CMD вместе с полной информацией о пути к журналу ошибок:
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\errors.log
При резервном копировании или восстановлении Enterprise Server сведения о любых ошибках, а также полный путь к файлу errors.log, отображаются непосредственно в окне CMD.
Локализовано с помощью ИИ