utm: Clean up parameter types (#52517)

This PR includes:
- Parameter types added
- Copyright format fixes
- Short license statement

This breaks out PR #52182
pull/52558/head
Dag Wieers 6 years ago committed by John R Barker
parent 5ee378430b
commit 409345ee97

@ -1,47 +1,51 @@
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com> # Copyright: (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
headers: headers:
description: description:
- A dictionary of additional headers to be sent to POST and PUT requests. - A dictionary of additional headers to be sent to POST and PUT requests.
- Is needed for some modules - Is needed for some modules
type: dict
required: false required: false
utm_host: utm_host:
description: description:
- The REST Endpoint of the Sophos UTM. - The REST Endpoint of the Sophos UTM.
type: str
required: true required: true
utm_port: utm_port:
description: description:
- The port of the REST interface. - The port of the REST interface.
type: int
default: 4444 default: 4444
utm_token: utm_token:
description: description:
- "The token used to identify at the REST-API. See U(https://www.sophos.com/en-us/medialibrary/\ - "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." PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2."
type: str
required: true required: true
utm_protocol: utm_protocol:
description: description:
- The protocol of the REST Endpoint. - The protocol of the REST Endpoint.
choices: choices: [ http, https ]
- https type: str
- http
default: https default: https
validate_certs: validate_certs:
description: description:
- Whether the REST interface's ssl certificate should be verified or not. - Whether the REST interface's ssl certificate should be verified or not.
default: True
type: bool type: bool
default: yes
state: state:
description: description:
- The desired state of the object. - The desired state of the object.
- C(present) will create or update an object - C(present) will create or update an object
- C(absent) will delete an object if it was present - C(absent) will delete an object if it was present
choices: type: str
- present choices: [ absent, present ]
- absent
default: present default: present
""" '''

Loading…
Cancel
Save