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.
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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.7/modules/win_robocopy_module.html