GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  REX::COMMANDS::SERVICE (3)

.ds Aq ’

NAME

Rex::Commands::Service - Manage System Services

CONTENTS

DESCRIPTION

With this module you can manage Linux services.

SYNOPSIS



 use Rex::Commands::Service

 service apache2 => "start";

 service apache2 => "stop";

 service apache2 => "restart";

 service apache2 => "status";

 service apache2 => "reload";

 service apache2 => "ensure", "started";

 service apache2 => "ensure", "stopped";



EXPORTED FUNCTIONS

service($service, CW$action, [$option])

The service function accepts 2 parameters. The first is the service name and the second the action you want to perform.
starting a service


 task "start-service", "server01", sub {
   service apache2 => "start";
 };



stopping a service


 task "stop-service", "server01", sub {
   service apache2 => "stop";
 };



restarting a service


 task "restart-service", "server01", sub {
   service apache2 => "restart";
 };



checking status of a service


 task "status-service", "server01", sub {
   if( service apache2 => "status" ) {
     say "Apache2 is running";
   }
   else {
     say "Apache2 is not running";
   }
 };



reloading a service


 task "reload-service", "server01", sub {
   service apache2 => "reload";
 };



ensure that a service will started at boot time


 task "prepare", sub {
   service "apache2",
     ensure => "started";
 };



ensure that a service will NOT be started.


 task "prepare", sub {
   service "apache2",
     ensure => "stopped";
 };



If you need to define a custom command for start, stop, restart, reload or status you can do this with the corresponding options.



 task "prepare", sub {
   service "apache2",
     ensure  => "started",
     start   => "/usr/local/bin/httpd -f /etc/my/httpd.conf",
     stop    => "killall httpd",
     status  => "ps -efww | grep httpd",
     restart => "killall httpd && /usr/local/bin/httpd -f /etc/my/httpd.conf",
     reload  => "killall httpd && /usr/local/bin/httpd -f /etc/my/httpd.conf";
 };



This function supports the following hooks:
before_action For example: before_start, before_stop, before_restart

This gets executed right before the service action.

after_action For example: after_start, after_stop, after_restart

This gets executed right after the service action.

service_provider_for CW$os => CW$type;

To set another service provider as the default, use this function.



 user "root";

 group "db" => "db[01..10]";
 service_provider_for SunOS => "svcadm";

 task "start", group => "db", sub {
    service ssh => "restart";
 };



This example will restart the ssh service via svcadm (but only on SunOS, on other operating systems it will use the default).

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 REX::COMMANDS::SERVICE (3) 2016-03-07

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.