Citrix Virtual Apps and Desktops

自動構成のトラブルシューティングと追加情報

重要:

自動構成でよく発生するエラーメッセージとそれに対応する解決策については、Knowledge Centerの記事 CTX277730 にある トラブルシューティングFAQ を参照してください。

自動構成ツールのエラー

自動構成ツールの操作中にエラーが発生することがあります。この場合、マシンカタログ、デリバリーグループ、グループポリシーなどのコンポーネントの処理中に障害が発生する可能性があります。OnErrorActionと継続パラメーターを使用すると、処理中にエラーを捕捉し、解決して、中断した箇所から再開できます。

デフォルトのOnErrorAction値はStopCompEndです。エラーが発生すると、ツールは現在のコンポーネントの処理を完了します。追加のコンポーネントは処理されず、エラーは下流の依存コンポーネントに引き継がれません。エラーを解決した後、継続パラメーターを適用してコマンドレットを再実行できます。

OnErrorActionパラメーター

移行コマンドでOnErrorActionパラメーター値を定義して、コンポーネントの処理中にツールが検出したエラーにどのように応答するかを制御できます。

この表は、パラメーター値とその説明を示しています。

説明
Continue 可能な限り多くのコンポーネントを処理しようとします。
Pause 処理の最後に一時停止し、続行または停止を促します。
StopCompEnd コンポーネントを可能な限り処理しようとします。コンポーネントの完了後に停止します。(デフォルト)
StopImmediately エラーが検出されると処理を停止します。

移行コマンドレット

次の移行コマンドにOnErrorActionパラメーターを適用できます。

  • Compare-CvadAcToSite
  • Import-CvadAcToSite
  • Merge-CvadAcToSite
  • New-CvadAcToSite
  • Restore-CvadAcToSite

例: Merge-CvadAcToSite -OnErrorAction StopImmediately

再開パラメーター

これらのパラメーターは、エラーのために操作が一時停止または停止した後にツールがどのように再開するかを定義します。

次のOnErrorActionパラメーター値のいずれかを含む移行コマンドレットに、再開パラメーターを適用できます。

  • Pause
  • StopCompEnd
  • StopImmediately

この表は、パラメーター値とその説明を示しています。

説明
-AllRemaining 開始コンポーネントが必要です。処理は開始コンポーネントから始まり、残りのすべてのコンポーネントを処理します。複数のコンポーネントが処理されます。
-Resume CurrentComponent.txtのコンポーネントを開始点として使用します。残りのすべてがtrueに設定されます。複数のコンポーネントが処理されます。
-Repeat CurrentComponent.txtのコンポーネントを開始点として使用します。残りのすべてがfalseに設定されます。1つのコンポーネントのみが処理されます。

最後に処理されたコンポーネントは、AutoConfigフォルダー内のCurrentComponent.txtファイルに保存されます。このファイルの編集は推奨されません。 -Resumeまたは-Repeatを指定し、CurrentComponent.txtが見つからないか無効な場合、処理は停止し、コンポーネントを選択するように求められます。

CustomerInfo.ymlファイルでのOnErrorActionの設定

CustomerInfo.ymlファイルでOnErrorAction値を設定することもできます。次のコマンドレットを使用して値を設定します。

  • 新しいファイルの場合: New-CvadAcCustomerInfoFile -OnErrorAction Continue | Pause | StopCompEnd | StopImmediately
  • 既存のファイルの場合: Set-CvadAcCustomerInfoFile -OnErrorAction Continue | Pause | StopCompEnd | StopImmediately

ログ

いずれかのコマンドレットを実行すると、ログファイルが作成され、メインの履歴ログファイルにエントリが追加されます。すべての操作ログファイルはバックアップフォルダーに配置されます。すべてのログファイル名はCitrixLogで始まり、その後に自動構成操作とコマンドレット実行の日時が示されます。ログは自動削除されません。

メインの履歴ログは、*%HOMEPATH%\Documents\Citrix\AutoConfig*内のHistory.Logというファイルにあります。各コマンドレットの実行により、実行の日付、操作、結果、バックアップ、およびログファイルの場所を含むメインログエントリが生成されます。

New-CvadAcZipInfoForSupportコマンドレットを使用して、Citrixにサポートのために送信するログを収集することもできます。このコマンドレットは、すべてのログファイルと.ymlファイルを1つのzipファイルに圧縮します。顧客の機密情報(CustomerInfo.ymlおよびCvadAcSecurity.yml)はzipに含まれません。Icon.ymlファイルもサイズが大きいため除外されます。zipファイルは*%HOMEPATH%\Documents\Citrix\AutoConfig*に配置され、日時に基づいて*CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip*という名前が付けられます。このzipファイルはバックアップとしても機能します。

各ログファイルには以下が含まれます。

  • 操作の名前とチェックモードが有効かどうか
  • 開始日時と終了日時
  • 各コンポーネントのアクションと成功/失敗通知の複数のエントリ
  • 作成されたオブジェクトのさまざまな数を含む実行されたアクションの概要
  • 該当する場合の推奨される修正
  • 該当する場合のバックアップフォルダーの場所
  • メインログの場所
  • 期間

診断ファイル

診断ファイルは、問題の特定と解決に役立ちます。次のファイルは、操作が実行されるときに作成されます。これらは*%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

このファイルには、すべてのAddUpdateDelete Rest APIコンテンツが含まれています。

依存関係に起因する問題

インポートとマージは、依存関係の欠落が原因で失敗する可能性があります。一般的な問題は次のとおりです。

  1. グループポリシーにデリバリーグループフィルターがありません。通常の原因は、インポートされていないデリバリーグループです。
  2. アプリケーションのインポートまたはマージが失敗します。通常の原因は、インポートされていないデリバリーグループまたはアプリケーショングループです。
  3. アプリケーショングループにRestrictToTagがありません。通常の原因は、インポートされていないタグです。
  4. ホスト接続が失敗します。通常の原因は、CvadAcSecurity.ymlファイルにセキュリティ情報が不足していることです。
  5. マシンカタログが失敗します。通常の原因は、インポートされていないホスト接続です。
  6. マシンカタログとデリバリーグループからマシンが欠落しています。通常の原因は、Active Directoryで見つからなかったマシンです。
  7. デリバリーグループからユーザーが欠落しています。通常の原因は、Active Directoryで見つからなかったユーザーです。

推奨事項

  • 自動構成の複数のインスタンスを同時に実行しないでください。複数のインスタンスを同時に実行すると、クラウドサイトで予測できない結果が生じます。この場合、自動構成の1つのインスタンスを再実行して、サイトを期待される状態に戻してください。
  • 自動構成の実行中にStudioで作業したりデータを変更したりしないでください。
  • Studioでマージ、インポート、または復元の結果を常に視覚的に確認し、クラウドサイトが期待どおりであることを確認してください。

フォルダー

デフォルトのフォルダーのルート場所

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

エクスポート

エクスポートされたすべてのファイルは、使いやすさとエクスポート履歴を提供するために、2つのフォルダーの場所に配置されます。エクスポートは常にルートフォルダーに配置されます。コピーは、エクスポートの日時とともにExportという名前のサブフォルダーに配置されます。

ルートフォルダーには、常に最新のエクスポートされたオンプレミスサイトの設定が含まれています。各 Export サブフォルダーには、指定された日時に行われたエクスポートが含まれており、エクスポートの履歴が保持されます。任意の Export サブフォルダーを使用して、クラウドサイトを設定できます。自動化された設定は、既存のエクスポートサブフォルダーを削除または変更しません。

インポート/マージ/同期/比較

ImportMergeCompare の各操作は、常にルートフォルダーにあるファイルからソースを取得します。各操作によりサブフォルダーが作成され、ルートフォルダー内のファイルがそこにコピーされ、クラウドサイトの変更元ファイルの履歴が提供されます。

Restore

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

バックアップ

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

クラウドサイト構成のバックアップは、常にバックアップの日付と時刻を含む Backup という名前のサブフォルダーに作成されます。Automated Configuration は、既存のエクスポートサブフォルダーを削除または変更しません。

バックアップを使用して、特定のコンポーネントまたは構成全体を復元できます。デリバリーグループとマシンカタログのコンポーネント全体を復元するには、次のコマンドレットを使用します。

Restore-CvadAcToSite -RestoreFolder %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss -DeliveryGroups -MachineCatalogs

注:

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

クラウドサイト構成全体を復元するには、次のコマンドレットを使用します。

Restore-CvadAcToSite -RestoreFolder %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss

注:

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

デフォルトのルートフォルダーの変更

ExportImportMergeSyncCompare の各操作は、–AlternateFolder パラメーターを使用することでデフォルトのルートフォルダーを変更できます。操作ごとのサブフォルダーの作成と管理は、前述のとおり変更ありません。

サブフォルダーにコピーされるファイル

以下のファイルを除き、”.yml” 拡張子を持つすべてのファイルは操作サブフォルダーにコピーされます。

  • CustomerInfo.yml
  • ZoneMapping.yml
  • CvadAcSecurity.yml

自動フェイルセーフクラウドサイトバックアップ

構成を変更する操作を実行する前に、現在のクラウドサイト構成のバックアップが作成されます。これには、ImportMergeSyncRestore の各パラメーターが含まれます。バックアップは常に、操作サブフォルダーの下のサブフォルダーにあります。

Restore の場合、バックアップフォルダーは -RestoreFolder パラメーターで指定されたフォルダーのサブフォルダーです。

自動化

Automated Configuration ツールのコマンドレットは、プロンプトとコマンドレット完了時のログ結果の表示を抑制することで、管理者による介入なしに自動化スクリプトで実行できます。CustomerInfo.yml ファイルを使用して、同じことを行うパラメーターを設定することもできます。

プロンプトの表示を抑制するには、クラウド変更コマンドレットに次のパラメーターを追加します。

-Confirm $false

コマンドレットの完了時にログの表示を抑制するには、コマンドレットに次のパラメーターを追加します。

-DisplayLog $false

PowerShell コマンドウィンドウへのログ記録を抑制するには、コマンドレットに次のパラメーターを追加します。

-Quiet

別の方法として、次のパラメーターを CustomerInfo.yml ファイルに配置できます。

Confirm: False

DisplayLog: False

Delivery Controller™ 以外の PC からのエクスポート

Automated Configuration ツールは、複数の Citrix PowerShell SDK を使用して、オンプレミスサイト構成をファイルにエクスポートします。これらの SDK は Delivery Controller に自動的にインストールされるため、追加のアクションなしで Delivery Controller でツールを実行できます。Delivery Controller 以外のマシンで実行する場合は、ツールに必要な Citrix PowerShell SDK のセットをインストールする必要があります。この SDK セットは Citrix Studio の一部であり、Citrix Virtual Apps and Desktops™ インストールメディアからインストールできます。

注:

Automated Configuration は Cloud Connector では実行できません。

Citrix Cloud™ Government および Japan Control Plane への移行

Citrix Cloud Government および Japan Control Plane 環境では、異なるアクセスポイントを使用して認証し、アクセストークンを割り当てます。この固有の要件は、クラウドにアクセスするすべての Automated Configuration ツールに適用されます。これらの環境で Automated Configuration を使用するには、次の手順を実行します。

  1. %HOMEPATH%\Documents\Citrix\AutoConfig フォルダーで、CustomerInfo.yml を編集します。
  2. 接続する環境に応じて、次のいずれかの行を CustomerInfo.yml に追加します(または、既に存在する場合は変更します)。

    Environment: 'ProductionGov'

    or

    Environment: 'ProductionJP'

これらの環境で Automated Configuration を使用できるようになりました。

Citrix Cloud データ収集

Citrix Cloud が収集する情報については、「Citrix Cloud Services Customer Content and Log Handling」を参照してください。

その他のリソース

ディスカッションフォーラム

Automated Configuration 用 Citrix ディスカッションフォーラムにアクセスしてください。

ビデオ

YouTube で「Under the Hood of the Automated Configuration Tool for Citrix Virtual Apps and Desktops」をご覧ください。

トレーニング

Cloud Learning Center には、この記事で説明されているタスクを含む、サービス展開を構築するためのステップバイステップのビデオガイドが含まれています。「Migrating Citrix Virtual Apps and Desktops to Citrix Cloud Learning Path」を参照してください。

自動構成のトラブルシューティングと追加情報