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:
parent
3a51ccd55a
commit
8ce38665cd
1 changed files with 23 additions and 22 deletions
|
@ -27,10 +27,10 @@ attributes:
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Indicate desired state of the job.
|
- Indicate desired state of the job.
|
||||||
- Set to list to get one or all jobs.
|
- Set to list to get one or all jobs.
|
||||||
- Set to present to create or update job.
|
- Set to present to create or update job.
|
||||||
- Set to absent to delete job.
|
- Set to absent to delete job.
|
||||||
choices: ['list', 'present', 'absent']
|
choices: ['list', 'present', 'absent']
|
||||||
type: str
|
type: str
|
||||||
all:
|
all:
|
||||||
|
@ -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,66 +164,67 @@ 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:
|
||||||
description:
|
description:
|
||||||
- Be quiet.
|
- Be quiet.
|
||||||
type: bool
|
type: bool
|
||||||
default: 0
|
default: 0
|
||||||
remove:
|
remove:
|
||||||
description:
|
description:
|
||||||
- Prune older backups according to 'prune-backups'.
|
- Prune older backups according to 'prune-backups'.
|
||||||
type: bool
|
type: bool
|
||||||
default: 1
|
default: 1
|
||||||
repeat_missed:
|
repeat_missed:
|
||||||
description:
|
description:
|
||||||
- If true, the job will be run as soon as possible if it was missed while the scheduler was not running.
|
- If true, the job will be run as soon as possible if it was missed while the scheduler was not running.
|
||||||
type: bool
|
type: bool
|
||||||
default: 0
|
default: 0
|
||||||
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:
|
||||||
- Use specified hook script.
|
- Use specified hook script.
|
||||||
type: str
|
type: str
|
||||||
starttime:
|
starttime:
|
||||||
description:
|
description:
|
||||||
- Job Start time.
|
- Job Start time.
|
||||||
format: HH:MM
|
format: "HH:MM"
|
||||||
type: str
|
type: str
|
||||||
stdexcludes:
|
stdexcludes:
|
||||||
description:
|
description:
|
||||||
- Exclude temporary files and logs.
|
- Exclude temporary files and logs.
|
||||||
type: bool
|
type: bool
|
||||||
default: 0
|
default: 0
|
||||||
stop:
|
stop:
|
||||||
description:
|
description:
|
||||||
- Stop running backup jobs on this host.
|
- Stop running backup jobs on this host.
|
||||||
type: bool
|
type: bool
|
||||||
default: 0
|
default: 0
|
||||||
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:
|
||||||
- Store temporary files to specified directory.
|
- Store temporary files to specified directory.
|
||||||
type: str
|
type: str
|
||||||
vmid:
|
vmid:
|
||||||
description:
|
description:
|
||||||
- The ID of the guest system you want to backup.
|
- The ID of the guest system you want to backup.
|
||||||
- Can not be use with vmid and pool in same job
|
- Can not be use with vmid and pool in same job
|
||||||
type: str
|
type: str
|
||||||
zstd:
|
zstd:
|
||||||
description:
|
description:
|
||||||
|
|
Loading…
Reference in a new issue