openstack.cloud.compute_flavor_info 模块 – 从 OpenStack 云获取计算资源规格

注意

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

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

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

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

概要

• 获取 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 的一部分一样。
ephemeral 字符串	根据临时存储空间量过滤资源规格。 *ephemeral* 支持与 *ram* 选项相同的格式。
interface 别名：endpoint_type 字符串	从服务目录中获取的端点 URL 类型。 选项 "admin" "internal" "public" ← (默认)
limit 整数	将资源规格数量限制为 *limit* 个结果。 默认情况下，返回所有匹配的资源规格。
name 字符串	资源规格名称。
ram 字符串	用于根据所需的 RAM 量（以 MB 为单位）过滤资源规格的字符串。此字符串接受以下特殊值：“MIN”（返回 RAM 量最少的资源规格）和“MAX”（返回 RAM 量最大的资源规格）。 也可以指定特定的 RAM 量。将返回具有此确切 RAM 量的任何资源规格。 可以使用特殊语法给出可接受的 RAM 范围。只需在 RAM 量之前添加以下可接受的范围值之一：'<'、'>'、'<='、'>='。这些值分别表示小于、大于、小于等于和大于等于。
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
vcpus 字符串	根据虚拟CPU数量筛选实例规格。 vcpus 支持与 ram 选项相同的格式。
wait 布尔值	Ansible 是否应等待请求的资源完成。 选项 false true ← (默认值)

注释

注意

• 可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。

• 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Gather information about all available flavors
  openstack.cloud.compute_flavor_info:
    cloud: mycloud

- name: Gather information for the flavor named "xlarge-flavor"
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    name: "xlarge-flavor"

- name: Get all flavors with 512 MB of RAM
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: "512"

- name: Get all flavors with >= 1024 MB RAM
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: ">=1024"

- name: Get a single flavor with minimum amount of RAM
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: "MIN"
    limit: 1

- name: Get all flavors with >=1024 MB RAM and 2 vCPUs
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: ">=1024"
    vcpus: "2"

- name: Get flavors with >= 1024 MB RAM 2 vCPUs and < 30gb ephemeral storage
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: ">=1024"
    vcpus: "2"
    ephemeral: "<30"

返回值

常见的返回值已在 此处 文档中说明，以下是此模块特有的字段

键	描述
flavors 列表 / 元素=字典	描述计算实例规格的字典列表。 返回值：始终返回
description 字符串	实例规格描述 返回值：成功 示例： "小型 规格"
disk 整数	本地磁盘大小，单位为 GB。 返回值：成功 示例： 10
ephemeral 整数	临时空间大小，单位为 GB。 返回值：成功 示例： 10
extra_specs 字典	配置不同实例规格选项的可选参数。 返回值：成功 示例： {"hw_rng:allowed": true}
id 字符串	实例规格 ID。 返回值：成功 示例： "515256b8-7027-4d73-aa54-4e30a4a4a339"
is_disabled 布尔值	实例规格是否已启用 返回值：成功 示例： false
is_public 布尔值	使实例规格对公众可见。 返回值：成功 示例： true
name 字符串	资源规格名称。 返回值：成功 示例： "tiny"
original_name 字符串	原始实例规格名称 返回值：成功 示例： "tiny"
ram 整数	内存大小，单位为 MB。 返回值：成功 示例： 1024
rxtx_factor 浮点数	乘以其所连接网络的 rxtx_base 属性的系数，以便具有不同的带宽上限。 返回值：成功 示例： 1.0
swap 整数	交换空间大小，单位为 MB。 返回值：成功 示例： 100
vcpus 整数	虚拟CPU数量。 返回值：成功 示例： 2

作者

• OpenStack Ansible SIG

资源链接

• 问题追踪器
• 代码仓库