mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-08 03:40:28 -07:00
284 lines
10 KiB
Python
284 lines
10 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
|
|
################################################################################
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: gcp_compute_backend_service_facts
|
|
description:
|
|
- Gather facts for GCP BackendService
|
|
short_description: Gather facts for GCP BackendService
|
|
version_added: 2.7
|
|
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) .
|
|
extends_documentation_fragment: gcp
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: " a backend service facts"
|
|
gcp_compute_backend_service_facts:
|
|
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:
|
|
affinityCookieTtlSec:
|
|
description:
|
|
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If
|
|
set to 0, the cookie is non-persistent and lasts only until the end of the
|
|
browser session (or equivalent). The maximum allowed value for TTL is one
|
|
day.
|
|
- When the load balancing scheme is INTERNAL, this field is not used.
|
|
returned: success
|
|
type: int
|
|
backends:
|
|
description:
|
|
- The list of backends that serve this BackendService.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
balancingMode:
|
|
description:
|
|
- Specifies the balancing mode for this backend.
|
|
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION.
|
|
Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
|
|
returned: success
|
|
type: str
|
|
capacityScaler:
|
|
description:
|
|
- A multiplier applied to the group's maximum servicing capacity (based
|
|
on UTILIZATION, RATE or CONNECTION).
|
|
- Default value is 1, which means the group will serve up to 100% of its
|
|
configured capacity (depending on balancingMode). A setting of 0 means
|
|
the group is completely drained, offering 0% of its available Capacity.
|
|
Valid range is [0.0,1.0].
|
|
returned: success
|
|
type: str
|
|
description:
|
|
description:
|
|
- An optional description of this resource.
|
|
returned: success
|
|
type: str
|
|
enable_cdn:
|
|
description:
|
|
- If true, enable Cloud CDN for this BackendService.
|
|
- When the load balancing scheme is INTERNAL, this field is not used.
|
|
returned: success
|
|
type: bool
|
|
health_checks:
|
|
description:
|
|
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
|
|
checking this BackendService. Currently at most one health check can be specified,
|
|
and a health check is required.
|
|
- For internal load balancing, a URL to a HealthCheck resource must be specified instead.
|
|
returned: success
|
|
type: list
|
|
id:
|
|
description:
|
|
- The unique identifier for the resource.
|
|
returned: success
|
|
type: int
|
|
iap:
|
|
description:
|
|
- Settings for enabling Cloud Identity Aware Proxy.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
enabled:
|
|
description:
|
|
- Enables IAP.
|
|
returned: success
|
|
type: bool
|
|
oauth2_client_id:
|
|
description:
|
|
- OAuth2 Client ID for IAP.
|
|
returned: success
|
|
type: str
|
|
oauth2_client_secret:
|
|
description:
|
|
- OAuth2 Client Secret for IAP.
|
|
returned: success
|
|
type: str
|
|
oauth2_client_secret_sha256:
|
|
description:
|
|
- OAuth2 Client Secret SHA-256 for IAP.
|
|
returned: success
|
|
type: str
|
|
load_balancing_scheme:
|
|
description:
|
|
- Indicates whether the backend service will be used with internal or external load
|
|
balancing. A backend service created for one type of load balancing cannot be used
|
|
with the other.
|
|
returned: success
|
|
type: str
|
|
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
|
|
port_name:
|
|
description:
|
|
- Name of backend port. The same name should appear in the instance groups referenced
|
|
by this service. Required when the load balancing scheme is EXTERNAL.
|
|
- When the load balancing scheme is INTERNAL, this field is not used.
|
|
returned: success
|
|
type: str
|
|
protocol:
|
|
description:
|
|
- The protocol this BackendService uses to communicate with backends.
|
|
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
|
|
- For internal load balancing, the possible values are TCP and UDP, and the default
|
|
is TCP.
|
|
returned: success
|
|
type: str
|
|
region:
|
|
description:
|
|
- The region where the regional backend service resides.
|
|
- This field is not applicable to global backend services.
|
|
returned: success
|
|
type: str
|
|
session_affinity:
|
|
description:
|
|
- Type of session affinity to use. The default is NONE.
|
|
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
|
|
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
|
|
or CLIENT_IP_PORT_PROTO.
|
|
- When the protocol is UDP, this field is not used.
|
|
returned: success
|
|
type: str
|
|
timeout_sec:
|
|
description:
|
|
- How many seconds to wait for the backend before considering it a failed request.
|
|
Default is 30 seconds. Valid range is [1, 86400].
|
|
returned: success
|
|
type: int
|
|
'''
|
|
|
|
################################################################################
|
|
# Imports
|
|
################################################################################
|
|
from ansible.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']
|
|
|
|
items = fetch_list(module, collection(module), query_options(module.params['filters']))
|
|
if items.get('items'):
|
|
items = items.get('items')
|
|
else:
|
|
items = []
|
|
return_value = {'resources': items}
|
|
module.exit_json(**return_value)
|
|
|
|
|
|
def collection(module):
|
|
return "https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices".format(**module.params)
|
|
|
|
|
|
def fetch_list(module, link, query):
|
|
auth = GcpSession(module, 'compute')
|
|
response = auth.get(link, params={'filter': query})
|
|
return return_if_object(module, response)
|
|
|
|
|
|
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()
|