自動構成のトラブルシューティングと追加情報
重要:
自動構成および対応するソリューションで発生することが多いエラーメッセージについては、ナレッジセンターの記事 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のコンポーネントを開始点として使用します。All Remainingはtrueに設定されます。複数のコンポーネントが処理されます。 |
-Repeat |
CurrentComponent.txtのコンポーネントを開始点として使用します。All Remainingは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
コマンドレットを使用してログを収集し、サポートを受けるためにシトリックスに送信することもできます。このコマンドレットでは、すべてのログファイルと.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コンテンツがすべて含まれます。
依存関係に起因する問題
依存関係がないため、インポートとマージが失敗することがあります。一般的な問題には次のようなものがあります:
- グループポリシーにデリバリーグループフィルターがありません。通常の原因は、インポートされていないデリバリーグループです。
- アプリケーションがインポートまたはマージに失敗します。通常の原因は、インポートされていないデリバリーグループまたはアプリケーショングループがないことです。
- アプリケーショングループにRestrictToタグがありません。通常の原因は、インポートされていないタグです。
- ホスト接続が失敗します。通常の原因は、CvadAcSecurity.ymlファイルにセキュリティ情報がないことです。
- マシンカタログが失敗します。通常の原因は、インポートされなかったホスト接続です。
- マシンカタログおよびデリバリーグループにないマシン。通常の原因は、Active Directoryで見つからなかったマシンです。
- デリバリーグループにないユーザー。通常の原因は、Active Directoryで見つからなかったユーザーです。
推奨事項
- 一度に複数の自動構成インスタンスを実行しないでください。複数インスタンスを同時に実行すると、クラウドサイトで想定外の結果となる場合があります。これが発生したら、自動構成の1つのインスタンスを再実行して、サイトを想定した状態にします。
- 自動構成の実行中は、[管理]タブの[完全な構成]での作業またはデータ変更は行わないでください。
- マージ、インポート、または復元の結果を[完全な構成]で常に視覚的に検証して、クラウドサイトが想定どおりとなるようにしてください。
フォルダー
デフォルトのフォルダールートの場所
自動構成ツールのすべての操作は、ルートフォルダーまたはその内部のサブフォルダーで行われます。ルートフォルダーは %HOMEPATH%\Documents\Citrix\AutoConfig にあります。
エクスポート
エクスポートされたファイルはすべて、使いやすさとエクスポートの履歴を提供する2つのフォルダーに配置されます。エクスポートは常にルートフォルダーに配置されます。コピーは、エクスポート日時のExportという名前のサブフォルダーに配置されます。
ルートフォルダーには常に、エクスポートされた最新のオンプレミスサイト構成が含まれています。各Exportサブフォルダーには、示された日時に行われたエクスポートが含まれ、エクスポートの履歴が保持されます。Exportサブフォルダーを使用して、クラウドサイトを構成できます。自動構成では、既存のエクスポートサブフォルダーは削除または変更されません。
Import/Merge/Sync/Compare
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コントロールプレーンへの移行
Citrix Cloud Government環境とJapanコントロールプレーン環境では、さまざまなアクセスポイントを使用して、アクセストークンの認証と割り当てを行います。この独自の要件は、クラウドにアクセスするすべての自動構成ツールに適用されます。これらの環境で自動構成を使用するには、次の手順を実行します。
- %HOMEPATH%\Documents\Citrix\AutoConfigフォルダーにあるCustomerInfo.ymlを編集します。
-
接続する環境に応じて、次のいずれかの行をCustomerInfo.ymlに追加します(または、既に存在する場合は変更します)。
Environment: 'ProductionGov'
または
Environment: 'ProductionJP'
自動構成をこれらの環境で使用できるようになりました。
Citrix Cloudのデータ収集
Citrix Cloudが収集する情報については、「Citrix Cloudサービスの顧客コンテンツとログの処理」を参照してください。
そのほかの情報の入手先
ディスカッション フォーラム
自動構成に関するCitrix Discussionsのフォーラムにアクセスしてください。
ビデオ
YouTubeで、「Citrix Virtual Apps and Desktopsの自動構成ツールの内容」をご覧ください。
トレーニング
Cloud Learning Centerには、この記事で説明するタスクなど、サービス展開を構築する手順についてのビデオガイドがあります。Citrix Virtual Apps and DesktopsのCitrix Cloudへの移行のラーニングパスを参照してください。