mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-21 09:51:27 -07:00
[PR #6683/eff0cb0e backport][stable-7] Use semantic markup (modules r-s) (#6707)
Use semantic markup (modules r-s) (#6683)
* Use semantic markup.
* Use 'ignore:' for alias reference.
* Ignore sanity errors for older ansible-core versions.
* Improve markup for RHSM modules.
Co-authored-by: Pino Toscano <ptoscano@redhat.com>
* 'ignore:' is no longer needed.
* E() now works better.
---------
Co-authored-by: Pino Toscano <ptoscano@redhat.com>
(cherry picked from commit eff0cb0ed9
)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
f4af31b76b
commit
34c4b1f367
49 changed files with 311 additions and 303 deletions
|
@ -32,10 +32,10 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Indicate desired state of the database backup.
|
||||
- C(present) creates a backup.
|
||||
- C(absent) deletes the backup.
|
||||
- C(exported) creates a download link for the backup.
|
||||
- C(restored) restores the backup to a new database.
|
||||
- V(present) creates a backup.
|
||||
- V(absent) deletes the backup.
|
||||
- V(exported) creates a download link for the backup.
|
||||
- V(restored) restores the backup to a new database.
|
||||
type: str
|
||||
default: present
|
||||
choices:
|
||||
|
@ -46,7 +46,7 @@ options:
|
|||
|
||||
region:
|
||||
description:
|
||||
- Scaleway region to use (for example C(fr-par)).
|
||||
- Scaleway region to use (for example V(fr-par)).
|
||||
type: str
|
||||
required: true
|
||||
choices:
|
||||
|
@ -57,37 +57,37 @@ options:
|
|||
id:
|
||||
description:
|
||||
- UUID used to identify the database backup.
|
||||
- Required for C(absent), C(exported) and C(restored) states.
|
||||
- Required for V(absent), V(exported) and V(restored) states.
|
||||
type: str
|
||||
|
||||
name:
|
||||
description:
|
||||
- Name used to identify the database backup.
|
||||
- Required for C(present) state.
|
||||
- Ignored when I(state=absent), I(state=exported) or I(state=restored).
|
||||
- Required for V(present) state.
|
||||
- Ignored when O(state=absent), O(state=exported) or O(state=restored).
|
||||
type: str
|
||||
required: false
|
||||
|
||||
database_name:
|
||||
description:
|
||||
- Name used to identify the database.
|
||||
- Required for C(present) and C(restored) states.
|
||||
- Ignored when I(state=absent) or I(state=exported).
|
||||
- Required for V(present) and V(restored) states.
|
||||
- Ignored when O(state=absent) or O(state=exported).
|
||||
type: str
|
||||
required: false
|
||||
|
||||
instance_id:
|
||||
description:
|
||||
- UUID of the instance associated to the database backup.
|
||||
- Required for C(present) and C(restored) states.
|
||||
- Ignored when I(state=absent) or I(state=exported).
|
||||
- Required for V(present) and V(restored) states.
|
||||
- Ignored when O(state=absent) or O(state=exported).
|
||||
type: str
|
||||
required: false
|
||||
|
||||
expires_at:
|
||||
description:
|
||||
- Expiration datetime of the database backup (ISO 8601 format).
|
||||
- Ignored when I(state=absent), I(state=exported) or I(state=restored).
|
||||
- Ignored when O(state=absent), O(state=exported) or O(state=restored).
|
||||
type: str
|
||||
required: false
|
||||
|
||||
|
@ -145,7 +145,7 @@ EXAMPLES = '''
|
|||
RETURN = '''
|
||||
metadata:
|
||||
description: Backup metadata.
|
||||
returned: when I(state=present), I(state=exported) or I(state=restored)
|
||||
returned: when O(state=present), O(state=exported), or O(state=restored)
|
||||
type: dict
|
||||
sample: {
|
||||
"metadata": {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue