mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-10 18:34:03 -07:00
Lookup docs (#30280)
* finalize lookup documentation * minor fixes to ansible-doc - actually show which file caused error on when listing plugins - removed redundant display of type and name * smart quote fixes from toshio
This commit is contained in:
parent
2ef8c5a03d
commit
24d4787b2d
40 changed files with 1715 additions and 853 deletions
|
@ -1,22 +1,42 @@
|
|||
# (c) 2015, Brian Coca <bcoca@ansible.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
# (c) 2012-17 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = """
|
||||
lookup: url
|
||||
author: Brian Coca <bcoca@ansible.com>
|
||||
version_added: "1.9"
|
||||
short_description: return contents from URL
|
||||
description:
|
||||
_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
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: url lookup splits lines by default
|
||||
debug: msg="{{item}}"
|
||||
with_url:
|
||||
- 'https://github.com/gremlin.keys'
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
_list:
|
||||
description: list of list of lines or content of url(s)
|
||||
"""
|
||||
|
||||
from ansible.errors import AnsibleError
|
||||
from ansible.module_utils.six.moves.urllib.error import HTTPError, URLError
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue