From 5ee378430b3a8e0e5d3e5558e4384c2343e476ec Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Tue, 19 Feb 2019 13:18:38 +0100 Subject: [PATCH] tower: Clean up parameter types (#52522) This PR includes: - Parameter types added - Copyright format fixes - Short license statement This breaks out PR #52182 --- lib/ansible/plugins/doc_fragments/tower.py | 77 ++++++++++------------ 1 file changed, 34 insertions(+), 43 deletions(-) diff --git a/lib/ansible/plugins/doc_fragments/tower.py b/lib/ansible/plugins/doc_fragments/tower.py index 9c5b07adf1c..3ab11c4b0f1 100644 --- a/lib/ansible/plugins/doc_fragments/tower.py +++ b/lib/ansible/plugins/doc_fragments/tower.py @@ -1,54 +1,45 @@ -# (c) 2017, Wayne Witzel III -# -# 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 . -# +# -*- coding: utf-8 -*- + +# Copyright: (c) 2017, Wayne Witzel III +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) class ModuleDocFragment(object): # Ansible Tower documentation fragment - DOCUMENTATION = ''' + DOCUMENTATION = r''' options: - tower_host: - description: - - URL to your Tower instance. - tower_username: - description: - - Username for your Tower instance. - tower_password: - description: - - Password for your Tower instance. - tower_verify_ssl: - description: - - Dis/allow insecure connections to Tower. If C(no), SSL certificates will not be validated. - 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. See notes. - + tower_host: + description: + - URL to your Tower instance. + type: str + tower_username: + description: + - Username for your Tower instance. + type: str + tower_password: + description: + - Password for your Tower instance. + type: str + tower_verify_ssl: + description: + - Whether to allow insecure connections to Tower. + - If C(no), SSL certificates will not be validated. + - 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: - - "ansible-tower-cli >= 3.0.2" +- ansible-tower-cli >= 3.0.2 notes: - - If no I(config_file) is provided we will attempt to use the tower-cli library - defaults to find your Tower host information. - - I(config_file) should contain Tower configuration in the following format - host=hostname - username=username - password=password +- If no I(config_file) is provided we will attempt to use the tower-cli library + defaults to find your Tower host information. +- I(config_file) should contain Tower configuration in the following format + host=hostname + username=username + password=password '''