ansible.builtin.url lookup – return contents from URL
Note
This lookup plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
url
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same lookup plugin name.
Synopsis
Returns the content of the URL requested to be used as data in play.
Terms
Parameter |
Comments |
---|---|
urls to query |
Keyword parameters
This describes keyword parameters of the lookup. These are the values key1=value1
, key2=value2
and so on in the following
examples: lookup('ansible.builtin.url', key1=value1, key2=value2, ...)
and query('ansible.builtin.url', key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
String of file system path to CA cert bundle to use Configuration:
|
|
String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information Default: Configuration:
|
|
Whether or not to set “cache-control” header with value “no-cache” Choices:
Configuration:
|
|
Force basic authentication Choices:
Configuration:
|
|
HTTP request headers Default: |
|
User-Agent to use in the request. The default was changed in 2.11 to Default: Configuration:
|
|
Password to use for HTTP authentication. |
|
Flag to control if content is returned as a list of lines or as a single text blob Choices:
|
|
How long to wait for the server to send data before giving up Default: Configuration:
|
|
String of file system path to unix socket file to use when establishing connection to the provided url Configuration:
|
|
A list of headers to not attach on a redirected request Configuration:
|
|
Use GSSAPI handler of requests As of Ansible 2.11, GSSAPI credentials can be specified with username and password. Choices:
Configuration:
|
|
Flag to control if the lookup will observe HTTP proxy environment variables when present. Choices:
|
|
Username to use for HTTP authentication. |
|
Flag to control SSL certificate validation Choices:
|
Notes
Note
When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters:
lookup('ansible.builtin.url', term1, term2, key1=value1, key2=value2)
andquery('ansible.builtin.url', term1, term2, key1=value1, key2=value2)
Examples
- name: url lookup splits lines by default
ansible.builtin.debug: msg="{{item}}"
loop: "{{ lookup('ansible.builtin.url', 'https://github.com/gremlin.keys', wantlist=True) }}"
- name: display ip ranges
ansible.builtin.debug: msg="{{ lookup('ansible.builtin.url', 'https://ip-ranges.amazonaws.com/ip-ranges.json', split_lines=False) }}"
- name: url lookup using authentication
ansible.builtin.debug: msg="{{ lookup('ansible.builtin.url', 'https://some.private.site.com/file.txt', username='bob', password='hunter2') }}"
- name: url lookup using basic authentication
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.url', 'https://some.private.site.com/file.txt', username='bob', password='hunter2', force_basic_auth='True') }}"
- name: url lookup using headers
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.url', 'https://some.private.site.com/api/service', headers={'header1':'value1', 'header2':'value2'} ) }}"
Return Value
Key |
Description |
---|---|
list of list of lines or content of url(s) Returned: success |