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

Примечание

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

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

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

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

Описание

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

Требования

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

infoblox-client

Параметры

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

Примечания

Примечание

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

Примеры

- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/nios_lookup.html