Altium On-Prem Enterprise Server のインストールのバックアップと復元

Enterprise Server Workspace には、定義済みのユーザー、グループ、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 設定を含む）。

• 上記のすべてのリビジョン。

• リポジトリおよび含まれる Workspace 設計。

• 検索インデックス。

• ユーザー定義（カスタム）設定。

バックアップの構文とスイッチ

ツールのバックアップ機能を使用する際に利用できるスイッチは次のとおりです:

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 Engineers との共有のために、より多くのログが作成されます。

• -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 Engineers との共有のために、より多くのログが作成されます。

• -c – 復元ポイント（現在の Enterprise Server インストールのバックアップ）用の対象 zip ファイルの圧縮レベルを指定できます。0 から 9 の数値を使用してください。次の値も使用できます:

  • Default – 圧縮レベル 6 と同等（このスイッチを指定しない場合に使用）

  • None – 圧縮レベル 0

  • BestSpeed と同等 – 圧縮レベル 1

  • BestCompression と同等 – 圧縮レベル 9 と同等。

• --split – このスイッチを指定すると、復元ポイント（現在の Enterprise Server インストールのバックアップ）について、その他のデータ用 zip ファイルに加えて、リポジトリおよびリビジョン用の個別 zip ファイル（無圧縮）が作成されます。

• --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

バックアップまたは復元中にエラーが発生した場合、その詳細情報もログファイル（）で確認できます。