---
title: Vmware Guest Screenshot
slug: homologacao-atmosphere/vmware-guest-screenshot
description: Learn how to capture screenshots of a virtual machine (VM) in a VMware environment with this comprehensive document. Discover the necessary requirements, including the PyVmomi library, and explore the various parameters available for customization. Find p
docTags: 
createdAt: 2021-12-13T11:18:27.000Z
---

## Sinopse

- Este módulo pode ser usado para tirar screenshots de uma dada VM que estiver ligada.
- Todos os parâmetros e nomes de objetos VMware diferenciam maiúsculas de minúsculas.

## Requisitos

Os requisitos abaixo são necessários no host que executa este módulo.

- PyVmomi

## Parâmetros

| **Parâmetro**  | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| -------------- | -------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| cluster        | string   |                              | O nome do cluster no qual a VM está rodando. Esse parâmentro é requerido se `esxi_hostname` não é definido.`esxi_hostname` e o `cluster` são mutualmente parâmetros exclusivos.                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| datacenter     | string   | - ***ha-datacenter***        | O `datacenter` onde a VM que você gostaria de operar o power. Esse parâmetro é case sensitive.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| esxi\_hostname | string   |                              | O hostname ESXi no qual a VM está rodando. Esse parâmentro é requerido se `cluster` não é definido. `esxi_hostname` e o `cluster `são mutualmente parâmetros exclusivos.                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| folder         | string   |                              | Pasta de destino, caminho absoluto ou relativo para encontrar um convidado existente.<br /><br />Este é um parâmetro obrigatório, apenas se várias VMs forem encontradas com o mesmo nome.<br /><br />A pasta deve incluir o datacenter. O datacenter da ESX é ha-datacenter<br /><br />Exemplos:<br />pasta: / ha-datacenter / vm<br />pasta: ha-datacenter / vm<br />pasta: / datacenter1 / vm<br />pasta: datacenter1 / vmpasta: / datacenter1 / vm / pasta1<br />pasta: datacenter1 / vm / pasta1<br />pasta: / pasta1 / datacenter1 / vm<br />pasta: pasta1 / datacenter1 / vm<br />pasta: / pasta1 / datacenter1 / vm / pasta2 |
| local\_path    | path     |                              | Se `local_path` náo for definido, o arquivo screenshot criado será mantido no diretório da VM no host ESXi. Se `local_path` é defenido em um local válido na máquinam então será feito o download do arquivo screenshot de um host ESXi para um diretório local. Se o download não for feito você pode abrir o arquivo atravéz de um arquivo URL retornado na screenshot manualmente.                                                                                                                                                                                                                                                |
| moid           | string   |                              | O ID do objeto gerenciado da instância a ser gerenciado, se conhecido, é um identificador exclusivo apenas em uma única instância do vCenter.<br /><br />Isso é necessário se nameou uuidnão for fornecido.                                                                                                                                                                                                                                                                                                                                                                                                                          |
| name           | string   |                              | Nome da máquina virtual.<br /><br />Este é o parâmetro obrigatório, se o parâmetro `uuid` ou `moid` não for fornecido.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| uuid           | string   |                              | UUID da instância para coletar informações, se conhecido, este é o identificador exclusivo da VMware.<br /><br />Este é o parâmetro obrigatório, se o parâmetro nameou moidnão for fornecido.                                                                                                                                                                                                                                                                                                                                                                                                                                        |




## Notas

Observação

- Testado em vSphere 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: take a screenshot of the virtual machine console
  community.vmware.vmware_guest_screenshot:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "{{ folder_name }}"
    name: "{{ vm_name }}"
    local_path: "/tmp/"
  delegate_to: localhost
  register: take_screenshot

- name: Take a screenshot of the virtual machine console using MoID
  community.vmware.vmware_guest_screenshot:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "{{ folder_name }}"
    moid: vm-42
    local_path: "/tmp/"
  delegate_to: localhost
  register: take_screenshot
```

## Valores Retornados

| **Parâmetro**     | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários**                                      |
| ----------------- | -------- | ---------------------------- | ---------------------------------------------------- |
| screenshot\_info  | dict     | sempre                       | Mostra os facts do uma arquivo screenshot de uma VM  |