--- title: VMware Guest Snapshot slug: homologacao-atmosphere/vmware-guest-snapshot description: Learn how to effectively create, delete, and update snapshots of virtual machines with this comprehensive module. Discover the various parameters available, including datacenter, description, folder, memory_dump, and snapshot_name. Explore practical examp docTags: createdAt: 2021-12-09T16:38:33.000Z --- ## Resumo - Este módulo pode ser usado para criar, excluir e atualizar snapshots de determinada máquina virtual. ## Parâmetros | **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** | | ----------------------- | -------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | datacenter - *required* | string  | | Datacenter de destino para a operação de implantação.
| | description  | string | Default:
"" | Defina uma descrição para anexar ao snapshot. | | folder  | string | | Pasta de destino, caminho absoluto ou relativo para encontrar um guest existente. Este é um parâmetro obrigatório, caso o nome seja fornecido. Datacenters ESX's tem por padrão o caminho "/ha-datacenter/"
| | memory\_dump  | boolean | Escolhas:
- false
(default)
- true | Se definido como true, o despejo de memória também será incluido ao snapshot. Observe que os snapshots de memória consomem tempo e recursos; isso levará mais tempo para ser criado. Se a máquina virtual não fornecer capacidade suficiente de memória, este parâmetro será definido como false.
| | moid  | string | | ID do objeto da instância a ser gerenciado, se conhecido, é um identificador exclusivo apenas em uma única instância do vCenter. Isso é necessário se o nome ou uuid não for fornecido.
| | name  | string | | Nome da máquina virtual. Este é um parâmetro obrigatório, se uuid ou moid não for fornecido.
| | name\_match  | string | | Caso haja várias VMs correspondentes ao nome, este parâmetro define se será utilizada a primeira ou a última encontrada.
| | new\_description  | string | | Nova descrição, que substituirá a de um snapshot já existente.
| | new\_snapshot\_name  | string | | Novo nome, que substituirá o de um snapshot já existente.
| | quiesce  | boolean | Escolhas:
- false
(default)
- true | Se definido como true e a máquina virtual estiver ligada, ele desativará o sistema de arquivos da mesma. Observe que as ferramentas VMware são necessárias para este parâmetro. Se a máquina virtual for desligada ou o VMware Tools não estiver disponível, este parâmetro será definido como false.

Caso a máquina virtual não forneça capacidade necessária para esse parâmetro, então, ele também será definido como false.
| | remove\_children  | boolean | Escolhas:
- false
(default)
- true | Se definido como true e o state como absent, toda a subárvore do snapshot é definida para a remoção. | | snapshot\_name  | string | | Nome do snapshot a ser gerenciado.
| | state - *required* | string  | Escolhas:
- present
- absent
- revert
- remove\_all | Se definido como present, criará um novo snapshot com o nome fornecido.

Se definido como absent, o snapshot com o nome fornecido é removido.

Se definido para reverter, o estado da máquina virtual será revertido para o snapshot fornecido.

Se definido como remove\_all, todos os snapshots serão removidos.
| | use\_instance\_uuid  | boolean | Escolhas:
- false
(default)
- true | Se deve usar o UUID da instância do VMware em vez do UUID do BIOS. | | uuid  | string | | UUID da instância a ser gerenciada, se conhecido, é o UUID do BIOS da VMware por padrão | Estende fragmentos da documentação do módulo VMware Options. ## Exemplos ```yaml # Exemplo: Crie um snapshot - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" name: "{{ guest_name }}" state: present snapshot_name: snap1 description: snap1_description # Exemplo: Remover um snapshot - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" name: "{{ guest_name }}" state: absent snapshot_name: snap1 # Exemplo: Reverter um snapshot - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" name: "{{ guest_name }}" state: revert snapshot_name: snap1 # Exemplo: Remover todos os snapshots de uma VM - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" name: "{{ guest_name }}" state: remove_all # Exemplo: Remover snapshots de uma VM utilizando MoID - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" moid: vm-42 state: remove_all # Exemplo: Faça um snapshot de uma VM usando quiesce e flag de memória - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" name: "{{ guest_name }}" state: present snapshot_name: dummy_vm_snap_0001 quiesce: true memory_dump: true # Exemplo: Remova um snapshot e uma subárvore de snapshot - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" name: "{{ guest_name }}" state: absent remove_children: true snapshot_name: snap1 # Exemplo: Renomear um snapshot - vmware_guest_snapshot: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" folder: "/{{ datacenter_name }}/vm/" name: "{{ guest_name }}" state: present snapshot_name: current_snap_name new_snapshot_name: im_renamed new_description: "{{ new_snapshot_description }}" ``` ## Valores retornados | **Chave** | **Tipo** | **Retornado quando** | **Descrição** | | ------------------ | ---------- | -------------------- | ------------------------------------------------------ | | snapshot\_results  | dictionary | Sempre | Metadados sobre os snapshots da máquina virtual.
|