xattr - set/retrieve extended attributes

Author:Brian Coca

Synopsis

New in version 1.3.

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

Options

parameter required default choices comments
follow no True
  • yes
  • no
if yes, dereferences symlinks and sets/gets attributes on symlink target, otherwise acts on symlink itself.
key no None
    The name of a specific Extended attribute key to set/retrieve
    name yes None
      The full path of the file/object to get the facts of
      state no get
      • read
      • present
      • all
      • keys
      • absent
      defines which state you want to do. read retrieves the current value for a key (default) present sets name to value, default if value is set all dumps all data keys retrieves all keys absent deletes the key
      value no None
        The value to set the named name/key to, it automatically sets the state to 'set'

        Examples


        # Obtain the extended attributes  of /etc/foo.conf
        - xattr: name=/etc/foo.conf
        
        # Sets the key 'foo' to value 'bar'
        - xattr: path=/etc/foo.conf key=user.foo value=bar
        
        # Removes the key 'foo'
        - xattr: name=/etc/foo.conf key=user.foo state=absent
        

        Table Of Contents

        Previous topic

        unarchive - Copies an archive to a remote location and unpack it

        Next topic

        Internal Modules