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

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

Описание

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

Параметры

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

Примечания

Примечание

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

См. также

synchronize – Обертка вокруг rsync для ускорения выполнения распространенных задач в ваших конвейерах: Официальная документация модуля synchronize.
win_copy – Копирует файлы на удаленные узлы Windows: Официальная документация модуля win_copy.

Примеры

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

- name: Sync the contents of one directory to another, including subdirectories
  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
  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
  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
  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
  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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/win_robocopy_module.html