tower: Clean up parameter types (#52522)
This PR includes: - Parameter types added - Copyright format fixes - Short license statement This breaks out PR #52182pull/4420/head
parent
e7df487a6c
commit
5ee378430b
|
@ -1,54 +1,45 @@
|
||||||
# (c) 2017, Wayne Witzel III <wayne@riotousliving.com>
|
# -*- coding: utf-8 -*-
|
||||||
#
|
|
||||||
# This file is part of Ansible
|
# Copyright: (c) 2017, Wayne Witzel III <wayne@riotousliving.com>
|
||||||
#
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
# 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/>.
|
|
||||||
#
|
|
||||||
|
|
||||||
|
|
||||||
class ModuleDocFragment(object):
|
class ModuleDocFragment(object):
|
||||||
|
|
||||||
# Ansible Tower documentation fragment
|
# Ansible Tower documentation fragment
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = r'''
|
||||||
options:
|
options:
|
||||||
tower_host:
|
tower_host:
|
||||||
description:
|
description:
|
||||||
- URL to your Tower instance.
|
- URL to your Tower instance.
|
||||||
tower_username:
|
type: str
|
||||||
description:
|
tower_username:
|
||||||
- Username for your Tower instance.
|
description:
|
||||||
tower_password:
|
- Username for your Tower instance.
|
||||||
description:
|
type: str
|
||||||
- Password for your Tower instance.
|
tower_password:
|
||||||
tower_verify_ssl:
|
description:
|
||||||
description:
|
- Password for your Tower instance.
|
||||||
- Dis/allow insecure connections to Tower. If C(no), SSL certificates will not be validated.
|
type: str
|
||||||
This should only be used on personally controlled sites using self-signed certificates.
|
tower_verify_ssl:
|
||||||
type: bool
|
description:
|
||||||
tower_config_file:
|
- Whether to allow insecure connections to Tower.
|
||||||
description:
|
- If C(no), SSL certificates will not be validated.
|
||||||
- Path to the Tower config file. See notes.
|
- This should only be used on personally controlled sites using self-signed certificates.
|
||||||
|
type: bool
|
||||||
|
tower_config_file:
|
||||||
|
description:
|
||||||
|
- Path to the Tower config file.
|
||||||
|
type: path
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "ansible-tower-cli >= 3.0.2"
|
- ansible-tower-cli >= 3.0.2
|
||||||
|
|
||||||
notes:
|
notes:
|
||||||
- If no I(config_file) is provided we will attempt to use the tower-cli library
|
- If no I(config_file) is provided we will attempt to use the tower-cli library
|
||||||
defaults to find your Tower host information.
|
defaults to find your Tower host information.
|
||||||
- I(config_file) should contain Tower configuration in the following format
|
- I(config_file) should contain Tower configuration in the following format
|
||||||
host=hostname
|
host=hostname
|
||||||
username=username
|
username=username
|
||||||
password=password
|
password=password
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in New Issue