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

Примечание

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

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

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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

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

Авторы

Corwin Brown (@blakfeld)

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

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