Class: Chef::Resource::User

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/user.rb,
lib/chef/resource/user/pw_user.rb,
lib/chef/resource/user/aix_user.rb,
lib/chef/resource/user/dscl_user.rb,
lib/chef/resource/user/linux_user.rb,
lib/chef/resource/user/solaris_user.rb,
lib/chef/resource/user/windows_user.rb

Overview

Use the user resource to add users, update existing users, remove users, and to lock/unlock user passwords.

Direct Known Subclasses

AixUser, DsclUser, LinuxUser, PwUser, SolarisUser, WindowsUser

Defined Under Namespace

Classes: AixUser, DsclUser, LinuxUser, PwUser, SolarisUser, WindowsUser

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #declared_type, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #logger, #params, #recipe_name, #resource_initializing, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, action, #action=, action_class, #after_created, allowed_actions, allowed_actions=, #as_json, #before_notifications, chef_version_for_provides, #cookbook_version, #current_value, #current_value_does_not_exist!, #custom_exception_message, custom_resource?, #customize_exception, declare_action_class, #declared_key, default_action, default_action=, default_description, #defined_at, #delayed_action, #delayed_notifications, deprecated, description, #events, examples, from_hash, from_json, #guard_interpreter, #identity, identity_attr, identity_property, #ignore_failure, #immediate_notifications, inherited, #inspect, introduced, is_custom_resource!, json_create, load_current_value, #load_from, #lookup_provider_constant, #method_missing, #name, #node, #not_if, #notifies, #notifies_before, #notifies_delayed, #notifies_immediately, #only_if, preview_resource, #provider, #provider=, #provider_for_action, provides, provides?, remove_canonical_dsl, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resource_name, resource_name, resource_name=, #retries, #retry_delay, #run_action, #sensitive, #should_skip?, skip_docs, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #to_h, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, use_automatic_resource_name, #validate_action, #validate_resource_spec!, #value_to_text

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

descendants, #descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::Deprecation

#deprecated_attr, #deprecated_attr_reader, #deprecated_attr_writer, #deprecated_ivar

Methods included from Mixin::Properties

included, #property_description, #property_is_set?, #reset_property

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from Mixin::ShellOut

#a_to_s, apply_default_env, #clean_array, maybe_add_timeout, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from Mixin::PowershellExec

#powershell_exec

Methods included from DSL::PlatformIntrospection

#docker?, #older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #resources, #with_run_context

Constructor Details

#initialize(name, run_context = nil) ⇒ User

Returns a new instance of User



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/chef/resource/user.rb', line 33

def initialize(name, run_context = nil)
  super
  @username = name
  @comment = nil
  @uid = nil
  @gid = nil
  @home = nil
  @shell = nil
  @password = nil
  @system = false
  @manage_home = false
  @force = false
  @non_unique = false
  @iterations = 27855
  @salt = nil
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



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

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

#force(arg = nil) ⇒ Object



142
143
144
145
146
147
148
# File 'lib/chef/resource/user.rb', line 142

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

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



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

def gid(arg = Chef::NOT_PASSED)
  set_or_return(
    :gid,
    arg,
    kind_of: [ String, Integer, NilClass ],
    coerce: proc { |x| x || nil }
  )
end

#home(arg = nil) ⇒ Object



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

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

#iterations(arg = nil) ⇒ Object



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

def iterations(arg = nil)
  set_or_return(
    :iterations,
    arg,
    kind_of: [ Integer ]
  )
end

#manage_home(arg = nil) ⇒ Object



134
135
136
137
138
139
140
# File 'lib/chef/resource/user.rb', line 134

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

#non_unique(arg = nil) ⇒ Object



150
151
152
153
154
155
156
# File 'lib/chef/resource/user.rb', line 150

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

#password(arg = nil) ⇒ Object



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

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

#salt(arg = nil) ⇒ Object



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

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

#shell(arg = nil) ⇒ Object



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

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

#system(arg = nil) ⇒ Object



126
127
128
129
130
131
132
# File 'lib/chef/resource/user.rb', line 126

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

#uid(arg = Chef::NOT_PASSED) ⇒ Object



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

def uid(arg = Chef::NOT_PASSED)
  set_or_return(
    :uid,
    arg,
    kind_of: [ String, Integer, NilClass ],
    coerce: proc { |x| x || nil }
  )
end

#username(arg = nil) ⇒ Object



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

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