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

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

Overview

Manage presence of groups on a host.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #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.



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

attribute :gid

#name ⇒ String

Returns Name of the group to manage.

Returns:

  • (String) —

    Name of the group to manage.



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

attribute :name

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, nil) —

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



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

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.



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

attribute :system