-
Notifications
You must be signed in to change notification settings - Fork 18
/
sysrc
283 lines (240 loc) · 7.6 KB
/
sysrc
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
# -*- coding: utf-8 -*-
#
# (c) 2014, David Lundgren <dlundgren@syberisle.net>
#
# This file is part of Ansible
#
# This module is free software: you can redistribute it and/or modify
# it under the terms of the MIT license.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# MIT License for more details.
#
# You should have received a copy of the MIT.
# If not, see <http://opensource.org/licenses/MIT>.
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'
}
DOCUMENTATION = r'''
---
author:
- David Lundgren (@dlundgren)
module: sysrc
short_description: Manage FreeBSD using sysrc
version_added: '2.10'
description:
- Manages /etc/rc.conf for FreeBSD
options:
name:
description:
- Name of variable in $dest to manage.
type: str
required: true
value:
description:
- The value if "present"
type: str
state:
description:
- Whether the var should be present or absent in $dest.
- append/subtract will add or remove the value from a list.
type: str
default: "present"
choices: [ present, absent, append, subtract ]
dest:
description:
- What file should be operated on
type: str
default: "/etc/rc.conf"
delim:
description:
- Delimiter used in append/subtract mode
default: " "
type: str
jail:
description:
- Name or ID of the jail to operate on
required: false
type: str
notes:
- The C(name) cannot use . (periods) as sysrc doesn't support OID style names
'''
EXAMPLES = r'''
---
# enable mysql in the /etc/rc.conf
- name: Configure mysql pid file
sysrc:
name: mysql_pidfile
value: "/var/run/mysqld/mysqld.pid"
# enable accf_http kld in the boot loader
- name: enable accf_http kld
sysrc:
name: accf_http_load
state: present
value: "YES"
dest: /boot/loader.conf
# add gif0 to cloned_interfaces
- name: add gif0 interface
sysrc:
name: cloned_interfaces
state: append
value: "gif0"
# enable nginx on a jail
- name: add gif0 interface
sysrc:
name: nginx_enable
value: "YES"
jail: www
'''
RETURN = r'''
changed:
description: Return changed for sysrc actions as true or false.
returned: always
type: bool
'''
from ansible.module_utils.basic import AnsibleModule
import re
class sysrc(object):
def __init__(self, module, name, value, dest, delim, jail):
self.module = module
self.name = name
self.changed = False
self.value = value
self.dest = dest
self.delim = delim
self.jail = jail
self.sysrc = module.get_bin_path('sysrc', True)
def has_unknown_variable(self, out, err):
# newer versions of sysrc use stderr instead of stdout
return err.find("unknown variable") > 0 or out.find("unknown variable") > 0
def exists(self):
# sysrc doesn't really use exit codes
(rc, out, err) = self.run_sysrc(self.name)
if self.value is None:
regex = "%s: " % re.escape(self.name)
else:
regex = "%s: %s$" % (re.escape(self.name), re.escape(self.value))
return not self.has_unknown_variable(out, err) and re.match(regex, out) is not None
def contains(self):
(rc, out, err) = self.run_sysrc('-n', self.name)
if self.has_unknown_variable(out, err):
return False
return self.value in out.strip().split(self.delim)
def create(self):
if self.module.check_mode:
self.changed = True
return
self.module._verbosity = 5
(rc, out, err) = self.run_sysrc("%s=%s" % (self.name, self.value))
if out.find("%s:" % self.name) == 0 and re.search("-> %s$" % re.escape(self.value), out) is not None:
self.changed = True
return True
else:
return False
def destroy(self):
if self.module.check_mode:
self.changed = True
return
(rc, out, err) = self.run_sysrc('-x', self.name)
if self.has_unknown_variable(out, err):
return False
self.changed = True
return True
def append(self):
if self.module.check_mode:
self.changed = True
return
setstring = '%s+=%s%s' % (self.name, self.delim, self.value)
(rc, out, err) = self.run_sysrc(setstring)
if out.find("%s:" % self.name) == 0:
values = out.split(' -> ')[1].strip().split(self.delim)
if self.value in values:
self.changed = True
return True
else:
return False
else:
return False
def subtract(self):
if self.module.check_mode:
self.changed = True
return
setstring = '%s-=%s%s' % (self.name, self.delim, self.value)
(rc, out, err) = self.run_sysrc(setstring)
if out.find("%s:" % self.name) == 0:
values = out.split(' -> ')[1].strip().split(self.delim)
if self.value in values:
return False
else:
self.changed = True
return True
else:
return False
def run_sysrc(self, *args):
cmd = [self.sysrc, '-f', self.dest]
if self.jail:
cmd += ['-j', self.jail]
cmd.extend(args)
(rc, out, err) = self.module.run_command(cmd)
if self.module._verbosity > 0:
self.cmd = cmd
if self.module._verbosity >= 4:
self.cmd_output = out
return (rc, out, err)
def main():
module = AnsibleModule(
argument_spec=dict(
name=dict(type='str', required=True),
value=dict(type='str', default=None),
state=dict(type='str', default='present', choices=['present', 'absent', 'append', 'subtract']),
dest=dict(type='str', default='/etc/rc.conf'),
delim=dict(type='str', default=' '),
jail=dict(type='str', default=None),
),
supports_check_mode=True,
)
name = module.params.pop('name')
# OID style names are not supported
if not re.match('^[a-zA-Z0-9_]+$', name):
module.fail_json(
msg="Name may only contain alpha-numeric and underscore characters"
)
value = module.params.pop('value')
state = module.params.pop('state')
dest = module.params.pop('dest')
delim = module.params.pop('delim')
jail = module.params.pop('jail')
result = dict(
name=name,
state=state,
value=value,
dest=dest,
delim=delim,
jail=jail
)
rcValue = sysrc(module, name, value, dest, delim, jail)
if module._verbosity >= 4:
result['existed'] = rcValue.exists()
if state == 'present':
not rcValue.exists() and rcValue.create()
elif state == 'absent':
rcValue.exists() and rcValue.destroy()
elif state == 'append':
not rcValue.contains() and rcValue.append()
elif state == 'subtract':
rcValue.contains() and rcValue.subtract()
if module._verbosity > 0:
result['command'] = ' '.join(rcValue.cmd)
if module._verbosity >= 4:
result['output'] = rcValue.cmd_output
result['changed'] = rcValue.changed
module.exit_json(**result)
if __name__ == '__main__':
main()