mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Add service option to avoid failure on missing service
This adds a must_exist option to the service module, which gives callers the ability to be tolerant to services that do not exist. This allows for opportunistic manipulation of a list of services if they happen to exist on the host. While failed_when could be used, it's difficult to track all the different error strings that might come from various service tools regarding a missing service.
This commit is contained in:
parent
af689dece3
commit
17aabee6df
1 changed files with 22 additions and 2 deletions
|
@ -72,6 +72,14 @@ options:
|
||||||
description:
|
description:
|
||||||
- Additional arguments provided on the command line
|
- Additional arguments provided on the command line
|
||||||
aliases: [ 'args' ]
|
aliases: [ 'args' ]
|
||||||
|
must_exist:
|
||||||
|
required: false
|
||||||
|
default: true
|
||||||
|
version_added: "1.9"
|
||||||
|
description:
|
||||||
|
- Avoid a module failure if the named service does not exist. Useful
|
||||||
|
for opportunistically starting/stopping/restarting a list of
|
||||||
|
potential services.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
@ -95,6 +103,9 @@ EXAMPLES = '''
|
||||||
|
|
||||||
# Example action to restart network service for interface eth0
|
# Example action to restart network service for interface eth0
|
||||||
- service: name=network state=restarted args=eth0
|
- service: name=network state=restarted args=eth0
|
||||||
|
|
||||||
|
# Example action to restart nova-compute if it exists
|
||||||
|
- service: name=nova-compute state=restarted must_exist=no
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import platform
|
import platform
|
||||||
|
@ -469,7 +480,11 @@ class LinuxService(Service):
|
||||||
self.enable_cmd = location['chkconfig']
|
self.enable_cmd = location['chkconfig']
|
||||||
|
|
||||||
if self.enable_cmd is None:
|
if self.enable_cmd is None:
|
||||||
|
if self.module.params['must_exist']:
|
||||||
self.module.fail_json(msg="no service or tool found for: %s" % self.name)
|
self.module.fail_json(msg="no service or tool found for: %s" % self.name)
|
||||||
|
else:
|
||||||
|
# exiting without change on non-existent service
|
||||||
|
self.module.exit_json(changed=False, exists=False)
|
||||||
|
|
||||||
# If no service control tool selected yet, try to see if 'service' is available
|
# 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):
|
if self.svc_cmd is None and location.get('service', False):
|
||||||
|
@ -477,7 +492,11 @@ class LinuxService(Service):
|
||||||
|
|
||||||
# couldn't find anything yet
|
# couldn't find anything yet
|
||||||
if self.svc_cmd is None and not self.svc_initscript:
|
if self.svc_cmd is None and not self.svc_initscript:
|
||||||
|
if self.module.params['must_exist']:
|
||||||
self.module.fail_json(msg='cannot find \'service\' binary or init script for service, possible typo in service name?, aborting')
|
self.module.fail_json(msg='cannot find \'service\' binary or init script for service, possible typo in service name?, aborting')
|
||||||
|
else:
|
||||||
|
# exiting without change on non-existent service
|
||||||
|
self.module.exit_json(changed=False, exists=False)
|
||||||
|
|
||||||
if location.get('initctl', False):
|
if location.get('initctl', False):
|
||||||
self.svc_initctl = location['initctl']
|
self.svc_initctl = location['initctl']
|
||||||
|
@ -1398,6 +1417,7 @@ def main():
|
||||||
enabled = dict(type='bool'),
|
enabled = dict(type='bool'),
|
||||||
runlevel = dict(required=False, default='default'),
|
runlevel = dict(required=False, default='default'),
|
||||||
arguments = dict(aliases=['args'], default=''),
|
arguments = dict(aliases=['args'], default=''),
|
||||||
|
must_exist = dict(type='bool', default=True),
|
||||||
),
|
),
|
||||||
supports_check_mode=True
|
supports_check_mode=True
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in a new issue