Class: Ansible::Ruby::Modules::Synchronize

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/files/synchronize.rb

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, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#archive ⇒ :yes, ...

Returns Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.

Returns:

  • (:yes, :no, nil) —

    Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.



26
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 26

attribute :archive

#checksum ⇒ :yes, ...

Returns Skip based on checksum, rather than mod-time & size; Note that that “archive” option is still enabled by default - the “checksum” option will not disable it.

Returns:

  • (:yes, :no, nil) —

    Skip based on checksum, rather than mod-time & size; Note that that “archive” option is still enabled by default - the “checksum” option will not disable it.



30
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 30

attribute :checksum

#compress ⇒ :yes, ...

Returns Compress file data during the transfer. In most cases, leave this enabled unless it causes problems.

Returns:

  • (:yes, :no, nil) —

    Compress file data during the transfer. In most cases, leave this enabled unless it causes problems.



34
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 34

attribute :compress

#copy_links ⇒ :yes, ...

Returns Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.

Returns:

  • (:yes, :no, nil) —

    Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.



58
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 58

attribute :copy_links

#delete ⇒ :yes, ...

Returns Delete files that don’t exist (after transfer, not before) in the C(src) path. This option requires C(recursive=yes).

Returns:

  • (:yes, :no, nil) —

    Delete files that don’t exist (after transfer, not before) in the C(src) path. This option requires C(recursive=yes).



42
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 42

attribute :delete

#dest ⇒ Object

Returns Path on the destination host that will be synchronized from the source; The path can be absolute or relative.

Returns:

  • (Object) —

    Path on the destination host that will be synchronized from the source; The path can be absolute or relative.



14
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 14

attribute :dest

#dest_port ⇒ Array<String>, ...

Returns Port number for ssh on the destination host. Prior to ansible 2.0, the ansible_ssh_port inventory var took precedence over this value.

Returns:

  • (Array<String>, String, nil) —

    Port number for ssh on the destination host. Prior to ansible 2.0, the ansible_ssh_port inventory var took precedence over this value.



18
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 18

attribute :dest_port

#dirs ⇒ :yes, ...

Returns Transfer directories without recursing.

Returns:

  • (:yes, :no, nil) —

    Transfer directories without recursing



46
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 46

attribute :dirs

#existing_only ⇒ :yes, ...

Returns Skip creating new files on receiver.

Returns:

  • (:yes, :no, nil) —

    Skip creating new files on receiver.



38
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 38

attribute :existing_only

#group ⇒ :yes, ...

Returns Preserve group.

Returns:

  • (:yes, :no, nil) —

    Preserve group



74
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 74

attribute :group

#links ⇒ :yes, ...

Returns Copy symlinks as symlinks.

Returns:

  • (:yes, :no, nil) —

    Copy symlinks as symlinks.



54
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 54

attribute :links

#mode ⇒ :push, ...

Returns Specify the direction of the synchronization. In push mode the localhost or delegate is the source; In pull mode the remote host in context is the source.

Returns:

  • (:push, :pull, nil) —

    Specify the direction of the synchronization. In push mode the localhost or delegate is the source; In pull mode the remote host in context is the source.



22
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 22

attribute :mode

#owner ⇒ :yes, ...

Returns Preserve owner (super user only).

Returns:

  • (:yes, :no, nil) —

    Preserve owner (super user only)



70
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 70

attribute :owner

#partial ⇒ Boolean?

Returns Tells rsync to keep the partial file which should make a subsequent transfer of the rest of the file much faster.

Returns:

  • (Boolean, nil) —

    Tells rsync to keep the partial file which should make a subsequent transfer of the rest of the file much faster.



96
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 96

attribute :partial

#perms ⇒ :yes, ...

Returns Preserve permissions.

Returns:

  • (:yes, :no, nil) —

    Preserve permissions.



62
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 62

attribute :perms

#recursive ⇒ :yes, ...

Returns Recurse into directories.

Returns:

  • (:yes, :no, nil) —

    Recurse into directories.



50
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 50

attribute :recursive

#rsync_opts ⇒ Object?

Returns Specify additional rsync options by passing in an array.

Returns:

  • (Object, nil) —

    Specify additional rsync options by passing in an array.



93
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 93

attribute :rsync_opts

#rsync_path ⇒ Object?

Returns Specify the rsync command to run on the remote host. See C(–rsync-path) on the rsync man page.

Returns:

  • (Object, nil) —

    Specify the rsync command to run on the remote host. See C(–rsync-path) on the rsync man page.



78
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 78

attribute :rsync_path

#rsync_timeout ⇒ Integer?

Returns Specify a –timeout for the rsync command in seconds.

Returns:

  • (Integer, nil) —

    Specify a –timeout for the rsync command in seconds.



81
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 81

attribute :rsync_timeout

#set_remote_user ⇒ Boolean?

Returns put user@ for the remote paths. If you have a custom ssh config to define the remote user for a host that does not match the inventory user, you should set this parameter to “no”.

Returns:

  • (Boolean, nil) —

    put user@ for the remote paths. If you have a custom ssh config to define the remote user for a host that does not match the inventory user, you should set this parameter to “no”.



85
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 85

attribute :set_remote_user

#src ⇒ Object

Returns Path on the source host that will be synchronized to the destination; The path can be absolute or relative.

Returns:

  • (Object) —

    Path on the source host that will be synchronized to the destination; The path can be absolute or relative.



10
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 10

attribute :src

#times ⇒ :yes, ...

Returns Preserve modification times.

Returns:

  • (:yes, :no, nil) —

    Preserve modification times



66
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 66

attribute :times

#use_ssh_args ⇒ :yes, ...

Returns Use the ssh_args specified in ansible.cfg.

Returns:

  • (:yes, :no, nil) —

    Use the ssh_args specified in ansible.cfg



89
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 89

attribute :use_ssh_args

#verify_host ⇒ Boolean?

Returns Verify destination host key.

Returns:

  • (Boolean, nil) —

    Verify destination host key.



100
 
# File 'lib/ansible/ruby/modules/generated/core/files/synchronize.rb', line 100

attribute :verify_host