falc/robo-system-service

Robo tasks related to system service management.

Robo System Service Tasks

, _(*1)

Collection of tasks for interacting with system service managers., _(*2)

Requirements

• Robo ~0.5 (0.5.0 or higher)

Installation

Add the falc/robo-system-service package to your composer.json:, _(*3)

composer require falc/robo-system-service

Add the Falc\Robo\Service\loadTasks trait to your RoboFile:, _(*4)

class RoboFile extends \Robo\Tasks
{
    use Falc\Robo\Service\loadTasks;

    // ...
}

Tasks

Start

Starting a service:, _(*5)

``` php $this->taskServiceStart() ->serviceManager('systemd') ->service('service1') ->run();, <sub>(*6)</sub>

Compact form:

$this->taskServiceStart('systemd', 'service1')->run();, <sub>(*7)</sub>

You can combine it with `taskSshExec()` to start services in a remote server:

```php
$startTask = $this->taskServiceStart()
    ->serviceManager('systemd')
    ->service('service1');

$this->taskSshExec('remote.example.com')
    ->remoteDir('/home/user')
    ->printed(false) // Do not display output
    ->exec($startTask)
    ->run();

Stop

Stopping a service:, <sub>(*8)</sub>

``` php $this->taskServiceStop() ->serviceManager('systemd') ->service('service1') ->run();, <sub>(*9)</sub>

Compact form:

$this->taskServiceStop('systemd', 'service1')->run();, <sub>(*10)</sub>

You can combine it with `taskSshExec()` to stop services in a remote server:

```php
$stopTask = $this->taskServiceStop()
    ->serviceManager('systemd')
    ->service('service1');

$this->taskSshExec('remote.example.com')
    ->remoteDir('/home/user')
    ->printed(false) // Do not display output
    ->exec($stopTask)
    ->run();

Restart

Restarting a service:, <sub>(*11)</sub>

``` php $this->taskServiceRestart() ->serviceManager('systemd') ->service('service1') ->run();, <sub>(*12)</sub>

Compact form:

$this->taskServiceRestart('systemd', 'service1')->run();, <sub>(*13)</sub>

You can combine it with `taskSshExec()` to restart services in a remote server:

```php
$restartTask = $this->taskServiceRestart()
    ->serviceManager('systemd')
    ->service('service1');

$this->taskSshExec('remote.example.com')
    ->remoteDir('/home/user')
    ->printed(false) // Do not display output
    ->exec($restartTask)
    ->run();

Reload

Reloading a service:, <sub>(*14)</sub>

``` php $this->taskServiceReload() ->serviceManager('systemd') ->service('service1') ->run();, <sub>(*15)</sub>

Compact form:

$this->taskServiceReload('systemd', 'service1')->run();, <sub>(*16)</sub>

You can combine it with `taskSshExec()` to reload services in a remote server:

```php
$reloadTask = $this->taskServiceReload()
    ->serviceManager('systemd')
    ->service('service1');

$this->taskSshExec('remote.example.com')
    ->remoteDir('/home/user')
    ->printed(false) // Do not display output
    ->exec($reloadTask)
    ->run();

Enable

Enabling a service:, <sub>(*17)</sub>

``` php $this->taskServiceEnable() ->serviceManager('systemd') ->service('service1') ->run();, <sub>(*18)</sub>

Compact form:

$this->taskServiceEnable('systemd', 'service1')->run();, <sub>(*19)</sub>

You can combine it with `taskSshExec()` to enable services in a remote server:

```php
$enableTask = $this->taskServiceEnable()
    ->serviceManager('systemd')
    ->service('service1');

$this->taskSshExec('remote.example.com')
    ->remoteDir('/home/user')
    ->printed(false) // Do not display output
    ->exec($enableTask)
    ->run();

Disable

Disabling a service:, <sub>(*20)</sub>

``` php $this->taskServiceDisable() ->serviceManager('systemd') ->service('service1') ->run();, <sub>(*21)</sub>

Compact form:

$this->taskServiceDisable('systemd', 'service1')->run();, <sub>(*22)</sub>

You can combine it with `taskSshExec()` to disable services in a remote server:

```php
$disableTask = $this->taskServiceDisable()
    ->serviceManager('systemd')
    ->service('service1');

$this->taskSshExec('remote.example.com')
    ->remoteDir('/home/user')
    ->printed(false) // Do not display output
    ->exec($disableTask)
    ->run();

Daemon reload

This task is supported only for systemd., <sub>(*23)</sub>

``` php $this->taskServiceDaemonReload() ->serviceManager('systemd') ->run();, <sub>(*24)</sub>

Compact form:

$this->taskServiceDaemonReload('systemd')->run();, <sub>(*25)</sub>

You can combine it with `taskSshExec()` to reload systemd manager configuration in a remote server:

```php
$daemonReloadTask = $this->taskServiceDaemonReload()
    ->serviceManager('systemd');

$this->taskSshExec('remote.example.com')
    ->remoteDir('/home/user')
    ->printed(false) // Do not display output
    ->exec($daemonReloadTask)
    ->run();

Methods

All the tasks implement these methods: * serviceManager($serviceManager): Sets the service manager to use. * service(): Sets the service to manage. * verbose(): Enables the verbose mode., <sub>(*26)</sub>

Service managers

Every task requires to set a service manager either in the constructor or using the serviceManager($serviceManager) method., <sub>(*27)</sub>

At the moment these are the supported service managers: * systemd * SysVinit, <sub>(*28)</sub>