archive

Collection: community.general

Full Name: parallax.community.general.archive

Aliases: community.general.archive, archive

Synopsis

Manage archive

Parameters

NameTypeRequiredDefaultDescription
pathstringyesRemote absolute path, glob, or list of paths or globs for the files to compress or archive
deststringThe file name of the destination archive
formatstringgzThe type of compression to use Choices: gz, bz2, zip, tar, xz
removeboolfalseRemove source files after archiving
force_archiveboolfalseForce archiving even if only a single file is specified
exclude_pathstringPaths or globs to exclude from the archive
modestringPermissions for the resulting archive file
ownerstringName of the user that should own the archive file
groupstringName of the group that should own the archive file

Example

- name: Example archive task
  archive:
    path: <your_path>