ansible.builtin.command 模块 – 在目标上执行命令

注意

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

概要

• ansible.builtin.command 模块接受命令名称，后跟一个空格分隔的参数列表。

• 给定的命令将在所有选定的节点上执行。

• 命令不会通过 shell 处理，因此 "*"、"<"、">"、"|"、";" 和 "&" 不会起作用。此外，环境变量通过 Python 解析，而不是 shell，请参见 expand_argument_vars，如果未匹配，则保持不变。如果您需要这些功能，请使用 ansible.builtin.shell 模块。

• 要创建易于阅读的 command 任务（比使用空格分隔的参数更容易阅读），请使用 args 任务关键字 传递参数，或使用 cmd 参数。

• 需要自由格式命令或 cmd 参数，请参见示例。

• 对于 Windows 目标，请改用 ansible.windows.win_command 模块。

注意

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

参数

参数	注释
argv list / elements=string	将命令作为列表而不是字符串传递。 使用 argv 来避免对将被错误解释的值（例如“用户名”）进行引号。 只能提供字符串（自由格式）或列表（argv）形式，不能同时提供两者。必须提供其中之一。
chdir path	在运行命令之前更改到此目录。
cmd string	要运行的命令。
creates path	文件名或（自 2.0 起）通配符模式。如果匹配的文件已存在，则不会运行此步骤。 在检查 removes 之前检查此项。
expand_argument_vars boolean 添加到 ansible-core 2.16 中	扩展作为变量的参数，例如 $HOME 将在传递到要运行的命令之前进行扩展。 如果变量没有匹配，它将保持不变，这与 shell 替换不同，shell 替换会将其删除。 设置为 false 以禁用扩展并将该值视为文字参数。 选择 false true ← (默认)
free_form string	command 模块接受自由格式字符串作为要运行的命令。 没有名为 free_form 的实际参数。
removes path	文件名或（自 2.0 起）通配符模式。如果匹配的文件存在，则会运行此步骤。 在检查 creates 之后检查此项。
stdin string	将命令的 stdin 直接设置为指定的值。
stdin_add_newline boolean 添加到 Ansible 2.8 中	如果设置为 true，则在 stdin 数据末尾添加一个换行符。 选择 false true ← (默认)
strip_empty_ends boolean 添加到 Ansible 2.8 中	从结果中的 stdout/stderr 末尾删除空行。 选择 false true ← (默认)

属性

属性	支持	描述
check_mode	支持：部分 虽然命令本身是任意的，不能受 check 模式语义的影响，但它添加了 creates/removes 选项作为一种变通方法	可以在 check_mode 中运行并返回已更改状态预测，而无需修改目标，如果不受支持，则将跳过操作。
diff_mode	支持：无	在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息
platform	平台： posix	可以针对其进行操作的目标操作系统/系列
raw	支持：完整	指示操作是否采用“原始”或“自由格式”字符串作为选项，并且具有其自身的特殊解析方式

注释

注意

• 如果您想通过 shell 运行命令（例如，您使用 <、>、| 等），您实际上需要的是 ansible.builtin.shell 模块。解析 shell 元字符会导致意外的命令执行（如果引号不正确），因此在可能的情况下使用 ansible.builtin.command 模块更安全。

• creates、removes 和 chdir 可以指定在命令之后。例如，如果您只想在特定文件不存在时运行命令，请使用此方法。

• 当传递 creates 或 removes 时，支持检查模式。如果在检查模式下运行，并且指定了其中任何一个，模块将检查文件是否存在并报告正确的更改状态。如果没有提供这些，则任务将被跳过。

• 从版本 2.4 开始，executable 参数已被删除。如果您需要此参数，请改用 ansible.builtin.shell 模块。

• 对于 Windows 目标，请改用 ansible.windows.win_command 模块。

• 对于重新启动系统，请使用 ansible.builtin.reboot 或 ansible.windows.win_reboot 模块。

• 如果命令返回非 UTF-8 数据，则必须将其编码以避免出现问题。这可能需要使用 ansible.builtin.shell，以便输出可以通过 base64 进行管道传输。

另请参阅

另请参阅

ansible.builtin.raw

执行一个直接粗暴的命令。

ansible.builtin.script

在传输后在远程节点上运行本地脚本。

ansible.builtin.shell

在目标上执行 shell 命令。

ansible.windows.win_command

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

示例

- name: Return motd to registered var
  ansible.builtin.command: cat /etc/motd
  register: mymotd

# free-form (string) arguments, all arguments on one line
- name: Run command if /path/to/database does not exist (without 'args')
  ansible.builtin.command: /usr/bin/make_database.sh db_user db_name creates=/path/to/database

# free-form (string) arguments, some arguments on separate lines with the 'args' keyword
# 'args' is a task keyword, passed at the same level as the module
- name: Run command if /path/to/database does not exist (with 'args' keyword)
  ansible.builtin.command: /usr/bin/make_database.sh db_user db_name
  args:
    creates: /path/to/database

# 'cmd' is module parameter
- name: Run command if /path/to/database does not exist (with 'cmd' parameter)
  ansible.builtin.command:
    cmd: /usr/bin/make_database.sh db_user db_name
    creates: /path/to/database

- name: Change the working directory to somedir/ and run the command as db_owner if /path/to/database does not exist
  ansible.builtin.command: /usr/bin/make_database.sh db_user db_name
  become: yes
  become_user: db_owner
  args:
    chdir: somedir/
    creates: /path/to/database

# argv (list) arguments, each argument on a separate line, 'args' keyword not necessary
# 'argv' is a parameter, indented one level from the module
- name: Use 'argv' to send a command as a list - leave 'command' empty
  ansible.builtin.command:
    argv:
      - /usr/bin/make_database.sh
      - Username with whitespace
      - dbname with whitespace
    creates: /path/to/database

- name: Run command using argv with mixed argument formats
  ansible.builtin.command:
    argv:
      - /path/to/binary
      - -v
      - --debug
      - --longopt
      - value for longopt
      - --other-longopt=value for other longopt
      - positional

- name: Safely use templated variable to run command. Always use the quote filter to avoid injection issues
  ansible.builtin.command: cat {{ myfile|quote }}
  register: myoutput

返回值

常见的返回值在 此处 有记录，以下是此模块特有的字段

Key	描述
cmd list / elements=string	任务执行的命令。 返回： 始终 示例： ["echo", "hello"]
delta string	命令执行时间差。 返回： 始终 示例： "0:00:00.001529"
end string	命令执行结束时间。 返回： 始终 示例： "2017-09-29 22:03:48.084657"
msg boolean	changed 返回： 始终 示例： true
rc 整数	命令返回值（0 表示成功）。 返回： 始终 示例： 0
start string	命令执行开始时间。 返回： 始终 示例： "2017-09-29 22:03:48.083128"
stderr string	命令标准错误输出。 返回： 始终 示例： "ls cannot access foo: No such file or directory"
stderr_lines list / elements=string	命令标准错误输出按行拆分。 返回： 始终 示例： [{"u'ls cannot access foo": "No such file or directory'"}, "u'ls \u2026'"]
stdout string	命令标准输出。 返回： 始终 示例： "Clustering node rabbit@slave1 with rabbit@master \u2026"
stdout_lines list / elements=string	命令标准输出按行拆分。 返回： 始终 示例： ["u'Clustering node rabbit@slave1 with rabbit@master \u2026'"]

作者

• Ansible 核心团队

• Michael DeHaan

收藏链接

• 问题跟踪器
• 仓库（来源）
• 通信