ansible.builtin.expect 模块 – 执行命令并响应提示

注意

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

摘要 

ansible.builtin.expect 模块执行命令并响应提示。
给定的命令将在所有选定的节点上执行。它不会通过 shell 处理，因此诸如 $HOME 之类的变量以及 "<"、">"、"|" 和 "&" 之类的操作将不起作用。

要求 

执行此模块的主机需要以下要求。

python >= 2.6
pexpect >= 3.3

参数 

参数	注释
chdir 路径	在运行命令之前更改到此目录。
command 字符串 / 必需	command 模块需要运行的命令。
creates 路径	文件名，如果该文件已存在，则不会运行此步骤。
echo 布尔值	是否回显响应字符串。选项 `false` ← (默认) `true`
removes 路径	文件名，如果该文件不存在，则不会运行此步骤。
responses 字典 / 必需	提示正则表达式和相应答案的映射。 `responses` 中的每个键都是一个 Python 正则表达式 https://docs.pythonlang.cn/3/library/re.html#regular-expression-syntax。每个键的值是一个字符串或字符串列表。如果值为字符串并且多次遇到提示，则会重复答案。提供值作为列表以针对连续匹配提供不同的答案。
timeout 任意	等待预期字符串的秒数。使用 `null` 禁用超时。默认值： `30`

属性 

属性	支持	描述
check_mode	支持：不支持	可以在检查模式下运行并返回更改状态预测，而无需修改目标，如果支持，则操作将被跳过。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在检查模式下更改的内容）的详细信息
platform	平台： posix	可以针对其进行操作的目标操作系统/系列

备注 

注意

如果要通过 shell 运行命令（例如您正在使用 <、>、| 等），则必须在命令中指定一个 shell，例如 /bin/bash -c "/path/to/something | grep else"。
不区分大小写的搜索以 (?i 前缀表示。
此模块使用的 pexpect 库使用 2000 字节的搜索窗口，并且不使用多行正则表达式匹配。要执行行首绑定匹配，请使用类似 (?m^pattern) 的模式。
ansible.builtin.expect 模块专为简单场景而设计。对于更复杂的需求，请考虑使用 ansible.builtin.shell 或 ansible.builtin.script 模块中的 expect 代码。（ansible.builtin.shell 模块文档中包含一个示例）。
如果命令返回非 UTF-8 数据，则必须对其进行编码以避免出现问题。一种选择是通过 base64 传递输出。

另请参阅 

另请参阅

ansible.builtin.script: 在传输后在远程节点上运行本地脚本。
ansible.builtin.shell: 在目标上执行 shell 命令。

示例 

- name: Case insensitive password string match
  ansible.builtin.expect:
    command: passwd username
    responses:
      (?i)password: "MySekretPa$$word"
  # you don't want to show passwords in your logs
  no_log: true

- name: Match multiple regular expressions and demonstrate individual and repeated responses
  ansible.builtin.expect:
    command: /path/to/custom/command
    responses:
      Question:
        # give a unique response for each of the 3 hypothetical prompts matched
        - response1
        - response2
        - response3
      # give the same response for every matching prompt
      "^Match another prompt$": "response"

- name: Multiple questions with responses
  ansible.builtin.expect:
    command: /path/to/custom/command
    responses:
        "Please provide your name":
            - "Anna"
        "Database user":
            - "{{ db_username }}"
        "Database password":
            - "{{ db_password }}"

作者

Matt Martz (@sivel)