Class: Ansible::Ruby::Modules::Xattr

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

Overview

Manages filesystem user defined extended attributes, requires that they are enabled on the target filesystem and that the setfattr/getfattr utilities are present.

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

#follow ⇒ :yes, ...

Returns If C(yes), dereferences symlinks and sets/gets attributes on symlink target, otherwise acts on symlink itself.

Returns:

  • (:yes, :no, nil) —

    If C(yes), dereferences symlinks and sets/gets attributes on symlink target, otherwise acts on symlink itself.



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

attribute :follow

#key ⇒ String?

Returns The name of a specific Extended attribute key to set/retrieve.

Returns:

  • (String, nil) —

    The name of a specific Extended attribute key to set/retrieve.



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

attribute :key

#namespace ⇒ String?

Returns Namespace of the named name/key.

Returns:

  • (String, nil) —

    Namespace of the named name/key.



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

attribute :namespace

#path ⇒ String

Returns The full path of the file/object to get the facts of.,Before 2.3 this option was only usable as I(name).

Returns:

  • (String) —

    The full path of the file/object to get the facts of.,Before 2.3 this option was only usable as I(name).



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

attribute :path

#state ⇒ :absent, ...

Returns defines which state you want to do. C(read) retrieves the current value for a C(key) (default) C(present) sets C(name) to C(value), default if value is set C(all) dumps all data C(keys) retrieves all keys C(absent) deletes the key.

Returns:

  • (:absent, :all, :keys, :present, :read, nil) —

    defines which state you want to do. C(read) retrieves the current value for a C(key) (default) C(present) sets C(name) to C(value), default if value is set C(all) dumps all data C(keys) retrieves all keys C(absent) deletes the key



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

attribute :state

#value ⇒ String?

Returns The value to set the named name/key to, it automatically sets the C(state) to ‘set’.

Returns:

  • (String, nil) —

    The value to set the named name/key to, it automatically sets the C(state) to ‘set’.



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

attribute :value