mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
b151f5d942
These config settings are being deprecated so we don't want people to think they need to implement them for their new shell plugin.
58 lines
1.6 KiB
Python
58 lines
1.6 KiB
Python
# Copyright (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# common shelldocumentation fragment
|
|
DOCUMENTATION = """
|
|
options:
|
|
remote_temp:
|
|
description:
|
|
- Temporary directory to use on targets when executing tasks.
|
|
default: '~/.ansible/tmp'
|
|
env: [{name: ANSIBLE_REMOTE_TEMP}]
|
|
ini:
|
|
- section: defaults
|
|
key: remote_tmp
|
|
vars:
|
|
- name: ansible_remote_tmp
|
|
system_temps:
|
|
description:
|
|
- List of valid system temporary directories for Ansible to choose when it cannot use ``remote_temp``, normally due to permission issues.
|
|
default: [ /var/tmp, /tmp ]
|
|
type: list
|
|
env: [{name: ANSIBLE_SYSTEM_TMPS}]
|
|
ini:
|
|
- section: defaults
|
|
key: system_tmps
|
|
vars:
|
|
- name: ansible_system_tmps
|
|
async_dir:
|
|
description:
|
|
- Directory in which ansible will keep async job inforamtion
|
|
default: '~/.ansible_async'
|
|
env: [{name: ANSIBLE_ASYNC_DIR}]
|
|
ini:
|
|
- section: defaults
|
|
key: async_dir
|
|
vars:
|
|
- name: ansible_async_dir
|
|
environment:
|
|
type: dict
|
|
default: {}
|
|
description:
|
|
- dictionary of environment variables and their values to use when executing commands.
|
|
admin_users:
|
|
type: list
|
|
default: ['root', 'toor', 'admin']
|
|
description:
|
|
- list of users to be expected to have admin privileges, for BSD you might want to add 'toor' for windows 'Administrator'.
|
|
env:
|
|
- name: ANSIBLE_ADMIN_USERS
|
|
ini:
|
|
- section: defaults
|
|
key: admin_users
|
|
vars:
|
|
- name: ansible_admin_users
|
|
"""
|