Extract an archive
New in version 2014.1.0.
salt.states.archive.
compareChecksum
(fname, target, checksum)¶salt.states.archive.
extracted
(name, source, archive_format, archive_user=None, password=None, user=None, group=None, tar_options=None, source_hash=None, if_missing=None, keep=False, trim_output=False, source_hash_update=None)¶New in version 2014.1.0.
State that make sure an archive is extracted in a directory. The downloaded archive is erased if successfully extracted. The archive is downloaded only if necessary.
Note
If if_missing
is not defined, this state will check for name
instead. If name
exists, it will assume the archive was previously
extracted successfully and will not extract it again.
Example, tar with flag for lmza compression:
graylog2-server:
archive.extracted:
- name: /opt/
- source: https://github.com/downloads/Graylog2/graylog2-server/graylog2-server-0.9.6p1.tar.lzma
- source_hash: md5=499ae16dcae71eeb7c3a30c75ea7a1a6
- tar_options: J
- archive_format: tar
- if_missing: /opt/graylog2-server-0.9.6p1/
Example, tar with flag for verbose output:
graylog2-server:
archive.extracted:
- name: /opt/
- source: https://github.com/downloads/Graylog2/graylog2-server/graylog2-server-0.9.6p1.tar.gz
- source_hash: md5=499ae16dcae71eeb7c3a30c75ea7a1a6
- archive_format: tar
- tar_options: v
- user: root
- group: root
- if_missing: /opt/graylog2-server-0.9.6p1/
Example, tar with flag for lmza compression and update based if source_hash differs from what was previously extracted:
graylog2-server:
archive.extracted:
- name: /opt/
- source: https://github.com/downloads/Graylog2/graylog2-server/graylog2-server-0.9.6p1.tar.lzma
- source_hash: md5=499ae16dcae71eeb7c3a30c75ea7a1a6
- source_hash_update: true
- tar_options: J
- archive_format: tar
- if_missing: /opt/graylog2-server-0.9.6p1/
Password to use with password protected zip files. Currently only zip files with passwords are supported.
New in version 2016.3.0.
Set this to True
if archive should be extracted if source_hash has
changed. This would extract regardless of the if_missing
parameter.
New in version 2016.3.0.
tar
, zip
or rar
The user to own each extracted file.
Deprecated since version 2014.7.2: Replaced by user
parameter
The user to own each extracted file.
New in version 2015.8.0.
Changed in version 2016.3.0: When used in combination with if_missing
, ownership will only
be enforced if if_missing
is a directory.
The group to own each extracted file.
New in version 2015.8.0.
Changed in version 2016.3.0: When used in combination with if_missing
, ownership will only
be enforced if if_missing
is a directory.
Some archives, such as tar, extract themselves in a subfolder. This directive can be used to validate if the archive had been previously extracted.
Changed in version 2016.3.0: When used in combination with either user
or group
,
ownership will only be enforced when if_missing
is a directory.
archive_format: tar
, otherwise optional.
It needs to be the tar argument specific to the archive being extracted,
such as 'J' for LZMA or 'v' to verbosely list files processed.
Using this option means that the tar executable on the target will
be used, which is less platform independent.
Main operators like -x, --extract, --get, -c and -f/--file
should not be used here.
If archive_format
is zip
or rar
and this option is not set,
then the Python tarfile module is used. The tarfile module supports gzip
and bz2 in Python 2.The number of files we should output on success before the rest are trimmed, if this is set to True then it will default to 100
New in version 2016.3.0.
salt.states.archive.
updateChecksum
(fname, target, checksum)¶Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2016.3.0