| 1 |
#!/usr/bin/python |
| 2 |
|
| 3 |
# (c) 2018-2025, NetApp, Inc |
| 4 |
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) |
| 5 |
|
| 6 |
from __future__ import absolute_import, division, print_function |
| 7 |
__metaclass__ = type |
| 8 |
|
| 9 |
|
| 10 |
DOCUMENTATION = """ |
| 11 |
module: na_ontap_ntp |
| 12 |
short_description: NetApp ONTAP NTP server |
| 13 |
extends_documentation_fragment: |
| 14 |
- netapp.ontap.netapp.na_ontap |
| 15 |
version_added: 2.6.0 |
| 16 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 17 |
description: |
| 18 |
- Create or delete or modify NTP server in ONTAP |
| 19 |
options: |
| 20 |
state: |
| 21 |
description: |
| 22 |
- Whether the specified NTP server should exist or not. |
| 23 |
choices: ['present', 'absent'] |
| 24 |
type: str |
| 25 |
default: 'present' |
| 26 |
server_name: |
| 27 |
description: |
| 28 |
- The name of the NTP server to manage. |
| 29 |
required: True |
| 30 |
type: str |
| 31 |
version: |
| 32 |
description: |
| 33 |
- give version for NTP server |
| 34 |
choices: ['auto', '3', '4'] |
| 35 |
default: 'auto' |
| 36 |
type: str |
| 37 |
key_id: |
| 38 |
description: |
| 39 |
- The symmetric authentication key ID being used for this time server. |
| 40 |
type: int |
| 41 |
version_added: 21.21.0 |
| 42 |
""" |
| 43 |
|
| 44 |
EXAMPLES = """ |
| 45 |
- name: Create NTP server |
| 46 |
netapp.ontap.na_ontap_ntp: |
| 47 |
state: present |
| 48 |
version: auto |
| 49 |
key_id: 1 |
| 50 |
server_name: "{{ server_name }}" |
| 51 |
hostname: "{{ netapp_hostname }}" |
| 52 |
username: "{{ netapp_username }}" |
| 53 |
password: "{{ netapp_password }}" |
| 54 |
|
| 55 |
- name: Delete NTP server |
| 56 |
netapp.ontap.na_ontap_ntp: |
| 57 |
state: absent |
| 58 |
server_name: "{{ server_name }}" |
| 59 |
hostname: "{{ netapp_hostname }}" |
| 60 |
username: "{{ netapp_username }}" |
| 61 |
password: "{{ netapp_password }}" |
| 62 |
""" |
| 63 |
|
| 64 |
RETURN = """ |
| 65 |
""" |
| 66 |
import traceback |
| 67 |
|
| 68 |
from ansible.module_utils.basic import AnsibleModule |
| 69 |
from ansible.module_utils._text import to_native |
| 70 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 71 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 72 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI |
| 73 |
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic |
| 74 |
|
| 75 |
|
| 76 |
class NetAppOntapNTPServer: |
| 77 |
""" object initialize and class methods """ |
| 78 |
def __init__(self): |
| 79 |
self.argument_spec = netapp_utils.na_ontap_host_argument_spec() |
| 80 |
self.argument_spec.update(dict( |
| 81 |
state=dict(required=False, type='str', choices=['present', 'absent'], default='present'), |
| 82 |
server_name=dict(required=True, type='str'), |
| 83 |
version=dict(required=False, type='str', default='auto', |
| 84 |
choices=['auto', '3', '4']), |
| 85 |
key_id=dict(required=False, type='int'), |
| 86 |
)) |
| 87 |
|
| 88 |
self.module = AnsibleModule( |
| 89 |
argument_spec=self.argument_spec, |
| 90 |
supports_check_mode=True |
| 91 |
) |
| 92 |
self.na_helper = NetAppModule() |
| 93 |
self.parameters = self.na_helper.set_parameters(self.module.params) |
| 94 |
|
| 95 |
self.rest_api = OntapRestAPI(self.module) |
| 96 |
self.use_rest = self.rest_api.is_rest() |
| 97 |
if self.use_rest and not self.rest_api.meets_rest_minimum_version(self.use_rest, 9, 7): |
| 98 |
msg = 'REST requires ONTAP 9.7 or later for na_ontap_ntp' |
| 99 |
self.use_rest = self.na_helper.fall_back_to_zapi(self.module, msg, self.parameters) |
| 100 |
if not self.use_rest: |
| 101 |
if not netapp_utils.has_netapp_lib(): |
| 102 |
self.module.fail_json(msg="the python NetApp-Lib module is required") |
| 103 |
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module) |
| 104 |
|
| 105 |
def get_ntp_server(self): |
| 106 |
""" |
| 107 |
Return details about the ntp server |
| 108 |
:param: |
| 109 |
name : Name of the server_name |
| 110 |
:return: Details about the ntp server. None if not found. |
| 111 |
:rtype: dict |
| 112 |
""" |
| 113 |
if self.use_rest: |
| 114 |
return self.get_ntp_server_rest() |
| 115 |
ntp_iter = netapp_utils.zapi.NaElement('ntp-server-get-iter') |
| 116 |
ntp_info = netapp_utils.zapi.NaElement('ntp-server-info') |
| 117 |
ntp_info.add_new_child('server-name', self.parameters['server_name']) |
| 118 |
|
| 119 |
query = netapp_utils.zapi.NaElement('query') |
| 120 |
query.add_child_elem(ntp_info) |
| 121 |
|
| 122 |
ntp_iter.add_child_elem(query) |
| 123 |
result = self.server.invoke_successfully(ntp_iter, True) |
| 124 |
return_value = None |
| 125 |
|
| 126 |
if result.get_child_by_name('num-records') and \ |
| 127 |
int(result.get_child_content('num-records')) == 1: |
| 128 |
|
| 129 |
ntp_server_name = result.get_child_by_name('attributes-list').\ |
| 130 |
get_child_by_name('ntp-server-info').\ |
| 131 |
get_child_content('server-name') |
| 132 |
server_version = result.get_child_by_name('attributes-list').\ |
| 133 |
get_child_by_name('ntp-server-info').\ |
| 134 |
get_child_content('version') |
| 135 |
server_key_id = result.get_child_by_name('attributes-list').\ |
| 136 |
get_child_by_name('ntp-server-info').\ |
| 137 |
get_child_content('key-id') |
| 138 |
return_value = { |
| 139 |
'server-name': ntp_server_name, |
| 140 |
'version': server_version, |
| 141 |
'key_id': int(server_key_id) if server_key_id is not None else 0, |
| 142 |
} |
| 143 |
|
| 144 |
return return_value |
| 145 |
|
| 146 |
def get_ntp_server_rest(self): |
| 147 |
api = 'cluster/ntp/servers' |
| 148 |
options = {'server': self.parameters['server_name'], |
| 149 |
'fields': 'server,version,key.id'} |
| 150 |
record, error = rest_generic.get_one_record(self.rest_api, api, options) |
| 151 |
if error: |
| 152 |
self.module.fail_json(msg=error) |
| 153 |
if record: |
| 154 |
return { |
| 155 |
'server': self.na_helper.safe_get(record, ['server']), |
| 156 |
'version': self.na_helper.safe_get(record, ['version']), |
| 157 |
'key_id': self.na_helper.safe_get(record, ['key', 'id']), |
| 158 |
} |
| 159 |
return None |
| 160 |
|
| 161 |
def create_ntp_server(self): |
| 162 |
""" |
| 163 |
create ntp server. |
| 164 |
""" |
| 165 |
if self.use_rest: |
| 166 |
return self.create_ntp_server_rest() |
| 167 |
ntp_server_create = netapp_utils.zapi.NaElement.create_node_with_children( |
| 168 |
'ntp-server-create', **{'server-name': self.parameters['server_name'], |
| 169 |
'version': self.parameters['version'] |
| 170 |
}) |
| 171 |
if self.parameters.get('key_id'): |
| 172 |
ntp_server_create.add_new_child("key-id", str(self.parameters['key_id'])) |
| 173 |
|
| 174 |
try: |
| 175 |
self.server.invoke_successfully(ntp_server_create, |
| 176 |
enable_tunneling=True) |
| 177 |
except netapp_utils.zapi.NaApiError as error: |
| 178 |
self.module.fail_json(msg='Error creating ntp server %s: %s' |
| 179 |
% (self.parameters['server_name'], to_native(error)), |
| 180 |
exception=traceback.format_exc()) |
| 181 |
|
| 182 |
def create_ntp_server_rest(self): |
| 183 |
api = 'cluster/ntp/servers' |
| 184 |
params = { |
| 185 |
'server': self.parameters['server_name'], |
| 186 |
'version': self.parameters['version'] |
| 187 |
} |
| 188 |
if self.parameters.get('key_id'): |
| 189 |
params['key'] = {'id': self.parameters['key_id']} |
| 190 |
dummy, error = rest_generic.post_async(self.rest_api, api, params) |
| 191 |
if error: |
| 192 |
self.module.fail_json(msg=error) |
| 193 |
|
| 194 |
def delete_ntp_server(self): |
| 195 |
""" |
| 196 |
delete ntp server. |
| 197 |
""" |
| 198 |
if self.use_rest: |
| 199 |
return self.delete_ntp_server_rest() |
| 200 |
ntp_server_delete = netapp_utils.zapi.NaElement.create_node_with_children( |
| 201 |
'ntp-server-delete', **{'server-name': self.parameters['server_name']}) |
| 202 |
|
| 203 |
try: |
| 204 |
self.server.invoke_successfully(ntp_server_delete, |
| 205 |
enable_tunneling=True) |
| 206 |
except netapp_utils.zapi.NaApiError as error: |
| 207 |
self.module.fail_json(msg='Error deleting ntp server %s: %s' |
| 208 |
% (self.parameters['server_name'], to_native(error)), |
| 209 |
exception=traceback.format_exc()) |
| 210 |
|
| 211 |
def delete_ntp_server_rest(self): |
| 212 |
dummy, error = rest_generic.delete_async(self.rest_api, 'cluster/ntp/servers', self.parameters['server_name']) |
| 213 |
if error: |
| 214 |
self.module.fail_json(msg=error) |
| 215 |
|
| 216 |
def modify_ntp_server(self, modify): |
| 217 |
""" |
| 218 |
modify the ntp server |
| 219 |
""" |
| 220 |
if self.use_rest: |
| 221 |
return self.modify_ntp_server_rest(modify) |
| 222 |
ntp_modify = netapp_utils.zapi.NaElement.create_node_with_children( |
| 223 |
'ntp-server-modify', |
| 224 |
**{'server-name': self.parameters['server_name'], 'version': self.parameters['version']}) |
| 225 |
if modify.get('key_id'): |
| 226 |
ntp_modify.add_new_child("key-id", str(self.parameters['key_id'])) |
| 227 |
try: |
| 228 |
self.server.invoke_successfully(ntp_modify, |
| 229 |
enable_tunneling=True) |
| 230 |
except netapp_utils.zapi.NaApiError as error: |
| 231 |
self.module.fail_json(msg='Error modifying version for ntp server %s: %s' |
| 232 |
% (self.parameters['server_name'], to_native(error)), |
| 233 |
exception=traceback.format_exc()) |
| 234 |
|
| 235 |
def modify_ntp_server_rest(self, modify): |
| 236 |
body = {} |
| 237 |
if modify.get('version'): |
| 238 |
body['version'] = modify['version'] |
| 239 |
if modify.get('key_id'): |
| 240 |
body['key'] = {'id': modify['key_id']} |
| 241 |
if body: |
| 242 |
dummy, error = rest_generic.patch_async(self.rest_api, 'cluster/ntp/servers', self.parameters['server_name'], body) |
| 243 |
if error: |
| 244 |
self.module.fail_json(msg=error) |
| 245 |
|
| 246 |
def apply(self): |
| 247 |
"""Apply action to ntp-server""" |
| 248 |
|
| 249 |
modify = None |
| 250 |
current = self.get_ntp_server() |
| 251 |
cd_action = self.na_helper.get_cd_action(current, self.parameters) |
| 252 |
if cd_action is None and self.parameters['state'] == 'present': |
| 253 |
modify = self.na_helper.get_modified_attributes(current, self.parameters) |
| 254 |
if self.na_helper.changed and not self.module.check_mode: |
| 255 |
if cd_action == 'create': |
| 256 |
self.create_ntp_server() |
| 257 |
elif cd_action == 'delete': |
| 258 |
self.delete_ntp_server() |
| 259 |
elif modify: |
| 260 |
self.modify_ntp_server(modify) |
| 261 |
result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify) |
| 262 |
self.module.exit_json(**result) |
| 263 |
|
| 264 |
|
| 265 |
def main(): |
| 266 |
""" Create object and call apply """ |
| 267 |
ntp_obj = NetAppOntapNTPServer() |
| 268 |
ntp_obj.apply() |
| 269 |
|
| 270 |
|
| 271 |
if __name__ == '__main__': |
| 272 |
main() |