W3cubDocs

pipe – read output from a command

Synopsis
Parameters
Notes
Examples
Return Values
Status

Synopsis

Run a command and return the output

Parameters

Parameter	Choices/Defaults	Configuration	Comments
_terms - / required			command(s) to run

Notes

Note

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.

Examples

- name: raw result of running date command"
  debug: msg="{{ lookup('pipe','date') }}"

- name: Always use quote filter to make sure your variables are safe to use with shell
  debug: msg="{{ lookup('pipe','getent ' + myuser|quote ) }}"

Return Values

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

Key	Returned	Description
_string -		stdout from command

Status

This lookup is not guaranteed to have a backwards compatible interface. [preview]
This lookup is maintained by the Ansible Community. [community]

Authors

Daniel Hokka Zakrisson <daniel@hozac.com>

Hint

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

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.

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