mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1701 lines
64 KiB
Python
1701 lines
64 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2012, Michael DeHaan <michael.dehaan@gmail.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
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: service
|
|
version_added: "0.1"
|
|
short_description: Manage services
|
|
description:
|
|
- Controls services on remote hosts. Supported init systems include BSD init,
|
|
OpenRC, SysV, Solaris SMF, systemd, upstart.
|
|
- This module acts as a proxy to the underlying service manager module. While all arguments will be passed to the
|
|
underlying module, not all modules support the same arguments. This documentation only covers the minimum intersection
|
|
of module arguments that all service manager modules support.
|
|
- This module is a proxy for multiple more specific service manager modules
|
|
(such as M(ansible.builtin.systemd) and M(ansible.builtin.sysvinit)).
|
|
This allows management of a heterogeneous environment of machines without creating a specific task for
|
|
each service manager. The module to be executed is determined by the I(use) option, which defaults to the
|
|
service manager discovered by M(ansible.builtin.setup). If C(setup) was not yet run, this module may run it.
|
|
- For Windows targets, use the M(ansible.windows.win_service) module instead.
|
|
options:
|
|
name:
|
|
description:
|
|
- Name of the service.
|
|
type: str
|
|
required: true
|
|
state:
|
|
description:
|
|
- C(started)/C(stopped) are idempotent actions that will not run
|
|
commands unless necessary.
|
|
- C(restarted) will always bounce the service.
|
|
- C(reloaded) will always reload.
|
|
- B(At least one of state and enabled are required.)
|
|
- Note that reloaded will start the service if it is not already started,
|
|
even if your chosen init system wouldn't normally.
|
|
type: str
|
|
choices: [ reloaded, restarted, started, stopped ]
|
|
sleep:
|
|
description:
|
|
- If the service is being C(restarted) then sleep this many seconds
|
|
between the stop and start command.
|
|
- This helps to work around badly-behaving init scripts that exit immediately
|
|
after signaling a process to stop.
|
|
- Not all service managers support sleep, i.e when using systemd this setting will be ignored.
|
|
type: int
|
|
version_added: "1.3"
|
|
pattern:
|
|
description:
|
|
- If the service does not respond to the status command, name a
|
|
substring to look for as would be found in the output of the I(ps)
|
|
command as a stand-in for a status result.
|
|
- If the string is found, the service will be assumed to be started.
|
|
- While using remote hosts with systemd this setting will be ignored.
|
|
type: str
|
|
version_added: "0.7"
|
|
enabled:
|
|
description:
|
|
- Whether the service should start on boot.
|
|
- B(At least one of state and enabled are required.)
|
|
type: bool
|
|
runlevel:
|
|
description:
|
|
- For OpenRC init scripts (e.g. Gentoo) only.
|
|
- The runlevel that this service belongs to.
|
|
- While using remote hosts with systemd this setting will be ignored.
|
|
type: str
|
|
default: default
|
|
arguments:
|
|
description:
|
|
- Additional arguments provided on the command line.
|
|
- While using remote hosts with systemd this setting will be ignored.
|
|
type: str
|
|
default: ''
|
|
aliases: [ args ]
|
|
use:
|
|
description:
|
|
- The service module actually uses system specific modules, normally through auto detection, this setting can force a specific module.
|
|
- Normally it uses the value of the 'ansible_service_mgr' fact and falls back to the old 'service' module when none matching is found.
|
|
type: str
|
|
default: auto
|
|
version_added: 2.2
|
|
extends_documentation_fragment:
|
|
- action_common_attributes
|
|
- action_common_attributes.flow
|
|
attributes:
|
|
action:
|
|
support: full
|
|
async:
|
|
support: full
|
|
bypass_host_loop:
|
|
support: none
|
|
check_mode:
|
|
details: support depends on the underlying plugin invoked
|
|
support: N/A
|
|
diff_mode:
|
|
details: support depends on the underlying plugin invoked
|
|
support: N/A
|
|
platform:
|
|
details: The support depends on the availability for the specific plugin for each platform and if fact gathering is able to detect it
|
|
platforms: all
|
|
notes:
|
|
- For AIX, group subsystem names can be used.
|
|
seealso:
|
|
- module: ansible.windows.win_service
|
|
author:
|
|
- Ansible Core Team
|
|
- Michael DeHaan
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Start service httpd, if not started
|
|
ansible.builtin.service:
|
|
name: httpd
|
|
state: started
|
|
|
|
- name: Stop service httpd, if started
|
|
ansible.builtin.service:
|
|
name: httpd
|
|
state: stopped
|
|
|
|
- name: Restart service httpd, in all cases
|
|
ansible.builtin.service:
|
|
name: httpd
|
|
state: restarted
|
|
|
|
- name: Reload service httpd, in all cases
|
|
ansible.builtin.service:
|
|
name: httpd
|
|
state: reloaded
|
|
|
|
- name: Enable service httpd, and not touch the state
|
|
ansible.builtin.service:
|
|
name: httpd
|
|
enabled: yes
|
|
|
|
- name: Start service foo, based on running process /usr/bin/foo
|
|
ansible.builtin.service:
|
|
name: foo
|
|
pattern: /usr/bin/foo
|
|
state: started
|
|
|
|
- name: Restart network service for interface eth0
|
|
ansible.builtin.service:
|
|
name: network
|
|
state: restarted
|
|
args: eth0
|
|
'''
|
|
|
|
RETURN = r'''#'''
|
|
|
|
import glob
|
|
import json
|
|
import os
|
|
import platform
|
|
import re
|
|
import select
|
|
import shlex
|
|
import subprocess
|
|
import tempfile
|
|
import time
|
|
|
|
# The distutils module is not shipped with SUNWPython on Solaris.
|
|
# It's in the SUNWPython-devel package which also contains development files
|
|
# that don't belong on production boxes. Since our Solaris code doesn't
|
|
# depend on LooseVersion, do not import it on Solaris.
|
|
if platform.system() != 'SunOS':
|
|
from ansible.module_utils.compat.version import LooseVersion
|
|
|
|
from ansible.module_utils._text import to_bytes, to_text
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.common.locale import get_best_parsable_locale
|
|
from ansible.module_utils.common.sys_info import get_platform_subclass
|
|
from ansible.module_utils.service import fail_if_missing
|
|
from ansible.module_utils.six import PY2, b
|
|
|
|
|
|
class Service(object):
|
|
"""
|
|
This is the generic Service manipulation class that is subclassed
|
|
based on platform.
|
|
|
|
A subclass should override the following action methods:-
|
|
- get_service_tools
|
|
- service_enable
|
|
- get_service_status
|
|
- service_control
|
|
|
|
All subclasses MUST define platform and distribution (which may be None).
|
|
"""
|
|
|
|
platform = 'Generic'
|
|
distribution = None
|
|
|
|
def __new__(cls, *args, **kwargs):
|
|
new_cls = get_platform_subclass(Service)
|
|
return super(cls, new_cls).__new__(new_cls)
|
|
|
|
def __init__(self, module):
|
|
self.module = module
|
|
self.name = module.params['name']
|
|
self.state = module.params['state']
|
|
self.sleep = module.params['sleep']
|
|
self.pattern = module.params['pattern']
|
|
self.enable = module.params['enabled']
|
|
self.runlevel = module.params['runlevel']
|
|
self.changed = False
|
|
self.running = None
|
|
self.crashed = None
|
|
self.action = None
|
|
self.svc_cmd = None
|
|
self.svc_initscript = None
|
|
self.svc_initctl = None
|
|
self.enable_cmd = None
|
|
self.arguments = module.params.get('arguments', '')
|
|
self.rcconf_file = None
|
|
self.rcconf_key = None
|
|
self.rcconf_value = None
|
|
self.svc_change = False
|
|
|
|
# ===========================================
|
|
# Platform specific methods (must be replaced by subclass).
|
|
|
|
def get_service_tools(self):
|
|
self.module.fail_json(msg="get_service_tools not implemented on target platform")
|
|
|
|
def service_enable(self):
|
|
self.module.fail_json(msg="service_enable not implemented on target platform")
|
|
|
|
def get_service_status(self):
|
|
self.module.fail_json(msg="get_service_status not implemented on target platform")
|
|
|
|
def service_control(self):
|
|
self.module.fail_json(msg="service_control not implemented on target platform")
|
|
|
|
# ===========================================
|
|
# Generic methods that should be used on all platforms.
|
|
|
|
def execute_command(self, cmd, daemonize=False):
|
|
|
|
locale = get_best_parsable_locale(self.module)
|
|
lang_env = dict(LANG=locale, LC_ALL=locale, LC_MESSAGES=locale)
|
|
|
|
# Most things don't need to be daemonized
|
|
if not daemonize:
|
|
# chkconfig localizes messages and we're screen scraping so make
|
|
# sure we use the C locale
|
|
return self.module.run_command(cmd, environ_update=lang_env)
|
|
|
|
# This is complex because daemonization is hard for people.
|
|
# What we do is daemonize a part of this module, the daemon runs the
|
|
# command, picks up the return code and output, and returns it to the
|
|
# main process.
|
|
pipe = os.pipe()
|
|
pid = os.fork()
|
|
if pid == 0:
|
|
os.close(pipe[0])
|
|
# Set stdin/stdout/stderr to /dev/null
|
|
fd = os.open(os.devnull, os.O_RDWR)
|
|
if fd != 0:
|
|
os.dup2(fd, 0)
|
|
if fd != 1:
|
|
os.dup2(fd, 1)
|
|
if fd != 2:
|
|
os.dup2(fd, 2)
|
|
if fd not in (0, 1, 2):
|
|
os.close(fd)
|
|
|
|
# Make us a daemon. Yes, that's all it takes.
|
|
pid = os.fork()
|
|
if pid > 0:
|
|
os._exit(0)
|
|
os.setsid()
|
|
os.chdir("/")
|
|
pid = os.fork()
|
|
if pid > 0:
|
|
os._exit(0)
|
|
|
|
# Start the command
|
|
if PY2:
|
|
# Python 2.6's shlex.split can't handle text strings correctly
|
|
cmd = to_bytes(cmd, errors='surrogate_or_strict')
|
|
cmd = shlex.split(cmd)
|
|
else:
|
|
# Python3.x shex.split text strings.
|
|
cmd = to_text(cmd, errors='surrogate_or_strict')
|
|
cmd = [to_bytes(c, errors='surrogate_or_strict') for c in shlex.split(cmd)]
|
|
# In either of the above cases, pass a list of byte strings to Popen
|
|
|
|
# chkconfig localizes messages and we're screen scraping so make
|
|
# sure we use the C locale
|
|
p = subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=lang_env, preexec_fn=lambda: os.close(pipe[1]))
|
|
stdout = b("")
|
|
stderr = b("")
|
|
fds = [p.stdout, p.stderr]
|
|
# Wait for all output, or until the main process is dead and its output is done.
|
|
while fds:
|
|
rfd, wfd, efd = select.select(fds, [], fds, 1)
|
|
if not (rfd + wfd + efd) and p.poll() is not None:
|
|
break
|
|
if p.stdout in rfd:
|
|
dat = os.read(p.stdout.fileno(), 4096)
|
|
if not dat:
|
|
fds.remove(p.stdout)
|
|
stdout += dat
|
|
if p.stderr in rfd:
|
|
dat = os.read(p.stderr.fileno(), 4096)
|
|
if not dat:
|
|
fds.remove(p.stderr)
|
|
stderr += dat
|
|
p.wait()
|
|
# Return a JSON blob to parent
|
|
blob = json.dumps([p.returncode, to_text(stdout), to_text(stderr)])
|
|
os.write(pipe[1], to_bytes(blob, errors='surrogate_or_strict'))
|
|
os.close(pipe[1])
|
|
os._exit(0)
|
|
elif pid == -1:
|
|
self.module.fail_json(msg="unable to fork")
|
|
else:
|
|
os.close(pipe[1])
|
|
os.waitpid(pid, 0)
|
|
# Wait for data from daemon process and process it.
|
|
data = b("")
|
|
while True:
|
|
rfd, wfd, efd = select.select([pipe[0]], [], [pipe[0]])
|
|
if pipe[0] in rfd:
|
|
dat = os.read(pipe[0], 4096)
|
|
if not dat:
|
|
break
|
|
data += dat
|
|
return json.loads(to_text(data, errors='surrogate_or_strict'))
|
|
|
|
def check_ps(self):
|
|
# Set ps flags
|
|
if platform.system() == 'SunOS':
|
|
psflags = '-ef'
|
|
else:
|
|
psflags = 'auxww'
|
|
|
|
# Find ps binary
|
|
psbin = self.module.get_bin_path('ps', True)
|
|
|
|
(rc, psout, pserr) = self.execute_command('%s %s' % (psbin, psflags))
|
|
# If rc is 0, set running as appropriate
|
|
if rc == 0:
|
|
self.running = False
|
|
lines = psout.split("\n")
|
|
for line in lines:
|
|
if self.pattern in line and "pattern=" not in line:
|
|
# so as to not confuse ./hacking/test-module.py
|
|
self.running = True
|
|
break
|
|
|
|
def check_service_changed(self):
|
|
if self.state and self.running is None:
|
|
self.module.fail_json(msg="failed determining service state, possible typo of service name?")
|
|
# Find out if state has changed
|
|
if not self.running and self.state in ["reloaded", "started"]:
|
|
self.svc_change = True
|
|
elif self.running and self.state in ["reloaded", "stopped"]:
|
|
self.svc_change = True
|
|
elif self.state == "restarted":
|
|
self.svc_change = True
|
|
if self.module.check_mode and self.svc_change:
|
|
self.module.exit_json(changed=True, msg='service state changed')
|
|
|
|
def modify_service_state(self):
|
|
|
|
# Only do something if state will change
|
|
if self.svc_change:
|
|
# Control service
|
|
if self.state in ['started']:
|
|
self.action = "start"
|
|
elif not self.running and self.state == 'reloaded':
|
|
self.action = "start"
|
|
elif self.state == 'stopped':
|
|
self.action = "stop"
|
|
elif self.state == 'reloaded':
|
|
self.action = "reload"
|
|
elif self.state == 'restarted':
|
|
self.action = "restart"
|
|
|
|
if self.module.check_mode:
|
|
self.module.exit_json(changed=True, msg='changing service state')
|
|
|
|
return self.service_control()
|
|
|
|
else:
|
|
# If nothing needs to change just say all is well
|
|
rc = 0
|
|
err = ''
|
|
out = ''
|
|
return rc, out, err
|
|
|
|
def service_enable_rcconf(self):
|
|
if self.rcconf_file is None or self.rcconf_key is None or self.rcconf_value is None:
|
|
self.module.fail_json(msg="service_enable_rcconf() requires rcconf_file, rcconf_key and rcconf_value")
|
|
|
|
self.changed = None
|
|
entry = '%s="%s"\n' % (self.rcconf_key, self.rcconf_value)
|
|
with open(self.rcconf_file, "r") as RCFILE:
|
|
new_rc_conf = []
|
|
|
|
# Build a list containing the possibly modified file.
|
|
for rcline in RCFILE:
|
|
# Parse line removing whitespaces, quotes, etc.
|
|
rcarray = shlex.split(rcline, comments=True)
|
|
if len(rcarray) >= 1 and '=' in rcarray[0]:
|
|
(key, value) = rcarray[0].split("=", 1)
|
|
if key == self.rcconf_key:
|
|
if value.upper() == self.rcconf_value:
|
|
# Since the proper entry already exists we can stop iterating.
|
|
self.changed = False
|
|
break
|
|
else:
|
|
# We found the key but the value is wrong, replace with new entry.
|
|
rcline = entry
|
|
self.changed = True
|
|
|
|
# Add line to the list.
|
|
new_rc_conf.append(rcline.strip() + '\n')
|
|
|
|
# If we did not see any trace of our entry we need to add it.
|
|
if self.changed is None:
|
|
new_rc_conf.append(entry)
|
|
self.changed = True
|
|
|
|
if self.changed is True:
|
|
|
|
if self.module.check_mode:
|
|
self.module.exit_json(changed=True, msg="changing service enablement")
|
|
|
|
# Create a temporary file next to the current rc.conf (so we stay on the same filesystem).
|
|
# This way the replacement operation is atomic.
|
|
rcconf_dir = os.path.dirname(self.rcconf_file)
|
|
rcconf_base = os.path.basename(self.rcconf_file)
|
|
(TMP_RCCONF, tmp_rcconf_file) = tempfile.mkstemp(dir=rcconf_dir, prefix="%s-" % rcconf_base)
|
|
|
|
# Write out the contents of the list into our temporary file.
|
|
for rcline in new_rc_conf:
|
|
os.write(TMP_RCCONF, rcline.encode())
|
|
|
|
# Close temporary file.
|
|
os.close(TMP_RCCONF)
|
|
|
|
# Replace previous rc.conf.
|
|
self.module.atomic_move(tmp_rcconf_file, self.rcconf_file)
|
|
|
|
|
|
class LinuxService(Service):
|
|
"""
|
|
This is the Linux Service manipulation class - it is currently supporting
|
|
a mixture of binaries and init scripts for controlling services started at
|
|
boot, as well as for controlling the current state.
|
|
"""
|
|
|
|
platform = 'Linux'
|
|
distribution = None
|
|
|
|
def get_service_tools(self):
|
|
|
|
paths = ['/sbin', '/usr/sbin', '/bin', '/usr/bin']
|
|
binaries = ['service', 'chkconfig', 'update-rc.d', 'rc-service', 'rc-update', 'initctl', 'systemctl', 'start', 'stop', 'restart', 'insserv']
|
|
initpaths = ['/etc/init.d']
|
|
location = dict()
|
|
|
|
for binary in binaries:
|
|
location[binary] = self.module.get_bin_path(binary, opt_dirs=paths)
|
|
|
|
for initdir in initpaths:
|
|
initscript = "%s/%s" % (initdir, self.name)
|
|
if os.path.isfile(initscript):
|
|
self.svc_initscript = initscript
|
|
|
|
def check_systemd():
|
|
|
|
# tools must be installed
|
|
if location.get('systemctl', False):
|
|
|
|
# this should show if systemd is the boot init system
|
|
# these mirror systemd's own sd_boot test http://www.freedesktop.org/software/systemd/man/sd_booted.html
|
|
for canary in ["/run/systemd/system/", "/dev/.run/systemd/", "/dev/.systemd/"]:
|
|
if os.path.exists(canary):
|
|
return True
|
|
|
|
# If all else fails, check if init is the systemd command, using comm as cmdline could be symlink
|
|
try:
|
|
f = open('/proc/1/comm', 'r')
|
|
except IOError:
|
|
# If comm doesn't exist, old kernel, no systemd
|
|
return False
|
|
|
|
for line in f:
|
|
if 'systemd' in line:
|
|
return True
|
|
|
|
return False
|
|
|
|
# Locate a tool to enable/disable a service
|
|
if check_systemd():
|
|
# service is managed by systemd
|
|
self.__systemd_unit = self.name
|
|
self.svc_cmd = location['systemctl']
|
|
self.enable_cmd = location['systemctl']
|
|
|
|
elif location.get('initctl', False) and os.path.exists("/etc/init/%s.conf" % self.name):
|
|
# service is managed by upstart
|
|
self.enable_cmd = location['initctl']
|
|
# set the upstart version based on the output of 'initctl version'
|
|
self.upstart_version = LooseVersion('0.0.0')
|
|
try:
|
|
version_re = re.compile(r'\(upstart (.*)\)')
|
|
rc, stdout, stderr = self.module.run_command('%s version' % location['initctl'])
|
|
if rc == 0:
|
|
res = version_re.search(stdout)
|
|
if res:
|
|
self.upstart_version = LooseVersion(res.groups()[0])
|
|
except Exception:
|
|
pass # we'll use the default of 0.0.0
|
|
|
|
self.svc_cmd = location['initctl']
|
|
|
|
elif location.get('rc-service', False):
|
|
# service is managed by OpenRC
|
|
self.svc_cmd = location['rc-service']
|
|
self.enable_cmd = location['rc-update']
|
|
return # already have service start/stop tool too!
|
|
|
|
elif self.svc_initscript:
|
|
# service is managed by with SysV init scripts
|
|
if location.get('update-rc.d', False):
|
|
# and uses update-rc.d
|
|
self.enable_cmd = location['update-rc.d']
|
|
elif location.get('insserv', None):
|
|
# and uses insserv
|
|
self.enable_cmd = location['insserv']
|
|
elif location.get('chkconfig', False):
|
|
# and uses chkconfig
|
|
self.enable_cmd = location['chkconfig']
|
|
|
|
if self.enable_cmd is None:
|
|
fail_if_missing(self.module, False, self.name, msg='host')
|
|
|
|
# If no service control tool selected yet, try to see if 'service' is available
|
|
if self.svc_cmd is None and location.get('service', False):
|
|
self.svc_cmd = location['service']
|
|
|
|
# couldn't find anything yet
|
|
if self.svc_cmd is None and not self.svc_initscript:
|
|
self.module.fail_json(msg='cannot find \'service\' binary or init script for service, possible typo in service name?, aborting')
|
|
|
|
if location.get('initctl', False):
|
|
self.svc_initctl = location['initctl']
|
|
|
|
def get_systemd_service_enabled(self):
|
|
def sysv_exists(name):
|
|
script = '/etc/init.d/' + name
|
|
return os.access(script, os.X_OK)
|
|
|
|
def sysv_is_enabled(name):
|
|
return bool(glob.glob('/etc/rc?.d/S??' + name))
|
|
|
|
service_name = self.__systemd_unit
|
|
(rc, out, err) = self.execute_command("%s is-enabled %s" % (self.enable_cmd, service_name,))
|
|
if rc == 0:
|
|
return True
|
|
elif out.startswith('disabled'):
|
|
return False
|
|
elif sysv_exists(service_name):
|
|
return sysv_is_enabled(service_name)
|
|
else:
|
|
return False
|
|
|
|
def get_systemd_status_dict(self):
|
|
|
|
# Check status first as show will not fail if service does not exist
|
|
(rc, out, err) = self.execute_command("%s show '%s'" % (self.enable_cmd, self.__systemd_unit,))
|
|
if rc != 0:
|
|
self.module.fail_json(msg='failure %d running systemctl show for %r: %s' % (rc, self.__systemd_unit, err))
|
|
elif 'LoadState=not-found' in out:
|
|
self.module.fail_json(msg='systemd could not find the requested service "%r": %s' % (self.__systemd_unit, err))
|
|
|
|
key = None
|
|
value_buffer = []
|
|
status_dict = {}
|
|
for line in out.splitlines():
|
|
if '=' in line:
|
|
if not key:
|
|
key, value = line.split('=', 1)
|
|
# systemd fields that are shell commands can be multi-line
|
|
# We take a value that begins with a "{" as the start of
|
|
# a shell command and a line that ends with "}" as the end of
|
|
# the command
|
|
if value.lstrip().startswith('{'):
|
|
if value.rstrip().endswith('}'):
|
|
status_dict[key] = value
|
|
key = None
|
|
else:
|
|
value_buffer.append(value)
|
|
else:
|
|
status_dict[key] = value
|
|
key = None
|
|
else:
|
|
if line.rstrip().endswith('}'):
|
|
status_dict[key] = '\n'.join(value_buffer)
|
|
key = None
|
|
else:
|
|
value_buffer.append(value)
|
|
else:
|
|
value_buffer.append(value)
|
|
|
|
return status_dict
|
|
|
|
def get_systemd_service_status(self):
|
|
d = self.get_systemd_status_dict()
|
|
if d.get('ActiveState') == 'active':
|
|
# run-once services (for which a single successful exit indicates
|
|
# that they are running as designed) should not be restarted here.
|
|
# Thus, we are not checking d['SubState'].
|
|
self.running = True
|
|
self.crashed = False
|
|
elif d.get('ActiveState') == 'failed':
|
|
self.running = False
|
|
self.crashed = True
|
|
elif d.get('ActiveState') is None:
|
|
self.module.fail_json(msg='No ActiveState value in systemctl show output for %r' % (self.__systemd_unit,))
|
|
else:
|
|
self.running = False
|
|
self.crashed = False
|
|
return self.running
|
|
|
|
def get_service_status(self):
|
|
if self.svc_cmd and self.svc_cmd.endswith('systemctl'):
|
|
return self.get_systemd_service_status()
|
|
|
|
self.action = "status"
|
|
rc, status_stdout, status_stderr = self.service_control()
|
|
|
|
# if we have decided the service is managed by upstart, we check for some additional output...
|
|
if self.svc_initctl and self.running is None:
|
|
# check the job status by upstart response
|
|
initctl_rc, initctl_status_stdout, initctl_status_stderr = self.execute_command("%s status %s %s" % (self.svc_initctl, self.name, self.arguments))
|
|
if "stop/waiting" in initctl_status_stdout:
|
|
self.running = False
|
|
elif "start/running" in initctl_status_stdout:
|
|
self.running = True
|
|
|
|
if self.svc_cmd and self.svc_cmd.endswith("rc-service") and self.running is None:
|
|
openrc_rc, openrc_status_stdout, openrc_status_stderr = self.execute_command("%s %s status" % (self.svc_cmd, self.name))
|
|
self.running = "started" in openrc_status_stdout
|
|
self.crashed = "crashed" in openrc_status_stderr
|
|
|
|
# Prefer a non-zero return code. For reference, see:
|
|
# http://refspecs.linuxbase.org/LSB_4.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
|
|
if self.running is None and rc in [1, 2, 3, 4, 69]:
|
|
self.running = False
|
|
|
|
# if the job status is still not known check it by status output keywords
|
|
# Only check keywords if there's only one line of output (some init
|
|
# scripts will output verbosely in case of error and those can emit
|
|
# keywords that are picked up as false positives
|
|
if self.running is None and status_stdout.count('\n') <= 1:
|
|
# first transform the status output that could irritate keyword matching
|
|
cleanout = status_stdout.lower().replace(self.name.lower(), '')
|
|
if "stop" in cleanout:
|
|
self.running = False
|
|
elif "run" in cleanout:
|
|
self.running = not ("not " in cleanout)
|
|
elif "start" in cleanout and "not " not in cleanout:
|
|
self.running = True
|
|
elif 'could not access pid file' in cleanout:
|
|
self.running = False
|
|
elif 'is dead and pid file exists' in cleanout:
|
|
self.running = False
|
|
elif 'dead but subsys locked' in cleanout:
|
|
self.running = False
|
|
elif 'dead but pid file exists' in cleanout:
|
|
self.running = False
|
|
|
|
# if the job status is still not known and we got a zero for the
|
|
# return code, assume here that the service is running
|
|
if self.running is None and rc == 0:
|
|
self.running = True
|
|
|
|
# if the job status is still not known check it by special conditions
|
|
if self.running is None:
|
|
if self.name == 'iptables' and "ACCEPT" in status_stdout:
|
|
# iptables status command output is lame
|
|
# TODO: lookup if we can use a return code for this instead?
|
|
self.running = True
|
|
|
|
return self.running
|
|
|
|
def service_enable(self):
|
|
|
|
if self.enable_cmd is None:
|
|
self.module.fail_json(msg='cannot detect command to enable service %s, typo or init system potentially unknown' % self.name)
|
|
|
|
self.changed = True
|
|
action = None
|
|
|
|
#
|
|
# Upstart's initctl
|
|
#
|
|
if self.enable_cmd.endswith("initctl"):
|
|
def write_to_override_file(file_name, file_contents, ):
|
|
override_file = open(file_name, 'w')
|
|
override_file.write(file_contents)
|
|
override_file.close()
|
|
|
|
initpath = '/etc/init'
|
|
if self.upstart_version >= LooseVersion('0.6.7'):
|
|
manreg = re.compile(r'^manual\s*$', re.M | re.I)
|
|
config_line = 'manual\n'
|
|
else:
|
|
manreg = re.compile(r'^start on manual\s*$', re.M | re.I)
|
|
config_line = 'start on manual\n'
|
|
conf_file_name = "%s/%s.conf" % (initpath, self.name)
|
|
override_file_name = "%s/%s.override" % (initpath, self.name)
|
|
|
|
# Check to see if files contain the manual line in .conf and fail if True
|
|
with open(conf_file_name) as conf_file_fh:
|
|
conf_file_content = conf_file_fh.read()
|
|
if manreg.search(conf_file_content):
|
|
self.module.fail_json(msg="manual stanza not supported in a .conf file")
|
|
|
|
self.changed = False
|
|
if os.path.exists(override_file_name):
|
|
with open(override_file_name) as override_fh:
|
|
override_file_contents = override_fh.read()
|
|
# Remove manual stanza if present and service enabled
|
|
if self.enable and manreg.search(override_file_contents):
|
|
self.changed = True
|
|
override_state = manreg.sub('', override_file_contents)
|
|
# Add manual stanza if not present and service disabled
|
|
elif not (self.enable) and not (manreg.search(override_file_contents)):
|
|
self.changed = True
|
|
override_state = '\n'.join((override_file_contents, config_line))
|
|
# service already in desired state
|
|
else:
|
|
pass
|
|
# Add file with manual stanza if service disabled
|
|
elif not (self.enable):
|
|
self.changed = True
|
|
override_state = config_line
|
|
else:
|
|
# service already in desired state
|
|
pass
|
|
|
|
if self.module.check_mode:
|
|
self.module.exit_json(changed=self.changed)
|
|
|
|
# The initctl method of enabling and disabling services is much
|
|
# different than for the other service methods. So actually
|
|
# committing the change is done in this conditional and then we
|
|
# skip the boilerplate at the bottom of the method
|
|
if self.changed:
|
|
try:
|
|
write_to_override_file(override_file_name, override_state)
|
|
except Exception:
|
|
self.module.fail_json(msg='Could not modify override file')
|
|
|
|
return
|
|
|
|
#
|
|
# SysV's chkconfig
|
|
#
|
|
if self.enable_cmd.endswith("chkconfig"):
|
|
if self.enable:
|
|
action = 'on'
|
|
else:
|
|
action = 'off'
|
|
|
|
(rc, out, err) = self.execute_command("%s --list %s" % (self.enable_cmd, self.name))
|
|
if 'chkconfig --add %s' % self.name in err:
|
|
self.execute_command("%s --add %s" % (self.enable_cmd, self.name))
|
|
(rc, out, err) = self.execute_command("%s --list %s" % (self.enable_cmd, self.name))
|
|
if self.name not in out:
|
|
self.module.fail_json(msg="service %s does not support chkconfig" % self.name)
|
|
# TODO: look back on why this is here
|
|
# state = out.split()[-1]
|
|
|
|
# Check if we're already in the correct state
|
|
if "3:%s" % action in out and "5:%s" % action in out:
|
|
self.changed = False
|
|
return
|
|
|
|
#
|
|
# Systemd's systemctl
|
|
#
|
|
if self.enable_cmd.endswith("systemctl"):
|
|
if self.enable:
|
|
action = 'enable'
|
|
else:
|
|
action = 'disable'
|
|
|
|
# Check if we're already in the correct state
|
|
service_enabled = self.get_systemd_service_enabled()
|
|
|
|
# self.changed should already be true
|
|
if self.enable == service_enabled:
|
|
self.changed = False
|
|
return
|
|
|
|
#
|
|
# OpenRC's rc-update
|
|
#
|
|
if self.enable_cmd.endswith("rc-update"):
|
|
if self.enable:
|
|
action = 'add'
|
|
else:
|
|
action = 'delete'
|
|
|
|
(rc, out, err) = self.execute_command("%s show" % self.enable_cmd)
|
|
for line in out.splitlines():
|
|
service_name, runlevels = line.split('|')
|
|
service_name = service_name.strip()
|
|
if service_name != self.name:
|
|
continue
|
|
runlevels = re.split(r'\s+', runlevels)
|
|
# service already enabled for the runlevel
|
|
if self.enable and self.runlevel in runlevels:
|
|
self.changed = False
|
|
# service already disabled for the runlevel
|
|
elif not self.enable and self.runlevel not in runlevels:
|
|
self.changed = False
|
|
break
|
|
else:
|
|
# service already disabled altogether
|
|
if not self.enable:
|
|
self.changed = False
|
|
|
|
if not self.changed:
|
|
return
|
|
|
|
#
|
|
# update-rc.d style
|
|
#
|
|
if self.enable_cmd.endswith("update-rc.d"):
|
|
|
|
enabled = False
|
|
slinks = glob.glob('/etc/rc?.d/S??' + self.name)
|
|
if slinks:
|
|
enabled = True
|
|
|
|
if self.enable != enabled:
|
|
self.changed = True
|
|
|
|
if self.enable:
|
|
action = 'enable'
|
|
klinks = glob.glob('/etc/rc?.d/K??' + self.name)
|
|
if not klinks:
|
|
if not self.module.check_mode:
|
|
(rc, out, err) = self.execute_command("%s %s defaults" % (self.enable_cmd, self.name))
|
|
if rc != 0:
|
|
if err:
|
|
self.module.fail_json(msg=err)
|
|
else:
|
|
self.module.fail_json(msg=out) % (self.enable_cmd, self.name, action)
|
|
else:
|
|
action = 'disable'
|
|
|
|
if not self.module.check_mode:
|
|
(rc, out, err) = self.execute_command("%s %s %s" % (self.enable_cmd, self.name, action))
|
|
if rc != 0:
|
|
if err:
|
|
self.module.fail_json(msg=err)
|
|
else:
|
|
self.module.fail_json(msg=out) % (self.enable_cmd, self.name, action)
|
|
else:
|
|
self.changed = False
|
|
|
|
return
|
|
|
|
#
|
|
# insserv (Debian <=7, SLES, others)
|
|
#
|
|
if self.enable_cmd.endswith("insserv"):
|
|
if self.enable:
|
|
(rc, out, err) = self.execute_command("%s -n -v %s" % (self.enable_cmd, self.name))
|
|
else:
|
|
(rc, out, err) = self.execute_command("%s -n -r -v %s" % (self.enable_cmd, self.name))
|
|
|
|
self.changed = False
|
|
for line in err.splitlines():
|
|
if self.enable and line.find('enable service') != -1:
|
|
self.changed = True
|
|
break
|
|
if not self.enable and line.find('remove service') != -1:
|
|
self.changed = True
|
|
break
|
|
|
|
if self.module.check_mode:
|
|
self.module.exit_json(changed=self.changed)
|
|
|
|
if not self.changed:
|
|
return
|
|
|
|
if self.enable:
|
|
(rc, out, err) = self.execute_command("%s %s" % (self.enable_cmd, self.name))
|
|
if (rc != 0) or (err != ''):
|
|
self.module.fail_json(msg=("Failed to install service. rc: %s, out: %s, err: %s" % (rc, out, err)))
|
|
return (rc, out, err)
|
|
else:
|
|
(rc, out, err) = self.execute_command("%s -r %s" % (self.enable_cmd, self.name))
|
|
if (rc != 0) or (err != ''):
|
|
self.module.fail_json(msg=("Failed to remove service. rc: %s, out: %s, err: %s" % (rc, out, err)))
|
|
return (rc, out, err)
|
|
|
|
#
|
|
# If we've gotten to the end, the service needs to be updated
|
|
#
|
|
self.changed = True
|
|
|
|
# we change argument order depending on real binary used:
|
|
# rc-update and systemctl need the argument order reversed
|
|
|
|
if self.enable_cmd.endswith("rc-update"):
|
|
args = (self.enable_cmd, action, self.name + " " + self.runlevel)
|
|
elif self.enable_cmd.endswith("systemctl"):
|
|
args = (self.enable_cmd, action, self.__systemd_unit)
|
|
else:
|
|
args = (self.enable_cmd, self.name, action)
|
|
|
|
if self.module.check_mode:
|
|
self.module.exit_json(changed=self.changed)
|
|
|
|
(rc, out, err) = self.execute_command("%s %s %s" % args)
|
|
if rc != 0:
|
|
if err:
|
|
self.module.fail_json(msg="Error when trying to %s %s: rc=%s %s" % (action, self.name, rc, err))
|
|
else:
|
|
self.module.fail_json(msg="Failure for %s %s: rc=%s %s" % (action, self.name, rc, out))
|
|
|
|
return (rc, out, err)
|
|
|
|
def service_control(self):
|
|
|
|
# Decide what command to run
|
|
svc_cmd = ''
|
|
arguments = self.arguments
|
|
if self.svc_cmd:
|
|
if not self.svc_cmd.endswith("systemctl"):
|
|
if self.svc_cmd.endswith("initctl"):
|
|
# initctl commands take the form <cmd> <action> <name>
|
|
svc_cmd = self.svc_cmd
|
|
arguments = "%s %s" % (self.name, arguments)
|
|
else:
|
|
# SysV and OpenRC take the form <cmd> <name> <action>
|
|
svc_cmd = "%s %s" % (self.svc_cmd, self.name)
|
|
else:
|
|
# systemd commands take the form <cmd> <action> <name>
|
|
svc_cmd = self.svc_cmd
|
|
arguments = "%s %s" % (self.__systemd_unit, arguments)
|
|
elif self.svc_cmd is None and self.svc_initscript:
|
|
# upstart
|
|
svc_cmd = "%s" % self.svc_initscript
|
|
|
|
# In OpenRC, if a service crashed, we need to reset its status to
|
|
# stopped with the zap command, before we can start it back.
|
|
if self.svc_cmd and self.svc_cmd.endswith('rc-service') and self.action == 'start' and self.crashed:
|
|
self.execute_command("%s zap" % svc_cmd, daemonize=True)
|
|
|
|
if self.action != "restart":
|
|
if svc_cmd != '':
|
|
# upstart or systemd or OpenRC
|
|
rc_state, stdout, stderr = self.execute_command("%s %s %s" % (svc_cmd, self.action, arguments), daemonize=True)
|
|
else:
|
|
# SysV
|
|
rc_state, stdout, stderr = self.execute_command("%s %s %s" % (self.action, self.name, arguments), daemonize=True)
|
|
elif self.svc_cmd and self.svc_cmd.endswith('rc-service'):
|
|
# All services in OpenRC support restart.
|
|
rc_state, stdout, stderr = self.execute_command("%s %s %s" % (svc_cmd, self.action, arguments), daemonize=True)
|
|
else:
|
|
# In other systems, not all services support restart. Do it the hard way.
|
|
if svc_cmd != '':
|
|
# upstart or systemd
|
|
rc1, stdout1, stderr1 = self.execute_command("%s %s %s" % (svc_cmd, 'stop', arguments), daemonize=True)
|
|
else:
|
|
# SysV
|
|
rc1, stdout1, stderr1 = self.execute_command("%s %s %s" % ('stop', self.name, arguments), daemonize=True)
|
|
|
|
if self.sleep:
|
|
time.sleep(self.sleep)
|
|
|
|
if svc_cmd != '':
|
|
# upstart or systemd
|
|
rc2, stdout2, stderr2 = self.execute_command("%s %s %s" % (svc_cmd, 'start', arguments), daemonize=True)
|
|
else:
|
|
# SysV
|
|
rc2, stdout2, stderr2 = self.execute_command("%s %s %s" % ('start', self.name, arguments), daemonize=True)
|
|
|
|
# merge return information
|
|
if rc1 != 0 and rc2 == 0:
|
|
rc_state = rc2
|
|
stdout = stdout2
|
|
stderr = stderr2
|
|
else:
|
|
rc_state = rc1 + rc2
|
|
stdout = stdout1 + stdout2
|
|
stderr = stderr1 + stderr2
|
|
|
|
return (rc_state, stdout, stderr)
|
|
|
|
|
|
class FreeBsdService(Service):
|
|
"""
|
|
This is the FreeBSD Service manipulation class - it uses the /etc/rc.conf
|
|
file for controlling services started at boot and the 'service' binary to
|
|
check status and perform direct service manipulation.
|
|
"""
|
|
|
|
platform = 'FreeBSD'
|
|
distribution = None
|
|
|
|
def get_service_tools(self):
|
|
self.svc_cmd = self.module.get_bin_path('service', True)
|
|
if not self.svc_cmd:
|
|
self.module.fail_json(msg='unable to find service binary')
|
|
|
|
self.sysrc_cmd = self.module.get_bin_path('sysrc')
|
|
|
|
def get_service_status(self):
|
|
rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.name, 'onestatus', self.arguments))
|
|
if self.name == "pf":
|
|
self.running = "Enabled" in stdout
|
|
else:
|
|
if rc == 1:
|
|
self.running = False
|
|
elif rc == 0:
|
|
self.running = True
|
|
|
|
def service_enable(self):
|
|
if self.enable:
|
|
self.rcconf_value = "YES"
|
|
else:
|
|
self.rcconf_value = "NO"
|
|
|
|
rcfiles = ['/etc/rc.conf', '/etc/rc.conf.local', '/usr/local/etc/rc.conf']
|
|
for rcfile in rcfiles:
|
|
if os.path.isfile(rcfile):
|
|
self.rcconf_file = rcfile
|
|
|
|
rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.name, 'rcvar', self.arguments))
|
|
try:
|
|
rcvars = shlex.split(stdout, comments=True)
|
|
except Exception:
|
|
# TODO: add a warning to the output with the failure
|
|
pass
|
|
|
|
if not rcvars:
|
|
self.module.fail_json(msg="unable to determine rcvar", stdout=stdout, stderr=stderr)
|
|
|
|
# In rare cases, i.e. sendmail, rcvar can return several key=value pairs
|
|
# Usually there is just one, however. In other rare cases, i.e. uwsgi,
|
|
# rcvar can return extra uncommented data that is not at all related to
|
|
# the rcvar. We will just take the first key=value pair we come across
|
|
# and hope for the best.
|
|
for rcvar in rcvars:
|
|
if '=' in rcvar:
|
|
self.rcconf_key, default_rcconf_value = rcvar.split('=', 1)
|
|
break
|
|
|
|
if self.rcconf_key is None:
|
|
self.module.fail_json(msg="unable to determine rcvar", stdout=stdout, stderr=stderr)
|
|
|
|
if self.sysrc_cmd: # FreeBSD >= 9.2
|
|
|
|
rc, current_rcconf_value, stderr = self.execute_command("%s -n %s" % (self.sysrc_cmd, self.rcconf_key))
|
|
# it can happen that rcvar is not set (case of a system coming from the ports collection)
|
|
# so we will fallback on the default
|
|
if rc != 0:
|
|
current_rcconf_value = default_rcconf_value
|
|
|
|
if current_rcconf_value.strip().upper() != self.rcconf_value:
|
|
|
|
self.changed = True
|
|
|
|
if self.module.check_mode:
|
|
self.module.exit_json(changed=True, msg="changing service enablement")
|
|
|
|
rc, change_stdout, change_stderr = self.execute_command("%s %s=\"%s\"" % (self.sysrc_cmd, self.rcconf_key, self.rcconf_value))
|
|
if rc != 0:
|
|
self.module.fail_json(msg="unable to set rcvar using sysrc", stdout=change_stdout, stderr=change_stderr)
|
|
|
|
# sysrc does not exit with code 1 on permission error => validate successful change using service(8)
|
|
rc, check_stdout, check_stderr = self.execute_command("%s %s %s" % (self.svc_cmd, self.name, "enabled"))
|
|
if self.enable != (rc == 0): # rc = 0 indicates enabled service, rc = 1 indicates disabled service
|
|
self.module.fail_json(msg="unable to set rcvar: sysrc did not change value", stdout=change_stdout, stderr=change_stderr)
|
|
|
|
else:
|
|
self.changed = False
|
|
|
|
else: # Legacy (FreeBSD < 9.2)
|
|
try:
|
|
return self.service_enable_rcconf()
|
|
except Exception:
|
|
self.module.fail_json(msg='unable to set rcvar')
|
|
|
|
def service_control(self):
|
|
|
|
if self.action == "start":
|
|
self.action = "onestart"
|
|
if self.action == "stop":
|
|
self.action = "onestop"
|
|
if self.action == "reload":
|
|
self.action = "onereload"
|
|
|
|
ret = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.name, self.action, self.arguments))
|
|
|
|
if self.sleep:
|
|
time.sleep(self.sleep)
|
|
|
|
return ret
|
|
|
|
|
|
class DragonFlyBsdService(FreeBsdService):
|
|
"""
|
|
This is the DragonFly BSD Service manipulation class - it uses the /etc/rc.conf
|
|
file for controlling services started at boot and the 'service' binary to
|
|
check status and perform direct service manipulation.
|
|
"""
|
|
|
|
platform = 'DragonFly'
|
|
distribution = None
|
|
|
|
def service_enable(self):
|
|
if self.enable:
|
|
self.rcconf_value = "YES"
|
|
else:
|
|
self.rcconf_value = "NO"
|
|
|
|
rcfiles = ['/etc/rc.conf'] # Overkill?
|
|
for rcfile in rcfiles:
|
|
if os.path.isfile(rcfile):
|
|
self.rcconf_file = rcfile
|
|
|
|
self.rcconf_key = "%s" % self.name.replace("-", "_")
|
|
|
|
return self.service_enable_rcconf()
|
|
|
|
|
|
class OpenBsdService(Service):
|
|
"""
|
|
This is the OpenBSD Service manipulation class - it uses rcctl(8) or
|
|
/etc/rc.d scripts for service control. Enabling a service is
|
|
only supported if rcctl is present.
|
|
"""
|
|
|
|
platform = 'OpenBSD'
|
|
distribution = None
|
|
|
|
def get_service_tools(self):
|
|
self.enable_cmd = self.module.get_bin_path('rcctl')
|
|
|
|
if self.enable_cmd:
|
|
self.svc_cmd = self.enable_cmd
|
|
else:
|
|
rcdir = '/etc/rc.d'
|
|
|
|
rc_script = "%s/%s" % (rcdir, self.name)
|
|
if os.path.isfile(rc_script):
|
|
self.svc_cmd = rc_script
|
|
|
|
if not self.svc_cmd:
|
|
self.module.fail_json(msg='unable to find svc_cmd')
|
|
|
|
def get_service_status(self):
|
|
if self.enable_cmd:
|
|
rc, stdout, stderr = self.execute_command("%s %s %s" % (self.svc_cmd, 'check', self.name))
|
|
else:
|
|
rc, stdout, stderr = self.execute_command("%s %s" % (self.svc_cmd, 'check'))
|
|
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
|
|
if rc == 1:
|
|
self.running = False
|
|
elif rc == 0:
|
|
self.running = True
|
|
|
|
def service_control(self):
|
|
if self.enable_cmd:
|
|
return self.execute_command("%s -f %s %s" % (self.svc_cmd, self.action, self.name), daemonize=True)
|
|
else:
|
|
return self.execute_command("%s -f %s" % (self.svc_cmd, self.action))
|
|
|
|
def service_enable(self):
|
|
if not self.enable_cmd:
|
|
return super(OpenBsdService, self).service_enable()
|
|
|
|
rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.enable_cmd, 'getdef', self.name, 'flags'))
|
|
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
|
|
getdef_string = stdout.rstrip()
|
|
|
|
# Depending on the service the string returned from 'getdef' may be
|
|
# either a set of flags or the boolean YES/NO
|
|
if getdef_string == "YES" or getdef_string == "NO":
|
|
default_flags = ''
|
|
else:
|
|
default_flags = getdef_string
|
|
|
|
rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.enable_cmd, 'get', self.name, 'flags'))
|
|
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
|
|
get_string = stdout.rstrip()
|
|
|
|
# Depending on the service the string returned from 'get' may be
|
|
# either a set of flags or the boolean YES/NO
|
|
if get_string == "YES" or get_string == "NO":
|
|
current_flags = ''
|
|
else:
|
|
current_flags = get_string
|
|
|
|
# If there are arguments from the user we use these as flags unless
|
|
# they are already set.
|
|
if self.arguments and self.arguments != current_flags:
|
|
changed_flags = self.arguments
|
|
# If the user has not supplied any arguments and the current flags
|
|
# differ from the default we reset them.
|
|
elif not self.arguments and current_flags != default_flags:
|
|
changed_flags = ' '
|
|
# Otherwise there is no need to modify flags.
|
|
else:
|
|
changed_flags = ''
|
|
|
|
rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.enable_cmd, 'get', self.name, 'status'))
|
|
|
|
if self.enable:
|
|
if rc == 0 and not changed_flags:
|
|
return
|
|
|
|
if rc != 0:
|
|
status_action = "set %s status on" % (self.name)
|
|
else:
|
|
status_action = ''
|
|
if changed_flags:
|
|
flags_action = "set %s flags %s" % (self.name, changed_flags)
|
|
else:
|
|
flags_action = ''
|
|
else:
|
|
if rc == 1:
|
|
return
|
|
|
|
status_action = "set %s status off" % self.name
|
|
flags_action = ''
|
|
|
|
# Verify state assumption
|
|
if not status_action and not flags_action:
|
|
self.module.fail_json(msg="neither status_action or status_flags is set, this should never happen")
|
|
|
|
if self.module.check_mode:
|
|
self.module.exit_json(changed=True, msg="changing service enablement")
|
|
|
|
status_modified = 0
|
|
if status_action:
|
|
rc, stdout, stderr = self.execute_command("%s %s" % (self.enable_cmd, status_action))
|
|
|
|
if rc != 0:
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
else:
|
|
self.module.fail_json(msg="rcctl failed to modify service status")
|
|
|
|
status_modified = 1
|
|
|
|
if flags_action:
|
|
rc, stdout, stderr = self.execute_command("%s %s" % (self.enable_cmd, flags_action))
|
|
|
|
if rc != 0:
|
|
if stderr:
|
|
if status_modified:
|
|
error_message = "rcctl modified service status but failed to set flags: " + stderr
|
|
else:
|
|
error_message = stderr
|
|
else:
|
|
if status_modified:
|
|
error_message = "rcctl modified service status but failed to set flags"
|
|
else:
|
|
error_message = "rcctl failed to modify service flags"
|
|
|
|
self.module.fail_json(msg=error_message)
|
|
|
|
self.changed = True
|
|
|
|
|
|
class NetBsdService(Service):
|
|
"""
|
|
This is the NetBSD Service manipulation class - it uses the /etc/rc.conf
|
|
file for controlling services started at boot, check status and perform
|
|
direct service manipulation. Init scripts in /etc/rc.d are used for
|
|
controlling services (start/stop) as well as for controlling the current
|
|
state.
|
|
"""
|
|
|
|
platform = 'NetBSD'
|
|
distribution = None
|
|
|
|
def get_service_tools(self):
|
|
initpaths = ['/etc/rc.d'] # better: $rc_directories - how to get in here? Run: sh -c '. /etc/rc.conf ; echo $rc_directories'
|
|
|
|
for initdir in initpaths:
|
|
initscript = "%s/%s" % (initdir, self.name)
|
|
if os.path.isfile(initscript):
|
|
self.svc_initscript = initscript
|
|
|
|
if not self.svc_initscript:
|
|
self.module.fail_json(msg='unable to find rc.d script')
|
|
|
|
def service_enable(self):
|
|
if self.enable:
|
|
self.rcconf_value = "YES"
|
|
else:
|
|
self.rcconf_value = "NO"
|
|
|
|
rcfiles = ['/etc/rc.conf'] # Overkill?
|
|
for rcfile in rcfiles:
|
|
if os.path.isfile(rcfile):
|
|
self.rcconf_file = rcfile
|
|
|
|
self.rcconf_key = "%s" % self.name.replace("-", "_")
|
|
|
|
return self.service_enable_rcconf()
|
|
|
|
def get_service_status(self):
|
|
self.svc_cmd = "%s" % self.svc_initscript
|
|
rc, stdout, stderr = self.execute_command("%s %s" % (self.svc_cmd, 'onestatus'))
|
|
if rc == 1:
|
|
self.running = False
|
|
elif rc == 0:
|
|
self.running = True
|
|
|
|
def service_control(self):
|
|
if self.action == "start":
|
|
self.action = "onestart"
|
|
if self.action == "stop":
|
|
self.action = "onestop"
|
|
|
|
self.svc_cmd = "%s" % self.svc_initscript
|
|
return self.execute_command("%s %s" % (self.svc_cmd, self.action), daemonize=True)
|
|
|
|
|
|
class SunOSService(Service):
|
|
"""
|
|
This is the SunOS Service manipulation class - it uses the svcadm
|
|
command for controlling services, and svcs command for checking status.
|
|
It also tries to be smart about taking the service out of maintenance
|
|
state if necessary.
|
|
"""
|
|
platform = 'SunOS'
|
|
distribution = None
|
|
|
|
def get_service_tools(self):
|
|
self.svcs_cmd = self.module.get_bin_path('svcs', True)
|
|
|
|
if not self.svcs_cmd:
|
|
self.module.fail_json(msg='unable to find svcs binary')
|
|
|
|
self.svcadm_cmd = self.module.get_bin_path('svcadm', True)
|
|
|
|
if not self.svcadm_cmd:
|
|
self.module.fail_json(msg='unable to find svcadm binary')
|
|
|
|
if self.svcadm_supports_sync():
|
|
self.svcadm_sync = '-s'
|
|
else:
|
|
self.svcadm_sync = ''
|
|
|
|
def svcadm_supports_sync(self):
|
|
# Support for synchronous restart/refresh is only supported on
|
|
# Oracle Solaris >= 11.2
|
|
for line in open('/etc/release', 'r').readlines():
|
|
m = re.match(r'\s+Oracle Solaris (\d+)\.(\d+).*', line.rstrip())
|
|
if m and m.groups() >= ('11', '2'):
|
|
return True
|
|
|
|
def get_service_status(self):
|
|
status = self.get_sunos_svcs_status()
|
|
# Only 'online' is considered properly running. Everything else is off
|
|
# or has some sort of problem.
|
|
if status == 'online':
|
|
self.running = True
|
|
else:
|
|
self.running = False
|
|
|
|
def get_sunos_svcs_status(self):
|
|
rc, stdout, stderr = self.execute_command("%s %s" % (self.svcs_cmd, self.name))
|
|
if rc == 1:
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
else:
|
|
self.module.fail_json(msg=stdout)
|
|
|
|
lines = stdout.rstrip("\n").split("\n")
|
|
status = lines[-1].split(" ")[0]
|
|
# status is one of: online, offline, degraded, disabled, maintenance, uninitialized
|
|
# see man svcs(1)
|
|
return status
|
|
|
|
def service_enable(self):
|
|
# Get current service enablement status
|
|
rc, stdout, stderr = self.execute_command("%s -l %s" % (self.svcs_cmd, self.name))
|
|
|
|
if rc != 0:
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
else:
|
|
self.module.fail_json(msg=stdout)
|
|
|
|
enabled = False
|
|
temporary = False
|
|
|
|
# look for enabled line, which could be one of:
|
|
# enabled true (temporary)
|
|
# enabled false (temporary)
|
|
# enabled true
|
|
# enabled false
|
|
for line in stdout.split("\n"):
|
|
if line.startswith("enabled"):
|
|
if "true" in line:
|
|
enabled = True
|
|
if "temporary" in line:
|
|
temporary = True
|
|
|
|
startup_enabled = (enabled and not temporary) or (not enabled and temporary)
|
|
|
|
if self.enable and startup_enabled:
|
|
return
|
|
elif (not self.enable) and (not startup_enabled):
|
|
return
|
|
|
|
if not self.module.check_mode:
|
|
# Mark service as started or stopped (this will have the side effect of
|
|
# actually stopping or starting the service)
|
|
if self.enable:
|
|
subcmd = "enable -rs"
|
|
else:
|
|
subcmd = "disable -s"
|
|
|
|
rc, stdout, stderr = self.execute_command("%s %s %s" % (self.svcadm_cmd, subcmd, self.name))
|
|
|
|
if rc != 0:
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
else:
|
|
self.module.fail_json(msg=stdout)
|
|
|
|
self.changed = True
|
|
|
|
def service_control(self):
|
|
status = self.get_sunos_svcs_status()
|
|
|
|
# if starting or reloading, clear maintenance states
|
|
if self.action in ['start', 'reload', 'restart'] and status in ['maintenance', 'degraded']:
|
|
rc, stdout, stderr = self.execute_command("%s clear %s" % (self.svcadm_cmd, self.name))
|
|
if rc != 0:
|
|
return rc, stdout, stderr
|
|
status = self.get_sunos_svcs_status()
|
|
|
|
if status in ['maintenance', 'degraded']:
|
|
self.module.fail_json(msg="Failed to bring service out of %s status." % status)
|
|
|
|
if self.action == 'start':
|
|
subcmd = "enable -rst"
|
|
elif self.action == 'stop':
|
|
subcmd = "disable -st"
|
|
elif self.action == 'reload':
|
|
subcmd = "refresh %s" % (self.svcadm_sync)
|
|
elif self.action == 'restart' and status == 'online':
|
|
subcmd = "restart %s" % (self.svcadm_sync)
|
|
elif self.action == 'restart' and status != 'online':
|
|
subcmd = "enable -rst"
|
|
|
|
return self.execute_command("%s %s %s" % (self.svcadm_cmd, subcmd, self.name))
|
|
|
|
|
|
class AIX(Service):
|
|
"""
|
|
This is the AIX Service (SRC) manipulation class - it uses lssrc, startsrc, stopsrc
|
|
and refresh for service control. Enabling a service is currently not supported.
|
|
Would require to add an entry in the /etc/inittab file (mkitab, chitab and rmitab
|
|
commands)
|
|
"""
|
|
|
|
platform = 'AIX'
|
|
distribution = None
|
|
|
|
def get_service_tools(self):
|
|
self.lssrc_cmd = self.module.get_bin_path('lssrc', True)
|
|
|
|
if not self.lssrc_cmd:
|
|
self.module.fail_json(msg='unable to find lssrc binary')
|
|
|
|
self.startsrc_cmd = self.module.get_bin_path('startsrc', True)
|
|
|
|
if not self.startsrc_cmd:
|
|
self.module.fail_json(msg='unable to find startsrc binary')
|
|
|
|
self.stopsrc_cmd = self.module.get_bin_path('stopsrc', True)
|
|
|
|
if not self.stopsrc_cmd:
|
|
self.module.fail_json(msg='unable to find stopsrc binary')
|
|
|
|
self.refresh_cmd = self.module.get_bin_path('refresh', True)
|
|
|
|
if not self.refresh_cmd:
|
|
self.module.fail_json(msg='unable to find refresh binary')
|
|
|
|
def get_service_status(self):
|
|
status = self.get_aix_src_status()
|
|
# Only 'active' is considered properly running. Everything else is off
|
|
# or has some sort of problem.
|
|
if status == 'active':
|
|
self.running = True
|
|
else:
|
|
self.running = False
|
|
|
|
def get_aix_src_status(self):
|
|
# Check subsystem status
|
|
rc, stdout, stderr = self.execute_command("%s -s %s" % (self.lssrc_cmd, self.name))
|
|
if rc == 1:
|
|
# If check for subsystem is not ok, check if service name is a
|
|
# group subsystem
|
|
rc, stdout, stderr = self.execute_command("%s -g %s" % (self.lssrc_cmd, self.name))
|
|
if rc == 1:
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
else:
|
|
self.module.fail_json(msg=stdout)
|
|
else:
|
|
# Check all subsystem status, if one subsystem is not active
|
|
# the group is considered not active.
|
|
lines = stdout.splitlines()
|
|
for state in lines[1:]:
|
|
if state.split()[-1].strip() != "active":
|
|
status = state.split()[-1].strip()
|
|
break
|
|
else:
|
|
status = "active"
|
|
|
|
# status is one of: active, inoperative
|
|
return status
|
|
else:
|
|
lines = stdout.rstrip("\n").split("\n")
|
|
status = lines[-1].split(" ")[-1]
|
|
|
|
# status is one of: active, inoperative
|
|
return status
|
|
|
|
def service_control(self):
|
|
|
|
# Check if service name is a subsystem of a group subsystem
|
|
rc, stdout, stderr = self.execute_command("%s -a" % (self.lssrc_cmd))
|
|
if rc == 1:
|
|
if stderr:
|
|
self.module.fail_json(msg=stderr)
|
|
else:
|
|
self.module.fail_json(msg=stdout)
|
|
else:
|
|
lines = stdout.splitlines()
|
|
subsystems = []
|
|
groups = []
|
|
for line in lines[1:]:
|
|
subsystem = line.split()[0].strip()
|
|
group = line.split()[1].strip()
|
|
subsystems.append(subsystem)
|
|
if group:
|
|
groups.append(group)
|
|
|
|
# Define if service name parameter:
|
|
# -s subsystem or -g group subsystem
|
|
if self.name in subsystems:
|
|
srccmd_parameter = "-s"
|
|
elif self.name in groups:
|
|
srccmd_parameter = "-g"
|
|
|
|
if self.action == 'start':
|
|
srccmd = self.startsrc_cmd
|
|
elif self.action == 'stop':
|
|
srccmd = self.stopsrc_cmd
|
|
elif self.action == 'reload':
|
|
srccmd = self.refresh_cmd
|
|
elif self.action == 'restart':
|
|
self.execute_command("%s %s %s" % (self.stopsrc_cmd, srccmd_parameter, self.name))
|
|
if self.sleep:
|
|
time.sleep(self.sleep)
|
|
srccmd = self.startsrc_cmd
|
|
|
|
if self.arguments and self.action in ('start', 'restart'):
|
|
return self.execute_command("%s -a \"%s\" %s %s" % (srccmd, self.arguments, srccmd_parameter, self.name))
|
|
else:
|
|
return self.execute_command("%s %s %s" % (srccmd, srccmd_parameter, self.name))
|
|
|
|
|
|
# ===========================================
|
|
# Main control flow
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
name=dict(type='str', required=True),
|
|
state=dict(type='str', choices=['started', 'stopped', 'reloaded', 'restarted']),
|
|
sleep=dict(type='int'),
|
|
pattern=dict(type='str'),
|
|
enabled=dict(type='bool'),
|
|
runlevel=dict(type='str', default='default'),
|
|
arguments=dict(type='str', default='', aliases=['args']),
|
|
),
|
|
supports_check_mode=True,
|
|
required_one_of=[['state', 'enabled']],
|
|
)
|
|
|
|
service = Service(module)
|
|
|
|
module.debug('Service instantiated - platform %s' % service.platform)
|
|
if service.distribution:
|
|
module.debug('Service instantiated - distribution %s' % service.distribution)
|
|
|
|
rc = 0
|
|
out = ''
|
|
err = ''
|
|
result = {}
|
|
result['name'] = service.name
|
|
|
|
# Find service management tools
|
|
service.get_service_tools()
|
|
|
|
# Enable/disable service startup at boot if requested
|
|
if service.module.params['enabled'] is not None:
|
|
# FIXME: ideally this should detect if we need to toggle the enablement state, though
|
|
# it's unlikely the changed handler would need to fire in this case so it's a minor thing.
|
|
service.service_enable()
|
|
result['enabled'] = service.enable
|
|
|
|
if module.params['state'] is None:
|
|
# Not changing the running state, so bail out now.
|
|
result['changed'] = service.changed
|
|
module.exit_json(**result)
|
|
|
|
result['state'] = service.state
|
|
|
|
# Collect service status
|
|
if service.pattern:
|
|
service.check_ps()
|
|
else:
|
|
service.get_service_status()
|
|
|
|
# Calculate if request will change service state
|
|
service.check_service_changed()
|
|
|
|
# Modify service state if necessary
|
|
(rc, out, err) = service.modify_service_state()
|
|
|
|
if rc != 0:
|
|
if err and "Job is already running" in err:
|
|
# upstart got confused, one such possibility is MySQL on Ubuntu 12.04
|
|
# where status may report it has no start/stop links and we could
|
|
# not get accurate status
|
|
pass
|
|
else:
|
|
if err:
|
|
module.fail_json(msg=err)
|
|
else:
|
|
module.fail_json(msg=out)
|
|
|
|
result['changed'] = service.changed | service.svc_change
|
|
if service.module.params['enabled'] is not None:
|
|
result['enabled'] = service.module.params['enabled']
|
|
|
|
if not service.module.params['state']:
|
|
status = service.get_service_status()
|
|
if status is None:
|
|
result['state'] = 'absent'
|
|
elif status is False:
|
|
result['state'] = 'started'
|
|
else:
|
|
result['state'] = 'stopped'
|
|
else:
|
|
# as we may have just bounced the service the service command may not
|
|
# report accurate state at this moment so just show what we ran
|
|
if service.module.params['state'] in ['reloaded', 'restarted', 'started']:
|
|
result['state'] = 'started'
|
|
else:
|
|
result['state'] = 'stopped'
|
|
|
|
module.exit_json(**result)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|