You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Shell plugins

Shell plugins work to ensure that the basic commands Ansible runs are properly formatted to work with the target machine and allow the user to configure certain behaviors related to how Ansible executes tasks.

Enabling shell plugins 

You can add a custom shell plugin by dropping it into a shell_plugins directory adjacent to your play, inside a role, or by putting it in one of the shell plugin directory sources configured in ansible.cfg.

Warning

You should not alter which plugin is used unless you have a setup in which the default /bin/sh is not a POSIX compatible shell or is not available for execution.

Using shell plugins 

In addition to the default configuration settings in Ansible Configuration Settings, you can use the connection variable ansible_shell_type to select the plugin to use. In this case, you will also want to update the ansible_shell_executable to match.

Plugin list 

You can further control the settings for each plugin with other configuration options detailed in the plugin themselves. You can use ansible-doc -t shell -l to see the list of available plugins. Use ansible-doc -t shell <plugin name> to see plugin-specific documentation and examples.

Shell plugins

Enabling shell plugins

Using shell plugins

Plugin list

Enabling shell plugins 

Using shell plugins 

Plugin list 