From 748c9acba7f2a97463e80544817d6e285f75e49a Mon Sep 17 00:00:00 2001 From: getjack Date: Tue, 12 Feb 2019 13:12:57 +0100 Subject: [PATCH] - Initial commit (#51731) - Fix sanity checks - Fixed documentation trailing whitespaces --- .../sophos_utm/utm_ca_host_key_cert_info.py | 106 ++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 lib/ansible/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py diff --git a/lib/ansible/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py b/lib/ansible/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py new file mode 100644 index 0000000000..49b638a61d --- /dev/null +++ b/lib/ansible/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py @@ -0,0 +1,106 @@ +#!/usr/bin/python + +# Copyright: (c) 2018, Stephan Schwarz +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +ANSIBLE_METADATA = { + 'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'community' +} + +DOCUMENTATION = """ +--- +module: utm_ca_host_key_cert_info + +author: + - Stephan Schwarz (@stearz) + +short_description: Get info for a ca host_key_cert entry in Sophos UTM + +description: + - Get info for a ca host_key_cert entry in SOPHOS UTM. + +version_added: "2.8" + +options: + name: + description: + - The name of the object. Will be used to identify the entry + required: true + +extends_documentation_fragment: + - utm +""" + +EXAMPLES = """ +- name: utm ca_host_key_cert_info + utm_ca_host_key_cert_info: + utm_host: sophos.host.name + utm_token: abcdefghijklmno1234 + name: TestHostKeyCertEntry +""" + +RETURN = """ +result: + description: The utm object that was created + returned: success + type: complex + contains: + _ref: + description: The reference name of the object + type: string + _locked: + description: Whether or not the object is currently locked + type: boolean + _type: + description: The type of the object + type: string + name: + description: The name of the object + type: string + ca: + description: A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object. + type: string + meta: + description: A reference to an existing utm_ca_meta_x509 object. + type: string + certificate: + description: The certificate in PEM format + type: string + comment: + description: Comment string (may be empty string) + type: string + encrypted: + description: If encryption is enabled + type: bool + key: + description: Private key in PEM format (may be empty string) + type: string +""" + +from ansible.module_utils.utm_utils import UTM, UTMModule +from ansible.module_utils._text import to_native + + +def main(): + endpoint = "ca/host_key_cert" + key_to_check_for_changes = [] + module = UTMModule( + argument_spec=dict( + name=dict(type='str', required=True) + ) + ) + try: + # This is needed because the bool value only accepts int values in the backend + UTM(module, endpoint, key_to_check_for_changes, info_only=True).execute() + except Exception as e: + module.fail_json(msg=to_native(e)) + + +if __name__ == '__main__': + main()