win_robocopy – Синхронизирует содержимое двух каталогов с помощью Robocopy
Новое в версии 2.2.
Описание
- Синхронизирует содержимое файлов/каталогов от источника до места назначения.
- Под капотом это просто вызов RoboCopy, так как он должен быть доступен на большинстве современных системах Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| dest путь / обязательно | Файл/каталог назначения для синхронизации (получит содержимое из src). | |
| flags строка | Непосредственно задайте флаги Robocopy. Если установлено, purge и recurse будут проигнорированы. | |
| purge логическое |
| Удаляет любые файлы/каталоги, найденные в месте назначения, которых нет в источнике. Включает флаг /purge в RoboCopy.Если установлено flags, это будет проигнорировано. |
| recurse логическое |
| Включает все подкаталоги (включает флаг /e в RoboCopy).Если установлено flags, это будет проигнорировано. |
| src путь / обязательно | Файл/каталог источника для синхронизации. |
Примечания
Примечание
- Это не полная копия модуля synchronize. В отличие от модуля synchronize, он выполняет синхронизацию/копирование только на удаленном компьютере, а не с главного на удаленный.
- Этот модуль в настоящее время не поддерживает все флаги Robocopy.
См. также
См. также
- synchronize – Обёртка над rsync для ускорения выполнения общих задач в ваших playbooks
- Официальная документация модуля 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.8/modules/win_robocopy_module.html