community.general.ovirt_snapshot_facts – Получение информации об одном или нескольких моментальных снимках виртуальных машин oVirt/RHV

Примечание

Этот плагин входит в состав коллекции community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в книге задач, укажите: community.general.ovirt_snapshot_facts

УСТЕРЕГШЕ
Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

УСТЕРЕГШЕ

Удалено в: версии 3.0.0
Почему: При миграции в коллекцию было решено использовать только модули _info.
Альтернатива: Используйте ovirt.ovirt.ovirt_snapshot_info вместо этого.

Описание

Получение информации об одном или нескольких моментальных снимках виртуальных машин oVirt/RHV.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth словарь / обязательно		Словарь со значениями, необходимыми для создания подключения HTTP/HTTPS к oVirt: `username`[обязательно] - Имя пользователя, например, admin@internal. Значение по умолчанию задается переменной окружения OVIRT_USERNAME. `password`[обязательно] - Пароль пользователя. Значение по умолчанию задается переменной окружения OVIRT_PASSWORD. `url`- Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной окружения OVIRT_URL. Требуется либо `url`, либо `hostname`. `hostname` - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задается переменной окружения OVIRT_HOSTNAME. Требуется либо `url`, либо `hostname`. `token` - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной окружения OVIRT_TOKEN. `insecure` - Флаг булевого типа, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста. `ca_file` - Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр ``ca_file`` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задается переменной окружения OVIRT_CAFILE. `kerberos` - Флаг булевого типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации по умолчанию. `headers` - Словарь HTTP-заголовков, которые нужно добавлять к каждому вызову API.
description строка		Описание моментального снимка, может быть использовано как выражение glob.
fetch_nested булево	Варианты: нет ← да	Если да, модуль получит дополнительные данные из API. Получаются только идентификаторы вложенной сущности. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes список / элементы=строка		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен истинному.
snapshot_id строка		Идентификатор моментального снимка, о котором мы хотим получить информацию.
vm строка / обязательно		Имя ВМ с моментальным снимком.

Примечания

Примечание

Этот модуль возвращает переменную ovirt_snapshots, которая содержит список моментальных снимков. Вам нужно зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: ansible.builtin.pip: name=ovirt-engine-sdk-python version=4.3.0

Примеры

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

- name: Gather information about all snapshots which description start with update for VM named centos7
  ovirt_snapshot_info:
    vm: centos7
    description: update*
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_snapshots }}"

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
ovirt_snapshots список / элементы=строка	При успешном выполнении.	Список словарей, описывающих моментальный снимок. Атрибуты моментального снимка сопоставляются с ключами словаря, все атрибуты моментального снимка можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/snapshot.

Статус

Этот модуль будет удален в версии 3.0.0. [устаревший]
Дополнительную информацию см. в разделе УСТЕРЕГШЕ.

Авторы

Ondra Machacek (@machacekondra)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ovirt_snapshot_facts_module.html