mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -07:00
d3be5d5327
* Fixes #18568 * Commit of the first set of utm modules * added documentation line for module_utils file * removed other utm modules for the first pr * added maintainers to botmeta * implemented fixes for shippable * fixed whitespaces and newlines in included doc fragment * added types and choices to documentation * fix for E501 * Implemented change requests * changed utm_utils license to BSD * changed str() to to_native() * added a status state that will just return information about my object * renamed state 'status' to 'info' * added team_e-spirit to botmeta and added the team as maintainer for the utm_utils * only return a result if the lookup was not empty. Do not return a null result * removed info state * added boilerplate * made preparation for info-only modules
44 lines
1.3 KiB
Python
44 lines
1.3 KiB
Python
# 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)
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
DOCUMENTATION = """
|
|
options:
|
|
utm_host:
|
|
description:
|
|
- The REST Endpoint of the Sophos UTM.
|
|
required: true
|
|
utm_port:
|
|
description:
|
|
- The port of the REST interface.
|
|
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."
|
|
required: true
|
|
utm_protocol:
|
|
description:
|
|
- The protocol of the REST Endpoint.
|
|
choices:
|
|
- https
|
|
- http
|
|
default: https
|
|
validate_certs:
|
|
description:
|
|
- Whether the REST interface's ssl certificate should be verified or not.
|
|
default: True
|
|
type: bool
|
|
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
|
|
- C(info) will return the object details
|
|
choices:
|
|
- present
|
|
- absent
|
|
- info
|
|
default: present
|
|
"""
|