File: //lib/python3.9/site-packages/ansible/plugins/lookup/__pycache__/pipe.cpython-39.pyc
a
�)g� � @ sX d dl mZmZmZ eZdZdZdZd dl Z d dl
mZ d dlm
Z
G dd � d e
�ZdS )
� )�absolute_import�division�print_functiona�
name: pipe
author: Daniel Hokka Zakrisson (!UNKNOWN) <[email protected]>
version_added: "0.9"
short_description: read output from a command
description:
- Run a command and return the output.
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,
so if you need to 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.
- Pipe lookup internally invokes Popen with shell=True (this is required and intentional).
This type of invocation is considered a security issue if appropriate care is not taken to sanitize any user provided or variable input.
It is strongly recommended to pass user input or variable input via quote filter before using with pipe lookup.
See example section for this.
Read more about this L(Bandit B602 docs,https://bandit.readthedocs.io/en/latest/plugins/b602_subprocess_popen_with_shell_equals_true.html)
aB
- name: raw result of running date command
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.pipe', 'date') }}"
- name: Always use quote filter to make sure your variables are safe to use with shell
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.pipe', 'getent passwd ' + myuser | quote ) }}"
zZ
_string:
description:
- stdout from command
type: list
elements: str
N)�AnsibleError)�
LookupBasec @ s e Zd Zdd� ZdS )�LookupModulec K sv g }|D ]h}t |�}tj|| j�� dtjtjd�}|�� \}}|jdkr^|�|� d��
� � qtd||jf ��q|S )NT)�cwd�shell�stdin�stdoutr zutf-8z"lookup_plugin.pipe(%s) returned %d)�str�
subprocess�PopenZ_loaderZget_basedir�PIPEZcommunicate�
returncode�append�decode�rstripr ) �selfZtermsZ variables�kwargs�retZterm�pr �stderr� r �?/usr/lib/python3.9/site-packages/ansible/plugins/lookup/pipe.py�run7 s
zLookupModule.runN)�__name__�
__module__�__qualname__r r r r r r 5 s r )Z
__future__r r r �typeZ
__metaclass__Z
DOCUMENTATIONZEXAMPLESZRETURNr
Zansible.errorsr Zansible.plugins.lookupr r r r r r �<module> s