mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 19:01:26 -07:00
[PR #9388/6aadcc72 backport][stable-10] [mem ... n]*.py: normalize docs (#9406)
[mem ... n]*.py: normalize docs (#9388)
* [mem ... n]*.py: normalize docs
* Update plugins/modules/netcup_dns.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* netcup_dns: change type of RV(records)
From complex to list of dicts.
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 6aadcc72d1)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot]
GitHub
parent
03f3b74934
commit
7732d64abb
25 changed files with 2245 additions and 2342 deletions
|
|
@ -14,89 +14,87 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: nsupdate
|
||||
|
||||
short_description: Manage DNS records
|
||||
description:
|
||||
- Create, update and remove DNS records using DDNS updates
|
||||
- Create, update and remove DNS records using DDNS updates.
|
||||
requirements:
|
||||
- dnspython
|
||||
author: "Loic Blot (@nerzhul)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Manage DNS record.
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
type: str
|
||||
server:
|
||||
description:
|
||||
- Apply DNS modification on this server, specified by IPv4 or IPv6 address.
|
||||
required: true
|
||||
type: str
|
||||
port:
|
||||
description:
|
||||
- Use this TCP port when connecting to O(server).
|
||||
default: 53
|
||||
type: int
|
||||
key_name:
|
||||
description:
|
||||
- Use TSIG key name to authenticate against DNS O(server)
|
||||
type: str
|
||||
key_secret:
|
||||
description:
|
||||
- Use TSIG key secret, associated with O(key_name), to authenticate against O(server)
|
||||
type: str
|
||||
key_algorithm:
|
||||
description:
|
||||
- Specify key algorithm used by O(key_secret).
|
||||
choices: ['HMAC-MD5.SIG-ALG.REG.INT', 'hmac-md5', 'hmac-sha1', 'hmac-sha224', 'hmac-sha256', 'hmac-sha384',
|
||||
'hmac-sha512']
|
||||
default: 'hmac-md5'
|
||||
type: str
|
||||
zone:
|
||||
description:
|
||||
- DNS record will be modified on this O(zone).
|
||||
- When omitted DNS will be queried to attempt finding the correct zone.
|
||||
type: str
|
||||
record:
|
||||
description:
|
||||
- Sets the DNS record to modify. When zone is omitted this has to be absolute (ending with a dot).
|
||||
required: true
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Sets the record type.
|
||||
default: 'A'
|
||||
type: str
|
||||
ttl:
|
||||
description:
|
||||
- Sets the record TTL.
|
||||
default: 3600
|
||||
type: int
|
||||
value:
|
||||
description:
|
||||
- Sets the record value.
|
||||
type: list
|
||||
elements: str
|
||||
protocol:
|
||||
description:
|
||||
- Sets the transport protocol (TCP or UDP). TCP is the recommended and a more robust option.
|
||||
default: 'tcp'
|
||||
choices: ['tcp', 'udp']
|
||||
type: str
|
||||
'''
|
||||
state:
|
||||
description:
|
||||
- Manage DNS record.
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
type: str
|
||||
server:
|
||||
description:
|
||||
- Apply DNS modification on this server, specified by IPv4 or IPv6 address.
|
||||
required: true
|
||||
type: str
|
||||
port:
|
||||
description:
|
||||
- Use this TCP port when connecting to O(server).
|
||||
default: 53
|
||||
type: int
|
||||
key_name:
|
||||
description:
|
||||
- Use TSIG key name to authenticate against DNS O(server).
|
||||
type: str
|
||||
key_secret:
|
||||
description:
|
||||
- Use TSIG key secret, associated with O(key_name), to authenticate against O(server).
|
||||
type: str
|
||||
key_algorithm:
|
||||
description:
|
||||
- Specify key algorithm used by O(key_secret).
|
||||
choices: ['HMAC-MD5.SIG-ALG.REG.INT', 'hmac-md5', 'hmac-sha1', 'hmac-sha224', 'hmac-sha256', 'hmac-sha384', 'hmac-sha512']
|
||||
default: 'hmac-md5'
|
||||
type: str
|
||||
zone:
|
||||
description:
|
||||
- DNS record will be modified on this O(zone).
|
||||
- When omitted DNS will be queried to attempt finding the correct zone.
|
||||
type: str
|
||||
record:
|
||||
description:
|
||||
- Sets the DNS record to modify. When zone is omitted this has to be absolute (ending with a dot).
|
||||
required: true
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Sets the record type.
|
||||
default: 'A'
|
||||
type: str
|
||||
ttl:
|
||||
description:
|
||||
- Sets the record TTL.
|
||||
default: 3600
|
||||
type: int
|
||||
value:
|
||||
description:
|
||||
- Sets the record value.
|
||||
type: list
|
||||
elements: str
|
||||
protocol:
|
||||
description:
|
||||
- Sets the transport protocol (TCP or UDP). TCP is the recommended and a more robust option.
|
||||
default: 'tcp'
|
||||
choices: ['tcp', 'udp']
|
||||
type: str
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Add or modify ansible.example.org A to 192.168.1.1"
|
||||
community.general.nsupdate:
|
||||
key_name: "nsupdate"
|
||||
|
|
@ -143,49 +141,49 @@ EXAMPLES = '''
|
|||
record: "1.1.168.192.in-addr.arpa."
|
||||
type: "PTR"
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
changed:
|
||||
description: If module has modified record
|
||||
returned: success
|
||||
type: str
|
||||
description: If module has modified record.
|
||||
returned: success
|
||||
type: str
|
||||
record:
|
||||
description: DNS record
|
||||
returned: success
|
||||
type: str
|
||||
sample: 'ansible'
|
||||
description: DNS record.
|
||||
returned: success
|
||||
type: str
|
||||
sample: 'ansible'
|
||||
ttl:
|
||||
description: DNS record TTL
|
||||
returned: success
|
||||
type: int
|
||||
sample: 86400
|
||||
description: DNS record TTL.
|
||||
returned: success
|
||||
type: int
|
||||
sample: 86400
|
||||
type:
|
||||
description: DNS record type
|
||||
returned: success
|
||||
type: str
|
||||
sample: 'CNAME'
|
||||
description: DNS record type.
|
||||
returned: success
|
||||
type: str
|
||||
sample: 'CNAME'
|
||||
value:
|
||||
description: DNS record value(s)
|
||||
returned: success
|
||||
type: list
|
||||
sample: '192.168.1.1'
|
||||
description: DNS record value(s).
|
||||
returned: success
|
||||
type: list
|
||||
sample: '192.168.1.1'
|
||||
zone:
|
||||
description: DNS record zone
|
||||
returned: success
|
||||
type: str
|
||||
sample: 'example.org.'
|
||||
description: DNS record zone.
|
||||
returned: success
|
||||
type: str
|
||||
sample: 'example.org.'
|
||||
dns_rc:
|
||||
description: dnspython return code
|
||||
returned: always
|
||||
type: int
|
||||
sample: 4
|
||||
description: C(dnspython) return code.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 4
|
||||
dns_rc_str:
|
||||
description: dnspython return code (string representation)
|
||||
returned: always
|
||||
type: str
|
||||
sample: 'REFUSED'
|
||||
'''
|
||||
description: C(dnspython) return code (string representation).
|
||||
returned: always
|
||||
type: str
|
||||
sample: 'REFUSED'
|
||||
"""
|
||||
|
||||
import traceback
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue