Class: Ansible::Ruby::Modules::Acl

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

Overview

Sets and retrieves file ACL information.

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

#default ⇒ Boolean?

Returns if the target is a directory, setting this to yes will make it the default acl for entities created inside the directory. It causes an error if name is a file.

Returns:

  • (Boolean, nil) —

    if the target is a directory, setting this to yes will make it the default acl for entities created inside the directory. It causes an error if name is a file.



23
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 23

attribute :default

#entity ⇒ String?

Returns actual user or group that the ACL applies to when matching entity types user or group are selected.

Returns:

  • (String, nil) —

    actual user or group that the ACL applies to when matching entity types user or group are selected.



27
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 27

attribute :entity

#entry ⇒ String?

Returns DEPRECATED. The acl to set or remove. This must always be quoted in the form of ‘<etype>:<qualifier>:<perms>’. The qualifier may be empty for some types, but the type and perms are always requried. ‘-’ can be used as placeholder when you do not care about permissions. This is now superseded by entity, type and permissions fields.

Returns:

  • (String, nil) —

    DEPRECATED. The acl to set or remove. This must always be quoted in the form of ‘<etype>:<qualifier>:<perms>’. The qualifier may be empty for some types, but the type and perms are always requried. ‘-’ can be used as placeholder when you do not care about permissions. This is now superseded by entity, type and permissions fields.



39
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 39

attribute :entry

#etype ⇒ :user, ...

Returns the entity type of the ACL to apply, see setfacl documentation for more info.

Returns:

  • (:user, :group, :mask, :other, nil) —

    the entity type of the ACL to apply, see setfacl documentation for more info.



31
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 31

attribute :etype

#follow ⇒ Boolean?

Returns whether to follow symlinks on the path if a symlink is encountered.

Returns:

  • (Boolean, nil) —

    whether to follow symlinks on the path if a symlink is encountered.



19
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 19

attribute :follow

#name ⇒ String

Returns The full path of the file or object.

Returns:

  • (String) —

    The full path of the file or object.



11
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 11

attribute :name

#permissions ⇒ String?

Returns Permissions to apply/remove can be any combination of r, w and x (read, write and execute respectively).

Returns:

  • (String, nil) —

    Permissions to apply/remove can be any combination of r, w and x (read, write and execute respectively)



35
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 35

attribute :permissions

#recursive ⇒ Boolean?

Returns Recursively sets the specified ACL (added in Ansible 2.0). Incompatible with C(state=query).

Returns:

  • (Boolean, nil) —

    Recursively sets the specified ACL (added in Ansible 2.0). Incompatible with C(state=query).



43
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 43

attribute :recursive

#state ⇒ :query, ...

Returns defines whether the ACL should be present or not. The C(query) state gets the current acl without changing it, for use in ‘register’ operations.

Returns:

  • (:query, :present, :absent, nil) —

    defines whether the ACL should be present or not. The C(query) state gets the current acl without changing it, for use in ‘register’ operations.



15
 
# File 'lib/ansible/ruby/modules/generated/core/files/acl.rb', line 15

attribute :state