synchronize module "ssh_args" parameters is not documented

[berlic]

ISSUE TYPE

• Documentation Report

COMPONENT NAME

synchronize module(action plugin)

ANSIBLE VERSION

ansible 2.0.0.2

and current devel

CONFIGURATION

standard

OS / ENVIRONMENT

Ubuntu 14.04

SUMMARY

Ability to use ssh_args parameter to add custom ssh options to rsync is not documented.

Example:

- name: sync and dont touch known_hosts
  synchronize: src=. dest=/sources ssh_args="-o UserKnownHostsFile=/dev/null"

[berlic]

ssh_args is the solution for:
#270
#483

[sivel]

ssh_args was purposefully not documented. It is an internally created argument, that is populated when use_ssh_args is supplied to the module. This is to pass on the ssh_args configuration from ansible.cfg.

[berlic]

Thanks for reply, @sivel !

In this case there is no documented way to prevent rsync from reading/writing known_hosts file.
Modifying ssh_args in ansible.cfg is discouraged by the docs, because it completely overwrites ansible default ssh arguments instead of appending it. Inventory parameter ansible_ssh_common_args is advised, which is ignored by synchronize module.

If setting ssh_args for synchronize module should be avoided, use_ssh_args must honor inventory parameters: ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args.

[sivel]

Yes, synchronize should be updated to cascade ssh_*args.

[sivel]

I've submitted ansible/ansible#15306 to address the lack of cascading the args configurations.

[berlic]

Thanks! Should I close the issue now?

[sivel]

It can remain open for right now, while the bug still exists.

[tima]

Unless I'm missing something, I believe this issue can be closed now.

[ansibot]

@ansible, ping. This issue is still waiting on your response.
click here for bot help

[tima]

bug_resolved