New Pure Storage FlashArray module to manage array NTP settings (#47581)

lib/ansible/modules/storage/purestorage/purefa_ntp.py

@@ -0,0 +1,126 @@
+#!/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: '2.8'
+short_description: Configure Pure Storage FlashArray NTP settings
+description:
+- Set or erase NTP configuration for Pure Storage FlashArrays.
+author:
+- Simon Dodsley (@sdodsley)
+options:
+  state:
+    description:
+    - Create or delete NTP servers configuration
+    default: present
+    choices: [ absent, present ]
+  ntp_servers:
+    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.
+extends_documentation_fragment:
+- purestorage.fa
+'''
+
+EXAMPLES = r'''
+- name: Delete exisitng NTP server entries
+  purefa_ntp:
+    state: absent
+    fa_url: 10.10.10.2
+    api_token: e31060a7-21fc-e277-6240-25983c6c4592
+
+- name: Set array NTP servers
+  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.module_utils.pure import get_system, purefa_argument_spec
+
+
+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"""
+    changed = False
+    if array.get(ntpserver=True)['ntpserver'] != []:
+        try:
+            array.set(ntpserver=[])
+            changed = True
+        except:
+            module.fail_json(msg='Deletion of NTP servers failed')
+    module.exit_json(changed=changed)
+
+
+def create_ntp(module, array):
+    """Set NTP Servers"""
+    changed = False
+    if not module.params['ntp_servers']:
+        module.params['ntp_servers'] = ['0.pool.ntp.org']
+    try:
+        array.set(ntpserver=module.params['ntp_servers'][0:4])
+        changed = True
+    except:
+        module.fail_json(msg='Update of NTP servers failed')
+    module.exit_json(changed=changed)
+
+
+def main():
+    argument_spec = purefa_argument_spec()
+    argument_spec.update(dict(
+        ntp_servers=dict(type='list'),
+        state=dict(type='str', default='present', choices=['absent', 'present']),
+    ))
+
+    required_if = [['state', 'present', ['ntp_servers']]]
+
+    module = AnsibleModule(argument_spec,
+                           required_if=required_if,
+                           supports_check_mode=False)
+
+    array = get_system(module)
+
+    if module.params['state'] == 'absent':
+        delete_ntp(module, array)
+    else:
+        module.params['ntp_servers'] = remove(module.params['ntp_servers'])
+        if sorted(array.get(ntpserver=True)['ntpserver']) != sorted(module.params['ntp_servers'][0:4]):
+            create_ntp(module, array)
+
+    module.exit_json(changed=False)
+
+
+if __name__ == '__main__':
+    main()