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
|
#!/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_syslog
version_added: '1.0.0'
short_description: Configure Pure Storage FlashArray syslog settings
description:
- Configure syslog configuration for Pure Storage FlashArrays.
- Manage individual syslog servers.
author:
- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
options:
state:
description:
- Create, update or delete syslog servers configuration
default: present
type: str
choices: [ absent, present ]
protocol:
description:
- Protocol which server uses
required: true
type: str
choices: [ tcp, tls, udp ]
port:
description:
- Port at which the server is listening. If no port is specified
the system will use 514
type: str
address:
description:
- Syslog server address.
This field supports IPv4, IPv6 or FQDN.
An invalid IP addresses will cause the module to fail.
No validation is performed for FQDNs.
type: str
required: true
name:
description:
- A user-specified name.
The name must be locally unique and cannot be changed.
type: str
required: true
extends_documentation_fragment:
- purestorage.flasharray.purestorage.fa
"""
EXAMPLES = r"""
- name: Delete existing syslog server entry
purestorage.flasharray.purefa_syslog:
address: syslog1.com
protocol: tcp
state: absent
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Add syslog server entry
purestorage.flasharray.purefa_syslog:
state: present
address: syslog1.com
port: 8081
protocol: udp
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Update syslog server entry
purestorage.flasharray.purefa_syslog:
state: present
address: syslog1.com
port: 8081
protocol: tcp
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
"""
RETURN = r"""
"""
HAS_PURESTORAGE = True
try:
from pypureclient.flasharray import SyslogServer
except ImportError:
HAS_PURESTORAGE = False
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.purestorage.flasharray.plugins.module_utils.purefa import (
get_array,
purefa_argument_spec,
)
def delete_syslog(module, array):
"""Delete Syslog Server"""
changed = True
if not module.check_mode:
res = array.delete_syslog_servers(names=[module.params["name"]])
if res.status_code != 200:
module.fail_json(
msg="Failed to remove syslog server {0}. Error: {1}".format(
module.params["name"], res.errors[0].message
)
)
module.exit_json(changed=changed)
def add_syslog(module, array):
"""Add Syslog Server"""
changed = True
noport_address = module.params["protocol"] + "://" + module.params["address"]
if module.params["port"]:
full_address = noport_address + ":" + module.params["port"]
else:
full_address = noport_address
if not module.check_mode:
res = array.post_syslog_servers(
names=[module.params["name"]],
syslog_server=SyslogServer(name=module.params["name"], uri=full_address),
)
if res.status_code != 200:
module.fail_json(
msg="Adding syslog server {0} failed. Error: {1}".format(
module.params["name"], res.errors[0].message
)
)
module.exit_json(changed=changed)
def update_syslog(module, array):
"""Update Syslog Server"""
changed = False
syslog_config = list(array.get_syslog_servers(names=[module.params["name"]]).items)[
0
]
noport_address = module.params["protocol"] + "://" + module.params["address"]
if module.params["port"]:
full_address = noport_address + ":" + module.params["port"]
else:
full_address = noport_address
if full_address != syslog_config.uri:
changed = True
res = array.patch_syslog_servers(
names=[module.params["name"]],
syslog_server=SyslogServer(uri=full_address),
)
if res.status_code != 200:
module.fail_json(
msg="Updating syslog server {0} failed. Error: {1}".format(
module.params["name"], res.errors[0].message
)
)
module.exit_json(changed=changed)
def main():
argument_spec = purefa_argument_spec()
argument_spec.update(
dict(
address=dict(type="str", required=True),
protocol=dict(type="str", choices=["tcp", "tls", "udp"], required=True),
port=dict(type="str"),
name=dict(type="str", required=True),
state=dict(type="str", default="present", choices=["absent", "present"]),
)
)
module = AnsibleModule(argument_spec, supports_check_mode=True)
array = get_array(module)
if not HAS_PURESTORAGE:
module.fail_json(msg="py-pure-client sdk is required for this module")
res = array.get_syslog_servers(names=[module.params["name"]])
if res.status_code == 200:
exists = True
else:
exists = False
if module.params["state"] == "absent" and exists:
delete_syslog(module, array)
elif module.params["state"] == "present" and not exists:
add_syslog(module, array)
elif module.params["state"] == "present" and exists:
update_syslog(module, array)
module.exit_json(changed=False)
if __name__ == "__main__":
main()
|
