url – return contents from URL

From Get docs
< Lookup PluginsAnsible/docs/2.7/plugins/lookup/url


url – return contents from URL

New in version 1.9.


Synopsis

  • Returns the content of the URL requested to be used as data in play.

Parameters

Parameter Choices/Defaults Configuration Comments

_terms

-

urls to query

split_lines

boolean

Default:

"yes"

Flag to control if content is returned as a list of lines or as a single text blob

use_proxy

boolean

Default:

"yes"

Flag to control if the lookup will observe HTTP proxy environment variables when present.

validate_certs

boolean

Default:

"yes"

Flag to control SSL certificate validation



Examples

- 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) }}"

Return Values

Common return values are documented here, the following are the fields unique to this lookup:

Key Returned Description

_list

-

list of list of lines or content of url(s)





Status

Authors

  • Brian Coca (@bcoca)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/plugins/lookup/url.html