summaryrefslogtreecommitdiffstats
path: root/ansible_collections/inspur/ispim/plugins/modules/edit_smtp_com.py
blob: 4965ec6c5b902d5526bdb3514e20d37904377b18 (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
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
#!/usr/bin/python
# -*- coding:utf-8 -*-

# Copyright (C) 2020 Inspur 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_smtp_com
version_added: "1.0.0"
author:
    - WangBaoshan (@ispim)
short_description: Set SMTP information
description:
   - Set SMTP com information on Inspur server.
   - Only the M6 models support this feature.
notes:
   - Does not support C(check_mode).
options:
    status:
        description:
            - SMTP Support.
        choices: ['enable', 'disable']
        required: true
        type: str
    server_ip:
        description:
            - SMTP server IP.
        type: str
    server_port:
        description:
            - SMTP server port,The Identification for retry count configuration(1-65535).
        type: int
    server_secure_port:
        description:
            - SMTP server sesure port,The Identification for retry count configuration(1-65535).
        type: int
    email:
        description:
            - Sender email.
        type: str
    server_auth:
        description:
            - SMTP server authentication.
        choices: ['enable', 'disable']
        type: str
    server_username:
        description:
            - SMTP server Username,lenth be 4 to 64 bits,
            - must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\\'(backslash).
            - Required when I(server_auth=enable).
        type: str
    server_password:
        description:
            - SMTP server Password,lenth be 4 to 64 bits,cannot contain ' '(space).
            - Required when I(server_auth=enable).
        type: str
    ssl_tls_enable:
        description:
            - SMTP SSLTLS Enable.
            - I(ssl_tls_enable=disable), when I(star_tls_enable=enable).
        choices: ['enable', 'disable']
        type: str
    star_tls_enable:
        description:
            - SMTP STARTTLS Enable.
            - I(star_tls_enable=disable), when I(ssl_tls_enable=enable).
        choices: ['enable', 'disable']
        type: str
    subject:
        description:
            - Email theme.
        type: str
    host_name:
        description:
            - Server name.
        choices: ['enable', 'disable']
        type: str
    serial_number:
        description:
            - Serial number.
        choices: ['enable', 'disable']
        type: str
    asset_tag:
        description:
            - product asset label,
        choices: ['enable', 'disable']
        type: str
    event_level:
        description:
            - Events above this level will be sent.
        choices: ['Info', 'Warning', 'Critical']
        type: str
extends_documentation_fragment:
    - inspur.ispim.ism
'''

EXAMPLES = '''
- name: Smtp com test
  hosts: ism
  no_log: true
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set smtp com information"
    inspur.ispim.edit_smtp_com:
      status: "disable"
      provider: "{{ ism }}"

  - name: "Set smtp com information"
    inspur.ispim.edit_smtp_com:
      status: "enable"
      server_ip: "100.2.2.2"
      email: "inspur@Inspur.com"
      server_auth: "enable"
      server_username: "admin"
      server_password: "1234qwer!@#$"
      provider: "{{ ism }}"
'''

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.inspur.ispim.plugins.module_utils.ism import (ism_argument_spec, get_connection)


class SMTP(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'] = 'setsmtpcom'
        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(
        status=dict(type='str', required=True, choices=['enable', 'disable']),
        server_ip=dict(type='str', required=False),
        server_port=dict(type='int', required=False),
        server_secure_port=dict(type='int', required=False),
        email=dict(type='str', required=False),
        server_auth=dict(type='str', required=False, choices=['enable', 'disable']),
        server_username=dict(type='str', required=False),
        server_password=dict(type='str', required=False, no_log=True),
        ssl_tls_enable=dict(type='str', required=False, choices=['enable', 'disable']),
        star_tls_enable=dict(type='str', required=False, choices=['enable', 'disable']),
        subject=dict(type='str', required=False),
        host_name=dict(type='str', required=False, choices=['enable', 'disable']),
        serial_number=dict(type='str', required=False, choices=['enable', 'disable']),
        asset_tag=dict(type='str', required=False, choices=['enable', 'disable']),
        event_level=dict(type='str', required=False, choices=['Info', 'Warning', 'Critical']),
    )
    argument_spec.update(ism_argument_spec)
    smtp_obj = SMTP(argument_spec)
    smtp_obj.work()


if __name__ == '__main__':
    main()