openstack.cloud.stack_info 模块 – 获取 Heat 堆栈信息

注意

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

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

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

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

概要

  • 获取 OpenStack 中 Heat 堆栈的信息

要求

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

  • 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" ← (默认)

name

字符串

堆栈的名称。

owner

别名：owner_id

字符串

父堆栈的名称或 ID。

project

别名：project_id

字符串

项目的名称或 ID。

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

status

字符串

堆栈的状态，例如 available

timeout

整数

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

默认值： 180

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: Fetch all Heat stacks
  openstack.cloud.stack_info:
    cloud: devstack

- name: Fetch a single Heat stack
  openstack.cloud.stack_info:
    cloud: devstack
    name: my_stack

返回值

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

键

描述

stacks

列表 / 元素=字典

描述堆栈的字典列表。

返回：始终。

added

列表 / 元素=字符串

将要添加的资源对象列表。

返回：成功

capabilities

列表 / 元素=字符串

AWS 兼容模板列出功能。

返回：成功

created_at

字符串

创建时间。

返回：成功

示例： "2016-07-05T17:38:12Z"

已删除

列表 / 元素=字符串

将要删除的资源对象列表。

返回：成功

deleted_at

字符串

删除时间。

返回：成功

示例： "2016-07-05T17:38:12Z"

description

字符串

Heat 模板中提供的堆栈描述。

返回：成功

示例： "HOT 模板 用于 创建 新的 实例和网络"

environment

字典

堆栈的 JSON 环境。

返回：成功

environment_files

列表 / 元素=字符串

在 files 字典中找到的环境文件的排序列表。

返回：成功

files

字典

模板或环境中引用的附加文件。

返回：成功

files_container

字符串

包含子模板和文件的 Swift 容器名称。

返回：成功

id

字符串

堆栈 ID。

返回：成功

示例： "97a3f543-8136-4570-920e-fd7605c989d6"

is_rollback_disabled

布尔值

堆栈是否支持回滚。

返回：成功

列表 / 元素=字典

指向当前堆栈的链接。

返回：成功

示例： "[{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/ 97a3f543-8136-4570-920e-fd7605c989d6']"

name

字符串

堆栈名称

返回：成功

示例： "test-stack"

notification_topics

字符串

与堆栈相关的事件。

返回：成功

示例： "HOT 模板 用于 创建 新的 实例和网络"

outputs

列表 / 元素=字典

堆栈返回的输出。

返回：成功

示例： "[{'description': 'server1 在私有网络中的IP地址', 'output_key': 'server1_private_ip', 'output_value': '10.1.10.103'}]"

owner_id

字符串

所有者堆栈的 ID（如有）。

返回：成功

parameters

字典

当前堆栈的参数。

返回：成功

示例： "{'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101', 'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6', 'OS::stack_name': 'test-stack', 'stack_status': 'CREATE_COMPLETE', 'stack_status_reason': '堆栈创建成功', 'status': 'COMPLETE', 'template_description': 'HOT 模板，用于创建一个新的实例和网络', 'timeout_mins': 60, 'updated_time': null}"

parent_id

字符串

父堆栈的 ID（如有）。

返回：成功

replaced

字符串

将要替换的资源对象列表。

返回：成功

status

字符串

堆栈状态。

返回：成功

status_reason

字符串

解释堆栈如何转换到当前状态。

返回：成功

tags

列表 / 元素=字符串

用作堆栈标签的字符串列表。

返回：成功

template

字典

包含用于堆栈创建的模板的字典。

返回：成功

template_description

字符串

堆栈模板描述文本。

返回：成功

template_url

字符串

可以找到堆栈模板的 URL。

返回：成功

timeout_mins

字符串

堆栈操作超时时间（分钟）。

返回：成功

unchanged

列表 / 元素=字符串

如果堆栈，则将保持不变的资源对象列表。

返回：成功

updated

列表 / 元素=字符串

将更新其属性的资源对象列表。

返回：成功

updated_at

字符串

堆栈最后更新的时间戳。

返回：成功

user_project_id

字符串

为此堆栈创建的用户项目的 ID。

返回：成功

作者

  • OpenStack Ansible SIG