mirror of https://github.com/ansible/ansible.git
doc_fragments: Clean up parameter types (other) (#52182)
This PR includes: - Parameter types added - Copyright format fixes - Short license statementpull/52605/head
Dag Wieers
5 years ago
committed by
Sandra McCann
parent
84ba41e0e1
commit
aa83307c68
@ -1,36 +1,28 @@
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard files documentation fragment
|
||||
DOCUMENTATION = """
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
api_url:
|
||||
description:
|
||||
- The resolvable endpoint for the API
|
||||
type: str
|
||||
api_username:
|
||||
description:
|
||||
- The username to use for authentication against the API
|
||||
type: str
|
||||
api_password:
|
||||
description:
|
||||
- The password to use for authentication against the API
|
||||
type: str
|
||||
validate_certs:
|
||||
description:
|
||||
- Whether or not to validate SSL certs when supplying a https endpoint.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
"""
|
||||
default: yes
|
||||
'''
|
||||
|
||||
@ -1,28 +1,30 @@
|
||||
# Copyright (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:
|
||||
strict:
|
||||
description:
|
||||
- If true make invalid entries a fatal error, otherwise skip and continue
|
||||
- If C(yes) make invalid entries a fatal error, otherwise skip and continue.
|
||||
- Since it is possible to use facts in the expressions they might not always be available
|
||||
and we ignore those errors by default.
|
||||
type: boolean
|
||||
default: False
|
||||
type: bool
|
||||
default: no
|
||||
compose:
|
||||
description: create vars from jinja2 expressions
|
||||
type: dictionary
|
||||
description: Create vars from jinja2 expressions.
|
||||
type: dict
|
||||
default: {}
|
||||
groups:
|
||||
description: add hosts to group based on Jinja2 conditionals
|
||||
type: dictionary
|
||||
description: Add hosts to group based on Jinja2 conditionals.
|
||||
type: dict
|
||||
default: {}
|
||||
keyed_groups:
|
||||
description: add hosts to group based on the values of a variable
|
||||
description: Add hosts to group based on the values of a variable.
|
||||
type: list
|
||||
default: []
|
||||
"""
|
||||
'''
|
||||
|
||||
@ -1,31 +1,18 @@
|
||||
# (c) 2017, Brian Coca <bcoca@redhat.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2017, Brian Coca <bcoca@redhat.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard files documentation fragment
|
||||
DOCUMENTATION = """
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
decrypt:
|
||||
description:
|
||||
- This option controls the autodecryption of source files using vault.
|
||||
required: false
|
||||
type: 'bool'
|
||||
default: 'yes'
|
||||
version_added: "2.4"
|
||||
"""
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '2.4'
|
||||
'''
|
||||
|
||||
@ -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…
Reference in New Issue