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

字典

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

auth_type

字符串

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

ca_cert

别名：cacert

字符串

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

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

整数

请求项目页面大小。

返回最多为限制值的项目数。

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，而不是提供显式值。

  • 身份验证信息由 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"

type

字符串

密钥对的类型。

允许的值为 ssh 或 x509。

返回： 成功

示例： "ssh"

user_id

字符串

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

返回： 成功

示例： "59b10f2a2138428ea9358e10c7e44444"

作者

  • OpenStack Ansible SIG