Class: Chef::Resource::Group

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

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, #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, #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=, #defined_at, #delayed_action, #delayed_notifications, #events, from_hash, from_json, #guard_interpreter, #identity, identity_attr, identity_property, #ignore_failure, #immediate_notifications, inherited, #inspect, 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, #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=, #resources, #retries, #retry_delay, #run_action, #sensitive, #should_skip?, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #to_hash, #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_is_set?, #reset_property

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #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 DSL::PlatformIntrospection

#docker?, #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?

Constructor Details

#initialize(name, run_context = nil) ⇒ Group

Returns a new instance of Group



31
32
33
34
35
36
37
38
39
# File 'lib/chef/resource/group.rb', line 31

def initialize(name, run_context = nil)
  super
  @group_name = name
  @gid = nil
  @members = []
  @excluded_members = []
  @append = false
  @non_unique = false
end

Dynamic Method Handling

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

Instance Method Details

#append(arg = nil) ⇒ Object



77
78
79
80
81
82
83
# File 'lib/chef/resource/group.rb', line 77

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

#excluded_members(arg = nil) ⇒ Object



68
69
70
71
72
73
74
75
# File 'lib/chef/resource/group.rb', line 68

def excluded_members(arg = nil)
  converted_members = arg.is_a?(String) ? arg.split(",") : arg
  set_or_return(
    :excluded_members,
    converted_members,
    :kind_of => [ Array ]
  )
end

#gid(arg = nil) ⇒ Object



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

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

#group_name(arg = nil) ⇒ Object



41
42
43
44
45
46
47
# File 'lib/chef/resource/group.rb', line 41

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

#members(arg = nil) ⇒ Object Also known as: users



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

def members(arg = nil)
  converted_members = arg.is_a?(String) ? arg.split(",") : arg
  set_or_return(
    :members,
    converted_members,
    :kind_of => [ Array ]
  )
end

#non_unique(arg = nil) ⇒ Object



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

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

#system(arg = nil) ⇒ Object



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

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