自動構成のトラブルシューティングと追加情報
重要:
自動構成でよく発生するエラーメッセージと対応する解決策については、Knowledge Centerの記事CTX277730のトラブルシューティングFAQを参照してください。
自動構成ツールのエラー
自動構成ツールの操作中にエラーが発生する場合があります。この場合、マシンカタログ、デリバリーグループ、グループポリシーなどのコンポーネントの処理中に障害が発生することがあります。
OnErrorActionと継続パラメーターを使用すると、処理中にエラーを捕捉し、解決して、中断したところから再開できます。
デフォルトの
OnErrorAction値はStopCompEndです。エラーが発生すると、ツールは現在のコンポーネントの処理を完了します。追加のコンポーネントは処理されず、エラーは下流の依存コンポーネントに引き継がれません。エラーを解決した後、継続パラメーターを適用してcmdletを再実行できます。
OnErrorActionパラメーター
コンポーネントの処理中にツールが検出したエラーへの応答方法を制御するために、移行コマンドで
OnErrorActionパラメーター値を定義できます。
この表は、パラメーター値とその説明を示しています。
| 値 | 説明 |
|---|---|
Continue |
すべてのコンポーネントを可能な限り多く処理しようとします。 |
Pause |
処理の最後に一時停止し、続行するか停止するかを尋ねます。 |
StopCompEnd |
コンポーネントを可能な限り多く処理しようとします。コンポーネントの完了後に停止します。(デフォルト) |
StopImmediately |
エラーが検出されると処理が停止します。 |
移行cmdlet
次の移行コマンドに
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
このファイルには、すべての
Add、Update、および Delete Rest APIコンテンツが含まれています。
依存関係に起因する問題
インポートとマージは、依存関係の欠落が原因で失敗する可能性があります。一般的な問題は次のとおりです。
-
グループポリシーにデリバリーグループフィルターがありません。通常の原因は、インポートされていないデリバリーグループです。
-
アプリケーションのインポートまたはマージが失敗します。通常の原因は、インポートされていないデリバリーグループまたはアプリケーショングループです。
-
アプリケーショングループにRestrictToTagがありません。通常の原因は、インポートされていないタグです。
-
ホスト接続が失敗します。通常の原因は、CvadAcSecurity.ymlファイルにセキュリティ情報がないことです。
-
マシンカタログが失敗します。通常の原因は、インポートされなかったホスト接続です。
-
マシンカタログとデリバリーグループからマシンが欠落しています。通常の原因は、Active Directoryで見つからなかったマシンです。
-
デリバリーグループからユーザーが欠落しています。通常の原因は、Active Directoryで見つからなかったユーザーです。
推奨事項
-
自動構成の複数のインスタンスを同時に実行しないでください。複数のインスタンスを同時に実行すると、クラウドサイトで予測できない結果が生じます。この問題が発生した場合は、自動構成の1つのインスタンスを再実行して、サイトを予期される状態に戻してください。
-
自動構成の実行中にStudioで作業したり、データを変更したりしないでください。
-
クラウドサイトが期待どおりであることを確認するために、Studioでマージ、インポート、または復元の結果を常に視覚的に検証してください。
フォルダー
デフォルトのフォルダーのルート場所
すべての自動構成ツール操作は、ルートフォルダーまたはその中のサブフォルダーで行われます。ルートフォルダーは、%HOMEPATH%\Documents\Citrix\AutoConfigにあります。
エクスポート
すべてのエクスポートされたファイルは、使いやすさとエクスポート履歴を提供するために、2つのフォルダーの場所に配置されます。エクスポートは常にルートフォルダーに配置されます。コピーは、エクスポートの日時とともにExportという名前のサブフォルダーに配置されます。
ルートフォルダーには常に、最新のエクスポートされたオンプレミスサイト構成が含まれています。各Exportサブフォルダーには、指定された日時に行われたエクスポートが含まれており、エクスポートの履歴が保持されます。任意のExportサブフォルダーを使用して、クラウドサイトを構成できます。自動構成は、既存のエクスポートサブフォルダーを削除または変更しません。
インポート/マージ/同期/比較
Import、Merge、およびCompare操作は、常にルートフォルダーにあるファイルから取得されます。各操作によりサブフォルダーが作成され、ルートフォルダー内のファイルがそこにコピーされ、クラウドサイトの変更元ファイルの履歴が提供されます。
復元
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
注:
前述のコマンドレットのバックアップファイル情報は、独自のバックアップに基づいています。
デフォルトのルートフォルダーの変更
Export、Import、Merge、Sync、およびCompare操作は、–AlternateFolderパラメーターを使用してデフォルトのルートフォルダーを変更できます。操作ごとのサブフォルダーの作成と管理は、前述のとおりです。
サブフォルダーにコピーされたファイル
以下のファイルを除き、拡張子が「.yml」のすべてのファイルは操作サブフォルダーにコピーされます。
-
CustomerInfo.yml
-
ZoneMapping.yml
-
CvadAcSecurity.yml
自動フェイルセーフクラウドサイトバックアップ
現在のクラウドサイト構成のバックアップは、構成を変更する操作を実行する前に作成されます。これには、
Import、Merge、Sync、およびRestoreパラメーターが含まれます。バックアップは常に、運用サブフォルダーの下のサブフォルダーに保存されます。
Restoreの場合、バックアップフォルダーは-RestoreFolderパラメーターで指定されたフォルダーのサブフォルダーです。
自動化
自動構成ツールコマンドレットは、プロンプトとコマンドレット完了時のログ結果の表示を抑制することで、管理者による介入なしに自動化スクリプトで実行できます。CustomerInfo.ymlファイルを使用して、同じことを行うようにパラメーターを設定することもできます。
プロンプトの表示を抑制するには、クラウド変更コマンドレットに次のパラメーターを追加します。
-Confirm $false
コマンドレットの完了時にログの表示を抑制するには、コマンドレットに次のパラメーターを追加します。
-DisplayLog $false
PowerShellコマンドウィンドウへのログ記録を抑制するには、コマンドレットに次のパラメーターを追加します。
-Quiet
別の方法として、次のパラメーターをCustomerInfo.ymlファイルに配置できます。
Confirm: False
DisplayLog: False
Delivery Controller™以外のPCからのエクスポート
自動構成ツールは、複数のCitrix PowerShell SDKを使用して、オンプレミスサイト構成をファイルにエクスポートします。これらのSDKはDelivery Controllerに自動的にインストールされるため、追加の操作なしでツールをDelivery Controllerで実行できます。Delivery Controller以外のマシンで実行する場合は、ツールに必要な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環境では、認証およびアクセストークンの割り当てに異なるアクセスポイントを使用します。この固有の要件は、クラウドにアクセスするすべての自動構成ツールに適用されます。これらの環境で自動構成を使用するには、次の手順を実行します。
-
%HOMEPATH%\Documents\Citrix\AutoConfigフォルダーで、CustomerInfo.ymlを編集します。
-
接続したい環境に応じて、CustomerInfo.yml に以下のいずれかの行を追加します (既に存在する場合は変更します)。
Environment: 'ProductionGov'またはEnvironment: 'ProductionJP'
これらの環境で自動構成を使用できるようになりました。
Citrix Cloud のデータ収集
Citrix Cloud が収集する情報については、「Citrix Cloud Services Customer Content and Log Handling」を参照してください。
その他のリソース
ディスカッションフォーラム
Citrix Discussion forum for Automated Configuration にアクセスしてください。
ビデオ
YouTube で Citrix Virtual Apps and Desktops の自動構成ツールの内部構造 をご覧ください。
トレーニング
クラウドラーニングセンターには、この記事で説明されているタスクを含む、サービス展開を構築するためのステップバイステップのビデオガイドがあります。「Migrating Citrix Virtual Apps and Desktops to Citrix Cloud Learning Path」を参照してください。