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，因为特权提升需要 shell。
free_form 字符串 / 必需	raw 模块接受一个自由格式的命令来运行。实际上没有名为“自由格式”的参数；请参阅示例！

属性 

属性	支持	描述
check_mode	支持：无	可以在 check_mode 中运行并返回更改状态预测，而无需修改目标，如果不受支持，则操作将被跳过。
diff_mode	支持：无	在 diff 模式下，将返回有关已更改内容（或可能在 check_mode 下需要更改的内容）的详细信息
platform	平台：全部此操作是少数不需要远程 Python 的操作之一，因为它将命令直接传递到连接字符串中	可以针对其进行操作的目标操作系统/系列
raw	支持：完全	指示操作是否接受“原始”或“自由格式”字符串作为选项，并对其进行特殊解析

备注 

注意

如果从剧本中使用 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