Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove reference of scp_if_ssh option #1346

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

Akasurde
Copy link
Member

SUMMARY
  • scp_if_ssh is removed in Ansible 2.17, remove the references

Fixes: #1341

Signed-off-by: Abhijeet Kasurde akasurde@redhat.com

ISSUE TYPE
  • Bugfix Pull Request

* scp_if_ssh is removed in Ansible 2.17, remove the references

Fixes: ansible#1341

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
@Akasurde Akasurde requested a review from bcoca April 25, 2024 14:24
@Akasurde Akasurde added the core_approval This PR requires approval from the Ansible Core team label Apr 25, 2024
docs/docsite/rst/reference_appendices/faq.rst Outdated Show resolved Hide resolved
Co-authored-by: Maxwell G <maxwell@gtmx.me>
* Set an environment variable on your control node: ``export ANSIBLE_SCP_IF_SSH=False``
* Pass an environment variable when you run Ansible: ``ANSIBLE_SCP_IF_SSH=smart ansible-playbook``
* Modify your ``ansible.cfg`` file: add ``scp_if_ssh=False`` to the ``[ssh_connection]`` section
* Use SFTP instead of SCP by setting ``ssh_transfer_method`` to ``smart`` (which tries SFTP first). You can do this in one of four ways:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

smart is the default, so people should not need to set it.

SFTP is the optimal transfer method, from a security, speed and reliability perspective. To ensure you use it, check that you are doing one of the following:

* Set a :ref:`host variable <host_variables>` or :ref:`group variable <group_variables>` in inventory: ``ansible_ssh_transfer_method: smart``
* Set an environment variable on your control node: ``export ANSIBLE_SSH_TRANSFER_METHOD=smart``
* Pass an environment variable when you run Ansible: ``ANSIBLE_SSH_TRANSFER_METHOD=smart ansible-playbook``
* Modify your ``ansible.cfg`` file: add ``ssh_transfer_method=smart`` to the ``[ssh_connection]`` section
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would explain the difference between setting to smart and to sftp.

All of the following should default to smart to ensure backwards compatibility, it tries sftp, scp and dd over pipes , in that order. But if you would prefer to fail if SFTP is not used, set directly to sftp.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core_approval This PR requires approval from the Ansible Core team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

scp_if_ssh is scheduled for removal in 2.17
3 participants