From 409345ee975ebf1bca27d32329b7a706de243957 Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Tue, 19 Feb 2019 13:19:32 +0100 Subject: [PATCH] utm: Clean up parameter types (#52517) This PR includes: - Parameter types added - Copyright format fixes - Short license statement This breaks out PR #52182 --- lib/ansible/plugins/doc_fragments/utm.py | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/lib/ansible/plugins/doc_fragments/utm.py b/lib/ansible/plugins/doc_fragments/utm.py index 92876f50b31..690fb5232e2 100644 --- a/lib/ansible/plugins/doc_fragments/utm.py +++ b/lib/ansible/plugins/doc_fragments/utm.py @@ -1,47 +1,51 @@ +# -*- coding: utf-8 -*- + # Copyright: (c) 2018, Johannes Brunswicker # 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: headers: description: - A dictionary of additional headers to be sent to POST and PUT requests. - Is needed for some modules + type: dict required: false utm_host: description: - The REST Endpoint of the Sophos UTM. + type: str required: true utm_port: description: - The port of the REST interface. + type: int default: 4444 utm_token: description: - "The token used to identify at the REST-API. See U(https://www.sophos.com/en-us/medialibrary/\ PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2." + type: str required: true utm_protocol: description: - The protocol of the REST Endpoint. - choices: - - https - - http + choices: [ http, https ] + type: str default: https validate_certs: description: - Whether the REST interface's ssl certificate should be verified or not. - default: True type: bool + default: yes state: description: - The desired state of the object. - C(present) will create or update an object - C(absent) will delete an object if it was present - choices: - - present - - absent + type: str + choices: [ absent, present ] default: present -""" +'''