openstack.cloud.identity_domain 模块 – 管理 OpenStack 身份（Keystone）域

注意

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

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

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

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

概要

  • 创建、更新或删除 OpenStack 身份（Keystone）域。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

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

auth

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的密码插件，这将包含 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 的一个部分一样。

description

字符串

域描述。

interface

别名：endpoint_type

字符串

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

选择

  • "admin"

  • "internal"

  • "public" ← (默认)

is_enabled

别名：enabled

布尔值

此域是否已启用。

选择

  • false

  • true

name

字符串 / 必需

域名。

region_name

字符串

区域名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选择

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

state

字符串

资源应该存在还是不存在。

选择

  • "present" ← (默认)

  • "absent"

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 配置文件，然后来自标准环境变量，最后来自 plays 中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Create a domain
  openstack.cloud.identity_domain:
    cloud: mycloud
    state: present
    name: demo
    description: Demo Domain

- name: Delete a domain
  openstack.cloud.identity_domain:
    cloud: mycloud
    state: absent
    name: demo

返回值

通用的返回值记录在这里，以下是此模块特有的字段

键

描述

domain

字典

描述域的字典。

返回: 当state为present时，成功返回。

description

字符串

域描述。

返回: 成功

示例: "演示域"

id

字符串

域 ID。

返回: 成功

示例: "474acfe5-be34-494c-b339-50f06aa143e4"

is_enabled

布尔值

域描述。

返回: 成功

示例: true

列表 / 元素=字符串

与域资源相关的链接

返回: 成功

name

字符串

域名。

返回: 成功

示例: "demo"

作者

  • OpenStack Ansible SIG