1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/doc_fragments/utm.py

58 lines
1.7 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
# -*- coding: utf-8 -*-
# Copyright (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
2020-03-09 10:11:07 +01:00
class ModuleDocFragment(object):
DOCUMENTATION = r'''
options:
headers:
description:
- A dictionary of additional headers to be sent to POST and PUT requests.
- Is needed for some modules.
2020-03-09 10:11:07 +01:00
type: dict
required: false
2022-11-01 19:25:51 +01:00
default: {}
2020-03-09 10:11:07 +01:00
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."
2020-03-09 10:11:07 +01:00
type: str
required: true
utm_protocol:
description:
- The protocol of the REST Endpoint.
choices: [ http, https ]
type: str
default: https
validate_certs:
description:
- Whether the REST interface's ssl certificate should be verified or not.
type: bool
default: true
2020-03-09 10:11:07 +01:00
state:
description:
- The desired state of the object.
- V(present) will create or update an object.
- V(absent) will delete an object if it was present.
2020-03-09 10:11:07 +01:00
type: str
choices: [ absent, present ]
default: present
'''