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

最終公開日 : Oct 24, 2026
このページでは、移行ユースケース向けにツールでサポートされているすべてのコマンドレットとパラメータを一覧表示します。
すべてのコマンドレットは、次のいずれかの型のパラメータを受け取ります。
  • 文字列
  • 文字列のリスト
  • ブール値: $true または $false
  • SwitchParameter: パラメータが存在する場合は $true を意味し、パラメータが存在しない場合は $false を意味します。
注:
SwitchParameter は真偽の選択に推奨される方法ですが、レガシーな問題により、ツールではブール値も引き続き使用されています。
次の表は、すべてのコマンドレットの概要です。各コマンドレットがサポートするパラメータについては、各セクションを参照してください。
カテゴリ コマンドレット 説明
オンプレミスからクラウドへの移行 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ファイルを検索します。
サイトアクティベーションコマンドレット(#site-activation-cmdlets) Set-CvadAcSiteActiveStateOnPrem オンプレミスサイトの状態をアクティブまたは非アクティブに設定します。
Set-CvadAcSiteActiveStateCloud クラウドサイトの状態をアクティブまたは非アクティブに設定します。
複数のオンプレミスサイトをマージするコマンドレット(#merging-multiple-on-premises-sites-cmdlets) New-CvadAcSiteMergingInfo サイトマージのプレフィックス/サフィックス情報セットを作成します。
Set-CvadAcSiteMergingInfo 既存のサイトマージのプレフィックス/サフィックス情報セットを更新します。
Remove-CvadAcSiteMergingInfo 既存のサイトマージのプレフィックス/サフィックス情報セットを削除します。
パラメーターとその使用方法の詳細については、「きめ細かな移行パラメーター」を参照してください。
Related information
構成のバックアップまたは移行

基本的なコマンドレット

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

  • Export-CvadAcToFile - オンプレミスファイルをYAMLファイルにエクスポートします。
    オンプレミス設定から構成をエクスポートします。これは、自動構成のデフォルトのエクスポート操作です。オンプレミスサイトの構成には変更が加えられません。エクスポートされたファイルは、一意の名前が付けられた Export サブフォルダー内のディレクトリ %HOMEPATH%\Documents\Citrix\AutoConfig に配置されます。フォルダー %HOMEPATH%\Documents\Citrix\AutoConfig には、常に最新のエクスポートされたオンプレミスサイト構成が含まれています。
    パラメーター:
    名前 説明 必須ですか？ 種類
    コンポーネントによる移行 「コンポーネントによる移行」を参照してください。 SwitchParameters
    オブジェクト名によるフィルタリング 「オブジェクト名によるフィルタリング」を参照してください(#filtering-by-object-names) 文字列のリスト
    TargetFolder エクスポート先のフォルダーを指定します。 文字列
    Locale エクスポート可能な人間が判読できるテキストの言語を指定します。 文字列
    Quiet コンソールへのログ出力を抑制します。 SwitchParameter
    AdminAddress エクスポートがDelivery Controllerで実行されていない場合に、Delivery ControllerのDNSまたはIPアドレスを指定します。 文字列
    CheckUserAndMachines ユーザーとマシンがActive Directoryに存在するかどうかを確認します。Active Directoryに存在しないユーザーとマシンは、インポートの失敗につながる可能性があります。 $true または $false
    ZipResults バックアップされたYAMLファイルを単一のzipファイルに圧縮します。このファイルは、バックアップされたYAMLファイルと同じフォルダーにあり、フォルダーと同じ名前を持ちます。 SwitchParameter
    戻り値:
データをクラウドにインポートする方法は3つあります。特定のコマンドレットを実行すると、クラウドサイトで次の3つのアクションの組み合わせのいずれかが発生します。
  • 追加、更新、および削除
  • 追加と更新のみ
  • 追加のみ
コマンドレット 追加 更新 削除
インポート X X X
マージ X X
新規 X
  • Import-CvadAcToSite - YAMLファイルをクラウドにインポートします。作成、更新、削除操作をサポートします。
    すべてのオンプレミスファイルをクラウドにインポートします。このコマンドは、クラウドの最終状態がオンプレミスの状態と同一であることを保証します。このオプションは、クラウドに存在する変更をすべて削除します。インポートされたサイト構成ファイルは、%HOMEPATH%\Documents\Citrix\AutoConfig から取得されます。注意して使用してください。
    パラメーター:
    名前 説明 必須? 種類
    コンポーネントによる移行 コンポーネントによる移行を参照してください。 SwitchParameters
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリングを参照してください。 文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーターを参照してください。 SwitchParameters
    SourceFolder %HOMEPATH%\Documents\Citrix\AutoConfig の代替ルートフォルダーを識別します。 文字列
    Locale エクスポート可能な人間が判読できるテキストの言語を指定します。 文字列
    Quiet コンソールへのログ出力を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには$falseに設定します。 $trueまたは$false
    Merge $trueに設定すると、クラウドサイトにコンポーネントのみを追加します。コンポーネントは削除されません。コンポーネントを削除するには$falseに設定します。 $trueまたは$false
    AddOnly $trueに設定すると、新しいコンポーネントのみを追加し、既存のコンポーネントは更新または削除しません。更新と削除を許可するには$falseに設定します。このパラメーターが$trueの場合、Mergeは無視されます。 $trueまたは$false
    MergePolicies ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCに既に存在する場合にのみ行われます。ポリシーをマージした結果、クラウドDDCポリシーには、既存の設定とフィルターに加えて、インポートされる新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。 SwitchParameter
    OnErrorAction を参照してください(/ja-jp/citrix-daas/backup-migrate-configuration/auto-config-troubleshoot.html#onerroraction-parameter)。 文字列
    戻り値:
    • を参照してください(#cmdlet-return-values)
  • Merge-CvadAcToSite - YAML ファイルをクラウドにインポートします。作成および更新操作をサポートします。
    オンプレミスファイルをクラウドにマージしますが、クラウドまたはオンプレミスサイトのコンポーネントを削除することはありません。これにより、クラウドで既に行われた変更が保持されます。Citrix Cloud に同じ名前のコンポーネントが存在する場合、このコマンドはそのコンポーネントを変更できます。これは、自動構成のデフォルトのインポート操作です。マージされたサイト構成ファイルは、%HOMEPATH%\Documents\Citrix\AutoConfig から取得されます。
    パラメーター:
    名前 説明 必須? タイプ
    コンポーネントによる移行 を参照してください(#migrate-by-components)。 SwitchParameters
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリングを参照してください。 文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーターを参照してください。 SwitchParameters
    SourceFolder %HOMEPATH%\Documents\Citrix\AutoConfig の代替ルートフォルダーを識別します。 文字列
    Locale エクスポート可能な人間が判読できるテキストの言語を指定します。 文字列
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$false に設定します。 $true または $false
    Merge $true に設定すると、クラウドサイトにコンポーネントのみを追加します。コンポーネントは削除されません。コンポーネントを削除するには、$false に設定します。 $true または $false
    AddOnly $true に設定すると、新しいコンポーネントのみを追加し、既存のコンポーネントを更新または削除しません。更新と削除を許可するには、$false に設定します。このパラメーターが $true の場合、Merge は無視されます。 $true または $false
    MergePolicies ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCにすでに存在する場合にのみ行われます。ポリシーをマージした結果、クラウドDDCポリシーには、既存の設定とフィルターに加えて、インポートされる新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。 SwitchParameter
    OnErrorAction を参照してください (/ja-jp/citrix-daas/backup-migrate-configuration/auto-config-troubleshoot.html#onerroraction-parameter)。 文字列
    戻り値:
  • New-CvadAcToSite - YAMLファイルをクラウドにインポートします。作成および更新操作をサポートします。
    オンプレミスサイト構成をクラウドにインポートしますが、新しいコンポーネントのみを追加します。既存のクラウドサイトコンポーネントは更新も削除もされません。既存のクラウドサイトコンポーネントを変更しない必要がある場合は、このコマンドを使用してください。
    パラメーター:
    名前 説明 必須? 種類
    コンポーネントによる移行 コンポーネントによる移行を参照してください。 SwitchParameters
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリングを参照してください。 文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーターを参照してください。 SwitchParameters
    SourceFolder %HOMEPATH%\Documents\Citrix\AutoConfig の代替ルートフォルダーを識別します。 文字列
    Locale エクスポート可能な人間が判読できるテキストの言語を指定します。 文字列
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$false に設定します。 $true または $false
    OnErrorAction を参照してください(/ja-jp/citrix-daas/backup-migrate-configuration/auto-config-troubleshoot.html#onerroraction-parameter)。 文字列
    戻り値:
    • を参照してください(#cmdlet-return-values)
  • Sync-CvadAcToSite - 1つのステップでエクスポートとインポートを実行します。
    同期は、エクスポートとインポートの両方を1つのステップで実行します。SourceTargetFolder パラメーターを使用して、エクスポート/インポート先のフォルダーを指定します。
    パラメーター:
    名前 説明 必須ですか? 種類
    コンポーネントによる移行 を参照してください(#migrate-by-components) SwitchParameters
    オブジェクト名によるフィルタリング 「オブジェクト名によるフィルタリング」を参照してください(#filtering-by-object-names) 文字列のリスト
    クラウドアクセスパラメータ 「クラウドアクセスパラメータ」を参照してください(#cloud-accessing-parameters) SwitchParameters
    SourceTargetFolder エクスポート/インポート先のフォルダを指定します。 文字列
    Locale エクスポート可能な人間が判読できるテキストの言語を指定します。 文字列
    AdminAddress エクスポートがデリバリーコントローラーで実行されていない場合に、デリバリーコントローラーのDNSまたはIPアドレスを指定します。 文字列
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$falseに設定します。 $true または $false
    Merge $trueに設定すると、コンポーネントはクラウドサイトにのみ追加されます。コンポーネントは削除されません。コンポーネントを削除するには、$falseに設定します。 $true または $false
    AddOnly $trueに設定すると、新しいコンポーネントのみが追加され、既存のコンポーネントは更新または削除されません。更新と削除を許可するには、$falseに設定します。このパラメーターが$trueの場合、Mergeは無視されます。 $true または $false
    MergePolicies ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCにすでに存在する場合にのみ行われます。ポリシーをマージした結果、クラウドDDCポリシーには、既存の設定とフィルターに加えて、新しくインポートされる設定とフィルターが含まれることになります。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。 SwitchParameter
    戻り値:

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

  • Backup-CvadAcToFile - クラウドサイトからすべての構成をバックアップします。
    クラウド構成を .yml ファイルにエクスポートします。このバックアップは、バックアップおよび復元プロセスで失われたコンポーネントを復元するために使用できます。
    パラメーター:
    名前 説明 必須? 型
    コンポーネントによる移行 コンポーネントによる移行 を参照してください SwitchParameters
    クラウドアクセスパラメーター クラウドアクセスパラメータを参照してください SwitchParameters
    TargetFolder エクスポート先のフォルダーを指定します。 文字列
    Locale エクスポート可能な人間が判読できるテキストの言語を指定します。 文字列
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$false に設定します。 $true または $false
    ZipResults バックアップされたYAMLファイルを単一のzipファイルに圧縮します。このファイルは、バックアップされたYAMLファイルと同じフォルダーにあり、フォルダーと同じ名前です。 SwitchParameter
    戻り値:
    • 「Cmdletの戻り値」を参照してください(#cmdlet-return-values)
  • Restore-CvadAcToSite - バックアップされたYAMLファイルをクラウドサイトに復元します。このクラウドサイトは、ソースクラウドサイトと同じでも異なっていてもかまいません。
    クラウドサイトを以前の構成に復元します。インポートされたファイルは、-RestoreFolder パラメーターを使用して指定されたフォルダーから取得されます。このパラメーターは、クラウドサイトに復元する.ymlファイルを含むフォルダーを識別します。これは、完全修飾フォルダー指定である必要があります。このコマンドレットは、以前の構成に戻すため、またはクラウドサイトをバックアップおよび復元するために使用できます。このコマンドは、クラウドサイトの追加、削除、更新を行うことができます。
    パラメーター:
    名前 説明 必須? タイプ
    コンポーネントによる移行 「コンポーネントによる移行」を参照してください(#migrate-by-components)。 SwitchParameters
    オブジェクト名によるフィルタリング 「オブジェクト名によるフィルタリング」を参照してください(#filtering-by-object-names)。 文字列のリスト
    クラウドアクセスパラメータ 「クラウドアクセスパラメータ」を参照してください(#cloud-accessing-parameters)。 SwitchParameters
    RestoreFolder クラウドサイトに復元する.ymlファイルを含むフォルダを識別します。これは完全修飾されたフォルダ指定である必要があります。 文字列
    Locale エクスポート可能な、人間が判読できるテキストの言語を指定します。 文字列
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには$falseに設定します。 $true または $false
    Merge $trueに設定すると、クラウドサイトにコンポーネントのみを追加します。コンポーネントは削除されません。コンポーネントを削除するには$falseに設定します。 $true または $false
    AddOnly $trueに設定すると、新しいコンポーネントのみを追加し、既存のコンポーネントを更新または削除しません。更新と削除を許可するには$falseに設定します。このパラメーターが$trueの場合、Mergeは無視されます。 $true または $false
    MergePolicies ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドDDCに既に存在する場合にのみ行われます。ポリシーをマージした結果、クラウドDDCポリシーには、既存の設定とフィルターに加えて、インポートされる新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合、インポートされた値が優先されることに注意してください。 SwitchParameter
    OnErrorAction OnErrorAction parameterを参照してください。 文字列
    戻り値:
  • Remove-CvadAcFromSite – クラウドからコンポーネントメンバーを削除します。
    サイト全体をリセットしたり、コンポーネントからメンバー項目を削除したりできます (たとえば、カタログのリストから1つのマシンカタログを削除する場合など)。これは、IncludeByNameパラメーターと組み合わせて使用すると、特定のメンバーを選択的に削除できます。
    パラメーター:
    名前 説明 必須? 種類
    コンポーネントによる移行 コンポーネントによる移行を参照してください SwitchParameters
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリングを参照してください 文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーターを参照してください SwitchParameters
    Quiet コンソールへのログ出力を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$falseに設定します。 $true または $false
    戻り値:

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

  • Compare-CvadAcToSite - オンプレミスの.ymlファイルをクラウド構成と比較し、Import、Merge、またはRestoreコマンドレットによって行われた変更のレポートを生成します。
    パラメーター:
    名前 説明 必須? 種類
    コンポーネントによる移行 コンポーネントによる移行を参照。 SwitchParameters
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリングを参照。 文字列のリスト
    クラウドアクセスパラメータ クラウドアクセスパラメータを参照。 SwitchParameters
    SourceFolder %HOMEPATH%\Documents\Citrix\AutoConfig の代替ルートフォルダーを識別します。 文字列
    Locale エクスポート可能な人間が判読できるテキストの言語を指定します。 文字列
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$false に設定します。 $true または $false
    Merge $true に設定すると、クラウドサイトにコンポーネントのみを追加します。コンポーネントは削除されません。コンポーネントを削除するには、$false に設定します。 $true または $false
    AddOnly $true に設定すると、新しいコンポーネントのみを追加し、既存のコンポーネントを更新または削除しません。更新と削除を許可するには、$false に設定します。このパラメーターが $true の場合、Merge は無視されます。 $true または $false
    OnErrorAction 「OnErrorAction パラメーター」を参照してください(/ja-jp/citrix-daas/backup-migrate-configuration/auto-config-troubleshoot.html#onerroraction-parameter)。 文字列
    戻り値:
    • 「Cmdlet の戻り値」を参照してください(#cmdlet-return-values)

きめ細かい移行パラメーター

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

それらをサポートするコマンドレットで、以下のコンポーネントを指定できます。コンポーネントパラメーターが指定されていない場合、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種類のワイルドカードがサポートされています。
  • * は任意の数の文字に一致します
  • ? は単一の文字に一致します
次の例では、EastDg で始まるすべてのデリバリーグループ名を参照するすべてのアプリケーションをマージします。
Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

無効なものを除外

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

マシン名別

ByMachineName は、マシンカタログおよびデリバリーグループのマシン名でフィルタリングします。このパラメーターは常に、マシン名の関連付けに基づいて含めるメンバーを識別するインクルージョンリストです。
ByMachineName は、任意の名前が1つ以上のワイルドカードを含むことができるマシン名のリストを受け取ります。2種類のワイルドカードがサポートされています。
  • * は任意の数の文字に一致します
  • ? は単一の文字に一致します
エクスポートまたはインポート時に ByMachineName を使用し、マシン名フィルターによってマシンカタログまたはデリバリーグループにマシンが存在しない場合、そのマシンカタログまたはデリバリーグループはエクスポートまたはインポートから除外されます。
注：
任意のインポート型コマンドレットでByMachineNameを使用すると、MergeMachinesが$trueに設定されます。

マシンのマージ

MergeMachinesを$trueに設定すると、インポート操作はマシンをマシンカタログまたはデリバリーグループにのみ追加するように指示します。マシンは削除されないため、増分的な追加操作が可能です。
MergeMachinesのデフォルトはfalseであり、これはマシンカタログまたはデリバリーグループの.ymlファイルに存在しないマシンは削除されることを意味します。ByMachineNameが使用されるとMergeMachinesは$trueに設定されますが、MergeMachinesをfalseに設定することで上書きできます。

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

  • New-CvadAcCustomerInfoFile - 顧客情報ファイルを作成します。デフォルトでは、顧客情報ファイルは %HOMEPATH%\Documents\Citrix\AutoConfig にあります。
    パラメーター:
    名前 説明 必須? タイプ
    CustomerId 顧客のID。 x 文字列
    ClientId Citrix Cloud で作成された顧客のクライアント ID。このパラメーターを使用する場合は、CustomerId と Secret を指定する必要があります。 条件付き 文字列
    Secret Citrix Cloud で作成された顧客のシークレットキー。このパラメーターを使用する場合は、CustomerId と ClientId を指定する必要があります。 条件付き 文字列
    Environment Production、ProductionGov、または ProductionJP 環境。 列挙型
    LogFileName ログファイルプレフィックスを CitrixLog から別のものに変更します。 文字列
    AltRootUrl Citrixの指示の下でのみ使用してください。 文字列
    StopOnError 最初のエラーで操作を停止します。 $true または $false
    TargetFolder %HOMEPATH%\Documents\Citrix\AutoConfig の代わりに、指定されたフォルダーをルートフォルダーとして使用します。 文字列
    Locale ツールが実行されているシステムから派生したロケールの代わりに、指定されたロケールを使用します。 文字列
    Editor 各コマンドレットの完了時にログを表示するために、指定されたエディターを使用します。Notepad.exe が既定のエディターです。このパラメーターには、エディターへの完全修飾ファイル指定を含める必要があり、エディターはログファイル指定を唯一のパラメーターとして受け取る必要があります。 文字列
    SecurityCsvFileSpec Citrix Identity and Access ManagementからダウンロードしたSecurityClient.csvファイルを指す完全修飾ファイル指定。このパラメーターを使用する場合は、CustomerIdを指定する必要があります。 文字列
    戻り値:
  • Set-CvadAcCustomerInfoFile - 既存の顧客情報ファイルを更新します。指定されたコマンドレットパラメーターのみが変更されます。CustomerInfo.ymlファイル内の指定されていないすべてのパラメーター値は変更されません。
    パラメーター:
    名前 説明 必須？ タイプ
    CustomerId 顧客ID。 文字列
    ClientId Citrix Cloudで作成された顧客のクライアントID。 文字列
    Secret Citrix Cloudで作成されたお客様のシークレットキー。 文字列
    Environment Production、ProductionGov、またはProductionJP環境。 列挙
    LogFileName ログファイルプレフィックスをCitrixLogから別のものに変更します。 文字列
    StopOnError 最初のエラーで操作を停止します。 $true または $false
    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 コンソールへのログ記録を抑制します。 SwitchParameter
    戻り値:
    • zipファイル名と場所を含むzipファイルがコマンドプロンプトに表示されます。
  • Get-CvadAcStatus - 接続をテストし、すべての前提条件が満たされていることを確認するために使用します。ツールに関する情報（バージョン番号、クラウドとの接続、コネクターステータスなど）を返します。
    パラメーター:
    名前 説明 必須? タイプ
    クラウドアクセスパラメーター クラウドアクセスパラメーターを参照してください。 SwitchParameters
    SiteId 接続先のサイトを識別します。 文字列
    AdminAddress これは、管理者のアクセスレベルを確認するために使用されるオンプレミスのDelivery ControllerのDNSまたはIPアドレスです。ツールがDelivery Controllerで実行されていない場合に必要です。 文字列
    戻り値:
    • 各項目の結果を表示します。
  • 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 エクスポート先のフォルダーを指定します。 文字列
    戻り値:
  • Show-CvadAcDocument - このドキュメントをデフォルトのブラウザーに表示します。
    パラメーター:
    • なし。
    戻り値:
    • このWebページをデフォルトのWebブラウザーに表示します。
  • Find-CvadAcInFile - ファイル内検索は、ワイルドカードを含む1つ以上の名前に一致するメンバーを探して、コンポーネントのYAMLファイルを検索します。結果は、見つかったメンバーのレポートです。ファイル内検索は、一度に1つのコンポーネントしか検索できません。ファイル内検索は、現在のフォルダーおよびすべてのサブフォルダー内のすべてのYAMLファイルを検索します。検索するファイルの数を制限するには、FindSourceFolderを使用します。
    パラメーター:
    名前 説明 必須? タイプ
    コンポーネントによる移行 コンポーネントによる移行を参照してください。注: -Allの値は無効です。 SwitchParameters
    IncludeByName サイトのアクティブ状態をアクティブに設定する際に含めるデリバリーグループの名前を指定するリスト。名前に「*」と「?」のワイルドカードがサポートされています。 文字列のリスト
    Unique 一意に見つかったメンバーのみを報告します。 SwitchParameter
    IncludeYaml メンバー固有のYAMLを含めます。 SwitchParameter
    FindSourceFolder 検索を開始するフォルダー。 文字列
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$false に設定します。 SwitchParameter
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    戻り値:
    • 指定されたコンポーネントについて、検出されたメンバーを含むレポートを作成します。

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

サイトのアクティベーションとこれらのコマンドレットの使用方法の詳細については、「サイトのアクティベーション」を参照してください。
  • Set-CvadAcSiteActiveStateOnPrem - オンプレミスサイトの状態をアクティブまたは非アクティブに設定します。
    パラメーター:
    名前 説明 必須? 種類
    クラウドアクセスパラメーター クラウドアクセスパラメーターを参照してください。 SwitchParameters
    SiteActive 存在する場合、オンプレミスサイトをアクティブに設定し、すべてのデリバリーグループからメンテナンスモードを削除します。このパラメーターが存在しない場合、すべてのデリバリーグループにメンテナンスモードが設定されます。 SwitchParameter
    IncludeByName サイトのアクティブ状態をアクティブに設定する際に含めるデリバリーグループの名前を指定するリスト。名前に「*」と「?」のワイルドカードがサポートされています。 文字列のリスト
    ExcludeByName サイトのアクティブ状態をアクティブに設定する際に除外するデリバリーグループの名前を指定するリストです。名前に「*」と「?」のワイルドカードがサポートされています。 文字列のリスト
    Quiet コンソールへのログ出力を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには$falseに設定します。 $true or $false
    戻り値:
    • 「コマンドレットの戻り値」を参照してください(#cmdlet-return-values)
  • Set-CvadAcSiteActiveStateCloud - クラウドサイトの状態をアクティブまたは非アクティブのいずれかに設定します。
    パラメーター:
    名前 説明 必須ですか？ 種類
    クラウドアクセスパラメーター クラウドアクセスパラメーターを参照してください SwitchParameters
    SiteActive 存在する場合、クラウドサイトをアクティブに設定し、すべてのデリバリーグループからメンテナンスモードを削除します。このパラメーターが存在しない場合、すべてのデリバリーグループでメンテナンスモードが設定されます。 SwitchParameter
    IncludeByName サイトのアクティブ状態をアクティブに設定する際に含めるデリバリーグループの名前を指定するリスト。名前に「*」と「?」のワイルドカードがサポートされています。 文字列のリスト
    ExcludeByName サイトのアクティブ状態をアクティブに設定する際に除外するデリバリーグループの名前を指定するリスト。名前に「*」と「?」のワイルドカードがサポートされています。 文字列のリスト
    Quiet コンソールへのログ記録を抑制します。 SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。ログ表示を抑制するには、$false に設定します。 $true or $false
    戻り値:

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

サイトのマージとこれらのコマンドレットの使用方法の詳細については、複数のサイトを単一のサイトにマージする を参照してください。
  • New-CvadAcSiteMergingInfo - サイトマージのプレフィックス/サフィックス情報セットを作成します。最初からすべてのプレフィックスまたはサフィックスを知っている必要はありません。これらは Set-CvadAcSiteMergingInfo で、または SiteMerging.yml ファイルを手動で編集することで更新できます。 パラメーター:
    名前 説明 必須ですか？ タイプ
    SiteName 特定のサイトのプレフィックス/サフィックスのセットを識別するために使用される名前。実際のサイト名と一致してもよいが、必須ではない。 x 文字列
    サイト統合パラメーター サイト統合パラメーターを参照 SwitchParameters
    Quiet コンソールへのログ出力を抑制します。 SwitchParameter
    戻り値:
    • なし
  • Set-CvadAcSiteMergingInfo - 既存のサイト統合プレフィックス/サフィックス情報セットを更新します。
    パラメーター:
    名前 説明 必須ですか？ 種類
    SiteName 特定のサイトのプレフィックス/サフィックスのセットを識別するために使用される名前。実際のサイト名と一致してもよいし、一致しなくてもよい。 x 文字列
    サイト統合パラメーター サイト統合パラメーターを参照してください 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 サイトで作成された clientID。これは、すべての 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

コマンドレットの戻り値

ActionResult

すべてのコマンドレットは次の値を返します。
public class ActionResult
{
    public bool                         Overall_Success;
    public Dictionary<string, string>   Individual_Success;
    public object                       CustomResult;
}
Overall_Success は、選択されたすべてのコンポーネントにおけるコマンドレット全体の成功を示す単一のブール値を返します。trueは成功、falseは失敗を意味します。
Individual_Success は、各主要コンポーネントに対して1つまたは3つの値を返します。コンポーネントの結果は、Success、Failure、またはSkippedのいずれかになります。Skippedは、そのコンポーネントがコマンドレットによる実行のために選択されなかったことを示します。
CustomResult はコマンドレット固有です。

CustomResult

Import、Merge、Restore、Sync、Compare、Compare File、および Remove は、EvaluationResultData の単一インスタンスに次のカスタム結果情報を返します。
注:
Export および Template コマンドレットはカスタム結果を返しません。
 public class EvaluationResultData
 {
     public Dictionary<string, Dictionary&lt;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 は、コマンドレットの結果を示す単一のブール値です。True はすべてのコンポーネントでの完全な成功を示し、False は 1 つ以上のコンポーネントの処理の失敗を示します。
CloudBackupFolder は、コマンドレットがクラウド変更アクションを実行する前の、クラウドサイト構成バックアップの完全修飾ファイル指定です。
SourceBackupFolder は、コマンドレットの完了後に作成されたソースファイルバックアップの完全修飾ファイル指定です。デフォルトでは、これらのファイルは %HOMEPATH%\Documents\Citrix\AutoConfig にあります。

PowerShell ヘルプ

各コマンドレットの PowerShell ヘルプが利用可能です。すべてのパラメーターは、コマンドレットの簡単な説明とともに各コマンドレットに記載されています。任意のコマンドレットのヘルプにアクセスするには、コマンドレットの前に Get-Help と入力します。
Get-Help Import-CvadAcToSite