archive
Collection: community.general
Full Name: parallax.community.general.archive
Aliases: community.general.archive, archive
Synopsis
Manage archive
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| path | string | yes | Remote absolute path, glob, or list of paths or globs for the files to compress or archive | |
| dest | string | The file name of the destination archive | ||
| format | string | gz | The type of compression to use Choices: gz, bz2, zip, tar, xz | |
| remove | bool | false | Remove source files after archiving | |
| force_archive | bool | false | Force archiving even if only a single file is specified | |
| exclude_path | string | Paths or globs to exclude from the archive | ||
| mode | string | Permissions for the resulting archive file | ||
| owner | string | Name of the user that should own the archive file | ||
| group | string | Name of the group that should own the archive file |
Example
- name: Example archive task
archive:
path: <your_path>