community.general.ovirt_host_facts – Получение информации об одном или нескольких хостах oVirt/RHV
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general
Для использования в playbook укажите: community.general.ovirt_host_facts
УСТАРЕЛО
- Удалено в
-
версии 3.0.0
- Почему
-
При миграции в коллекцию мы решили использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_host_info вместо этого.
Описание
- Получение информации об одном или нескольких хостах oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| all_content boolean |
| Если истина, все атрибуты хостов должны быть включены в ответ. |
| 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. | |
| cluster_version строка | Фильтрация хостов по версии кластера. | |
| fetch_nested boolean |
| Если да, модуль получит дополнительные данные из API. Получаются только идентификаторы вложенных сущностей. Не получаются несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен истине. | |
| pattern строка | Поисковый термин, принятый бэкендом поиска oVirt/RHV. Например, для поиска хоста X из ЦОД Y используйте следующий шаблон: name=X and datacenter=Y |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_hosts, содержащую список хостов. Вам нужно зарегистрировать результат с помощью ключевого слова 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 hosts which names start with host and belong to data center west
ovirt_host_info:
pattern: name=host* and datacenter=west
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_hosts }}"
- name: Gather information about all hosts with cluster version 4.2
ovirt_host_info:
pattern: name=host*
cluster_version: "4.2"
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_hosts }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_hosts список / элементы=строка | При успехе. | Список словарей, описывающих хосты. Атрибуты хостов сопоставлены с ключами словаря, все атрибуты хостов можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/host. |
Статус
- Этот модуль будет удален в версии 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_host_facts_module.html