ansible.builtin.raw 模块 - 执行低级命令

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使没有指定 collections 关键字，您也可以使用简短模块名称 raw。但是，我们建议您使用 完全限定集合名称 (FQCN) ansible.builtin.raw 来方便链接到模块文档并避免与可能具有相同模块名称的其他集合冲突。

概要

  • 执行低级 SSH 命令，不通过模块子系统。

  • 这很有用，但只应在少数情况下使用。一个常见的情况是在没有默认安装 python 的系统上安装 python。另一个是与任何没有安装 Python 的设备（如路由器）通信。在任何其他情况下，使用 ansible.builtin.shell 或 ansible.builtin.command 模块更合适。

  • 传递给 raw 的参数将直接通过配置的远程 shell 运行。

  • 标准输出、错误输出和返回代码将在可用时返回。

  • 此模块没有更改处理程序支持。

  • 此模块不需要远程系统上的 python，类似于 ansible.builtin.script 模块。

  • 此模块也支持 Windows 目标。

  • 如果命令返回非 UTF-8 数据，则必须对其进行编码以避免问题。一个选项是通过 base64 管道输出。

注意

此模块具有相应的 动作插件。

参数

参数

注释

executable

字符串

更改用于执行命令的 shell。应该是可执行文件的绝对路径。

使用特权升级 (become) 时，如果未提供默认 shell，则会分配一个，因为特权升级需要 shell。

free_form

字符串 / 必需

raw 模块接受一个要运行的自由格式命令。

实际上没有名为“free form”的参数；请参见示例！

属性

属性

支持

描述

check_mode

支持：无

可以在 check_mode 中运行并返回更改状态预测，而无需修改目标，如果不受支持，则将跳过操作。

diff_mode

支持：无

将在差异模式下返回有关更改内容（或可能在 check_mode 中需要更改内容）的详细信息

platform

平台： 所有

此操作是少数不需要远程系统上 Python 的操作之一，因为它将命令直接传递到连接字符串中

可以针对其执行操作的目标操作系统/系列

raw

支持：完全支持

指示操作是否采用“raw”或“free form”字符串作为选项，并对其进行特殊解析

备注

注意

  • 如果从剧本中使用 raw，您可能需要使用 gather_facts: no 禁用事实收集，如果您使用 raw 将 python 引导到机器上。

  • 如果您想以安全和可预测的方式执行命令，最好使用 ansible.builtin.command 或 ansible.builtin.shell 模块。

  • 关键字 environment 通常不适用于 raw，它需要一个 shell，这意味着它仅在设置了 executable 或使用具有特权升级 (become) 的模块时才有效。

另请参阅

另请参阅

ansible.builtin.command

在目标上执行命令。

ansible.builtin.shell

在目标上执行 shell 命令。

ansible.windows.win_command

有关 **ansible.windows.win_command** 模块的官方文档。

ansible.windows.win_shell

有关 **ansible.windows.win_shell** 模块的官方文档。

示例

- name: Bootstrap a host without python2 installed
  ansible.builtin.raw: dnf install -y python2 python2-dnf libselinux-python

- name: Run a command that uses non-posix shell-isms (in this example /bin/sh doesn't handle redirection and wildcards together but bash does)
  ansible.builtin.raw: cat < /tmp/*txt
  args:
    executable: /bin/bash

- name: Safely use templated variables. Always use quote filter to avoid injection issues.
  ansible.builtin.raw: "{{ package_mgr|quote }} {{ pkg_flags|quote }} install {{ python|quote }}"

- name: List user accounts on a Windows system
  ansible.builtin.raw: Get-WmiObject -Class Win32_UserAccount

作者

  • Ansible 核心团队

  • Michael DeHaan