AWSカタログを作成する

最終公開日 : Nov 13, 2026
マシンカタログの作成では、マシンカタログを作成するウィザードについて説明しています。以下の情報は、AWS仮想化環境に固有の詳細を扱っています。
注:
AWSカタログを作成する前に、AWSへの接続の作成を完了する必要があります。AWSへの接続を参照してください。
Related information
マシンカタログを作成する

制限事項

Citrix Virtual Apps and Desktops™ 2203 LTSR以降では、MCS AWSプラグインがDescribeInstanceTypes AWS API呼び出しを行い、それが成功すると、MCSはAPI応答から作成されたインベントリ名を使用します。
したがって、CVAD 1912から2203以降にアップグレードする場合は、AWSのDefineInstanceType権限を無効にし、Set-ProvSchemeコマンドを使用して既存のカタログを更新してAWSの命名スキームに合わせます。その後、カタログの更新が完了し、サービス提供がAWSの命名スキームに一致したら、DescribeInstanceType権限を再度追加します。

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

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

AWSテナンシーを構成する

AWSは以下のテナンシーオプションを提供します。
  • 共有テナンシー（デフォルトタイプ）：異なる顧客の複数のAmazon EC2インスタンスが同じ物理ハードウェア上に存在する場合があります。
  • 専用テナンシー：EC2インスタンスは、デプロイした他のインスタンスと同じハードウェア上でのみ実行されます。他の顧客は同じハードウェアを使用しません。
PowerShellを使用して、MCSでAWS専用ホストをプロビジョニングできます。

PowerShellを使用したAWS専用ホストテナンシーの構成

PowerShellを通じてホストテナンシーが定義されたマシンカタログを作成できます。
Amazon 専用ホストは、インスタンス容量を持つ物理サーバーであり、完全に専用であるため、既存のソケットごとまたはVMごとのソフトウェアライセンスを使用できます。
専用ホストには、インスタンスタイプに基づいて事前設定された利用率があります。たとえば、C4 Large インスタンスタイプの単一の割り当てられた専用ホストは、16 インスタンスの実行に制限されます。詳細については、AWS サイト を参照してください。
AWSホストへのプロビジョニングの要件は次のとおりです。
  • インポートされたBYOL（bring your own license）イメージ（AMI）。専用ホストでは、既存のライセンスを使用および管理します。
  • プロビジョニング要求を満たすのに十分な利用率を持つ専用ホストの割り当て。
  • 自動配置を有効にします。
PowerShell を使用して AWS の専用ホストにプロビジョニングするには、New-ProvScheme コマンドレットを、パラメーター TenancyType を Host に設定して使用します。
詳細については、Citrix Developer Documentation を参照してください。

AMI からマシンプロパティをキャプチャする

AWS で Machine Creation Services (MCS) を使用してマシンをプロビジョニングするためのカタログを作成するときは、そのカタログのマスター/ゴールデンイメージを表す AMI を選択します。その AMI から、MCS はディスクのスナップショットを使用します。以前のリリースでは、マシンにロールやタグを設定したい場合、AWS コンソールを使用して個別に設定していました。この機能はデフォルトで有効になっています。
ヒント:
AWS インスタンスプロパティキャプチャを使用するには、AMI に関連付けられた VM が必要です。
このプロセスを改善するために、MCS は AMI が取得されたインスタンスからプロパティを読み取り、そのマシンの Identity Access Management (IAM) ロールとタグを、特定のカタログ用にプロビジョニングされたマシンに適用します。このオプション機能を使用する場合、カタログ作成プロセスは、選択された AMI ソースインスタンスを見つけ、限られたプロパティセットを読み取ります。これらのプロパティは AWS Launch Template に保存され、そのカタログのマシンをプロビジョニングするために使用されます。カタログ内のすべてのマシンは、キャプチャされたインスタンスプロパティを継承します。
キャプチャされるプロパティには以下が含まれます。
  • IAMロール – プロビジョニングされたインスタンスに適用されます。
  • タグ – プロビジョニングされたインスタンス、そのディスク、およびNICに適用されます。これらのタグは、S3バケットとオブジェクト、AMI、スナップショット、起動テンプレートを含む、一時的なCitrix®リソースに適用されます。
ヒント:
一時的なCitrixリソースのタグ付けはオプションであり、カスタムプロパティ AwsOperationalResourcesTagging を使用して構成できます。

AWS インスタンスプロパティをキャプチャする

AWSホスティング接続のプロビジョニングスキームを作成する際に、カスタムプロパティ AwsCaptureInstanceProperties を指定することで、この機能を使用できます。
New-ProvScheme -CustomProperties "AwsCaptureInstanceProperties,true" …<standard provscheme parameters
詳細については、Citrix Developer Documentation を参照してください。
注:
AwsCaptureInstanceProperties は非推奨です。代わりに、VMのプロパティを指定するにはマシンプロファイルを使用することをお勧めします。

マシンプロファイルからマシンプロパティをキャプチャする

MCSを使用してAWSマシンをプロビジョニングするためのカタログを作成する際、マシンプロファイルを使用して特定のマシンプロパティ設定をプリセットできます。
これを行うには、次の手順に従います。
  1. このカタログを作成するリソースと同じアベイラビリティゾーンにマシンプロファイルを保存します。
  2. カタログ作成ウィザードの ページで、 を選択します。選択したリソースと同じアベイラビリティゾーンにあるマシンプロファイルが表示されます。
  3. 必要に応じてマシンプロファイルを選択します。
注：
マシンプロファイルまたはAMIのいずれかを使用して、マシンのプロパティをキャプチャできます。Web Studioで、マシンプロファイルを使用を選択すると、仮想マシンにマシンテンプレートプロパティを適用オプションは自動的に非表示になります。

AWS運用リソースのタグ付け

MCSを使用してAWSでマシンをプロビジョニングするためのカタログを作成する際、IAMロールとタグプロパティをそれらのマシンに適用するかどうかを制御できます。また、マシンタグを運用リソースに適用するかどうかも制御できます。
Amazon Machine Image (AMI) は、Amazon Cloud環境内で仮想マシンを作成するために使用される仮想アプライアンスの一種であり、一般にEC2と呼ばれます。AMIを使用して、EC2環境を使用するサービスを展開します。MCS for AWSを使用してマシンをプロビジョニングするためのカタログを作成する際、そのカタログのゴールデンイメージとして機能するAMIを選択します。
重要：
インスタンスプロパティと起動テンプレートをキャプチャしてカタログを作成することは、運用リソースのタグ付けを使用するために必要です。
AWSカタログを作成するには、まずゴールデンイメージとするインスタンスのAMIを作成する必要があります。MCSはそのインスタンスからタグを読み取り、起動テンプレートに組み込みます。その後、起動テンプレートのタグは、AWS環境で作成されたすべてのCitrixリソースに適用されます。これには以下が含まれます。
  • 仮想マシン
  • VMディスク
  • VMネットワークインターフェイス
  • S3バケット
  • S3オブジェクト
  • 起動テンプレート
  • エーエムアイ

運用リソースにタグ付けする

PowerShell を使用してリソースにタグを付けるには:
  1. DDC ホストから PowerShell ウィンドウを開きます。
  2. Citrix 固有の PowerShell モジュールをロードするには、コマンド asnp citrix を実行します。
プロビジョニングされた VM のリソースにタグを付けるには、新しいカスタムプロパティ AwsOperationalResourcesTagging を使用します。このプロパティの構文は次のとおりです。
New-ProvScheme -CustomProperties "AwsCaptureInstanceProperties,true; AwsOperationalResourcesTagging,true" …<standard provscheme parameters>

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 は両方のネットワークインターフェイスのタグを取得します。

マシンプロファイルを使用してカタログを作成する

マシンプロファイルを使用して、EC2インスタンス (VM) または起動テンプレートバージョンからハードウェアプロパティを取得し、プロビジョニングされたマシンに適用できます。取得されるプロパティには、例えば、EBSボリュームプロパティ、インスタンスタイプ、EBS最適化、CPUオプション、テナンシータイプ、ハイバネーション機能、その他のサポートされているAWS構成が含まれます。
マシンプロファイルの入力として、AWS EC2インスタンス (VM) またはAWS起動テンプレートバージョンを使用できます。
注：
  • EBSボリュームのプロパティは、マシンプロファイルからのみ派生します。
  • MCSは、GP3ボリュームタイプのIDディスクを持つVMをプロビジョニングします。GP3ボリュームタイプはAWSが提供する最も安価なオプションであるため、この機能はコストを最小限に抑えます。この実装は、新しいカタログに追加されたVMと、既存のカタログに追加された新しいVMにのみ適用されます。この機能が導入される前に作成された既存のVMは、IDディスクがリセットされない限り、GP2ボリュームタイプのIDディスクを引き続き使用します。

重要な考慮事項

MCSマシンカタログを作成する際の重要な考慮事項：
  • New-ProvSchemeおよびSet-ProvSchemeコマンドでマシンハードウェアプロパティパラメータを追加すると、パラメータで指定された値がマシンプロファイルの値よりも優先されます。
  • AwsCaptureInstancePropertiesをtrueとして設定し、MachineProfileプロパティを設定しない場合、IAMロールとタグのみがキャプチャされます。
  • AwsCaptureInstancePropertiesとMachineProfileを同時に設定することはできません。
    **注：
    AwsCaptureInstanceProperties は非推奨です。
  • マシンプロファイルが提供されていない場合は、以下のプロパティの値を明示的に指定する必要があります。
    • セキュリティグループ
    • ENI または仮想ネットワーク
  • AwsOperationalResourcesTagging は、AwsCaptureInstanceProperties を有効にするか、マシンプロファイルを指定した場合にのみ有効にできます。
MCSマシンカタログ作成後の重要な考慮事項：
  • マシンプロファイルベースのカタログから非マシンプロファイルベースのカタログにカタログを変更することはできません。

マシンプロファイルを使用してマシンカタログを作成する

マシンプロファイルを使用してマシンカタログを作成するには：
  1. PowerShellウィンドウを開きます。
  2. Citrix固有のPowerShellモジュールをロードするためにasnp citrix*を実行します。
  3. まだ作成されていない場合は、IDプールを作成します。例：
    New-AcctIdentityPool -IdentityPoolName idPool -NamingScheme ms## -Domain abcdf -NamingSchemeType Numeric
  4. New-ProvSchemeコマンドを実行します。例：
    New-ProvScheme -ProvisioningSchemeName demet-test-1
    -HostingUnitUid aa633238-9xxd-4cf6-80e8-232a758a1xx1
    -IdentityPoolUid 34d5b088-e312-416f-907d-16573xxxxxc4
    -CleanOnBoot
    -MasterImageVM 'XDHyp:\HostingUnits\cvad-test-scalestress\citrix-demet-ami.0 (ami-0ca813xxxxxx061ef).template'
    -MachineProfile 'XdHyp:\HostingUnits\cvad-test-scalestress\us-east-1a.availabilityzone\machine-profile-instance i (i-0xxxxxxxx).vm'
  5. カタログの作成を完了します。詳しくは、「Citrix PowerShell SDK」を参照してください。

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

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

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

起動テンプレートバージョンをマシンプロファイル入力として使用して、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" `
    -MasterImageVM "XDHyp:\HostingUnits\xxxd-ue1a\apollo-non-persistent-vda-win2022 (ami-0axxxxxxxxxxx).template" `
    -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. カタログの作成を完了します。詳細については、「Citrix PowerShell SDK」を参照してください。
マシンプロファイルカタログの入力を、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ディスクの暗号化

AWS KMSキー（カスタマーマネージドキーおよびAWSマネージドキー）を使用して、OSディスクとIDディスクの暗号化に使用できる永続的および非永続的な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を使用して既存のカタログを変更し、以下を持たせることができます。
  • 新しいKMSキーを含むボリュームを持つマシンプロファイル入力。
  • 新しい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セキュアブートが有効なカタログが必要な場合は、新しいカタログを作成してください。

主な手順

  1. AWS環境をセットアップします。
  2. AWSへの接続を作成します。
  3. NitroTPMおよび/またはUEFIセキュアブートが有効なマスターイメージ (AMI) を作成する(#create-an-ami-that-supports-nitrotpm-and-uefi-secure-boot)。
  4. 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インスタンスのフィルタリング

マシンプロファイルVMとして使用するAWS EC2インスタンスは、マシンカタログが正しく作成され、機能するために互換性がある必要があります。マシンプロファイルの入力VMとして使用できるAWS EC2インスタンスを一覧表示するには、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つがある場合、それは Get 結果に含まれます。例:
    Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 100 -Tags '{"opex owner": "Not tagged"}' | select Name
    注:
    2つのタグ値がサポートされています。タグなし のタグ値は、タグのリストに指定されたタグがない項目と一致します。すべての値 のタグ値は、タグの値に関係なくタグを持つ項目と一致します。それ以外の場合、一致は、項目にタグがあり、その値がフィルターで指定されたものと等しい場合にのみ発生します。
  • -Id "ami-0a2d913927e0352f3": AMIが指定されたIDと一致する場合、それは 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

次のステップ

詳細情報