ssh retry docs addition (#77930)

2 years ago · 15750aec52
parent f270b4e224
commit 15750aec52
1 changed files with 4 additions and 1 deletions
--- a/lib/ansible/plugins/connection/ssh.py
+++ b/lib/ansible/plugins/connection/ssh.py
@ -174,7 +174,10 @@ DOCUMENTATION = '''
            - name: ssh_extra_args
          default: ''
      reconnection_retries:
-          description: Number of attempts to connect.
+          description:
+            - Number of attempts to connect.
+            - Ansible retries connections only if it gets an SSH error with a return code of 255.
+            - Any errors with return codes other than 255 indicate an issue with program execution.
          default: 0
          type: integer
          env: