mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-30 12:59:09 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -35,68 +35,53 @@ options:
|
|||
required: true
|
||||
port:
|
||||
description: Service port. Required for C(type=SRV)
|
||||
required: false
|
||||
default: null
|
||||
priority:
|
||||
description: Record priority. Required for C(type=MX) and C(type=SRV)
|
||||
required: false
|
||||
default: "1"
|
||||
proto:
|
||||
description: Service protocol. Required for C(type=SRV). Common values are tcp and udp. (Before Ansible 2.6 only tcp and udp were available).
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Service protocol. Required for C(type=SRV).
|
||||
- Common values are tcp and udp.
|
||||
- Before Ansible 2.6 only tcp and udp were available.
|
||||
proxied:
|
||||
description: Proxy through cloudflare network or just use DNS
|
||||
required: false
|
||||
default: no
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.3"
|
||||
record:
|
||||
description:
|
||||
- Record to add. Required if C(state=present). Default is C(@) (e.g. the zone name)
|
||||
required: false
|
||||
default: "@"
|
||||
aliases: [ "name" ]
|
||||
service:
|
||||
description: Record service. Required for C(type=SRV)
|
||||
required: false
|
||||
default: null
|
||||
solo:
|
||||
description:
|
||||
- Whether the record should be the only one for that record type and record name. Only use with C(state=present)
|
||||
- This will delete all other records with the same record name and type.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Whether the record(s) should exist or not
|
||||
required: false
|
||||
choices: [ 'present', 'absent' ]
|
||||
default: present
|
||||
timeout:
|
||||
description:
|
||||
- Timeout for Cloudflare API calls
|
||||
required: false
|
||||
default: 30
|
||||
ttl:
|
||||
description:
|
||||
- The TTL to give the new record. Must be between 120 and 2,147,483,647 seconds, or 1 for automatic.
|
||||
required: false
|
||||
default: 1 (automatic)
|
||||
type:
|
||||
description:
|
||||
- The type of DNS record to create. Required if C(state=present)
|
||||
required: false
|
||||
choices: [ 'A', 'AAAA', 'CNAME', 'TXT', 'SRV', 'MX', 'NS', 'SPF' ]
|
||||
default: null
|
||||
value:
|
||||
description:
|
||||
- The record value. Required for C(state=present)
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ "content" ]
|
||||
weight:
|
||||
description: Service weight. Required for C(type=SRV)
|
||||
required: false
|
||||
default: "1"
|
||||
zone:
|
||||
description:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue