#!/usr/bin/python # -*- coding: utf-8 -*- # # Copyright (c) 2025 Marzieh Raoufnezhad # Copyright (c) 2025 Maryam Mayabi # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ --- module: proxmox_backup_schedule short_description: Schedule VM backups and removing them description: The module modifies backup jobs such as set or delete C(vmid). author: - "Marzieh Raoufnezhad (@raoufnezhad) " - "Maryam Mayabi (@mmayabi) " version_added: 1.0.0 options: vm_name: description: - The name of the Proxmox VM. - Mutually exclusive with O(vm_id). type: str vm_id: description: - The ID of the Proxmox VM. - Mutually exclusive with O(vm_name). type: str backup_id: description: The backup job ID. type: str state: description: - If V(present), ensure that VM is present in the backup job on defined O(backup_id). - If V(absent), ensure that VM is not present in the backup job if O(backup_id) is defined and otherwise, it should not exist in any of the backup jobs. required: true choices: ["present", "absent"] type: str extends_documentation_fragment: - community.proxmox.proxmox.documentation - community.proxmox.attributes - community.proxmox.attributes.info_module - community.proxmox.proxmox.actiongroup_proxmox """ EXAMPLES = """ - name: Ensure that VM is present in the backup job community.proxmox.proxmox_backup_schedule: api_user: 'myUser@pam' api_password: '*******' api_host: '192.168.20.20' vm_name: 'VM Name' backup_id: 'backup-b2adffdc-316e' state: 'present' - name: Ensure that vmid is present in the backup job community.proxmox.proxmox_backup_schedule: api_user: 'myUser@pam' api_password: '*******' api_host: '192.168.20.20' vm_id: 'VM ID' backup_id: 'backup-b2adffdc-316e' state: 'present' - name: Ensure that there is no scheduled backup for VM name within all backup jobs community.proxmox.proxmox_backup_schedule: api_user: 'myUser@pam' api_password: '*******' api_host: '192.168.20.20' vm_name: 'VM Name' state: 'absent' - name: Ensure that there is no scheduled backup for vmid within all backup jobs community.proxmox.proxmox_backup_schedule: api_user: 'myUser@pam' api_password: '*******' api_host: '192.168.20.20' vm_id: 'VM ID' state: 'absent' - name: Ensure that there is no scheduled backup for VM within specific backup job community.proxmox.proxmox_backup_schedule: api_user: 'myUser@pam' api_password: '*******' api_host: '192.168.20.20' vm_name: 'VM Name' backup_id: 'backup-b2adffdc-316e' state: 'absent' - name: Ensure that there is no scheduled backup for vmid within specific backup job community.proxmox.proxmox_backup_schedule: api_user: 'myUser@pam' api_password: '*******' api_host: '192.168.20.20' vm_id: 'VM ID' backup_id: 'backup-b2adffdc-316e' state: 'absent' """ RETURN = """ """ from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible_collections.community.proxmox.plugins.module_utils.proxmox import ( proxmox_auth_argument_spec, ProxmoxAnsible, HAS_PROXMOXER, PROXMOXER_IMP_ERR) class ProxmoxSetVMBackupAnsible(ProxmoxAnsible): def list_backup_schedules(self): try: backupSections = self.proxmox_api.cluster.backup.get() except Exception as e: self.module.fail_json(msg="Getting backup sections failed: %s" % e) return backupSections def get_backup_job_info(self, backup_id): try: specificBackupID = self.proxmox_api.cluster.backup.get(backup_id) except Exception as e: self.module.fail_json(msg="Getting specific backup ID failed: %s" % e) return specificBackupID def update_backup_job_vmid(self, backup_id, updated_backup_vmids): try: self.proxmox_api.cluster.backup.put(backup_id, vmid=updated_backup_vmids) except Exception as e: self.module.fail_json(msg="Setting vmid backup failed: %s" % e) return def get_vms_list(self): """Retrieve the list of all virtual machines in the cluster.""" try: vms = self.proxmox_api.cluster.resources.get(type='vm') except Exception as e: self.module.fail_json(msg="Getting vms info from cluster failed: %s" % e) return vms def get_vmid_from_vmname(self, vmname): """Convert vm name to vm ID.""" vmInfo = self.get_vms_list() vms = [vm for vm in vmInfo if vm['name'] == vmname] return (vms[0]['vmid']) def ensure_backup_present(self, vm_id, backup_id): """Add vmid to backup job.""" backup_job_info = self.get_backup_job_info(backup_id) """If backup_job_info is a list, get the first item (assuming there's only one backup job returned).""" if isinstance(backup_job_info, list): backup_job_info = backup_job_info[0] vmids = backup_job_info['vmid'].split(',') if str(vm_id) not in vmids: updated_backup_vmids = backup_job_info['vmid'] + ',' + str(vm_id) self.update_backup_job_vmid(backup_id, updated_backup_vmids) return True else: return False def ensure_backup_absent(self, vm_id, backup_id): """Delete vmid from backup job.""" if backup_id is not None and backup_id != '': backup_job_info = self.get_backup_job_info(backup_id) if isinstance(backup_job_info, list): backup_job_info = backup_job_info[0] vmids = backup_job_info['vmid'].split(',') if str(vm_id) in vmids: if len(vmids) > 1: vmids.remove(str(vm_id)) new_vmids = ','.join(map(str, vmids)) self.update_backup_job_vmid(backup_job_info['id'], new_vmids) return True else: self.module.fail_json(msg="No more than one vmid is assigned to %s. You just can remove job." % backup_job_info['id']) return False else: list_backup_jobs_vm_deleted = [] list_backups = self.list_backup_schedules() for backup_job in list_backups: vmids = list(backup_job['vmid'].split(',')) if str(vm_id) in vmids: if len(vmids) > 1: vmids.remove(str(vm_id)) new_vmids = ','.join(map(str, vmids)) self.update_backup_job_vmid(backup_job['id'], new_vmids) list_backup_jobs_vm_deleted.append(backup_job['id']) else: self.module.fail_json(msg="No more than one vmid is assigned to %s. You just can remove job." % backup_job['id']) return len(list_backup_jobs_vm_deleted) > 0 def main(): args = proxmox_auth_argument_spec() backup_schedule_args = dict( vm_name=dict(type='str'), vm_id=dict(type='str'), backup_id=dict(type='str'), state=dict(choices=['present', 'absent'], required=True) ) args.update(backup_schedule_args) module = AnsibleModule( argument_spec=args, mutually_exclusive=[('vm_id', 'vm_name')], supports_check_mode=True ) result = dict(changed=False, message='') # Check if proxmoxer exist if not HAS_PROXMOXER: module.fail_json(msg=missing_required_lib('proxmoxer'), exception=PROXMOXER_IMP_ERR) # Start to connect to proxmox to get backup data proxmox = ProxmoxSetVMBackupAnsible(module) vm_name = module.params['vm_name'] vm_id = module.params['vm_id'] backup_id = module.params['backup_id'] state = module.params['state'] if vm_name: vm_id = proxmox.get_vmid_from_vmname(vm_name) if state == 'present': backup_schedule = proxmox.ensure_backup_present(vm_id, backup_id) if state == 'absent': backup_schedule = proxmox.ensure_backup_absent(vm_id, backup_id) if backup_schedule: result['changed'] = True result['message'] = 'The backup schedule has been changed successfully.' else: result['message'] = 'The backup schedule did not change anything.' module.exit_json(**result) if __name__ == '__main__': main()