ansible / ansible.builtin / v2.6.17 / module / vmware_cfg_backup Backup / Restore / Reset ESXi host configuration | "added in version" 2.5 of ansible.builtin" Authors: Andreas Nafpliotis (@nafpliot-ibm) preview | supported by communityansible.builtin.vmware_cfg_backup (v2.6.17) — module
pip
Install with pip install ansible==2.6.17
This module can be used to perform various operations related to backup, restore and reset of ESXi host configuration.
# save the ESXi configuration locally by authenticating directly against the ESXi host - name: ESXI backup test local_action: module: vmware_cfg_backup hostname: esxi_hostname username: user password: pass state: saved dest: /tmp/
# save the ESXi configuration locally by authenticating against the vCenter and selecting the ESXi host - name: ESXI backup test local_action: module: vmware_cfg_backup hostname: vCenter esxi_hostname: esxi_hostname username: user password: pass state: saved dest: /tmp/
src: description: - The file containing the ESXi configuration that will be restored. dest: description: - The destination where the ESXi configuration bundle will be saved. The I(dest) can be a folder or a file. - If I(dest) is a folder, the backup file will be saved in the folder with the default filename generated from the ESXi server. - If I(dest) is a file, the backup file will be saved with that filename. The file extension will always be .tgz. port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable C(VMWARE_PORT) will be used instead. - Environment variable support added in Ansible 2.6. type: int state: choices: - saved - absent - loaded description: - If C(saved), the .tgz backup bundle will be saved in I(dest). - If C(absent), the host configuration will be reset to default values. - If C(loaded), the backup file in I(src) will be loaded to the ESXi host rewriting the hosts settings. hostname: description: - The hostname or IP address of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. - Environment variable support added in Ansible 2.6. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. - Environment variable support added in Ansible 2.6. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. - Environment variable support added in Ansible 2.6. type: str proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST) will be used instead. - This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT) will be used instead. required: false type: int esxi_hostname: description: - Name of ESXi server. This is required only if authentication against a vCenter is done. required: false validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. - Environment variable support added in Ansible 2.6. - If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine. type: bool
dest_file: description: The full path of where the file holding the ESXi configurations was stored returned: changed sample: /tmp/configBundle-esxi.host.domain.tgz type: string