| Parameter |
Choices/Defaults |
Comments |
|
become
boolean
|
|
Whether to prefix remote commands with sudo.
|
|
content
string
|
|
Inline text content to write to dest. Marked no_log, since this module is commonly used to push credential material. Mutually exclusive with src.
Since content is a normal string-type module option, Ansible renders any Jinja expressions in it (e.g. {{ my_var }}) before this module ever runs, the same as any other option value — no special templating support is implemented by this module itself.
|
|
dest
path
/ required
|
|
Absolute path to the remote file or directory to manage.
|
|
group
string
|
|
Name of the group that should own dest.
|
|
mode
string
|
|
Permission bits for dest, as a string (e.g. '0600'). Compared against stat output after normalizing to 4 digits; '600' and '0600' are treated as equivalent.
|
|
owner
string
|
|
Name of the user that should own dest.
|
|
src
path
|
|
Path to a local file (on the Ansible controller) whose content should be pushed to dest. Transferred via a real SCP session over the connection's own persistent socket (the same mechanism ansible.netcommon.net_put uses), never placed inside a command string. Mutually exclusive with content.
File bytes are uploaded exactly as they exist on disk — Ansible does not render Jinja expressions inside the file's contents for src, only in the option values of the task itself (e.g. a templated path string). To push templated text, render it first with the template lookup and pass the result via content instead.
|
|
state
string
|
Choices:
present ← - absent
|
Whether the path should exist (present) or be removed (absent).
|