W3cubDocs

/Ansible 2.10

google.cloud.gcp_runtimeconfig_variable – Creates a GCP Variable

Note

This plugin is part of the google.cloud collection.

To install it use: ansible-galaxy collection install google.cloud.

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 Choices/Defaults Comments
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
config
string / required
The name of the runtime config that this variable belongs to.
env_type
string
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.
name
string / required
The name of the variable resource.
project
string
The Google Cloud Platform project to use.
scopes
list / elements=string
Array of scopes to be used
service_account_contents
jsonarg
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
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.
state
string
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
text
string
The string value of the variable. Either this or `value` can be set.
value
string
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 Returned Description
config
string
success
The name of the runtime config that this variable belongs to.
name
string
success
The name of the variable resource.
text
string
success
The string value of the variable. Either this or `value` can be set.
value
string
success
The binary value of the variable. Either this or `text` can be set.


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.10/collections/google/cloud/gcp_runtimeconfig_variable_module.html