ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-23 13:20:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add default Network timeout values to network troubleshooting guide (#51555)

Browse source 
* add toc and default timeout values

* make options more obvious
This commit is contained in:
Sandra McCann 2019-02-05 15:46:29 -05:00 • committed by Alicia Cozine
commit 9c058d3121
1 changed files with 52 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst
View file

@ -4,6 +4,9 @@
Network Debug and Troubleshooting Guide
***************************************
.. contents::
:local:
Introduction
============
@ -14,8 +17,6 @@ This section discusses how to debug and troubleshoot network modules in Ansible
How to troubleshoot
===================
@ -442,11 +443,10 @@ of inactivity), simple delete the socket file.
Timeout issues
==============
Timeouts
--------
Persistent connection idle timeout:
Persistent connection idle timeout
----------------------------------
For example:
By default, ``ANSIBLE_PERSISTENT_CONNECT_TIMEOUT`` is set to 30 (seconds). You may see the following error if this value is too low:
.. code-block:: yaml
@ -467,8 +467,12 @@ To make this a permanent change, add the following to your ``ansible.cfg`` file:
[persistent_connection]
connect_timeout = 60
Command timeout:
For example:
Command timeout
---------------
By default, ``ANSIBLE_PERSISTENT_COMMAND_TIMEOUT`` is set to 30 (seconds). Prior versions of Ansible had this value set to 10 seconds by default.
You may see the following error if this value is too low:
.. code-block:: yaml
@ -476,7 +480,7 @@ For example:
Suggestions to resolve:
Options 1 (Global command timeout setting):
* Option 1 (Global command timeout setting):
Increase value of command timeout in configuration file or by setting environment variable.
.. code-block:: yaml
@ -490,7 +494,7 @@ To make this a permanent change, add the following to your ``ansible.cfg`` file:
[persistent_connection]
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
timeout value that can be set on a per task basis.
The timeout value controls the amount of time in seconds before the
@ -530,8 +534,10 @@ 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
successfully.
Persistent socket connect timeout:
For example:
Persistent connection retry timeout
-----------------------------------
By default, ``ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT`` is set to 15 (seconds). You may see the following error if this value is too low:
.. code-block:: yaml