--- title: VMware Guest Info slug: homologacao-atmosphere/vmware-guest-info description: Learn how to use the "vmware_guest_info" module to effortlessly add or remove the Virtual Trusted Platform Module (vTPM) for your virtual machine. This comprehensive document covers all the essential parameters, including name, uuid, moid, folder, datacen docTags: createdAt: 2023-03-17T12:36:22.000Z --- ## Resumo - Este módulo é usado para adicionar ou remover o dispositivo Virtual Trusted Platform Module (vTPM) para um Máquina virtual. ## Parâmetros | **Parâmetro** | **Tipo** | **Escolhas \| *****Valor Padrão*** | **Comentários** | | ------------- | ------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | name | string | ****** | - Nome da máquina virtual. - Isso é necessário se o parâmetro C(uuid) ou C(moid) não for fornecido. | | uudi | string | | * UUID da instância para gerenciar, se conhecido, este é o identificador exclusivo do VMware. * Isso é necessário se o parâmetro C(name) ou C(moid) não for fornecido. | | moid | string | | - ID do objeto gerenciado da instância a ser gerenciada, se conhecida, este é um identificador exclusivo apenas em uma única instância do vCenter. - Isso é necessário se C(name) ou C(uuid) não for fornecido. | | folder | string | | * Pasta VM, caminho absoluto ou relativo para encontrar uma VM existente. * Este parâmetro não é necessário, apenas quando várias VMs são encontradas com o mesmo nome. * A pasta deve incluir o nome do datacenter. | | datacenter | string | | - O nome do datacenter do vCenter usado para obter o cluster ou host especificado. - Este parâmetro diferencia maiúsculas de minúsculas. | | tags | bool | * ***False*** * True | - Se deve mostrar tags ou não. - Se definido C(True), mostra informações de tags. Retorna uma lista de nomes de tags. - Se definido C(False), oculta informações de tags. - O SDK do vSphere Automation é necessário. | | tag\_details | bool | * ***False*** * True | - Se definido C(True), informações detalhadas sobre 'tags' retornadas. - Sem este sinalizador, o 'tags' retorna uma lista de nomes de tags. - Com este sinalizador, as 'tags' retornam uma lista de ditados sobre as informações da tag com detalhes adicionais, como nome da categoria, id da categoria e id da tag. - Este parâmetro é adicionado para manter a compatibilidade com versões anteriores. | | schema | string | * ***summary*** * vsphere | - Especifique o esquema de saída desejado. - O esquema de saída 'resumo' é a saída herdada do módulo - O esquema de saída 'vsphere' é a definição de classe da API do vSphere | | properties | list/elements=list | | * Especifique as propriedades a serem recuperadas. * Se não especificado, todas as propriedades são recuperadas (profundamente). * Os resultados são retornados em uma estrutura idêntica à API do vsphere. * \- 'Exemplo:' \- ' propriedades: \[' \- ' "config.hardware.memoryMB",' \- ' "config.hardware.numCPU",' \- ' "guest.disco",' \- ' "Estado geral"' -']' * Válido somente quando C(schema) for C(vsphere). | Estende fragmentos da documentação do módulo [VMware Options](https://app.archbee.com/docs/qhqZWWA92JYWAihQOL_T5/lUq5eineIhH7ZwvyWZYCa). ## Notas Observação - Testado em ESXi 7.0.2 - Todos os módulos requerem acesso de gravação API e, portanto, não são suportados em uma licença ESXi gratuita. ## Exemplos ```yaml - name: Gather info from standalone ESXi server having datacenter as 'ha-datacenter' vmware_guest_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: ha-datacenter uuid: 421e4592-c069-924d-ce20-7e7533fab926 delegate_to: localhost register: info - name: Gather some info from a guest using the vSphere API output schema vmware_guest_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" name: "{{ vm_name }}" schema: "vsphere" properties: ["config.hardware.memoryMB", "guest.disk", "overallStatus"] delegate_to: localhost register: info - name: Gather some information about a guest using MoID vmware_guest_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" moid: vm-42 schema: "vsphere" properties: ["config.hardware.memoryMB", "guest.disk", "overallStatus"] delegate_to: localhost register: vm_moid_info - name: Gather Managed object ID (moid) from a guest using the vSphere API output schema for REST Calls vmware_guest_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" name: "{{ vm_name }}" schema: "vsphere" properties: - _moId delegate_to: localhost register: moid_info - name: Gather detailed information about tags and category associated with the given VM vmware_guest_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" name: "{{ vm_name }}" tags: True tag_details: True register: detailed_tag_info ``` ## Valores Retornados | **Chave** | **Tipo** | **Retornado quando** | **Descrição** | | --------- | -------- | -------------------- | ------------------------------------------ | | instance | dict | sempre | metadados sobre o a maquina virtual
|