Class: Chef::Resource::User

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/user.rb

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #delayed_notifications, #enclosing_provider, #immediate_notifications, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #add_notification, attribute, build_from_file, #defined_at, #epic_fail, #ignore_failure, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #resolve_notification_references, #resources, #run_action, #should_skip?, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, run_context = nil) ⇒ User

Returns a new instance of User.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/chef/resource/user.rb', line 25

def initialize(name, run_context=nil)
  super
  @resource_name = :user
  @username = name
  @comment = nil
  @uid = nil
  @gid = nil
  @home = nil
  @shell = nil
  @password = nil
  @system = false
  @manage_home = false
  @non_unique = false
  @action = :create
  @supports = { 
    :manage_home => false,
    :non_unique => false
  }
  @allowed_actions.push(:create, :remove, :modify, :manage, :lock, :unlock)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#comment(arg = nil) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/chef/resource/user.rb', line 54

def comment(arg=nil)
  set_or_return(
    :comment,
    arg,
    :kind_of => [ String ]
  )
end

#gid(arg = nil) ⇒ Object Also known as: group 



70
71
72
73
74
75
76
 
# File 'lib/chef/resource/user.rb', line 70

def gid(arg=nil)
  set_or_return(
    :gid,
    arg,
    :kind_of => [ String, Integer ]
  )
end

#home(arg = nil) ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/chef/resource/user.rb', line 80

def home(arg=nil)
  set_or_return(
    :home,
    arg,
    :kind_of => [ String ]
  )
end

#manage_home(arg = nil) ⇒ Object 



112
113
114
115
116
117
118
 
# File 'lib/chef/resource/user.rb', line 112

def manage_home(arg=nil)
  set_or_return(
    :manage_home,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#non_unique(arg = nil) ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/chef/resource/user.rb', line 120

def non_unique(arg=nil)
  set_or_return(
    :non_unique,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#password(arg = nil) ⇒ Object 



96
97
98
99
100
101
102
 
# File 'lib/chef/resource/user.rb', line 96

def password(arg=nil)
  set_or_return(
    :password,
    arg,
    :kind_of => [ String ]
  )
end

#shell(arg = nil) ⇒ Object 



88
89
90
91
92
93
94
 
# File 'lib/chef/resource/user.rb', line 88

def shell(arg=nil)
  set_or_return(
    :shell,
    arg,
    :kind_of => [ String ]
  )
end

#system(arg = nil) ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/chef/resource/user.rb', line 104

def system(arg=nil)
  set_or_return(
    :system,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#uid(arg = nil) ⇒ Object 



62
63
64
65
66
67
68
 
# File 'lib/chef/resource/user.rb', line 62

def uid(arg=nil)
  set_or_return(
    :uid,
    arg,
    :kind_of => [ String, Integer ]
  )
end

#username(arg = nil) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/chef/resource/user.rb', line 46

def username(arg=nil)
  set_or_return(
    :username,
    arg,
    :kind_of => [ String ]
  )
end