Documentation

vmware_cfg_backup - Backup / Restore / Reset ESXi host configuration

New in version 2.5.

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

Parameter
Choices/Defaults
Comments
dest
The destination where the ESXi configuration bundle will be saved. The dest can be a folder or a file.
If dest is a folder, the backup file will be saved in the folder with the default filename generated from the ESXi server.
If dest is a file, the backup file will be saved with that filename. The file extension will always be .tgz.
esxi_hostname
Name of ESXi server.
hostname
required
The hostname or IP address of the vSphere vCenter.
password
required
The password of the vSphere vCenter.

aliases: pass, pwd
port
(added in 2.5)
Default:
443
The port number of the vSphere vCenter or ESXi server.
src
The file containing the ESXi configuration that will be restored.
state
    Choices:
  • saved
  • absent
  • loaded
If saved, the .tgz backup bundle will be saved in dest.
If absent, the host configuration will be reset to default values.
If loaded, the backup file in src will be loaded to the ESXi host rewriting the hosts settings.
username
required
The username of the vSphere vCenter.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Notes

Note

  • Tested on ESXi 6.0
  • Works only for ESXi hosts
  • For configuration save or reset, the host will be switched automatically to maintenance mode.

Examples

# save the ESXi configuration locally
- name: ESXI backup test
  local_action:
      module: vmware_cfg_backup
      hostname: esxi_host
      username: user
      password: pass
      state: saved
      dest: /tmp/

# save the ESXi configuration locally for specific ESXi
- name: ESXI backup test
  local_action:
      module: vmware_cfg_backup
      hostname: vCenter
      esxi_hostname: esxi_hostname
      username: user
      password: pass
      state: saved
      dest: /tmp/

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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Andreas Nafpliotis (@nafpliot-ibm)

Hint

If you notice any issues in this documentation you can edit this document to improve it.