Модуль community.windows.win_robocopy — синхронизация содержимого двух каталогов с помощью Robocopy

Примечание

Этот модуль входит в коллекцию community.windows (версия 3.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.windows.

Чтобы использовать её в плейбуке, укажите: community.windows.win_robocopy.

Краткое описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Синхронизирует содержимое файлов и каталогов из источника в место назначения.
В основе работы лежит вызов RoboCopy, поскольку он должен быть доступен в большинстве современных систем Windows.

Параметры

Параметр	Комментарии
dest path / обязательный	Файл или каталог назначения для синхронизации (получит содержимое src).
flags string	Непосредственно передаёт флаги Robocopy. Если задано, `purge` и `recurse` игнорируются.
purge boolean	Удаляет все файлы и каталоги в месте назначения, которых нет в источнике. Переключает флаг `/purge` для RoboCopy. Если задано `flags`, этот параметр игнорируется. Варианты: `false` ← (по умолчанию) `true`
recurse boolean	Включает все подкаталоги (переключает флаг `/e` для RoboCopy). Если задано `flags`, этот параметр игнорируется. Варианты: `false` ← (по умолчанию) `true`
src path / обязательный	Исходный файл или каталог для синхронизации.

Примечания

Примечание

Это не полный перенос модуля ansible.posix.synchronize. В отличие от модуля ansible.posix.synchronize, этот модуль выполняет синхронизацию и копирование только на удалённом компьютере, а не с контроллера Ansible на удалённый компьютер.
В настоящее время этот модуль не поддерживает все флаги Robocopy.

См. также

ansible.posix.synchronize: Обёртка для rsync, упрощающая и ускоряющая выполнение типовых задач в плейбуках.
ansible.windows.win_copy: Копирует файлы в удалённые расположения на узлах Windows.

Примеры

- name: Sync the contents of one directory to another
  community.windows.win_robocopy:
    src: C:\DirectoryOne
    dest: C:\DirectoryTwo

- name: Sync the contents of one directory to another, including subdirectories
  community.windows.win_robocopy:
    src: C:\DirectoryOne
    dest: C:\DirectoryTwo
    recurse: true

- name: Sync the contents of one directory to another, and remove any files/directories found in destination that do not exist in the source
  community.windows.win_robocopy:
    src: C:\DirectoryOne
    dest: C:\DirectoryTwo
    purge: true

- name: Sync content in recursive mode, removing any files/directories found in destination that do not exist in the source
  community.windows.win_robocopy:
    src: C:\DirectoryOne
    dest: C:\DirectoryTwo
    recurse: true
    purge: true

- name: Sync two directories in recursive and purging mode, specifying additional special flags
  community.windows.win_robocopy:
    src: C:\DirectoryOne
    dest: C:\DirectoryTwo
    flags: /E /PURGE /XD SOME_DIR /XF SOME_FILE /MT:32

- name: Sync one file from a remote UNC path in recursive and purging mode, specifying additional special flags
  community.windows.win_robocopy:
    src: \\Server1\Directory One
    dest: C:\DirectoryTwo
    flags: file.zip /E /PURGE /XD SOME_DIR /XF SOME_FILE /MT:32

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
cmd string	Использованная командная строка. Возвращается: всегда Пример: `"robocopy C:\\DirectoryOne C:\\DirectoryTwo /e /purge"`
dest string	Файл или каталог назначения для синхронизации. Возвращается: всегда Пример: `"C:\\Some\\Path"`
flags string	Флаги, переданные пользователем. Возвращается: всегда Пример: `"/e /purge"`
msg string	Вывод, преобразованный в краткое сообщение. Возвращается: всегда Пример: `"No files copied!"`
output string	Вывод команды robocopy. Возвращается: при успешном выполнении Пример: `"------------------------------------\\n ROBOCOPY :: Robust File Copy for Windows \\n------------------------------------\\n "`
purge boolean	Указывает, был ли включён флаг purge. Возвращается: всегда Пример: `false`
rc integer	Код возврата, полученный от robocopy. Возвращается: при успешном выполнении Пример: `1`
recurse boolean	Указывает, был ли включён флаг recurse. Возвращается: всегда Пример: `false`
src string	Исходный файл или каталог для синхронизации. Возвращается: всегда Пример: `"C:\\Some\\Path"`

Авторы

Corwin Brown (@blakfeld)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/windows/win_robocopy_module.html