ansible.builtin.script 模块 – 在传输后在远程节点上运行本地脚本

注意

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

概要 

ansible.builtin.script 模块接受脚本名称，后跟以空格分隔的参数列表。
需要一个自由格式的命令或 cmd 参数，请参阅示例。
本地路径下的脚本将被传输到远程节点，然后执行。
给定的脚本将在远程节点上的 shell 环境中处理。
与 ansible.builtin.raw 模块类似，此模块不需要远程系统上的 Python。
此模块也支持 Windows 目标。

注意

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

参数 

参数	注释
chdir 字符串	在运行脚本之前，切换到远程节点上的此目录。
cmd 字符串	要运行的本地脚本的路径，后跟可选参数。
creates 字符串	远程节点上的文件名，当它已经存在时，此步骤将不会运行。
decrypt 布尔值	此选项控制使用 Vault 自动解密源文件。选项 `false` `true` ← (默认)
executable 字符串	用于调用脚本的可执行文件的名称或路径。
free_form 字符串	本地脚本文件的路径，后跟可选参数。
removes 字符串	远程节点上的文件名，当它不存在时，此步骤将不会运行。

属性 

属性	支持	描述
check_mode	支持：部分虽然脚本本身是任意的，不能受制于检查模式语义，但它添加了 `creates`/`removes` 选项作为一种解决方法	可以在 check_mode 中运行并返回更改状态预测，而无需修改目标；如果不支持，则将跳过该操作。
diff_mode	支持：无	在 diff 模式下，将返回已更改的内容（或在 check_mode 中可能需要更改的内容）的详细信息
platform	平台：全部此操作是少数几个不需要远程 Python 的操作之一，因为它直接将命令传递到连接字符串中	可以对其进行操作的目标操作系统/系列
raw	支持：完全	指示操作是否采用“原始”或“自由格式”字符串作为选项，并对其进行特殊的解析
safe_file_operations	支持：无	使用 Ansible 的严格文件操作函数来确保正确的权限并避免数据损坏
vault	支持：完全	可以自动解密 Ansible Vault 文件

注释 

注意

通常，最好编写 Ansible 模块，而不是推送脚本。将您的脚本转换为 Ansible 模块以获得额外积分！
当执行脚本时，ansible.builtin.ssh 连接插件将通过 -tt 强制分配伪终端。伪终端没有 stderr 通道，所有 stderr 都将发送到 stdout。如果您依赖于分离的 stdout 和 stderr 结果键，请切换到一组包含 ansible.builtin.copy 和 ansible.builtin.command 的任务，而不是使用 ansible.builtin.script。
如果本地脚本的路径包含空格，则需要用引号引起来。
此模块也支持 Windows 目标。
如果脚本返回非 UTF-8 数据，则必须对其进行编码以避免出现问题。一种方法是通过 base64 管道输出。

另请参阅 

另请参阅

ansible.builtin.shell: 在目标上执行 shell 命令。
ansible.windows.win_shell: 关于 ansible.windows.win_shell 模块的官方文档。

示例 

- name: Run a script with arguments (free form)
  ansible.builtin.script: /some/local/script.sh --some-argument 1234

- name: Run a script with arguments (using 'cmd' parameter)
  ansible.builtin.script:
    cmd: /some/local/script.sh --some-argument 1234

- name: Run a script only if file.txt does not exist on the remote node
  ansible.builtin.script: /some/local/create_file.sh --some-argument 1234
  args:
    creates: /the/created/file.txt

- name: Run a script only if file.txt exists on the remote node
  ansible.builtin.script: /some/local/remove_file.sh --some-argument 1234
  args:
    removes: /the/removed/file.txt

- name: Run a script using an executable in a non-system path
  ansible.builtin.script: /some/local/script
  args:
    executable: /some/remote/executable

- name: Run a script using an executable in a system path
  ansible.builtin.script: /some/local/script.py
  args:
    executable: python3

- name: Run a Powershell script on a Windows host
  script: subdirectories/under/path/with/your/playbook/script.ps1

作者

Ansible Core 团队
Michael DeHaan