Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.97 KB

environment_variables.rst

File metadata and controls

53 lines (34 loc) · 1.97 KB
orphan

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 configuation are documented in ansible_configuration_settings.

ANSIBLE_INVENTORY_USE_EXTRA_VARS

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

Used by: netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>

NETBOX_API

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

Used by: netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>, netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>

NETBOX_API_KEY

NetBox API token to be able to read against NetBox.

This may not be required depending on the NetBox setup.

Used by: netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>

NETBOX_API_TOKEN

The API token created through NetBox

This may not be required depending on the NetBox setup.

Used by: netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>

NETBOX_TOKEN

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

Used by: netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>, netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>

NETBOX_URL

The URL to the NetBox instance to query

Used by: netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>