change description in proxmox_backup_schedule.py

This commit is contained in:
raoufnezhad 2025-03-03 12:30:27 +03:30 committed by GitHub
parent 8afd207c82
commit 2f7469be42
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -86,6 +86,24 @@ EXAMPLES = """
api_host: '192.168.20.20'
vm_id: 'VM ID'
state: 'absent'
- name: Removing backup setting based on VM name from specific backup job
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: Removing backup setting based on VM ID from specific backup job
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 = """
@ -93,12 +111,8 @@ RETURN = """
backup_schedule:
description:
- If V(present), the backup_schedule will return True after adding the VM ID to the backup job.
- If V(absent), the backup_schedule will return a list of backup job IDs where the VM ID has existed after removing it.
returned: always, but can be empty
type: raw
sample:
- true
- ['backup-job-id1', 'backup-job-id2']
- If V(absent), the backup_schedule will return True after removing it from the backup job.
returned: always, but can be empty
"""
from ansible.module_utils.basic import AnsibleModule, missing_required_lib