Amazon WorkSpaces Core Managed Instances のカタログを作成する

最終公開日 : Nov 13, 2026
マシンカタログの作成 では、マシンカタログを作成するウィザードについて説明します。以下の情報では、Amazon WorkSpaces Core マネージドインスタンスに固有の詳細について説明します。
注:
現在、永続VMと非永続VMの両方のカタログの作成（CleanOnBoot プロパティが True または False）がサポートされています。
Related information
準備済みイメージマシンカタログを作成する

前提条件

Amazon WorkSpaces Core マネージドインスタンスのカタログを作成する前に、次の作成を完了する必要があります。
  1. Amazon WorkSpaces Core マネージドインスタンスへの接続。「Amazon WorkSpaces Core マネージドインスタンスへの接続」を参照してください。
  2. 準備されたイメージ。「Amazon WorkSpaces Core マネージドインスタンス用の準備されたイメージを作成する」を参照してください。

イメージ準備中のネットワーク設定

イメージ準備中に、元のVMに基づいて準備用仮想マシン（VM）が作成されます。この準備用VMはネットワークから切断されます。準備用VMからネットワークを切断するために、すべてのインバウンドおよびアウトバウンドトラフィックを拒否するネットワークセキュリティグループが作成されます。このネットワークセキュリティグループは永続的であり、再利用されます。ネットワークセキュリティグループの名前は Citrix.XenDesktop.IsolationGroup-GUID で、GUIDはランダムに生成されます。

マシンプロファイルベースのマシンカタログ

マシンプロファイルを使用して、EC2インスタンス（VM）または起動テンプレートバージョンからハードウェアプロパティをキャプチャし、プロビジョニングされたマシンに適用できます。キャプチャされるプロパティには、テナンシータイプ、インスタンスタイプ、セキュリティグループ、ネットワークマッピング、EBSボリュームプロパティ、EBS最適化、CPUオプション、ハイバネーション機能、その他のサポートされているAWS構成などが含まれます。
マシンプロファイルの入力として、AWS EC2インスタンス（VM）またはAWS起動テンプレートバージョンを使用できます。
注:
  • EBSボリュームプロパティは、マシンプロファイルからのみ派生します。
  • Instance Metadata Service (IMDS) V2 のみがサポートされており、IMDS V1 はサポートされていません。詳細については、「How Instance Metadata Service Version 2 works」を参照してください。

AWS テナンシー

AWS は、共有テナンシー（デフォルトタイプ）と専用テナンシーの次のテナンシーオプションを提供します。共有テナンシーとは、異なる顧客の複数の Amazon WorkSpaces Core インスタンスが同じ物理ハードウェア上に存在する可能性があることを意味します。専用テナンシーとは、Amazon WorkSpaces Core インスタンスが、展開した他のインスタンスと同じハードウェア上でのみ実行されることを意味します。
注:
専用インスタンスのみがサポートされています（専用ホストは現在サポートされていません）。他の顧客は同じハードウェアを使用しません。

テナンシータイプはマシンプロファイルから取得されます

MCS を使用して AWS でマシンをプロビジョニングするカタログを作成すると、テナンシータイプはマシンプロファイルから取得されます。
  • 共有ハードウェア：この設定は、ほとんどの展開に適しています。複数の顧客が互いにやり取りすることはありませんが、ハードウェアを共有します。共有ハードウェアを使用することは、Amazon EC2 インスタンスを実行するための最も安価なオプションです。
  • 専用インスタンス：この設定は、特定のセキュリティまたはコンプライアンス要件を持つ展開により適しています。専用インスタンスを使用すると、他の AWS 顧客とは別のホストを持つという利点を享受できますが、ホスト全体に対して料金を支払う必要はありません。ホストの容量について心配する必要はありませんが、インスタンスに対してはより高い料金が課金されます。さらに、専用インスタンスは、Bring Your Own License (BYOL) のサポートが限定的です。

カタログを作成する

Amazon WorkSpaces Coreマネージドインスタンスのカタログを作成するには、準備済みイメージとマシンプロファイルが必要です。マシンプロファイルの入力として、AWS VMインスタンスまたはAWS起動テンプレートバージョンを使用できます。
カタログは以下を使用して作成できます。

Web Studioを使用してカタログを作成する

「イメージ」ノードからマシンカタログを作成する

イメージノードのカタログの作成オプションを使用して、イメージバージョンでカタログを作成します。
または、マシンカタログノードでカタログを作成する際にバージョンを選択し、カタログ作成ワークフローで準備されたイメージオプションにリンクすることもできます。「マシンカタログ」ノードからマシンカタログを作成するを参照してください。
イメージノードからMCSマシンカタログを作成するには、次の手順を実行します。
  1. イメージバージョンを選択し、カタログの作成をクリックします。はじめにページで次へをクリックします。
  2. 「マシン管理」および「イメージ」ページでは、選択したイメージバージョンに基づいて設定が事前に選択されています。イメージページで、選択した準備済みイメージのメモを入力します。
  3. 次のページで設定を完了します。
  4. 概要ページで、マシンカタログの詳細を確認します。マシンカタログの名前と説明を入力します。完了をクリックします。
  5. マシンカタログノードに移動して、作成されたマシンカタログを表示します。

「マシンカタログ」ノードからマシンカタログを作成する

「マシンカタログ」ノードからMCSマシンカタログを作成するには、次の手順を実行します。
  1. 左側のナビゲーションペインでマシンカタログをクリックします。
  2. マシンカタログの作成をクリックします。マシンカタログのセットアップページが表示されます。
  3. マシンタイプページで、カタログのマシンタイプ（例: マルチセッションOS）を選択します。
  4. マシン管理ページで、次の設定を選択します。
    1. 「電源管理されるマシン (仮想マシンやブレードPCなど)」を選択します。
    2. 「Citrixプロビジョニングテクノロジー」を選択します。次に、「Citrix Machine Creation Services™」を選択します。
    3. 「リソース」フィールドで、ホスト接続の作成時に構成したリソース（アベイラビリティゾーンまたはローカルゾーン）を選択し、「次へ」をクリックします。
  5. 「デスクトップエクスペリエンス」ページで、ユーザーがログインしたときに使用するランダムまたは静的デスクトップのいずれかを選択します。静的デスクトップを選択した場合は、ユーザーがローカルディスクで行った変更を保存するかどうか（永続的または非永続的）をさらに指定します。
  6. 「イメージ」ページで、「イメージの選択」をクリックして、マシンカタログ用の準備済みイメージを選択します。作成した準備済みバージョンを選択します。イメージのバージョン名をクリックします。選択したイメージバージョンの詳細を表示するには、下線が引かれているバージョン番号をクリックします。「完了」をクリックします。
    準備済みイメージに関連付けられたマシンプロファイルが表示され、そのハードウェアプロパティ（インスタンスタイプ、テナンシータイプ、ネットワークマッピング、セキュリティグループ、ボリュームプロパティなど）がカタログ内のマシンを作成するために使用されます。マシンプロファイルのソースを別のVMまたは起動テンプレートバージョンに変更するには、編集ボタンをクリックします。
  7. 「仮想マシン」ページで、次の操作を行います。
    1. カタログのVM数を入力します。
    2. デフォルトのマシン仕様が表示されます。これはマシンプロファイルに基づいています。変更するには、編集アイコンを選択し、マシン仕様を選択します。
  8. 「NIC」ページで、VMのNIC（またはENI）を選択します。
  9. 「マシンID」ページで、カタログ内のマシンのマシンIDタイプを構成します。
    1. **ドメイン参加済みマシン（オンプレミスのActive DirectoryまたはMicrosoft Entraハイブリッド参加）**を構成するには、ドメインを選択し、このマシンカタログで作成するVMの新しいADアカウントを作成します。プロビジョニングされたVMは、選択したドメインに参加します。ドメイン非参加マシンをプロビジョニングするには、ドメイン非参加オプションを選択します。
    2. VM用に作成する新しいアカウントのアカウント命名スキームを指定します。
  10. 「ドメイン資格情報」ページで、「資格情報の入力」をクリックして、選択したドメインの資格情報を入力します。プロンプトが表示されたら、管理者レベルのユーザー名とパスワードを入力します。当社の製品ドキュメントに従って、ドメイン資格情報を以前に保存している場合は、サービスアカウントを使用することもできます。
  11. 「概要」ページが表示されるまで残りのページをクリックします。マシンカタログの名前を入力し、「完了」を選択してマシンカタログを作成します。

AWSローカルゾーンでのマシンカタログ作成に関する制限事項

  • 特定のローカルゾーンは特定のハードウェア構成のみをサポートします（例：パースのローカルゾーンはGP3ボリュームをサポートせず、GP2のみをサポートします）。
  • gp2はすべてのローカルゾーンで普遍的にサポートされており、すべてのローカルゾーンがgp3をサポートしているわけではないため、IDディスクの作成はデフォルトでgp2ボリュームタイプを使用します。
  • 目的のローカルゾーンでサポートされているハードウェア仕様を持つマシンプロファイルを選択する必要があります。
  • 準備されたイメージAMIスナップショットとIDディスクスナップショットは、デフォルトでローカルゾーンではなくリージョンに配置されます（ローカルゾーンでのEBSスナップショットサポートの可視性に関するAWSの制限のため）。
  • 完全なEC2およびEBSサービスをサポートするローカルゾーンのみがサポート対象ゾーンです。

PowerShellを使用してカタログを作成する

準備済みイメージバージョン仕様とマシンプロファイルを使用してカタログを作成する

  • New-ProvSchemeコマンドを使用して、準備済みイメージバージョン仕様からMCS非永続マシンカタログを作成します。例:
    New-ProvScheme -ProvisioningSchemeName <string> -ImageVersionSpecUid <Guid> -HostingUnitUid <Guid> -IdentityPoolUid <Guid> [-CleanOnBoot $true] [-MachineProfile <string>] [-ProvisioningSchemeType “MCS”]
  • New-ProvSchemeコマンドを使用して、準備済みイメージバージョン仕様からMCS永続マシンカタログを作成します。例:
    New-ProvScheme -ProvisioningSchemeName <string> -ImageVersionSpecUid <Guid> -HostingUnitUid <Guid> -IdentityPoolUid <Guid> [-CleanOnBoot $false] [-MachineProfile <string>] [-ProvisioningSchemeType “MCS”]
カタログを作成するためのPowershellコマンドの完全なセットの例:
$Catalog = New-BrokerCatalog  -AllocationType "Random"  -IsRemotePC $False  -MinimumFunctionalLevel "L7_20" -Name "wsccatalog" -PersistUserChanges "Discard" -ProvisioningType "MCS" -Scope @() -SessionSupport "MultiSession"

$IdentityPool = New-AcctIdentityPool  -AllowUnicode  -Domain "domainname" -IdentityPoolName "wsccatalog" -IdentityType "ActiveDirectory"  -NamingScheme "aws##" -NamingSchemeType "Numeric" -Scope @()

$PreparedImageVersionSpec = Get-ProvImageVersionSpec -ImageDefinitionName image1 -ImageVersionNumber 1 -Filter "PreparationType -eq 'Mcs'"

$Task = New-ProvScheme -ProvisioningSchemeName wsccatalog -ImageVersionSpecUid $PreparedImageVersionSpec.ImageVersionSpecUid -HostingUnitName wsc -IdentityPoolName wsccatalog -CleanOnBoot -Scope @() -SecurityGroup @() -MachineProfile 'XdHyp:\HostingUnits\cvad-test-scalestress\us-east-1a.availabilityzone\machine-profile-instance i (i-0xxxxxxxx).vm' -RunAsynchronously

Get-ProvTask -TaskId $Task.TaskId
$ProvScheme = Get-ProvScheme -ProvisioningSchemeName wsccatalog

Set-BrokerCatalog -Name $Catalog.Name -ProvisioningSchemeId $ProvScheme.ProvisioningSchemeUid

マシンプロファイルを更新する

マシンプロファイルで最初にプロビジョニングされたカタログのマシンプロファイルを更新するには、以下を実行します。MCSマシンカタログの編集中に、マシンプロファイルソースのテナンシータイプとハイバネーション機能を変更することもできます。
  1. Set-ProvSchemeコマンドを実行します。例：
    Set-ProvScheme `
    -ProvisioningSchemeUid "<ID" `
    -MachineProfile "XDHyp:\HostingUnits\abc\us-east-1a.availabilityzone\citrix-cvad-machineprofile-instance (i-0xxxxxxxx).vm"

PowerShellを使用して起動テンプレートバージョンでカタログを作成する

マシンプロファイル入力として起動テンプレートバージョンを使用してMCSマシンカタログを作成できます。また、マシンプロファイルカタログの入力をVMから起動テンプレートバージョンへ、または起動テンプレートバージョンからVMへ更新することもできます。
AWS EC2コンソールでは、起動テンプレートのインスタンス構成情報をバージョン番号とともに提供できます。マシンカタログの作成または更新時に、マシンプロファイル入力として起動テンプレートバージョンを指定すると、そのバージョンの起動テンプレートのプロパティがプロビジョニングされたVDA VMにコピーされます。
以下のプロパティは、マシンプロファイル入力を使用するか、New-ProvScheme または Set-ProvScheme コマンドでパラメーターとして明示的に指定できます。New-ProvScheme または Set-ProvScheme コマンドで指定された場合、これらのプロパティのマシンプロファイル値よりも優先されます。
  • サービスオファリング
  • ネットワーク
注:
マシンプロファイル起動テンプレートでサービスオファリングが提供されていない場合、または New-ProvScheme コマンドのパラメーターとして提供されていない場合、適切なエラーが発生します。
マシンプロファイル入力として起動テンプレートバージョンを使用してカタログを作成するには：
  1. PowerShell ウィンドウを開きます。
  2. Citrix固有のPowerShellモジュールをロードするために asnp citrix* を実行します。
  3. 起動テンプレートの起動テンプレートバージョンの一覧を取得します。例：
    XDHyp:\HostingUnits\test\test-mp-sard (lt-01xxxxx).launchtemplate> ls | Select FullPath
  4. 作成されていない場合は、IDプールを作成します。例：
    New-AcctIdentityPool `
    -IdentityPoolName "abc11" `
    -NamingScheme "abc1-##" `
    -NamingSchemeType Numeric `
    -Domain "citrix-xxxxxx.local" `
    -ZoneUid "xxxxxxxx" `
  5. マシンプロファイル入力として起動テンプレートバージョンを使用してプロビジョニングスキームを作成します。例：
    New-ProvScheme `
    -ProvisioningSchemeName "MPLT1" `
    -HostingUnitUid "c7f71f6a-3f45-4xxx-xxxx-xxxxxxxxxx" `
    -IdentityPoolUid "bf3a6ba2-1f80-4xxx-xxxx-xxxxxxxxx" `
    -ImageVersionSpecUid ‘24dfb047-e867-527g-896c-25664xxxxx1t’ `
    -CleanOnBoot `
    -MachineProfile "XDHyp:\HostingUnits\xxxx-ue1a\machineprofiletest (lt-01xxxxx).launchtemplate\lt-01xxxxx (1).launchtemplateversion"
  6. プロビジョニングスキームをブローカーカタログとして登録します。例：
    New-BrokerCatalog -Name "MPLT1" `
    -AllocationType Random `
    -Description "Machine profile catalog" `
    -ProvisioningSchemeId fe7df345-244e-4xxxx-xxxxxxxxx `
    -ProvisioningType Mcs `
    -SessionSupport MultiSession `
    -PersistUserChanges Discard
  7. カタログの作成を完了します。

マシンプロファイルのソースを更新する

マシンプロファイルカタログの入力を、VMから起動テンプレートバージョンへ、または起動テンプレートバージョンからVMへ更新することもできます。例：
  • マシンプロファイルカタログの入力をVMから起動テンプレートバージョンに更新するには：
    Set-ProvScheme -ProvisioningSchemeName "CloudServiceOfferingTest" `
    -MachineProfile "XDHyp:\HostingUnits\xxxx-ue1a\machineprofiletest (lt-0bxxxxxxxxxxxx).launchtemplate\lt-0bxxxxxxxxxxxx (1).launchtemplateversion"
  • マシンプロファイルカタログの入力を起動テンプレートバージョンからVMに更新するには：
    Set-ProvScheme -ProvisioningSchemeName "CloudServiceOfferingTest" `
    -MachineProfile "XDHyp:\HostingUnits\sard-ue1a\us-east-1a.availabilityzone\apollo-non-persistent-vda-win2022-2 (i-08xxxxxxxxx).vm"

OSディスクとIDディスクを暗号化する

OSディスクとIDディスク（Identity Disk）の暗号化に使用できるAWS KMSキー（カスタマー管理キーおよびAWS管理キー）を使用して、VMのカタログを作成できます。
  • AWS管理キーは毎年自動的にローテーションされます。
  • カスタマー管理キーは自動ローテーションがオプションであり、手動で管理できます。
KMSキーの詳細については、以下のAWSドキュメントを参照してください。
OSディスクとIDディスクの暗号化には、以下のいずれかを構成します。
  • 暗号化された準備済みイメージを使用します（例：KMSキーで暗号化されたEBSルートボリュームを含むインスタンスまたはスナップショットから作成されたAMI）
  • 暗号化されたEBSルートボリュームを含むマシンプロファイルソース（VMまたは起動テンプレート）を使用します。

制限事項

次の制限事項を考慮してください。
  • MCSは現在、準備済みイメージAMI上のディスクを1つのみサポートしています。
  • 既存の暗号化されていないEBSボリュームやスナップショットを直接暗号化したり、既存の暗号化されたボリュームのKMSキーを変更したりすることはできません。これを行うには、次の手順を実行する必要があります。
    1. そのボリュームの新しいスナップショットを作成します。
    2. そのスナップショットから新しいボリュームを作成します
    3. 新しいボリュームを暗号化します。
以下のAWSドキュメントを参照してください。

ディスク暗号化を使用してカタログを作成する

ディスク暗号化を使用して MCS マシンカタログを作成するには、次のものを使用できます。
  • 準備済みイメージ（暗号化されたディスクを持つマスターイメージからイメージ管理を使用して作成）
  • マシンプロファイル
マシンプロファイル入力を使用する際の考慮事項は次のとおりです。
  • マシンプロファイル入力の KMS キーは、準備されたイメージの KMS キーよりも優先されます。
  • マシンプロファイル入力が提供されない場合、準備されたイメージAMIのKMSキーがカタログVMのディスクを暗号化するために使用されます。
  • マシンプロファイルにブロックデバイスマッピングが存在する場合、準備されたイメージテンプレート (AMI) とマシンプロファイルに存在するブロックデバイスは一致する必要があります。たとえば、AMIに/dev/sda1で定義されたデバイスがある場合、マシンプロファイルにも/dev/sda1で定義されたデバイスが必要です。
  • マシンプロファイルソースにキーがなく、準備されたイメージが暗号化されていない場合、カタログVMのディスクは暗号化されません。
  • 準備されたイメージが暗号化されている場合、マシンプロファイルソースVMまたは起動テンプレートには、有効な入力と見なされるために暗号化されたルートボリュームが必要です。

既存のカタログを変更する

Set-ProvScheme PowerShellコマンドを使用して、既存のカタログを次のように変更できます。
  • 新しいKMSキーを含むボリュームを持つマシンプロファイル入力。
  • イメージ管理を使用して、暗号化されたAMIを持つマスターイメージから作成された準備済みイメージ。
重要な考慮事項：
  • カタログに追加された新しいVMのボリュームは、新しいKMSキーで暗号化されます。
  • 既存のマシンプロファイルがある場合に暗号化設定を更新するには、新しいマシンプロファイルでSet-ProvSchemeを実行します。
  • 既存のカタログを、暗号化されたボリュームから暗号化されていないボリュームに変更することはできません。 暗号化された準備済みイメージAMIから暗号化されていない準備済みイメージAMIへのイメージ更新はできません。

VMインスタンスでNitroTPMとUEFIセキュアブートを有効にする

カタログを作成する際、NitroTPMおよび/またはUEFIセキュアブートが有効な準備済みイメージ (AMI) を選択できるようになりました。これにより、カタログ内のプロビジョニングされたVMもNitroTPMおよび/またはUEFIセキュアブートが有効になります。この実装により、VMが安全で信頼できるものになります。NitroTPMおよびUEFIセキュアブートの詳細については、Amazonドキュメントを参照してください。

制限事項

  • NitroTPMとSecure Bootは現在、中国を除くすべてのAWSリージョン（AWS GovCloud (US) リージョンを含む）で利用できます。
  • 既存のカタログでNitroTPMとUEFIセキュアブートを有効にすることはできません。NitroTPMとUEFIセキュアブートが有効なカタログが必要な場合は、新しいカタログを作成してください。

主要な手順

  1. AWS環境をセットアップします。
  2. AWSへの接続を作成します。
  3. NitroTPMおよび/またはUEFIセキュアブートが有効なマスターイメージ（AMI）を作成します(#create-an-ami-that-supports-nitrotpm-and-uefi-secure-boot)。
  4. マスターイメージから準備済みイメージを作成します。Amazon WorkSpaces Core Managed Instances 用の準備済みイメージを作成するを参照してください。
  5. Web Studioのカタログ作成メニューでNitroTPMとUEFIセキュアブートが有効な準備済みイメージを選択するか、PowerShellコマンドを使用してプロビジョニングスキームを作成する際に、マシンカタログを作成します。
作成されたカタログに追加されたVMは、NitroTPMおよびUEFIセキュアブートが有効になっています。

NitroTPMおよびUEFIセキュアブートをサポートするAMIを作成する

  1. NitroTPMおよび/またはUEFIセキュアブートが有効になっているVMからAMIを作成できます。
    1. AWS Marketplaceイメージを使用してインスタンスを作成します。例：TPM-Windows_Server-2022-English-Full-Base on the aws-marketplaceを検索します。
    2. シングルセッションまたはマルチセッションVDAをダウンロードします。
    3. そのVMからAMIを作成します。
  2. register-imageコマンドを使用します。
    --boot-mode (string)
    --tpm-support (string)
    詳細については、register-imageを参照してください。
以下のAWSドキュメントを参照してください。
Delivery Controller™ホストからPowerShellウィンドウを開いて、特定の項目を確認できます。
  • サービス提供がNitroTPMまたはUEFIセキュアブートをサポートしているか
    (Get-Item -Path “XDHyp:\HostingUnits\aws\T3 Medium Instance.serviceoffering”).AdditionalData.BootMode
    (Get-Item -Path “XDHyp:\HostingUnits\aws\T3 Medium Instance.serviceoffering”).AdditionalData.NitroTpmSupportVersions
  • テンプレートがNitroTPMまたはUEFIセキュアブートをサポートしているか
    (Get-HypInventoryItem -LiteralPath “XDHyp:\HostingUnits\aws” -ResourceType “template -Id “ID”).AdditionalData.BootMode

    (Get-HypInventoryItem -LiteralPath “XDHyp:\HostingUnits\aws” -ResourceType “template -Id “ID”).AdditionalData.TpmSupport

既存のカタログのサービス提供を更新する

Set-ProvSchemeを使用して、既存のカタログのサービス提供を変更できます。この変更は、新しく追加されたVMに適用されます。ただし、次のシナリオではエラーが発生します。
AMIのブートモード AMIはNitro TPMをサポートしていますか？ サービス提供はNitroTPMとUEFIセキュアブートをサポートしていますか？
UEFI いいえ いいえ
レガシーBIOS はい いいえ
UEFI はい いいえ
UEFI優先 はい いいえ

VM上のタグをコピーする

マシンプロファイルで指定されたNIC、およびディスク（IDディスク、ライトバックキャッシュディスク、OSディスク）のタグを、MCSマシンカタログで新しく作成されたVMにコピーできます。これらのタグは、マシンプロファイルのソース（AWS VMインスタンスまたはAWS起動テンプレートバージョン）のいずれかで指定できます。この機能は、永続および非永続マシンカタログとVMに適用されます。
注:
  • AWS EC2コンソールでは、起動テンプレートバージョンリソースタグの下にネットワークインターフェイスのタグの値が表示されません。ただし、PowerShellコマンド aws ec2 describe-launch-template-versions --launch-template-id lt-0bb652503d45dcbcd --versions 12 を実行すると、タグの仕様を確認できます。
  • マシンプロファイルのソース（VMまたは起動テンプレートバージョン）に2つのネットワークインターフェイス（eni-1とeni-2）があり、eni-1にタグt1、eni-2にタグt2がある場合、VMは両方のネットワークインターフェイスのタグを取得します。

PowerShellを使用してVMインスタンスをフィルタリングする

マシンプロファイルVMとして使用するAWS VMインスタンスは、マシンカタログが正しく作成され機能するために互換性がある必要があります。マシンプロファイルの入力VMとして使用できるAWS VMインスタンスを一覧表示するには、Get-HypInventoryItem コマンドを使用できます。このコマンドは、ホスティングユニットで利用可能なVMのインベントリをページングおよびフィルタリングできます。
ページネーション：
Get-HypInventoryItem は、2つのページネーションモードをサポートしています。
  • ページングモードでは、-MaxRecords と -Skip パラメーターを使用してアイテムのセットを返します。
    • -MaxRecords: デフォルトは 1 です。これは、返すアイテムの数を制御します。
    • -Skip: デフォルトは 0 です。これは、ハイパーバイザー内のリストの絶対的な先頭 (または絶対的な末尾) からスキップするアイテムの数を制御します。
  • スクロールモードでは、-MaxRecords、-ForwardDirection、および -ContinuationToken パラメーターを使用してレコードのスクロールを許可します。
    • -ForwardDirection: デフォルトは True です。これは -MaxRecords とともに使用され、一致するレコードの次のセットまたは前のセットのいずれかを返します。
    • -ContinuationToken: ContinuationToken で指定されたアイテムを含まずに、その直後 (または ForwardDirection が false の場合は直前) のアイテムを返します。
ページネーションの例:
  • 最も名前の小さいマシンテンプレートの単一レコードを返します。AdditionalData フィールドには TotalItemsCount と TotalFilteredItemsCount があります。
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template
  • 最も低い名前を持つマシンのテンプレートのレコードを10件返すには:
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 10 | select Name
  • 最も高い名前で終わるレコードの配列を返すには:
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -ForwardDirection $False -MaxRecords 10 | select Name
  • 指定された ContinuationToken に関連付けられたマシンテンプレートから始まるレコードの配列を返します。
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -ContinuationToken "ami-07xxxxxxxxxx" -MaxRecords 10
フィルタリング:
フィルタリングには、以下の追加のオプションパラメーターがサポートされています。これらのパラメーターは、ページネーションオプションと組み合わせることができます。
  • -ContainsName "my_name": 指定された文字列がAMI名の一部と一致する場合、そのAMIはGetの結果に含まれます。例:
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 100 -ContainName ‘apollo’ | select Name
  • -Tags '{ "Key0": "Value0", "Key1": "Value1", "Key2": "Value2" }': AMIがこれらのタグの少なくとも1つを持っている場合、そのAMIはGetの結果に含まれます。例:
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 100 -Tags '{"opex owner": "Not tagged"}' | select Name
    注:
    2つのタグ値がサポートされています。Not Tagged タグ値は、タグのリストに指定されたタグがない項目と一致します。All values タグ値は、タグの値に関係なくタグを持つ項目と一致します。それ以外の場合、一致は、項目がタグを持ち、その値がフィルターで指定された値と等しい場合にのみ発生します。
  • -Id "ami-0a2d913927e0352f3": AMIが指定されたIDと一致する場合、そのAMIはGetの結果に含まれます。例:
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -Id ami-xxxxxxxxxxxxx
AdditionalDataパラメーターでのフィルタリング:
AdditionalDataフィルターパラメーターは、テンプレートまたはVMを、その機能、サービス提供、またはAdditionalDataにある任意のプロパティに基づいて一覧表示します。例:
(Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\aws" -MaxRecords 200).AdditionalData
互換性のないVMを示すために、-Warnパラメーターを追加することもできます。VMには、Warningという名前のAdditionalDataフィールドが含まれます。例:
(Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\aws" -MaxRecords 200 -Template "ami-015xxxxxxxxx" -Warn $true).AdditionalData

次のステップ

  • Amazon WorkSpaces Coreカタログの管理については、Amazon WorkSpaces Coreマネージドインスタンスのカタログを管理するを参照してください。

詳細情報