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

Примечание

Этот плагин является частью коллекции community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows

Для использования в книге задач укажите: community.windows.win_robocopy

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

Обзор

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

Параметры

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

Примечания

Примечание

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

См. также

ansible.posix.synchronize: Официальная документация модуля ansible.posix.synchronize.
ansible.windows.win_copy: Официальная документация модуля ansible.windows.win_copy.

Примеры

- 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: yes

- 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: yes

- 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: yes
    purge: yes

- 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 строка	всегда	Используемая командная строка. Пример: robocopy C:\DirectoryOne C:\DirectoryTwo /e /purge
dest строка	всегда	Файл/каталог назначения синхронизации. Пример: C:\Some\Path
flags строка	всегда	Любые флаги, переданные пользователем. Пример: /e /purge
msg строка	всегда	Вывод, интерпретированный в краткое сообщение. Пример: Файлы не скопированы!
output строка	успех	Вывод выполнения команды robocopy. Пример: ------------------------------------\n ROBOCOPY :: Robust File Copy for Windows \n------------------------------------\n
purge логическое	всегда	Было ли переключено флаг purge.
rc целое число	успех	Код возврата, возвращенный robocopy. Пример: 1
recurse логическое	всегда	Было ли переключено флаг recurse.
src строка	всегда	Файл/каталог источника синхронизации. Пример: C:\Some\Path

Авторы

Corwin Brown (@blakfeld)

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