community.general.ovirt_vmpool_facts – Получение информации об одном или нескольких пулах виртуальных машин oVirt/RHV
Примечание
Этот плагин входит в сборку community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать его в плейбуке, укажите: community.general.ovirt_vmpool_facts.
УСТАРЕВШИЙ
- Удалено в
-
версии 3.0.0
- Почему
-
При миграции в сборку мы решили использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_vmpool_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. | |
| fetch_nested boolean |
| Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенной сущности. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен истинному. | |
| pattern строка | Критерий поиска, принятый механизмом поиска oVirt/RHV. Например, для поиска vmpool X: name=X |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_vmpools, которая содержит список пулов виртуальных машин. Вам необходимо зарегистрировать результат с помощью ключевого слова 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 vm pools which names start with centos
ovirt_vmpool_info:
pattern: name=centos*
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_vm_pools }}"
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_vm_pools список / элементы=строка | При успехе. | Список словарей, описывающих пулы виртуальных машин. Атрибуты пула виртуальных машин отображаются в ключах словаря, все атрибуты пулов виртуальных машин можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm_pool. |
Статус
- Этот модуль будет удален в версии 3.0.0. [устарел]
- Для получения дополнительной информации см. УСТАРЕВШИЙ.
Авторы
- Ondra Machacek (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_vmpool_facts_module.html