129 lines
4.9 KiB
ReStructuredText
129 lines
4.9 KiB
ReStructuredText
.. _ansible.netcommon.persistent_connection:
|
|
|
|
|
|
****************************
|
|
ansible.netcommon.persistent
|
|
****************************
|
|
|
|
**Use a persistent unix socket for connection**
|
|
|
|
|
|
Version added: 1.0.0
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
|
|
Synopsis
|
|
--------
|
|
- This is a helper plugin to allow making other connections persistent.
|
|
|
|
|
|
|
|
|
|
Parameters
|
|
----------
|
|
|
|
.. raw:: html
|
|
|
|
<table border=0 cellpadding=0 class="documentation-table">
|
|
<tr>
|
|
<th colspan="1">Parameter</th>
|
|
<th>Choices/<font color="blue">Defaults</font></th>
|
|
<th>Configuration</th>
|
|
<th width="100%">Comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
<b>persistent_command_timeout</b>
|
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">integer</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>Default:</b><br/><div style="color: blue">30</div>
|
|
</td>
|
|
<td>
|
|
<div> ini entries:
|
|
<p>[persistent_connection]<br>command_timeout = 30</p>
|
|
</div>
|
|
<div>env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT</div>
|
|
<div>var: ansible_command_timeout</div>
|
|
</td>
|
|
<td>
|
|
<div>Configures, in seconds, the amount of time to wait for a command to return from the remote device. If this timer is exceeded before the command returns, the connection plugin will raise an exception and close.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
<b>persistent_connect_timeout</b>
|
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">integer</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>Default:</b><br/><div style="color: blue">30</div>
|
|
</td>
|
|
<td>
|
|
<div> ini entries:
|
|
<p>[persistent_connection]<br>connect_timeout = 30</p>
|
|
</div>
|
|
<div>env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT</div>
|
|
<div>var: ansible_connect_timeout</div>
|
|
</td>
|
|
<td>
|
|
<div>Configures, in seconds, the amount of time to wait when trying to initially establish a persistent connection. If this value expires before the connection to the remote device is completed, the connection will fail.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
<b>persistent_log_messages</b>
|
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">boolean</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>Default:</b><br/><div style="color: blue">"no"</div>
|
|
</td>
|
|
<td>
|
|
<div> ini entries:
|
|
<p>[persistent_connection]<br>log_messages = no</p>
|
|
</div>
|
|
<div>env:ANSIBLE_PERSISTENT_LOG_MESSAGES</div>
|
|
<div>var: ansible_persistent_log_messages</div>
|
|
</td>
|
|
<td>
|
|
<div>This flag will enable logging the command executed and response received from target device in the ansible log file. For this option to work 'log_path' ansible configuration option is required to be set to a file path with write access.</div>
|
|
<div>Be sure to fully understand the security implications of enabling this option as it could create a security vulnerability by logging sensitive information in log file.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Status
|
|
------
|
|
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
- Ansible Networking Team (@ansible-network)
|
|
|
|
|
|
.. hint::
|
|
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
|