Persistent connection timer changes (#27272)

*  Add command_timeout timer that defines the amount
   of time to wait for a command or RPC call before
   timing out.
*  Remove connect_retries and connect_interval configuration
   varaible and replace it with connect_retry_timeout to control
   the timeout value of connection to local scoket.
*  Make required changes to netowrk action plugins and relevant
   network files in module_utils.
*  Required documentation changes.

1 files changed, 13 insertions, 12 deletions

diff --git a/examples/ansible.cfg b/examples/ansible.cfg
index 674c5d3333..d6892b2bac 100644
--- a/examples/ansible.cfg
+++ b/examples/ansible.cfg
@@ -400,20 +400,21 @@
 # Configures the persistent connection timeout value in seconds.  This value is
 # how long the persistent connection will remain idle before it is destroyed.  
 # If the connection doesn't receive a request before the timeout value 
-# expires, the connection is shutdown.  The default value is 30 seconds.
+# expires, the connection is shutdown. The default value is 30 seconds.
 #connect_timeout = 30
 
-# Configures the persistent connection retries.  This value configures the
-# number of attempts the ansible-connection will make when trying to connect
-# to the local domain socket.  The default value is 30.
-#connect_retries = 30
-
-# Configures the amount of time in seconds to wait between connection attempts 
-# to the local unix domain socket.  This value works in conjunction with the
-# connect_retries value to define how long to try to connect to the local
-# domain socket when setting up a persistent connection.  The default value is
-# 1 second.
-#connect_interval = 1
+# Configures the persistent connection retry timeout.  This value configures the
+# the retry timeout that ansible-connection will wait to connect
+# to the local domain socket. This value must be larger than the
+# ssh timeout (timeout) and less than persistent connection idle timeout (connect_timeout).
+# The default value is 15 seconds.
+#connect_retry_timeout = 15
+
+# The command timeout value defines the amount of time to wait for a command
+# or RPC call before timing out. The value for the command timeout must
+# be less than the value of the persistent connection idle timeout (connect_timeout)
+# The default value is 10 second.
+#command_timeout = 10
 
 [accelerate]
 #accelerate_port = 5099