mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
New GCP Module: gcp_compute_router_facts (#44040)
This commit is contained in:
Alex Stephen
Ryan Brown
parent
31158b322e
commit
18139104ee
1 changed files with 240 additions and 0 deletions
240
lib/ansible/modules/cloud/google/gcp_compute_router_facts.py
Normal file
240
lib/ansible/modules/cloud/google/gcp_compute_router_facts.py
Normal file
|
|
@ -0,0 +1,240 @@
|
|||
#!/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_router_facts
|
||||
description:
|
||||
- Gather facts for GCP Router
|
||||
short_description: Gather facts for GCP Router
|
||||
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)
|
||||
region:
|
||||
description:
|
||||
- Region where the router resides.
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: a router facts
|
||||
gcp_compute_router_facts:
|
||||
region: us-central1
|
||||
filters:
|
||||
- name = test_object
|
||||
project: test_project
|
||||
auth_kind: service_account
|
||||
service_account_file: "/tmp/auth.pem"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
items:
|
||||
description: List of items
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource.
|
||||
returned: success
|
||||
type: int
|
||||
creation_timestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. 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
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
returned: success
|
||||
type: str
|
||||
network:
|
||||
description:
|
||||
- A reference to the network to which this router belongs.
|
||||
returned: success
|
||||
type: dict
|
||||
bgp:
|
||||
description:
|
||||
- BGP information specific to this router.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
asn:
|
||||
description:
|
||||
- Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either
|
||||
16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels
|
||||
that link to this router will have the same local ASN.
|
||||
returned: success
|
||||
type: int
|
||||
advertise_mode:
|
||||
description:
|
||||
- User-specified flag to indicate which mode to use for advertisement.
|
||||
- 'Valid values of this enum field are: DEFAULT, CUSTOM .'
|
||||
returned: success
|
||||
type: str
|
||||
advertised_groups:
|
||||
description:
|
||||
- User-specified list of prefix groups to advertise in custom mode.
|
||||
- This field can only be populated if advertiseMode is CUSTOM and is advertised to
|
||||
all peers of the router. These groups will be advertised in addition to any specified
|
||||
prefixes. Leave this field blank to advertise no custom groups.
|
||||
- 'This enum field has the one valid value: ALL_SUBNETS .'
|
||||
returned: success
|
||||
type: list
|
||||
advertised_ip_ranges:
|
||||
description:
|
||||
- User-specified list of individual IP ranges to advertise in custom mode. This field
|
||||
can only be populated if advertiseMode is CUSTOM and is advertised to all peers
|
||||
of the router. These IP ranges will be advertised in addition to any specified groups.
|
||||
- Leave this field blank to advertise no custom IP ranges.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
range:
|
||||
description:
|
||||
- The IP range to advertise. The value must be a CIDR-formatted string.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- User-specified description for the IP range.
|
||||
returned: success
|
||||
type: str
|
||||
region:
|
||||
description:
|
||||
- Region where the router resides.
|
||||
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'),
|
||||
region=dict(required=True, type='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}/regions/{region}/routers".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()
|
||||
Loading…
Reference in a new issue