ansible 之 archive

archive

官方文档

[root@ansible ~]# ansible-doc archive
> ARCHIVE    (/usr/lib/python2.7/site-packages/ansible-2.8.0.dev0-py2.7.egg/ansible/modules/files/archive.py)

        Packs an archive. It is the opposite of [unarchive]. By default, it assumes the compression source exists on the target. It will not copy the source file from the
        local system to the target before archiving. Source files can be deleted after archival by specifying `remove=True'.

  * This module is maintained by The Ansible Community
OPTIONS (= is mandatory):

- attributes
        The attributes the resulting file or directory should have.
        To get supported flags look at the man page for `chattr' on the target system.
        This string should contain the attributes in the same order as the one displayed by `lsattr'.
        The `=' operator is assumed as default, otherwise `+' or `-' operators need to be included in the string.
        (Aliases: attr)[Default: (null)]
        version_added: 2.3

- dest
        The file name of the destination archive. This is required when `path' refers to multiple files by either specifying a glob, a directory or multiple paths in a
        list.
        [Default: (null)]

- exclude_path
        Remote absolute path, glob, or list of paths or globs for the file or files to exclude from the archive
        [Default: (null)]
        version_added: 2.4

- format
        The type of compression to use.
        Support for xz was added in version 2.5.
        (Choices: bz2, gz, tar, xz, zip)[Default: gz]

- group
        Name of the group that should own the file/directory, as would be fed to `chown'.
        [Default: (null)]

- mode
        The permissions the resulting file or directory should have.
        For those used to `/usr/bin/chmod' remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an
        octal number (like `0644' or `01777') or quote it (like `'644'' or `'1777'') so Ansible receives a string and can do its own conversion from string into number.
        Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.
        As of version 1.8, the mode may be specified as a symbolic mode (for example, `u+rwx' or `u=rw,g=r,o=r').
        As of version 2.6, the mode may also be the special string `preserve'.
        When set to `preserve' the file will be given the same permissions as the source file.
        [Default: (null)]

- owner
        Name of the user that should own the file/directory, as would be fed to `chown'.
        [Default: (null)]

= path
        Remote absolute path, glob, or list of paths or globs for the file or files to compress or archive.


- remove
        Remove any added source files and trees after adding to archive.
        [Default: no]
        type: bool

- selevel
        The level part of the SELinux file context.
        This is the MLS/MCS attribute, sometimes known as the `range'.
        When set to `_default', it will use the `level' portion of the policy if available.
        [Default: s0]

- serole
        The role part of the SELinux file context.
        When set to `_default', it will use the `role' portion of the policy if available.
        [Default: (null)]

- setype
        The type part of the SELinux file context.
        When set to `_default', it will use the `type' portion of the policy if available.
        [Default: (null)]

- seuser
        The user part of the SELinux file context.
        By default it uses the `system' policy, where applicable.
        When set to `_default', it will use the `user' portion of the policy if available.
        [Default: (null)]

- unsafe_writes
        Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file.
        By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just
        broken in ways that prevent this. One example is docker mounted files, which cannot be updated atomically from inside the container and can only be written in an
        unsafe manner.
        This option allows Ansible to fall back to unsafe methods of updating files when atomic operations fail (however, it doesn't force Ansible to perform unsafe
        writes).
        IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
        [Default: False]
        type: bool
        version_added: 2.2


NOTES:
      * requires tarfile, zipfile, gzip and bzip2 packages on target host
      * requires lzma or backports.lzma if using xz format
      * can produce `gzip', `bzip2', `lzma' and `zip' compressed files or archives

AUTHOR: Ben Doherty (@bendoh)
        METADATA:
          status:
          - preview
          supported_by: community
        

EXAMPLES:
- name: Compress directory /path/to/foo/ into /path/to/foo.tgz
  archive:
    path: /path/to/foo
    dest: /path/to/foo.tgz

- name: Compress regular file /path/to/foo into /path/to/foo.gz and remove it
  archive:
    path: /path/to/foo
    remove: yes

- name: Create a zip archive of /path/to/foo
  archive:
    path: /path/to/foo
    format: zip

- name: Create a bz2 archive of multiple files, rooted at /path
  archive:
    path:
    - /path/to/foo
    - /path/wong/foo
    dest: /path/file.tar.bz2
    format: bz2

- name: Create a bz2 archive of a globbed path, while excluding specific dirnames
  archive:
    path:
    - /path/to/foo/*
    dest: /path/file.tar.bz2
    exclude_path:
    - /path/to/foo/bar
    - /path/to/foo/baz
    format: bz2

- name: Create a bz2 archive of a globbed path, while excluding a glob of dirnames
  archive:
    path:
    - /path/to/foo/*
    dest: /path/file.tar.bz2
    exclude_path:
    - /path/to/foo/ba*
    format: bz2

RETURN VALUES:


state:
    description:
        The current state of the archived file.
        If 'absent', then no source files were found and the archive does not exist.
        If 'compress', then the file source file is in the compressed state.
        If 'archive', then the source file or paths are currently archived.
        If 'incomplete', then an archive was created, but not all source paths were found.
    type: string
    returned: always
missing:
    description: Any files that were missing from the source.
    type: list
    returned: success
archived:
    description: Any files that were compressed or added to the archive.
    type: list
    returned: success
arcroot:
    description: The archive root.
    type: string
    returned: always
expanded_paths:
    description: The list of matching paths from paths argument.
    type: list
    returned: always
expanded_exclude_paths:
    description: The list of matching exclude paths from the exclude_path argument.
    type: list
    returned: always

参数说明

• attributes

• dest
  文件归档后的压缩包文件名，当 path中有多个文件或目录时，需提供 dest 参数

• exclude_path

• format
  文档压缩包的格式，默认值为 gz，可供选择的格式：bz2、gz、tar、xz、zip

• group
  默认值为：null
  设置文件或目录的所属组

• mode
  默认值为：null
  设置权限

• owner
  默认值：null
  设置文件或目录所有者

• path
  远程主机中需打包文件的绝对路径，可以是一个或多个文件

• remove
  默认值：no
  类型：bool
  文件归档完后，删除源文件

以下内容为 SELinux 相关：

• selevel
  默认值：s0

• serole
  默认值：null

• seuser
  默认值：null

• unsafe_writes
  默认值：False
  类型：bool