Class: Chef::Resource::User

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

Instance Attribute Summary

Attributes inherited from Chef::Resource

#actions, #allowed_actions, #collection, #cookbook_name, #enclosing_provider, #node, #params, #provider, #recipe_name, #resource_name, #source_line, #updated

Instance Method Summary collapse

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, #supports, #to_hash, #to_json, #to_s

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string

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, collection = nil, node = 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
 
# File 'lib/chef/resource/user.rb', line 25

def initialize(name, collection=nil, node=nil)
  super(name, collection, node)
  @resource_name = :user
  @username = name
  @comment = nil
  @uid = nil
  @gid = nil
  @home = nil
  @shell = nil
  @password = nil
  @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 



51
52
53
54
55
56
57
 
# File 'lib/chef/resource/user.rb', line 51

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

#gid(arg = nil) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/chef/resource/user.rb', line 67

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

#home(arg = nil) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/chef/resource/user.rb', line 75

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

#password(arg = nil) ⇒ Object 



91
92
93
94
95
96
97
 
# File 'lib/chef/resource/user.rb', line 91

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

#shell(arg = nil) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/chef/resource/user.rb', line 83

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

#uid(arg = nil) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/chef/resource/user.rb', line 59

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

#username(arg = nil) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/chef/resource/user.rb', line 43

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