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 の設定

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

  • 新規ファイルの場合: 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 ファイルを単一の 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

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

バックアップ

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

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

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

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 パラメーターで指定されたフォルダーのサブフォルダーです。

自動化

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

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

-Confirm $false

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

-DisplayLog $false

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

-Quiet

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

Confirm: False

DisplayLog: False

デリバリーコントローラー以外のPCからのエクスポート

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

注:

自動構成は Cloud Connector では実行できません。

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

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

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

    Environment: 'ProductionGov'

    or

    Environment: 'ProductionJP'

自動構成は、これらの環境で使用できるようになりました。

Citrix Cloudのデータ収集

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

その他のリソース

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

自動構成に関する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」を参照してください。

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