ovirt.ovirt.ovirt_vm_os_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_vm_os_info

ovirt.ovirt 1.1.0 中的新功能

概要

  • 检索所有支持的 oVirt/RHV 操作系统的相关信息。

要求

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

  • 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 环境变量设置。

urlhostname 是必需的。

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 环境变量设置。

urlhostname 是必需的。

username

字符串

用户的名称,类似于 admin@internal

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

fetch_nested

布尔值

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

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

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

选项

  • false ← (默认)

  • true

filter_keys

列表 / 元素=字符串

应在返回中包含的属性列表。

follow

别名:follows

列表 / 元素=字符串

在 ovirt.ovirt 1.5.0 中添加

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

此参数替换了 fetch_nestednested_attributes 的用法。

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

name

字符串

应返回的操作系统的名称。

nested_attributes

列表 / 元素=字符串

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

此参数仅在 fetch_nestedtrue 时适用。

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

备注

注意

  • 此模块返回一个名为 ovirt_operating_systems 的变量,其中包含操作系统列表。您需要使用 register 关键字注册结果才能使用它。

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

示例

# Look at ovirt_auth module to see how to reuse authentication:

- ovirt.ovirt.ovirt_vm_os_info:
    auth: "{{ ovirt_auth }}"
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_operating_systems }}"

- ovirt.ovirt.ovirt_vm_os_info:
    auth: "{{ ovirt_auth }}"
    filter_keys: name,architecture
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_operating_systems }}"

返回值

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

描述

ovirt_operating_systems

列表 / 元素=字符串

描述操作系统的字典列表。操作系统属性映射到字典键,所有操作系统属性都可以在以下 URL 中找到:http://ovirt.github.io/ovirt-engine-api-model/master/#types/operating_system_info

返回: 成功时。

作者

  • Martin Necas (@mnecas)

  • Chris Brown (@snecklifter)