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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#default ⇒ :yes, ...

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 path is a file.

Returns:

  • (:yes, :no, 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 path is a file.



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

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.



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

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 required. ‘-’ 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 required. ‘-’ can be used as placeholder when you do not care about permissions. This is now superseded by entity, type and permissions fields.



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

attribute :entry

#etype ⇒ :group, ...

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

Returns:

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

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



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

attribute :etype

#follow ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :follow

#path ⇒ String

Returns The full path of the file or object.

Returns:

  • (String) —

    The full path of the file or object.



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

attribute :path

#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)



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

attribute :permissions

#recalculate_mask ⇒ :default, ...

Returns Select if and when to recalculate the effective right masks of the files, see setfacl documentation for more info. Incompatible with C(state=query).

Returns:

  • (:default, :mask, :no_mask, nil) —

    Select if and when to recalculate the effective right masks of the files, see setfacl documentation for more info. Incompatible with C(state=query).



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

attribute :recalculate_mask

#recursive ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :recursive

#state ⇒ :absent, ...

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:

  • (:absent, :present, :query, 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.



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

attribute :state