备份与恢复您的 Altium On-Prem Enterprise Server 安装

Enterprise Server 工作区可以包含范围广泛的宝贵数据，包括已定义的用户、组、LDAP Sync 任务、设计数据（包括项目、元件、模型、模板），以及 PLS 和 NIS 服务的配置（并且通常还包括一系列已获取的产品与扩展，以及为后者定义的部署包）。确保这些数据长期完整性的一个关键要求，就是对其进行备份。标准的 Enterprise Server 安装包含一个备份与还原工具，可通过命令提示符访问。

备份工具的默认位置在文件夹 \Program Files (x86)\Altium\Altium365\Tools\BackupTool 中。

备份工具的名称是 avbackup.exe。

访问备份工具

要使用该工具：

1. 启动 Windows 命令提示符。

   你必须以管理员模式运行命令提示符，才能使用备份与还原工具。如果未以 Windows 管理员身份运行 CMD 提示符，尝试执行与备份或还原 Enterprise Server 相关的命令时，将会收到明确提示信息：Access Denied. Administrator permissions are needed to use the selected options. Use an administrator command prompt to complete these tasks。

2. 导航到正确的文件夹。对于在主机计算机 C 盘上的默认安装，路径为：cd C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\

3. 要运行该工具并列出可用选项，请在提示符下输入：avbackup ?

通过命令提示符（以管理员身份运行）访问备份工具。

注意 ?，包含它将显示备份工具中可用功能的帮助信息：

• backup – 将数据备份到 ZIP 归档。

• restore – 从 ZIP 归档还原数据。将自动创建还原点。

• help – 显示帮助屏幕（可使用 ? 替代字符串 help）。

Zip 归档的内容

该工具会备份整个 Enterprise Server 和用户数据，包括：

• 完整数据库备份，包括：所有数据项（模型、元件、受管原理图、模板、已发布设计等）、用户、组、通过 Network Installation Service 获取的安装项，以及 LDAP Sync 设置。

• 上述所有内容的全部修订版本。

• 存储库以及其中包含的工作区设计。

• 搜索索引。

• 用户自定义设置。

备份语法与开关

使用该工具的备份功能时，可用以下开关：

avbackup backup -z [-t] [-h] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]

• -z – 要创建的目标 zip 文件的路径和文件名。如果字符串中包含空格，请用引号括起来。此开关为必需项。

• -t, --test – 如果指定此开关，备份完成后将测试该 zip 文件。

• -h, --hash – 如果指定此开关，将创建 MD5 哈希文件（*.md5）。

• -i – Enterprise Server 的 LocalVault.ini 文件的完整路径，该文件提供要备份的 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，即可列出这些开关作为帮助提示。

在备份模式下使用该工具时可用的开关。

还原语法与开关

使用该工具的还原功能时，可用以下开关：

avbackup restore -z [--skip-backup] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]

• -z – 要从中还原的备份 zip 文件的路径和文件名。如果字符串中包含空格，请用引号括起来。此开关为必需项。

• --skip-backup – 允许你在开始还原 Enterprise Server 之前跳过创建还原点。请谨慎使用，因为如果数据还原失败，将无法回滚。

• -i – Enterprise Server 的 LocalVault.ini 文件的完整路径，该文件提供要将 Enterprise Server 数据还原到哪些位置的信息。该文件的默认路径为 C:\Program Files (x86)\Altium\Altium365\LocalVault.ini。如果未指定此开关，工具将基于该默认安装位置尝试自动查找该文件。如果字符串中包含空格，请用引号括起来。

• -m – 用于确定还原操作应以静默方式运行（-m silent，默认模式），还是在失败时弹出对话框询问是否重试（-m dialog）。如果未指定此开关，将使用静默模式。

• -d, --debug – 如果指定此开关，将使用调试模式，从而生成更多日志用于诊断以及与 Altium 工程师共享。

• -c – 允许你为还原点（当前 Enterprise Server 安装的备份）的目标 zip 文件指定压缩级别。使用从 0 到 9 的数字。你也可以使用以下值：

  • Default – 等同于压缩级别 6 （未指定此开关时使用）

  • None – 等同于压缩级别 0

  • BestSpeed – 等同于压缩级别 1

  • BestCompression – 等同于压缩级别 9。

• --split – 如果指定此开关，将为存储库和修订版本分别创建单独的 zip 文件（不压缩），此外还会为其他数据创建一个 zip 文件，用于还原点（当前 Enterprise Server 安装的备份）。

• --skip-shadow-copy–  如果指定此开关，将不会为还原点创建影子副本（即当前 Enterprise Server 安装的备份）。 请注意，使用此开关会增加服务器停机时间（停止服务与启动服务之间的时间段）。

只需输入 avbackup restore，即可列出这些开关以供参考。

在以还原模式使用该工具时可用的开关。

还原点

备份工具会在开始还原 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\avbackup.log

如果在备份或还原过程中发生错误，相关的完整信息也可以在日志文件（）中找到。