win_copy – Копирование файлов в удаленные расположения на хостах Windows
Новая в версии 1.9.2.
Обзор
- Модуль
win_copyкопирует файл с локального компьютера в удаленное расположение на Windows. - Для целей, не являющихся Windows, используйте модуль copy вместо него.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| content - Добавлен в 2.3 | При использовании вместо src, устанавливает содержимое файла непосредственно в указанное значение. Подходит для простых значений; для сложных или форматированных значений используйте модуль шаблонов. | |
| decrypt boolean Добавлен в 2.5 |
| Этот параметр управляет автоматическим расшифрованием исходных файлов с помощью хранилища. |
| dest путь / обязательный | Абсолютный удаленный путь, куда должен быть скопирован файл. Если src — это каталог, то и dest должен быть каталогом. Используйте \ для разделителей путей или \\ в "двойных кавычках". Если dest заканчивается на \ , то исходный файл или содержимое исходного файла будут скопированы в каталог без переименования.Если dest — это несуществующий путь, он будет создан только если dest заканчивается на "/" или "\", или src — это каталог.Если src и dest — это файлы, и если родительский каталог dest не существует, задача завершится ошибкой. | |
| force boolean Добавлен в 2.3 |
| Если установлено yes, файл будет передан только в том случае, если его содержимое отличается от содержимого целевого файла.Если установлено no, файл будет передан только в том случае, если целевой файл не существует.Если установлено no, вычисление контрольной суммы содержимого не выполняется, что может повысить производительность при работе с большими файлами. |
| local_follow boolean Добавлен в 2.4 |
| Этот флаг указывает, что системные ссылки в исходном дереве, если они существуют, должны быть прослежены. |
| remote_src boolean Добавлен в 2.3 |
| Если no, будет выполнен поиск src на исходной/главной машине.Если yes, будет выполнен поиск 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: yes
- name: Copy a folder recursively where the source is on the remote host
win_copy:
src: C:\Temp
dest: C:\ansible
remote_src: yes
- name: Set the contents of a file
win_copy:
content: abc123
dest: C:\Temp\foo.txt
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| 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]
- Этот модуль поддерживается основной командой Ansible. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля Red Hat можно найти в этой статье базы знаний 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.7/modules/win_copy_module.html
