Citrix Virtual Apps and Desktopsサービス

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

このページには、自動構成でサポートされているすべてのコマンドレットとパラメーターが一覧で示されています。

すべてのコマンドレットは、次のいずれかのタイプのパラメーターを取ります。

  • 文字列
  • 文字列のリスト
  • ブール: $trueまたは$false
  • SwitchParameter:このパラメーターがある場合は$trueを意味し、ない場合は$falseを意味します。

注:

SwitchParameterは、trueかfalseかを選択するための推奨される方法ですが、従来の問題が原因で、このツールではブールが引き続き使用されます。

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

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

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

基本的なコマンドレット

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

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

    オンプレミスセットアップから構成をエクスポートします。これは、自動構成のデフォルトのエクスポート操作です。オンプレミスサイトの構成は変更されません。エクスポートされたファイルは、一意の名前のExportサブフォルダーにある%HOMEPATH%\Documents\Citrix\AutoConfigディレクトリに配置されます。%HOMEPATH%\Documents\Citrix\AutoConfigフォルダーには常に、最も新しくエクスポートされたオンプレミスサイトの構成があります。

    パラメーター:

    名前 説明 必須である 種類
    コンポーネントによる移行 コンポーネントによる移行」を参照してください   SwitchParameter
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリング」を参照してください   文字列のリスト
    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つの組み合わせのいずれかになります:

  • 追加、更新、および削除
  • 追加と更新のみ
  • 追加のみ
コマンドレット 追加 アップデート Delete
インポート X X X
マージ X X  
変更後 X    
  • Import-CvadAcToSite - YAMLファイルをクラウドにインポートします。作成、更新、削除の操作をサポートします。

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

    パラメーター:

    名前 説明 必須である 種類
    コンポーネントによる移行 コンポーネントによる移行」を参照してください   SwitchParameter
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリング」を参照してください   文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーター」を参照してください   SwitchParameter
    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 ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドのDesktop Delivery Controllerに既に存在する場合にのみ発生します。ポリシーをマージした結果、クラウドのDesktop Delivery Controllerポリシーには、既に存在していた設定とフィルター、およびインポートされた新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合はインポートされた値が優先されることに注意してください。   SwitchParameter

    戻り値:

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

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

    パラメーター:

    名前 説明 必須である 種類
    コンポーネントによる移行 コンポーネントによる移行」を参照してください   SwitchParameter
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリング」を参照してください   文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーター」を参照してください   SwitchParameter
    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 ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドのDesktop Delivery Controllerに既に存在する場合にのみ発生します。ポリシーをマージした結果、クラウドのDesktop Delivery Controllerポリシーには、既に存在していた設定とフィルター、およびインポートされた新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合はインポートされた値が優先されることに注意してください。   SwitchParameter

    戻り値:

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

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

    パラメーター:

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

    戻り値:

  • Sync-CvadAcToSite - エクスポートとインポートを1つの手順で実行します。

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

    パラメーター:

    名前 説明 必須である 種類
    コンポーネントによる移行 コンポーネントによる移行」を参照してください   SwitchParameter
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリング」を参照してください   文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーター」を参照してください   SwitchParameter
    SourceTargetFolder エクスポート/インポート先フォルダーを指定します。   文字列
    Locale エクスポート可能な、人間が判読できるテキストの言語を指定します。   文字列
    AdminAddress エクスポートがDelivery Controllerで実行されていないときの、Delivery ControllerのDNSまたはIPアドレスを指定します。   文字列
    Quiet コンソールへのログ記録を抑制します。   SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。$falseに設定すると、ログの表示が抑制されます。   $true または $false
    Merge $trueに設定すると、クラウドサイトにコンポーネントを追加するのみになります。コンポーネントは削除されません。コンポーネントを削除するには$falseに設定します。   $true または $false
    AddOnly $trueに設定すると、新しいコンポーネントのみが追加され、既存のコンポーネントは更新または削除されません。$falseに設定すると、更新と削除が可能になります。このパラメーターが$trueのとき、Mergeは無視されます。   $true または $false
    MergePolicies ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドのDesktop Delivery Controllerに既に存在する場合にのみ発生します。ポリシーをマージした結果、クラウドのDesktop Delivery Controllerポリシーには、既に存在していた設定とフィルター、およびインポートされた新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合はインポートされた値が優先されることに注意してください。   SwitchParameter

    戻り値:

クラウドからクラウドへのコマンドレット

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

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

    パラメーター:

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

    戻り値:

  • Restore-CvadAcToSite - バックアップYAMLファイルをクラウドサイトに復元します。このクラウドサイトは、ソースクラウドサイトと同じでも異なっていてもかまいません。

    クラウドサイトを以前の構成に復元します。インポートされるファイルは、-RestoreFolderパラメーターを使用して指定されたフォルダーから供給されます。このパラメーターでは、クラウドサイトに復元する.ymlファイルを含むフォルダーを指定します。これは、完全修飾フォルダー仕様である必要があります。このコマンドレットは、以前の構成に戻す場合、またはクラウドサイトのバックアップと復元を実行する場合に使用できます。このコマンドでは、クラウドサイトを追加、削除、および更新できます。

    パラメーター:

    名前 説明 必須である 種類
    コンポーネントによる移行 コンポーネントによる移行」を参照してください   SwitchParameter
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリング」を参照してください   文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーター」を参照してください   SwitchParameter
    RestoreFolder クラウドサイトに復元する.ymlファイルを含むフォルダーを特定します。これは、完全修飾フォルダー仕様である必要があります。   文字列
    Locale エクスポート可能な、人間が判読できるテキストの言語を指定します。   文字列
    Quiet コンソールへのログ記録を抑制します。   SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。$falseに設定すると、ログの表示が抑制されます。   $true または $false
    Merge $trueに設定すると、クラウドサイトにコンポーネントを追加するのみになります。コンポーネントは削除されません。コンポーネントを削除するには$falseに設定します。   $true または $false
    AddOnly $trueに設定すると、新しいコンポーネントのみが追加され、既存のコンポーネントは更新または削除されません。$falseに設定すると、更新と削除が可能になります。このパラメーターが$trueのとき、Mergeは無視されます。   $true または $false
    MergePolicies ポリシー設定とフィルターをマージします。マージは、インポートされるポリシーがクラウドのDesktop Delivery Controllerに既に存在する場合にのみ発生します。ポリシーをマージした結果、クラウドのDesktop Delivery Controllerポリシーには、既に存在していた設定とフィルター、およびインポートされた新しい設定とフィルターが含まれます。設定とフィルターの競合が発生した場合はインポートされた値が優先されることに注意してください。   SwitchParameter

    戻り値:

  • Remove-CvadAcFromSite – クラウドからコンポーネントメンバーを削除します。

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

    パラメーター:

    名前 説明 必須である 種類
    コンポーネントによる移行 コンポーネントによる移行」を参照してください   SwitchParameter
    オブジェクト名によるフィルタリング オブジェクト名によるフィルタリング」を参照してください   文字列のリスト
    クラウドアクセスパラメーター クラウドアクセスパラメーター」を参照してください   SwitchParameter
    Quiet コンソールへのログ記録を抑制します。   SwitchParameter
    DisplayLog コマンドレットの完了時にログファイルを表示します。$falseに設定すると、ログの表示が抑制されます。   $true または $false

    戻り値:

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

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

    パラメーター:

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

    戻り値:

詳細な移行のパラメーター

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

以下のコンポーネントは、これらのコンポーネントをサポートしているコマンドレットで指定できます。コンポーネントのパラメーターが指定されていない場合、Allオプションが自動的に選択されます。

  • All
  • Tags
  • AdminRolesScopes
  • MachineCatalogs
  • StoreFronts
  • DeliveryGroups
  • ApplicationGroups
  • Applications
  • GroupPolicies

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

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

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をfalseに設定しても上書きできない場合に、MergeMachines$trueに設定されます。

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

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

    パラメーター:

    名前 説明 必須である 種類
    CustomerId 顧客のID。 x 文字列
    ClientId Citrix Cloudで作成された、顧客のクライアントID。このパラメーターを使用するときは、CustomerIdとSecretを指定する必要があります。 条件付き 文字列
    Secret Citrix Cloudで作成される、顧客の秘密キー。このパラメーターを使用するときは、CustomerIdとClientIdを指定する必要があります。 条件付き 文字列
    Environment 本番環境、ProductionGov環境、またはProductionJP環境。   列挙
    LogFileName ログファイルのプレフィックスをCitrixLogから別のプレフィックスに変更します。   文字列
    AltRootUrl シトリックスの指示の下でのみ使用してください。   文字列
    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 本番環境、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 - 本番環境またはProductionGov環境。
  • LogFileName - ログファイルのプレフィックスをCitrixLogから別のプレフィックスに変更します。
  • StopOnError - 最初のエラーで操作を停止します。
  • AlternateRootFolder - %HOMEPATH%\Documents\Citrix\AutoConfigではなく、ルートフォルダーとして指定したフォルダーを使用します。
  • Locale - ツールが実行されているシステムから取得したロケールではなく、指定したロケールを使用します。
  • Editor - 各コマンドレットの完了時に、指定したエディターを使用してログを表示します。Notepad.exeがデフォルトのエディターです。このパラメーターには、エディターのフルパス指定を含める必要があり、エディターは唯一のパラメーターとしてログファイルの指定を受け取る必要があります。

コマンドレットのサポートとトラブルシューティング

  • 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ファイルはバックアップとしても機能します。

    パラメーター:

    名前 説明 必須である 種類
    TargetFolder zipファイルを作成して保存するためのターゲットフォルダーを指定します。   文字列
    Quiet コンソールへのログ記録を抑制します。   SwitchParameter

    戻り値:

    • コマンドプロンプトにzipファイルのzipファイル名前とその場所が表示されます。
  • Get-CvadAcStatus - 接続をテストし、すべての前提条件が満たされていることを確認するために使用します。バージョン番号、クラウドとの接続、コネクタのステータスなど、ツールに関する情報を返します。

    パラメーター:

    名前 説明 必須である 種類
    クラウドアクセスパラメーター クラウドアクセスパラメーター」を参照してください   SwitchParameter
    SiteId 接続するサイトを特定します。   文字列
    AdminAddress 管理者のアクセスレベルを確認するために使用される、オンプレミスのDelivery ControllerのDNSまたはIPアドレスです。これは、ツールがDelivery Controllerで実行されていない場合に必要です。   文字列

    戻り値:

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

    パラメーター:

    名前 説明 必須である 種類
    クラウドアクセスパラメーター クラウドアクセスパラメーター」を参照してください   SwitchParameter
    Quiet コンソールへのログ記録を抑制します。   SwitchParameter

    戻り値:

    • テスト結果はコマンドラインに表示されます。
  • Find-CvadAcConnector - 既存のコネクタを検索し、コネクタの実行状態を判別します。このコマンドレットは、CustomerInfo.ymlファイルまたは顧客IDパラメーターの情報を使用して、顧客のコネクタを検索します。

    パラメーター:

    名前 説明 必須である 種類
    CustomerInfoFileSpec デフォルトの場所と名前を上書きするための、顧客情報ファイルを示すファイルの指定です。CustomerIdパラメーターが指定されている場合、このパラメーターは無視されます。   文字列
    CustomerId 顧客のID。このパラメーターは、CustomerInfo.ymlファイル内の同じ値を上書きします。   文字列

    戻り値:

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

    パラメーター:

    戻り値:

    • 見つかった顧客サイトIDのリストを表示します。
  • New-CvadAcTemplateToFile – 選択されたコンポーネントのテンプレートファイルを作成し、インポートファイルを手動で作成できるようにします。

    パラメーター:

    名前 説明 必須である 種類
    コンポーネントによる移行 コンポーネントによる移行」を参照してください   SwitchParameter
    TargetFolder エクスポート先フォルダーを指定します。   文字列

    戻り値:

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

    パラメーター:

    • なし。

    戻り値:

    • このWebページをデフォルトのWebブラウザーに表示します。
  • Find-CvadAcInFile - ファイル内検索でコンポーネントのYAMLファイルを検索し、ワイルドカードを含む可能性がある名前に一致するメンバーを見つけます。結果は、見つかったメンバーのレポートです。ファイル内検索では、一度に1つのコンポーネントしか検索できません。ファイル内検索では、現在のフォルダー内とすべてのサブフォルダー内で、すべてのYAMLファイルが検索されます。FindSourceFolderを使用して、検索するファイルの数を制限します。

    パラメーター:

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

    戻り値:

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

サイトアクティブ化コマンドレット

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

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

    パラメーター:

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

    戻り値:

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

    パラメーター:

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

    戻り値:

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

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

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

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

    戻り値:

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

    パラメーター:

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

    戻り値:

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

    パラメーター:

    • SiteName – サイトのプレフィックスとサフィックスのセットを特定します。これは文字列であり、必須です。

    戻り値:

    • なし

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

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

  • SiteName - 特定サイトのプレフィックス/サフィックスのセットを識別するために使用する名前。実際のサイトの名前と一致させることはできますが、一致させる必要はありません。SiteNameは必須パラメーターです。
  • AdminScopedPrefix - 管理者スコープに適用するプレフィックス。
  • ApplicationPrefix - アプリケーションに適用するプレフィックス。
  • ApplicationFolderPrefix - アプリケーションフォルダーに適用するプレフィックス。 ApplicationFolderPrefixApplicationFolderRootと組み合わせることができます 。
  • ApplicationFolderRoot - アプリケーションフォルダーへの新しいルートフォルダー。これにより、追加のフォルダー階層が作成されます。ApplicationFolderRootApplicationFolderPrefixと組み合わせることができます。
  • ApplicationGroupPrefix - アプリケーショングループのプレフィックス。
  • ApplicationUserPrefix - ユーザーに表示されるアプリケーション名に適用するプレフィックス。
  • ApplicationAdminPrefix - 管理者に表示されるアプリケーション名に適用するプレフィックス。
  • DeliveryGroupPrefix - デリバリーグループに適用するプレフィックス。
  • GroupPolicyPrefix - ポリシー名に適用するプレフィックス。
  • HostConnectionPrefix - ホスト接続に適用するプレフィックス。
  • MachineCatalogPrefix - マシンカタログに適用するプレフィックス。
  • StoreFrontPrefix - StoreFront名に適用するプレフィックス。
  • TagPrefix - タグに適用するプレフィックス。
  • AdminScopedSuffix - 管理者スコープに適用するサフィックス。
  • ApplicationSuffix - アプリケーションに適用するサフィックス。
  • ApplicationFolderSuffix - アプリケーションフォルダーに適用するサフィックス。 ApplicationFolderSuffixApplicationFolderRootと組み合わせることができます 。
  • 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の「IDおよびアクセス管理」Webサイトで作成されたクライアントIDです。これは、すべてのRest APIの認証で必要なベアラートークンを取得するのに必要です。
  • Secret – Citrix Cloudの「IDおよびアクセス管理」Webサイトで作成された秘密キーです。これは、すべてのRest APIの認証で必要なベアラートークンを取得するのに必要です。
  • CustomerInfoFileSpec – デフォルトの場所と名前を上書きするための、顧客情報ファイルを示すファイルの指定です。

移行モードパラメーター

クラウドサイト構成を変更するコマンドレット(ImportRestoreMergeNew、およびSync)では、柔軟性を高める以下の追加パラメーターがサポートされています。

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

ログ表示パラメーター

ExportImportSyncRestoreBackupCompare、および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は、選択したすべてのコンポーネントでのコマンドレットの全体的な成功を示す1つのブール値を返します:trueは成功を示し、falseは失敗を示します。

Individual_Successは、主要コンポーネントごとに1つまたは3つの値を返します。コンポーネントの結果は、Success、Failure、Skippedのいずれかです。Skippedは、コマンドレットがコンポーネントを実行対象に選択しなかったことを示します。

CustomResultはコマンドレットに固有です。

CustomResult

ImportMergeRestoreSyncCompareCompare File、およびRemoveは、EvaluationResultDataの単一インスタンスに以下のカスタム結果情報を返します。

注:

コマンドレットExportおよびTemplateはカスタム結果を返しません。

                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の値のいずれかにできます。

AddedUpdatedDeleted、およびNoChangeでは、追加、更新、削除、または操作が実行されなかったコンポーネントメンバーの合計数がその順序で示されます。

TotalChangedは、AddedUpdatedDeletedの合計です。

OverallResultは、コマンドレットの結果を示す1つのブール値です。trueはすべてのコンポーネントの全体的な成功を示し、falseは1つ以上のコンポーネントの処理が失敗したことを示します。

CloudBackupFolderは、コマンドレットがクラウド変更操作を実行する前の、クラウドサイト構成バックアップのフルパスのファイル指定です。

SourceBackupFolderは、コマンドレットの完了後に作成されたソースファイルバックアップのフルパスのファイル指定です。デフォルトでは、これらのファイルは %HOMEPATH%\Documents\Citrix\AutoConfig にあります。

PowerShellヘルプ

コマンドレットごとに、PowerShellヘルプが提供されます。各コマンドレットのすべてのパラメーターが、コマンドレットの簡単な説明とともに文書化されています。コマンドレットのヘルプにアクセスするには、コマンドレットの前に「Get-Help」と入力します。

Get-Help Import-CvadAcToSite