Class: Ansible::Ruby::Modules::Win_copy
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Win_copy
- Defined in:
- lib/ansible/ruby/modules/generated/windows/win_copy.rb
Overview
The C(win_copy) module copies a file on the local box to remote windows locations. For non-Windows targets, use the M(copy) module instead.
Instance Method Summary collapse
-
#content ⇒ String?
When used instead of C(src), sets the contents of a file directly to the specified value.
-
#decrypt ⇒ :yes, ...
This option controls the autodecryption of source files using vault.
-
#dest ⇒ String
Remote absolute path where the file should be copied to.
-
#force ⇒ :yes, ...
If set to C(yes), the file will only be transferred if the content is different than destination.,If set to C(no), the file will only be transferred if the destination does not exist.,If set to C(no), no checksuming of the content is performed which can help improve performance on larger files.
-
#local_follow ⇒ :yes, ...
This flag indicates that filesystem links in the source tree, if they exist, should be followed.
-
#remote_src ⇒ :yes, ...
If C(no), it will search for src at originating/master machine.,If C(yes), it will go to the remote/target machine for the src.
-
#src ⇒ String
Local path to a file to copy to the remote server; can be absolute or relative.,If path is a directory, it is copied (including the source folder name) recursively to C(dest).,If path is a directory and ends with “/”, only the inside contents of that directory are copied to the destination.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#content ⇒ String?
Returns When used instead of C(src), sets the contents of a file directly to the specified value. This is for simple values, for anything complex or with formatting please switch to the template module.
13 |
# File 'lib/ansible/ruby/modules/generated/windows/win_copy.rb', line 13 attribute :content |
#decrypt ⇒ :yes, ...
Returns This option controls the autodecryption of source files using vault.
17 |
# File 'lib/ansible/ruby/modules/generated/windows/win_copy.rb', line 17 attribute :decrypt |
#dest ⇒ String
Returns Remote absolute path where the file should be copied to. If src is a directory, this must be a directory too.,Use \ for path separators or \ when in “double quotes”.,If C(dest) ends with \ then source or the contents of source will be copied to the directory without renaming.,If C(dest) is a nonexistent path, it will only be created if C(dest) ends with “/” or “", or C(src) is a directory.,If C(src) and C(dest) are files and if the parent directory of C(dest) doesn’t exist, then the task will fail.
21 |
# File 'lib/ansible/ruby/modules/generated/windows/win_copy.rb', line 21 attribute :dest |
#force ⇒ :yes, ...
Returns If set to C(yes), the file will only be transferred if the content is different than destination.,If set to C(no), the file will only be transferred if the destination does not exist.,If set to C(no), no checksuming of the content is performed which can help improve performance on larger files.
25 |
# File 'lib/ansible/ruby/modules/generated/windows/win_copy.rb', line 25 attribute :force |
#local_follow ⇒ :yes, ...
Returns This flag indicates that filesystem links in the source tree, if they exist, should be followed.
29 |
# File 'lib/ansible/ruby/modules/generated/windows/win_copy.rb', line 29 attribute :local_follow |
#remote_src ⇒ :yes, ...
Returns If C(no), it will search for src at originating/master machine.,If C(yes), it will go to the remote/target machine for the src.
33 |
# File 'lib/ansible/ruby/modules/generated/windows/win_copy.rb', line 33 attribute :remote_src |
#src ⇒ String
Returns Local path to a file to copy to the remote server; can be absolute or relative.,If path is a directory, it is copied (including the source folder name) recursively to C(dest).,If path is a directory and ends with “/”, only the inside contents of that directory are copied to the destination. Otherwise, if it does not end with “/”, the directory itself with all contents is copied.,If path is a file and dest ends with “", the file is copied to the folder with the same filename.
37 |
# File 'lib/ansible/ruby/modules/generated/windows/win_copy.rb', line 37 attribute :src |