Class: Ansible::Ruby::Modules::Win_robocopy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_robocopy.rb

Overview

Synchronizes the contents of two directories on the remote machine. Under the hood this just calls out to RoboCopy, since that should be available on most modern Windows Systems.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

#dest ⇒ String

Returns Destination file/directory to sync (Will receive contents of src).

Returns:

  • (String) —

    Destination file/directory to sync (Will receive contents of src).



17
 
# File 'lib/ansible/ruby/modules/generated/windows/win_robocopy.rb', line 17

attribute :dest

#flags ⇒ String?

Returns Directly supply Robocopy flags. If set, C(purge) and C(recurse) will be ignored.

Returns:

  • (String, nil) —

    Directly supply Robocopy flags. If set, C(purge) and C(recurse) will be ignored.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_robocopy.rb', line 29

attribute :flags

#purge ⇒ :yes, ...

Returns Deletes any files/directories found in the destination that do not exist in the source.,Toggles the C(/purge) flag to RoboCopy. If C(flags) is set, this will be ignored.

Returns:

  • (:yes, :no, nil) —

    Deletes any files/directories found in the destination that do not exist in the source.,Toggles the C(/purge) flag to RoboCopy. If C(flags) is set, this will be ignored.



25
 
# File 'lib/ansible/ruby/modules/generated/windows/win_robocopy.rb', line 25

attribute :purge

#recurse ⇒ :yes, ...

Returns Includes all subdirectories (Toggles the C(/e) flag to RoboCopy).,If C(flags) is set, this will be ignored.

Returns:

  • (:yes, :no, nil) —

    Includes all subdirectories (Toggles the C(/e) flag to RoboCopy).,If C(flags) is set, this will be ignored.



21
 
# File 'lib/ansible/ruby/modules/generated/windows/win_robocopy.rb', line 21

attribute :recurse

#src ⇒ String

Returns Source file/directory to sync.

Returns:

  • (String) —

    Source file/directory to sync.



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_robocopy.rb', line 13

attribute :src