ovirt.ovirt.ovirt_snapshot_info 模块 – 获取一个或多个 oVirt/RHV 虚拟机快照信息

注意

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

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

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

要在剧本中使用它，请指定：ovirt.ovirt.ovirt_snapshot_info。

ovirt.ovirt 1.0.0 中的新增功能

概要

  • 检索有关一个或多个 oVirt/RHV 虚拟机快照的信息。

  • 在 Ansible 2.9 之前，此模块称为 ovirt_snapshot_facts，返回 ansible_facts。请注意，ovirt.ovirt.ovirt_snapshot_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 环境变量设置。

description

字符串

快照的描述，可以用作 glob 表达式。

fetch_nested

布尔值

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

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

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

选项

  • false ← (默认)

  • true

follow

别名：follows

列表 / 元素=字符串

ovirt.ovirt 1.5.0 中新增

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

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

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

nested_attributes

列表 / 元素=字符串

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

此参数仅在fetch_nested为true时适用。

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

snapshot_id

字符串

我们要检索其信息的快照的 ID。

vm

字符串 / 必填

包含快照的虚拟机的名称。

备注

注意

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

  • 要使用此模块，您必须安装 oVirt Python SDK。为确保安装了正确版本的 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 all snapshots which description start with C(update) for VM named C(centos7):
- ovirt.ovirt.ovirt_snapshot_info:
    vm: centos7
    description: update*
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_snapshots }}"

返回值

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

键

描述

ovirt_snapshots

列表 / 元素=字符串

描述快照的字典列表。快照属性映射到字典键，所有快照属性都可以在以下网址找到：http://ovirt.github.io/ovirt-engine-api-model/master/#types/snapshot。

返回：成功时。

作者

  • Ondra Machacek (@machacekondra)

  • Martin Necas (@mnecas)