ovirt_network_info – Получение информации об одной или нескольких сетях oVirt/RHV

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

Краткое описание

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

Псевдонимы: ovirt_network_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 вместо стандартной аутентификации по протоколу basic. `headers` - Словарь HTTP-заголовков, которые должны добавляться к каждому API-запросу.
fetch_nested булево	Варианты: нет да	Если да, модуль получит дополнительные данные из API. Получаются только идентификаторы вложенных сущностей. Не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes список		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` имеет значение истина.
pattern -		Поисковый термин, принимаемый поисковым бэкендом oVirt/RHV. Например, чтобы найти сеть, начинающуюся со строки vlan1, используйте: name=vlan1*

Примечания

Примечание

Этот модуль возвращает переменную ovirt_networks, которая содержит список сетей. Для использования результата необходимо зарегистрировать его с помощью ключевого слова 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 networks which names start with C(vlan1):
- ovirt_network_info:
    pattern: name=vlan1*
  register: result
- debug:
    msg: "{{ result.ovirt_networks }}"

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

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

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

Статус

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

Авторы

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_network_info_module.html