google.cloud.gcp_kms_crypto_key_info 模块 – 收集 GCP 密钥信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP 密钥信息

要求

以下是执行此模块的主机所需的条件。

  • 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。

  • 只有在未设置剧本值时，才会使用环境变量值。

  • 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"

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

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，则请求将创建一个没有任何 CryptoKeyVersions 的 CryptoKey。您必须使用 `google_kms_key_ring_import_job` 资源导入 CryptoKeyVersion。

返回：成功

versionTemplate

复杂

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

返回：成功

algorithm

字符串

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

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

返回：成功

protectionLevel

字符串

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

返回：成功

作者

  • 谷歌公司 (@googlecloudplatform)