Added docs for archive options in sychronize module. Added missing default value for dirs option.

reviewable/pr18780/r1
Timothy Appnel 11 years ago
parent 4cb2cb9bac
commit 4e8f5eaef5

@ -40,12 +40,60 @@ options:
required: false required: false
choices: [ 'push', 'pull' ] choices: [ 'push', 'pull' ]
default: 'push' default: 'push'
archive:
description:
- Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.
choices: [ 'yes', 'no' ]
default: 'yes'
required: false
delete: delete:
description: description:
- Delete files that don't exist (after transfer, not before) in the C(src) path. - Delete files that don't exist (after transfer, not before) in the C(src) path.
choices: [ 'yes', 'no' ] choices: [ 'yes', 'no' ]
default: 'no' default: 'no'
required: false required: false
dirs:
description:
- Transfer directories without recursing
choices: [ 'yes', 'no' ]
default: 'no'
required: false
recursive:
description:
- Recurse into directories.
choices: [ 'yes', 'no' ]
default: the value of the archive option
required: false
links:
description:
- Copy symlinks as symlinks.
choices: [ 'yes', 'no' ]
default: the value of the archive option
required: false
perms:
description:
- Preserve permissions.
choices: [ 'yes', 'no' ]
default: the value of the archive option
required: false
times:
description:
- Preserve modification times
choices: [ 'yes', 'no' ]
default: the value of the archive option
required: false
owner:
description:
- Preserve owner (super user only)
choices: [ 'yes', 'no' ]
default: the value of the archive option
required: false
group:
description:
- Preserve group
choices: [ 'yes', 'no' ]
default: the value of the archive option
required: false
rsync_path: rsync_path:
description: description:
- Specify the rsync command to run on the remote machine. See C(--rsync-path) on the rsync man page. - Specify the rsync command to run on the remote machine. See C(--rsync-path) on the rsync man page.
@ -54,9 +102,18 @@ author: Timothy Appnel
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Synchronization of src on the control machien to dest on the remote hosts # Synchronization of src on the control machine to dest on the remote hosts
synchronize: src=some/relative/path dest=/some/absolute/path synchronize: src=some/relative/path dest=/some/absolute/path
# Synchronization without any --archive options enabled
synchronize: src=some/relative/path dest=/some/absolute/path archive=no
# Synchronization with --archive options enabled except for --recursive
synchronize: src=some/relative/path dest=/some/absolute/path recursive=no
# Synchronization without --archive options enabled except use --links
synchronize: src=some/relative/path dest=/some/absolute/path archive=no links=yes
# Synchronization of two paths both on the control machine # Synchronization of two paths both on the control machine
local_action: synchronize src=some/relative/path dest=/some/absolute/path local_action: synchronize src=some/relative/path dest=/some/absolute/path
@ -86,7 +143,7 @@ def main():
private_key = dict(default=None), private_key = dict(default=None),
rsync_path = dict(default=None), rsync_path = dict(default=None),
archive = dict(default='yes', type='bool'), archive = dict(default='yes', type='bool'),
dirs = dict(type='bool'), dirs = dict(default='no', type='bool'),
recursive = dict(type='bool'), recursive = dict(type='bool'),
links = dict(type='bool'), links = dict(type='bool'),
perms = dict(type='bool'), perms = dict(type='bool'),

Loading…
Cancel
Save