google.cloud.gcp_runtimeconfig_variable 模块 – 创建一个 GCP 变量

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：google.cloud.gcp_runtimeconfig_variable。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有未解决的健全性测试失败。有关更多信息，请参阅讨论线程。

概要 

描述运行时配置资源中的单个变量。

要求 

在执行此模块的主机上需要以下要求。

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭证类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭证类型。选择 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
config 字符串 / 必需	此变量所属的运行时配置的名称。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
name 字符串 / 必需	变量资源的名称。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / elements=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应存在于 GCP 中选择 `"present"` ← (默认) `"absent"`
text 字符串	变量的字符串值。可以设置此项或 `value`。
value 字符串	变量的二进制值。可以设置此项或 `text`。

示例 

- 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

返回值 

通用返回值记录在此处，以下是此模块特有的字段

键	描述
config 字符串	此变量所属的运行时配置的名称。返回：成功
name 字符串	变量资源的名称。返回：成功
text 字符串	变量的字符串值。可以设置此项或 `value`。返回：成功
value 字符串	变量的二进制值。可以设置此项或 `text`。返回：成功

作者

Google Inc. (@googlecloudplatform)