Backing up & Restoring Your Installation of Altium On-Prem Enterprise Server

Enterprise Server Workspace には、定義されたユーザー、グループ、LDAP同期タスク、設計データ（プロジェクト、コンポーネント、モデル、テンプレートを含む）、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同期設定。

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

• リポジトリおよび含まれる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ファイルへのフルパス。このファイルのデフォルトパスは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 – 圧縮レベルに相当します。

• --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 – このスイッチが指定されている場合、リストアポイント（現在の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

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