テクニカルブリーフ:Citrix の自動構成ツール

概要

オンプレミスのCitrix Virtual Apps and Desktops 環境をCitrix DaaSに移行したり、異なるクラウドリージョンやテナント間で情報を移行したりすることは、長年にわたって多くのCitrix 管理者にとって面倒で困難な作業でした。移行の多くはケースによって異なる傾向があるため、Citrix 管理者は移行を実行するために自動化スクリプトまたはツールを作成する必要があります。Citrix Automated Configuration Toolを開発しました。これは、管理者が移行を一度に、または段階的に実行し、ツールを複数回実行してCitrix DaaS環境の望ましい構成状態を実現できるツールを提供することで、このプロセスを容易にすることを目的としています。Citrix の自動構成ツールでは、パブリッククラウドリージョンまたはテナント間で情報を移行することもできます。

Citrix Virtual Apps and Desktops の自動構成ツールは何ですか

このツールは、 CVAD構成 (ポリシー、アプリケーション、カタログ、管理者ロール、スコープなど)を1つ以上のオンプレミスサイトからCitrix Cloud でホストされているCitrix DaaSに自動的に移行できるように設計されています 。また、 **異なるクラウドリージョンまたはテナント間で情報を移行する場合にも使用できます**。

このツールを複数回実行することで、移行を段階的に実行できるため、管理者は必要な構成状態を容易に達成できます。 自動構成ツールのクイックツアーを提供する2分間のビデオがあります

 

このツールを使用する理由

大規模環境や複雑な環境を担当するIT管理者は、移行が面倒なプロセスであることがよくあります。彼らはしばしば、このタスクを正常に達成するために独自のツールを書くことになります。なぜなら、それは彼らのユースケースに特有になる傾向があるからです。

Citrixは、自動化を通じてユースケースに対応するツールを提供することで、このプロセスを容易にしたいと考えています。管理者は、 Citrix Cloud で現在の構成を簡単にテストし、 現在の環境をそのまま維持しながらCitrix DaaSが提供するメリットを活用できます 。このようなメリットには、Citrixがバックエンドとコントロールプレーンの一部を管理する場合の管理オーバーロードの軽減、 Citrix Cloudコンポーネントの自動更新およびカスタマイズが可能です

このツールはどのように実装されていますか

Citrixでは業界標準のコードでの構成を使用して、移行プロセスの自動化を支援するメカニズムを提供します。このツールは、1 つ以上のオンプレミスサイトを構成ファイルのコレクションとして検出してエクスポートします。このファイルは、管理者がオプションで編集できます。これらのファイルの構成は、その後、Citrix DaaSにインポートできます。

このコードは移行に限定されるものではなく、Citrixサイトの構成を作成する将来のものです。そのため、 さまざまなユースケースに適用できます。災害復旧、開発/テスト/ステージングから本番サイトへの同期、地理的(GEO)移動、およびその他のいくつかのシナリオがサポートされています。パブリッククラウドプロバイダーを使用する管理者の場合、これにより、オブジェクトの組み合わせを自動的に作成できます (Microsoft Azure ARM テンプレートおよび AWS CloudFormation と並行)。

このツールを使用すると、管理者は名前の競合を回避しながら、 複数のオンプレミスサイトを 1 つのサイトにマージすることもできます。管理者は、オンプレミスとクラウドのどちらがリソースを制御するかを制御できます。 **CvadAcSecurity.ymlファイルを指すSecurityFileFolderパラメーターを使用するときに 、認証を必要とする安全なネットワークファイル共有にファイルを配置できるようになりました** 。

技術的な詳細

Citrix の自動構成ツールは、移行プロセスを自動化することを目的としています。移行がサポートされるCitrix Studioノードには、アプリケーション設定、アプリケーショングループ、アイコン、マシンカタログ、デリバリーグループ、Citrixポリシー、タグ、およびホスト接続が含まれます。Citrix の自動構成ツールは、Citrix PowerShell SDXを使用して情報をクラウドにエクスポートし、REST APIを使用して情報をクラウドにインポートします。

自動設定ツールコマンド

Citrix の自動構成ツールは、PowerShell コマンドレットと既存の Citrix PowerShell SDK を使用します。次の表は、主なコマンドとその機能の詳細を示しています。 自動構成ツールの製品ドキュメントには 、参照用にコマンドレットの詳細が記載されています。

|役割| コマンド | 説明 | | 移行 | Export-CVADactoFile | オンプレミスセットアップから構成をエクスポートします。このコマンドは、自動構成のデフォルトのエクスポート操作です。オンプレミスサイトの構成は変更されません。エクスポートされたファイルは、名前の付いたエクスポートサブフォルダーの「%HOMEPATH%\ Documents\ Citrix\ AutoConfig」ディレクトリーに置かれます。| | 移行 | Import-CVADactoSite | すべてのオンプレミスファイルをクラウドにインポートします。このコマンドにより、クラウドの終了状態がオンプレミスの状態と同じになります。このオプションにより、クラウドに存在する変更がすべて削除されます。インポートされたサイト構成ファイルは、「%HOMEPATH%\ Documents\ Citrix\ AutoConfig」から取得されます。| | 移行 | Merge-CVADactoSite | オンプレミスのファイルをクラウドにマージしますが、クラウド内のコンポーネントは削除しません。 これにより、クラウドで既に行われた変更が維持されます。Citrix Cloudに同じ名前のコンポーネントが存在する場合、このコマンドによりそのコンポーネントを変更できます。これは、自動構成のデフォルトのインポート操作です。マージされたサイト構成ファイルは、「%HOMEPATH%\ Documents\ Citrix\ AutoConfig」から提供されます。| | 移行 | New-CVADactoSite | オンプレミスのサイト構成をクラウドにインポートしますが、新しいコンポーネントを追加するだけです。既存のクラウドサイトコンポーネントは更新も削除もされません。既存のクラウドサイトコンポーネントを変更しない必要がある場合は、このコマンドを使用してください。| | バックアップと復元 | 復元-CVADactoSite | クラウドサイトを以前の構成に復元します。インポートファイルは、-RestoreFolderパラメーターで指定されたフォルダーからインポートされます。これは、以前の構成に戻したり、クラウドサイトの障害復旧に使用したりできます。| | バックアップと復元 | Backup-CVADactoSite | クラウドサイトのすべての設定をバックアップします。| | その他 | compare-CVADactoSite | オンプレミスの.yml ファイルをクラウド設定と比較し、ImportMerge、またはRestoreによって加えられた変更のレポートを作成します 。 | | その他 | Remove-CVADACFromSite | サイト全体をリセットしたり、コンポーネントからメンバーアイテムを削除したりできます(たとえば、カタログのリストからマシンカタログを1つ削除するなど)。 IncludeByName これをパラメータと組み合わせて特定のメンバーを選択的に削除する場合に使用できます。|

コマンドパラメータ

末尾が ToSiteToFileFromSiteのすべてのコマンドレットで、処理対象となるコンポーネントを1つ以上選択できます。これらのパラメータでは、選択したコンポーネントのみをより細かく移行できます。次のパラメータを使用できます。

-All -Tags -MachineCatalogs -DeliveryGroups -ApplicationGroups -Applications -GroupPolicies -IncludeByName and ExcludeByName

フィルタリング

包含および除外

IncludeByNameおよびExcludeByNameパラメーターでは、コンポーネントメンバーを名前でコマンドレットに含めたり、コマンドレットから除外したりできます。サポートされているコマンドレットで選択できるコンポーネント(デリバリーグループ)は1つだけです。サポートされているコマンドレット (含む、含まない) は次のとおりです。

  • Export-CvadAcToFile
  • Import-CvadAcToSite
  • Merge-CvadAcToSite
  • New-CvadAcToSite
  • Restore-CvadAcToSite
  • Sync-CvadAcSiteToSite
  • Compare-CvadAcToSite
  • Remove-CvadAcFromSite

IncludeByNameおよびExcludeByNameは、コンポーネントメンバー名のリストを取得します。すべての名前に1文字以上のワイルドカードを含めることができます。次の2種類のワイルドカードがサポートされています。

  • 任意の数の文字に一致
  • 1文字に一致

IncludeByNameおよびExcludeByNameにより、メンバーのリストを含むファイルを取得することもできます。そこには各メンバーが明示されているか、ワイルドカードが含まれています。ファイル内の各行には 1 つのメンバーを指定できます。先頭または末尾のスペースはメンバー名から削除されます。ファイル名は先頭に@を付け、一重引用符で囲む必要があります(@が再解釈されないようにするためのPowerShellの要件)。メンバー名が混在するのに加え、複数のファイルをリストできます。

デリバリーグループ名で

ByDeliveryGroupName アプリケーションおよびアプリケーショングループのデリバリーグループ名でフィルタリングします。このパラメータは常に、デリバリーグループの関連付けに基づいて含めるメンバーを識別する包含リストです。 ByDeliveryGroupName以下のコマンドレットがサポートされています。

  • Export-CvadAcToFile
  • Import-CvadAcToSite
  • Merge-CvadAcToSite
  • New-CvadAcToSite
  • Restore-CvadAcToSite
  • Sync-CvadAcSiteToSite
  • Compare-CvadAcToSite

ByDeliveryGroupName デリバリーグループ名のリストを取ります。すべての名前に1文字以上のワイルドカードを含めることができます。次の2種類のワイルドカードがサポートされています。

  • 任意の数の文字に一致
  • 1文字に一致

次の例では、で始まるすべてのデリバリーグループ名を参照するすべてのアプリケーションをマージします EastDg

Merge-CvadAcToSite –Applications $true –ByDeliveryGroupName EastDg*

移行モードパラメーター

クラウドサイトの構成を変更するコマンドレット (ImportRestoreMergeNewおよびSync) は、柔軟性を高めるために次の追加パラメーターをサポートします。

パラメーター 説明
-チェックモード インポート操作を実行しますが、変更は行いません。インポート実行前に、想定されるすべての変更が報告されます。このコマンドを使用して、インポートを実行前にテストできます。注:チェックモードは、コンポーネントが 1 つずつ移行していて、各マージの前にチェックモードを実行しない限り、コンポーネントの依存関係から生じる問題をテストできません。
-最初にバックアップを取る このパラメータはデフォルトで有効になっており、クラウド設定を変更する前にクラウドコンテンツを.yml ファイルにバックアップします。
-確認 true の場合、クラウドサイト構成を変更するかどうかを確認するようユーザーに促します。 Remove このコマンドレットは破壊的であるため、プロンプトが表示されます。自動スクリプト内での実行など、プロンプトが必要ない場合は false に設定します。 Confirm デフォルトは true です。
-AdminAddress エクスポート元の任意の DDC を対象とするエクスポートコマンドレットがサポートされています。
-すべてのユーザーとマシンを確認 マシンカタログ内のすべてのマシンがActive Directory に存在することを確認します。Active Directory に存在しないユーザーまたはデバイスはエクスポートデータから削除されるため、インポート操作が成功する可能性が高くなります。 CheckAllUsersAndMachines デフォルトは true です。

クラウドアクセスパラメーター

クラウドにアクセスするすべてのコマンドレット (末尾が FromSite'andGet-CVADacStatus`) は、次の追加パラメーターをサポートします。 ToSite

これらのパラメータは、CustomerInfo.yml ファイルに追加されている場合は不要です。これらのパラメータがなく、CustomerInfo.ymlファイルが更新されていない場合でも、PowerShell SDKを介してCitrix Cloudの認証情報を入力することで、インタラクティブに認証を行うことができます。

パラメーター 説明
-カスタマー ID REST API で使用されているカスタマー ID は、すべての REST API にアクセスするために必要です。顧客IDはCitrix Cloudに保存されています。
-クライアント ID Citrix Cloud IDおよびアクセス管理Webサイトで作成されたクライアントID。これは、すべての REST API の認証用のベアラートークンを取得するために必要です。
-シークレット Citrix Cloud IDおよびアクセス管理Webサイトで作成された秘密鍵。これは、すべての REST API の認証用のベアラートークンを取得するために必要です。
-顧客情報ファイル仕様 ファイル仕様は、デフォルトの場所と名前を上書きする顧客情報ファイルを指しています。

フォルダとロギング

自動構成は、クラウドサイト構成を初期化、更新、およびバックアップします。クラウドサイトでは、時間の経過とともに使用すると、多くの構成が変更される可能性があります。自動構成では、長期間の使用を容易にし、変更履歴を保持するために、保存スキームを使用して変更履歴を保存し、以前の状態を復元する方法を提供しています。

フォルダー

自動構成操作はすべて、ルートフォルダーまたはその中のサブフォルダーで行われます。ルートフォルダは「%HOMEPATH%\ Documents\ Citrix\ AutoConfig」にあります。

エクスポートエクスポートされたファイルはすべて 2 つのフォルダーに配置され、使いやすくエクスポートの履歴も確認できます。エクスポートは常にルートフォルダーに配置されます。コピーは、エクスポートの日付と時刻を含む「エクスポート」という名前のサブフォルダーに配置されます。ルートフォルダーには、エクスポートされた最新のオンプレミスサイト構成が常に含まれています。各「エクスポート」サブフォルダーには、指定された日時に行われたエクスポートが含まれ、エクスポートの履歴が保持されます。任意の「エクスポート」サブフォルダーを使用してクラウドサイトを構成できます。自動構成では、既存の「エクスポート」サブフォルダーは削除または変更されません。

インポート/マージ/同期/比較 ImportMergeCompare および操作は常にルートフォルダーのファイルから行われます。操作を行うたびに、ルートフォルダー内のファイルがコピーされるサブフォルダーが作成され、クラウドサイトのソースファイルの変更履歴が表示されます。 任意のサブフォルダーを使用して、クラウドサイトを構成できます。自動構成では、既存のエクスポートサブフォルダーは削除または変更されません。

Restore 復元操作では 、既存のサブフォルダーを使用してクラウドサイトを構成します。ソースフォルダーは、必須の-RestoreFolderパラメーターで指定されます。他のコマンドとは異なり、 Restore 操作では既存のサブフォルダーが使用されるため、新しいサブフォルダーは作成されません。復元フォルダーはルートフォルダーでも構いませんが、-RestoreFolderパラメーターで指定する必要があります。

バックアップクラウドサイト設定のバックアップは常に 、バックアップのデータと時刻を含む「バックアップ」という名前のサブフォルダーに作成されます。自動構成では、既存のエクスポートサブフォルダーは削除または変更されません。バックアップを使用して、特定のコンポーネントや構成全体を復元できます。デリバリーグループおよびマシンカタログコンポーネント全体を復元するには、次のコマンドレットを使用します: Restore-CvadAcToSite -RestoreFrom %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss -GroupPolicies -IncludeByName Policy1,Policy2 -DeliveryGroups -MachineCatalogs

前述のコマンドレットのバックアップファイル情報は、バックアップに基づいています。

クラウドサイト構成全体を復元するには、次のコマンドレットを使用します: Restore-CvadAcToSite -RestoreFrom %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss

前述のコマンドレットのバックアップファイル情報は、バックアップに基づいています。

ログ

自動構成ツールのコマンドレットを実行すると、ログファイルが作成され、マスター履歴ログファイルにエントリが作成されます。操作ログファイルはすべて、バックアップフォルダーに配置されます。ログファイル名はすべてCitrixLogで始まり、自動構成操作とコマンドレットの実行日およびタイムスタンプを示します。ログは自動削除されません。 マスター履歴ログは「%HOMPATH%\ Documents\ Citrix\ AutoConfig」の「History.Log」という名前のファイルにあります。コマンドレットを実行するたびに、実行日、操作、結果、バックアップ、およびログファイルの場所を含むマスターログエントリが作成されます。

ロギングの詳細各ログファイルには以下が含まれます 。 -操作の名前とチェックモードが有効になっているかどうか -開始日時と終了日時 -各コンポーネントのアクションと成功/失敗の通知に関する複数のエントリ -実行されたアクションの概要(作成されたオブジェクトのさまざまな数を含む) -推奨修正方法(該当する場合)-バックアップフォルダーの場所 -マスターログの場所 -期間

診断ファイル診断ファイルは 、問題の特定と解決に役立ちます。操作の実行時に、以下のファイルが作成されます。これらは、「%HOMEPATH%\ Documents\ Citrix\ AutoConfig」の下のアクション固有のサブフォルダーにあります。問題解決サポートの情報を提供する際には、これらのファイルを含めてください。

PoshSDK_YYYY_MM_dd_HH_MM_SS.ps1** のエクスポートこのファイルには** 、サイト構成をファイルにエクスポートするための Broker PowerShell SDK 呼び出しがすべて列挙されています。

インポート、マージ、復元、同期、バックアップ、比較このファイルには Transaction_yyyy_mm_dd_hh_mm_ss.txt 、各 REST API 呼び出しと関連情報が記録されています。 RestApiContent_yyyy_mm_dd_hh_mm_ss.txt このファイルには AddUpdate、および Delete REST API のすべてのコンテンツが含まれています。

移行シナリオ

オンプレミスのCitrix Virtual Apps and Desktops からCitrix DaaSへの移行は、オンプレミスのサイトに複数のホスト接続があるか、複数のゾーンがあるかによって、単純なものから複雑なものまでさまざまです。

シンプルな移行

単純な移行シナリオでは、次の図に示すように、オンプレミスサイトには、Citrix DaaSに移行するための単一のゾーンと1つ以上のホスト接続が含まれます。

シンプルな移行

複雑な移行

複雑な移行シナリオでは、次の図に示すように、オンプレミスサイトには複数のゾーンと複数のホスト接続が含まれます。

複雑な移行

移行シナリオによっては、次のセクションで詳しく説明するように、自動構成ツールとのワークフローのやり取りが異なる場合があります。

自動構成ワークフロー

自動構成ツールを使用する場合、一般的なワークフローに従います。このワークフローでは、管理者が直面する可能性のある複数の決定ポイントがあります。次の図は、ワークフローを示しています。

ACT ワークフロー

注:

チェックモードは、コンポーネントごとにきめ細かく移行する場合に最適です。

  1. 自動構成ツールをダウンロードし、ツールを正常に使用するためのシステム要件と前提条件を確認してください。
  2. 自動構成ツールを開き、Export-CVADactoFile コマンドを実行してオンプレミスサイトをエクスポートします。

    移行には次のものがサポートされています。

    • タグ
    • 接続のホスティング
    • マシンカタログ
    • デリバリーグループ
    • アプリケーショングループ
    • アプリケーション
    • グループポリシー
    • 管理者スコープとロール

    以下はマイグレーションをサポートしていません。

    • AppDisk
    • AppDNA
    • App-V公開
    • 委任管理機能
  3. オンプレミスサイトをCitrix DaaSに移行するには、 CustomerInfo.yml ファイルを手動で更新する必要があります。メモ帳で「CustomerInfo.yml」ファイルを開き CustomerName、対応する CustomerIDSecretKey およびの値を追加します。これらの値は、Citrix Cloudポータルから取得および生成されます。
  4. CustomerInfo.yml ファイルが更新されると、最初の決定点に達しました。サイトに複数のゾーンが含まれている場合は、すべてのゾーンをCitrix ZoneMapping.yml DaaSリソースロケーションにマップするようにファイルを更新する必要があります。注:オンプレミスのCitrix 環境のゾーンは、Citrix DaaS 内のリソースロケーションと同等の概念です。オンプレミスサイトに 1 つのゾーンしかない場合は、次のステップに進んでください。
  5. オンプレミスサイトに複数のホスティング接続が含まれている場合は、Citrix DaaSに移行する各ホストタイプの接続情報でCvadAcSecurity.ymlを更新します。オンプレミスサイトにホスト接続が 1 つしかない場合は、 CvadACSecurity.yml ホスト接続の接続情報でファイルを更新します。
  6. Citrix では、環境を段階的に移行することを推奨しています。Merge-CVADactoSite -<ComponentName> (デリバリーグループ、マシンカタログなど)を実行して、コンポーネントを 1 つずつ移行します。 コンポーネントは必ず次の順序で移行してください。チェックモードを使用するには、-checkMode パラメーターを追加して、コンポーネントが正常に移行されるかどうかを確認します。問題がなければ、-CheckMode パラメータを削除して merge-CVADactoSite -<ComponentName>を再実行してください。すべてのコンポーネントが完成したら、DaaS サイトの準備は完了です。または、コンポーネント名をパラメーターとして追加せずに merge-CVADactoSite を実行して、サイト全体を一度に移行することもできます。

注:

チェックモードでは、コンポーネントが 1 つずつ移行されない限り、コンポーネント間の相互依存性はチェックされません。

  1. この時点で、オンプレミスのCitrixサイトはまだアクティブです。Citrix DaaSデリバリーグループはメンテナンスモードになっています。すべてのセッションは、引き続きオンプレミスの仮想アプリおよびデスクトップ環境によって仲介されます。次のコマンドを実行して、DaaS を使用してセッションを仲介し始めます。
  • Set-CvadAcSiteActiveStateCloudOnPrem (このコマンドは、オンプレミスのデリバリーグループを切り替えてメンテナンスモードにします)
  • Set-CvadAcSiteActiveStateCloud -SiteActive (このコマンドは、クラウドデリバリーグループをアクティブ化し、メンテナンスモードを解除して、サイトを有効にします。)

注:

これらのコマンドは、フィルタリング、IncludeByName、およびチェックモードをサポートしています

  1. 報告されたエラーについては、 トラブルシューティングガイドを参照してください 。トラブルシューティングガイドには、エラータイプに関する提案が記載されています。推奨アクションを実行して、自動構成ツールのチェックモードを再実行します。
  2. トラブルシューティングガイドで問題を解決できない場合は、 トラブルシューティングの指示に従ってファイルを zip 形式にパッケージ化し、サポートチケットを開いてサポートを受けてください。

リファレンス

Citrix 自動構成ツール製品ドキュメント

Citrix 自動構成ツールトラブルシューティングガイドと FAQ

Citrix の自動構成ツール POC ガイド

テクニカルブリーフ:Citrix の自動構成ツール