openstack.cloud.keypair 模块 – 从 OpenStack 添加/删除密钥对

注意

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

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

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

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

概要

  • 从 OpenStack 添加或删除密钥对

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

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

auth

字典

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

auth_type

字符串

要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他方式，则应在此处指示插件的名称，并相应地更新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" ← (默认)

name

字符串 / 必需

必须赋予密钥对的名称

public_key

字符串

将上传到 nova 并在创建时注入到 VM 中的公钥。

public_key_file

字符串

包含 ssh 公钥的本地文件的路径。与 public_key 互斥。

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

state

字符串

资源应该是存在还是不存在。如果 state 为 replace 并且密钥存在但内容不同，则删除它并使用新内容重新创建它。

选项

  • "present" ← (默认)

  • "absent"

  • "replace"

timeout

整数

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

默认值: 180

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/

示例

# Creates a key pair with the running users public key
- openstack.cloud.keypair:
      cloud: mordred
      state: present
      name: ansible_key
      public_key_file: /home/me/.ssh/id_rsa.pub

# Creates a new key pair and the private key returned after the run.
- openstack.cloud.keypair:
      cloud: rax-dfw
      state: present
      name: ansible_key

返回值

常见返回值记录在这里，以下是此模块独有的字段

键

描述

keypair

字典

描述密钥对的字典。

返回: 当 state 为 ‘present’ 时成功返回

created_at

字符串

密钥对的创建日期

返回: 成功

fingerprint

字符串

与此密钥对的 public_key 关联的短指纹。

返回: 成功

id

字符串

唯一的 UUID。

返回: 成功

is_deleted

布尔值

密钥对是否已删除

返回: 成功

name

字符串

给密钥对的名称。

返回: 成功

private_key

字符串

密钥对的私钥值。

返回: 仅当为用户生成密钥对时返回 (例如，创建密钥对且未指定公钥时)。

public_key

字符串

密钥对的公钥值。

返回: 成功

type

字符串

密钥对的类型

返回: 成功

user_id

字符串

密钥对的用户 ID

返回: 成功

作者

  • OpenStack Ansible SIG