Parent page: Altium NEXUS Server
Altium NEXUS Server には、定義済みのユーザー、ロール、LDAP Sync タスク、設計データ(プロジェクト、コンポーネント、モデル、テンプレートを含む)、および PLS/NIS サービスの構成(通常は取得済み製品や拡張機能の一式、さらに後者のために定義されたデプロイメントパッケージの範囲も含む)など、幅広い重要データを保持できます。これらのデータの長期的な完全性を確保するための重要な要件は、バックアップを取得することです。標準の Altium NEXUS Server インストールには、コマンドプロンプトからアクセスするバックアップ/復元ツールが含まれています。
バックアップツールの既定の場所は、フォルダー \Program Files (x86)\Altium\Altium NEXUS Server\Tools\BackupTool\ 内です。
バックアップツールの名前は avbackup.exe です。
- このツールを使用したバックアップ/復元は、バックエンドに Firebird データベースを使用している Altium NEXUS Server インストールでのみ、現在サポートされています。
-
standalone Health Monitor tool(avhealth.exe)は、バックアップツール(バックアップ/復元いずれのモードでも)使用時に閉じておく必要があります。両ツールともサーバーのデータベースファイルへのアクセスを必要とするためです。
-
バックアップ/復元プロセスではサーバーのデータベースへのアクセスが必要となるため、その間はユーザーがサーバーに接続して使用しないことを強く推奨します。サーバー管理者は、必要に応じてブラウザーインターフェースの Sessions ページ(Admin – Sessions)から、現在のサーバーセッションを切断してユーザーを強制ログアウトできます。詳細は Sessions page を参照してください。
- バックアップの復元は、そのバックアップを作成したサーバーと同じバージョンに対してのみ可能です。この点から、バックアップ Zip アーカイブと一緒に、そのサーバーのインストーラーおよび対応するライセンスファイルを保管しておくとよいでしょう。
バックアップツールへのアクセス
ツールを使用するには:
- Windows のコマンドプロンプトを起動します。
バックアップ/復元ツールを使用するには、コマンドプロンプトを管理者モードで実行する必要があります。Windows 管理者として CMD プロンプトを実行していない場合、Altium NEXUS 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\Altium NEXUS Server\Tools\BackupTool\
- ツールを実行して利用可能なオプションを一覧表示するには、プロンプトで次を入力します:
avbackup ?
Windows の一部バージョンでは、Ctrl+V を使用してコマンドプロンプトへ貼り付けできませんが、右クリックメニューから貼り付けできます。必要な文字列を先にコピーし、この方法で貼り付けることで、時間を節約し、ミスを防げます。
コマンドプロンプト(管理者として実行)からバックアップツールにアクセスします。
? に注意してください。これを含めると、バックアップツールで利用可能な機能のヘルプが表示されます:
backup – データを ZIP アーカイブにバックアップします。
restore – ZIP アーカイブからデータを復元します。復元ポイントは自動的に作成されます。
help – ヘルプ画面を表示します(文字列 help の代わりに ? を使用できます)。
Zip アーカイブの内容
このツールは、NEXUS Server とユーザーデータ全体をバックアップします。内容は次のとおりです:
- データベースの完全バックアップ(モデル、コンポーネント、管理シート、テンプレート、リリース済み設計などのすべてのデータアイテム、ユーザー、ロール、Network Installation Service 経由で取得したインストール、LDAP Sync 設定を含む)。
- 上記のすべてのリビジョン。
- リポジトリおよび含まれる管理設計。
- 検索インデックス。
- ユーザー定義(カスタム)設定。
バックアップの構文とスイッチ
ツールのバックアップ機能を使用する際に利用できるスイッチは次のとおりです:
avbackup backup -z [-i] [-m] [-d]
-z – 作成する対象 zip ファイルのパスとファイル名。文字列にスペースが含まれる場合は引用符で囲んでください。このスイッチは必須です。
-i – バックアップ対象の Altium NEXUS Server のデータ位置情報を提供する、サーバーの LocalVault.ini ファイルへのフルパス。このファイルの既定パスは C:\Program Files (x86)\Altium\Altium NEXUS Server\LocalVault.ini です。このスイッチを指定しない場合、ツールは既定のインストール場所に基づいて自動的にファイルを見つけようとします。文字列にスペースが含まれる場合は引用符で囲んでください。
-m – バックアップ操作をサイレント(-m silent:既定モード)で実行するか、失敗時に再試行を促すダイアログ(-m dialog)を表示するかを指定できます。このスイッチを指定しない場合、サイレントモードが使用されます。
- -d--debug – このスイッチを指定するとデバッグモードが使用され、診断目的および Altium Engineers との共有のために、より多くのログが作成されます。
avbackup backup のみを入力すると、これらのスイッチが一覧表示され、便利な補助となります。
ツールをバックアップモードで使用する際に利用可能なスイッチ。
Backup Example
次のエントリは、Altium NEXUS Server を 201912_Backup.zip という名前のファイルにサイレントでバックアップし、フォルダー C:\Backups\Altium NEXUS Server\ に書き込みます:
avbackup backup -z "C:\Backups\Altium NEXUS Server\201912_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium NEXUS Server\LocalVault.ini"
指定するフォルダーは事前に存在している必要があります。また、新しいファイル名が既存ファイルと同じ場合、既存ファイルは上書きされます。
例のバックアップコマンドを実行した結果。
復元の構文とスイッチ
ツールの復元機能を使用する際に利用できるスイッチは次のとおりです:
avbackup restore -z [-i] [-m] [-d]
-z – 復元元となるバックアップ zip ファイルのパスとファイル名。文字列にスペースが含まれる場合は引用符で囲んでください。このスイッチは必須です。
-i – Altium NEXUS Server データを復元する場所の情報を提供する、サーバーの LocalVault.ini ファイルへのフルパス。このファイルの既定パスは C:\Program Files (x86)\Altium\Altium NEXUS Server\LocalVault.ini です。このスイッチを指定しない場合、ツールは既定のインストール場所に基づいて自動的にファイルを見つけようとします。文字列にスペースが含まれる場合は引用符で囲んでください。
-m – 復元操作をサイレント(-m silent:既定モード)で実行するか、失敗時に再試行を促すダイアログ(-m dialog)を表示するかを指定できます。このスイッチを指定しない場合、サイレントモードが使用されます。
- -d--debug – このスイッチを指定するとデバッグモードが使用され、診断目的および Altium Engineers との共有のために、より多くのログが作成されます。
avbackup restore のみを入力すると、これらのスイッチが一覧表示され、便利な補助となります。
ツールを復元モードで使用する際に利用可能なスイッチ。
Restore Example
次のエントリは、フォルダー C:\Backups\Altium NEXUS Server\ に保存されている 201912_Backup.zip という名前のバックアップ zip ファイルを使用して、Altium NEXUS Server をサイレントで復元します:
avbackup restore -z "C:\Backups\Altium NEXUS Server\201912_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium NEXUS Server\LocalVault.ini"
例の復元コマンドを実行した結果。復元を実行する前に、ツールが最初に復元ポイント(現在の Altium NEXUS Server インストールのバックアップ)を作成している点に注意してください。
復元ポイント
バックアップツールは、NEXUS Server の復元を開始する前に自動的に復元ポイントを作成します。これを行うために、バックアップツールは既存の NEXUS Server のバックアップを実行し、復元 ZIP を次の場所にコピーします:
C:\Program Files (x86)\Altium\Altium NEXUS Server\Tools\BackupTool\Backups\
ZIP は次の形式で命名されます:Backup_<Date>_<Time>.zip。
バックアップまたは復元中のエラー
バックアップまたは復元中に発生したエラーは、CMD ウィンドウ内に直接表示され、エラーログへのフルパス情報も併せて示されます:
C:\Program Files (x86)\Altium\Altium NEXUS Server\Tools\BackupTool\errors.log
NEXUS Server のバックアップまたは復元を行う際、エラーの詳細および errors.log ファイルへのフルパスは、CMD ウィンドウに直接表示されます。