ovirt.ovirt.ovirt_quota_info 模块 – 获取一个或多个 oVirt/RHV 配额的信息

注意

此模块是 ovirt.ovirt 集合（版本 3.2.0）的一部分。

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

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

要在 playbook 中使用它，请指定：ovirt.ovirt.ovirt_quota_info。

ovirt.ovirt 1.0.0 中的新增功能

概要

  • 获取一个或多个 oVirt/RHV 配额的信息。

  • 在 Ansible 2.9 之前，此模块被称为 ovirt_quota_facts，返回 ansible_facts。请注意，ovirt.ovirt.ovirt_quota_info 模块不再返回 ansible_facts！

要求

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

  • python >= 2.7

  • ovirt-engine-sdk-python >= 4.4.0

参数

参数

注释

auth

字典 / 必需

包含创建到 oVirt 的 HTTP/HTTPS 连接所需值的字典

ca_file

字符串

包含受信任 CA 证书的 PEM 文件。

将使用这些 CA 证书验证服务器提供的证书。

如果未设置 ca_file 参数，则使用系统范围的 CA 证书存储。

默认值由 OVIRT_CAFILE 环境变量设置。

compress

布尔值

标志指示是否对连接使用压缩。

选项

  • false

  • true ← (默认)

headers

字典

要添加到每个 API 调用的 HTTP 标头字典。

hostname

字符串

包含服务器主机名的字符串，通常类似于 `server.example.com`。

默认值由 OVIRT_HOSTNAME 环境变量设置。

需要 url 或 hostname。

insecure

布尔值

一个布尔标志，指示是否应检查服务器 TLS 证书和主机名。

选项

  • false ← (默认)

  • true

kerberos

布尔值

一个布尔标志，指示是否应使用 Kerberos 身份验证而不是默认的基本身份验证。

选项

  • false

  • true

password

字符串

用户的密码。

默认值由 OVIRT_PASSWORD 环境变量设置。

timeout

整数

等待响应的秒数。

token

字符串

用于代替使用用户名/密码登录的令牌。

默认值由 OVIRT_TOKEN 环境变量设置。

url

字符串

包含服务器 API URL 的字符串，通常类似于 `https://server.example.com/ovirt-engine/api`。

默认值由 OVIRT_URL 环境变量设置。

需要 url 或 hostname。

username

字符串

用户名，类似于 admin@internal。

默认值由 OVIRT_USERNAME 环境变量设置。

data_center

字符串 / 必需

配额所在的数据中心的名称。

fetch_nested

布尔值

如果为 yes，则模块将从 API 获取其他数据。

它将仅获取嵌套实体的 ID。它不获取多层嵌套属性。仅获取当前实体的属性。用户可以配置为通过指定 nested_attributes 来获取嵌套实体的其他属性。

此参数已弃用，并由 follow 替换。

选项

  • false ← (默认)

  • true

follow

别名: follows

列表 / 元素=字符串

在 ovirt.ovirt 1.5.0 中添加

链接实体的列表，应与主实体一起获取。

此参数替代了 fetch_nested 和 nested_attributes 的用法。

所有以下参数都可以在以下 URL 中找到：https://ovirt.github.io/ovirt-engine-api-model/master/#types/quota/links_summary

name

字符串

配额的名称，可以用作 glob 表达式。

nested_attributes

列表 / 元素=字符串

指定应从 API 获取的属性列表。

此参数仅当 fetch_nested 为 true 时应用。

此参数已弃用，并由 follow 替换。

注释

注意

  • 此模块返回一个变量 ovirt_quotas，其中包含配额列表。您需要使用 register 关键字注册结果才能使用它。

  • 要使用此模块，您必须安装 oVirt Python SDK。为确保安装了正确的版本，您可以创建以下任务：pip: name=ovirt-engine-sdk-python version=4.4.0

示例

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Gather information about quota named C<myquota> in Default datacenter:
- ovirt.ovirt.ovirt_quota_info:
    data_center: Default
    name: myquota
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_quotas }}"

返回值

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

键

描述

ovirt_quotas

列表 / 元素=字符串

描述配额的字典列表。配额属性映射到字典键，所有配额属性都可以在以下 URL 中找到：http://ovirt.github.io/ovirt-engine-api-model/master/#types/quota。

返回: 成功时。

作者

  • Maor Lipchuk (@machacekondra)