Class: Ansible::Ruby::Modules::Group

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/group.rb

Overview

Manage presence of groups on a host. For Windows targets, use the M(win_group) module instead.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#gid ⇒ Object?

Returns Optional I(GID) to set for the group.

Returns:

  • (Object, nil) —

    Optional I(GID) to set for the group.



17
 
# File 'lib/ansible/ruby/modules/generated/system/group.rb', line 17

attribute :gid

#local ⇒ String?

Returns Forces the use of “local” command alternatives on platforms that implement it. This is useful in environments that use centralized authentification when you want to manipulate the local groups. I.E. it uses ‘lgroupadd` instead of `useradd`.,This requires that these commands exist on the targeted host, otherwise it will be a fatal error.

Returns:

  • (String, nil) —

    Forces the use of “local” command alternatives on platforms that implement it. This is useful in environments that use centralized authentification when you want to manipulate the local groups. I.E. it uses ‘lgroupadd` instead of `useradd`.,This requires that these commands exist on the targeted host, otherwise it will be a fatal error.



28
 
# File 'lib/ansible/ruby/modules/generated/system/group.rb', line 28

attribute :local

#name ⇒ String

Returns Name of the group to manage.

Returns:

  • (String) —

    Name of the group to manage.



13
 
# File 'lib/ansible/ruby/modules/generated/system/group.rb', line 13

attribute :name

#state ⇒ :absent, ...

Returns Whether the group should be present or not on the remote host.

Returns:

  • (:absent, :present, nil) —

    Whether the group should be present or not on the remote host.



20
 
# File 'lib/ansible/ruby/modules/generated/system/group.rb', line 20

attribute :state

#system ⇒ :yes, ...

Returns If I(yes), indicates that the group created is a system group.

Returns:

  • (:yes, :no, nil) —

    If I(yes), indicates that the group created is a system group.



24
 
# File 'lib/ansible/ruby/modules/generated/system/group.rb', line 24

attribute :system