Spec-Zone.ru › Ansible 2.9

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Получение информации о моментальных снимках одной или нескольких виртуальных машин oVirt/RHV.
  • Этот модуль назывался ovirt_snapshot_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль ovirt_snapshot_info больше не возвращает ansible_facts!

Псевдонимы: ovirt_snapshot_facts

Требования

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

  • 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
-
Описание моментального снимка, может использоваться как выражение глоб.
fetch_nested
boolean
    Варианты:
  • нет
  • да
Если да, модуль извлечет дополнительные данные из API.
Он извлечет только идентификаторы вложенных сущностей. Он не извлекает несколько уровней вложенных атрибутов. Он извлекает только атрибуты текущей сущности. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes.
nested_attributes
список
Указывает список атрибутов, которые должны быть извлечены из API.
Этот параметр применяется только если fetch_nested равен истинному.
snapshot_id
-
Идентификатор моментального снимка, для которого требуется информация.
vm
- / обязательный
Имя ВМ с моментальным снимком.

Примечания

Примечание

  • Этот модуль возвращает переменную ovirt_snapshots, которая содержит список моментальных снимков. Вам нужно зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
  • Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: 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:

# Gather information about all snapshots which description start with C(update) for VM named C(centos7):
- ovirt_snapshot_info:
    vm: centos7
    description: update*
  register: result
- debug:
    msg: "{{ result.ovirt_snapshots }}"

Возвращаемые значения

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

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



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • 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.9/modules/ovirt_snapshot_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API