Class: Ansible::Ruby::Modules::Service

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/service.rb

Overview

Controls services on remote hosts. Supported init systems include BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart. For Windows targets, use the M(win_service) module instead.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#arguments ⇒ Object?

Returns Additional arguments provided on the command line.

Returns:

  • (Object, nil) —

    Additional arguments provided on the command line



36
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 36

attribute :arguments

#enabled ⇒ Symbol?

Returns Whether the service should start on boot. B(At least one of state and enabled are required.).

Returns:

  • (Symbol, nil) —

    Whether the service should start on boot. B(At least one of state and enabled are required.)



28
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 28

attribute :enabled

#name ⇒ String

Returns Name of the service.

Returns:

  • (String) —

    Name of the service.



13
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 13

attribute :name

#pattern ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



24
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 24

attribute :pattern

#runlevel ⇒ String?

Returns For OpenRC init scripts (ex: Gentoo) only. The runlevel that this service belongs to.

Returns:

  • (String, nil) —

    For OpenRC init scripts (ex: Gentoo) only. The runlevel that this service belongs to.



32
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 32

attribute :runlevel

#sleep ⇒ Object?

Returns If the service is being C(restarted) then sleep this many seconds between the stop and start command. This helps to workaround badly behaving init scripts that exit immediately after signaling a process to stop.

Returns:

  • (Object, nil) —

    If the service is being C(restarted) then sleep this many seconds between the stop and start command. This helps to workaround badly behaving init scripts that exit immediately after signaling a process to stop.



21
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 21

attribute :sleep

#state ⇒ :reloaded, ...

Returns 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.

Returns:

  • (:reloaded, :restarted, :started, :stopped, nil) —

    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.



17
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 17

attribute :state

#use ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



39
 
# File 'lib/ansible/ruby/modules/generated/system/service.rb', line 39

attribute :use