vmware_cfg_backup – Backup / Restore / Reset ESXi host configuration

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

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

Examples

- name: Save the ESXi configuration locally by authenticating directly against the ESXi host
  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
  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:

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Andreas Nafpliotis (@nafpliot-ibm)