google.cloud.gcp_runtimeconfig_variable module – Creates a GCP Variable
Note
This module is part of the google.cloud collection (version 1.4.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_runtimeconfig_variable
.
Synopsis
Describes a single variable within a runtime config resource.
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 |
Comments |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
The name of the runtime config that this variable belongs to. |
|
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. |
|
The name of the variable resource. |
|
The Google Cloud Platform project to use. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
Whether the given object should exist in GCP Choices:
|
|
The string value of the variable. Either this or `value` can be set. |
|
The binary value of the variable. Either this or `text` can be set. |
Examples
- name: create a config
google.cloud.gcp_runtimeconfig_config:
name: my-config
description: My config
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: config
- name: create a variable
google.cloud.gcp_runtimeconfig_variable:
name: prod-variables/hostname
config: my-config
text: example.com
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The name of the runtime config that this variable belongs to. Returned: success |
|
The name of the variable resource. Returned: success |
|
The string value of the variable. Either this or `value` can be set. Returned: success |
|
The binary value of the variable. Either this or `text` can be set. Returned: success |