Increase persistent command_timeout default value (#51056)

* Increase persistent command_timeout default value

*  Increase command_timeout default value from 10 to 30 sec
   to reduce frequent timeout issue for network connection
   types (netconf/network_cli/httpapi/napalm)

* Fix review comments
This commit is contained in:
Ganesh Nalawade 2019-01-21 10:50:52 +05:30 committed by GitHub
parent 9b3e74fe91
commit 1b6228fa10
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 17 additions and 21 deletions

View file

@ -0,0 +1,3 @@
---
minor_changes:
- "Increase the default persistent command_timeout value from 10 to 30 seconds to reduce frequent timeout issues."

View file

@ -240,7 +240,7 @@ If the identified error message from the log file is:
.. code-block:: yaml .. code-block:: yaml
2017-04-04 12:19:05,670 p=18591 u=fred | command timeout triggered, timeout value is 10 secs 2017-04-04 12:19:05,670 p=18591 u=fred | command timeout triggered, timeout value is 30 secs
or or
@ -472,7 +472,7 @@ For example:
.. code-block:: yaml .. code-block:: yaml
2017-04-04 12:19:05,670 p=18591 u=fred | command timeout triggered, timeout value is 10 secs 2017-04-04 12:19:05,670 p=18591 u=fred | command timeout triggered, timeout value is 30 secs
Suggestions to resolve: Suggestions to resolve:
@ -481,14 +481,14 @@ Increase value of command timeout in configuration file or by setting environmen
.. code-block:: yaml .. code-block:: yaml
export ANSIBLE_PERSISTENT_COMMAND_TIMEOUT=30 export ANSIBLE_PERSISTENT_COMMAND_TIMEOUT=60
To make this a permanent change, add the following to your ``ansible.cfg`` file: To make this a permanent change, add the following to your ``ansible.cfg`` file:
.. code-block:: ini .. code-block:: ini
[persistent_connection] [persistent_connection]
command_timeout = 30 command_timeout = 60
Option 2 (Per task command timeout setting): Option 2 (Per task command timeout setting):
Increase command timeout per task basis. All network modules support a Increase command timeout per task basis. All network modules support a
@ -522,11 +522,11 @@ Suggestions to resolve:
ios_command: ios_command:
commands: copy running-config startup-config commands: copy running-config startup-config
vars: vars:
ansible_command_timeout: 30 ansible_command_timeout: 60
Some operations take longer than the default 10 seconds to complete. One good Some operations take longer than the default 30 seconds to complete. One good
example is saving the current running config on IOS devices to startup config. example is saving the current running config on IOS devices to startup config.
In this case, changing the timeout value from the default 10 seconds to 30 In this case, changing the timeout value from the default 30 seconds to 60
seconds will prevent the task from failing before the command completes seconds will prevent the task from failing before the command completes
successfully. successfully.

View file

@ -435,18 +435,11 @@
# 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 #connect_timeout = 30
# 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 # 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 # 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) # be less than the value of the persistent connection idle timeout (connect_timeout)
# The default value is 10 second. # The default value is 30 second.
#command_timeout = 10 #command_timeout = 30
[accelerate] [accelerate]
#accelerate_port = 5099 #accelerate_port = 5099

View file

@ -1554,7 +1554,7 @@ PERSISTENT_CONNECT_RETRY_TIMEOUT:
type: integer type: integer
PERSISTENT_COMMAND_TIMEOUT: PERSISTENT_COMMAND_TIMEOUT:
name: Persistence command timeout name: Persistence command timeout
default: 10 default: 30
description: This controls the amount of time to wait for response from remote device before timing out presistent connection. description: This controls the amount of time to wait for response from remote device before timing out presistent connection.
env: [{name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT}] env: [{name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT}]
ini: ini:

View file

@ -137,7 +137,7 @@ options:
return from the remote device. If this timer is exceeded before the return from the remote device. If this timer is exceeded before the
command returns, the connection plugin will raise an exception and command returns, the connection plugin will raise an exception and
close. close.
default: 10 default: 30
ini: ini:
- section: persistent_connection - section: persistent_connection
key: command_timeout key: command_timeout

View file

@ -121,7 +121,7 @@ options:
return from the remote device. If this timer is exceeded before the return from the remote device. If this timer is exceeded before the
command returns, the connection plugin will raise an exception and command returns, the connection plugin will raise an exception and
close. close.
default: 10 default: 30
ini: ini:
- section: persistent_connection - section: persistent_connection
key: command_timeout key: command_timeout

View file

@ -149,7 +149,7 @@ options:
return from the remote device. If this timer is exceeded before the return from the remote device. If this timer is exceeded before the
command returns, the connection plugin will raise an exception and command returns, the connection plugin will raise an exception and
close. close.
default: 10 default: 30
ini: ini:
- section: persistent_connection - section: persistent_connection
key: command_timeout key: command_timeout

View file

@ -151,7 +151,7 @@ options:
return from the remote device. If this timer is exceeded before the return from the remote device. If this timer is exceeded before the
command returns, the connection plugin will raise an exception and command returns, the connection plugin will raise an exception and
close. close.
default: 10 default: 30
ini: ini:
- section: persistent_connection - section: persistent_connection
key: command_timeout key: command_timeout