StoreFront構成のエクスポートとインポート
注:
ターゲットのStoreFrontインストールと同じStoreFrontバージョンの構成のみをインポートできます。
StoreFront展開の構成全体をエクスポートできます。これには、単一サーバー展開とサーバーグループ構成の両方が含まれます。インポート先のサーバーに既存の展開がすでに存在する場合、現在の構成は消去され、バックアップアーカイブに含まれる構成に置き換えられます。ターゲットサーバーがクリーンな工場出荷時のデフォルトインストールである場合、バックアップに保存されているインポートされた構成を使用して新しい展開が作成されます。エクスポートされた構成バックアップは、暗号化されていない場合は単一の.zipアーカイブ形式で、バックアップファイルの作成時に暗号化を選択した場合は.ctxzip形式になります。
構成のエクスポートとインポートが使用できるシナリオ
- 動作可能で信頼できる状態のStoreFront展開のみをバックアップします。構成に変更を加える場合は、古いバックアップを置き換えるために新しいバックアップを作成する必要があります。backup.zipファイルのファイルハッシュによって変更が防止されるため、既存のバックアップを変更することはできません。
- 災害復旧のためにStoreFrontをアップグレードする前にバックアップします。
- 既存のテスト用StoreFront展開をクローンして本番環境に移行します。
- 本番展開をテスト環境にクローンして、ユーザー受け入れ環境を作成します。
- ホスティングをWindows Server 2019からWindows 2022にアップグレードするなど、OS移行中にStoreFrontを移動します。インプレースOSアップグレードはサポートされていません。
- 複数のデータセンターを持つ大規模企業など、マルチジオ展開で追加のサーバーグループを構築します。
StoreFront構成のエクスポートとインポートに関する考慮事項
- 現在、Magic Word認証やサードパーティ認証のカスタマイズなど、Citrix®が公開している認証SDKの例を使用していますか。その場合、追加の認証方法を含む構成をインポートする前に、これらのパッケージをすべてのインポートサーバーにインストールする必要があります。必要な認証SDKパッケージがインポートサーバーのいずれにもインストールされていない場合、構成のインポートは失敗します。サーバーグループに構成をインポートする場合は、グループのすべてのメンバーに認証パッケージをインストールしてください。
- 構成バックアップを暗号化または復号化できます。エクスポートおよびインポートのPowerShellコマンドレットは、両方のユースケースをサポートしています。
- 暗号化されたバックアップ（.ctxzip）は後で復号化できますが、StoreFrontは暗号化されていないバックアップファイル（.zip）を再暗号化できません。暗号化されたバックアップが必要な場合は、選択したパスワードを含むPowerShell資格情報オブジェクトを使用してエクスポートを再度実行してください。
- StoreFrontが現在インストールされているIISのWebサイトのSiteID（エクスポート元サーバー）は、バックアップされたStoreFront構成を復元するIISのターゲットWebサイトのSiteID（インポート先サーバー）と一致する必要があります。
PowerShellコマンドレット
Export-STFConfiguration
| パラメーター | 説明 |
|---|---|
| -TargetFolder (文字列) | バックアップアーカイブのエクスポートパス。例: “$env:userprofile\desktop\” |
| -Credential (PSCredentialオブジェクト) | エクスポート中に暗号化された.ctxzipバックアップアーカイブを作成するための資格情報オブジェクトを指定します。PowerShell資格情報オブジェクトには、暗号化と復号化に使用するパスワードを含める必要があります。-Credentialを-NoEncryptionパラメーターと同時に使用しないでください。例: $CredObject |
| -NoEncryption (スイッチ) | バックアップアーカイブが暗号化されていない.zipであることを指定します。-NoEncryptionを-Credentialパラメーターと同時に使用しないでください。 |
| -ZipFileName (文字列) | StoreFront構成バックアップアーカイブの名前。 .zipや.ctxzipなどのファイル拡張子を追加しないでください。ファイル拡張子は、エクスポート中に-Credentialまたは-NoEncryptionパラメーターが指定されているかどうかに応じて自動的に追加されます。例: “backup” |
| -Force (ブール値) | このパラメーターは、指定されたエクスポート場所にすでに存在する既存のバックアップファイルと同じファイル名のバックアップアーカイブを自動的に上書きします。 |
重要:
StoreFront 3.5にあったSiteIDパラメーターは、バージョン3.6で非推奨になりました。バックアップアーカイブに含まれるSiteIDが常に使用されるため、インポート時にSiteIDを指定する必要はなくなりました。SiteIDが、インポートサーバーのIIS内にすでに構成されている既存のStoreFront Webサイトと一致していることを確認してください。SiteID 1からSiteID 2への構成インポートはサポートされていません。
Import-STFConfiguration
| パラメーター | 説明 |
|---|---|
| -ConfigurationZip (文字列) | インポートするバックアップアーカイブへのフルパス。ファイル拡張子も含まれている必要があります。暗号化されていない場合は.zip、暗号化されている場合は.ctxzipを使用します。例: $env:userprofile\desktop\backup.ctxzip
|
| -Credential (PSCredentialオブジェクト) | インポート中に暗号化されたバックアップを復号化するための資格情報オブジェクトを指定します。例: $CredObject
|
| -HostBaseURL (文字列) | このパラメーターが含まれている場合、エクスポート元サーバーのホストベースURLの代わりに、指定したホストベースURLが使用されます。例: https://<importingserver>.example.com
|
Unprotect-STFConfigurationBackup
| パラメーター | 説明 |
|---|---|
| -TargetFolder (文字列)
-Credential (PSCredentialオブジェクト) |
バックアップアーカイブのエクスポートパス。例: $env:userprofile\desktop
このパラメーターを使用して、暗号化されたバックアップアーカイブの暗号化されていないコピーを作成します。復号化に使用するパスワードを含むPowerShell資格情報オブジェクトを指定します。例: $CredObject
|
| -EncryptedConfigurationZip (文字列) | 復号化する暗号化されたバックアップアーカイブのフルパス。ファイル拡張子.ctxzipを指定する必要があります。例: $env:userprofile\\desktop\\backup.ctxzip
|
| -OutputFolder (文字列)
-Force (ブール値) |
暗号化された（.ctxzip）バックアップアーカイブの暗号化されていないコピー（.zip）を作成するパス。バックアップの元の暗号化されたコピーは再利用できるように保持されます。暗号化されていないコピーのファイル名とファイル拡張子を指定しないでください。例: $env:userprofile\desktop
このパラメーターは、指定されたエクスポート場所にすでに存在する既存のバックアップファイルと同じファイル名のバックアップアーカイブを自動的に上書きします。 |
構成のエクスポートとインポートの例
現在のPowerShellセッションへのStoreFrontコマンドレットのインポート
StoreFrontサーバーでPowerShell統合スクリプト環境（ISE）を開き、以下を実行します。
$env:PSModulePath = [Environment]::GetEnvironmentVariable('PSModulePath','Machine')
$SDKModules = 'C:\Program Files\Citrix\Receiver StoreFront\PowerShellSDK\Modules\Citrix.StoreFront'
Import-Module "$SDKModules\Citrix.StoreFront.psd1" -verbose
Import-Module "$SDKModules.Authentication\Citrix.StoreFront.Authentication.psd1" -verbose
Import-Module "$SDKModules.Roaming\Citrix.StoreFront.Roaming.psd1" -verbose
Import-Module "$SDKModules.Stores\Citrix.StoreFront.Stores.psd1" -verbose
Import-Module "$SDKModules.WebReceiver\Citrix.StoreFront.WebReceiver.psd1" -verbose
<!--NeedCopy-->
単一サーバーのシナリオ
サーバーA上の既存構成の暗号化されていないバックアップの作成と、同じ展開への復元
バックアップするサーバーの構成をエクスポートします。
Export-STFConfiguration -targetFolder "$env:userprofile\desktop\" -zipFileName "backup" -NoEncryption
<!--NeedCopy-->
backup.zipファイルを安全な場所にコピーします。このバックアップを使用して、災害復旧のためにサーバーを以前の状態に復元できます。
Import-STFConfiguration -configurationZip "$env:userprofile\desktop\backup.zip" -HostBaseURL "https://storefront.example.com"
<!--NeedCopy-->
サーバーA上の既存構成のバックアップと、サーバーBへの復元による既存サーバーのクローン作成
バックアップするサーバーの構成をエクスポートします。
Export-STFConfiguration -targetFolder "$env:userprofile\desktop\" -zipFileName "backup" -NoEncryption
<!--NeedCopy-->
backup.zipファイルをサーバーBのデスクトップにコピーします。
Import-STFConfiguration -configurationZip "$env:userprofile\desktop\backup.zip" -HostBaseURL "https://serverB.example.com"
<!--NeedCopy-->
IISのカスタムWebサイトにすでに展開されているStoreFrontの構成を、別のカスタムWebサイト展開に復元
サーバーAには、IIS内の通常のデフォルトWebサイトではなく、カスタムWebサイトの場所にStoreFrontが展開されています。IISで作成された2番目のWebサイトのIIS SiteIDは2です。StoreFront Webサイトの物理パスは、d:\などの非システムドライブ上、またはデフォルトのc:\システムドライブ上に配置できますが、IIS SiteIDは1より大きい値を使用する必要があります。
IIS内にSiteID = 2を使用するStoreFrontという新しいWebサイトが構成されています。StoreFrontはすでにIISのカスタムWebサイトに展開されており、その物理パスはドライブd:\inetpub\wwwroot上にあります。
- サーバーAの構成のコピーをエクスポートします。
- サーバーBで、SiteID 2も使用するStoreFrontという新しいWebサイトをIISで構成します。
-
サーバーAの構成をサーバーBにインポートします。バックアップに含まれるサイトIDが使用され、StoreFront構成をインポートするターゲットWebサイトと一致する必要があります。
Import-STFConfiguration -configurationZip "$env:userprofile\desktop\backup.ctxzip" -HostBaseURL "https://serverB.example.com" <!--NeedCopy-->
サーバーグループのシナリオ
シナリオ1: 既存のサーバーグループ構成のバックアップと、同じサーバーグループ展開への復元
以前の構成バックアップは、2012R2-Aと2012R2-Bの2台のStoreFrontサーバーのみがサーバーグループのメンバーであったときに取得されました。バックアップアーカイブには、バックアップ取得時のCitrixClusterMembershipの記録が含まれており、元の2台のサーバー2012R2-Aと2012R2-Bのみが含まれています。その後、ビジネス需要により、元のバックアップが取得されてからStoreFrontサーバーグループ展開のサイズが増加し、追加ノード2012R2-Cがサーバーグループに追加されました。バックアップに保持されているサーバーグループの基盤となるStoreFront構成は変更されていません。元の2台のサーバーグループノードのみを含む古いバックアップがインポートされた場合でも、3台のサーバーの現在のCitrixClusterMembershipを維持する必要があります。インポート中、現在のクラスターメンバーシップは保持され、構成がプライマリサーバーに正常にインポートされた後で書き戻されます。インポートは、元のバックアップが取得されてからサーバーグループノードがサーバーグループから削除された場合でも、現在のCitrixClusterMembershipを保持します。
-
サーバーグループ全体を管理するために使用されるプライマリサーバーである2012R2-Aから、サーバーグループ1の構成をエクスポートします。
-
その後、既存のサーバーグループに2012R2-Cという追加サーバーを追加します。
-
サーバーグループの構成は、既知の以前に動作していた状態に復元する必要があります。StoreFrontは、インポートプロセス中に3台のサーバーの現在のCitrixClusterMembershipをバックアップし、インポートが成功した後にそれを復元します。
-
サーバーグループ1の構成をノード2012R2-Aにインポートし直します。
Import-STFConfiguration -configurationZip "$env:userprofile\desktop\backup.ctxzip" -HostBaseURL "https://servergroup1.example.com" <!--NeedCopy--> -
新しくインポートされた構成をサーバーグループ全体に伝播し、インポート後にすべてのサーバーが整合性のある構成を持つようにします。
シナリオ2: サーバーグループ1の既存構成のバックアップと、別の工場出荷時設定のインストールでの新しいサーバーグループの作成。その後、新しいプライマリサーバーに他の新しいサーバーグループメンバーを追加
2台の新しいサーバー2012R2-Cと2012R2-Dを含むサーバーグループ2が作成されます。サーバーグループ2の構成は、2台のサーバー2012R2-Aと2012R2-Bも含む既存の展開であるサーバーグループ1の構成に基づきます。新しいサーバーグループを作成する場合、バックアップアーカイブに含まれるCitrixClusterMembershipは使用されません。現在のCitrixClusterMembershipは常にバックアップされ、インポートが成功した後に復元されます。インポートされた構成を使用して新しい展開を作成する場合、CitrixClusterMembershipセキュリティグループには、追加のサーバーが新しいグループに参加するまで、インポートサーバーのみが含まれます。サーバーグループ2は新しい展開であり、サーバーグループ1と共存することを意図しています。-HostBaseURLパラメーターを指定します。サーバーグループ2は、新しい工場出荷時のデフォルトのStoreFrontインストールを使用して作成されます。
-
サーバーグループ全体を管理するために使用されるプライマリサーバーである2012R2-Aから、サーバーグループ1の構成をエクスポートします。
-
新しく作成されたサーバーグループ2を管理するために使用されるプライマリサーバーとなるノード2012R2-Cの工場出荷時設定のインストールに、サーバーグループ1の構成をインポートします。
Import-STFConfiguration -configurationZip "$env:userprofile\desktop\backup.ctxzip" -HostBaseURL "https://servergroup2.example.com" <!--NeedCopy--> -
新しいサーバーグループ2展開の一部となる追加のサーバーを参加させます。新しいサーバーが追加される際の通常の参加プロセスの一部であるため、サーバーグループ1からサーバーグループ2のすべての新しいメンバーへの新しくインポートされた構成の伝播は自動的に行われます。
シナリオ3: サーバーグループAの既存構成のバックアップと、既存のサーバーグループB構成の上書きへの使用
サーバーグループ1とサーバーグループ2は、すでに2つの異なるデータセンターに存在します。サーバーグループ1で多くのStoreFront構成変更が行われており、これらを別のデータセンターのサーバーグループ2に適用する必要があります。サーバーグループ1からサーバーグループ2に変更を移植できます。サーバーグループ2のバックアップアーカイブ内のCitrixClusterMembershipは使用しないでください。サーバーグループ2のホストベースURLは、現在サーバーグループ1で使用されているのと同じFQDNに変更すべきではないため、インポート中に-HostBaseURLパラメーターを指定してください。サーバーグループ2は既存の展開です。
-
サーバーグループ全体を管理するために使用されるプライマリサーバーである2012R2-Aから、サーバーグループ1の構成をエクスポートします。
-
新しいサーバーグループ2のプライマリサーバーとなるノード2012R2-Cの工場出荷時設定のインストールに、サーバーグループ1の構成をインポートします。
Import-STFConfiguration -configurationZip "$env:userprofile\desktop\backup.zip" -NoEncryption -HostBaseURL "https://servergroup2.example.com" <!--NeedCopy-->
サーバー構成の暗号化されたバックアップの作成
PowerShell資格情報オブジェクトは、Windowsアカウントのユーザー名とパスワードの両方で構成されます。PowerShell資格情報オブジェクトは、パスワードがメモリ内で保護された状態を保つことを保証します。
注:
構成バックアップアーカイブを暗号化するには、暗号化と復号化を実行するためのパスワードのみが必要です。資格情報オブジェクト内に保存されているユーザー名は使用されません。エクスポートサーバーとインポートサーバーの両方で使用されるPowerShellセッション内で、同じパスワードを含む資格情報オブジェクトを作成する必要があります。資格情報オブジェクト内では、任意のユーザーを指定できます。
PowerShellでは、新しい資格情報オブジェクトを作成する際にユーザーを指定する必要があります。この例のコードは、便宜上、現在ログオンしているWindowsユーザーを取得します。
エクスポートサーバーのPowerShellセッション内にPowerShell資格情報オブジェクトを作成します。
$User = [System.Security.Principal.WindowsIdentity]::GetCurrent().Name
$Password = "Pa55w0rd"
$Password = $Password | ConvertTo-SecureString -asPlainText -Force
$CredObject = New-Object System.Management.Automation.PSCredential($User,$Password)
<!--NeedCopy-->
構成を暗号化されたzipファイルであるbackup.ctxzipにエクスポートします。
Export-STFConfiguration -targetFolder "$env:userprofile\desktop\" -zipFileName "backup" -Credential $CredObject
<!--NeedCopy-->
インポートサーバーのPowerShellセッション内に同一のPowerShell資格情報オブジェクトを作成します。
Import-STFConfiguration -configurationZip "$env:userprofile\desktop\backup.ctxzip" -Credential $CredObject -HostBaseURL "https://storefront.example.com"
<!--NeedCopy-->
既存の暗号化されたバックアップアーカイブの保護解除
$User = [System.Security.Principal.WindowsIdentity]::GetCurrent().Name
$Password = "Pa55w0rd"
$Password = $Password | ConvertTo-SecureString -asPlainText -Force
$CredObject = New-Object System.Management.Automation.PSCredential($User,$Password)
Unprotect-STFConfigurationExport -encryptedConfigurationZip "$env:userprofile\desktop\backup.ctxzip" -credential $CredObject -outputFolder "c:\StoreFrontBackups" -Force
<!--NeedCopy-->