class AutomateIt::ServiceManager

ServiceManager

ServiceManager provides a way of managing services, such starting and stopping Unix daemons.

Public Instance Methods

disable(service, opts={}) click to toggle source

Don’t make this service start when the computer is rebooted, but only if it’s already enabled.

# File lib/automateit/service_manager.rb, line 70
def disable(service, opts={}) dispatch(service, opts) end
enable(service, opts={}) click to toggle source

Make this service start when the computer is rebooted, but only if it’s not already enabled.

# File lib/automateit/service_manager.rb, line 66
def enable(service, opts={}) dispatch(service, opts) end
enabled?(service) click to toggle source

Will this service start when the computer is rebooted?

# File lib/automateit/service_manager.rb, line 62
def enabled?(service) dispatch(service) end
restart(service, opts={}) click to toggle source

Restart this service if it’s running, or start it if it’s stopped.

Options:

  • :wait – Maxmimum seconds to wait for service to STOP.

  • :pause – Maximum seconds to wait for service to START before stopping it. Only set this if you just started the service and then decided to restart it.

# File lib/automateit/service_manager.rb, line 46
def restart(service, opts={}) dispatch(service, opts) end
running?(service, opts={}) click to toggle source

Alias for started?

# File lib/automateit/service_manager.rb, line 23
def running?(service, opts={}) dispatch_to(:started?, service, opts) end
start(service, opts={}) click to toggle source

Start this service if it’s not running.

Options:

  • :wait – Same as :wait option for started?

  • :force – Start service without checking if it’s running.

# File lib/automateit/service_manager.rb, line 30
def start(service, opts={}) dispatch(service, opts) end
start_and_enable(service, opts={}) click to toggle source

Start and enable the service using start and enable.

# File lib/automateit/service_manager.rb, line 56
def start_and_enable(service, opts={}) dispatch(service, opts) end
start_or_restart(service, is_restart, opts={}) click to toggle source

If is_restart, restart the service, otherwise start it.

Example:

modified = edit "/etc/myapp.conf" {#...}
service_manager.start_or_restart("myapp", modified)
# File lib/automateit/service_manager.rb, line 53
def start_or_restart(service, is_restart, opts={}) dispatch(service, is_restart, opts) end
started?(service, opts={}) click to toggle source

Is this service started?

Options:

  • :wait – Maximum number of seconds to wait until service starts. Useful when a service accepts a start and returns immediately before the service has finished starting.

# File lib/automateit/service_manager.rb, line 12
def started?(service, opts={}) dispatch(service, opts) end
stop(service, opts={}) click to toggle source

Stop this service if it’s running.

Options:

  • :wait – Same as :wait option for stopped?

  • :force – Stop service without checking if it’s running.

# File lib/automateit/service_manager.rb, line 37
def stop(service, opts={}) dispatch(service, opts) end
stopped?(service, opts={}) click to toggle source

Is this service stopped?

Options:

  • :wait – Maximum number of seconds to wait until service stops. Useful when a service accepts a stop and returns immediately while the service continues running for a few seconds.

# File lib/automateit/service_manager.rb, line 20
def stopped?(service, opts={}) dispatch(service, opts) end
tell(service, action, opts={}) click to toggle source

Tell the service to take a specific action, e.g., “condrestart”.

# File lib/automateit/service_manager.rb, line 59
def tell(service, action, opts={}) dispatch(service, action, opts={}) end