win_copy - Копирование файлов в удаленные расположения на хостах Windows
Новое в версии 1.9.2.
Описание
- Модуль
win_copyкопирует файл с локального компьютера в удаленное расположение на Windows. - Для целей, отличных от Windows, используйте модуль copy вместо этого.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| content (добавлен в 2.3) | При использовании вместо src, задает содержимое файла непосредственно указанным значением. Это для простых значений; для сложных значений или значений с форматированием используйте модуль шаблонов. | |
| decrypt (добавлен в 2.5) |
| Этот параметр управляет автоматическим расшифрованием исходных файлов с помощью хранилища vault. |
| dest обязательно | Полный удаленный путь, куда должен быть скопирован файл. Если src — это каталог, то и dest должен быть каталогом. Используйте \ для разделителей путей или \\ в "двойных кавычках". Если dest заканчивается на \ , то источник или содержимое источника будут скопированы в каталог без изменения имени.Если dest — это несуществующий путь, он будет создан только если dest заканчивается на "/" или "\", или src является каталогом.Если src и dest являются файлами, и если родительский каталог dest не существует, задача завершится ошибкой. | |
| force (добавлен в 2.3) |
| Если установлено значение yes, файл будет передан только если содержимое отличается от содержимого назначения.Если установлено значение no, файл будет передан только если назначения не существует.Если установлено значение no, вычисление контрольной суммы содержимого не выполняется, что может повысить производительность при работе с большими файлами. |
| local_follow (добавлен в 2.4) |
| Этот флаг указывает, что ссылки на файлы системы в исходном дереве, если они существуют, должны быть пройдены. |
| remote_src (добавлен в 2.3) |
| Если False, поиск src будет происходить на машине-источнике/мастер-машине; если True, поиск src будет происходить на удаленной/целевой машине. |
| src обязательно | Локальный путь к файлу, который нужно скопировать на удаленный сервер; может быть абсолютным или относительным. Если путь указывает на каталог, он копируется (включая имя исходной папки) рекурсивно в dest. Если путь указывает на каталог и заканчивается на "/", копируются только содержимое этого каталога в назначение. В противном случае, если он не заканчивается на "/", копируется сам каталог со всем содержимым. Если путь указывает на файл и dest заканчивается на "\", файл копируется в папку с тем же именем файла. |
Примечания
Примечание
- Для целей, отличных от Windows, используйте модуль copy вместо этого.
- В настоящее время win_copy не поддерживает копирование символических ссылок как с локального на удаленный, так и с удаленного на удаленный.
- Рекомендуется использовать обратные слэши
\вместо/при работе с удаленными путями. - Поскольку win_copy работает через WinRM, это не очень эффективный механизм передачи. Если передаются большие файлы, рассмотрите возможность размещения их на веб-сервисе и использования win_get_url вместо этого.
Примеры
- name: Copy a single file
win_copy:
src: /srv/myfiles/foo.conf
dest: c:\Temp\renamed-foo.conf
- name: Copy a single file keeping the filename
win_copy:
src: /src/myfiles/foo.conf
dest: c:\temp\
- name: Copy folder to c:\temp (results in C:\Temp\temp_files)
win_copy:
src: files/temp_files
dest: c:\Temp
- name: Copy folder contents recursively
win_copy:
src: files/temp_files/
dest: c:\Temp
- name: Copy a single file where the source is on the remote host
win_copy:
src: C:\temp\foo.txt
dest: C:\ansible\foo.txt
remote_src: True
- name: Copy a folder recursively where the source is on the remote host
win_copy:
src: C:\temp
dest: C:\ansible
remote_src: True
- name: Set the contents of a file
win_copy:
dest: C:\temp\foo.txt
content: abc123
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| checksum строка | успех, src — это файл | контрольная сумма sha1 файла после выполнения копирования Пример: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| dest строка | изменён | файл/путь назначения Пример: C:\Temp\ |
| operation строка | успех | является ли это копированием одного файла или копированием папки Пример: file_copy |
| original_basename строка | изменён, src — это файл | имя файла, скопированного файла Пример: foo.txt |
| size целое число | изменён, src — это файл | размер назначения после выполнения Пример: 1220 |
| src строка | изменён | исходный файл, используемый для копирования на целевую машину Пример: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source |
Статус
Этот модуль помечен как stableinterface, что означает, что авторы гарантируют отсутствие несовместимых изменений в интерфейсе.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний
Автор
- Jon Hawkesworth (@jhawkesworth)
- Jordan Borean (@jborean93)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/win_copy_module.html