mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
260 lines
8.5 KiB
Python
260 lines
8.5 KiB
Python
|
#!/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
|
||
|
|
################################################################################
|
||
|
|
|
||
|
|
DOCUMENTATION = '''
|
||
|
|
---
|
||
|
|
module: gcp_compute_ssl_policy_info
|
||
|
|
description:
|
||
|
|
- Gather info for GCP SslPolicy
|
||
|
|
short_description: Gather info for GCP SslPolicy
|
||
|
|
author: Google Inc. (@googlecloudplatform)
|
||
|
|
requirements:
|
||
|
|
- python >= 2.6
|
||
|
|
- requests >= 2.18.4
|
||
|
|
- google-auth >= 1.3.0
|
||
|
|
options:
|
||
|
|
filters:
|
||
|
|
description:
|
||
|
|
- A list of filter value pairs. Available filters are listed here U(https://cloud.google.com/sdk/gcloud/reference/topic/filters).
|
||
|
|
- Each additional filter in the list will act be added as an AND condition (filter1
|
||
|
|
and filter2) .
|
||
|
|
type: list
|
||
|
|
project:
|
||
|
|
description:
|
||
|
|
- The Google Cloud Platform project to use.
|
||
|
|
type: str
|
||
|
|
auth_kind:
|
||
|
|
description:
|
||
|
|
- The type of credential used.
|
||
|
|
type: str
|
||
|
|
required: true
|
||
|
|
choices:
|
||
|
|
- application
|
||
|
|
- machineaccount
|
||
|
|
- serviceaccount
|
||
|
|
service_account_contents:
|
||
|
|
description:
|
||
|
|
- The contents of a Service Account JSON file, either in a dictionary or as a
|
||
|
|
JSON string that represents it.
|
||
|
|
type: jsonarg
|
||
|
|
service_account_file:
|
||
|
|
description:
|
||
|
|
- The path of a Service Account JSON file if serviceaccount is selected as type.
|
||
|
|
type: path
|
||
|
|
service_account_email:
|
||
|
|
description:
|
||
|
|
- An optional service account email address if machineaccount is selected and
|
||
|
|
the user does not wish to use the default email.
|
||
|
|
type: str
|
||
|
|
scopes:
|
||
|
|
description:
|
||
|
|
- Array of scopes to be used
|
||
|
|
type: list
|
||
|
|
env_type:
|
||
|
|
description:
|
||
|
|
- Specifies which Ansible environment you're running this module within.
|
||
|
|
- This should not be set unless you know what you're doing.
|
||
|
|
- This only alters the User Agent string for any API requests.
|
||
|
|
type: str
|
||
|
|
notes:
|
||
|
|
- for authentication, you can set service_account_file using the C(gcp_service_account_file)
|
||
|
|
env variable.
|
||
|
|
- for authentication, you can set service_account_contents using the C(GCP_SERVICE_ACCOUNT_CONTENTS)
|
||
|
|
env variable.
|
||
|
|
- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL)
|
||
|
|
env variable.
|
||
|
|
- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
|
||
|
|
- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
|
||
|
|
- Environment variables values will only be used if the playbook values are not set.
|
||
|
|
- The I(service_account_email) and I(service_account_file) options are mutually exclusive.
|
||
|
|
'''
|
||
|
|
|
||
|
|
EXAMPLES = '''
|
||
|
|
- name: get info on a SSL policy
|
||
|
|
gcp_compute_ssl_policy_info:
|
||
|
|
filters:
|
||
|
|
- name = test_object
|
||
|
|
project: test_project
|
||
|
|
auth_kind: serviceaccount
|
||
|
|
service_account_file: "/tmp/auth.pem"
|
||
|
|
'''
|
||
|
|
|
||
|
|
RETURN = '''
|
||
|
|
resources:
|
||
|
|
description: List of resources
|
||
|
|
returned: always
|
||
|
|
type: complex
|
||
|
|
contains:
|
||
|
|
creationTimestamp:
|
||
|
|
description:
|
||
|
|
- Creation timestamp in RFC3339 text format.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
description:
|
||
|
|
description:
|
||
|
|
- An optional description of this resource.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
id:
|
||
|
|
description:
|
||
|
|
- The unique identifier for the resource.
|
||
|
|
returned: success
|
||
|
|
type: int
|
||
|
|
name:
|
||
|
|
description:
|
||
|
|
- Name of the resource. Provided by the client when the resource is created.
|
||
|
|
The name must be 1-63 characters long, and comply with RFC1035. Specifically,
|
||
|
|
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||
|
|
which means the first character must be a lowercase letter, and all following
|
||
|
|
characters must be a dash, lowercase letter, or digit, except the last character,
|
||
|
|
which cannot be a dash.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
profile:
|
||
|
|
description:
|
||
|
|
- Profile specifies the set of SSL features that can be used by the load balancer
|
||
|
|
when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`,
|
||
|
|
`RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable
|
||
|
|
must be specified in the `customFeatures` field.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
minTlsVersion:
|
||
|
|
description:
|
||
|
|
- The minimum version of SSL protocol that can be used by the clients to establish
|
||
|
|
a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`,
|
||
|
|
`TLS_1_2`.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
enabledFeatures:
|
||
|
|
description:
|
||
|
|
- The list of features enabled in the SSL policy.
|
||
|
|
returned: success
|
||
|
|
type: list
|
||
|
|
customFeatures:
|
||
|
|
description:
|
||
|
|
- A list of features enabled when the selected profile is CUSTOM. The method
|
||
|
|
returns the set of features that can be specified in this list. This field
|
||
|
|
must be empty if the profile is not CUSTOM.
|
||
|
|
returned: success
|
||
|
|
type: list
|
||
|
|
fingerprint:
|
||
|
|
description:
|
||
|
|
- Fingerprint of this resource. A hash of the contents stored in this object.
|
||
|
|
This field is used in optimistic locking.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
warnings:
|
||
|
|
description:
|
||
|
|
- If potential misconfigurations are detected for this SSL policy, this field
|
||
|
|
will be populated with warning messages.
|
||
|
|
returned: success
|
||
|
|
type: complex
|
||
|
|
contains:
|
||
|
|
code:
|
||
|
|
description:
|
||
|
|
- A warning code, if applicable.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
message:
|
||
|
|
description:
|
||
|
|
- A human-readable description of the warning code.
|
||
|
|
returned: success
|
||
|
|
type: str
|
||
|
|
'''
|
||
|
|
|
||
|
|
################################################################################
|
||
|
|
# Imports
|
||
|
|
################################################################################
|
||
|
|
from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest
|
||
|
|
import json
|
||
|
|
|
||
|
|
################################################################################
|
||
|
|
# Main
|
||
|
|
################################################################################
|
||
|
|
|
||
|
|
|
||
|
|
def main():
|
||
|
|
module = GcpModule(argument_spec=dict(filters=dict(type='list', elements='str')))
|
||
|
|
|
||
|
|
if not module.params['scopes']:
|
||
|
|
module.params['scopes'] = ['https://www.googleapis.com/auth/compute']
|
||
|
|
|
||
|
|
return_value = {'resources': fetch_list(module, collection(module), query_options(module.params['filters']))}
|
||
|
|
module.exit_json(**return_value)
|
||
|
|
|
||
|
|
|
||
|
|
def collection(module):
|
||
|
|
return "https://www.googleapis.com/compute/v1/projects/{project}/global/sslPolicies".format(**module.params)
|
||
|
|
|
||
|
|
|
||
|
|
def fetch_list(module, link, query):
|
||
|
|
auth = GcpSession(module, 'compute')
|
||
|
|
return auth.list(link, return_if_object, array_name='items', params={'filter': query})
|
||
|
|
|
||
|
|
|
||
|
|
def query_options(filters):
|
||
|
|
if not filters:
|
||
|
|
return ''
|
||
|
|
|
||
|
|
if len(filters) == 1:
|
||
|
|
return filters[0]
|
||
|
|
else:
|
||
|
|
queries = []
|
||
|
|
for f in filters:
|
||
|
|
# For multiple queries, all queries should have ()
|
||
|
|
if f[0] != '(' and f[-1] != ')':
|
||
|
|
queries.append("(%s)" % ''.join(f))
|
||
|
|
else:
|
||
|
|
queries.append(f)
|
||
|
|
|
||
|
|
return ' '.join(queries)
|
||
|
|
|
||
|
|
|
||
|
|
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()
|