community.general.ovirt_network_facts – Получение информации об одной или нескольких сетях oVirt/RHV
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.ovirt_network_facts.
УСТАРЕЛО
- Удалили в
-
версии 3.0.0
- Почему
-
При миграции на коллекцию мы решили использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_network_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 равен true. | |
| pattern строка | Поисковый термин, который поддерживается поисковым движком oVirt/RHV. Например, чтобы найти сеть, начинающуюся со строки vlan1, используйте: name=vlan1* |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_networks, которая содержит список сетей. Вам нужно зарегистрировать результат с помощью ключевого слова 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 networks which names start with vlan1
ovirt_network_info:
pattern: name=vlan1*
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_networks }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_networks список / элементы=строка | При успехе. | Список словарей, описывающих сети. Атрибуты сети сопоставлены с ключами словаря, все атрибуты сетей можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/network. |
Статус
- Этот модуль будет удален в версии 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_network_facts_module.html