Documentação de produtos

Criar um catálogo AWS

May 31, 2026
Contribuição de: 
C

(/pt-br/citrix-virtual-apps-desktops/2411/install-configure/machine-catalogs-create.html) descreve os assistentes que criam um catálogo de máquinas. As informações a seguir cobrem detalhes específicos dos ambientes de virtualização AWS.

Nota:

Antes de criar um catálogo AWS, você precisa concluir a criação de uma conexão com a AWS. Consulte (/pt-br/citrix-virtual-apps-desktops/2411/install-configure/connections/connection-aws.html).

Limitação

A partir do Citrix Virtual Apps and Desktops™ 2203 LTSR e posterior, o plug-in MCS AWS faz a chamada de API AWS DescribeInstanceTypes e, se for bem-sucedida, o MCS usa o nome do inventário criado a partir da resposta da API.

Portanto, ao atualizar do CVAD 1912 para 2203 ou posterior, desative a permissão DefineInstanceType na AWS e, em seguida, atualize o catálogo existente usando o comando Set-ProvScheme para corresponder ao esquema de nomenclatura da AWS. Em seguida, adicione as permissões DescribeInstanceType de volta após a conclusão da atualização do catálogo e o serviço oferecido corresponder ao esquema de nomenclatura da AWS.

Configuração de rede durante a preparação da imagem

Durante a preparação da imagem, uma máquina virtual (VM) de preparação é criada com base na VM original. Esta VM de preparação é desconectada da rede. Para desconectar a rede da VM de preparação, um grupo de segurança de rede é criado para negar todo o tráfego de entrada e saída. Este grupo de segurança de rede persiste e é reutilizado. O nome do grupo de segurança de rede é Citrix.XenDesktop.IsolationGroup-GUID, onde GUID é gerado aleatoriamente.

Configurar a tenancy da AWS

A AWS oferece as seguintes opções de tenancy:

  • Tenancy compartilhada (o tipo padrão): Várias instâncias do Amazon EC2 de diferentes clientes podem residir na mesma peça de hardware físico.
  • Tenancy dedicada: Suas instâncias EC2 são executadas apenas em hardware com outras instâncias que você implantou. Outros clientes não usam a mesma peça de hardware.

Você pode usar o MCS para provisionar hosts dedicados da AWS usando o PowerShell.

Configurar a tenancy de host dedicado da AWS usando o PowerShell

Você pode criar um catálogo de máquinas com tenancy de host definida via PowerShell.

Um host dedicado [EC2] da Amazon é um servidor físico com capacidade de instância [EC2] totalmente dedicada, permitindo que você use licenças de software existentes por soquete ou por VM.

Hosts dedicados têm utilização predefinida com base no tipo de instância. Por exemplo, um único host dedicado alocado de tipos de instância C4 Large é limitado a executar 16 instâncias. Consulte o site da AWS para obter mais informações.

Os requisitos para provisionamento em hosts AWS incluem:

  • Uma imagem BYOL (traga sua própria licença) importada (AMI). Com hosts dedicados, use e gerencie suas licenças existentes.
  • Uma alocação de hosts dedicados com utilização suficiente para satisfazer as solicitações de provisionamento.
  • habilitar auto-placement.

Para provisionar para um host dedicado na AWS usando PowerShell, use o cmdlet New-ProvScheme com o parâmetro TenancyType definido como Host.

Consulte a Documentação do Desenvolvedor Citrix para obter mais informações.

Capturar propriedades da máquina de AMIs

Ao criar um catálogo para provisionar máquinas usando o Machine Creation Services (MCS) na AWS, você seleciona uma AMI para representar a imagem mestre/golden desse catálogo. A partir dessa AMI, o MCS usa um snapshot do disco. Em versões anteriores, se você quisesse funções ou tags em suas máquinas, usaria o console da AWS para configurá-las individualmente. Essa funcionalidade é habilitada por padrão.

Dica:

Para usar a captura de propriedades de instância da AWS, você deve ter uma VM associada à AMI.

Para melhorar esse processo, o MCS lê as propriedades da instância da qual a AMI foi tirada e aplica a função de Identity Access Management (IAM) e as tags da máquina às máquinas provisionadas para um determinado catálogo. Ao usar esse recurso opcional, o processo de criação do catálogo encontra a instância de origem da AMI selecionada, lendo um conjunto limitado de propriedades. Essas propriedades são então armazenadas em um Modelo de Lançamento da AWS, que é usado para provisionar máquinas para esse catálogo. Qualquer máquina no catálogo herda as propriedades de instância capturadas.

As propriedades capturadas incluem:

  • Funções IAM – aplicadas a instâncias provisionadas.
  • Tags - aplicadas a instâncias provisionadas, seus discos e NICs. Essas tags são aplicadas a recursos transientes do Citrix®, incluindo: bucket e objetos S3, e AMIs, snapshots e modelos de inicialização.

Dica:

A marcação de recursos transientes do Citrix é opcional e configurável usando a propriedade personalizada AwsOperationalResourcesTagging.

Capturar a propriedade da instância AWS

Você pode usar esse recurso especificando uma propriedade personalizada, AwsCaptureInstanceProperties, ao criar um esquema de provisionamento para uma conexão de hospedagem AWS:

New-ProvScheme -CustomProperties "AwsCaptureInstanceProperties,true" …<standard provscheme parameters

Consulte a Documentação do Desenvolvedor Citrix para obter mais informações.

Nota:

O AwsCaptureInstanceProperties está obsoleto. Recomendamos usar perfis de máquina para especificar propriedades de máquina para VMs.

Capturar propriedades de máquina de perfis de máquina

Ao criar um catálogo para provisionar máquinas AWS usando o MCS, você pode usar um perfil de máquina para predefinir certas configurações de propriedade da máquina.

Para fazer isso, siga estas etapas:

  1. Armazene os perfis de máquina na mesma zona de disponibilidade que os recursos onde você está criando este catálogo.
  2. Na página Modelo de Máquina do assistente de criação de catálogo, selecione Usar um perfil de máquina. Os perfis de máquina localizados na mesma zona disponível que os recursos selecionados são exibidos.
  3. Selecione um perfil de máquina conforme necessário.

Nota:

Você pode usar um perfil de máquina ou uma AMI para capturar as propriedades da máquina. No Web Studio, ao selecionar Usar um perfil de máquina, a opção Aplicar propriedades de modelo de máquina a máquinas virtuais é automaticamente ocultada.

Marcar recurso operacional da AWS

Ao criar um catálogo para provisionar máquinas na AWS usando o MCS, você pode controlar se deseja aplicar a função IAM e as propriedades de tag a essas máquinas. Você também pode controlar se deseja aplicar tags de máquina a recursos operacionais.

Uma Amazon Machine Image (AMI) representa um tipo de dispositivo virtual usado para criar uma máquina virtual no ambiente Amazon Cloud, comumente referido como EC2. Você usa uma AMI para implantar serviços que usam o ambiente EC2. Ao criar um catálogo para provisionar máquinas usando o MCS para AWS, você seleciona a AMI para atuar como a imagem dourada para esse catálogo.

Importante:

A criação de catálogos capturando uma propriedade de instância e um modelo de inicialização é necessária para usar a marcação de recursos operacionais.

Para criar um catálogo AWS, você deve primeiro criar uma AMI para a instância que deseja que seja a imagem dourada. O MCS lê as tags dessa instância e as incorpora ao modelo de inicialização. As tags do modelo de inicialização são então aplicadas a todos os recursos Citrix criados em seu ambiente AWS, incluindo:

  • Máquinas Virtuais
  • Discos de VM
  • Interfaces de rede de VM
  • Buckets S3
  • Objetos S3
  • Modelos de inicialização
  • AMIs

Marcar um recurso operacional

Para usar o PowerShell para marcar recursos:

  1. Abra uma janela do PowerShell a partir do host DDC.
  2. Execute o comando asnp citrix para carregar módulos do PowerShell específicos da Citrix.

Para marcar um recurso para uma VM provisionada, use a nova propriedade personalizada AwsOperationalResourcesTagging. A sintaxe para esta propriedade é:

New-ProvScheme -CustomProperties "AwsCaptureInstanceProperties,true; AwsOperationalResourcesTagging,true" …<standard provscheme parameters>

Copiar tags em VMs

Você pode copiar tags em NICs e discos (disco de identidade, disco de cache de gravação e disco do SO) que são especificados no perfil da máquina para VMs recém-criadas em um catálogo de máquinas MCS. Você pode especificar essas tags em qualquer uma das fontes de perfil da máquina (instância de VM AWS ou versão de modelo de inicialização AWS). Este recurso é aplicável a catálogos de máquinas e VMs persistentes e não persistentes.

Nota:

  • No console do AWS EC2, você não pode ver os valores de Tag Network Interfaces em Launch Template Version Resource Tags. No entanto, você pode executar o comando PowerShell aws ec2 describe-launch-template-versions --launch-template-id lt-0bb652503d45dcbcd --versions 12 para ver as especificações da tag.
  • Se uma fonte de perfil de máquina (VM ou versão de modelo de inicialização) tiver duas interfaces de rede (eni-1 e eni-2), e eni-1 tiver a tag t1 e eni-2 tiver a tag t2, então a VM receberá as tags de ambas as interfaces de rede.

Criar um catálogo usando um perfil de máquina

Você pode usar um perfil de máquina para capturar as propriedades de hardware de uma instância EC2 (VM) ou versão de modelo de inicialização e aplicá-las às máquinas provisionadas. As propriedades capturadas podem incluir, por exemplo, propriedades de volume EBS, tipo de instância, otimização EBS, opções de CPU, tipo de locação, capacidade de hibernação e outras configurações AWS suportadas.

Você pode usar uma Instância AWS EC2 (VM) ou versão de modelo de inicialização AWS como entrada do perfil da máquina.

Nota:

  • As propriedades do volume EBS são derivadas apenas de um perfil de máquina.
  • O MCS provisiona VMs com discos de identidade do tipo de volume GP3. Como o tipo de volume GP3 é a opção mais barata oferecida pela AWS, esse recurso minimiza custos. A implementação é aplicável apenas às VMs adicionadas a um novo catálogo e às novas VMs adicionadas a um catálogo existente. As VMs existentes criadas antes desse recurso continuarão a ter discos de ID com tipo de volume GP2, a menos que o disco de ID seja redefinido.

Considerações importantes

As considerações importantes ao criar um catálogo de máquinas MCS:

  • Se você adicionar parâmetros de propriedade de hardware da máquina nos comandos New-ProvScheme e Set-ProvScheme, os valores fornecidos nos parâmetros sobrescreverão os valores no perfil da máquina.
  • Se você definir AwsCaptureInstanceProperties como true e não definir a propriedade MachineProfile, apenas as funções IAM e as tags serão capturadas.

  • Você não pode definir AwsCaptureInstanceProperties e MachineProfile ao mesmo tempo.

    **Nota:

    O AwsCaptureInstanceProperties está obsoleto.

  • Se um perfil de máquina não for fornecido, você deve fornecer explicitamente os valores das seguintes propriedades:

    • Grupo de Segurança
    • ENI ou Rede Virtual
  • Você pode habilitar AwsOperationalResourcesTagging apenas se habilitar AwsCaptureInstanceProperties ou especificar um perfil de máquina.

As considerações importantes após a criação de um catálogo de máquinas MCS:

  • Você não pode alterar um catálogo de baseado em perfil de máquina para um catálogo não baseado em perfil de máquina.

Criar um catálogo de máquinas usando um perfil de máquina

Para criar um catálogo de máquinas usando um perfil de máquina:

  1. Abra uma janela do PowerShell.
  2. Execute asnp citrix* para carregar os módulos PowerShell específicos da Citrix.

  3. Crie um pool de identidades se ainda não tiver sido criado. Por exemplo,

    New-AcctIdentityPool -IdentityPoolName idPool -NamingScheme ms## -Domain abcdf -NamingSchemeType Numeric
<!--NeedCopy-->

  4. Execute o comando New-ProvScheme. Por exemplo:

    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'
<!--NeedCopy-->
  5. Conclua a criação do catálogo. Para obter mais informações, consulte Citrix PowerShell SDK.

Atualizar o perfil da máquina

Para atualizar o perfil da máquina em um catálogo que foi inicialmente provisionado com um perfil de máquina, faça o seguinte. Você também pode alterar o tipo de locação e a capacidade de hibernação da origem do perfil da máquina ao editar um catálogo de máquinas MCS.

  1. Execute o comando Set-ProvScheme. Por exemplo,

    Set-ProvScheme `
-ProvisioningSchemeUid "<ID" `
-MachineProfile "XDHyp:\HostingUnits\abc\us-east-1a.availabilityzone\citrix-cvad-machineprofile-instance (i-0xxxxxxxx).vm"
<!--NeedCopy-->

Criar um catálogo com a versão do modelo de inicialização

Você pode criar um catálogo de máquinas MCS com uma versão de modelo de inicialização como entrada de perfil de máquina. Você também pode atualizar a entrada de um catálogo de perfil de máquina de uma VM para uma versão de modelo de inicialização e de uma versão de modelo de inicialização para uma VM.

No console do AWS EC2, você pode fornecer as informações de configuração da instância de um modelo de inicialização junto com o número da versão. Ao especificar a versão do modelo de inicialização como entrada de perfil de máquina ao criar ou atualizar um catálogo de máquinas, as propriedades dessa versão do modelo de inicialização são copiadas para as VMs VDA provisionadas.

As seguintes propriedades podem ser fornecidas usando a entrada do perfil da máquina ou explicitamente como parâmetros nos comandos New-ProvScheme ou Set-ProvScheme. Se forem fornecidas nos comandos New-ProvScheme ou Set-ProvScheme, elas terão precedência sobre os valores do perfil da máquina dessas propriedades.

  • Oferta de Serviço
  • Redes
  • Grupos de Segurança
  • Tipo de Tenancy

Nota:

Se a oferta de serviço não for fornecida no modelo de inicialização do perfil da máquina ou como um parâmetro no comando New-ProvScheme, você receberá um erro apropriado.

Para criar um catálogo usando a versão do modelo de inicialização como entrada de perfil de máquina:

  1. Abra uma janela do PowerShell.
  2. Execute asnp citrix* para carregar os módulos PowerShell específicos da Citrix.

  3. Obtenha a lista de versões do modelo de inicialização de um modelo de inicialização. Por exemplo:

    XDHyp:\HostingUnits\test\test-mp-sard (lt-01xxxxx).launchtemplate> ls | Select FullPath
<!--NeedCopy-->

  4. Crie um pool de identidades, se ainda não tiver sido criado. Por exemplo:

    New-AcctIdentityPool `
-IdentityPoolName "abc11" `
-NamingScheme "abc1-##" `
-NamingSchemeType Numeric `
-Domain "citrix-xxxxxx.local" `
-ZoneUid "xxxxxxxx" `
<!--NeedCopy-->

  5. Crie um esquema de provisionamento com uma versão do modelo de inicialização como entrada de perfil de máquina. Por exemplo:

    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"
<!--NeedCopy-->

  6. Registre o esquema de provisionamento como um catálogo de broker. Por exemplo:

    New-BrokerCatalog -Name "MPLT1" `
-AllocationType Random `
-Description "Machine profile catalog" `
-ProvisioningSchemeId fe7df345-244e-4xxxx-xxxxxxxxx `
-ProvisioningType Mcs `
-SessionSupport MultiSession `
-PersistUserChanges Discard
<!--NeedCopy-->
  7. Conclua a criação do catálogo. Para obter mais informações, consulte Citrix PowerShell SDK

Você também pode atualizar a entrada de um catálogo de perfil de máquina de uma VM para uma versão de modelo de inicialização e de uma versão de modelo de inicialização para uma VM. Por exemplo:

  • Para atualizar a entrada de um catálogo de perfil de máquina de uma VM para uma versão de modelo de inicialização:

     Set-ProvScheme -ProvisioningSchemeName "CloudServiceOfferingTest" `
 -MachineProfile "XDHyp:\HostingUnits\xxxx-ue1a\machineprofiletest (lt-0bxxxxxxxxxxxx).launchtemplate\lt-0bxxxxxxxxxxxx (1).launchtemplateversion"
 <!--NeedCopy-->

  • Para atualizar a entrada de um catálogo de perfil de máquina de uma versão de modelo de inicialização para uma VM:

     Set-ProvScheme -ProvisioningSchemeName "CloudServiceOfferingTest" `
 -MachineProfile "XDHyp:\HostingUnits\sard-ue1a\us-east-1a.availabilityzone\apollo-non-persistent-vda-win2022-2 (i-08xxxxxxxxx).vm"
 <!--NeedCopy-->

Criptografar discos de SO e ID

Você pode criar catálogos persistentes e não persistentes de VMs com chaves AWS KMS (chave gerenciada pelo cliente e chave gerenciada pela AWS) que podem ser usadas para criptografar o disco do SO e o disco de identidade.

  • As chaves gerenciadas pela AWS são rotacionadas automaticamente todos os anos.
  • As chaves gerenciadas pelo cliente são opcionais para rotação automática e podem ser gerenciadas manualmente.

Você pode consultar os seguintes documentos da AWS para obter mais informações sobre chaves KMS:

Para criptografia de discos de SO e ID, configure um dos seguintes:

  • Use uma imagem mestre criptografada (por exemplo, uma AMI criada a partir de uma instância ou snapshot que contém um volume raiz EBS criptografado com chave KMS)
  • Use uma fonte de perfil de máquina (VM ou modelo de inicialização) que contenha um volume raiz EBS criptografado.

Limitações

Considere as seguintes limitações:

  • O MCS atualmente suporta apenas um disco na AMI da imagem mestre.

  • Você não pode criptografar diretamente volumes ou snapshots EBS existentes não criptografados, nem modificar a chave KMS de um volume criptografado existente. Para fazer isso, você deve:

    1. Crie um novo snapshot desse volume.
    2. Crie um novo volume a partir desse snapshot.
    3. Criptografe o novo volume.

Consulte os seguintes documentos da AWS:

Criar um catálogo com criptografia de disco

Você pode criar um catálogo de máquinas MCS com criptografia de disco usando:

  • Imagem mestre
  • Perfil da máquina

Considerações ao usar a entrada do perfil da máquina para criptografia de disco:

  • A chave KMS da entrada do perfil da máquina tem precedência sobre a chave KMS da imagem mestre.
  • Se nenhuma entrada de perfil da máquina for fornecida, a chave KMS da AMI da imagem mestre será usada para criptografar os discos das VMs do catálogo.
  • Se o perfil da máquina tiver Mapeamentos de Dispositivo de Bloco presentes, os dispositivos de bloco presentes no modelo de imagem mestre (AMI) e no perfil da máquina devem corresponder. Por exemplo, se a AMI tiver um dispositivo definido em /dev/sda1, o Perfil da Máquina também deverá ter um dispositivo definido em /dev/sda1.
  • Se não houver chave na origem do perfil da máquina e a imagem mestre não for criptografada, os discos das VMs do catálogo não serão criptografados.
  • Quando a imagem mestre é criptografada, uma VM de origem de perfil de máquina ou um modelo de inicialização deve ter um volume raiz criptografado para ser considerado uma entrada válida.

Modificar um catálogo existente

Você pode modificar um catálogo existente usando Set-ProvScheme para ter:

  • Uma entrada de perfil de máquina com um volume contendo uma nova chave KMS.
  • Um AMI de modelo de imagem mestre criptografado com uma nova chave KMS.

Considerações importantes

  • Os volumes das novas VMs adicionadas ao catálogo são criptografados com a nova chave KMS.
  • Para atualizar as configurações de criptografia quando houver um perfil de máquina existente, execute Set-ProvScheme com um novo perfil de máquina.
  • Você não pode modificar um catálogo existente de volumes criptografados para volumes não criptografados. Você não pode fazer uma atualização de imagem de um AMI mestre criptografado para um AMI mestre não criptografado.

Habilitar NitroTPM e inicialização segura UEFI para instâncias de VM

Ao criar um catálogo, agora você pode selecionar uma imagem mestre (AMI) com NitroTPM e/ou inicialização segura UEFI habilitados. Consequentemente, as VMs provisionadas no catálogo também são habilitadas com NitroTPM e/ou inicialização segura UEFI. Essa implementação garante que as VMs sejam seguras e confiáveis. Para obter mais informações sobre NitroTPM e inicialização segura UEFI, consulte a documentação da Amazon.

Limitações

  • Você pode usar NitroTPM e Secure Boot atualmente em todas as regiões da AWS (incluindo as regiões AWS GovCloud (US)), exceto na China.
  • Você não pode habilitar NitroTPM e inicialização segura UEFI em catálogos existentes. Se você deseja um catálogo com NitroTPM e inicialização segura UEFI habilitados, crie um novo catálogo.

Principais etapas

  1. Configure seu ambiente AWS.
  2. Crie uma conexão com a AWS.
  3. Crie uma imagem mestre (AMI) habilitada com NitroTPM e/ou inicialização segura UEFI.
  4. Crie um catálogo de máquinas selecionando a imagem mestre com NitroTPM e inicialização segura UEFI habilitados no menu de criação de catálogo do Web Studio ou ao criar um Esquema de Provisionamento usando comandos PowerShell.

As VMs adicionadas ao catálogo criado têm NitoTPM e inicialização segura UEFI habilitados.

Crie uma AMI que suporte NitroTPM e inicialização segura UEFI

  1. Você pode criar uma AMI a partir de uma VM que tenha NitroTPM e/ou inicialização segura UEFI habilitados.

    1. Crie a instância usando as imagens do AWS Marketplace. Exemplo, procure por TPM-Windows_Server-2022-English-Full-Base on the aws-marketplace.
    2. Baixe o VDA de sessão única ou múltipla.
    3. Crie uma AMI a partir dessa VM.

  2. Use o comando register-image:

    --boot-mode (string)
--tpm-support (string)
<!--NeedCopy-->

    Para obter mais informações, consulte register-image.

Consulte os seguintes documentos da AWS:

Você pode abrir uma janela do PowerShell no host do Delivery Controller™ para verificar se um(a) específico(a):

  • oferta de serviço suporta NitroTPM ou inicialização segura 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-->

  • modelo suporta NitroTPM ou inicialização segura 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-->

Atualizar a oferta de serviço de um catálogo existente

Você pode alterar a oferta de serviço de um catálogo existente usando Set-ProvScheme. A alteração se aplica às VMs recém-adicionadas. No entanto, você receberá erros nos seguintes cenários:

Modo de inicialização das AMIs A AMI suporta Nitro TPM? A oferta de serviço suporta NitroTPM e inicialização segura UEFI?
UEFI Não Não
BIOS herdado Sim Não
UEFI Sim Não
UEFI Preferencial Sim Não

Filtrar instâncias de VM

Uma instância AWS EC2 que você usa como VM de perfil de máquina deve ser compatível para que o catálogo de máquinas seja criado e funcione corretamente. Para listar as instâncias AWS EC2 que podem ser usadas como VMs de entrada de perfil de máquina, você pode usar o comando Get-HypInventoryItem. O comando pode paginar e filtrar o inventário de VMs disponíveis em uma unidade de hospedagem.

Paginação:

Get-HypInventoryItem oferece suporte a dois modos de paginação:

  • O modo de paginação usa os parâmetros -MaxRecords e -Skip para retornar conjuntos de itens:
    • -MaxRecords: O padrão é 1. Isso controla quantos itens retornar.
    • -Skip: O padrão é 0. Isso controla quantos itens ignorar desde o início absoluto (ou fim absoluto) da lista no hypervisor.
  • O modo de rolagem usa os parâmetros -MaxRecords, -ForwardDirection e -ContinuationToken para permitir a rolagem dos registros:
    • -ForwardDirection: O padrão é True. Isso é usado junto com -MaxRecords para retornar o próximo conjunto de registros correspondentes ou o conjunto anterior de registros correspondentes.
    • -ContinuationToken: Retorna os itens imediatamente depois (ou antes, se ForwardDirection for false), mas não incluindo o item fornecido em ContinuationToken.

Exemplos de paginação:

  • Para retornar um único registro do modelo de máquina com o nome mais baixo. O campo AdditionalData tem TotalItemsCount e TotalFilteredItemsCount:

     Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template
 <!--NeedCopy-->

  • Para retornar 10 registros do modelo de máquina com o nome mais baixo:

     Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 10 | select Name
 <!--NeedCopy-->

  • Para retornar um array de registros terminando com o nome mais alto:

     Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -ForwardDirection $False -MaxRecords 10 | select Name
 <!--NeedCopy-->

  • Para retornar um array de registros começando no modelo de máquina associado ao ContinuationToken fornecido:

     Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -ContinuationToken "ami-07xxxxxxxxxx" -MaxRecords 10
 <!--NeedCopy-->

Filtragem:

Os seguintes parâmetros opcionais adicionais são suportados para filtragem. Você pode combinar esses parâmetros com as opções de paginação.

  • -ContainsName "my_name": Se a string fornecida corresponder a parte de um nome de AMI, a AMI será incluída no resultado Get. Por exemplo:

     Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 100 -ContainName ‘apollo’ | select Name
 <!--NeedCopy-->

  • -Tags '{ "Key0": "Value0", "Key1": "Value1", "Key2": "Value2" }': Se uma AMI tiver pelo menos uma dessas tags, ela será incluída no resultado Get. Por exemplo:

     Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -MaxRecords 100 -Tags '{"opex owner": "Not tagged"}' | select Name
 <!--NeedCopy-->

    Nota:

    Dois valores de tag são suportados. O valor de tag Não Marcado corresponde a itens que não possuem a tag fornecida em sua lista de tags. O valor de tag Todos os valores corresponde a itens que possuem a tag, independentemente do valor da tag. Caso contrário, a correspondência ocorre somente se o item tiver a tag e o valor for igual ao que é fornecido no filtro.

  • -Id "ami-0a2d913927e0352f3": Se a AMI corresponder ao ID fornecido, ela será incluída no resultado Get. Por exemplo:

     Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -Id ami-xxxxxxxxxxxxx
 <!--NeedCopy-->

Filtragem no parâmetro AdditionalData:

O parâmetro de filtro AdditionalData lista modelos ou VMs com base em sua capacidade, oferta de serviço ou qualquer propriedade que esteja em AdditionalData. Por exemplo:

(Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\aws" -MaxRecords 200).AdditionalData
<!--NeedCopy-->

Você também pode adicionar um parâmetro -Warn para indicar as VMs incompatíveis. As VMs são incluídas com um campo AdditionalData chamado Warning. Por exemplo:

(Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\aws" -MaxRecords 200 -Template "ami-015xxxxxxxxx" -Warn $true).AdditionalData
<!--NeedCopy-->

Onde ir em seguida

Mais informações

Criar um catálogo AWS
May 31, 2026
Contribuição de: 
C
May 31, 2026
Contribuição de: 
C

Neste artigo

Feedback do site | Your privacy choices footer linkSuas escolhas de privacidade | Privacidade e termos legais | Preferências de cookies | Configurações de consentimento | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.