ansible.builtin.raw 模块 – 执行底层命令

注意

此模块是 ansible-core 的一部分，并包含在所有 Ansible 安装中。在大多数情况下，即使不指定集合关键字，也可以使用短模块名 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

string

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

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

free_form

string / required

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

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

属性

属性

支持

描述

check_mode

支持： 无

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

diff_mode

支持： 无

当处于 diff 模式时，将返回有关已更改的内容（或可能需要在 check_mode 中更改的内容）的详细信息

platform

平台： 全部

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

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

raw

支持： 完全

指示操作是否将“raw”或“自由格式”字符串作为选项，并且对其进行自己的特殊解析

注意

注意

  • 如果从 playbook 使用 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 Core 团队

  • Michael DeHaan