mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Move doc fragments back into file module.
This commit is contained in:
parent
b4b115cd13
commit
f24e335d0f
1 changed files with 43 additions and 0 deletions
|
@ -42,6 +42,49 @@ notes:
|
||||||
- See also M(copy), M(template), M(assemble)
|
- See also M(copy), M(template), M(assemble)
|
||||||
requirements: [ ]
|
requirements: [ ]
|
||||||
author: Michael DeHaan
|
author: Michael DeHaan
|
||||||
|
options:
|
||||||
|
path:
|
||||||
|
description:
|
||||||
|
- 'path to the file being managed. Aliases: I(dest), I(name)'
|
||||||
|
required: true
|
||||||
|
default: []
|
||||||
|
aliases: ['dest', 'name']
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- If C(directory), all immediate subdirectories will be created if they
|
||||||
|
do not exist, since 1.7 they will be created with the supplied permissions.
|
||||||
|
If C(file), the file will NOT be created if it does not exist, see the M(copy)
|
||||||
|
or M(template) module if you want that behavior. If C(link), the symbolic
|
||||||
|
link will be created or changed. Use C(hard) for hardlinks. If C(absent),
|
||||||
|
directories will be recursively deleted, and files or symlinks will be unlinked.
|
||||||
|
If C(touch) (new in 1.4), an empty file will be created if the c(path) does not
|
||||||
|
exist, while an existing file or directory will receive updated file access and
|
||||||
|
modification times (similar to the way `touch` works from the command line).
|
||||||
|
required: false
|
||||||
|
default: file
|
||||||
|
choices: [ file, link, directory, hard, touch, absent ]
|
||||||
|
src:
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
|
choices: []
|
||||||
|
description:
|
||||||
|
- path of the file to link to (applies only to C(state=link)). Will accept absolute,
|
||||||
|
relative and nonexisting paths. Relative paths are not expanded.
|
||||||
|
recurse:
|
||||||
|
required: false
|
||||||
|
default: "no"
|
||||||
|
choices: [ "yes", "no" ]
|
||||||
|
version_added: "1.1"
|
||||||
|
description:
|
||||||
|
- recursively set the specified file attributes (applies only to state=directory)
|
||||||
|
force:
|
||||||
|
required: false
|
||||||
|
default: "no"
|
||||||
|
choices: [ "yes", "no" ]
|
||||||
|
description:
|
||||||
|
- 'force the creation of the symlinks in two cases: the source file does
|
||||||
|
not exist (but will appear later); the destination exists and is a file (so, we need to unlink the
|
||||||
|
"path" file and create symlink to the "src" file in place of it).'
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
Loading…
Reference in a new issue