summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/general/plugins/modules/xattr.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/community/general/plugins/modules/xattr.py')
-rw-r--r--ansible_collections/community/general/plugins/modules/xattr.py17
1 files changed, 7 insertions, 10 deletions
diff --git a/ansible_collections/community/general/plugins/modules/xattr.py b/ansible_collections/community/general/plugins/modules/xattr.py
index 0b44fdaad..7a5f3b431 100644
--- a/ansible_collections/community/general/plugins/modules/xattr.py
+++ b/ansible_collections/community/general/plugins/modules/xattr.py
@@ -27,7 +27,6 @@ options:
path:
description:
- The full path of the file/object to get the facts of.
- - Before 2.3 this option was only usable as I(name).
type: path
required: true
aliases: [ name ]
@@ -42,27 +41,25 @@ options:
type: str
value:
description:
- - The value to set the named name/key to, it automatically sets the I(state) to C(present).
+ - The value to set the named name/key to, it automatically sets the O(state) to V(present).
type: str
state:
description:
- defines which state you want to do.
- C(read) retrieves the current value for a I(key) (default)
- C(present) sets I(path) to C(value), default if value is set
- C(all) dumps all data
- C(keys) retrieves all keys
- C(absent) deletes the key
+ V(read) retrieves the current value for a O(key) (default)
+ V(present) sets O(path) to O(value), default if value is set
+ V(all) dumps all data
+ V(keys) retrieves all keys
+ V(absent) deletes the key
type: str
choices: [ absent, all, keys, present, read ]
default: read
follow:
description:
- - If C(true), dereferences symlinks and sets/gets attributes on symlink target,
+ - If V(true), dereferences symlinks and sets/gets attributes on symlink target,
otherwise acts on symlink itself.
type: bool
default: true
-notes:
- - As of Ansible 2.3, the I(name) option has been changed to I(path) as default, but I(name) still works as well.
author:
- Brian Coca (@bcoca)
'''