slurp - Slurps a file from remote nodes¶

Synopsis
Parameters
Notes
Examples
Status
Maintenance
- Support
- Author

Synopsis ¶

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

Parameters ¶

Parameter	Choices/Defaults	Comments
src required		The file on the remote system to fetch. This must be a file, not a directory.

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.
This module is also supported for Windows targets.
See also: fetch

Examples ¶

- name: 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

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.

Maintenance ¶

This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Core Team, see here.

Support ¶

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author ¶

Ansible Core Team
Michael DeHaan (@mpdehaan)

Hint

If you notice any issues in this documentation you can edit this document to improve it.