openstack.cloud.resources 模块 – 列出 OpenStack 云资源

注意

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

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

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

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

概要 

列出 OpenStack 云资源。

要求 

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

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 字符串	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"` ← (默认)
parameters 字典	传递给 OpenStack API 用于结果过滤的查询参数。 attributes 是一组键值对，其中每个键都是一个属性名称，例如 `id`，而值则包含其对应的属性值，例如 `ddad2d86-02a6-444d-80ae-1cc2fb023784`。有关有效查询参数的完整列表，请打开 openstacksdk 中的任何资源类，例如 https://opendev.org/openstack/openstacksdk/ 中的 `openstack/compute/v2/server.py` 文件，并查阅变量 `_query_mapping`。
region_name 字符串	区域名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入日志
service 字符串 / 必需	此资源所属的 OpenStack 服务。例如 `block_storage`、`compute` 或 `network`。 service 必须是 openstacksdk 中使用的 OpenStack 服务的小写名称。有关可用服务的列表，请访问 https://opendev.org/openstack/openstacksdk：`openstack` 目录中的大多数子目录都对应于一个 OpenStack 服务，除了 `cloud`、`common` 和其他辅助目录。
timeout 整数	Ansible 应等待请求资源多长时间。默认： `180`
type 字符串 / 必需	资源的类型名称。例如 `ip`、`network`、`router` 或 `server`。 type 必须是 openstacksdk 资源类的 `小写` 名称。资源类在 openstacksdk 的服务文件夹中定义。例如，访问 https://opendev.org/openstack/openstacksdk，进入 `openstack` 目录，进入任何服务目录，例如 `compute`，选择一个 API 版本目录，例如 `v2`，并在 `*.py` 文件中查找所有可用的资源类，例如 `Server`。
validate_certs 别名: verify 布尔值	是否验证 SSL API 请求。 Ansible 2.3 之前，默认为 `true`。选项 `false` `true`
wait 布尔值	Ansible 是否应等待请求的资源完成。选项 `false` `true` ← (默认)

备注 

注意

此模块不支持所有 OpenStack 云资源。资源处理必须遵循 openstacksdk 的 CRUD 结构，并使用和提供 <service>.<type>s 函数。如果找不到此函数，模块将失败。
可以使用标准的 OpenStack 环境变量（例如 OS_USERNAME），而不是提供显式值。
身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 play 中的显式参数。更多信息可在 https://docs.openstack.org/openstacksdk/ 找到。

示例 

- name: List images
  openstack.cloud.resources:
    cloud: devstack-admin
    service: image
    type: image
  register: images

- name: Identify CirrOS image id
  set_fact:
    image_id: "{{
      images.resources|community.general.json_query(query)|first }}"
  vars:
    query: "[?starts_with(name, 'cirros')].id"

- name: List compute flavors
  openstack.cloud.resources:
    cloud: devstack-admin
    service: compute
    type: flavor
  register: flavors

- name: Identify m1.tiny flavor id
  set_fact:
    flavor_id: "{{
      flavors.resources|community.general.json_query(query)|first }}"
  vars:
    query: "[?name == 'm1.tiny'].id"

- name: List public network
  openstack.cloud.resources:
    cloud: devstack-admin
    service: network
    type: network
    parameters:
      name: public

返回值 

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

键	描述
resources 列表 / 元素=字典	描述已识别的 OpenStack 云资源的字典。返回：始终

作者

OpenStack Ansible SIG