vmware cfg backup module (#21070)
* vmware cfg backup module * used ansible's urllib * pep8 changes * pep8 changes * added ansible metadata * user can define also the backup filename * fixed required_if values * Changes for vmware_cfg_backup as per recommendation * small changes (pep, specific imports etc) * added import from future
This commit is contained in:
Andreas Nafpliotis
Abhijeet Kasurde
parent
bac759e282
commit
639bac11d4
1 changed files with 211 additions and 0 deletions
211
lib/ansible/modules/cloud/vmware/vmware_cfg_backup.py
Normal file
211
lib/ansible/modules/cloud/vmware/vmware_cfg_backup.py
Normal file
|
|
@ -0,0 +1,211 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright IBM Corp. 2017
|
||||
# Author(s): Andreas Nafpliotis <nafpliot@de.ibm.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: vmware_cfg_backup
|
||||
short_description: Backup / Restore / Reset ESXi host configuration
|
||||
description:
|
||||
- Backup / Restore / Reset ESXi host configuration
|
||||
version_added: "2.5"
|
||||
author:
|
||||
- Andreas Nafpliotis (@nafpliot-ibm)
|
||||
notes:
|
||||
- Tested on ESXi 6.0
|
||||
- Works only for ESXi hosts
|
||||
- For configuration save or reset, the host will be switched automatically to maintenance mode.
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- PyVmomi installed
|
||||
options:
|
||||
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.
|
||||
src:
|
||||
description:
|
||||
- The file containing the ESXi configuration that will be restored
|
||||
state:
|
||||
description:
|
||||
- If C(saved), the .tgz backup bundle will be saved in I(dest).
|
||||
- If C(absent), the host configuration will be resetted to default values.
|
||||
- If C(loaded), the backup file in I(src) will be loaded to the ESXi host rewriting the hosts settings.
|
||||
choices: [saved, absent, loaded]
|
||||
extends_documentation_fragment: vmware.documentation
|
||||
'''
|
||||
|
||||
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/
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
dest_file:
|
||||
description: The full path of where the file holding the ESXi configurations was stored
|
||||
returned: changed
|
||||
type: string
|
||||
sample: /tmp/configBundle-esxi.host.domain.tgz
|
||||
'''
|
||||
|
||||
import os
|
||||
|
||||
try:
|
||||
from pyVmomi import vim, vmodl
|
||||
HAS_PYVMOMI = True
|
||||
except ImportError:
|
||||
HAS_PYVMOMI = False
|
||||
|
||||
from ansible.module_utils.vmware import vmware_argument_spec, connect_to_api, get_all_objs, wait_for_task
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.urls import open_url
|
||||
from ansible.module_utils.six.moves.urllib.error import HTTPError
|
||||
|
||||
|
||||
class VMwareConfigurationBackup(object):
|
||||
def __init__(self, module):
|
||||
self.module = module
|
||||
self.state = self.module.params['state']
|
||||
self.dest = self.module.params['dest']
|
||||
self.src = self.module.params['src']
|
||||
self.hostname = self.module.params['hostname']
|
||||
self.username = self.module.params['username']
|
||||
self.password = self.module.params['password']
|
||||
self.validate_certs = self.module.params['validate_certs']
|
||||
self.content = connect_to_api(self.module)
|
||||
self.host = self.find_host_system()
|
||||
|
||||
def find_host_system(self):
|
||||
host_system = get_all_objs(self.content, [vim.HostSystem])
|
||||
return host_system.keys()[0]
|
||||
|
||||
def process_state(self):
|
||||
if self.state == 'saved':
|
||||
self.save_configuration()
|
||||
|
||||
if self.state == 'absent':
|
||||
self.reset_configuration()
|
||||
|
||||
if self.state == 'loaded':
|
||||
self.load_configuration()
|
||||
|
||||
def load_configuration(self):
|
||||
if not os.path.isfile(self.src):
|
||||
self.module.fail_json(msg="Source file {} does not exist".format(self.src))
|
||||
|
||||
url = self.host.configManager.firmwareSystem.QueryFirmwareConfigUploadURL()
|
||||
url = url.replace('*', self.hostname)
|
||||
# find manually the url if there is a redirect because urllib2 -per RFC- doesn't do automatic redirects for PUT requests
|
||||
try:
|
||||
request = open_url(url=url, method='HEAD', validate_certs=self.validate_certs)
|
||||
except HTTPError as e:
|
||||
url = e.geturl()
|
||||
|
||||
try:
|
||||
with open(self.src, 'rb') as file:
|
||||
data = file.read()
|
||||
request = open_url(url=url, data=data, method='PUT', validate_certs=self.validate_certs,
|
||||
url_username=self.username, url_password=self.password, force_basic_auth=True)
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg=str(e))
|
||||
|
||||
if not self.host.runtime.inMaintenanceMode:
|
||||
self.enter_maintenance()
|
||||
try:
|
||||
self.host.configManager.firmwareSystem.RestoreFirmwareConfiguration(force=True)
|
||||
self.module.exit_json(changed=True)
|
||||
except Exception as e:
|
||||
self.exit_maintenance()
|
||||
self.module.fail_json(msg=str(e))
|
||||
|
||||
def reset_configuration(self):
|
||||
if not self.host.runtime.inMaintenanceMode:
|
||||
self.enter_maintenance()
|
||||
try:
|
||||
self.host.configManager.firmwareSystem.ResetFirmwareToFactoryDefaults()
|
||||
self.module.exit_json(changed=True)
|
||||
except Exception as e:
|
||||
self.exit_maintenance()
|
||||
self.module.fail_json(msg=str(e))
|
||||
|
||||
def save_configuration(self):
|
||||
url = self.host.configManager.firmwareSystem.BackupFirmwareConfiguration()
|
||||
url = url.replace('*', self.hostname)
|
||||
if os.path.isdir(self.dest):
|
||||
filename = url.rsplit('/', 1)[1]
|
||||
self.dest = os.path.join(self.dest, filename)
|
||||
else:
|
||||
filename, file_extension = os.path.splitext(self.dest)
|
||||
if file_extension != ".tgz":
|
||||
self.dest = filename + ".tgz"
|
||||
try:
|
||||
request = open_url(url=url, validate_certs=self.validate_certs)
|
||||
with open(self.dest, "wb") as file:
|
||||
file.write(request.read())
|
||||
self.module.exit_json(changed=True, dest_file=self.dest)
|
||||
except IOError as e:
|
||||
self.module.fail_json(msg="Failed to write backup file. Ensure that the dest path exists and is writable.")
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg=str(e))
|
||||
|
||||
def enter_maintenance(self):
|
||||
try:
|
||||
task = self.host.EnterMaintenanceMode_Task(timeout=15)
|
||||
success, result = wait_for_task(task)
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg="Failed to enter maintenance mode. Ensure that there are no powered on machines on the host.")
|
||||
|
||||
def exit_maintenance(self):
|
||||
try:
|
||||
task = self.host.ExitMaintenanceMode_Task(timeout=15)
|
||||
success, result = wait_for_task(task)
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg="Failed to exit maintenance mode")
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
argument_spec = vmware_argument_spec()
|
||||
argument_spec.update(dict(dest=dict(required=False, type='path'),
|
||||
src=dict(required=False, type='path'),
|
||||
state=dict(required=True, choices=['saved', 'absent', 'loaded'], type='str')))
|
||||
required_if = [('state', 'saved', ['dest']),
|
||||
('state', 'loaded', ['src'])]
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec, required_if=required_if, supports_check_mode=False)
|
||||
|
||||
if not HAS_PYVMOMI:
|
||||
module.fail_json(msg='pyvmomi is required for this module')
|
||||
|
||||
vmware_cfg_backup = VMwareConfigurationBackup(module)
|
||||
vmware_cfg_backup.process_state()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue