---
title: VMware Cfg Backup
slug: homologacao-atmosphere/vmware-cfg-backup
description: Learn how to use a versatile module for backup, restoration, and resetting of ESXi host configurations. This document covers essential parameters like destination, hostname, source file, and state. Discover practical examples and find out the returned val
docTags: 
createdAt: 2021-12-14T12:30:12.000Z
---

## Resumo

- Este módulo pode ser usado para realizar várias operações relacionadas ao backup, restauração e redefinição da configuração do host ESXi.

## Parâmetros

| **Parâmetro**      | **Tipo** | **Escolhas \| Valor Padrão**                       | **Comentários**                                                                                                                                                                                                                                                                                                                                                |
| ------------------ | -------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| dest               | path     |                                                    | Destino onde o pacote de configuração ESXi será salvo. O destino pode ser uma pasta ou um arquivo. Se o destino for uma pasta, o arquivo de backup será salvo na pasta com o nome de arquivo padrão gerado a partir do servidor ESXi. Se o destino for um arquivo, o arquivo de backup será salvo com esse nome. A extensão do arquivo sempre será .tgz.<br /> |
| esxi\_hostname     | string   |                                                    | Nome do servidor ESXi. Isso é necessário apenas se a autenticação em um vCenter for feita.<br />                                                                                                                                                                                                                                                               |
| src                | path     |                                                    | Arquivo contendo a configuração ESXi que será restaurada.<br />                                                                                                                                                                                                                                                                                                |
| state - *required* | string   | Escolhas:<br />- saved<br />- absent<br />- loaded | Se saved, o pacote de backup .tgz será salvo em dest. Se absent, a configuração do host será redefinida para os valores padrão. Se loaded, o arquivo de backup em src será carregado no host ESXi reescrevendo as configurações do host.<br />                                                                                                                 |

Estende fragmentos da documentação do módulo VMware Options.&#x20;


## Exemplos

```yaml
# Exemplo: Salve a configuração ESXi localmente, autenticando diretamente no host ESXi
- vmware_cfg_backup:
   hostname: '{{ esxi_hostname }}'
   username: '{{ esxi_username }}'
   password: '{{ esxi_password }}'
   state: saved
   dest: /tmp/
  delegate_to: localhost

# Exemplo: Salve a configuração ESXi localmente, autenticando no vCenter e selecionando o host ESXi
- vmware_cfg_backup:
   hostname: '{{ vcenter_hostname }}'
   esxi_hostname: '{{ esxi_hostname }}'
   username: '{{ esxi_username }}'
   password: '{{ esxi_password }}'
   state: saved
   dest: /tmp/
  delegate_to: localhost
```



## Valores retornados

| **Chave**   | **Tipo** | **Retornado quando** | **Descrição**                                                                          |
| ----------- | -------- | -------------------- | -------------------------------------------------------------------------------------- |
| dest\_file  | string   | Modificado           | Caminho completo de onde o arquivo que contém as configurações do ESXi foi armazenado. |