mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -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,51 +1,53 @@
|
|||
# (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):
|
||||
|
||||
DOCUMENTATION = """
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
display_skipped_hosts:
|
||||
name: Show skipped hosts
|
||||
description: "Toggle to control displaying skipped task/host results in a task"
|
||||
default: True
|
||||
type: bool
|
||||
default: yes
|
||||
env:
|
||||
- name: DISPLAY_SKIPPED_HOSTS
|
||||
ini:
|
||||
- key: display_skipped_hosts
|
||||
section: defaults
|
||||
type: boolean
|
||||
display_ok_hosts:
|
||||
name: Show 'ok' hosts
|
||||
description: "Toggle to control displaying 'ok' task/host results in a task"
|
||||
default: True
|
||||
type: bool
|
||||
default: yes
|
||||
env:
|
||||
- name: ANSIBLE_DISPLAY_OK_HOSTS
|
||||
ini:
|
||||
- key: display_ok_hosts
|
||||
section: defaults
|
||||
type: boolean
|
||||
version_added: '2.7'
|
||||
display_failed_stderr:
|
||||
name: Use STDERR for failed and unreachable tasks
|
||||
description: "Toggle to control whether failed and unreachable tasks are displayed to STDERR (vs. STDOUT)"
|
||||
default: False
|
||||
type: bool
|
||||
default: no
|
||||
env:
|
||||
- name: ANSIBLE_DISPLAY_FAILED_STDERR
|
||||
ini:
|
||||
- key: display_failed_stderr
|
||||
section: defaults
|
||||
type: boolean
|
||||
version_added: '2.7'
|
||||
show_custom_stats:
|
||||
name: Show custom stats
|
||||
description: 'This adds the custom stats set via the set_stats plugin to the play recap'
|
||||
default: False
|
||||
type: bool
|
||||
default: no
|
||||
env:
|
||||
- name: ANSIBLE_SHOW_CUSTOM_STATS
|
||||
ini:
|
||||
- key: show_custom_stats
|
||||
section: defaults
|
||||
type: bool
|
||||
"""
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue