ansible.builtin.expect – Executes a command and responds to prompts
This module is part of
ansible-core and included in all Ansible
installations. In most cases, you can use the short
expect even without specifying the
However, we recommend you use the FQCN for easy linking to the
module documentation and to avoid conflicting with other collections that may have
the same module name.
New in version 2.0: of ansible.builtin
expectmodule executes a command and responds to prompts.
The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like
$HOMEand operations like
"&"will not work.
The below requirements are needed on the host that executes this module.
python >= 2.6
pexpect >= 3.3
Can run in check_mode and return changed status prediction withought modifying target
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
Target OS/families that can be operated against
If you want to run a command through the shell (say you are using
|, and so on), you must specify a shell in the command such as
/bin/bash -c "/path/to/something | grep else".
The question, or key, under responses is a python regex match. Case insensitive searches are indicated with a prefix of
pexpectlibrary used by this module operates with a search window of 2000 bytes, and does not use a multiline regex match. To perform a start of line bound match, use a pattern like
By default, if a question is encountered multiple times, its string response will be repeated. If you need different responses for successive question matches, instead of a string response, use a list of strings as the response. The list functionality is new in 2.1.
The ansible.builtin.expect module is designed for simple scenarios. For more complex needs, consider the use of expect code with the ansible.builtin.shell or ansible.builtin.script modules. (An example is part of the ansible.builtin.shell module documentation).
- 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: Generic question with multiple different responses ansible.builtin.expect: command: /path/to/custom/command responses: Question: - response1 - response2 - response3