ansible.builtin.raw (v2.16.5) — module

Executes a low-down and dirty command

| "added in version" historical of ansible.builtin"

Authors: Ansible Core Team, Michael DeHaan

This plugin has a corresponding action plugin.

Install Ansible via pip

Install with pip install ansible-core==2.16.5

Description

Executes a low-down and dirty SSH command, not going through the module subsystem.

This is useful and should only be done in a few cases. A common case is installing C(python) on a system without python installed by default. Another is speaking to any devices such as routers that do not have any Python installed. In any other case, using the M(ansible.builtin.shell) or M(ansible.builtin.command) module is much more appropriate.

Arguments given to C(raw) are run directly through the configured remote shell.

Standard output, error output and return code are returned when available.

There is no change handler support for this module.

This module does not require python on the remote system, much like the M(ansible.builtin.script) module.

This module is also supported for Windows targets.

If the command returns non UTF-8 data, it must be encoded to avoid issues. One option is to pipe the output through C(base64).

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Bootstrap a host without python2 installed
  ansible.builtin.raw: dnf install -y python2 python2-dnf libselinux-python
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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)
  ansible.builtin.raw: cat < /tmp/*txt
  args:
    executable: /bin/bash
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Safely use templated variables. Always use quote filter to avoid injection issues.
  ansible.builtin.raw: "{{ package_mgr|quote }} {{ pkg_flags|quote }} install {{ python|quote }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List user accounts on a Windows system
  ansible.builtin.raw: Get-WmiObject -Class Win32_UserAccount

Inputs

    
free_form:
    description:
    - The raw module takes a free form command to run.
    - There is no parameter actually named 'free form'; see the examples!
    required: true

executable:
    description:
    - Change the shell used to execute the command. Should be an absolute path to the
      executable.
    - When using privilege escalation (C(become)) a default shell will be assigned if
      one is not provided as privilege escalation requires a shell.
    version_added: '1.0'
    version_added_collection: ansible.builtin

See also