diff options
Diffstat (limited to 'lib/ansible/plugins/doc_fragments/inventory_cache.py')
-rw-r--r-- | lib/ansible/plugins/doc_fragments/inventory_cache.py | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/lib/ansible/plugins/doc_fragments/inventory_cache.py b/lib/ansible/plugins/doc_fragments/inventory_cache.py new file mode 100644 index 0000000..9326c3f --- /dev/null +++ b/lib/ansible/plugins/doc_fragments/inventory_cache.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- + +# Copyright: (c) 2017, Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + + +class ModuleDocFragment(object): + + # inventory cache + DOCUMENTATION = r''' +options: + cache: + description: + - Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. + type: bool + default: no + env: + - name: ANSIBLE_INVENTORY_CACHE + ini: + - section: inventory + key: cache + cache_plugin: + description: + - Cache plugin to use for the inventory's source data. + type: str + default: memory + env: + - name: ANSIBLE_CACHE_PLUGIN + - name: ANSIBLE_INVENTORY_CACHE_PLUGIN + ini: + - section: defaults + key: fact_caching + - section: inventory + key: cache_plugin + cache_timeout: + description: + - Cache duration in seconds + default: 3600 + type: int + env: + - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT + - name: ANSIBLE_INVENTORY_CACHE_TIMEOUT + ini: + - section: defaults + key: fact_caching_timeout + - section: inventory + key: cache_timeout + cache_connection: + description: + - Cache connection data or path, read cache plugin documentation for specifics. + type: str + env: + - name: ANSIBLE_CACHE_PLUGIN_CONNECTION + - name: ANSIBLE_INVENTORY_CACHE_CONNECTION + ini: + - section: defaults + key: fact_caching_connection + - section: inventory + key: cache_connection + cache_prefix: + description: + - Prefix to use for cache plugin files/tables + default: ansible_inventory_ + env: + - name: ANSIBLE_CACHE_PLUGIN_PREFIX + - name: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX + ini: + - section: default + key: fact_caching_prefix + deprecated: + alternatives: Use the 'defaults' section instead + why: Fixes typing error in INI section name + version: '2.16' + - section: defaults + key: fact_caching_prefix + - section: inventory + key: cache_prefix +''' |