community.general.nios – Запрос объектов Infoblox NIOS

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.nios.

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

Обзор

Использует API Infoblox WAPI для получения указанных объектов NIOS. Этот поиск поддерживает добавление дополнительных ключевых слов для фильтрации возвращаемых данных и указания желаемого набора возвращаемых полей.

Требования

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

infoblox-client

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
_terms строка / обязательный			Имя объекта, который нужно вернуть из NIOS
extattrs строка			Объект словаря, используемый для фильтрации по extattrs
filter строка			Объект словаря, используемый для фильтрации возвращаемых объектов
provider словарь			Объект словаря, содержащий данные подключения.
	host строка		Указывает имя или адрес хоста DNS для подключения к удалённому экземпляру NIOS WAPI через REST Значение также можно указать с помощью переменной среды `INFOBLOX_HOST`.
	http_request_timeout целое число	Значение по умолчанию: 10	Время ожидания ответа Значение также можно указать с помощью переменной среды `INFOBLOX_HTTP_REQUEST_TIMEOUT`.
	max_results целое число	Значение по умолчанию: 1000	Указывает максимальное количество объектов для возврата. Если установлено отрицательное значение, при превышении числа возвращаемых объектов установленное значение приведёт к ошибке. Значение также можно указать с помощью переменной среды `INFOBLOX_MAX_RESULTS`.
	max_retries целое число	Значение по умолчанию: 3	Настраивает количество попыток повторных подключений перед объявлением подключения работоспособным. Значение также можно указать с помощью переменной среды `INFOBLOX_MAX_RETRIES`.
	password строка		Указывает пароль для аутентификации подключения к удалённому экземпляру NIOS. Значение также можно указать с помощью переменной среды `INFOBLOX_PASSWORD`.
	username строка		Указывает имя пользователя для аутентификации подключения к удалённому экземпляру NIOS. Значение также можно указать с помощью переменной среды `INFOBLOX_USERNAME`.
	validate_certs булево	Варианты: нет ← да	Булевое значение для включения или выключения проверки сертификатов SSL Значение также можно указать с помощью переменной среды `INFOBLOX_SSL_VERIFY`. псевдонимы: ssl_verify
	wapi_version строка	Значение по умолчанию: "2.1"	Указывает используемую версию WAPI Значение также можно указать с помощью переменной среды `INFOBLOX_WAP_VERSION`. До Ansible 2.8 значение по умолчанию для WAPI было 1.4.
return_fields строка			Список имён полей, которые нужно вернуть для указанного объекта.

Примечания

Примечание

Этот модуль должен быть запущен локально, что можно сделать, указав connection: local.
Для получения подробной информации об использовании Infoblox с Ansible, обратитесь к Руководству Infoblox.

Примеры

- name: fetch all networkview objects
  ansible.builtin.set_fact:
    networkviews: "{{ lookup('community.general.nios', 'networkview',
                         provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"

- name: fetch the default dns view
  ansible.builtin.set_fact:
    dns_views: "{{ lookup('community.general.nios', 'view', filter={'name': 'default'},
                      provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"

# all of the examples below use credentials that are  set using env variables
# export INFOBLOX_HOST=nios01
# export INFOBLOX_USERNAME=admin
# export INFOBLOX_PASSWORD=admin

- name: fetch all host records and include extended attributes
  ansible.builtin.set_fact:
    host_records: "{{ lookup('community.general.nios', 'record:host', return_fields=['extattrs', 'name', 'view', 'comment']}) }}"


- name: use env variables to pass credentials
  ansible.builtin.set_fact:
    networkviews: "{{ lookup('community.general.nios', 'networkview') }}"

- name: get a host record
  ansible.builtin.set_fact:
    host: "{{ lookup('community.general.nios', 'record:host', filter={'name': 'hostname.ansible.com'}) }}"

- name: get the authoritative zone from a non default dns view
  ansible.builtin.set_fact:
    host: "{{ lookup('community.general.nios', 'zone_auth', filter={'fqdn': 'ansible.com', 'view': 'ansible-dns'}) }}"

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

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

Ключ		Возвращаемое значение	Описание
obj_type словарь		успех	Тип объекта, указанного в аргументе terms
	obj_field строка	успех	Одно или несколько полей obj_type, как указано в аргументе return_fields, или набор полей по умолчанию для типа объекта.

Авторы

Неизвестно (!UNKNOWN)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/nios_lookup.html