Citrix DaaS™

PDFを表示

移行用自動構成ツールコマンドレット

April 6, 2026

寄稿者:

C C

このページでは、移行ユースケース向けにツールがサポートするすべてのコマンドレットとパラメーターを一覧表示します。

すべてのコマンドレットは、次のいずれかの型のパラメーターを受け取ります。
String
文字列のリスト
Boolean: $true または $false
SwitchParameter: パラメーターの存在は $true を意味し、パラメーターの不在は $false を意味します。

注:

SwitchParameter は true または false の選択に推奨される方法ですが、レガシーの問題により、ツールでは引き続きブール値が使用されます。

次の表は、すべてのコマンドレットの概要です。各コマンドレットがサポートするパラメーターについては、個々のセクションを参照してください。

カテゴリ	コマンドレット	説明
オンプレミスからクラウドへの移行	`Export-CvadAcToFile`	オンプレミスファイルを YAML ファイルにエクスポートします。
	`Import-CvadAcToSite`	YAML ファイルをクラウドにインポートします。作成、更新、および削除操作をサポートします。
	`Merge-CvadAcToSite`	YAML ファイルをクラウドにインポートします。作成および更新操作をサポートします。
	`New-CvadAcToSite`	YAML ファイルをクラウドにインポートします。作成および更新操作をサポートします。
	`Sync-CvadAcToSite`	エクスポートとインポートを 1 ステップで実行します。
	詳細な移行コンポーネントの場合、上記のコマンドでパラメーターを使用します。例: `MachineCatalogs`、`Tags`。コンポーネント名の場合、上記のコマンドでパラメーターを使用します。例: `IncludeByName`、`ExcludeByName`。	コンポーネントまたはコンポーネント名のみを選択的に移行します。
クラウドからクラウドへのコマンドレット	`Backup-CvadAcToFile`	クラウドサイトからすべての構成をバックアップします。
	`Restore-CvadAcToSite`	バックアップ YAML ファイルをクラウドサイトに復元します。このクラウドサイトは、ソースクラウドサイトと同じでも異なっていてもかまいません。
	`Remove-CvadAcFromSite`	クラウドからコンポーネントメンバーを削除します。
	詳細な移行コンポーネントの場合、上記のコマンドでパラメーターを使用します。例: `MachineCatalogs`、`Tags`。コンポーネント名の場合、上記のコマンドでパラメーターを使用します。例: `IncludeByName`、`ExcludeByName`。	コンポーネントまたはコンポーネント名のみを選択的に移行します。
その他の基本コマンドレット	`Compare-CvadAcToSite`	オンプレミスの .yml ファイルとクラウド構成を比較します。
前提条件関連コマンドレット	`New-CvadAcCustomerInfoFile`	顧客情報ファイルを作成します。
前提条件関連コマンドレット	`Set-CvadAcCustomerInfoFile`	既存の顧客情報ファイルを更新します。
サポートおよびトラブルシューティングコマンドレット	`New-CvadAcZipInfoForSupport`	すべてのログファイルと .yml ファイルを単一の zip ファイルに圧縮し、サポートのために Citrix® に送信します。
	`Get-CvadAcStatus`	接続をテストし、すべての前提条件が満たされていることを確認するために使用します。バージョン番号、クラウドとの接続、コネクターステータスなど、ツールに関する情報を返します。
	`Test-CvadAcConnectionWithSite`	クラウドサイトとの接続をテストします。
	`Find-CvadAcConnector`	既存のコネクターを特定し、その実行状態を判断します。
	`Get-CvadAcCustomerSites`	すべての顧客サイトのリストを返します。
	`New-CvadAcTemplateToFile`	選択したコンポーネントのテンプレートファイルを作成します。
	`Show-CvadAcDocument`	このドキュメントをデフォルトのブラウザーに表示します。
	`Find-CvadAcInFile`	ファイル内検索は、1つ以上の名前に一致するメンバーを検索するためにコンポーネント YAML ファイルを検索します。これらの名前にはワイルドカードが含まれる場合があります。
サイトアクティベーションコマンドレット	`Set-CvadAcSiteActiveStateOnPrem`	オンプレミスサイトの状態をアクティブまたは非アクティブに設定します。
サイトアクティベーションコマンドレット	`Set-CvadAcSiteActiveStateCloud`	クラウドサイトの状態をアクティブまたは非アクティブに設定します。

-  |\[複数のオンプレミスサイトをマージするコマンドレット]\(#merging-multiple-on-premises-sites-cmdlets)|`New-CvadAcSiteMergingInfo`|サイトマージのプレフィックス/サフィックス情報セットを作成します。| |^^|`Set-CvadAcSiteMergingInfo`|既存のサイトマージのプレフィックス/サフィックス情報セットを更新します。| |^^|`Remove-CvadAcSiteMergingInfo`|既存のサイトマージのプレフィックス/サフィックス情報セットを削除します。|

パラメーターとその使用方法の詳細については、「詳細な移行パラメーター」を参照してください。

基本コマンドレット

オンプレミスからクラウドへのコマンドレット

Export-CvadAcToFile - オンプレミスファイルを YAML ファイルにエクスポートします。

オンプレミス設定から構成をエクスポートします。これは、自動構成のデフォルトのエクスポート操作です。オンプレミスサイトの構成は変更されません。エクスポートされたファイルは、一意の名前を持つ Export サブフォルダー内のディレクトリ %HOMEPATH%\Documents\Citrix\AutoConfig に配置されます。フォルダー %HOMEPATH%\Documents\Citrix\AutoConfig には、常に最新のエクスポートされたオンプレミスサイト構成が含まれています。
- パラメーター:
名前説明必須? 型

|—|—|—|—|

コンポーネントによる移行	コンポーネントによる移行を参照してください。
オブジェクト名によるフィルタリング	オブジェクト名によるフィルタリングを参照してください。
`TargetFolder`	エクスポート先のフォルダーを指定します。
`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。
`Quiet`	コンソールへのログ出力を抑制します。
`AdminAddress`	エクスポートが Delivery Controller で実行されていない場合に、Delivery Controller の DNS または IP アドレスを指定します。

`CheckUserAndMachines`	ユーザーとマシンが Active Directory に存在するかどうかを確認します。Active Directory に存在しないユーザーとマシンは、インポートの失敗につながる可能性があります。
`ZipResults`	バックアップされた YAML ファイルを単一の zip ファイルに圧縮します。ファイルはバックアップされた YAML ファイルと同じフォルダーにあり、フォルダーと同じ名前です。

戻り値:

コマンドレットの戻り値を参照してください。

クラウドにデータをインポートする方法は 3 つあります。特定のコマンドレットを実行すると、クラウドサイトで次の 3 つのアクションの組み合わせのいずれかが発生する可能性があります。

追加、更新、および削除
- 追加と更新のみ
追加のみ

コマンドレット	追加	更新	削除
Import	X	X	X
Merge	X	X

-  | New | X | | |

Import-CvadAcToSite - YAML ファイルをクラウドにインポートします。作成、更新、および削除操作をサポートします。

すべてのオンプレミスファイルをクラウドにインポートします。このコマンドは、クラウドの最終状態がオンプレミスの状態と同一であることを保証します。このオプションは、クラウドに存在する変更をすべて削除します。インポートされたサイト構成ファイルは、%HOMEPATH%\Documents\Citrix\AutoConfig から取得されます。注意して使用してください。

パラメーター:

名前	説明	型
コンポーネントによる移行	コンポーネントによる移行を参照してください。	SwitchParameters
オブジェクト名によるフィルタリング	オブジェクト名によるフィルタリングを参照してください。	文字列のリスト
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください。	SwitchParameters
`SourceFolder`	%HOMEPATH%\Documents\Citrix\AutoConfig の代替ルートフォルダーを識別します。	String
`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。	String
`Quiet`	コンソールへのログ出力を抑制します。	SwitchParameter
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには `$false` に設定します。	`$true` または `$false`
`Merge`	`$true` に設定すると、コンポーネントがクラウドサイトに追加されるだけです。コンポーネントは削除されません。コンポーネントを削除するには `$false` に設定します。	`$true` または `$false`

AddOnly $true に設定すると、新しいコンポーネントのみが追加され、既存のコンポーネントは更新または削除されません。更新と削除を許可するには $false に設定します。このパラメーターが $true の場合、Merge は無視されます。

`MergePolicies`	ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCに既に存在する場合にのみ行われます。ポリシーをマージすると、クラウドDDCポリシーには、既に持っていた設定とフィルターに加えて、インポートされる新しい設定とフィルターが含まれるようになります。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。
`OnErrorAction`	`[OnErrorAction パラメーター](/ja-jp/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter)` を参照してください。

戻り値:

-  [Cmdlet の戻り値](#cmdlet-return-values)を参照してください。

Merge-CvadAcToSite - YAMLファイルをクラウドにインポートします。作成および更新操作をサポートします。

オンプレミスファイルをクラウドにマージしますが、クラウドまたはオンプレミスサイトのコンポーネントを削除することはありません。これにより、クラウドで既に行われた変更が保持されます。Citrix Cloudに同じ名前のコンポーネントが存在する場合、このコマンドはそのコンポーネントを変更できます。これは、自動構成のデフォルトのインポート操作です。マージされたサイト構成ファイルは、%HOMEPATH%\Documents\Citrix\AutoConfig から取得されます。

パラメーター:

|名前|説明|必須?|種類|
- |—|—|—|—|

コンポーネントによる移行	コンポーネントによる移行を参照してください。
オブジェクト名によるフィルタリング	オブジェクト名によるフィルタリングを参照してください。
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください。
`SourceFolder`	%HOMEPATH%\Documents\Citrix\AutoConfig の代替ルートフォルダーを識別します。
`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。
`Quiet`	コンソールへのログ出力を抑制します。
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには `$false` に設定します。
`Merge`	`$true` に設定すると、コンポーネントをクラウドサイトに追加するだけです。コンポーネントは削除されません。コンポーネントを削除するには `$false` に設定します。
`AddOnly`	`$true` に設定すると、新しいコンポーネントのみを追加し、既存のコンポーネントを更新または削除しません。更新と削除を許可するには `$false` に設定します。このパラメーターが `$true` の場合、`Merge` は無視されます。
`MergePolicies`	ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCにすでに存在する場合にのみ行われます。ポリシーをマージした結果、クラウドDDCポリシーには、すでに持っていた設定とフィルターに加えて、新しくインポートされる設定とフィルターが含まれます。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。
`OnErrorAction`	OnErrorAction パラメーターを参照してください。

戻り値:

Cmdlet の戻り値を参照してください。

New-CvadAcToSite - YAMLファイルをクラウドにインポートします。作成および更新操作をサポートします。

オンプレミスサイト構成をクラウドにインポートしますが、新しいコンポーネントのみを追加します。既存のクラウドサイトコンポーネントは更新も削除もされません。既存のクラウドサイトコンポーネントを変更しないでおく必要がある場合は、このコマンドを使用してください。

パラメーター:

名前	説明	種類
コンポーネントによる移行	コンポーネントによる移行を参照してください。	SwitchParameters
オブジェクト名によるフィルタリング	オブジェクト名によるフィルタリングを参照してください。	List of strings
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください。	SwitchParameters
`SourceFolder`	%HOMEPATH%\Documents\Citrix\AutoConfig の代替ルートフォルダーを識別します。	String
`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。	String
`Quiet`	コンソールへのログ出力を抑制します。	SwitchParameter
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには `$false` に設定します。	`$true` または `$false`
`OnErrorAction`	OnErrorAction パラメーターを参照してください。	String

戻り値:
- Cmdlet の戻り値を参照してください。

Sync-CvadAcToSite - エクスポートとインポートを1ステップで実行します。

Syncは、エクスポートとインポートの両方を1ステップで実行します。エクスポート/インポート先のフォルダーを指定するには、SourceTargetFolderパラメーターを使用します。

パラメーター:

名前	説明	種類
コンポーネントによる移行	コンポーネントによる移行を参照してください。	SwitchParameters
オブジェクト名によるフィルタリング	オブジェクト名によるフィルタリングを参照してください。	List of strings
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください。	SwitchParameters
`SourceTargetFolder`	エクスポート/インポート先のフォルダーを指定します。	String
`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。	String

AdminAddress エクスポートがデリバリーコントローラーで実行されていない場合に、デリバリーコントローラーのDNSまたはIPアドレスを指定します。

`Quiet`	コンソールへのログ出力を抑制します。
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには `$false` に設定します。
`Merge`	`$true` に設定すると、コンポーネントをクラウドサイトに追加するだけです。コンポーネントは削除されません。コンポーネントを削除するには `$false` に設定します。
`AddOnly`	`$true` に設定すると、新しいコンポーネントのみを追加し、既存のコンポーネントを更新または削除しません。更新と削除を許可するには `$false` に設定します。このパラメーターが `$true` の場合、`Merge` は無視されます。
`MergePolicies`	ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCにすでに存在する場合にのみ行われます。ポリシーをマージした結果、クラウドDDCポリシーには、すでに持っていた設定とフィルターに加えて、新しくインポートされる設定とフィルターが含まれます。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。

戻り値:

Cmdlet の戻り値を参照してください。

クラウド間コマンドレット

Backup-CvadAcToFile - クラウドサイトからすべての構成をバックアップします。

クラウド構成を.ymlファイルにエクスポートします。このバックアップは、バックアップおよび復元プロセスで失われたコンポーネントを復元するために使用できます。

パラメーター:

名前	説明	種類
コンポーネントによる移行	コンポーネントによる移行を参照してください。	SwitchParameters
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください。	SwitchParameters
`TargetFolder`	エクスポート先のフォルダーを指定します。	String
`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。	String
`Quiet`	コンソールへのログ出力を抑制します。	SwitchParameter
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには `$false` に設定します。	`$true` または `$false`
`ZipResults`	バックアップされたYAMLファイルを単一のzipファイルに圧縮します。ファイルはバックアップされたYAMLファイルと同じフォルダーにあり、フォルダーと同じ名前です。	SwitchParameter

戻り値:

コマンドレットの戻り値を参照してください。
Restore-CvadAcToSite - バックアップYAMLファイルをクラウドサイトに復元します。このクラウドサイトは、ソースクラウドサイトと同じでも異なっていてもかまいません。
クラウドサイトを以前の構成に復元します。インポートされたファイルは、-RestoreFolderパラメーターを使用して指定されたフォルダーから取得されます。このパラメーターは、クラウドサイトに復元する.ymlファイルを含むフォルダーを識別します。これは完全修飾フォルダー指定である必要があります。このコマンドレットは、以前の構成に戻すため、またはクラウドサイトのバックアップと復元のために使用できます。このコマンドは、クラウドサイトの追加、削除、および更新を行うことができます。
パラメーター:
名前説明必須? タイプ
|—|—|—|—|
コンポーネントによる移行コンポーネントによる移行を参照してください。

オブジェクト名によるフィルタリング

オブジェクト名によるフィルタリングを参照してください。

クラウドアクセスパラメータークラウドアクセスパラメーターを参照してください。

RestoreFolder クラウドサイトに復元する.ymlファイルを含むフォルダーを識別します。これは完全修飾フォルダー指定である必要があります。

`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。
`Quiet`	コンソールへのログ出力を抑制します。
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには`$false`に設定します。
`Merge`	`$true`に設定すると、コンポーネントのみがクラウドサイトに追加されます。コンポーネントは削除されません。コンポーネントを削除するには`$false`に設定します。
`AddOnly`	`$true`に設定すると、新しいコンポーネントのみが追加され、既存のコンポーネントは更新または削除されません。更新と削除を許可するには`$false`に設定します。このパラメーターが`$true`の場合、`Merge`は無視されます。

MergePolicies ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCにすでに存在する場合にのみ発生します。ポリシーをマージした結果、クラウドDDCポリシーには、既存の設定とフィルターに加えて、インポートされる新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。

OnErrorAction OnErrorActionパラメーターを参照してください。

戻り値:
- コマンドレットの戻り値を参照してください。
Remove-CvadAcFromSite – クラウドからコンポーネントメンバーを削除します。

サイト全体をリセットしたり、コンポーネントからメンバー項目を削除したりできます（たとえば、カタログのリストから1つのマシンカタログを削除するなど）。これは、IncludeByNameパラメーターと組み合わせて使用することで、特定のメンバーを選択的に削除できます。

パラメーター:

名前	説明	必須?	タイプ
コンポーネントによる移行	コンポーネントによる移行を参照してください。		SwitchParameters
オブジェクト名によるフィルタリング	オブジェクト名によるフィルタリングを参照してください。		List of strings

クラウドアクセスパラメータークラウドアクセスパラメーターを参照してください。

`Quiet`	コンソールへのログ出力を抑制します。
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには`$false`に設定します。

戻り値:

コマンドレットの戻り値を参照してください。

その他の基本コマンドレット

Compare-CvadAcToSite - オンプレミスの.ymlファイルをクラウド構成と比較し、Import、Merge、またはRestoreコマンドレットによって行われた変更のレポートを生成します。

パラメーター:

名前	説明	タイプ
コンポーネントによる移行	コンポーネントによる移行を参照してください。	SwitchParameters
オブジェクト名によるフィルタリング	オブジェクト名によるフィルタリングを参照してください。	List of strings
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください。	SwitchParameters
`SourceFolder`	`%HOMEPATH%\Documents\Citrix\AutoConfig`の代替ルートフォルダーを識別します。	String
`Locale`	エクスポート可能な人間が判読できるテキストの言語を指定します。	String
`Quiet`	コンソールへのログ出力を抑制します。	SwitchParameter
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには`$false`に設定します。	`$true`または`$false`
`Merge`	`$true`に設定すると、コンポーネントのみがクラウドサイトに追加されます。コンポーネントは削除されません。コンポーネントを削除するには`$false`に設定します。	`$true`または`$false`
`AddOnly`	`$true`に設定すると、新しいコンポーネントのみが追加され、既存のコンポーネントは更新または削除されません。更新と削除を許可するには`$false`に設定します。このパラメーターが`$true`の場合、`Merge`は無視されます。	`$true`または`$false`
`OnErrorAction`	OnErrorActionパラメーターを参照してください。	String

戻り値:
- コマンドレットの戻り値を参照してください。

詳細な移行パラメーター

コンポーネントによる移行

以下のコンポーネントは、それらをサポートするコマンドレットで指定できます。コンポーネントパラメーターが指定されていない場合、Allオプションが自動的に選択されます。エラーを避けるため、コンポーネントを以下の順序で移行することをお勧めします。

All
- Tags
AdminRoles
- AdminScopes
HostConnections
- MachineCatalogs
StoreFronts
- DeliveryGroups
- ApplicationGroups
ApplicationFolders
- Applications
GroupPolicies
- UserZonePreference

オブジェクト名によるフィルタリング

コンポーネント名による移行

IncludeByName および ExcludeByName パラメーターを使用すると、コマンドレットでコンポーネントメンバーを名前で含めたり除外したりできます。サポートされているいずれかのコマンドレットでは、一度に 1 つのコンポーネント (たとえば、デリバリーグループ) のみを選択できます。コンポーネントメンバーが両方の領域にある場合、除外は他のすべてのパラメーターを上書きし、除外されたコンポーネントとメンバー名を特定するエントリがログ修正リストに作成されます。

IncludeByName および ExcludeByName は、コンポーネントメンバー名のリストを受け取ります。任意の名前には、1 つ以上のワイルドカードを含めることができます。2 種類のワイルドカードがサポートされています。メンバー名に特殊文字が含まれている場合、コンポーネントメンバー名のリストは単一引用符で囲む必要があります。

-  \* 任意の数の文字に一致します

? 1 文字に一致します

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

名前が DgSite1 で始まり Home2 を含むすべてのデリバリーグループをマージする例は、次のように記述されます。

Merge-CvadAcToSite –DeliveryGroups –IncludeByName DgSite1*,*Home2*

デリバリーグループ名によるフィルタリング

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

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

* 任意の数の文字に一致します
- ? 1 文字に一致します
次の例は、EastDg で始まるすべてのデリバリーグループ名を参照するすべてのアプリケーションをマージします。

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

無効なものの除外

ExcludeDisabled は、無効になっているすべてのアプリケーションおよびアプリケーショングループをインポート操作から除外します。ExcludeDisabled のデフォルトは false であり、これはすべてのアプリケーションおよびアプリケーショングループが有効状態に関係なくインポートされることを意味します。

マシン名によるフィルタリング

-  `ByMachineName` は、マシンカタログおよびデリバリーグループのマシン名でフィルタリングします。このパラメーターは常に、マシン名の関連付けに基づいて含めるメンバーを識別する包含リストです。

-  `ByMachineName` は、任意の名前が 1 つ以上のワイルドカードを含むマシン名のリストを受け取ります。2 種類のワイルドカードがサポートされています。

* 任意の数の文字に一致します
- ? 1 文字に一致します

エクスポートまたはインポート時に ByMachineName を使用し、マシン名フィルターの結果、マシンカタログまたはデリバリーグループにマシンがない場合、そのマシンカタログまたはデリバリーグループはエクスポートまたはインポートから除外されます。

注記: - > - > 任意のインポートタイプのコマンドレットで ByMachineName を使用すると、MergeMachines が $true に設定されます。

マシンのマージ

-  `MergeMachines` が `$true` に設定されている場合、インポート操作はマシンをマシンカタログまたはデリバリーグループにのみ追加するように指示します。マシンは削除されないため、増分追加操作が可能です。

MergeMachines はデフォルトで false に設定されており、これはマシンカタログまたはデリバリーグループの .yml ファイルに存在しないマシンが削除されることを意味します。ByMachineName が使用される場合、MergeMachines は $true に設定されますが、MergeMachines を false に設定することで上書きできます。

前提条件関連のコマンドレット

New-CvadAcCustomerInfoFile - 顧客情報ファイルを作成します。デフォルトでは、顧客情報ファイルは %HOMEPATH%\Documents\Citrix\AutoConfig にあります。

パラメーター:

名前	説明	必須?	型
`CustomerId`	顧客のID。	x	String

`ClientId`	Citrix Cloudで作成された顧客のクライアントID。このパラメーターを使用する場合は、CustomerIdとSecretを指定する必要があります。	条件付き	String
`Secret`	Citrix Cloudで作成された顧客のシークレットキー。このパラメーターを使用する場合は、CustomerIdとClientIdを指定する必要があります。	条件付き	String
`Environment`	Production、ProductionGov、またはProductionJP環境。		Enumeration

`LogFileName`	ログファイルプレフィックスをCitrixLogから別のものに変更します。
`AltRootUrl`	Citrixの指示がある場合にのみ使用します。
`StopOnError`	最初のエラーで操作を停止します。
`TargetFolder`	%HOMEPATH%\Documents\Citrix\AutoConfig の代わりに、指定されたフォルダーをルートフォルダーとして使用します。
`Locale`	ツールが実行されているシステムから派生したロケールの代わりに、指定されたロケールを使用します。
`Editor`	各コマンドレットの完了時にログを表示するために指定されたエディターを使用します。Notepad.exeがデフォルトのエディターです。このパラメーターには、エディターへの完全修飾ファイル指定を含める必要があり、エディターはログファイル指定を唯一のパラメーターとして受け入れる必要があります。
`SecurityCsvFileSpec`	Citrix Identity and Access ManagementからダウンロードされたSecurityClient.csvファイルを指す完全修飾ファイル指定。このパラメーターを使用する場合は、CustomerIdを指定する必要があります。

戻り値:

コマンドレットの戻り値を参照してください。

Set-CvadAcCustomerInfoFile - 既存の顧客情報ファイルを更新します。コマンドレットで指定されたパラメーターのみが変更されます。CustomerInfo.ymlファイル内の指定されていないすべてのパラメーター値は変更されません。

パラメーター:

名前	説明	型
`CustomerId`	顧客のID。	String
`ClientId`	Citrix Cloudで作成された顧客のクライアントID。	String
`Secret`	Citrix Cloudで作成された顧客のシークレットキー。	String
`Environment`	Production、ProductionGov、またはProductionJP環境。	Enumeration
`LogFileName`	ログファイルプレフィックスをCitrixLogから別のものに変更します。	String

`StopOnError`	最初のエラーで操作を停止します。
`TargetFolder`	%HOMEPATH%\Documents\Citrix\AutoConfig の代わりに、指定されたフォルダーをルートフォルダーとして使用します。
`Locale`	ツールが実行されているシステムから派生したロケールの代わりに、指定されたロケールを使用します。

`Editor`	各コマンドレットの完了時にログを表示するために指定されたエディターを使用します。Notepad.exeがデフォルトのエディターです。このパラメーターには、エディターへの完全修飾ファイル指定を含める必要があり、エディターはログファイル指定を唯一のパラメーターとして受け入れる必要があります。
`SecurityCsvFileSpec`	Citrix Identity and Access ManagementからダウンロードされたSecurityClient.csvファイルを指す完全修飾ファイル指定。このパラメーターを使用する場合は、CustomerIdを指定する必要があります。

戻り値:

コマンドレットの戻り値を参照してください。

前提条件関連のパラメーター

クラウドアクセスパラメーターに加えて、以下のパラメーターを前提条件関連のコマンドレットで使用できます。
Environment – ProductionまたはProductionGov環境。
LogFileName – ログファイルプレフィックスをCitrixLogから別のものに変更します。
StopOnError – 最初のエラーで操作を停止します。
AlternateRootFolder – %HOMEPATH%\Documents\Citrix\AutoConfig の代わりに、指定されたフォルダーをルートフォルダーとして使用します。
Locale – ツールが実行されているシステムから派生したロケールの代わりに、指定されたロケールを使用します。
Editor – 各コマンドレットの完了時にログを表示するために指定されたエディターを使用します。Notepad.exeがデフォルトのエディターです。このパラメーターには、エディターへの完全修飾ファイル指定を含める必要があり、エディターはログファイル指定を唯一のパラメーターとして受け入れる必要があります。

サポートおよびトラブルシューティングコマンドレット

New-CvadAcZipInfoForSupport - すべてのログファイルと.ymlファイルを単一のzipファイルに圧縮し、サポートのためにCitrixに送信します。顧客の機密情報（CustomerInfo.ymlおよびCvadAcSecurity.yml）はzipに含まれません。Icon.ymlファイルもサイズが大きいため除外されます。zipファイルは %HOMEPATH%\Documents\Citrix\AutoConfig に配置され、日付とタイムスタンプに基づいて CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip という名前が付けられます。このzipファイルはバックアップとしても機能します。
- パラメーター:
名前説明必須? 型
|–|–|–|–|
TargetFolder zipファイルを作成して保存するターゲットフォルダーを指定します。
Quiet コンソールへのログ出力を抑制します。
戻り値:
- zipファイル名と場所を含むzipファイルがコマンドプロンプトに表示されます。
Get-CvadAcStatus - 接続をテストし、すべての前提条件が満たされていることを確認するために使用します。バージョン番号、クラウドとの接続、コネクターの状態など、ツールに関する情報を返します。
パラメーター:
名前説明必須? 型
|–|–|–|–|
Cloud-accessing parameters クラウドアクセスパラメーターを参照してください。
SiteId 接続するサイトを識別します。

AdminAddress これは、管理者のアクセスレベルを確認するために使用されるオンプレミスのデリバリーコントローラーのDNSまたはIPアドレスです。ツールがデリバリーコントローラーで実行されていない場合に必要です。

戻り値:
各項目の結果を表示します。
Test-CvadAcConnectionWithSite – クラウドサイトとの接続をテストし、通信接続が機能していることを確認します。このコマンドレットは、クラウドアクセスパラメーターまたは CustomerInfo.yml ファイルを使用して、顧客の接続情報を指定します。
パラメーター:

名前	説明	必須?	型
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください		SwitchParameters
`Quiet`	コンソールへのログ出力を抑制します。		SwitchParameter

戻り値:

テスト結果がコマンドラインに表示されます。

Find-CvadAcConnector - 既存のコネクタを検索し、その実行状態を判断します。このコマンドレットは、CustomerInfo.yml ファイルまたは顧客 ID パラメーターの情報を使用して、顧客のコネクタを検索します。

パラメーター:
名前説明必須? 型
|–|–|–|–|

CustomerInfoFileSpec デフォルトの場所と名前を上書きする顧客情報ファイルを指すファイル指定。このパラメーターは、CustomerId パラメーターが指定されている場合は無視されます。

CustomerId 顧客の ID。このパラメーターは、CustomerInfo.yml ファイル内の同じ値を上書きします。
戻り値:
- 結果がコマンドラインに表示されます。
Get-CvadAcCustomerSites - すべての顧客サイトのリストを返します。このコマンドレットは、クラウドアクセスパラメーターまたは CustomerInfo.yml ファイルを使用して、顧客の接続情報を指定します。

パラメーター:
- クラウドアクセスパラメーターを参照してください
戻り値:
- 見つかった顧客サイト ID のリストを表示します。

New-CvadAcTemplateToFile – 選択したコンポーネントのテンプレートファイルを作成し、インポートファイルを手動で作成できるようにします。

パラメーター:

名前	説明	必須?	型
コンポーネントごとの移行	コンポーネントごとの移行を参照してください		SwitchParameters
`TargetFolder`	エクスポート先のフォルダーを指定します。		String

戻り値:

コマンドレットの戻り値を参照してください

Show-CvadAcDocument - このドキュメントをデフォルトのブラウザーに表示します。

パラメーター:
- なし
戻り値:
- このWebページをデフォルトのWebブラウザに表示します

Find-CvadAcInFile - ファイル内検索は、ワイルドカードを含む1つ以上の名前に一致するメンバーを検索するために、コンポーネントのYAMLファイルを検索します。結果は、見つかったメンバーのレポートです。ファイル内検索は、一度に1つのコンポーネントのみを検索できます。ファイル内検索は、現在のフォルダーおよびすべてのサブフォルダー内のすべてのYAMLファイルを検索します。検索するファイルの数を制限するには、FindSourceFolder を使用します。

パラメーター:

名前	説明	型
コンポーネントによる移行	コンポーネントによる移行を参照してください。注: `-All` の値は無効です。	SwitchParameters
`IncludeByName`	サイトのアクティブ状態をアクティブに設定する際に含めるデリバリーグループの名前を指定するリストです。名前に「*」および「?」のワイルドカードがサポートされています。	文字列のリスト
`Unique`	一意に見つかったメンバーのみをレポートします。	SwitchParameter
`IncludeYaml`	メンバー固有のYAMLを含めます。	SwitchParameter
`FindSourceFolder`	検索を開始するフォルダーです。	String
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、`$false` に設定します。	SwitchParameter
`Quiet`	コンソールへのログ記録を抑制します。	SwitchParameter

戻り値:

指定されたコンポーネントについて、見つかったメンバーを含むレポートを作成します

サイトアクティベーションコマンドレット

サイトのアクティベーションとこれらのコマンドレットの使用方法の詳細については、サイトのアクティベーションを参照してください。

Set-CvadAcSiteActiveStateOnPrem - オンプレミスサイトの状態をアクティブまたは非アクティブに設定します。

パラメーター:

名前	説明	型
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください	SwitchParameters
`SiteActive`	このパラメーターが存在する場合、オンプレミスサイトをアクティブに設定し、すべてのデリバリーグループからメンテナンスモードを削除します。このパラメーターが存在しない場合、すべてのデリバリーグループにメンテナンスモードが設定されます。	SwitchParameter
`IncludeByName`	サイトのアクティブ状態をアクティブに設定する際に含めるデリバリーグループの名前を指定するリストです。名前に「*」および「?」のワイルドカードがサポートされています。	文字列のリスト
`ExcludeByName`	サイトのアクティブ状態をアクティブに設定する際に除外するデリバリーグループの名前を指定するリストです。名前に「*」および「?」のワイルドカードがサポートされています。	文字列のリスト
`Quiet`	コンソールへのログ記録を抑制します。	SwitchParameter
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、`$false` に設定します。	`$true または $false`

戻り値:

コマンドレットの戻り値を参照してください

Set-CvadAcSiteActiveStateCloud - クラウドサイトの状態をアクティブまたは非アクティブに設定します。

パラメーター:

名前	説明	型
クラウドアクセスパラメーター	クラウドアクセスパラメーターを参照してください	SwitchParameters
`SiteActive`	このパラメーターが存在する場合、クラウドサイトをアクティブに設定し、すべてのデリバリーグループからメンテナンスモードを削除します。このパラメーターが存在しない場合、すべてのデリバリーグループにメンテナンスモードが設定されます。	SwitchParameter
`IncludeByName`	サイトのアクティブ状態をアクティブに設定する際に含めるデリバリーグループの名前を指定するリストです。名前に「*」および「?」のワイルドカードがサポートされています。	文字列のリスト
`ExcludeByName`	サイトのアクティブ状態をアクティブに設定する際に除外するデリバリーグループの名前を指定するリストです。名前に「*」および「?」のワイルドカードがサポートされています。	文字列のリスト
`Quiet`	コンソールへのログ記録を抑制します。	SwitchParameter
`DisplayLog`	コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、`$false` に設定します。	`$true または $false`

戻り値:

コマンドレットの戻り値を参照してください

複数のオンプレミスサイトのマージコマンドレット

サイトのマージとこれらのコマンドレットの使用方法の詳細については、複数のサイトを単一サイトにマージするを参照してください。

New-CvadAcSiteMergingInfo - サイトマージのプレフィックス/サフィックス情報セットを作成します。最初からすべてのプレフィックスまたはサフィックスを知っている必要はありません。これらは、Set-CvadAcSiteMergingInfo を使用するか、SiteMerging.yml ファイルを手動で編集することで更新できます。パラメーター:

名前	説明	必須	型
`SiteName`	特定のサイトのプレフィックス/サフィックスのセットを識別するために使用される名前です。実際のサイトの名前と一致してもかまいませんが、一致する必要はありません。	x	String
サイトマージパラメーター	サイトマージパラメーターを参照してください		SwitchParameters
`Quiet`	コンソールへのログ記録を抑制します。		SwitchParameter

戻り値:

なし

Set-CvadAcSiteMergingInfo - 既存のサイトマージのプレフィックス/サフィックス情報セットを更新します。

パラメーター:

名前	説明	必須?	タイプ
`SiteName`	特定のサイトのプレフィックス/サフィックスのセットを識別するために使用される名前。実際のサイト名と一致してもよいし、一致しなくてもよい。	x	String
サイトマージパラメーター	サイトマージパラメーターを参照してください。		SwitchParameters
`Quiet`	コンソールへのログ出力を抑制します。		SwitchParameter

戻り値:

なし

Remove-CvadAcSiteMergingInfo - 既存のサイトマージのプレフィックス/サフィックス情報セットを削除します。

パラメーター:
- SiteName – サイトのプレフィックスとサフィックスのセットを識別します。これは文字列であり、必須です。
戻り値:
- なし

サイトマージパラメーター

サイトマージコマンドレットの実行時に、以下のパラメーターを使用できます。リストされているすべてのパラメーターは文字列です。

SiteName – 特定のサイトのプレフィックス/サフィックスのセットを識別するために使用される名前。実際のサイト名と一致してもよいし、一致しなくてもよい。SiteName は必須パラメーターです。
AdminScopedPrefix – 管理者スコープに適用するプレフィックス。
ApplicationPrefix - アプリケーションに適用するプレフィックス。
ApplicationFolderPrefix – アプリケーションフォルダーに適用するプレフィックス。ApplicationFolderPrefix は ApplicationFolderRoot と組み合わせることができます。
ApplicationFolderRoot – アプリケーションフォルダーの新しいルートフォルダー。これにより、追加のフォルダー階層が作成されます。ApplicationFolderRoot は ApplicationFolderPrefix と組み合わせることができます。
ApplicationGroupPrefix – アプリケーショングループのプレフィックス。
ApplicationUserPrefix – ユーザーに表示されるアプリケーション名に適用するプレフィックス。
ApplicationAdminPrefix – 管理者に表示されるアプリケーション名に適用するプレフィックス。
DeliveryGroupPrefix – デリバリーグループに適用するプレフィックス。
GroupPolicyPrefix – ポリシー名に適用するプレフィックス。
HostConnectionPrefix – ホスト接続に適用するプレフィックス。
MachineCatalogPrefix – マシンカタログに適用するプレフィックス。
StoreFrontPrefix – StoreFront™ 名に適用するプレフィックス。
TagPrefix – タグに適用するプレフィックス。
AdminScopedSuffix – 管理者スコープに適用するサフィックス。
ApplicationSuffix - アプリケーションに適用するサフィックス。
ApplicationFolderSuffix – アプリケーションフォルダーに適用するサフィックス。ApplicationFolderSuffix は ApplicationFolderRoot と組み合わせることができます。
ApplicationGroupSuffix – アプリケーショングループのサフィックス。
ApplicationUserSuffix – ユーザーに表示されるアプリケーション名に適用するサフィックス。
ApplicationAdminSuffix – 管理者に表示されるアプリケーション名に適用するサフィックス。
DeliveryGroupSuffix – デリバリーグループに適用するサフィックス。
GroupPolicySuffix – ポリシー名に適用するサフィックス。
HostConnectionSuffix – ホスト接続に適用するサフィックス。
MachineCatalogSuffix – マシンカタログに適用するサフィックス。
StoreFrontSuffix – StoreFront 名に適用するサフィックス。
TagSuffix – タグに適用するサフィックス。
SiteRootFolder – エクスポートおよびインポートに使用する完全修飾フォルダー名。これはローカルフォルダーまたはファイル共有にすることができます。

汎用パラメーター

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

クラウドにアクセスするすべてのコマンドレットは、以下の追加パラメーターをサポートしています。

注:

CustomerId、ClientId、および Secret は、CustomerInfo.yml ファイルに配置するか、以下のパラメーターを使用してコマンドレットで指定できます。両方の場所で指定されている場合、コマンドレットパラメーターが優先されます。

CustomerId – Rest API で使用される顧客 ID であり、すべての Rest API にアクセスするために必要です。顧客 ID は Citrix Cloud で確認できます。
ClientId – Citrix Cloud Identity and Access Management Web サイトで作成されたクライアント ID。これは、すべての Rest API の認証に必要なベアラートークンを取得するために必要です。
Secret – Citrix Cloud Identity and Access Management Web サイトで作成されたシークレットキー。これは、すべての Rest API の認証に必要なベアラートークンを取得するために必要です。
CustomerInfoFileSpec – デフォルトの場所と名前を上書きするために顧客情報ファイルを指すファイル仕様。

移行モードパラメーター

クラウドサイト構成を変更するコマンドレット (Import、Restore、Merge、New、および Sync) は、さらなる柔軟性を提供するために以下の追加パラメーターをサポートしています。

CheckMode – インポート操作を実行しますが、変更は行いません。予想されるすべての変更は、インポートが完了する前に報告されます。このコマンドを使用して、インポートを実行する前にテストできます。
BackupFirst – クラウド構成を変更する前に、クラウドコンテンツを .yml ファイルにバックアップします。これはデフォルトで有効になっています。
Confirm – true の場合、クラウドサイト構成に変更を加えることをユーザーに確認するプロンプトを表示します。Remove コマンドレットは、その破壊的な性質のためプロンプトを表示します。自動化されたスクリプト内で実行する場合など、プロンプトが不要な場合は false に設定します。Confirm はデフォルトで true です。
SecurityFileFolder – CustomerInfo.yml ファイルを含む完全修飾フォルダー。これは、ローカルフォルダーまたは認証制御下にある可能性のあるネットワーク共有フォルダーを指す場合があります。このツールは資格情報を要求しません。ツールを実行する前に、制御されたリソースへのアクセスを取得する必要があります。
SiteName – インポート時に使用するサイトマージのプレフィックスとサフィックスのセットを指定します。
SiteActive – インポートされたサイトがアクティブか非アクティブかを指定します。デフォルトでは、このパラメーターは $false に設定されており、インポートされたサイトは非アクティブであることを意味します。

ログ表示パラメーター

Export、Import、Sync、Restore、Backup、Compare、および Remove コマンドレットは、操作が完了するとログファイルを表示します。-DisplayLog パラメーターを $false に設定することで、表示を抑制できます。ログファイルの表示には、デフォルトで Notepad.exe が使用されます。CustomerInfo.yml ファイルで別のエディターを指定できます。

Editor: C:\Program Files\Notepad++\notepad++.exe

Cmdlet の戻り値

ActionResult

すべての Cmdlet は次の値を返します。

            public class ActionResult
            {
                public bool                         Overall_Success;
                public Dictionary<string, string>   Individual_Success;
                public object                       CustomResult;
            }

Overall_Success は、選択されたすべてのコンポーネントにおける Cmdlet の全体的な成功を示す単一のブール値を返します。true は成功、false は失敗を意味します。

Individual_Success は、各主要コンポーネントに対して 1 つまたは 3 つの値を返します。コンポーネントの結果は、Success、Failure、または Skipped のいずれかになります。Skipped は、そのコンポーネントが Cmdlet による実行のために選択されなかったことを示します。

CustomResult は Cmdlet 固有です。

CustomResult

Import、Merge、Restore、Sync、Compare、Compare File、および Remove は、EvaluationResultData の単一インスタンスに次のカスタム結果情報を返します。

注:

Export および Template Cmdlet はカスタム結果を返しません。

                public class EvaluationResultData
                {
                    public Dictionary<string, Dictionary<string, ActionResultValues >> EvaluationResults;
                    public int                  Added;
                    public int                  Updated;
                    public int                  Deleted;
                    public int                  NoChange;
                    public int                  TotalChanged;
                    public EvaluationResults     OverallResult;
                    public string               CloudBackupFolder;
                    public string               SourceBackupFolder;
                }
                Where:
                public enum ActionResultValues
               {
                    Add,
                    Update,
                    Delete,
                    Identical,
                    DoNothing
                }
                public enum EvaluationResults
                {
                    Success,
                    Failure,
                    Skipped
                }

EvaluationResults は、選択されたコンポーネントごとに 1 つのエントリを持つリストを表示します。キーはコンポーネント名で、値は各コンポーネントメンバーと、そのコンポーネントメンバーに対して実行されたアクションのリストです。アクションは、ActionResultValues のいずれかの値になります。

Added、Updated、Deleted、および NoChange は、追加、更新、削除、またはアクションなしのコンポーネントメンバーの総数をこの順序で示します。

TotalChanged は、Added、Updated、および Deleted の合計です。

OverallResult は、Cmdlet の結果を示す単一のブール値です。true はすべてのコンポーネントにおける完全な成功を示し、false は 1 つ以上のコンポーネントの処理における失敗を示します。

CloudBackupFolder は、Cmdlet がクラウド変更アクションを実行する前のクラウドサイト構成バックアップの完全修飾ファイル指定です。

SourceBackupFolder は、Cmdlet の完了後に作成されたソースファイルバックアップの完全修飾ファイル指定です。既定では、これらのファイルは %HOMEPATH%\Documents\Citrix\AutoConfig にあります。

PowerShell ヘルプ

各 Cmdlet で PowerShell ヘルプを利用できます。すべてのパラメーターは、Cmdlet の簡単な説明とともに各 Cmdlet に文書化されています。任意の Cmdlet のヘルプにアクセスするには、Get-Help を Cmdlet の前にタイプします。

Get-Help Import-CvadAcToSite

このコンテンツの正式なバージョンは英語で提供されています。Cloud Software Groupドキュメントのコンテンツの一部は、お客様の利便性のみを目的として機械翻訳されています。Cloud Software Groupは機械翻訳されたコンテンツを管理していないため、誤り、不正確な情報、不適切な用語が含まれる場合があります。英語の原文から他言語への翻訳について、精度、信頼性、適合性、正確性、またはお使いのCloud Software Group製品またはサービスと機械翻訳されたコンテンツとの整合性に関する保証、該当するライセンス契約書またはサービス利用規約、あるいはCloud Software Groupとのその他すべての契約に基づき提供される保証、および製品またはサービスのドキュメントとの一致に関する保証は、明示的か黙示的かを問わず、かかるドキュメントの機械翻訳された範囲には適用されないものとします。機械翻訳されたコンテンツの使用に起因する損害または問題について、Cloud Software Groupは責任を負わないものとします。

この情報は役に立ちましたか?

移行用自動構成ツールコマンドレット

April 6, 2026

寄稿者:

C C

April 6, 2026

寄稿者:

C C

この情報は役に立ちましたか?

移行用自動構成ツール コマンドレット

基本コマンドレット

オンプレミスからクラウドへのコマンドレット

クラウド間コマンドレット

その他の基本コマンドレット

詳細な移行パラメーター

コンポーネントによる移行

オブジェクト名によるフィルタリング

コンポーネント名による移行

デリバリーグループ名によるフィルタリング

無効なものの除外

マシン名によるフィルタリング

マシンのマージ

前提条件関連のコマンドレット

前提条件関連のパラメーター

サポートおよびトラブルシューティングコマンドレット

サイトアクティベーションコマンドレット

複数のオンプレミスサイトのマージコマンドレット

サイトマージパラメーター

汎用パラメーター

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

移行モードパラメーター

ログ表示パラメーター

Cmdlet の戻り値

ActionResult

CustomResult

PowerShell ヘルプ

この記事の概要

移行用自動構成ツールコマンドレット