salt.modules.archive

A module to wrap archive calls

salt.modules.archive.gunzip(gzipfile, template=None)

Uses the gunzip command to unpack gzip files

CLI Example to create /tmp/sourcefile.txt:

salt '*' archive.gunzip /tmp/sourcefile.txt.gz

The template arg can be set to 'jinja' or another supported template engine to render the command arguments before execution. CLI Example:

salt '*' archive.gunzip template=jinja /tmp/{{grains.id}}.txt.gz

salt.modules.archive.gzip(sourcefile, template=None)

Uses the gzip command to create gzip files

CLI Example to create /tmp/sourcefile.txt.gz:

salt '*' archive.gzip /tmp/sourcefile.txt

The template arg can be set to 'jinja' or another supported template engine to render the command arguments before execution. CLI Example:

salt '*' archive.gzip template=jinja /tmp/{{grains.id}}.txt

salt.modules.archive.rar(rarfile, template=None, *sources)

Uses the rar command to create rar files Uses rar for Linux from http://www.rarlab.com/

CLI Example:

salt '*' archive.rar /tmp/rarfile.rar /tmp/sourcefile1 /tmp/sourcefile2

The template arg can be set to 'jinja' or another supported template engine to render the command arguments before execution. For example:

salt '*' archive.rar template=jinja /tmp/rarfile.rar /tmp/sourcefile1 /tmp/{{grains.id}}.txt

salt.modules.archive.tar(options, tarfile, cwd=None, template=None, *sources)

Uses the tar command to pack, unpack, etc tar files

CLI Example:

salt '*' archive.tar cjvf /tmp/tarfile.tar.bz2 /tmp/file_1 /tmp/file_2

The template arg can be set to 'jinja' or another supported template engine to render the command arguments before execution. For example:

salt '*' archive.tar template=jinja cjvf /tmp/salt.tar.bz2 {{grains.saltpath}}

salt.modules.archive.unrar(rarfile, dest, template=None, *xfiles)

Uses the unrar command to unpack rar files Uses rar for Linux from http://www.rarlab.com/

CLI Example:

salt '*' archive.unrar /tmp/rarfile.rar /home/strongbad/ file_1 file_2

The template arg can be set to 'jinja' or another supported template engine to render the command arguments before execution. For example:

salt '*' archive.unrar template=jinja /tmp/rarfile.rar /tmp/{{grains.id}}/ file_1 file_2

salt.modules.archive.unzip(zipfile, dest, template=None, *xfiles)

Uses the unzip command to unpack zip files

CLI Example:

salt '*' archive.unzip /tmp/zipfile.zip /home/strongbad/ file_1 file_2

The template arg can be set to 'jinja' or another supported template engine to render the command arguments before execution. For example:

salt '*' archive.unzip template=jinja /tmp/zipfile.zip /tmp/{{grains.id}}/ file_1 file_2

salt.modules.archive.zip(zipfile, template=None, *sources)

Uses the zip command to create zip files

CLI Example:

salt '*' archive.zip /tmp/zipfile.zip /tmp/sourcefile1 /tmp/sourcefile2

The template arg can be set to 'jinja' or another supported template engine to render the command arguments before execution. For example:

salt '*' archive.zip template=jinja /tmp/zipfile.zip /tmp/sourcefile1 /tmp/{{grains.id}}.txt