:orphan:

.. meta::
  :antsibull-docs: 2.26.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:: ANSIBLE_INVENTORY_CACHE

    Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`
.. envvar:: ANSIBLE_INVENTORY_CACHE_CONNECTION

    Cache connection data or path, read cache plugin documentation for specifics.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`
.. envvar:: ANSIBLE_INVENTORY_CACHE_PLUGIN

    Cache plugin to use for the inventory's source data.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`
.. envvar:: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

    Prefix to use for cache plugin files/tables.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`
.. envvar:: ANSIBLE_INVENTORY_CACHE_TIMEOUT

    Cache duration in seconds.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`
.. envvar:: ANSIBLE_INVENTORY_USE_EXTRA_VARS

    Merge extra vars into the available variables for composition (highest precedence).

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`
.. envvar:: SCW_ACCESS_KEY

    Scaleway API access key.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`,
    :ansplugin:`stephrobert.scaleway.resource\_id lookup plugin <stephrobert.scaleway.resource_id#lookup>`
.. envvar:: SCW_API_URL

    See the documentations for the options where this environment variable is used.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`,
    :ansplugin:`stephrobert.scaleway.resource\_id lookup plugin <stephrobert.scaleway.resource_id#lookup>`
.. envvar:: SCW_CONFIG_PATH

    Path to the Scaleway configuration file.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`,
    :ansplugin:`stephrobert.scaleway.resource\_id lookup plugin <stephrobert.scaleway.resource_id#lookup>`
.. envvar:: SCW_DEFAULT_ORGANIZATION_ID

    Default Organization ID.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`,
    :ansplugin:`stephrobert.scaleway.resource\_id lookup plugin <stephrobert.scaleway.resource_id#lookup>`
.. envvar:: SCW_DEFAULT_PROJECT_ID

    Default Project ID.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`,
    :ansplugin:`stephrobert.scaleway.resource\_id lookup plugin <stephrobert.scaleway.resource_id#lookup>`
.. envvar:: SCW_PROFILE

    Name of the profile to read in the Scaleway configuration file.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`,
    :ansplugin:`stephrobert.scaleway.resource\_id lookup plugin <stephrobert.scaleway.resource_id#lookup>`
.. envvar:: SCW_SECRET_KEY

    Scaleway API secret key.

    *Used by:*
    :ansplugin:`stephrobert.scaleway.compute inventory plugin <stephrobert.scaleway.compute#inventory>`,
    :ansplugin:`stephrobert.scaleway.resource\_id lookup plugin <stephrobert.scaleway.resource_id#lookup>`