mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-06 02:40:29 -07:00
79e3fe4704
* adding the things * rebase * tf example * removing google provider * pr comments Signed-off-by: Modular Magician <magic-modules@google.com>
228 lines
7.6 KiB
Python
228 lines
7.6 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_external_vpn_gateway_info
|
||
description:
|
||
- Gather info for GCP ExternalVpnGateway
|
||
short_description: Gather info for GCP ExternalVpnGateway
|
||
version_added: '2.10'
|
||
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 an external vpn gateway
|
||
gcp_compute_external_vpn_gateway_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:
|
||
description:
|
||
description:
|
||
- An optional description of this resource.
|
||
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
|
||
redundancyType:
|
||
description:
|
||
- Indicates the redundancy type of this external VPN gateway .
|
||
returned: success
|
||
type: str
|
||
interfaces:
|
||
description:
|
||
- A list of interfaces on this external VPN gateway.
|
||
returned: success
|
||
type: complex
|
||
contains:
|
||
id:
|
||
description:
|
||
- The numberic ID for this interface. Allowed values are based on the redundancy
|
||
type of this external VPN gateway * `0 - SINGLE_IP_INTERNALLY_REDUNDANT`
|
||
* `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` .
|
||
returned: success
|
||
type: int
|
||
ipAddress:
|
||
description:
|
||
- IP address of the interface in the external VPN gateway.
|
||
- Only IPv4 is supported. This IP address can be either from your on-premise
|
||
gateway or another Cloud provider’s VPN gateway, it cannot be an IP address
|
||
from Google Compute Engine.
|
||
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(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/externalVpnGateways".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()
|