google.cloud.gcp_kms_crypto_key_info 模块 – 收集 GCP CryptoKey 的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要更多要求才能使用此模块，有关详细信息，请参阅要求。

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

注意

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

概要

  • 收集 GCP CryptoKey 的信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型是 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

key_ring

字符串 / 必需

此密钥所属的密钥环。

格式：`’projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}’`。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串形式。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

说明

注意

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

  • 如果未设置 playbook 值，则只会使用环境变量值。

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: get info on a crypto key
  gcp_kms_crypto_key_info:
    key_ring: projects/{{ gcp_project }}/locations/us-central1/keyRings/key-key-ring
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

资源

复杂

资源列表

返回：始终

createTime

字符串

此资源在服务器上创建的时间。

这是 RFC3339 文本格式。

返回：成功

keyRing

字符串

此密钥所属的密钥环。

格式：`’projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}’`。

返回：成功

labels

字典

带有用户定义元数据的标签，用于应用于此资源。

返回：成功

name

字符串

CryptoKey 的资源名称。

返回：成功

nextRotationTime

字符串

KMS 将何时创建此 Crypto Key 的新版本。

返回：成功

purpose

字符串

CryptoKey 的不可变用途。有关输入，请参阅https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose。

返回：成功

rotationPeriod

字符串

每次经过此时间段后，生成一个新的 CryptoKeyVersion 并将其设置为主要版本。

首次轮换将在指定时间段后进行。轮换周期格式为带最多 9 位小数的十进制数，后跟字母“s”（秒）。它必须大于一天（即 86400）。

返回：成功

skipInitialVersionCreation

布尔值

如果设置为 true，则请求将创建一个没有任何 CryptoKeyVersion 的 CryptoKey。您必须使用 `google_kms_key_ring_import_job` 资源来导入 CryptoKeyVersion。

返回：成功

versionTemplate

复杂

一个描述新加密密钥版本设置的模板。

返回：成功

algorithm

字符串

基于此模板创建版本时要使用的算法。

有关可能的输入，请参阅[算法参考](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm)。

返回：成功

protectionLevel

字符串

基于此模板创建版本时要使用的保护级别。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)