概念実証ガイド:自動構成ツール
概要
自動構成ツールを使用すると、 Citrix DaaSへの構成の移行とエクスポートが容易になります。この概念実証ガイドでは、このツールの使用方法を段階的に説明しています。
管理者は、既存のオンプレミス環境を同時に実行しながら、 Citrix DaaS Sの機能と利点を簡単にテストおよび探索でき、クラウドリージョン間の移動、既存の構成のバックアップ、およびその他のユースケースを容易に実行することもできます。 自動構成のダウンロードリンクには 、 ******上記のユースケースとカスタマイズに関する追加情報と詳細なドキュメントも含まれています******。
前提条件
オンプレミス環境
- 少なくとも1つのVDAが登録されているCitrix Virtual Apps and Desktops(CVAD)オンプレミス環境。
- Citrix Virtual Apps and Desktopsオンプレミス環境は、最新のCU (1912、2203)を搭載した任意の長期サービスリリース(LTSR) バージョン、 または対応する最新の2つの最新リリース(CR)バージョンのいずれか(例:2308、2311) で実行されています。
- 自動構成ツールのコマンドを実行するドメイン参加マシンでは 、 .NET 4.7.2 以降が実行されている必要があります。
- DDCに自動的にインストールされるCitrix PowerShell SDKを搭載したマシン。
注:
ツールを別のマシンで実行する場合は、そのツールがドメインに参加している必要があり、 Studio には正しい PowerShell スナップインがインストールされている必要があります。このインストーラーは、 対応するバージョンの製品ISOインストールメディアにあります。このメディアは、 Citrix のダウンロード > Citrix Virtual Apps and Desktops のWebサイトから入手できます。
- 自動構成ツール (MSI) を公式ダウンロード Webサイトからダウンロードします。
クラウド関連のコンポーネント
注: クラウドサイト間を移行する場合 (クラウドからクラウドへの移行)、詳細な手順については、 公式ドキュメントを参照してください 。
- 有効なCitrix DaaS ライセンス。
- 管理者は Cloud Portal にログインして以下を取得できる必要があります。 リソースの場所名、 顧客 ID、 クライアントシークレット (アプリ IDとシークレットキー)
- 既存のCitrix Cloudリソースの場所には 、 少なくとも1つのCloud Connectorがあり、これは緑(正常)としてマークされ、オンプレミスセットアップと同じドメインの一部です。
注:
Citrixでは、(冗長性と高可用性のために) Cloud Connectorを2つ以上用意することを推奨しています 。Cloud Connectorの設定方法については、 このガイドを参照してください。
この概念実証ガイドでは、
- オンプレミスの前提条件を完了する
- オンプレミスのサイト設定を YAML (.yml) ファイルにエクスポートする
- クラウドの前提条件を完了する
- 異なるプロビジョニング方法 (プールカタログと静的カタログの両方にMachine Creation Services (MCS)) を使用する場合、サイト構成をインポートするための必要条件を満たします。
- サイト構成をクラウドにインポートする(必要なファイルを編集して)
- トラブルシューティングのヒントと詳細情報の入手先
オンプレミスサイトからエクスポートするための完全な前提条件
これらの手順は、DDC または自動構成ツールを実行するドメイン参加マシンで実行する必要があります 。
- 最新の自動構成ツール MSI を、 オンプレミス DDC またはドメイン参加マシンにダウンロードします。注: 別のマシンから実行する方法の詳細については、「 前提条件」セクションを参照してください 。 ツールはこちらからダウンロードできます。 注: 別のマシンから実行する方法の詳細については、「 前提条件」セクションを参照してください 。
- AutoConfig_PowerShell_x64.msi インストーラを右クリックし、[ インストール] をクリックして、 オンプレミス DDC で MSIを実行します。
- 使用許諾契約書を読み 、条件に同意する場合はチェックボックスをオンにします。次に、[ インストール: ] をクリックします
- MSIの実行後 、正常に完了したことを示すウィンドウがポップアップします。[ 完了 ] をクリックして MSI セットアップウィンドウを閉じます 。
-
注:実行が成功すると、 Auto Config というデスクトップアイコンが作成されます。起動すると、
C:\Users\<username>\Documents\Citrix\AutoConfig
にある対応するフォルダ構造が作成されます。このツールは、後続のステップで使用されるツールです。
オンプレミスのサイト構成をエクスポートする
export
PowerShell コマンドを使用して、既存のオンプレミス構成をエクスポートし、 必要な.yml ファイルを取得できます。これらのファイルは、 必要な構成をCitrix Cloudにインポートするために使用されます。
- 前の手順で MSI インストーラを実行すると、 デスクトップに自動構成ショートカットが自動的に作成されます 。このショートカットを右クリックし、[ 管理者として実行] をクリックします。
-
Export-CvadAcToFile
コマンドを実行します。このコマンドは、ポリシー、手動でプロビジョニングされたカタログ、およびデリバリーグループをエクスポートします。また、アプリケーション、アプリケーションフォルダ、アイコン、ゾーンマッピング、タグ、管理者ロールとスコープ、およびその他の項目もエクスポートします。注:MCSマシンカタログとデリバリーグループについては 、このガイドの「 異なるプロビジョニング方法を使用してサイト構成をインポートするための要件」セクションの手順を参照してください 。 -
ツールの実行が完了すると、[ 全体] ステータスが[ True ] と表示され、エクスポートプロセスが完了します (表示されている出力行は、次の図と一致します)。注: エラーがある場合は、アクション固有のサブフォルダ
(Export, Import, Merge, Restore, Sync, Backup, Compare)
に診断ファイルが作成されます。このサブフォルダは、%HOMEPATH%\Documents\Citrix\AutoConfig
にあります 。エラーが発生した場合は、「 トラブルシューティングのヒント」セクションを参照してください 。 - .yml ファイル (
Application.yml
) の内容の例については、以下の画像を参照してください。
注:
必要に応じて、 Citrix Cloud環境へ**の設定のインポートに使用するマシンに.ymlファイルをコピーします 。エクスポートとインポートは、同じマシンから実行できます。
クラウドの前提条件を完了する
リソースの場所に移動し 、 Cloud Connectorが両方とも緑色 (使用可能)になっていることを確認します。注:Cloud Connectorの設定方法に関する指示が必要な場合は、 このガイドを参照してください。
-
Cloud Connectorの正常性ステータスを確認するには、まずCitrix 管理者の認証情報(または、該当する場合はAzure AD 認証情報) を使用してクラウドポータルにログインします 。
注:
Cloud Connectorは 、次の図に示すように、正常状態を示す緑色で表示されている必要があります。冗長性を確保するために、 **リソースの場所ごとに複数のCloud Connector**をお勧めします。
さまざまなプロビジョニング方法を使用してサイト構成をインポートするための必要条件
Provisioning Services(PVS)マシンカタログ、デリバリー、アプリケーショングループおよびポリシーの対処
現時点では、 PVSカタログとそれに対応するアプリケーションをインポートするために追加の手順は必要ありません 。このガイドの「 サイト構成をクラウドにインポートする 」セクションに記載されている手順に従います。
マシン作成サービス (MCS) の対処:プールされたVDIマルチセッション (ランダム) およびRDSマシンカタログ
注:
静的に割り当てられた仮想マシンの手順については、別のセクションを参照してください。このガイドの「 MCS静的割り当てVDI 」セクションに記載されている手順を参照してください。
インポートコマンドとエクスポートコマンドがこのタスクでサポートされるようになりました。ゴールデンイメージと [ ユーザーデータを含むカタログ:破棄 ] の設定の両方を移行できます。ただし、インポート元のサイトが仮想マシンのライフサイクルを維持する責任があるため、これらのカタログ内の仮想マシンは移行されません。
マシンをオンにすると、その状態が変化し、仮想マシンの同期のインポートデータに影響することがあります。したがって、ツールを使用してこれらのカタログを移行すると、カタログメタデータが作成され、マスターイメージの作成が開始されます。ただし、インポートされるマシンはゼロです。
重要な考慮事項:
- MCSカタログのインポートプロセスには、マスターイメージのサイズに応じて数時間かかる場合があります。したがって、ツール内のインポートコマンドはMCSカタログの作成のみを開始し、完了するまで待機しません。
- インポートが完了すると、クラウド展開のStudioを介してカタログ作成の進行状況を監視できます。
- マスターイメージが作成されたら、マシンをプロビジョニングできます。オンプレミスの使用量から消費されるため、ハイパーバイザーの既存の容量を考慮してください。
- 他のすべてのオブジェクト(デリバリーグループ、アプリケーション、ポリシー、およびカタログを使用するすべてのオブジェクトを含む)は、マスターイメージの作成を待たずにインポートできます。ツール内で使用できるのと同じコマンドを使用して、カタログとその他のすべてのオブジェクトを移行できます。
- カタログの作成が完了したら、インポートしたカタログにマシンを追加し、ユーザーはリソースを起動できます。
注:
これらの点を考慮した後、このガイドの「 サイト構成をクラウドにインポートする」セクションに従い 、必要に応じて構成をマージしてください。
マシン作成サービス (MCS) の対処:静的割り当てマシン
注:
プールマシンと RDS マシンの手順については、別のセクションを参照してください。 MCSプールVDIおよびRDSマシンに記載されている手順を参照してください
このプロセスは、 データベースに格納されているいくつかの低レベルの詳細をインポートするため、データベースにアクセスできるマシンから実行する必要があります。ツールのインポートプロセスでは、構成、マスターイメージ、およびマシンも移行されます。画像は作成されないため、簡単な操作です。
重要な考慮事項:
- Citrix Cloud Cloudに登録するには、 VDAをCloud Connectorにポイントする必要があります。
- Citrix Cloud Cloudを介してクラウドサイトをアクティブ化し、再起動スケジュール、電源管理などを制御するには、 サイトのアクティブ化のドキュメントを参照してください。
- 移行が完了したら、 対応するカタログをオンプレミスサイトから削除する場合は、[ VM と AD アカウントを残す ] オプションを選択する必要があります。そうしないと、両方のレコードが削除され、クラウドサイトは削除された仮想マシンをポイントしたままになります。
注:
これらの点を考慮した後、このガイドの「 サイト構成をクラウドにインポートする」セクションに従い 、必要に応じて構成をマージしてください。
サイト構成をクラウドにインポートする
このステップでは、 顧客接続の詳細を取得し、 ゾーンマッピングを手動で作成し、クラウドテナントに構成をインポートします。 注:MCSの場合は、まず、このガイドの「 サイト構成をクラウドにインポートする」セクションの対応するサブセクションに従います 。
カスタマー接続の詳細の取得
管理者はCustomerInfo.yml
ファイルを編集し、 対応する顧客名、顧客ID、およびsecretKeyの値を追加する必要があります。これらの値は、次の手順に示すように、クラウドポータルから取得して生成できます。
-
まず、メモ帳などのテキストエディタアプリケーションを使用して
CustomerInfo.yml
ファイルを開きます。次のスクリーンショットは、編集が必要なCustomerInfo.yml
ファイル値 (赤の下線付き) を示しています。 -
Cloud Portal で、 ハンバーガーメニューをもう一度クリックし 、[ ID とアクセス管理: ] に移動します。
-
[ API アクセス ] タブに移動し、[ 顧客 ID ] の値をコピーします。この値は、次のスクリーンショット (赤い長方形) のように
customer ID
テキストの横にあります。 -
取得した値を、
CustomerInfo.yml
ファイルの CustomerID フィールドに続く引用符の間のââ
(引用符) の間に貼り付けます。 -
クラウドポータルに戻り、[ ID とアクセス管理 ] ポータルと [ API アクセス ] タブに移動します。この API キーを識別する名前を [ セキュアクライアントに名前を付ける ] ボックスに入力します。次に、[ クライアントの作成 ] ボタンをクリックします。注: このアクションは、
Client ID
とSecret Key
を生成します。 -
ID
とSecret
の値を 1 つずつコピーします (次の手順に示すように、CustomerInfo.yml
ファイルに貼り付けます)。その後、[ ダウンロード ] をクリックして、後で参照できるようにファイルを保存します。 -
ID
値とSecret
値をCustomerInfo.yml
ファイル内の対応するフィールドに貼り付けます。
ゾーンマッピングファイル (ZoneMapping.yml) を手動で更新する
オンプレミスゾーンは 、 クラウドリソースロケーションに自動的に移行できないため、 ZoneMapping.yml
ファイルを使用してマッピングする必要があります。注: ゾーンが同名のリソースロケーション ( まったく同じ名前のリソースロケーション) にマップされていない場合、移行エラーが発生します。
-
.ymlファイルがある
(Documents\Citrix\AutoConfig)
ディレクトリに戻り、メモ帳または任意のテキストエディタを使用してZoneMapping.yml
を開きます 。注:Primary
の値は、(オンプレミス環境で) オブジェクトの移行元となる対応するゾーンの名前に置き換える必要があります 。 -
この名前は、 オンプレミスのCitrix Studio コンソール>[構成]>[ゾーン]で確認できます。注: オンプレミス環境でゾーンの名前
Primary
が付けられている場合は、ZoneMapping.yml
ファイルの次の値を変更する必要はありません: -
それでも
ZoneMapping.yml
ファイル上で、Name_Of_Your_Resource_Zone
値はクラウドリソースの場所の名前に置き換える必要があります。この値は、 クラウドポータルの [ハンバーガー] メニュー > [ リソースの場所: ] にあります。 -
リソースの場所の名前をコピーします ( 次のスクリーンショットで
My Resource Location
のように表示): -
Name_Of_Your_Resouce_Zone
値の代わりにZoneMapping.yml
値をファイルに貼り付けます: -
オンプレミス環境の複数のゾーンをクラウド内の 1 つのリソースロケーションにマップすることもできます 。ただし、 **オンプレミス環境のゾーンごとに、ファイルには常に 1 つの行が必要です。 オンプレミスの複数のゾーンと1つのリソースロケーション**の場合 、このファイルの形式は次のようになります。
CvadAcSecurity.yml ファイルを手動で更新してください
ホスト接続とそれに関連するハイパーバイザーはCitrix DaaSに移行できます。 ホスト接続を追加するには 、特定のハイパーバイザーのセキュリティ情報が必要です。この情報は、 CVADAcSecurity.yml ファイルに手動で追加する必要があります。注: この例では、Citrix Hypervisor を使用しています。他の種類のハイパーバイザーに必要なセキュリティ情報については、 Citrix DaaS製品ドキュメントサイトを参照してください 。
-
.ymlファイルがある
(Documents\Citrix\AutoConfig)
ディレクトリに戻り、メモ帳または任意のテキストエディタを使用してCvadAcSecurity.yml
を開きます 。 -
CvadAcSecurity.yml
ファイルに、 ハイパーバイザー接続のusername
とpassword
を入力し、ファイルを保存します 。
構成のマージ
-
移行ツールの PowerShell コンソールに戻り、次のコマンド
Merge-CvadAcToSite
を実行します。既存のクラウド構成 (存在する場合) を、オンプレミスサイトからエクスポートされた構成にマージします。 -
各タスクが正常に実行されると、 .yml ファイルがインポートされ、対応するコンポーネントがクラウドサイトに追加されると、出力は緑色に見えます。
-
結果のファイルは次のディレクトリに表示されます。
<This PC>\Documents\Citrix\AutoConfig\Import_<YYYY_MM_DD_HH_mm_ss>
-
この同じフォルダには、
Backup_YYYY_MM_DD_HH_mm_ss
フォルダがあります。注: このフォルダは、構成のバックアップであるため、安全な場所にコピーしてください。
クラウドStudio で作成された設定の確認
-
Citrix DaaS の[ 管理 ]タブには、[ クラウドコンソール ]>[ マイサービス]>[Citrix DaaS]>[管理]
-
更新して、 マシンカタログ、 デリバリーグループ、 ポリシー、 タグ、およびアプリケーションが期待どおりに表示されることを確認します。注:インポートする内容に応じて、独自の構成に固有の結果として異なります。各セクションを確認して 、予想される項目がリストされていることを確認します。
- マシンカタログリストの例:
すべてが期待どおりであれば、Citrix DaaS の移行は完了です。
リソースロケーション間でのクラウド環境の移行
クラウドリージョンまたはDaaS環境間の移行方法に関するガイダンスについては、「Citrix DaaS クラウドからクラウドへの移行」ドキュメントを参照してください。
トラブルシューティングのヒント
トラブルシューティングに関する一般的な情報:
- 自動構成ツールのトラブルシューティング FAQ 記事を参照してください。
- Citrix でサポートチケットを開く前に、
New-CvadAcZipInfoForSupport
を実行してすべてのログと*.yml
ファイルを1つのzipに収集します。顧客のセキュリティ情報は含まれていません。次の場所%HOMEPATH%\Documents\Citrix\AutoConfig\CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zipNew-CvadAcZipInfoForSupport
の zipファイルを転送します。 - コマンドレットを実行すると、 **ログファイルとマスター履歴ログファイルにエントリが作成されます**。エントリには、実行の日付、操作、結果、バックアップ、ログファイルの場所が含まれます。このログは、一般的なエラーに対する潜在的な解決策と修正を提供します。
-
マスター履歴ログは 、という
%HOMEPATH%\Documents\Citrix\AutoConfig
名前History.Log
のファイルにあります。 * すべての操作ログファイルは、 バックアップフォルダーに配置されます。 - すべてのログファイル名は
CitrixLog
で始まり 、auto-config
操作と、コマンドレット実行の日付とタイムスタンプが表示されます 。 - ログは自動削除されません 。
- コンソールのログ記録は、
-quiet
パラメータを使用して抑制できます