ansible.builtin.url – возврат содержимого из URL

Примечание

Этот модуль входит в состав ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля url даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя класса (FQCN) для удобной ссылки на документацию по модулю и для предотвращения конфликтов с другими коллекциями, которые могут иметь такое же имя модуля.

В версии 1.9: из ansible.builtin

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

Описание

Возвращает содержимое запрошенного URL-адреса для использования в качестве данных в роли.

Параметры

Параметр	Варианты/Значения по умолчанию	Конфигурация	Комментарии
_terms строка			URL-адреса для запроса
ca_path строка добавлен в версии 2.10 ansible.builtin		записи ini: [url_lookup] ca_path = None переменная среды:ANSIBLE_LOOKUP_URL_CA_PATH переменная: ansible_lookup_url_ca_path	Строка пути к файлу с сертификатом CA для использования
follow_redirects строка добавлен в версии 2.10 ansible.builtin	Значение по умолчанию: "urllib2"	записи ini: [url_lookup] follow_redirects = urllib2 переменная среды:ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS переменная: ansible_lookup_url_follow_redirects	Строка urllib2, all/yes, safe, none для определения, как обрабатываются перенаправления, см. RedirectHandlerFactory для получения дополнительной информации
force булево добавлен в версии 2.10 ansible.builtin	Варианты: нет ← да	записи ini: [url_lookup] force = нет переменная среды:ANSIBLE_LOOKUP_URL_FORCE переменная: ansible_lookup_url_force	Устанавливать заголовок "cache-control" со значением "no-cache"
force_basic_auth булево добавлен в версии 2.10 ansible.builtin	Варианты: нет ← да	записи ini: [url_lookup] agent = нет переменная среды:ANSIBLE_LOOKUP_URL_AGENT переменная: ansible_lookup_url_agent	Принудительное использование базовой аутентификации
headers словарь добавлен в версии 2.9 ansible.builtin	Значение по умолчанию: {}		Заголовки HTTP-запроса
http_agent строка добавлен в версии 2.10 ansible.builtin	Значение по умолчанию: "ansible-httpget"	записи ini: [url_lookup] agent = ansible-httpget переменная среды:ANSIBLE_LOOKUP_URL_AGENT переменная: ansible_lookup_url_agent	Используемый User-Agent в запросе. Значение по умолчанию было изменено в версии 2.11 на `ansible-httpget`.
password строка добавлен в версии 2.8 ansible.builtin			Пароль для аутентификации по HTTP.
split_lines булево	Варианты: нет да ←		Флаг, определяющий, возвращается ли содержимое в виде списка строк или как один текст.
timeout вещественное число добавлен в версии 2.10 ansible.builtin	Значение по умолчанию: 10	записи ini: [url_lookup] timeout = 10 переменная среды:ANSIBLE_LOOKUP_URL_TIMEOUT переменная: ansible_lookup_url_timeout	Время ожидания ответа от сервера перед отказом
unix_socket строка добавлен в версии 2.10 ansible.builtin		записи ini: [url_lookup] unix_socket = None переменная среды:ANSIBLE_LOOKUP_URL_UNIX_SOCKET переменная: ansible_lookup_url_unix_socket	Строка пути к файлу сокета Unix для использования при подключении к предоставленному URL-адресу.
unredirected_headers список / элементы=строка добавлен в версии 2.10 ansible.builtin		записи ini: [url_lookup] unredirected_headers = None переменная среды:ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS переменная: ansible_lookup_url_unredir_headers	Список заголовков, которые не должны добавляться к перенаправленному запросу
use_gssapi булево добавлен в версии 2.10 ansible.builtin	Варианты: нет ← да	записи ini: [url_lookup] use_gssapi = нет переменная среды:ANSIBLE_LOOKUP_URL_USE_GSSAPI переменная: ansible_lookup_url_use_gssapi	Использовать обработчик GSSAPI для запросов Начиная с Ansible 2.11, учетные данные GSSAPI можно указать с помощью имя_пользователя и пароля.
use_proxy булево	Варианты: нет да ←		Флаг, определяющий, будет ли поиск использовать переменные среды HTTP-прокси, если они присутствуют.
username строка добавлен в версии 2.8 ansible.builtin			Имя пользователя для аутентификации по HTTP.
validate_certs булево	Варианты: нет да ←		Флаг для управления проверкой SSL-сертификатов

Примеры

- name: url lookup splits lines by default
  debug: msg="{{item}}"
  loop: "{{ lookup('url', 'https://github.com/gremlin.keys', wantlist=True) }}"

- name: display ip ranges
  debug: msg="{{ lookup('url', 'https://ip-ranges.amazonaws.com/ip-ranges.json', split_lines=False) }}"

- name: url lookup using authentication
  debug: msg="{{ lookup('url', 'https://some.private.site.com/file.txt', username='bob', password='hunter2') }}"

- name: url lookup using basic authentication
  debug: msg="{{ lookup('url', 'https://some.private.site.com/file.txt', username='bob', password='hunter2', force_basic_auth='True') }}"

- name: url lookup using headers
  debug: msg="{{ lookup('url', 'https://some.private.site.com/api/service', headers={'header1':'value1', 'header2':'value2'} ) }}"

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

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

Ключ	Возвращаемое значение	Описание
_list список / элементы=строка	успех	список списков строк или содержимое URL-адреса(ов)

Авторы

Brian Coca (@bcoca)

© 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/ansible/builtin/url_lookup.html