diff options
Diffstat (limited to 'lib/ansible/utils/module_docs_fragments/inventory_cache.py')
-rw-r--r-- | lib/ansible/utils/module_docs_fragments/inventory_cache.py | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/lib/ansible/utils/module_docs_fragments/inventory_cache.py b/lib/ansible/utils/module_docs_fragments/inventory_cache.py new file mode 100644 index 0000000000..784f899ad7 --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/inventory_cache.py @@ -0,0 +1,46 @@ +# (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): + + # inventory cache + DOCUMENTATION = """ +options: + cache: + description: + - Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. + type: boolean + default: False + env: + - name: ANSIBLE_INVENTORY_CACHE + ini: + - section: inventory + key: cache + cache_plugin: + description: + - Cache plugin to use for the inventory's source data. + env: + - name: ANSIBLE_INVENTORY_CACHE_PLUGIN + ini: + - section: inventory + key: cache_plugin + cache_timeout: + description: + - Cache duration in seconds + default: 3600 + type: integer + env: + - name: ANSIBLE_INVENTORY_CACHE_TIMEOUT + ini: + - section: inventory + key: cache_timeout + cache_connection: + description: + - Cache connection data or path, read cache plugin documentation for specifics. + env: + - name: ANSIBLE_INVENTORY_CACHE_CONNECTION + ini: + - section: inventory + key: cache_connection +""" |