summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/dns/plugins/doc_fragments
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
commit38b7c80217c4e72b1d8988eb1e60bb6e77334114 (patch)
tree356e9fd3762877d07cde52d21e77070aeff7e789 /ansible_collections/community/dns/plugins/doc_fragments
parentAdding upstream version 7.7.0+dfsg. (diff)
downloadansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.tar.xz
ansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.zip
Adding upstream version 9.4.0+dfsg.upstream/9.4.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/community/dns/plugins/doc_fragments')
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/filters.py12
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/hetzner.py35
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/hosttech.py41
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/inventory_records.py12
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/module_record.py14
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/module_record_info.py16
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/module_record_set.py37
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/module_record_set_info.py16
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/module_record_sets.py26
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/module_zone_info.py4
-rw-r--r--ansible_collections/community/dns/plugins/doc_fragments/options.py22
11 files changed, 128 insertions, 107 deletions
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/filters.py b/ansible_collections/community/dns/plugins/doc_fragments/filters.py
index e153d4bf9..3227c0f21 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/filters.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/filters.py
@@ -26,8 +26,8 @@ options:
keep_unknown_suffix:
description:
- This treats unknown TLDs as valid public suffixes. So for example the public suffix
- of C(example.tlddoesnotexist) is C(.tlddoesnotexist) if this is C(true). If set to
- C(false), it will return an empty string in this case.
+ of C(example.tlddoesnotexist) is C(.tlddoesnotexist) if this is V(true). If set to
+ V(false), it will return an empty string in this case.
- This option corresponds to whether the global wildcard rule C(*) in the Public
Suffix List is used or not.
type: boolean
@@ -40,17 +40,17 @@ options:
description:
- This controls the behavior in case there is no label in front of the public suffix.
This is the case if the DNS name itself is a public suffix.
- - If set to C(false), in this case the public suffix is treated as a registrable domain.
- - If set to C(true) (default), the registrable domain of a public suffix is interpreted as an
+ - If set to V(false), in this case the public suffix is treated as a registrable domain.
+ - If set to V(true) (default), the registrable domain of a public suffix is interpreted as an
empty string.
type: boolean
default: true
keep_unknown_suffix:
description:
- This treats unknown TLDs as valid public suffixes. So for example the public suffix of
- C(example.tlddoesnotexist) is C(.tlddoesnotexist) if this is C(true), and hence the
+ C(example.tlddoesnotexist) is C(.tlddoesnotexist) if this is V(true), and hence the
registrable domain of C(www.example.tlddoesnotexist) is C(example.tlddoesnotexist).
- If set to C(false), the registrable domain of C(www.example.tlddoesnotexist) is
+ If set to V(false), the registrable domain of C(www.example.tlddoesnotexist) is
C(tlddoesnotexist).
- This option corresponds to whether the global wildcard rule C(*) in the Public Suffix List
is used or not.
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/hetzner.py b/ansible_collections/community/dns/plugins/doc_fragments/hetzner.py
index 3b79e5da0..3e8199b85 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/hetzner.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/hetzner.py
@@ -16,7 +16,7 @@ options:
hetzner_token:
description:
- The token for the Hetzner API.
- - If not provided, will be read from the environment variable C(HETZNER_DNS_TOKEN).
+ - If not provided, will be read from the environment variable E(HETZNER_DNS_TOKEN).
aliases:
- api_token
type: str
@@ -33,6 +33,15 @@ options:
- name: HETZNER_DNS_TOKEN
'''
+ # NOTE: This document fragment adds additional information on records.
+ RECORD_NOTES = r'''
+options: {}
+notes:
+ - For C(CNAME) records, use absolute DNS names for values. Absolute DNS names end with
+ a trailing period C(.), for example C(foo.example.com.). If you use a relative DNS name, with no
+ trailing period, the value will be relative to the zone of the C(CNAME) record.
+'''
+
# WARNING: This section is automatically generated by update-docs-fragments.py.
# It is used to augment the docs fragments module_record, module_record_set.
# DO NOT EDIT MANUALLY!
@@ -76,17 +85,19 @@ options:
record:
description:
- The full DNS record to create or delete.
- - Exactly one of I(record) and I(prefix) must be specified.
+ - Exactly one of O(record_sets[].record) and O(record_sets[].prefix)
+ must be specified.
type: str
prefix:
description:
- The prefix of the DNS record.
- - This is the part of I(record) before I(zone_name). For example,
- if the record to be modified is C(www.example.com) for the zone
- C(example.com), the prefix is C(www). If the record in this
- example would be C(example.com), the prefix would be C('') (empty
- string).
- - Exactly one of I(record) and I(prefix) must be specified.
+ - This is the part of O(record_sets[].record) before O(zone_name).
+ For example, if the record to be modified is C(www.example.com)
+ for the zone C(example.com), the prefix is V(www). If the record
+ in this example would be C(example.com), the prefix would be
+ V('') (empty string).
+ - Exactly one of O(record_sets[].record) and O(record_sets[].prefix)
+ must be specified.
type: str
ttl:
description:
@@ -119,13 +130,13 @@ options:
- YAML lists or multiple comma-spaced values are allowed.
- When deleting a record all values for the record must be specified
or it will not be deleted.
- - Must be specified if I(ignore=false).
+ - Must be specified if O(record_sets[].ignore=false).
type: list
elements: str
ignore:
description:
- - If set to C(true), I(value) will be ignored.
- - This is useful when I(prune=true), but you do not want certain
+ - If set to V(true), O(record_sets[].value) will be ignored.
+ - This is useful when O(prune=true), but you do not want certain
entries to be removed without having to know their current value.
type: bool
default: false
@@ -136,7 +147,7 @@ options:
# DO NOT EDIT MANUALLY!
RECORD_TYPE_CHOICES_RECORDS_INVENTORY = r'''
options:
- filters:
+ simple_filters:
suboptions:
type:
description:
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/hosttech.py b/ansible_collections/community/dns/plugins/doc_fragments/hosttech.py
index 937983f50..571b0e595 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/hosttech.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/hosttech.py
@@ -19,20 +19,20 @@ options:
hosttech_username:
description:
- The username for the Hosttech API user.
- - If provided, I(hosttech_password) must also be provided.
- - Mutually exclusive with I(hosttech_token).
+ - If provided, O(hosttech_password) must also be provided.
+ - Mutually exclusive with O(hosttech_token).
type: str
hosttech_password:
description:
- The password for the Hosttech API user.
- - If provided, I(hosttech_username) must also be provided.
- - Mutually exclusive with I(hosttech_token).
+ - If provided, O(hosttech_username) must also be provided.
+ - Mutually exclusive with O(hosttech_token).
type: str
hosttech_token:
description:
- The password for the Hosttech API user.
- - Mutually exclusive with I(hosttech_username) and I(hosttech_password).
- - Since community.dns 1.2.0, the alias I(api_token) can be used.
+ - Mutually exclusive with O(hosttech_username) and O(hosttech_password).
+ - Since community.dns 1.2.0, the alias O(ignore:api_token) can be used.
aliases:
- api_token
type: str
@@ -58,6 +58,11 @@ options:
version_added: 2.5.0
'''
+ # NOTE: This document fragment adds additional information on records.
+ RECORD_NOTES = r'''
+options: {}
+'''
+
# WARNING: This section is automatically generated by update-docs-fragments.py.
# It is used to augment the docs fragments module_record, module_record_set.
# DO NOT EDIT MANUALLY!
@@ -97,17 +102,19 @@ options:
record:
description:
- The full DNS record to create or delete.
- - Exactly one of I(record) and I(prefix) must be specified.
+ - Exactly one of O(record_sets[].record) and O(record_sets[].prefix)
+ must be specified.
type: str
prefix:
description:
- The prefix of the DNS record.
- - This is the part of I(record) before I(zone_name). For example,
- if the record to be modified is C(www.example.com) for the zone
- C(example.com), the prefix is C(www). If the record in this
- example would be C(example.com), the prefix would be C('') (empty
- string).
- - Exactly one of I(record) and I(prefix) must be specified.
+ - This is the part of O(record_sets[].record) before O(zone_name).
+ For example, if the record to be modified is C(www.example.com)
+ for the zone C(example.com), the prefix is V(www). If the record
+ in this example would be C(example.com), the prefix would be
+ V('') (empty string).
+ - Exactly one of O(record_sets[].record) and O(record_sets[].prefix)
+ must be specified.
type: str
ttl:
description:
@@ -136,13 +143,13 @@ options:
- YAML lists or multiple comma-spaced values are allowed.
- When deleting a record all values for the record must be specified
or it will not be deleted.
- - Must be specified if I(ignore=false).
+ - Must be specified if O(record_sets[].ignore=false).
type: list
elements: str
ignore:
description:
- - If set to C(true), I(value) will be ignored.
- - This is useful when I(prune=true), but you do not want certain
+ - If set to V(true), O(record_sets[].value) will be ignored.
+ - This is useful when O(prune=true), but you do not want certain
entries to be removed without having to know their current value.
type: bool
default: false
@@ -153,7 +160,7 @@ options:
# DO NOT EDIT MANUALLY!
RECORD_TYPE_CHOICES_RECORDS_INVENTORY = r'''
options:
- filters:
+ simple_filters:
suboptions:
type:
description:
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/inventory_records.py b/ansible_collections/community/dns/plugins/doc_fragments/inventory_records.py
index fcdc55acb..e7a90a7b7 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/inventory_records.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/inventory_records.py
@@ -17,24 +17,28 @@ description:
- Records are matched by prefix / record name and value.
notes:
- - The I(zone_name) and I(zone_id) options can be templated.
+ - The O(zone_name) and O(zone_id) options can be templated.
options:
zone_name:
description:
- The DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
type: str
aliases:
- zone
zone_id:
description:
- The ID of the DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
- filters:
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
+ simple_filters:
description:
- A dictionary of filter value pairs.
+ - This option has been renamed from O(filters) to O(simple_filters) in community.dns 2.8.0.
+ The old name can still be used until community.dns 3.0.0.
type: dict
+ aliases:
+ - filters
default: {}
suboptions:
# (The following must be kept in sync with the equivalent lines in <provider_name>.py!)
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/module_record.py b/ansible_collections/community/dns/plugins/doc_fragments/module_record.py
index 4eaa956aa..d79313555 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/module_record.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/module_record.py
@@ -28,26 +28,26 @@ options:
zone_name:
description:
- The DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
type: str
aliases:
- zone
zone_id:
description:
- The ID of the DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
record:
description:
- The full DNS record to create or delete.
- - Exactly one of I(record) and I(prefix) must be specified.
+ - Exactly one of O(record) and O(prefix) must be specified.
type: str
prefix:
description:
- The prefix of the DNS record.
- - This is the part of I(record) before I(zone_name). For example, if the record to be modified is C(www.example.com)
- for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
- prefix would be C('') (empty string).
- - Exactly one of I(record) and I(prefix) must be specified.
+ - This is the part of O(record) before O(zone_name). For example, if the record to be modified is C(www.example.com)
+ for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+ prefix would be V('') (empty string).
+ - Exactly one of O(record) and O(prefix) must be specified.
type: str
ttl:
description:
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/module_record_info.py b/ansible_collections/community/dns/plugins/doc_fragments/module_record_info.py
index e039ec6aa..43b0549c2 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/module_record_info.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/module_record_info.py
@@ -27,30 +27,30 @@ options:
zone_name:
description:
- The DNS zone to modify.
- - Exactly one of I(zone) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
type: str
aliases:
- zone
zone_id:
description:
- The ID of the DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
record:
description:
- The full DNS record to retrieve.
- - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+ - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
type: str
prefix:
description:
- The prefix of the DNS record.
- - This is the part of I(record) before I(zone_name). For example, if the record to be modified is C(www.example.com)
- for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
- prefix would be C('') (empty string).
- - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+ - This is the part of O(record) before O(zone_name). For example, if the record to be modified is C(www.example.com)
+ for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+ prefix would be V('') (empty string).
+ - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
type: str
type:
description:
- The type of DNS record to retrieve.
- - Required if I(what) is C(single_record).
+ - Required if O(what) is V(single_record).
type: str
'''
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/module_record_set.py b/ansible_collections/community/dns/plugins/doc_fragments/module_record_set.py
index 2b4004422..2fb83186c 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/module_record_set.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/module_record_set.py
@@ -25,33 +25,32 @@ options:
zone_name:
description:
- The DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
type: str
aliases:
- zone
zone_id:
description:
- The ID of the DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
version_added: 0.2.0
record:
description:
- The full DNS record to create or delete.
- - Exactly one of I(record) and I(prefix) must be specified.
+ - Exactly one of O(record) and O(prefix) must be specified.
type: str
prefix:
description:
- The prefix of the DNS record.
- - This is the part of I(record) before I(zone_name). For example, if the record to be modified is C(www.example.com)
- for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
- prefix would be C('') (empty string).
- - Exactly one of I(record) and I(prefix) must be specified.
+ - This is the part of O(record) before O(zone_name). For example, if the record to be modified is C(www.example.com)
+ for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+ prefix would be V('') (empty string).
+ - Exactly one of O(record) and O(prefix) must be specified.
type: str
version_added: 0.2.0
ttl:
description:
- The TTL to give the new record, in seconds.
- - Will be ignored if I(state=absent) and I(on_existing=replace).
type: int
type:
description:
@@ -64,22 +63,22 @@ options:
- YAML lists or multiple comma-spaced values are allowed.
- When deleting a record all values for the record must be specified or it will
not be deleted.
- - Must be specified if I(state=present) or when I(on_existing) is not C(replace).
- - Will be ignored if I(state=absent) and I(on_existing=replace).
+ - Must be specified if O(state=present) or when O(on_existing) is not V(replace).
+ - Will be ignored if O(state=absent) and O(on_existing=replace).
type: list
elements: str
on_existing:
description:
- This option defines the behavior if the record set already exists, but differs from the specified record set.
- For this comparison, I(value) and I(ttl) are used for all records of type I(type) matching the I(prefix) resp. I(record).
- - If set to C(replace), the record will be updated (I(state=present)) or removed (I(state=absent)).
- This is the old I(overwrite=true) behavior.
- - If set to C(keep_and_fail), the module will fail and not modify the records.
- This is the old I(overwrite=false) behavior if I(state=present).
- - If set to C(keep_and_warn), the module will warn and not modify the records.
- - If set to C(keep), the module will not modify the records.
- This is the old I(overwrite=false) behavior if I(state=absent).
- - If I(state=absent) and the value is not C(replace), I(value) must be specified.
+ For this comparison, O(value) and O(ttl) are used for all records of type O(type) matching the O(prefix) resp. O(record).
+ - If set to V(replace), the record will be updated (O(state=present)) or removed (O(state=absent)).
+ This is the old O(ignore:overwrite=true) behavior.
+ - If set to V(keep_and_fail), the module will fail and not modify the records.
+ This is the old O(ignore:overwrite=false) behavior if O(state=present).
+ - If set to V(keep_and_warn), the module will warn and not modify the records.
+ - If set to V(keep), the module will not modify the records.
+ This is the old O(ignore:overwrite=false) behavior if O(state=absent).
+ - If O(state=absent) and the value is not V(replace), O(value) must be specified.
default: replace
type: str
choices:
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/module_record_set_info.py b/ansible_collections/community/dns/plugins/doc_fragments/module_record_set_info.py
index 857e9036e..2fa5321dd 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/module_record_set_info.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/module_record_set_info.py
@@ -27,32 +27,32 @@ options:
zone_name:
description:
- The DNS zone to modify.
- - Exactly one of I(zone) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
type: str
aliases:
- zone
zone_id:
description:
- The ID of the DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
version_added: 0.2.0
record:
description:
- The full DNS record to retrieve.
- - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+ - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
type: str
prefix:
description:
- The prefix of the DNS record.
- - This is the part of I(record) before I(zone_name). For example, if the record to be modified is C(www.example.com)
- for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
- prefix would be C('') (empty string).
- - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+ - This is the part of O(record) before O(zone_name). For example, if the record to be modified is C(www.example.com)
+ for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+ prefix would be V('') (empty string).
+ - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
type: str
version_added: 0.2.0
type:
description:
- The type of DNS record to retrieve.
- - Required if I(what) is C(single_record).
+ - Required if O(what) is V(single_record).
type: str
'''
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/module_record_sets.py b/ansible_collections/community/dns/plugins/doc_fragments/module_record_sets.py
index 1b393b444..cf3fcbe9f 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/module_record_sets.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/module_record_sets.py
@@ -14,27 +14,27 @@ class ModuleDocFragment(object):
DOCUMENTATION = r'''
description:
- The module allows to set, modify and delete multiple DNS record sets at once.
- - With the I(purge) option, it is also possible to delete existing record sets
+ - With the O(prune) option, it is also possible to delete existing record sets
that are not mentioned in the module parameters. With this, it is possible
to synchronize the expected state of a DNS zone with the expected state.
- - "It is possible to ignore certain record sets by specifying I(ignore: true) for
+ - "It is possible to ignore certain record sets by specifying O(record_sets[].ignore=true) for
that record set."
options:
zone_name:
description:
- The DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
type: str
aliases:
- zone
zone_id:
description:
- The ID of the DNS zone to modify.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
prune:
description:
- - If set to C(true), will remove all existing records in the zone that are not listed in I(records).
+ - If set to V(true), will remove all existing records in the zone that are not listed in O(record_sets).
type: bool
default: false
record_sets:
@@ -50,15 +50,15 @@ options:
record:
description:
- The full DNS record to create or delete.
- - Exactly one of I(record) and I(prefix) must be specified.
+ - Exactly one of O(record_sets[].record) and O(record_sets[].prefix) must be specified.
type: str
prefix:
description:
- The prefix of the DNS record.
- - This is the part of I(record) before I(zone_name). For example, if the record to be modified is C(www.example.com)
- for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
- prefix would be C('') (empty string).
- - Exactly one of I(record) and I(prefix) must be specified.
+ - This is the part of O(record_sets[].record) before O(zone_name). For example, if the record to be modified is C(www.example.com)
+ for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+ prefix would be V('') (empty string).
+ - Exactly one of O(record_sets[].record) and O(record_sets[].prefix) must be specified.
type: str
ttl:
description:
@@ -75,13 +75,13 @@ options:
- YAML lists or multiple comma-spaced values are allowed.
- When deleting a record all values for the record must be specified or it will
not be deleted.
- - Must be specified if I(ignore=false).
+ - Must be specified if O(record_sets[].ignore=false).
type: list
elements: str
ignore:
description:
- - If set to C(true), I(value) will be ignored.
- - This is useful when I(prune=true), but you do not want certain entries to be removed
+ - If set to V(true), O(record_sets[].value) will be ignored.
+ - This is useful when O(prune=true), but you do not want certain entries to be removed
without having to know their current value.
type: bool
default: false
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/module_zone_info.py b/ansible_collections/community/dns/plugins/doc_fragments/module_zone_info.py
index b218051e5..bcccfea73 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/module_zone_info.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/module_zone_info.py
@@ -16,13 +16,13 @@ options:
zone_name:
description:
- The DNS zone to query.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
type: str
aliases:
- zone
zone_id:
description:
- The ID of the DNS zone to query.
- - Exactly one of I(zone_name) and I(zone_id) must be specified.
+ - Exactly one of O(zone_name) and O(zone_id) must be specified.
version_added: 0.2.0
'''
diff --git a/ansible_collections/community/dns/plugins/doc_fragments/options.py b/ansible_collections/community/dns/plugins/doc_fragments/options.py
index a9e92e8b5..55c83f1b2 100644
--- a/ansible_collections/community/dns/plugins/doc_fragments/options.py
+++ b/ansible_collections/community/dns/plugins/doc_fragments/options.py
@@ -28,23 +28,23 @@ options:
description:
- Determines how TXT entry values are converted between the API and this module's
input and output.
- - The value C(api) means that values are returned from this module as they are returned
+ - The value V(api) means that values are returned from this module as they are returned
from the API, and pushed to the API as they have been passed to this module. For
idempotency checks, the input string will be compared to the strings returned by the
API. The API might automatically transform some values, like splitting long values or
adding quotes, which can cause problems with idempotency.
- - The value C(unquoted) automatically transforms values so that you can pass in unquoted
+ - The value V(unquoted) automatically transforms values so that you can pass in unquoted
values, and the module will return unquoted values. If you pass in quoted values, they
will be double-quoted.
- - The value C(quoted) automatically transforms values so that you must use quoting for values
+ - The value V(quoted) automatically transforms values so that you must use quoting for values
that contain spaces, characters such as quotation marks and backslashes, and that are
longer than 255 bytes. It also makes sure to return values from the API in a normalized
encoding.
- - The default value, C(unquoted), ensures that you can work with values without having
- to care about how to correctly quote for DNS. Most users should use one of C(unquoted)
- or C(quoted), but not C(api).
+ - The default value, V(unquoted), ensures that you can work with values without having
+ to care about how to correctly quote for DNS. Most users should use one of V(unquoted)
+ or V(quoted), but not V(api).
- B(Note:) the conversion code assumes UTF-8 encoding for values. If you need another
- encoding use I(txt_transformation=api) and handle the encoding yourself.
+ encoding use O(txt_transformation=api) and handle the encoding yourself.
type: str
choices:
- api
@@ -53,10 +53,10 @@ options:
default: unquoted
txt_character_encoding:
description:
- - Whether to treat numeric escape sequences (C(\xyz)) as octal or decimal numbers.
- This is only used when I(txt_transformation=quoted).
- - The current default is C(octal) which is deprecated. It will change to C(decimal) in
- community.dns 3.0.0. The value C(decimal) is compatible to L(RFC 1035, https://www.ietf.org/rfc/rfc1035.txt).
+ - Whether to treat numeric escape sequences (V(\\xyz)) as octal or decimal numbers.
+ This is only used when O(txt_transformation=quoted).
+ - The current default is V(octal) which is deprecated. It will change to V(decimal) in
+ community.dns 3.0.0. The value V(decimal) is compatible to L(RFC 1035, https://www.ietf.org/rfc/rfc1035.txt).
type: str
choices:
- decimal