summaryrefslogtreecommitdiffstats
path: root/ansible_collections/kaytus/ksmanage/plugins/modules/edit_ntp.py
blob: 5ca241f0d814af77850992c66023b5402773972d (plain)
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
#!/usr/bin/python
# -*- coding:utf-8 -*-

# Copyright(C) 2023 Kaytus Inc. All Rights Reserved.
# 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

DOCUMENTATION = '''
---
module: edit_ntp
version_added: "1.0.0"
author:
    - WangBaoshan (@ieisystem)
short_description: Set NTP
description:
   - Set NTP on kaytus Server.
notes:
   - Does not support C(check_mode).
options:
    auto_date:
        description:
            - Date auto synchronize.
        choices: ['enable', 'disable']
        type: str
    ntp_time:
        description:
            - NTP time(YYYYmmddHHMMSS).
            - Only the M5 model supports this parameter.
        type: str
    time_zone:
        description:
            - UTC time zone, chose from {-12, -11.5, -11, ... , 11, 11.5, 12}.
        type: str
    server1:
        description:
            - NTP Server1(ipv4 or ipv6 or domain name), set when auto_date is enable.
        type: str
    server2:
        description:
            - NTP Server2(ipv4 or ipv6 or domain name), set when auto_date is enable.
        type: str
    server3:
        description:
            - NTP Server3(ipv4 or ipv6 or domain name), set when auto_date is enable.
        type: str
    server4:
        description:
            - NTP Server4(ipv4 or ipv6 or domain name), set when auto_date is enable.
        type: str
    server5:
        description:
            - NTP Server5(ipv4 or ipv6 or domain name), set when auto_date is enable.
        type: str
    server6:
        description:
            - NTP Server6(ipv4 or ipv6 or domain name), set when auto_date is enable.
        type: str
    syn_cycle:
        description:
            - NTP syn cycle(minute), sync cycle(5-1440).
        type: int
    max_variety:
        description:
            - NTP Maximum jump time(minute), max variety(1-60).
            - Only the M6 model supports this parameter.
        type: int
extends_documentation_fragment:
    - kaytus.ksmanage.ksmanage
'''

EXAMPLES = '''
- name: NTP test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set ntp"
    kaytus.ksmanage.edit_ntp:
      auto_date: "enable"
      server2: "time.nist.gov"
      provider: "{{ ksmanage }}"

  - name: "Set ntp"
    kaytus.ksmanage.edit_ntp:
      auto_date: "disable"
      ntp_time: "20200609083600"
      provider: "{{ ksmanage }}"

  - name: "set ntp"
    kaytus.ksmanage.edit_ntp:
      time_zone: "8"
      provider: "{{ ksmanage }}"
'''

RETURN = '''
message:
    description: Messages returned after module execution.
    returned: always
    type: str
state:
    description: Status after module execution.
    returned: always
    type: str
changed:
    description: Check to see if a change was made on the device.
    returned: always
    type: bool
'''

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.kaytus.ksmanage.plugins.module_utils.ksmanage import (ksmanage_argument_spec, get_connection)


class NTP(object):
    def __init__(self, argument_spec):
        self.spec = argument_spec
        self.module = None
        self.init_module()
        self.results = dict()

    def init_module(self):
        """Init module object"""

        self.module = AnsibleModule(
            argument_spec=self.spec, supports_check_mode=False)

    def run_command(self):
        self.module.params['subcommand'] = 'settime'
        self.results = get_connection(self.module)
        if self.results['State'] == 'Success':
            self.results['changed'] = True

    def show_result(self):
        """Show result"""
        self.module.exit_json(**self.results)

    def work(self):
        """Worker"""
        self.run_command()
        self.show_result()


def main():
    argument_spec = dict(
        auto_date=dict(type='str', required=False, choices=['enable', 'disable']),
        ntp_time=dict(type='str', required=False),
        time_zone=dict(type='str', required=False),
        server1=dict(type='str', required=False),
        server2=dict(type='str', required=False),
        server3=dict(type='str', required=False),
        server4=dict(type='str', required=False),
        server5=dict(type='str', required=False),
        server6=dict(type='str', required=False),
        syn_cycle=dict(type='int', required=False),
        max_variety=dict(type='int', required=False),
    )
    argument_spec.update(ksmanage_argument_spec)
    ntp_obj = NTP(argument_spec)
    ntp_obj.work()


if __name__ == '__main__':
    main()