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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# (c) 2018, Simon Dodsley (simon@purestorage.com)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {
"metadata_version": "1.1",
"status": ["preview"],
"supported_by": "community",
}
DOCUMENTATION = r"""
---
module: purefa_ntp
version_added: '1.0.0'
short_description: Configure Pure Storage FlashArray NTP settings
description:
- Set or erase NTP configuration for Pure Storage FlashArrays.
author:
- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
options:
state:
description:
- Create or delete NTP servers configuration
type: str
default: present
choices: [ absent, present ]
ntp_servers:
type: list
elements: str
description:
- A list of up to 4 alternate NTP servers. These may include IPv4,
IPv6 or FQDNs. Invalid IP addresses will cause the module to fail.
No validation is performed for FQDNs.
- If more than 4 servers are provided, only the first 4 unique
nameservers will be used.
- if no servers are given a default of I(0.pool.ntp.org) will be used.
ntp_key:
type: str
description:
- The NTP symmetric key to be used for NTP authentication.
- If it is an ASCII string, it cannot contain the character "#"
and cannot be longer than 20 characters.
- If it is a hex-encoded string, it cannot be longer than 64 characters.
- Setting this parameter is not idempotent.
version_added: "1.22.0"
extends_documentation_fragment:
- purestorage.flasharray.purestorage.fa
"""
EXAMPLES = r"""
- name: Delete exisitng NTP server entries
purestorage.flasharray.purefa_ntp:
state: absent
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Set array NTP servers
purestorage.flasharray.purefa_ntp:
state: present
ntp_servers:
- "0.pool.ntp.org"
- "1.pool.ntp.org"
- "2.pool.ntp.org"
- "3.pool.ntp.org"
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
"""
RETURN = r"""
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.purestorage.flasharray.plugins.module_utils.purefa import (
get_array,
purefa_argument_spec,
)
from ansible_collections.purestorage.flasharray.plugins.module_utils.version import (
LooseVersion,
)
HAS_PURESTORAGE = True
try:
from pypureclient.flasharray import Arrays
except ImportError:
HAS_PURESTORAGE = False
KEY_API_VERSION = "2.26"
def _is_cbs(array, is_cbs=False):
"""Is the selected array a Cloud Block Store"""
model = list(array.get_controllers().items)[0].model
is_cbs = bool("CBS" in model)
return is_cbs
def remove(duplicate):
final_list = []
for num in duplicate:
if num not in final_list:
final_list.append(num)
return final_list
def delete_ntp(module, array):
"""Delete NTP Servers"""
if array.get(ntpserver=True)["ntpserver"] != []:
changed = True
if not module.check_mode:
try:
array.patch_arrays(array=Arrays(ntp_servers=[]))
except Exception:
module.fail_json(msg="Deletion of NTP servers failed")
else:
changed = False
module.exit_json(changed=changed)
def create_ntp(module, array):
"""Set NTP Servers"""
changed = True
if not module.check_mode:
if not module.params["ntp_servers"]:
module.params["ntp_servers"] = ["0.pool.ntp.org"]
try:
array.patch_arrays(
array=Arrays(ntp_servers=module.params["ntp_servers"][0:4])
)
except Exception:
module.fail_json(msg="Update of NTP servers failed")
module.exit_json(changed=changed)
def update_ntp_key(module, array):
"""Update NTP Symmetric Key"""
if module.params["ntp_key"] == "" and not getattr(
list(array.get_arrays().items)[0], "ntp_symmetric_key", None
):
changed = False
else:
try:
int(module.params["ntp_key"], 16)
if len(module.params["ntp_key"]) > 64:
module.fail_json(msg="HEX string cannot be longer than 64 characters")
except ValueError:
if len(module.params["ntp_key"]) > 20:
module.fail_json(msg="ASCII string cannot be longer than 20 characters")
if "#" in module.params["ntp_key"]:
module.fail_json(msg="ASCII string cannot contain # character")
if not all(ord(c) < 128 for c in module.params["ntp_key"]):
module.fail_json(msg="NTP key is non-ASCII")
changed = True
res = array.patch_arrays(
array=Arrays(ntp_symmetric_key=module.params["ntp_key"])
)
if res.status_code != 200:
module.fail_json(
msg="Failed to update NTP Symmetric Key. Error: {0}".format(
res.errors[0].message
)
)
module.exit_json(changed=changed)
if len(module.params["ntp_key"]) > 20:
# Must be HEX string is greter than 20 characters
try:
int(module.params["ntp_key"], 16)
except ValueError:
module.fail_json(msg="NTP key is not HEX")
def main():
argument_spec = purefa_argument_spec()
argument_spec.update(
dict(
ntp_servers=dict(type="list", elements="str"),
ntp_key=dict(type="str", no_log=True),
state=dict(type="str", default="present", choices=["absent", "present"]),
)
)
module = AnsibleModule(argument_spec, supports_check_mode=True)
if not HAS_PURESTORAGE:
module.fail_json(msg="py-pure-client sdk is required for this module")
array = get_array(module)
api_version = array.get_rest_version()
if _is_cbs(array):
module.warn("NTP settings are not necessary for a CBS array - ignoring...")
module.exit_json(changed=False)
if module.params["state"] == "absent":
delete_ntp(module, array)
elif module.params["ntp_servers"]:
module.params["ntp_servers"] = remove(module.params["ntp_servers"])
if sorted(list(array.get_arrays().items)[0].ntp_servers) != sorted(
module.params["ntp_servers"][0:4]
):
create_ntp(module, array)
if module.params["ntp_key"] or module.params["ntp_key"] == "":
if LooseVersion(KEY_API_VERSION) > LooseVersion(api_version):
module.fail_json(msg="REST API does not support setting NTP Symmetric Key")
else:
update_ntp_key(module, array)
module.exit_json(changed=False)
if __name__ == "__main__":
main()
|
