aff78f4cbc
* Fix various sanity errors in plugins.
* Revert callback_type -> type transform.
* Undo paramiko_ssh 'connection' change, since this discrepancy is hardcoded in the plugin loader.
* Standardize on name and type (for callbacks).
* Fix existing author entries.
* Add 'Unknown (!UNKNOWN)' as author when author is missing.
* These are actually parsed as integers in the code.
* Revert "Add 'Unknown (!UNKNOWN)' as author when author is missing."
This reverts commit 29d1438aca.
63 lines
2.1 KiB
Python
63 lines
2.1 KiB
Python
# (c) 2012, Daniel Hokka Zakrisson <daniel@hozac.com>
|
|
# (c) 2017 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 = """
|
|
name: lines
|
|
author: Daniel Hokka Zakrisson (!UNKNOWN) <daniel@hozac.com>
|
|
version_added: "0.9"
|
|
short_description: read lines from command
|
|
description:
|
|
- Run one or more commands and split the output into lines, returning them as a list
|
|
options:
|
|
_terms:
|
|
description: command(s) to run
|
|
required: True
|
|
notes:
|
|
- Like all lookups, this runs on the Ansible controller and is unaffected by other keywords such as 'become'.
|
|
If you need to use different permissions, you must change the command or run Ansible as another user.
|
|
- Alternatively, you can use a shell/command task that runs against localhost and registers the result.
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- name: We could read the file directly, but this shows output from command
|
|
debug: msg="{{ item }} is an output line from running cat on /etc/motd"
|
|
with_lines: cat /etc/motd
|
|
|
|
- name: More useful example of looping over a command result
|
|
shell: "/usr/bin/frobnicate {{ item }}"
|
|
with_lines:
|
|
- "/usr/bin/frobnications_per_host --param {{ inventory_hostname }}"
|
|
"""
|
|
|
|
RETURN = """
|
|
_list:
|
|
description:
|
|
- lines of stdout from command
|
|
type: list
|
|
elements: str
|
|
"""
|
|
|
|
import subprocess
|
|
from ansible.errors import AnsibleError
|
|
from ansible.plugins.lookup import LookupBase
|
|
from ansible.module_utils._text import to_text
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
|
|
def run(self, terms, variables, **kwargs):
|
|
|
|
ret = []
|
|
for term in terms:
|
|
p = subprocess.Popen(term, cwd=self._loader.get_basedir(), shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE)
|
|
(stdout, stderr) = p.communicate()
|
|
if p.returncode == 0:
|
|
ret.extend([to_text(l) for l in stdout.splitlines()])
|
|
else:
|
|
raise AnsibleError("lookup_plugin.lines(%s) returned %d" % (term, p.returncode))
|
|
return ret
|