New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind
required |
|
The type of credential used.
|
host
required |
The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion.
|
|
instance
required |
The name of the Cloud SQL instance. This does not include the project ID.
|
|
name
required |
The name of the user in the Cloud SQL instance.
|
|
password |
The password for the user.
|
|
project |
Default: None
|
The Google Cloud Platform project to use.
|
scopes |
Array of scopes to be used.
|
|
service_account_email |
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
|
service_account_file |
The path of a Service Account JSON file if serviceaccount is selected as type.
|
|
state |
|
Whether the given object should exist in GCP
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a instance
gcp_sql_instance:
name: "instance-user"
settings:
ip_configuration:
authorized_networks:
- name: google dns server
value: 8.8.8.8/32
tier: db-n1-standard-1
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: instance
- name: create a user
gcp_sql_user:
name: test-user
host: 10.1.2.3
password: secret-password
instance: "{{ instance }}"
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
host
str
|
success |
The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion.
|
instance
dict
|
success |
The name of the Cloud SQL instance. This does not include the project ID.
|
name
str
|
success |
The name of the user in the Cloud SQL instance.
|
password
str
|
success |
The password for the user.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.