1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Update documentation and fix typo

This commit is contained in:
Dylan LEVERRIER 2024-05-15 08:50:07 +02:00
parent 3a51ccd55a
commit 8ce38665cd

View file

@ -83,7 +83,7 @@ options:
fleecing: fleecing:
description: description:
- Options for backup fleecing (VM only). - Options for backup fleecing (VM only).
format: [[enabled=]<1|0>] [,storage=<storage ID>] format: "[enabled=<1|0>][,storage=<storage ID>]"
type: str type: str
id: id:
description: description:
@ -164,7 +164,7 @@ options:
prune_backups: prune_backups:
description: description:
- Use these retention options instead of those from the storage configuration. - Use these retention options instead of those from the storage configuration.
Format: [keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]) Format: "[keep-all=<1|0>], [keep-daily=<N>], [keep-hourly=<N>], [keep-last=<N>], [keep-monthly=<N>], [keep-weekly=<N>], [keep-yearly=<N>]"
type: str type: str
default: keep-all=1 default: keep-all=1
quiet: quiet:
@ -185,6 +185,7 @@ options:
schedule: schedule:
description: description:
- Backup schedule. The format is a subset of `systemd` calendar events. - Backup schedule. The format is a subset of `systemd` calendar events.
example: "*-*-* 22:00:00"
type: str type: str
script: script:
description: description:
@ -193,7 +194,7 @@ options:
starttime: starttime:
description: description:
- Job Start time. - Job Start time.
format: HH:MM format: "HH:MM"
type: str type: str
stdexcludes: stdexcludes:
description: description:
@ -208,13 +209,13 @@ options:
stopwait: stopwait:
description: description:
- Maximal time to wait until a guest system is stopped (minutes). - Maximal time to wait until a guest system is stopped (minutes).
format: <integer> (0 - N) format: "<integer> (0 - N)"
type: int type: int
default: 10 default: 10
storage: storage:
description: description:
- Store resulting file to this storage. - Store resulting file to this storage.
format: <storage ID> format: "<storage ID>"
type: str type: str
tmpdir: tmpdir:
description: description: