community.vmware.vmware_cfg_backup – Backup / Restore / Reset ESXi host configuration¶
Note
This plugin is part of the community.vmware collection (version 1.9.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_cfg_backup
.
Synopsis¶
This module can be used to perform various operations related to backup, restore and reset of ESXi host configuration.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi installed
Parameters¶
Notes¶
Note
Tested on ESXi 6.0
Works only for ESXi hosts
For configuration load or reset, the host will be switched automatically to maintenance mode.
Examples¶
- name: Save the ESXi configuration locally by authenticating directly against the ESXi host
community.vmware.vmware_cfg_backup:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
state: saved
dest: /tmp/
delegate_to: localhost
- name: Save the ESXi configuration locally by authenticating against the vCenter and selecting the ESXi host
community.vmware.vmware_cfg_backup:
hostname: '{{ vcenter_hostname }}'
esxi_hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
state: saved
dest: /tmp/
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
dest_file
string
|
changed |
The full path of where the file holding the ESXi configurations was stored
Sample:
/tmp/configBundle-esxi.host.domain.tgz
|
Authors¶
Andreas Nafpliotis (@nafpliot-ibm)