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 Ansible Configuration Settings.

ANSIBLE_INVENTORY_CACHE

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

Used by: amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin

ANSIBLE_INVENTORY_CACHE_CONNECTION

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

Used by: amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin

ANSIBLE_INVENTORY_CACHE_PLUGIN

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

Used by: amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin

ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

Prefix to use for cache plugin files/tables.

Used by: amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin

ANSIBLE_INVENTORY_CACHE_TIMEOUT

Cache duration in seconds.

Used by: amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin

ANSIBLE_INVENTORY_USE_EXTRA_VARS

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

Used by: amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin

AWS_ACCESS_KEY

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_ACCESS_KEY_ID

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_DEFAULT_PROFILE

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_DEFAULT_REGION

The region the EC2 instance is located.

Used by: amazon.aws.aws_ssm connection plugin

AWS_PROFILE

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_REGION

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_SECRET_ACCESS_KEY

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_SECRET_KEY

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_SESSION_MANAGER_PLUGIN

This defines the location of the session-manager-plugin binary.

Support for environment variable was added in version 9.1.0.

The plugin will first check the '/usr/local/bin/session-manager-plugin' as the default path of the SSM plugin if this does not exist, it will find the session-manager-plugin from the PATH environment variable. Added in version 9.1.0.

Used by: amazon.aws.aws_ssm connection plugin

AWS_SESSION_TOKEN

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

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.aws_ssm connection plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin

AWS_URL

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

Used by: amazon.aws.aws_account_attribute lookup plugin, amazon.aws.aws_ec2 inventory plugin, amazon.aws.aws_rds inventory plugin, amazon.aws.secretsmanager_secret lookup plugin, amazon.aws.ssm_parameter lookup plugin