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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
#!/usr/bin/python
from __future__ import absolute_import, division, print_function
# Copyright 2019-2024 Fortinet, Inc.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
__metaclass__ = type
ANSIBLE_METADATA = {'status': ['preview'],
'supported_by': 'community',
'metadata_version': '1.1'}
DOCUMENTATION = '''
---
module: fmgr_system_mail
short_description: Alert emails.
description:
- This module is able to configure a FortiManager device.
- Examples include all parameters and values which need to be adjusted to data sources before usage.
version_added: "2.0.0"
author:
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
notes:
- Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case).
Please change the arguments such as "var-name" to "var_name".
Old argument names are still available yet you will receive deprecation warnings.
You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
- Running in workspace locking mode is supported in this FortiManager module, the top
level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state present directive.
- To delete an object, use state absent directive.
- Normally, running one module can fail when a non-zero rc is returned. you can also override
the conditions to fail or succeed with parameters rc_failed and rc_succeeded
options:
access_token:
description: The token to access FortiManager without using username and password.
type: str
bypass_validation:
description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.
type: bool
default: false
enable_log:
description: Enable/Disable logging for task.
type: bool
default: false
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
proposed_method:
description: The overridden method for the underlying Json RPC request.
type: str
choices:
- update
- set
- add
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
type: list
elements: int
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
type: list
elements: int
state:
description: The directive to create, update or delete an object.
type: str
required: true
choices:
- present
- absent
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
type: str
workspace_locking_timeout:
description: The maximum time in seconds to wait for other user to release the workspace lock.
type: int
default: 300
system_mail:
description: The top level parameters set.
required: false
type: dict
suboptions:
auth:
type: str
description:
- Enable authentication.
- disable - Disable authentication.
- enable - Enable authentication.
choices:
- 'disable'
- 'enable'
id:
type: str
description: Mail Service ID.
required: true
passwd:
type: raw
description: (list) SMTP account password.
port:
type: int
description: SMTP server port.
secure-option:
type: str
description:
- Deprecated, please rename it to secure_option.
- Communication secure option.
- default - Try STARTTLS, proceed as plain text communication otherwise.
- none - Communication will be in plain text format.
- smtps - Communication will be protected by SMTPS.
- starttls - Communication will be protected by STARTTLS.
choices:
- 'default'
- 'none'
- 'smtps'
- 'starttls'
server:
type: str
description: SMTP server.
user:
type: str
description: SMTP account username.
auth-type:
type: str
description:
- Deprecated, please rename it to auth_type.
- SMTP authentication type.
- psk - Use username and password to authenticate.
- certificate - Use local certificate to authenticate.
choices:
- 'psk'
- 'certificate'
local-cert:
type: str
description: Deprecated, please rename it to local_cert. SMTP local certificate.
from:
type: str
description: Username for MAIL FROM.
'''
EXAMPLES = '''
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Alert emails.
fortinet.fortimanager.fmgr_system_mail:
bypass_validation: false
state: present
system_mail:
auth: enable
id: 1
passwd: fortinet
port: 1
secure-option: none # <value in [default, none, smtps, ...]>
server: ALL
user: ansible
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the alert emails
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_mail"
params:
mail: "your_value"
'''
RETURN = '''
meta:
description: The result of the request.
type: dict
returned: always
contains:
request_url:
description: The full url requested.
returned: always
type: str
sample: /sys/login/user
response_code:
description: The status of api request.
returned: always
type: int
sample: 0
response_data:
description: The api response.
type: list
returned: always
response_message:
description: The descriptive message of the api response.
type: str
returned: always
sample: OK.
system_information:
description: The information of the target system.
type: dict
returned: always
rc:
description: The status the request.
type: int
returned: always
sample: 0
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by the current FortiManager version.
type: list
returned: complex
'''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import NAPIManager
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import check_galaxy_version
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import check_parameter_bypass
from ansible_collections.fortinet.fortimanager.plugins.module_utils.common import get_module_arg_spec
def main():
jrpc_urls = [
'/cli/global/system/mail'
]
perobject_jrpc_urls = [
'/cli/global/system/mail/{mail}'
]
url_params = []
module_primary_key = 'id'
module_arg_spec = {
'system_mail': {
'type': 'dict',
'v_range': [['6.0.0', '']],
'options': {
'auth': {'choices': ['disable', 'enable'], 'type': 'str'},
'id': {'required': True, 'type': 'str'},
'passwd': {'no_log': True, 'type': 'raw'},
'port': {'type': 'int'},
'secure-option': {'choices': ['default', 'none', 'smtps', 'starttls'], 'type': 'str'},
'server': {'type': 'str'},
'user': {'type': 'str'},
'auth-type': {'v_range': [['6.4.6', '']], 'choices': ['psk', 'certificate'], 'type': 'str'},
'local-cert': {'v_range': [['6.4.6', '']], 'type': 'str'},
'from': {'v_range': [['7.0.7', '7.0.12'], ['7.2.2', '']], 'type': 'str'}
}
}
}
module_option_spec = get_module_arg_spec('full crud')
module_arg_spec.update(module_option_spec)
params_validation_blob = []
check_galaxy_version(module_arg_spec)
module = AnsibleModule(argument_spec=check_parameter_bypass(module_arg_spec, 'system_mail'),
supports_check_mode=False)
if not module._socket_path:
module.fail_json(msg='MUST RUN IN HTTPAPI MODE')
connection = Connection(module._socket_path)
connection.set_option('access_token', module.params.get('access_token', None))
connection.set_option('enable_log', module.params.get('enable_log', False))
connection.set_option('forticloud_access_token', module.params.get('forticloud_access_token', None))
fmgr = NAPIManager(jrpc_urls, perobject_jrpc_urls, module_primary_key, url_params, module, connection, top_level_schema_name='data')
fmgr.validate_parameters(params_validation_blob)
fmgr.process_curd(argument_specs=module_arg_spec)
module.exit_json(meta=module.params)
if __name__ == '__main__':
main()
|
