File: //lib/python3.9/site-packages/ansible/plugins/lookup/__pycache__/url.cpython-39.pyc
a
�)g6# � @ s� d dl mZmZmZ eZdZdZdZd dl m
Z
mZ d dlm
Z
d dlmZmZ d dlmZmZmZ d d lmZ d d
lmZ e� ZG dd� de�Zd
S )� )�absolute_import�division�print_functiona<
name: url
author: Brian Coca (@bcoca)
version_added: "1.9"
short_description: return contents from URL
description:
- Returns the content of the URL requested to be used as data in play.
options:
_terms:
description: urls to query
validate_certs:
description: Flag to control SSL certificate validation
type: boolean
default: True
split_lines:
description: Flag to control if content is returned as a list of lines or as a single text blob
type: boolean
default: True
use_proxy:
description: Flag to control if the lookup will observe HTTP proxy environment variables when present.
type: boolean
default: True
username:
description: Username to use for HTTP authentication.
type: string
version_added: "2.8"
password:
description: Password to use for HTTP authentication.
type: string
version_added: "2.8"
headers:
description: HTTP request headers
type: dictionary
default: {}
version_added: "2.9"
force:
description: Whether or not to set "cache-control" header with value "no-cache"
type: boolean
version_added: "2.10"
default: False
vars:
- name: ansible_lookup_url_force
env:
- name: ANSIBLE_LOOKUP_URL_FORCE
ini:
- section: url_lookup
key: force
timeout:
description: How long to wait for the server to send data before giving up
type: float
version_added: "2.10"
default: 10
vars:
- name: ansible_lookup_url_timeout
env:
- name: ANSIBLE_LOOKUP_URL_TIMEOUT
ini:
- section: url_lookup
key: timeout
http_agent:
description: User-Agent to use in the request. The default was changed in 2.11 to C(ansible-httpget).
type: string
version_added: "2.10"
default: ansible-httpget
vars:
- name: ansible_lookup_url_agent
env:
- name: ANSIBLE_LOOKUP_URL_AGENT
ini:
- section: url_lookup
key: agent
force_basic_auth:
description: Force basic authentication
type: boolean
version_added: "2.10"
default: False
vars:
- name: ansible_lookup_url_agent
env:
- name: ANSIBLE_LOOKUP_URL_AGENT
ini:
- section: url_lookup
key: agent
follow_redirects:
description: String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information
type: string
version_added: "2.10"
default: 'urllib2'
vars:
- name: ansible_lookup_url_follow_redirects
env:
- name: ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS
ini:
- section: url_lookup
key: follow_redirects
use_gssapi:
description:
- Use GSSAPI handler of requests
- As of Ansible 2.11, GSSAPI credentials can be specified with I(username) and I(password).
type: boolean
version_added: "2.10"
default: False
vars:
- name: ansible_lookup_url_use_gssapi
env:
- name: ANSIBLE_LOOKUP_URL_USE_GSSAPI
ini:
- section: url_lookup
key: use_gssapi
use_netrc:
description:
- Determining whether to use credentials from ``~/.netrc`` file
- By default .netrc is used with Basic authentication headers
- When set to False, .netrc credentials are ignored
type: boolean
version_added: "2.14"
default: True
vars:
- name: ansible_lookup_url_use_netrc
env:
- name: ANSIBLE_LOOKUP_URL_USE_NETRC
ini:
- section: url_lookup
key: use_netrc
unix_socket:
description: String of file system path to unix socket file to use when establishing connection to the provided url
type: string
version_added: "2.10"
vars:
- name: ansible_lookup_url_unix_socket
env:
- name: ANSIBLE_LOOKUP_URL_UNIX_SOCKET
ini:
- section: url_lookup
key: unix_socket
ca_path:
description: String of file system path to CA cert bundle to use
type: string
version_added: "2.10"
vars:
- name: ansible_lookup_url_ca_path
env:
- name: ANSIBLE_LOOKUP_URL_CA_PATH
ini:
- section: url_lookup
key: ca_path
unredirected_headers:
description: A list of headers to not attach on a redirected request
type: list
elements: string
version_added: "2.10"
vars:
- name: ansible_lookup_url_unredir_headers
env:
- name: ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS
ini:
- section: url_lookup
key: unredirected_headers
ciphers:
description:
- SSL/TLS Ciphers to use for the request
- 'When a list is provided, all ciphers are joined in order with C(:)'
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT)
for more details.
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions
type: list
elements: string
version_added: '2.14'
vars:
- name: ansible_lookup_url_ciphers
env:
- name: ANSIBLE_LOOKUP_URL_CIPHERS
ini:
- section: url_lookup
key: ciphers
a�
- 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'} ) }}"
zg
_list:
description: list of list of lines or content of url(s)
type: list
elements: str
)� HTTPError�URLError)�AnsibleError)�to_text� to_native)�open_url�ConnectionError�SSLValidationError)�
LookupBase)�Displayc @ s e Zd Zddd�ZdS )�LookupModuleNc K s� | j ||d� g }|D �]�}t�d| � z�t|| �d�| �d�| �d�| �d�| �d�| �d�| �d �| �d
�| �d�| �d�| �d
�| �d�| �d�| �d�| �d�| �d�d�}W n� ty� } z td|t|�f ��W Y d }~n�d }~0 t�y( } z td|t|�f ��W Y d }~nzd }~0 t �y` } z td|t|�f ��W Y d }~nBd }~0 t
�y� } z td|t|�f ��W Y d }~n
d }~0 0 | �d��r�|�� �� D ]}|�
t|�� �q�q|�
t|�� �� q|S )N)Zvar_optionsZdirectzurl lookup connecting to %s�validate_certs� use_proxy�username�password�headers�force�timeout�
http_agent�force_basic_auth�follow_redirects�
use_gssapi�unix_socket�ca_path�unredirected_headers�ciphers� use_netrc)r r Zurl_usernameZurl_passwordr r r r r r r r r r r r zReceived HTTP error for %s : %szFailed lookup url for %s : %sz4Error validating the server's certificate for %s: %szError connecting to %s: %sZsplit_lines)Zset_options�displayZvvvvr
Z
get_optionr r r r r r �read�
splitlines�appendr ) �selfZtermsZ variables�kwargs�retZtermZresponse�e�line� r) �>/usr/lib/python3.9/site-packages/ansible/plugins/lookup/url.py�run� sH
�
(((*zLookupModule.run)N)�__name__�
__module__�__qualname__r+ r) r) r) r* r � s r N)Z
__future__r r r �typeZ
__metaclass__Z
DOCUMENTATIONZEXAMPLESZRETURNZurllib.errorr r Zansible.errorsr Zansible.module_utils._textr r Zansible.module_utils.urlsr
r r Zansible.plugins.lookupr
Zansible.utils.displayr r r r) r) r) r* �<module> s 2