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] переменная среды:ANSIBLE_LOOKUP_URL_CA_PATH переменная: ansible_lookup_url_ca_path | Строка пути к файлу с корневым сертификатом для использования | |
| follow_redirects строка добавлен в 2.10 ansible.builtin | По умолчанию: "urllib2" | записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS переменная: ansible_lookup_url_follow_redirects | Строка "urllib2", "all"/"yes", "safe", "none" для определения обработки редиректов, см. RedirectHandlerFactory для получения дополнительной информации |
| force булево добавлен в 2.10 ansible.builtin |
| записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_FORCE переменная: ansible_lookup_url_force | Устанавливать заголовок "cache-control" со значением "no-cache" или нет |
| force_basic_auth булево добавлен в 2.10 ansible.builtin |
| записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_AGENT переменная: ansible_lookup_url_agent | Принудительное использование базовой аутентификации |
| headers словарь добавлен в 2.9 ansible.builtin | По умолчанию: {} | HTTP заголовки запроса | |
| http_agent строка добавлен в 2.10 ansible.builtin | записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_AGENT переменная: ansible_lookup_url_agent | Использовать User-Agent в запросе | |
| password строка добавлен в 2.8 ansible.builtin | Пароль для HTTP аутентификации. | ||
| split_lines булево |
| Флаг, определяющий, возвращать содержимое как список строк или как единый текстовый блок | |
| timeout число с плавающей запятой добавлен в 2.10 ansible.builtin | По умолчанию: 10 | записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_TIMEOUT переменная: ansible_lookup_url_timeout | Время ожидания ответа сервера перед прекращением |
| unix_socket строка добавлен в 2.10 ansible.builtin | записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_UNIX_SOCKET переменная: ansible_lookup_url_unix_socket | Строка пути к файлу unix-сокет для подключения по указанному URL. | |
| unredirected_headers список / элементы=строка добавлен в 2.10 ansible.builtin | записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS переменная: ansible_lookup_url_unredir_headers | Список заголовков, которые не должны прикрепляться к перенаправленному запросу | |
| use_gssapi булево добавлен в 2.10 ansible.builtin |
| записи ini: [url_lookup] переменная среды:ANSIBLE_LOOKUP_URL_USE_GSSAPI переменная: ansible_lookup_url_use_gssapi | Использование обработчика 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/url_lookup.html
