openstack.cloud.endpoint 模块 – 管理 OpenStack 身份服务端点

注意

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

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

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

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

概要

• 创建、更新或删除 OpenStack 身份服务端点。如果存在具有相同 service、interface 和 region 组合的服务，则将更新 url、enabled 和 state（present 或 absent）。

要求

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

• 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 的一个部分中一样。
enabled 布尔值	是否启用该服务。 选择 false true ← (默认)
endpoint_interface 字符串 / 必需	服务的接口。 选择 "admin" "public" "internal"
interface 别名: endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。 选择 "admin" "internal" "public" ← (默认)
region 字符串	服务所属区域的 ID。请注意，region 用于身份验证。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别 选择 "INFO" ← (默认) "DEBUG"
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
service 字符串 / 必需	服务的名称或 ID。
state 字符串	资源应为 present 还是 absent。 选择 "present" ← (默认) "absent"
timeout 整数	Ansible 应该等待请求的资源多长时间。 默认值: 180
url 字符串 / 必需	服务的 URL。
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 配置文件，然后来自标准环境变量，最后来自 play 中的显式参数。更多信息请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Create a service for glance
  openstack.cloud.endpoint:
     cloud: mycloud
     service: glance
     endpoint_interface: public
     url: http://controller:9292
     region: RegionOne
     state: present

- name: Delete a service for nova
  openstack.cloud.endpoint:
     cloud: mycloud
     service: nova
     endpoint_interface: public
     region: RegionOne
     state: absent

返回值

通用返回值在此处记录 此处，以下是此模块独有的字段

键	描述
endpoint 字典	描述端点的字典。 返回: 当 state 为 present 时成功返回
id 字符串	端点 ID。 返回: 成功 示例: "3292f020780b4d5baf27ff7e1d224c44"
interface 字符串	端点接口。 返回: 成功 示例: "public"
is_enabled 布尔值	服务状态。 返回: 成功 示例: true
links 字符串	端点的链接 返回: 成功 示例: "http://controller/identity/v3/endpoints/123"
name 字符串	端点的名称 返回: 成功 示例: "cinder"
region_id 字符串	区域 ID。 返回: 成功 示例: "RegionOne"
service_id 字符串	服务 ID。 返回: 成功 示例: "b91f1318f735494a825a55388ee118f3"
url 字符串	服务 URL。 返回: 成功 示例: "http://controller:9292"

作者

• OpenStack Ansible SIG

合集链接

• 问题跟踪器
• 存储库 (源代码)