openstack.cloud.project_info 模块 – 获取一个或多个 OpenStack 项目的信息

注意

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

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

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

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

摘要

  • 检索一个或多个 OpenStack 项目的信息

要求

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

  • 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 的一部分一样。

domain

字符串

包含项目的域的名称或 ID。

filters

字典

用于过滤项目的元数据字典。

*filters* 的元素作为查询参数传递给 OpenStack Identity API。

interface

别名：endpoint_type

字符串

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

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

name

字符串

项目的名称或 ID。

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

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 Identity (Keystone) projects
  openstack.cloud.project_info:
    cloud: awesomecloud

- name: Fetch all projects with a name
  openstack.cloud.project_info:
    cloud: awesomecloud
    name: demoproject

- name: Fetch all projects with a name in a domain
  openstack.cloud.project_info:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain

- name: Fetch all disabled projects
  openstack.cloud.project_info:
    cloud: awesomecloud
    filters:
      is_enabled: false

返回值

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

键

描述

projects

列表 / 元素=字典

描述 Identity (Keystone) 项目的字典列表。

返回： 始终返回，但可能为空

description

字符串

项目描述

返回： 成功

示例： "demodescription"

domain_id

字符串

项目所属的域 ID

返回： 成功

示例： "default"

id

字符串

项目 ID

返回： 成功

示例： "f59382db809c43139982ca4189404650"

is_domain

布尔值

指示项目是否也充当域。

返回： 成功

is_enabled

布尔值

指示项目是否已启用

返回： 成功

name

字符串

项目名称

返回： 成功

示例： "demoproject"

options

字典

项目的资源选项

返回： 成功

parent_id

字符串

项目的父级的 ID

返回： 成功

tags

列表 / 元素=字符串

关联标签的列表

返回： 成功

作者

  • OpenStack Ansible SIG