:orphan:

.. meta::
  :antsibull-docs: 2.23.0

.. _list_of_collection_env_vars:

Index of all Collection Environment Variables
=============================================

The following index documents all environment variables declared by plugins in collections.
Environment variables used by the ansible-core configuration are documented in :ref:`ansible_configuration_settings`.

.. envvar:: AMNESH_NETWORK_TERMINAL_TYPE

    Specifies the terminal type to be used when requesting the pseudo terminal from the remote device. The default terminal type is :literal:`vt100`.

    *Used by:*
    :ansplugin:`amnesh.soodar.network\_cli connection plugin <amnesh.soodar.network_cli#connection>`
.. envvar:: ANSIBLE_HOST_KEY_AUTO_ADD

    By default, Ansible will prompt the user before adding SSH keys to the known hosts file. Since persistent connections such as network\_cli run in background processes, the user will never be prompted. By enabling this option, unknown host keys will automatically be added to the known hosts file.

    Be sure to fully understand the security implications of enabling this option on production systems as it could create a security vulnerability.

    *Used by:*
    :ansplugin:`amnesh.soodar.network\_cli connection plugin <amnesh.soodar.network_cli#connection>`
.. envvar:: ANSIBLE_NETWORK_CLI_RETRIES

    Number of attempts to connect to remote host. The delay time between the retires increases after every attempt by power of 2 in seconds till either the maximum attempts are exhausted or any of the :literal:`persistent\_command\_timeout` or :literal:`persistent\_connect\_timeout` timers are triggered.

    *Used by:*
    :ansplugin:`amnesh.soodar.network\_cli connection plugin <amnesh.soodar.network_cli#connection>`
.. envvar:: ANSIBLE_NETWORK_CLI_SSH_TYPE

    The python package that will be used by the :literal:`network\_cli` connection plugin to create a SSH connection to remote host.

    :emphasis:`libssh` will use the ansible\-pylibssh package, which needs to be installed in order to work.

    :emphasis:`paramiko` will instead use the paramiko package to manage the SSH connection.

    :emphasis:`auto` will use ansible\-pylibssh if that package is installed, otherwise will fallback to paramiko.

    *Used by:*
    :ansplugin:`amnesh.soodar.network\_cli connection plugin <amnesh.soodar.network_cli#connection>`
.. envvar:: ANSIBLE_NETWORK_SINGLE_USER_MODE

    This option enables caching of data fetched from the target for re\-use. The cache is invalidated when the target device enters configuration mode.

    Applicable only for platforms where this has been implemented.

    *Used by:*
    :ansplugin:`amnesh.soodar.network\_cli connection plugin <amnesh.soodar.network_cli#connection>`
.. envvar:: ANSIBLE_PERSISTENT_BUFFER_READ_TIMEOUT

    Configures, in seconds, the amount of time to wait for the data to be read from Paramiko channel after the command prompt is matched. This timeout value ensures that command prompt matched is correct and there is no more data left to be received from remote host.

    *Used by:*
    :ansplugin:`amnesh.soodar.network\_cli connection plugin <amnesh.soodar.network_cli#connection>`
.. envvar:: ANSIBLE_SSH_HOST_KEY_CHECKING

    Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host

    *Used by:*
    :ansplugin:`amnesh.soodar.network\_cli connection plugin <amnesh.soodar.network_cli#connection>`