Skip to content

persistent

Collection Note

This module is part of the ansible.netcommon collection. To install the collection, use:

ansible-galaxy collection install ansible.netcommon
Added in version 1.0.0.

Synopsis

  • This is a helper plugin to allow making other connections persistent.

Parameters

Parameter Defaults / Choices Comments
import_modules
boolean		 Default: True
 Reduce CPU usage and network module execution time by enabling direct execution. Instead of the module being packaged and executed by the shell, it will be directly executed by the Ansible control node using the same python interpreter as the Ansible process. Note- Incompatible with C(asynchronous mode). Note- Python 3 and Ansible 2.9.16 or greater required. Note- With Ansible 2.9.x fully qualified modules names are required in tasks.
Env: ANSIBLE_NETWORK_IMPORT_MODULES
persistent_command_timeout
int		 Default: 30
 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.
Env: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
persistent_connect_timeout
int		 Default: 30
 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.
Env: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
persistent_log_messages
boolean		 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.
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.
Env: ANSIBLE_PERSISTENT_LOG_MESSAGES

Authors

  • Ansible Networking Team (@ansible-Network)