gcp_sql_database_facts – Gather facts for GCP Database
gcp_sql_database_facts – Gather facts for GCP Database
New in version 2.8.
Synopsis
- Gather facts for GCP Database
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind string / required |
|
The type of credential used. |
instance - / required |
The name of the Cloud SQL instance. This does not include the project ID. This field represents a link to a Instance resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'name' and value of your resource's name Alternatively, you can add `register: name-of-resource` to a gcp_sql_instance task and then set this instance field to "Template:Name-of-resource" | |
project string |
The Google Cloud Platform project to use. | |
scopes list |
Array of scopes to be used. | |
service_account_contents string |
A string representing the contents of a Service Account JSON file. This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON) | |
service_account_email string |
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. | |
service_account_file path |
The path of a Service Account JSON file if serviceaccount is selected as type. |
Notes
Note
- For authentication, you can set service_account_file using the
GCP_SERVICE_ACCOUNT_FILE
env variable. - For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable. - For authentication, you can set service_account_contents using the
GCP_SERVICE_ACCOUNT_CONTENTS
env variable. - For authentication, you can set auth_kind using the
GCP_AUTH_KIND
env variable. - For authentication, you can set scopes using the
GCP_SCOPES
env variable. - Environment variables values will only be used if the playbook values are not set.
- The service_account_email and service_account_file options are mutually exclusive.
Examples
- name: " a database facts"
gcp_sql_database_facts:
instance: "{{ instance }}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
items complex |
always |
List of items
| |
charset string |
success |
The MySQL charset value.
| |
collation string |
success |
The MySQL collation value.
| |
instance dictionary |
success |
The name of the Cloud SQL instance. This does not include the project ID.
| |
name string |
success |
The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_sql_database_facts_module.html