ansible.netcommon.persistent (3.1.3) — connection

Install collection

Install with ansible-galaxy collection install ansible.netcommon:==3.1.3

Add to requirements.yml

  collections:
    - name: ansible.netcommon
      version: 3.1.3

Description

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

Inputs

    
import_modules:
    default: true
    description:
    - 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:
    - name: ANSIBLE_NETWORK_IMPORT_MODULES
    ini:
    - key: import_modules
      section: ansible_network
    type: boolean
    vars:
    - name: ansible_network_import_modules

persistent_log_messages:
    default: false
    description:
    - 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:
    - name: ANSIBLE_PERSISTENT_LOG_MESSAGES
    ini:
    - key: log_messages
      section: persistent_connection
    type: boolean
    vars:
    - name: ansible_persistent_log_messages

persistent_command_timeout:
    default: 30
    description:
    - 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:
    - name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
    ini:
    - key: command_timeout
      section: persistent_connection
    type: int
    vars:
    - name: ansible_command_timeout

persistent_connect_timeout:
    default: 30
    description:
    - 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:
    - name: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
    ini:
    - key: connect_timeout
      section: persistent_connection
    type: int
    vars:
    - name: ansible_connect_timeout