Class: Chef::Resource::Service
- Inherits:
-
Chef::Resource
- Object
- Chef::Resource
- Chef::Resource::Service
- Defined in:
- lib/chef/resource/service.rb
Instance Attribute Summary
Attributes inherited from Chef::Resource
#actions, #allowed_actions, #collection, #cookbook_name, #enclosing_provider, #node, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #source_line, #updated
Instance Method Summary collapse
-
#enabled(arg = nil) ⇒ Object
if the service is enabled or not.
-
#initialize(name, collection = nil, node = nil) ⇒ Service
constructor
A new instance of Service.
-
#pattern(arg = nil) ⇒ Object
regex for match against ps -ef when !supports && status == nil.
- #reload_command(arg = nil) ⇒ Object
-
#restart_command(arg = nil) ⇒ Object
command to call to restart service.
-
#running(arg = nil) ⇒ Object
if the service is running or not.
- #service_name(arg = nil) ⇒ Object
-
#start_command(arg = nil) ⇒ Object
command to call to start service.
-
#startup_type(arg = nil) ⇒ Object
This attribute applies for Windows only.
-
#status_command(arg = nil) ⇒ Object
command to call to get status of service.
-
#stop_command(arg = nil) ⇒ Object
command to call to stop service.
- #supports(args = {}) ⇒ Object
Methods inherited from Chef::Resource
#action, attribute, build_from_file, #epic_fail, #ignore_failure, #is, json_create, #load_prior_resource, #method_missing, #name, #noop, #not_if, #notifies, #only_if, provider_base, #resources, #run_action, #subscribes, #to_hash, #to_json, #to_s
Methods included from Mixin::ConvertToClassName
#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename
Methods included from Mixin::Language
#data_bag, #data_bag_item, #platform?, #search, #value_for_platform
Methods included from Mixin::ParamsValidate
Methods included from Mixin::CheckHelper
Constructor Details
#initialize(name, collection = nil, node = nil) ⇒ Service
Returns a new instance of Service.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/chef/resource/service.rb', line 25 def initialize(name, collection=nil, node=nil) super(name, collection, node) @resource_name = :service @service_name = name @enabled = nil @running = nil @pattern = service_name @start_command = nil @stop_command = nil @status_command = nil @restart_command = nil @reload_command = nil @action = "nothing" @startup_type = :automatic @supports = { :restart => false, :reload => false, :status => false } @allowed_actions.push(:enable, :disable, :start, :stop, :restart, :reload) end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Chef::Resource
Instance Method Details
#enabled(arg = nil) ⇒ Object
if the service is enabled or not
105 106 107 108 109 110 111 |
# File 'lib/chef/resource/service.rb', line 105 def enabled(arg=nil) set_or_return( :enabled, arg, :kind_of => [ TrueClass, FalseClass ] ) end |
#pattern(arg = nil) ⇒ Object
regex for match against ps -ef when !supports && status == nil
52 53 54 55 56 57 58 |
# File 'lib/chef/resource/service.rb', line 52 def pattern(arg=nil) set_or_return( :pattern, arg, :kind_of => [ String ] ) end |
#reload_command(arg = nil) ⇒ Object
96 97 98 99 100 101 102 |
# File 'lib/chef/resource/service.rb', line 96 def reload_command(arg=nil) set_or_return( :reload_command, arg, :kind_of => [ String ] ) end |
#restart_command(arg = nil) ⇒ Object
command to call to restart service
88 89 90 91 92 93 94 |
# File 'lib/chef/resource/service.rb', line 88 def restart_command(arg=nil) set_or_return( :restart_command, arg, :kind_of => [ String ] ) end |
#running(arg = nil) ⇒ Object
if the service is running or not
114 115 116 117 118 119 120 |
# File 'lib/chef/resource/service.rb', line 114 def running(arg=nil) set_or_return( :running, arg, :kind_of => [ TrueClass, FalseClass ] ) end |
#service_name(arg = nil) ⇒ Object
43 44 45 46 47 48 49 |
# File 'lib/chef/resource/service.rb', line 43 def service_name(arg=nil) set_or_return( :service_name, arg, :kind_of => [ String ] ) end |
#start_command(arg = nil) ⇒ Object
command to call to start service
61 62 63 64 65 66 67 |
# File 'lib/chef/resource/service.rb', line 61 def start_command(arg=nil) set_or_return( :start_command, arg, :kind_of => [ String ] ) end |
#startup_type(arg = nil) ⇒ Object
This attribute applies for Windows only.
133 134 135 136 137 138 139 |
# File 'lib/chef/resource/service.rb', line 133 def startup_type(arg=nil) set_or_return( :startup_type, arg, :equal_to => [:automatic, :mannual] ) end |
#status_command(arg = nil) ⇒ Object
command to call to get status of service
79 80 81 82 83 84 85 |
# File 'lib/chef/resource/service.rb', line 79 def status_command(arg=nil) set_or_return( :status_command, arg, :kind_of => [ String ] ) end |
#stop_command(arg = nil) ⇒ Object
command to call to stop service
70 71 72 73 74 75 76 |
# File 'lib/chef/resource/service.rb', line 70 def stop_command(arg=nil) set_or_return( :stop_command, arg, :kind_of => [ String ] ) end |
#supports(args = {}) ⇒ Object
122 123 124 125 126 127 128 129 130 |
# File 'lib/chef/resource/service.rb', line 122 def supports(args={}) if args.is_a? Array args.each { |arg| @supports[arg] = true } elsif args.any? @supports = args else @supports end end |