ansible.builtin.pipe lookup – 读取命令输出

注意

此lookup插件是ansible-core的一部分，包含在所有Ansible安装中。在大多数情况下，您可以使用简短的插件名称pipe。但是，我们建议您使用完全限定的集合名称 (FQCN) ansible.builtin.pipe，以便轻松链接到插件文档并避免与可能具有相同lookup插件名称的其他集合冲突。

概要

  • 运行命令并返回输出。

术语

参数

注释

术语

字符串 / 必填

要运行的命令。

备注

注意

  • 与所有lookup一样，此操作在Ansible控制器上运行，不受其他关键字（如become）的影响，因此，如果您需要不同的权限，则必须更改命令或以其他用户身份运行Ansible。

  • 或者，您可以使用针对localhost运行并注册结果的shell/command任务。

  • Pipe lookup在内部使用shell=True调用Popen（这是必需的且故意的）。如果不对用户提供或变量输入进行适当的清理，此类型的调用会被认为是安全问题。强烈建议在使用pipe lookup之前，通过quote过滤器传递用户输入或变量输入。请参阅示例部分。阅读更多关于此的信息 Bandit B602文档

  • play的目录用作当前工作目录。

示例

- 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 ) }}"

返回值

键

描述

返回值

列表 / 元素=字符串

命令的标准输出

返回：成功

作者

  • Daniel Hokka Zakrisson

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。