1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
# -*- coding: utf-8 -*-
#
# Copyright (c) 2017-2020 Felix Fontein
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = r'''
requirements:
- lxml
options:
hosttech_username:
description:
- The username for the Hosttech API user.
- 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, 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 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
version_added: 0.2.0
'''
# NOTE: This document fragment augments the above standard DOCUMENTATION document fragment
# by providing alternative ways to provide configuration for plugins. (The above
# documentation fragment is tailored for modules.)
PLUGIN = r'''
options:
hosttech_username:
env:
- name: ANSIBLE_HOSTTECH_API_USERNAME
version_added: 2.5.0
hosttech_password:
env:
- name: ANSIBLE_HOSTTECH_API_PASSWORD
version_added: 2.5.0
hosttech_token:
env:
- name: ANSIBLE_HOSTTECH_DNS_TOKEN
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!
RECORD_DEFAULT_TTL = r'''
options:
ttl:
default: 3600
'''
# WARNING: This section is automatically generated by update-docs-fragments.py.
# It is used to augment the docs fragments module_record, module_record_info,
# module_record_set, module_record_set_info.
# DO NOT EDIT MANUALLY!
RECORD_TYPE_CHOICES = r'''
options:
type:
choices:
- A
- AAAA
- CAA
- CNAME
- MX
- NS
- PTR
- SPF
- SRV
- TXT
'''
# WARNING: This section is automatically generated by update-docs-fragments.py.
# It is used to augment the docs fragment module_record_sets.
# DO NOT EDIT MANUALLY!
RECORD_TYPE_CHOICES_RECORD_SETS_MODULE = r'''
options:
record_sets:
suboptions:
record:
description:
- The full DNS record to create or delete.
- 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 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:
- The TTL to give the new record, in seconds.
type: int
default: 3600
type:
description:
- The type of DNS record to create or delete.
required: true
type: str
choices:
- A
- AAAA
- CAA
- CNAME
- MX
- NS
- PTR
- SPF
- SRV
- TXT
value:
description:
- The new value when creating a DNS record.
- 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 O(record_sets[].ignore=false).
type: list
elements: str
ignore:
description:
- 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
'''
# WARNING: This section is automatically generated by update-docs-fragments.py.
# It is used to augment the docs fragment inventory_records.
# DO NOT EDIT MANUALLY!
RECORD_TYPE_CHOICES_RECORDS_INVENTORY = r'''
options:
simple_filters:
suboptions:
type:
description:
- Record types whose values to use.
type: list
elements: string
default:
- A
- AAAA
- CNAME
choices:
- A
- AAAA
- CAA
- CNAME
- MX
- NS
- PTR
- SPF
- SRV
- TXT
'''
# WARNING: This section is automatically generated by update-docs-fragments.py.
# It is used to augment the docs fragments inventory_records, module_record,
# module_record_info, module_record_set, module_record_set_info,
# module_record_sets, module_zone_info.
# DO NOT EDIT MANUALLY!
ZONE_ID_TYPE = r'''
options:
zone_id:
type: int
'''
|
