diff --git a/plugins/modules/gcp_compute_backend_service_facts.py b/plugins/modules/gcp_compute_backend_service_facts.py new file mode 100644 index 0000000..e4695e2 --- /dev/null +++ b/plugins/modules/gcp_compute_backend_service_facts.py @@ -0,0 +1,370 @@ +#!/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: service_account + service_account_file: "/tmp/auth.pem" +''' + +RETURN = ''' + affinity_cookie_ttl_sec: + 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: + balancing_mode: + 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). + - This cannot be used for internal load balancing. + returned: success + type: str + capacity_scaler: + 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]. + - This cannot be used for internal load balancing. + returned: success + type: str + description: + description: + - An optional description of this resource. + - Provide this property when you create the resource. + returned: success + type: str + group: + description: + - This instance group defines the list of instances that serve traffic. Member virtual + machine instances from each instance group must live in the same zone as the instance + group itself. + - No two backends in a backend service are allowed to use same Instance Group resource. + - When the BackendService has load balancing scheme INTERNAL, the instance group must + be in a zone within the same region as the BackendService. + returned: success + type: dict + max_connections: + description: + - The max number of simultaneous connections for the group. Can be used with either + CONNECTION or UTILIZATION balancing modes. + - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be + set. + - This cannot be used for internal load balancing. + returned: success + type: int + max_connections_per_instance: + description: + - The max number of simultaneous connections that a single backend instance can handle. + This is used to calculate the capacity of the group. Can be used in either CONNECTION + or UTILIZATION balancing modes. + - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be + set. + - This cannot be used for internal load balancing. + returned: success + type: int + max_rate: + description: + - The max requests per second (RPS) of the group. + - Can be used with either RATE or UTILIZATION balancing modes, but required if RATE + mode. For RATE mode, either maxRate or maxRatePerInstance must be set. + - This cannot be used for internal load balancing. + returned: success + type: int + max_rate_per_instance: + description: + - The max requests per second (RPS) that a single backend instance can handle. This + is used to calculate the capacity of the group. Can be used in either balancing + mode. For RATE mode, either maxRate or maxRatePerInstance must be set. + - This cannot be used for internal load balancing. + returned: success + type: str + max_utilization: + description: + - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target + for the group. The default is 0.8. Valid range is [0.0, 1.0]. + - This cannot be used for internal load balancing. + returned: success + type: str + cdn_policy: + description: + - Cloud CDN configuration for this BackendService. + returned: success + type: complex + contains: + cache_key_policy: + description: + - The CacheKeyPolicy for this CdnPolicy. + returned: success + type: complex + contains: + include_host: + description: + - If true requests to different hosts will be cached separately. + returned: success + type: bool + include_protocol: + description: + - If true, http and https requests will be cached separately. + returned: success + type: bool + include_query_string: + description: + - If true, include query string parameters in the cache key according to query_string_whitelist + and query_string_blacklist. If neither is set, the entire query string will be included. + - If false, the query string will be excluded from the cache key entirely. + returned: success + type: bool + query_string_blacklist: + description: + - Names of query string parameters to exclude in cache keys. + - All other parameters will be included. Either specify query_string_whitelist or + query_string_blacklist, not both. + - "'&' and '=' will be percent encoded and not treated as delimiters." + returned: success + type: list + query_string_whitelist: + description: + - Names of query string parameters to include in cache keys. + - All other parameters will be excluded. Either specify query_string_whitelist or + query_string_blacklist, not both. + - "'&' and '=' will be percent encoded and not treated as delimiters." + returned: success + type: list + connection_draining: + description: + - Settings for connection draining. + returned: success + type: complex + contains: + draining_timeout_sec: + description: + - Time for which instance will be drained (not accept new connections, but still work + to finish started). + returned: success + type: int + creation_timestamp: + description: + - Creation timestamp in RFC3339 text format. + 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 + 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 'scopes' not in module.params: + 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 = { + 'items': 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()