mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 12:21:26 -07:00
doc_fragments: Clean up parameter types (other) (#52182)
This PR includes: - Parameter types added - Copyright format fixes - Short license statement
This commit is contained in:
parent
84ba41e0e1
commit
aa83307c68
8 changed files with 93 additions and 99 deletions
|
@ -1,17 +1,19 @@
|
|||
# (c) 2017 Ansible Project
|
||||
# -*- 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)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# inventory cache
|
||||
DOCUMENTATION = """
|
||||
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: boolean
|
||||
default: False
|
||||
type: bool
|
||||
default: no
|
||||
env:
|
||||
- name: ANSIBLE_INVENTORY_CACHE
|
||||
ini:
|
||||
|
@ -20,6 +22,7 @@ options:
|
|||
cache_plugin:
|
||||
description:
|
||||
- Cache plugin to use for the inventory's source data.
|
||||
type: str
|
||||
env:
|
||||
- name: ANSIBLE_INVENTORY_CACHE_PLUGIN
|
||||
ini:
|
||||
|
@ -29,7 +32,7 @@ options:
|
|||
description:
|
||||
- Cache duration in seconds
|
||||
default: 3600
|
||||
type: integer
|
||||
type: int
|
||||
env:
|
||||
- name: ANSIBLE_INVENTORY_CACHE_TIMEOUT
|
||||
ini:
|
||||
|
@ -38,9 +41,10 @@ options:
|
|||
cache_connection:
|
||||
description:
|
||||
- Cache connection data or path, read cache plugin documentation for specifics.
|
||||
type: str
|
||||
env:
|
||||
- name: ANSIBLE_INVENTORY_CACHE_CONNECTION
|
||||
ini:
|
||||
- section: inventory
|
||||
key: cache_connection
|
||||
"""
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue