openstack.cloud.keypair_info 模块 – 从 OpenStack 获取密钥对信息

注意

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

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

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

要在 playbook 中使用它，请指定： openstack.cloud.keypair_info。

概要

  • 获取与帐户关联的密钥对信息

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此参数，则不会将任何内容传递给 requests 库。

auth

字典

包含云的 auth 插件策略所需的 auth 信息的字典。对于默认的 *password* 插件，这将包含 *auth_url*、*username*、*password*、*project_name* 以及云支持的任何关于域的信息（例如，*user_domain_name* 或 *project_domain_name*）。对于其他插件，此参数需要包含该 auth 插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。

auth_type

字符串

要使用的 auth 插件的名称。如果云使用密码身份验证以外的其他方法，则应在此处指示插件的名称，并相应地更新 *auth* 参数的内容。

ca_cert

别名：cacert

字符串

CA 证书包的路径，可用作验证 SSL API 请求的一部分。

client_cert

别名：cert

字符串

客户端证书的路径，用作 SSL 事务的一部分。

client_key

别名：key

字符串

客户端密钥的路径，用作 SSL 事务的一部分。

cloud

任意

要对其进行操作的命名云或云配置。如果 *cloud* 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 *auth* 和 *auth_type* 提供默认值。如果提供了 *auth* 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 *cloud* 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。

interface

别名：endpoint_type

字符串

要从服务目录中获取的端点 URL 类型。

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

limit

整数

请求指定数量的项目。

返回最多 limit 值数量的项目。

marker

字符串

最后看到的项目。

name

字符串

密钥对的名称或 ID

region_name

字符串

区域名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 日志文件的路径。如果为空，则不写入日志

timeout

整数

Ansible 应该等待请求资源多长时间。

默认值： 180

user_id

字符串

允许管理员用户操作指定用户 ID 的密钥对。

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，默认为 true。

选项

  • false

  • true

wait

布尔值

Ansible 是否应等待直到请求的资源完成。

选项

  • false

  • true ← (默认)

备注

注意

  • 可以使用标准的 OpenStack 环境变量（例如 OS_USERNAME），而不是提供显式值。

  • Auth 信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息可以在 https://docs.openstack.org/openstacksdk/ 找到。

示例

- name: Get information about keypairs
  openstack.cloud.keypair_info:
  register: result

- name: Get information about keypairs using optional parameters
  openstack.cloud.keypair_info:
    name: "test"
    user_id: "fed75b36fd7a4078a769178d2b1bd844"
    limit: 10
    marker: "jdksl"
  register: result

返回值

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

键

描述

keypairs

列表 / 元素=字典

列出与帐户关联的密钥对。

返回： 始终

created_at

字符串

创建资源的日期和时间。

返回： 成功

示例： "2021-01-19T14:52:07.261634"

fingerprint

字符串

密钥对的指纹。

返回： 成功

示例： "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd"

id

字符串

标识密钥对的 ID

返回： 成功

示例： "keypair-5d935425-31d5-48a7-a0f1-e76e9813f2c3"

is_deleted

布尔值

布尔值，指示此密钥对是否已删除。

返回： 成功

name

字符串

稍后将用于引用它的密钥对名称。

返回： 成功

示例： "keypair-5d935425-31d5-48a7-a0f1-e76e9813f2c3"

private_key

字符串

密钥对的私钥。

返回： 成功

示例： "MIICXAIBAAKBgQCqGKukO ... hZj6+H0qtjTkVxwTCpvKe4eCZ0FPq"

public_key

字符串

密钥对公钥。

返回： 成功

示例： "ssh-rsa AAAAB3NzaC1yc ... 8rPsBUHNLQp Generated-by-Nova"

类型

字符串

密钥对的类型。

允许的值为 ssh 或 x509。

返回： 成功

示例： "ssh"

user_id

字符串

允许管理员用户操作指定用户 ID 的密钥对。

返回： 成功

示例： "59b10f2a2138428ea9358e10c7e44444"

作者

  • OpenStack Ansible SIG