Documentation

slurp - Slurps a file from remote nodes

Synopsis

  • This module works like fetch. It is used for fetching a base64- encoded blob containing the data in a remote file.

Options

parameter required default choices comments
src
yes
    The file on the remote system to fetch. This must be a file, not a directory.

    Examples

    # Find out what the remote machine's mounts are:
    - slurp:
        src: /proc/mounts
      register: mounts
    
    - debug:
        msg: "{{ mounts['content'] | b64decode }}"
    
    # From the commandline, find the pid of the remote machine's sshd
    # $ ansible host -m slurp -a 'src=/var/run/sshd.pid'
    # host | SUCCESS => {
    #     "changed": false,
    #     "content": "MjE3OQo=",
    #     "encoding": "base64",
    #     "source": "/var/run/sshd.pid"
    # }
    # $ echo MjE3OQo= | base64 -d
    # 2179
    

    Notes

    Note

    • This module returns an ‘in memory’ base64 encoded version of the file, take into account that this will require at least twice the RAM as the original file size.
    • See also: fetch

    Status

    This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

    Support

    This module is maintained by those with core commit privileges

    For more information on what this means please read Module Support

    For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.