From afa84af91d605bf9786f3d2c31bbced2a8b6cd2f Mon Sep 17 00:00:00 2001 From: The Magician Date: Mon, 26 Aug 2019 10:28:28 -0700 Subject: [PATCH] New Module: gcp_kms_key_ring_info (#61099) --- .../cloud/google/gcp_kms_key_ring_info.py | 140 ++++++++++++++++++ 1 file changed, 140 insertions(+) create mode 100644 lib/ansible/modules/cloud/google/gcp_kms_key_ring_info.py diff --git a/lib/ansible/modules/cloud/google/gcp_kms_key_ring_info.py b/lib/ansible/modules/cloud/google/gcp_kms_key_ring_info.py new file mode 100644 index 00000000000..d2fcc59f3e7 --- /dev/null +++ b/lib/ansible/modules/cloud/google/gcp_kms_key_ring_info.py @@ -0,0 +1,140 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# +# Copyright (C) 2017 Google +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +# ---------------------------------------------------------------------------- +# +# *** AUTO GENERATED CODE *** AUTO GENERATED CODE *** +# +# ---------------------------------------------------------------------------- +# +# This file is automatically generated by Magic Modules and manual +# changes will be clobbered when the file is regenerated. +# +# Please read more about how to change this file at +# https://www.github.com/GoogleCloudPlatform/magic-modules +# +# ---------------------------------------------------------------------------- + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +################################################################################ +# Documentation +################################################################################ + +ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'} + +DOCUMENTATION = ''' +--- +module: gcp_kms_key_ring_info +description: +- Gather info for GCP KeyRing +short_description: Gather info for GCP KeyRing +version_added: 2.9 +author: Google Inc. (@googlecloudplatform) +requirements: +- python >= 2.6 +- requests >= 2.18.4 +- google-auth >= 1.3.0 +options: + location: + description: + - The location for the KeyRing. + - A full list of valid locations can be found by running `gcloud kms locations + list`. + required: true + type: str +extends_documentation_fragment: gcp +''' + +EXAMPLES = ''' +- name: get info on a key ring + gcp_kms_key_ring_info: + location: us-central1 + project: test_project + auth_kind: serviceaccount + service_account_file: "/tmp/auth.pem" +''' + +RETURN = ''' +resources: + description: List of resources + returned: always + type: complex + contains: + name: + description: + - The resource name for the KeyRing. + returned: success + type: str + creationTime: + description: + - The time that this resource was created on the server. + - This is in RFC3339 text format. + returned: success + type: str + location: + description: + - The location for the KeyRing. + - A full list of valid locations can be found by running `gcloud kms locations + list`. + returned: success + type: str +''' + +################################################################################ +# Imports +################################################################################ +from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest +import json + +################################################################################ +# Main +################################################################################ + + +def main(): + module = GcpModule(argument_spec=dict(location=dict(required=True, type='str'))) + + if not module.params['scopes']: + module.params['scopes'] = ['https://www.googleapis.com/auth/cloudkms'] + + return_value = {'resources': fetch_list(module, collection(module))} + module.exit_json(**return_value) + + +def collection(module): + return "https://cloudkms.googleapis.com/v1/projects/{project}/locations/{location}/keyRings".format(**module.params) + + +def fetch_list(module, link): + auth = GcpSession(module, 'kms') + return auth.list(link, return_if_object, array_name='keyRings') + + +def return_if_object(module, response): + # If not found, return nothing. + if response.status_code == 404: + return None + + # If no content, return nothing. + if response.status_code == 204: + return None + + try: + module.raise_for_status(response) + result = response.json() + except getattr(json.decoder, 'JSONDecodeError', ValueError) as inst: + module.fail_json(msg="Invalid JSON response with error: %s" % inst) + + if navigate_hash(result, ['error', 'errors']): + module.fail_json(msg=navigate_hash(result, ['error', 'errors'])) + + return result + + +if __name__ == "__main__": + main()