community.general.xattr module – Manage user defined extended attributes
Note
This module is part of the community.general collection (version 5.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.xattr
.
Synopsis
Manages filesystem user defined extended attributes.
Requires that extended attributes are enabled on the target filesystem and that the setfattr/getfattr utilities are present.
Parameters
Parameter |
Comments |
---|---|
If Choices:
|
|
The name of a specific Extended attribute key to set/retrieve. |
|
Namespace of the named name/key. Default: |
|
The full path of the file/object to get the facts of. Before 2.3 this option was only usable as name. |
|
defines which state you want to do. Choices:
|
|
The value to set the named name/key to, it automatically sets the state to |
Notes
Note
As of Ansible 2.3, the name option has been changed to path as default, but name still works as well.
Examples
- name: Obtain the extended attributes of /etc/foo.conf
community.general.xattr:
path: /etc/foo.conf
- name: Set the key 'user.foo' to value 'bar'
community.general.xattr:
path: /etc/foo.conf
key: foo
value: bar
- name: Set the key 'trusted.glusterfs.volume-id' to value '0x817b94343f164f199e5b573b4ea1f914'
community.general.xattr:
path: /mnt/bricks/brick1
namespace: trusted
key: glusterfs.volume-id
value: "0x817b94343f164f199e5b573b4ea1f914"
- name: Remove the key 'user.foo'
community.general.xattr:
path: /etc/foo.conf
key: foo
state: absent
- name: Remove the key 'trusted.glusterfs.volume-id'
community.general.xattr:
path: /mnt/bricks/brick1
namespace: trusted
key: glusterfs.volume-id
state: absent
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication