diff options
Diffstat (limited to 'v1/ansible/utils/module_docs_fragments/files.py')
-rw-r--r-- | v1/ansible/utils/module_docs_fragments/files.py | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/v1/ansible/utils/module_docs_fragments/files.py b/v1/ansible/utils/module_docs_fragments/files.py new file mode 100644 index 0000000000..adff1f2f1b --- /dev/null +++ b/v1/ansible/utils/module_docs_fragments/files.py @@ -0,0 +1,78 @@ +# (c) 2014, Matt Martz <matt@sivel.net> +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see <http://www.gnu.org/licenses/>. + + +class ModuleDocFragment(object): + + # Standard files documentation fragment + DOCUMENTATION = """ +options: + mode: + required: false + default: null + choices: [] + description: + - mode the file or directory should be, such as 0644 as would be fed to I(chmod). As of version 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or C(u=rw,g=r,o=r)). + owner: + required: false + default: null + choices: [] + description: + - name of the user that should own the file/directory, as would be fed to I(chown) + group: + required: false + default: null + choices: [] + description: + - name of the group that should own the file/directory, as would be fed to I(chown) + seuser: + required: false + default: null + choices: [] + description: + - user part of SELinux file context. Will default to system policy, if + applicable. If set to C(_default), it will use the C(user) portion of the + policy if available + serole: + required: false + default: null + choices: [] + description: + - role part of SELinux file context, C(_default) feature works as for I(seuser). + setype: + required: false + default: null + choices: [] + description: + - type part of SELinux file context, C(_default) feature works as for I(seuser). + selevel: + required: false + default: "s0" + choices: [] + description: + - level part of the SELinux file context. This is the MLS/MCS attribute, + sometimes known as the C(range). C(_default) feature works as for + I(seuser). + follow: + required: false + default: "no" + choices: [ "yes", "no" ] + version_added: "1.8" + description: + - 'This flag indicates that filesystem links, if they exist, should be followed.' + +""" |