Update RETURN section in proxmox_backup_schedule module

This commit is contained in:
raoufnezhad 2025-02-01 08:50:55 +03:30 committed by GitHub
parent 5a3e20faad
commit 942bb39304
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -90,15 +90,17 @@ EXAMPLES = """
RETURN = """
---
backup_schedule:
description:
- When backup_action is 'update_vmid', the backup_schedule will return True after successfully adding the VM ID to the backup job.
- When backup_action is 'delete_vmid', the backup_schedule will return a list of backup job IDs where the VM ID has been removed.
returned: always, but can be empty
type: bool | list
sample:
- True
- ['backup-job-id1', 'backup-job-id2']
update_result:
description: True if the VM ID was successfully added to the backup job.
returned: when backup_action is 'update_vmid'
type: bool
sample: true
delete_result:
description: A list of backup job IDs where the VM ID has been removed.
returned: when backup_action is 'delete_vmid'
type: list
sample: ['backup-job-id1', 'backup-job-id2']
"""
from ansible.module_utils.basic import AnsibleModule, missing_required_lib