ansible.builtin.shell – Execute shell commands on targets

• Synopsis
• Parameters
• Notes
• See Also
• Examples
• Return Values

Synopsis

• The shell module takes the command name followed by a list of space-delimited arguments.
• Either a free form command or cmd parameter is required, see the examples.
• It is almost exactly like the ansible.builtin.command module but runs the command through a shell (/bin/sh) on the remote node.
• For Windows targets, use the ansible.windows.win_shell module instead.

Parameters

Notes

See Also

Examples

- name: Execute the command in remote shell; stdout goes to the specified file on the remote
  shell: somescript.sh >> somelog.txt

- name: Change the working directory to somedir/ before executing the command
  shell: somescript.sh >> somelog.txt
  args:
    chdir: somedir/

# You can also use the 'args' form to provide the options.
- name: This command will change the working directory to somedir/ and will only run when somedir/somelog.txt doesn't exist
  shell: somescript.sh >> somelog.txt
  args:
    chdir: somedir/
    creates: somelog.txt

# You can also use the 'cmd' parameter instead of free form format.
- name: This command will change the working directory to somedir/
  shell:
    cmd: ls -l | grep log
    chdir: somedir/

- 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)
  shell: cat < /tmp/*txt
  args:
    executable: /bin/bash

- name: Run a command using a templated variable (always use quote filter to avoid injection)
  shell: cat {{ myfile|quote }}

# You can use shell to run other executables to perform actions inline
- name: Run expect to wait for a successful PXE boot via out-of-band CIMC
  shell: |
    set timeout 300
    spawn ssh admin@{{ cimc_host }}

    expect "password:"
    send "{{ cimc_password }}\n"

    expect "\n{{ cimc_name }}"
    send "connect host\n"

    expect "pxeboot.n12"
    send "\n"

    exit 0
  args:
    executable: /usr/bin/expect
  delegate_to: localhost

# Disabling warnings
- name: Using curl to connect to a host via SOCKS proxy (unsupported in uri). Ordinarily this would throw a warning
  shell: curl --socks5 localhost:9000 http://www.ansible.com
  args:
    warn: no

Return Values

Common return values are documented here, the following are the fields unique to this module:

Authors

• Ansible Core Team
• Michael DeHaan