Manage information about regular files, directories, and special files on the minion, set/read user, group, mode, and data
salt.modules.file.
access
(path, mode)¶New in version 2014.1.0.
Test whether the Salt process has the specified access to the file. One of the following modes must be specified:
CLI Example:
salt '*' file.access /path/to/file f
salt '*' file.access /path/to/file x
salt.modules.file.
append
(path, *args, **kwargs)¶New in version 0.9.5.
Append text to the end of a file
CLI Example:
salt '*' file.append /etc/motd \
"With all thine offerings thou shalt offer salt." \
"Salt is what makes things taste bad when it isn't in them."
Attention
If you need to pass a string to append and that string contains an equal sign, you must include the argument name, args. For example:
salt '*' file.append /etc/motd args='cheese=spam'
salt '*' file.append /etc/motd args="['cheese=spam','spam=cheese']"
salt.modules.file.
basename
(path)¶Returns the final component of a pathname
New in version 2015.5.0.
This can be useful at the CLI but is frequently useful when scripting.
{%- set filename = salt['file.basename'](source_file) %}
CLI Example:
salt '*' file.basename 'test/test.config'
salt.modules.file.
blockreplace
(path, marker_start='#-- start managed zone --', marker_end='#-- end managed zone --', content='', append_if_not_found=False, prepend_if_not_found=False, backup='.bak', dry_run=False, show_changes=True)¶New in version 2014.1.0.
Replace content of a text block in a file, delimited by line markers
A block of content delimited by comments can help you manage several lines entries without worrying about old entries removal.
Note
This function will store two copies of the file in-memory (the original version and the edited version) in order to detect changes and only edit the targeted file if necessary.
True
then, the markers and
content will be appended to the file.True
then, the markers and
content will be prepended to the file.False
to skip making a backup.False
,
return a boolean if any changes were made.CLI Example:
salt '*' file.blockreplace /etc/hosts '#-- start managed zone foobar : DO NOT EDIT --' \
'#-- end managed zone foobar --' $'10.0.1.1 foo.foobar\n10.0.1.2 bar.foobar' True
salt.modules.file.
check_file_meta
(name, sfn, source, source_sum, user, group, mode, saltenv, template=None, contents=None)¶Check for the changes in the file metadata.
CLI Example:
salt '*' file.check_file_meta /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root, root, '755' base
Note
Supported hash types include sha512, sha384, sha256, sha224, sha1, and md5.
salt.modules.file.
check_hash
(path, file_hash)¶Check if a file matches the given hash string
Returns true if the hash matched, otherwise false. Raises ValueError if the hash was not formatted correctly.
md5:e138491e9d5b97023cea823fe17bac22
CLI Example:
salt '*' file.check_hash /etc/fstab md5:<md5sum>
salt.modules.file.
check_managed
(name, source, source_hash, user, group, mode, template, context, defaults, saltenv, contents=None, **kwargs)¶Check to see what changes need to be made for a file
CLI Example:
salt '*' file.check_managed /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root, root, '755' jinja True None None base
salt.modules.file.
check_managed_changes
(name, source, source_hash, user, group, mode, template, context, defaults, saltenv, contents=None, **kwargs)¶Return a dictionary of what changes need to be made for a file
CLI Example:
salt '*' file.check_managed_changes /etc/httpd/conf.d/httpd.conf salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root, root, '755' jinja True None None base
salt.modules.file.
check_perms
(name, ret, user, group, mode, follow_symlinks=False)¶Check the permissions on files and chown if needed
CLI Example:
salt '*' file.check_perms /etc/sudoers '{}' root root 400
Changed in version 2014.1.3: follow_symlinks
option added
salt.modules.file.
chgrp
(path, group)¶Change the group of a file
CLI Example:
salt '*' file.chgrp /etc/passwd root
salt.modules.file.
chown
(path, user, group)¶Chown a file, pass the file the desired user and group
CLI Example:
salt '*' file.chown /etc/passwd root root
salt.modules.file.
comment
(path, regex, char='#', backup='.bak')¶Deprecated since version 0.17.0: Use replace()
instead.
Comment out specified lines in a file
^
or $
characters outside the parenthesis
(e.g., the pattern ^foo$
will be rewritten as ^(foo)$
)#
.bak
The file will be backed up before edit with this file extension
Warning
This backup will be overwritten each time sed
/ comment
/
uncomment
is called. Meaning the backup will only be useful
after the first invocation.
CLI Example:
salt '*' file.comment /etc/modules pcspkr
salt.modules.file.
contains
(path, text)¶Deprecated since version 0.17.0: Use search()
instead.
Return True
if the file at path
contains text
CLI Example:
salt '*' file.contains /etc/crontab 'mymaintenance.sh'
salt.modules.file.
contains_glob
(path, glob_expr)¶Deprecated since version 0.17.0: Use search()
instead.
Return True
if the given glob matches a string in the named file
CLI Example:
salt '*' file.contains_glob /etc/foobar '*cheese*'
salt.modules.file.
contains_regex
(path, regex, lchar='')¶Deprecated since version 0.17.0: Use search()
instead.
Return True if the given regular expression matches on any line in the text of a given file.
If the lchar argument (leading char) is specified, it will strip lchar from the left side of each line before trying to match
CLI Example:
salt '*' file.contains_regex /etc/crontab
salt.modules.file.
contains_regex_multiline
(path, regex)¶Deprecated since version 0.17.0: Use search()
instead.
Return True if the given regular expression matches anything in the text of a given file
Traverses multiple lines at a time, via the salt BufferedReader (reads in chunks)
CLI Example:
salt '*' file.contains_regex_multiline /etc/crontab '^maint'
salt.modules.file.
copy
(src, dst, recurse=False, remove_existing=False)¶Copy a file or directory from source to dst
In order to copy a directory, the recurse flag is required, and will by default overwrite files in the destination with the same path, and retain all other existing files. (similar to cp -r on unix)
remove_existing will remove all files in the target directory, and then copy files from the source.
CLI Example:
salt '*' file.copy /path/to/src /path/to/dst
salt '*' file.copy /path/to/src_dir /path/to/dst_dir recurse=True
salt '*' file.copy /path/to/src_dir /path/to/dst_dir recurse=True remove_existing=True
salt.modules.file.
delete_backup
(path, backup_id)¶New in version 0.17.0.
Delete a previous version of a file that was backed up using Salt's file state backup system.
file.list_backups
CLI Example:
salt '*' file.restore_backup /foo/bar/baz.txt 0
salt.modules.file.
directory_exists
(path)¶Tests to see if path is a valid directory. Returns True/False.
CLI Example:
salt '*' file.directory_exists /etc
salt.modules.file.
dirname
(path)¶Returns the directory component of a pathname
New in version 2015.5.0.
This can be useful at the CLI but is frequently useful when scripting.
{%- from salt['file.dirname'](tpldir) + '/vars.jinja' import parent_vars %}
CLI Example:
salt '*' file.dirname 'test/path/filename.config'
salt.modules.file.
diskusage
(path)¶Recursively calculate disk usage of path and return it in bytes
CLI Example:
salt '*' file.diskusage /path/to/check
salt.modules.file.
extract_hash
(hash_fn, hash_type='sha256', file_name='')¶This routine is called from the file.managed
state to pull a hash from a remote file.
Regular expressions are used line by line on the source_hash
file, to
find a potential candidate of the indicated hash type. This avoids many
problems of arbitrary file lay out rules. It specifically permits pulling
hash codes from debian *.dsc
files.
For example:
openerp_7.0-latest-1.tar.gz:
file.managed:
- name: /tmp/openerp_7.0-20121227-075624-1_all.deb
- source: http://nightly.openerp.com/7.0/nightly/deb/openerp_7.0-20121227-075624-1.tar.gz
- source_hash: http://nightly.openerp.com/7.0/nightly/deb/openerp_7.0-20121227-075624-1.dsc
CLI Example:
salt '*' file.extract_hash /etc/foo sha512 /path/to/hash/file
salt.modules.file.
file_exists
(path)¶Tests to see if path is a valid file. Returns True/False.
CLI Example:
salt '*' file.file_exists /etc/passwd
salt.modules.file.
find
(path, *args, **kwargs)¶Approximate the Unix find(1)
command and return a list of paths that
meet the specified criteria.
The options include match criteria:
name = path-glob # case sensitive
iname = path-glob # case insensitive
regex = path-regex # case sensitive
iregex = path-regex # case insensitive
type = file-types # match any listed type
user = users # match any listed user
group = groups # match any listed group
size = [+-]number[size-unit] # default unit = byte
mtime = interval # modified since date
grep = regex # search file contents
and/or actions:
delete [= file-types] # default type = 'f'
exec = command [arg ...] # where {} is replaced by pathname
print [= print-opts]
and/or depth criteria:
maxdepth = maximum depth to transverse in path
mindepth = minimum depth to transverse before checking files or directories
The default action is print=path
path-glob
:
* = match zero or more chars
? = match any char
[abc] = match a, b, or c
[!abc] or [^abc] = match anything except a, b, and c
[x-y] = match chars x through y
[!x-y] or [^x-y] = match anything except chars x through y
{a,b,c} = match a or b or c
path-regex
: a Python Regex (regular expression) pattern to match pathnames
file-types
: a string of one or more of the following:
a: all file types
b: block device
c: character device
d: directory
p: FIFO (named pipe)
f: plain file
l: symlink
s: socket
users
: a space and/or comma separated list of user names and/or uids
groups
: a space and/or comma separated list of group names and/or gids
size-unit
:
b: bytes
k: kilobytes
m: megabytes
g: gigabytes
t: terabytes
interval:
[<num>w] [<num>d] [<num>h] [<num>m] [<num>s]
where:
w: week
d: day
h: hour
m: minute
s: second
print-opts: a comma and/or space separated list of one or more of the following:
group: group name
md5: MD5 digest of file contents
mode: file permissions (as integer)
mtime: last modification time (as time_t)
name: file basename
path: file absolute path
size: file size in bytes
type: file type
user: user name
CLI Examples:
salt '*' file.find / type=f name=\*.bak size=+10m
salt '*' file.find /var mtime=+30d size=+10m print=path,size,mtime
salt '*' file.find /var/log name=\*.[0-9] mtime=+30d size=+10m delete
salt.modules.file.
get_devmm
(name)¶Get major/minor info from a device
CLI Example:
salt '*' file.get_devmm /dev/chr
salt.modules.file.
get_diff
(minionfile, masterfile, env=None, saltenv='base')¶Return unified diff of file compared to file on master
CLI Example:
salt '*' file.get_diff /home/fred/.vimrc salt://users/fred/.vimrc
salt.modules.file.
get_gid
(path, follow_symlinks=True)¶Return the id of the group that owns a given file
CLI Example:
salt '*' file.get_gid /etc/passwd
Changed in version 0.16.4: follow_symlinks
option added
salt.modules.file.
get_group
(path, follow_symlinks=True)¶Return the group that owns a given file
CLI Example:
salt '*' file.get_group /etc/passwd
Changed in version 0.16.4: follow_symlinks
option added
salt.modules.file.
get_hash
(path, form='sha256', chunk_size=65536)¶Get the hash sum of a file
get_sum
for the following reasons:It does not read the entire file into memory.
get_sum
cannot really be trusted since it is vulnerable to
collisions: get_sum(..., 'xyz') == 'Hash xyz not supported'
CLI Example:
salt '*' file.get_hash /etc/shadow
salt.modules.file.
get_managed
(name, template, source, source_hash, user, group, mode, saltenv, context, defaults, **kwargs)¶Return the managed file data for file.managed
CLI Example:
salt '*' file.get_managed /etc/httpd/conf.d/httpd.conf jinja salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root root '755' base None None
salt.modules.file.
get_mode
(path, follow_symlinks=True)¶Return the mode of a file
CLI Example:
salt '*' file.get_mode /etc/passwd
Changed in version 2014.1.0: follow_symlinks
option added
salt.modules.file.
get_selinux_context
(path)¶Get an SELinux context from a given path
CLI Example:
salt '*' file.get_selinux_context /etc/hosts
salt.modules.file.
get_sum
(path, form='sha256')¶Return the checksum for the given file. The following checksum algorithms are supported:
CLI Example:
salt '*' file.get_sum /etc/passwd sha512
salt.modules.file.
get_uid
(path, follow_symlinks=True)¶Return the id of the user that owns a given file
CLI Example:
salt '*' file.get_uid /etc/passwd
Changed in version 0.16.4: follow_symlinks
option added
salt.modules.file.
get_user
(path, follow_symlinks=True)¶Return the user that owns a given file
CLI Example:
salt '*' file.get_user /etc/passwd
Changed in version 0.16.4: follow_symlinks
option added
salt.modules.file.
gid_to_group
(gid)¶Convert the group id to the group name on this system
CLI Example:
salt '*' file.gid_to_group 0
salt.modules.file.
grep
(path, pattern, *args)¶Grep for a string in the specified file
Note
This function's return value is slated for refinement in future versions of Salt
test
a[0-5]
" -v"
" -i -B2"
CLI Example:
salt '*' file.grep /etc/passwd nobody
salt '*' file.grep /etc/sysconfig/network-scripts/ifcfg-eth0 ipaddr " -i"
salt '*' file.grep /etc/sysconfig/network-scripts/ifcfg-eth0 ipaddr " -i -B2"
salt '*' file.grep "/etc/sysconfig/network-scripts/*" ipaddr " -i -l"
salt.modules.file.
group_to_gid
(group)¶Convert the group to the gid on this system
CLI Example:
salt '*' file.group_to_gid root
salt.modules.file.
is_blkdev
(name)¶Check if a file exists and is a block device.
CLI Example:
salt '*' file.is_blkdev /dev/blk
salt.modules.file.
is_chrdev
(name)¶Check if a file exists and is a character device.
CLI Example:
salt '*' file.is_chrdev /dev/chr
salt.modules.file.
is_fifo
(name)¶Check if a file exists and is a FIFO.
CLI Example:
salt '*' file.is_fifo /dev/fifo
salt.modules.file.
is_link
(path)¶Check if the path is a symlink
CLI Example:
salt '*' file.is_link /path/to/link
salt.modules.file.
join
(*args)¶Return a normalized file system path for the underlying OS
New in version 2014.7.0.
This can be useful at the CLI but is frequently useful when scripting combining path variables:
{% set www_root = '/var' %}
{% set app_dir = 'myapp' %}
myapp_config:
file:
- managed
- name: {{ salt['file.join'](www_root, app_dir, 'config.yaml') }}
CLI Example:
salt '*' file.join '/' 'usr' 'local' 'bin'
salt.modules.file.
lchown
(path, user, group)¶Chown a file, pass the file the desired user and group without following symlinks.
CLI Example:
salt '*' file.chown /etc/passwd root root
salt.modules.file.
line
(path, content, match=None, mode=None, location=None, before=None, after=None, show_changes=True, backup=False, quiet=False, indent=True)¶New in version Beryllium.
Edit a line in the configuration file.
Parameters: |
|
---|
Output a unified diff of the old file and the new file.
If False
return a boolean if any changes were made.
Default is True
Note
Using this option will store two copies of the file in-memory (the original version and the edited version) in order to generate the diff.
CLI Examples:
salt '*' file.line /etc/nsswitch.conf "networks: files dns", after="hosts:.*?", mode='ensure'
salt.modules.file.
link
(src, path)¶New in version 2014.1.0.
Create a hard link to a file
CLI Example:
salt '*' file.link /path/to/file /path/to/link
salt.modules.file.
list_backups
(path, limit=None)¶New in version 0.17.0.
Lists the previous versions of a file backed up using Salt's file state backup system.
CLI Example:
salt '*' file.list_backups /foo/bar/baz.txt
salt.modules.file.
list_backups_dir
(path, limit=None)¶Lists the previous versions of a directory backed up using Salt's file state backup system.
CLI Example:
salt '*' file.list_backups_dir /foo/bar/baz/
salt.modules.file.
lstat
(path)¶New in version 2014.1.0.
Returns the lstat attributes for the given file or dir. Does not support symbolic links.
CLI Example:
salt '*' file.lstat /path/to/file
salt.modules.file.
makedirs
(path, user=None, group=None, mode=None)¶Ensure that the directory containing this path is available.
Note
The path must end with a trailing slash otherwise the directory/directories
will be created up to the parent directory. For example if path is
/opt/code
, then it would be treated as /opt/
but if the path
ends with a trailing slash like /opt/code/
, then it would be
treated as /opt/code/
.
CLI Example:
salt '*' file.makedirs /opt/code/
salt.modules.file.
makedirs_perms
(name, user=None, group=None, mode='0755')¶Taken and modified from os.makedirs to set user, group and mode for each directory created.
CLI Example:
salt '*' file.makedirs_perms /opt/code
salt.modules.file.
manage_file
(name, sfn, ret, source, source_sum, user, group, mode, saltenv, backup, makedirs=False, template=None, show_diff=True, contents=None, dir_mode=None, follow_symlinks=True)¶Checks the destination against what was retrieved with get_managed and makes the appropriate modifications (if necessary).
location of cached file on the minion
This is the path to the file stored on the minion. This file is placed on the minion using cp.cache_file. If the hash sum of that file matches the source_sum, we do not transfer the file to the minion again.
This file is then grabbed and if it has template set, it renders the file to be placed into the correct place on the system using salt.files.utils.copyfile()
CLI Example:
salt '*' file.manage_file /etc/httpd/conf.d/httpd.conf '' '{}' salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' root root '755' base ''
Changed in version 2014.7.0: follow_symlinks
option added
salt.modules.file.
mkdir
(dir_path, user=None, group=None, mode=None)¶Ensure that a directory is available.
CLI Example:
salt '*' file.mkdir /opt/jetty/context
salt.modules.file.
mknod
(name, ntype, major=0, minor=0, user=None, group=None, mode='0600')¶New in version 0.17.0.
Create a block device, character device, or fifo pipe. Identical to the gnu mknod.
CLI Examples:
salt '*' file.mknod /dev/chr c 180 31
salt '*' file.mknod /dev/blk b 8 999
salt '*' file.nknod /dev/fifo p
salt.modules.file.
mknod_blkdev
(name, major, minor, user=None, group=None, mode='0660')¶New in version 0.17.0.
Create a block device.
CLI Example:
salt '*' file.mknod_blkdev /dev/blk 8 999
salt.modules.file.
mknod_chrdev
(name, major, minor, user=None, group=None, mode='0660')¶New in version 0.17.0.
Create a character device.
CLI Example:
salt '*' file.mknod_chrdev /dev/chr 180 31
salt.modules.file.
mknod_fifo
(name, user=None, group=None, mode='0660')¶New in version 0.17.0.
Create a FIFO pipe.
CLI Example:
salt '*' file.mknod_fifo /dev/fifo
salt.modules.file.
move
(src, dst)¶Move a file or directory
CLI Example:
salt '*' file.move /path/to/src /path/to/dst
salt.modules.file.
normpath
(path)¶Returns Normalize path, eliminating double slashes, etc.
New in version 2015.5.0.
This can be useful at the CLI but is frequently useful when scripting.
{%- from salt['file.normpath'](tpldir + '/../vars.jinja') import parent_vars %}
CLI Example:
salt '*' file.normpath 'a/b/c/..'
salt.modules.file.
open_files
(by_pid=False)¶Return a list of all physical open files on the system.
CLI Examples:
salt '*' file.open_files
salt '*' file.open_files by_pid=True
salt.modules.file.
pardir
()¶Return the relative parent directory path symbol for underlying OS
New in version 2014.7.0.
This can be useful when constructing Salt Formulas.
{% set pardir = salt['file.pardir']() %}
{% set final_path = salt['file.join']('subdir', pardir, 'confdir') %}
CLI Example:
salt '*' file.pardir
salt.modules.file.
patch
(originalfile, patchfile, options='', dry_run=False)¶New in version 0.10.4.
Apply a patch to a file
Equivalent to:
patch <options> <originalfile> <patchfile>
originalfile
CLI Example:
salt '*' file.patch /opt/file.txt /tmp/file.txt.patch
salt.modules.file.
path_exists_glob
(path)¶Tests to see if path after expansion is a valid path (file or directory). Expansion allows usage of ? * and character ranges []. Tilde expansion is not supported. Returns True/False.
New in version Hellium.
CLI Example:
salt '*' file.path_exists_glob /etc/pam*/pass*
salt.modules.file.
prepend
(path, *args, **kwargs)¶New in version 2014.7.0.
Prepend text to the beginning of a file
CLI Example:
salt '*' file.prepend /etc/motd \
"With all thine offerings thou shalt offer salt." \
"Salt is what makes things taste bad when it isn't in them."
Attention
If you need to pass a string to append and that string contains an equal sign, you must include the argument name, args. For example:
salt '*' file.prepend /etc/motd args='cheese=spam'
salt '*' file.prepend /etc/motd args="['cheese=spam','spam=cheese']"
salt.modules.file.
psed
(path, before, after, limit='', backup='.bak', flags='gMS', escape_all=False, multi=False)¶Deprecated since version 0.17.0: Use replace()
instead.
Make a simple edit to a file (pure Python version)
Equivalent to:
sed <backup> <options> "/<limit>/ s/<before>/<after>/<flags> <file>"
after
before
''
before
.bak
sed
/comment
/uncomment
is called will
overwrite this backupgMS
g
: Replace all occurrences of the pattern, not just the first.I
: Ignore case.L
: Make \w
, \W
, \b
, \B
, \s
and \S
dependent on the locale.M
: Treat multiple lines as a single line.S
: Make . match all characters, including newlines.U
: Make \w
, \W
, \b
, \B
, \d
, \D
,
\s
and \S
dependent on Unicode.X
: Verbose (whitespace is ignored).False
Forward slashes and single quotes will be escaped automatically in the
before
and after
patterns.
CLI Example:
salt '*' file.sed /etc/httpd/httpd.conf 'LogLevel warn' 'LogLevel info'
salt.modules.file.
readdir
(path)¶New in version 2014.1.0.
Return a list containing the contents of a directory
CLI Example:
salt '*' file.readdir /path/to/dir/
salt.modules.file.
readlink
(path, canonicalize=False)¶New in version 2014.1.0.
Return the path that a symlink points to If canonicalize is set to True, then it return the final target
CLI Example:
salt '*' file.readlink /path/to/link
salt.modules.file.
remove
(path)¶Remove the named file
CLI Example:
salt '*' file.remove /tmp/foo
salt.modules.file.
rename
(src, dst)¶Rename a file or directory
CLI Example:
salt '*' file.rename /path/to/src /path/to/dst
salt.modules.file.
replace
(path, pattern, repl, count=0, flags=0, bufsize=1, append_if_not_found=False, prepend_if_not_found=False, not_found_content=None, backup='.bak', dry_run=False, search_only=False, show_changes=True, ignore_if_missing=False, preserve_inode=True)¶New in version 0.17.0.
Replace occurrences of a pattern in a file
This is a pure Python implementation that wraps Python's sub()
.
['IGNORECASE',
'MULTILINE']
. Note: multiline searches must specify file
as the
bufsize
argument below.1
processes one line at a time. The special value
file
may be specified which will read the entire file into memory
before processing. Note: multiline searches must specify file
buffering.New in version 2014.7.0.
If pattern is not found and set to True
then, the content will be appended to the file.
Default is False
New in version 2014.7.0.
If pattern is not found and set to True
then, the content will be appended to the file.
Default is False
New in version 2014.7.0.
Content to use for append/prepend if not found. If
None (default), uses repl
. Useful when repl
uses references to group in
pattern.
False
to skip making a backup. Default
is .bak
False
False
Output a unified diff of the old file and the new
file. If False
return a boolean if any changes were made.
Default is True
Note
Using this option will store two copies of the file in-memory (the original version and the edited version) in order to generate the diff.
New in version Beryllium.
When this parameter is True
, file.replace
will return False
if the
file doesn't exist. When this parameter is False
, file.replace
will
throw an error if the file doesn't exist.
Default is False
(to maintain compatibility with prior behaviour).
New in version Beryllium.
Preserve the inode of the file, so that any hard links continue to share the
inode with the original filename. This works by copying the file, reading
from the copy, and writing to the file at the original inode. If False
, the
file will be moved rather than copied, and a new file will be written to a
new inode, but using the original filename. Hard links will then share an inode
with the backup, instead (if using backup
to create a backup copy).
Default is True
.
If an equal sign (=
) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format key=val
. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
salt '*' file.replace /path/to/file pattern='=' repl=':'
salt '*' file.replace /path/to/file pattern="bind-address\s*=" repl='bind-address:'
CLI Examples:
salt '*' file.replace /etc/httpd/httpd.conf pattern='LogLevel warn' repl='LogLevel info'
salt '*' file.replace /some/file pattern='before' repl='after' flags='[MULTILINE, IGNORECASE]'
salt.modules.file.
restore_backup
(path, backup_id)¶New in version 0.17.0.
Restore a previous version of a file that was backed up using Salt's file state backup system.
file.list_backups
CLI Example:
salt '*' file.restore_backup /foo/bar/baz.txt 0
salt.modules.file.
restorecon
(path, recursive=False)¶Reset the SELinux context on a given path
CLI Example:
salt '*' file.restorecon /home/user/.ssh/authorized_keys
salt.modules.file.
rmdir
(path)¶New in version 2014.1.0.
Remove the specified directory. Fails if a directory is not empty.
CLI Example:
salt '*' file.rmdir /tmp/foo/
salt.modules.file.
search
(path, pattern, flags=0, bufsize=1, ignore_if_missing=False, multiline=False)¶New in version 0.17.0.
Search for occurrences of a pattern in a file
Except for multiline, params are identical to
replace()
.
If true, inserts 'MULTILINE' into flags
and sets bufsize
to
'file'.
New in version Beryllium.
CLI Example:
salt '*' file.search /etc/crontab 'mymaintenance.sh'
salt.modules.file.
sed
(path, before, after, limit='', backup='.bak', options='-r -e', flags='g', escape_all=False, negate_match=False)¶Deprecated since version 0.17.0: Use replace()
instead.
Make a simple edit to a file
Equivalent to:
sed <backup> <options> "/<limit>/ s/<before>/<after>/<flags> <file>"
after
before
''
before
.bak
sed
/comment
/uncomment
is called will
overwrite this backup-r -e
g
i
for case-insensitive pattern
matchingNegate the search command (!
)
New in version 0.17.0.
Forward slashes and single quotes will be escaped automatically in the
before
and after
patterns.
CLI Example:
salt '*' file.sed /etc/httpd/httpd.conf 'LogLevel warn' 'LogLevel info'
salt.modules.file.
sed_contains
(path, text, limit='', flags='g')¶Deprecated since version 0.17.0: Use search()
instead.
Return True if the file at path
contains text
. Utilizes sed to
perform the search (line-wise search).
Note: the p
flag will be added to any flags you pass in.
CLI Example:
salt '*' file.contains /etc/crontab 'mymaintenance.sh'
salt.modules.file.
seek_read
(path, size, offset)¶New in version 2014.1.0.
Seek to a position on a file and read it
CLI Example:
salt '*' file.seek_read /path/to/file 4096 0
salt.modules.file.
seek_write
(path, data, offset)¶New in version 2014.1.0.
Seek to a position on a file and write to it
CLI Example:
salt '*' file.seek_write /path/to/file 'some data' 4096
salt.modules.file.
set_mode
(path, mode)¶Set the mode of a file
CLI Example:
salt '*' file.set_mode /etc/passwd 0644
salt.modules.file.
set_selinux_context
(path, user=None, role=None, type=None, range=None)¶Set a specific SELinux label on a given path
CLI Example:
salt '*' file.set_selinux_context path <role> <type> <range>
salt.modules.file.
source_list
(source, source_hash, saltenv)¶Check the source list and return the source to use
CLI Example:
salt '*' file.source_list salt://http/httpd.conf '{hash_type: 'md5', 'hsum': <md5sum>}' base
salt.modules.file.
stats
(path, hash_type=None, follow_symlinks=True)¶Return a dict containing the stats for a given file
CLI Example:
salt '*' file.stats /etc/passwd
salt.modules.file.
statvfs
(path)¶New in version 2014.1.0.
Perform a statvfs call against the filesystem that the file resides on
CLI Example:
salt '*' file.statvfs /path/to/file
salt.modules.file.
symlink
(src, path)¶Create a symbolic link to a file
CLI Example:
salt '*' file.symlink /path/to/file /path/to/link
salt.modules.file.
touch
(name, atime=None, mtime=None)¶New in version 0.9.5.
Just like the touch
command, create a file if it doesn't exist or
simply update the atime and mtime if it already does.
CLI Example:
salt '*' file.touch /var/log/emptyfile
salt.modules.file.
truncate
(path, length)¶New in version 2014.1.0.
Seek to a position on a file and delete everything after that point
CLI Example:
salt '*' file.truncate /path/to/file 512
salt.modules.file.
uid_to_user
(uid)¶Convert a uid to a user name
CLI Example:
salt '*' file.uid_to_user 0
salt.modules.file.
uncomment
(path, regex, char='#', backup='.bak')¶Deprecated since version 0.17.0: Use replace()
instead.
Uncomment specified commented lines in a file
^
character will be stripped for convenience (for easily switching
between comment() and uncomment()).#
.bak
sed
/comment
/uncomment
is called will
overwrite this backupCLI Example:
salt '*' file.uncomment /etc/hosts.deny 'ALL: PARANOID'
salt.modules.file.
user_to_uid
(user)¶Convert user name to a uid
CLI Example:
salt '*' file.user_to_uid root
salt.modules.file.
write
(path, *args, **kwargs)¶New in version 2014.7.0.
Write text to a file, overwriting any existing contents.
CLI Example:
salt '*' file.write /etc/motd \
"With all thine offerings thou shalt offer salt."
Attention
If you need to pass a string to append and that string contains an equal sign, you must include the argument name, args. For example:
salt '*' file.write /etc/motd args='cheese=spam'
salt '*' file.write /etc/motd args="['cheese=spam','spam=cheese']"