Amazon WorkSpaces Coreマネージドインスタンスのカタログ作成
マシンカタログの作成では、マシンカタログを作成するウィザードについて説明しています。以下の情報では、Amazon WorkSpaces Coreマネージドインスタンスに固有の詳細について説明します。
注：
現在、永続VMと非永続VMの両方のカタログ（
CleanOnBootプロパティがTrueまたはFalse）の作成がサポートされています。
前提条件
Amazon WorkSpaces Coreマネージドインスタンスのカタログを作成する前に、以下の作成を完了する必要があります。
- Amazon WorkSpaces Coreマネージドインスタンスへの接続。詳細については、「Amazon WorkSpaces Coreマネージドインスタンスへの接続」を参照してください。
- 準備済みイメージ。詳細については、「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は、共有テナンシー（デフォルトタイプ）と専用テナンシーの2つのテナンシーオプションを提供しています。共有テナンシーとは、異なる顧客の複数の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マシンカタログを作成するには、次の手順を実行します。
-
- イメージバージョンを選択し、カタログの作成をクリックします。はじめにページで次へをクリックします。
-
- マシン管理ページとイメージページでは、選択したイメージバージョンに基づいて設定が事前選択されています。イメージページで、選択した準備済みイメージのメモを入力します。
-
- 次のページで設定を完了します。
-
- 概要ページで、マシンカタログの詳細を確認します。マシンカタログの名前と説明を入力します。完了をクリックします。
-
- マシンカタログノードに移動して、作成されたマシンカタログを確認します。
マシンカタログノードからのマシンカタログの作成
マシンカタログノードからMCSマシンカタログを作成するには、次の手順を実行します。
- 左側のナビゲーションペインでマシンカタログをクリックします。
-
- マシンカタログの作成をクリックします。マシンカタログのセットアップページが表示されます。
- マシンタイプページで、カタログのマシンタイプ（例：マルチセッションOS）を選択します。
-
マシン管理ページで、次の設定を選択します。
- 電源管理されているマシン（仮想マシンやブレードPCなど）を選択します。
- Citrixプロビジョニングテクノロジーを選択します。次に、Citrix Machine Creation Services™を選択します。
- リソースフィールドで、ホスト接続の作成時に構成したリソース（アベイラビリティーゾーンまたはローカルゾーン）を選択し、次へをクリックします。
- デスクトップエクスペリエンスページで、ユーザーがログオンしたときに使用するランダムデスクトップまたは静的デスクトップのいずれかを選択します。静的デスクトップが選択されている場合、ユーザーがローカルディスクに行った変更を保存するかどうか（永続的または非永続的）をさらに指定します。
-
イメージページで、イメージの選択をクリックして、マシンカタログの準備済みイメージを選択します。作成した準備済みバージョンを選択します。イメージバージョン名をクリックします。選択したイメージバージョンの詳細を表示するには、下線が引かれているバージョン番号をクリックします。完了をクリックします。
準備済みイメージに関連付けられたマシンプロファイルが表示され、そのハードウェアプロパティ（例：インスタンスタイプ、テナンシータイプ、ネットワークマッピング、セキュリティグループ、ボリュームプロパティ）がカタログ内のマシンを作成するために使用されます。マシンプロファイルのソースを別のVMまたは起動テンプレートバージョンに変更するには、編集ボタンをクリックします。
-
仮想マシンページで：
- カタログのVM数を入力します。
- デフォルトのマシンスペックが表示されます。これはマシンプロファイルに基づいています。変更するには、編集アイコンを選択し、マシンスペックを選択します。
- NICページで、VMのNIC（またはENI）を選択します。
-
マシンIDページで、カタログ内のマシンのマシンIDタイプを構成します。
- ドメイン参加済みマシン（オンプレミスActive DirectoryまたはMicrosoft Entraハイブリッド参加済み）を構成するには、ドメインを選択し、このマシンカタログで作成されるVMの新しいADアカウントを作成します。プロビジョニングされたVMは、選択したドメインに参加します。ドメイン非参加マシンをプロビジョニングするには、ドメイン非参加オプションを選択します。
- VM用に作成される新しいアカウントのアカウント命名スキームを指定します。
- ドメインクレデンシャルページで、クレデンシャルの入力をクリックして、選択したドメインのクレデンシャルを提供します。プロンプトが表示されたら、管理者レベルのユーザー名とパスワードを入力します。以前にドメインクレデンシャルを保存している場合は、弊社の製品ドキュメントに従ってサービスアカウントを使用することもできます。
- 残りのページをクリックしてサマリーページに進みます。マシンカタログの名前を入力し、完了を選択してマシンカタログを作成します。
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”] <!--NeedCopy--> -
準備されたイメージバージョン仕様から
New-ProvSchemeコマンドを使用してMCS永続マシンカタログを作成します。例：New-ProvScheme -ProvisioningSchemeName <string> -ImageVersionSpecUid <Guid> -HostingUnitUid <Guid> -IdentityPoolUid <Guid> [-CleanOnBoot $false] [-MachineProfile <string>] [-ProvisioningSchemeType “MCS”] <!--NeedCopy-->
カタログを作成するための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
<!--NeedCopy-->
マシンプロファイルの更新
マシンプロファイルで最初にプロビジョニングされたカタログのマシンプロファイルを更新するには、次の手順を実行します。MCSマシンカタログを編集する際に、マシンプロファイルソースのテナンシータイプとハイバネーション機能を変更することもできます。
-
Set-ProvSchemeコマンドを実行します。例：Set-ProvScheme ` -ProvisioningSchemeUid "<ID" ` -MachineProfile "XDHyp:\HostingUnits\abc\us-east-1a.availabilityzone\citrix-cvad-machineprofile-instance (i-0xxxxxxxx).vm" <!--NeedCopy-->
PowerShellを使用した起動テンプレートバージョンによるカタログの作成
起動テンプレートバージョンをマシンプロファイル入力として使用して、MCSマシンカタログを作成できます。また、マシンプロファイルカタログの入力をVMから起動テンプレートバージョンへ、および起動テンプレートバージョンからVMへ更新することもできます。
AWS EC2コンソールでは、起動テンプレートのインスタンス構成情報をバージョン番号とともに提供できます。マシンカタログの作成または更新時に起動テンプレートバージョンをマシンプロファイル入力として指定すると、そのバージョンの起動テンプレートのプロパティがプロビジョニングされたVDA VMにコピーされます。
-
以下のプロパティは、マシンプロファイル入力を使用するか、
New-ProvSchemeまたはSet-ProvSchemeコマンドでパラメーターとして明示的に指定できます。New-ProvSchemeまたはSet-ProvSchemeコマンドで指定された場合、これらのプロパティのマシンプロファイル値よりも優先されます。 - サービスオファリング
-
ネットワーク
-
注：
-
マシンプロファイルの起動テンプレートまたは
New-ProvSchemeコマンドのパラメーターとしてサービスオファリングが提供されていない場合、適切なエラーが発生します。 - 起動テンプレートバージョンをマシンプロファイル入力として使用してカタログを作成するには：
- PowerShellウィンドウを開きます。
-
asnp citrix*を実行して、Citrix固有のPowerShellモジュールをロードします。 -
起動テンプレートの起動テンプレートバージョンの一覧を取得します。例：
```
-
XDHyp:\HostingUnits\test\test-mp-sard (lt-01xxxxx).launchtemplate> ls Select FullPath ```
-
- 作成されていない場合は、IDプールを作成します。例：
```
-
New-AcctIdentityPool `
- -IdentityPoolName “abc11” `
- -NamingScheme “abc1-##” `
- -NamingSchemeType Numeric `
-
-Domain “citrix-xxxxxx.local” ` -ZoneUid “xxxxxxxx” `
```
-
- 起動テンプレートバージョンをマシンプロファイル入力として使用してプロビジョニングスキームを作成します。例：
```
-
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”
```
-
プロビジョニングスキームをブローカーカタログとして登録します。例：
New-BrokerCatalog -Name "MPLT1" ` -AllocationType Random ` -Description "Machine profile catalog" ` -ProvisioningSchemeId fe7df345-244e-4xxxx-xxxxxxxxx ` -ProvisioningType Mcs ` -SessionSupport MultiSession ` -PersistUserChanges Discard <!--NeedCopy--> -
カタログの作成を完了します。
マシンプロファイルソースの更新
マシンプロファイルカタログの入力を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" <!--NeedCopy-->
OSディスクとIDディスクの暗号化
OSディスクとIDディスク（ID）の暗号化に使用できるAWS KMSキー（カスタマー管理キーとAWS管理キー）を使用してVMのカタログを作成できます。
- AWS管理キーは毎年自動的にローテーションされます。
- カスタマー管理キーは自動ローテーションがオプションであり、手動で管理できます。
KMSキーの詳細については、以下のAWSドキュメントを参照してください：
OSディスクとIDディスクの暗号化には、次のいずれかを構成します：
- 暗号化された準備済みイメージを使用する（例：KMSキーで暗号化されたEBSルートボリュームを含むインスタンスまたはスナップショットから作成されたAMI）
- 暗号化されたEBSルートボリュームを含むマシンプロファイルソース（VMまたは起動テンプレート）を使用する。
制限事項
- 以下の制限事項を考慮してください。
- MCSは現在、準備済みイメージAMI上のディスクを1つのみサポートしています。
-
既存の暗号化されていないEBSボリュームまたはスナップショットを直接暗号化したり、既存の暗号化されたボリュームのKMSキーを変更したりすることはできません。これを行うには、次の手順を実行する必要があります。
-
- そのボリュームの新しいスナップショットを作成します。 1. そのスナップショットから新しいボリュームを作成します。 1. 新しいボリュームを暗号化します。
-
-
以下のAWSドキュメントを参照してください。
- 暗号化されていないリソースの暗号化
- EBSボリュームの自動またはデフォルトの暗号化の制限事項: 既存および新規のAmazon EBSボリュームを自動的に暗号化する。
ディスク暗号化を使用したカタログの作成
ディスク暗号化を使用して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ドキュメントを参照してください。
制限事項
- 現在、中国を除くすべてのAWSリージョン（AWS GovCloud (US)リージョンを含む）でNitroTPMとセキュアブートの両方を使用できます。
-
既存のカタログでNitroTPMおよびUEFIセキュアブートを有効にすることはできません。NitroTPMおよびUEFIセキュアブートが有効なカタログが必要な場合は、新しいカタログを作成してください。
-
主要な手順
-
- AWS環境をセットアップします。
- AWSへの接続を作成します。
- NitroTPMおよび/またはUEFIセキュアブートが有効なマスターイメージ（AMI）を作成します。
- マスターイメージから準備済みイメージを作成します。Amazon WorkSpaces Coreマネージドインスタンス用の準備済みイメージの作成を参照してください。
- Web Studioのカタログ作成メニューでNitroTPMおよびUEFIセキュアブートが有効な準備済みイメージを選択するか、PowerShellコマンドを使用してプロビジョニングスキームを作成する際に、マシンカタログを作成します。
作成されたカタログに追加されたVMは、NitroTPMおよびUEFIセキュアブートが有効になります。
NitroTPMおよびUEFIセキュアブートをサポートするAMIの作成
-
NitroTPMおよび/またはUEFIセキュアブートが有効なVMからAMIを作成できます。
- AWS Marketplaceイメージを使用してインスタンスを作成します。例として、
TPM-Windows_Server-2022-English-Full-Base on the aws-marketplaceを検索します。 - シングルまたはマルチセッションVDAをダウンロードします。
- そのVMからAMIを作成します。
- AWS Marketplaceイメージを使用してインスタンスを作成します。例として、
-
register-imageコマンドを使用します。
--boot-mode (string) --tpm-support (string) <!--NeedCopy-->詳細については、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 <!--NeedCopy--> -
テンプレートが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 <!--NeedCopy-->
既存のカタログのサービスオファリングの更新
Set-ProvSchemeを使用して、既存のカタログのサービスオファリングを変更できます。この変更は、新しく追加されたVMに適用されます。ただし、以下のシナリオではエラーが発生します。
| AMIのブートモード | AMIはNitro TPMをサポートしていますか？ | サービス提供はNitroTPMとUEFIセキュアブートをサポートしていますか？ |
|---|---|---|
| UEFI | いいえ | いいえ |
| Legacy BIOS | はい | いいえ |
| UEFI | はい | いいえ |
| UEFI Preferred | はい | いいえ |
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 <!--NeedCopy--> -
最も名前の小さいマシンテンプレートの10個のレコードを返します。
Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 10 | select Name <!--NeedCopy--> -
最も名前の大きいレコードで終わるレコードの配列を返します。
Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -ForwardDirection $False -MaxRecords 10 | select Name <!--NeedCopy--> -
指定された
ContinuationTokenに関連付けられたマシンテンプレートから始まるレコードの配列を返します。Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -ContinuationToken "ami-07xxxxxxxxxx" -MaxRecords 10 <!--NeedCopy-->
フィルタリング：
フィルタリングには、以下の追加のオプションパラメーターがサポートされています。これらのパラメーターは、ページネーションオプションと組み合わせることができます。
-
-ContainsName "my_name": 指定された文字列がAMI名の一部と一致する場合、そのAMIはGet結果に含まれます。例：Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 100 -ContainName ‘apollo’ | select Name <!--NeedCopy--> -
-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 <!--NeedCopy-->注：
2つのタグ値がサポートされています。タグなしタグ値は、タグのリストに指定されたタグがないアイテムと一致します。すべての値タグ値は、タグの値に関係なくタグを持つアイテムと一致します。それ以外の場合、一致は、アイテムがタグを持ち、その値がフィルターで指定されたものと等しい場合にのみ発生します。
-
-Id "ami-0a2d913927e0352f3": AMIが指定されたIDと一致する場合、そのAMIはGet結果に含まれます。例：Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -Id ami-xxxxxxxxxxxxx <!--NeedCopy-->
AdditionalDataパラメーターでのフィルタリング：
AdditionalData フィルターパラメーターは、テンプレートまたはVMをその機能、サービス提供、またはAdditionalDataにある任意のプロパティに基づいてリストします。例：
(Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\aws" -MaxRecords 200).AdditionalData
<!--NeedCopy-->
互換性のないVMを示すために、-Warn パラメーターを追加することもできます。VMは、Warningという名前の AdditionalData フィールドとともに含まれます。例：
(Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\aws" -MaxRecords 200 -Template "ami-015xxxxxxxxx" -Warn $true).AdditionalData
<!--NeedCopy-->
次のステップ
- Amazon WorkSpaces Coreカタログの管理については、「Amazon WorkSpaces Coreマネージドインスタンスのカタログを管理する」を参照してください。
詳細情報
- AWS仮想化環境
- Amazon WorkSpaces Coreマネージドインスタンスへの接続
- イメージ管理
- Amazon WorkSpaces Coreマネージドインスタンス用の準備済みイメージを作成する
- Amazon WorkSpaces Core GitHub PowerShellの例については、「citrix-mcs-sdk-samples-Amazon WorkSpaces Core」を参照してください。