community.general.stackpath_compute – StackPath Edge Computing inventory source¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.stackpath_compute
.
New in version 1.2.0: of community.general
Synopsis¶
Get inventory hosts from StackPath Edge Computing.
Uses a YAML configuration file that ends with stackpath_compute.(yml|yaml).
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
cache
boolean
|
|
ini entries:
[inventory]
env:ANSIBLE_INVENTORY_CACHE
|
Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work.
|
cache_connection
string
|
ini entries:
[defaults]
[inventory]
env:ANSIBLE_CACHE_PLUGIN_CONNECTION
env:ANSIBLE_INVENTORY_CACHE_CONNECTION
|
Cache connection data or path, read cache plugin documentation for specifics.
|
|
cache_plugin
string
|
Default: "memory"
|
ini entries:
[defaults]
[inventory]
env:ANSIBLE_CACHE_PLUGIN
env:ANSIBLE_INVENTORY_CACHE_PLUGIN
|
Cache plugin to use for the inventory's source data.
|
cache_prefix
string
|
Default: "ansible_inventory_"
|
ini entries:
[default]
[inventory]
env:ANSIBLE_CACHE_PLUGIN_PREFIX
env:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX
|
Prefix to use for cache plugin files/tables
|
cache_timeout
integer
|
Default: 3600
|
ini entries:
[defaults]
[inventory]
env:ANSIBLE_CACHE_PLUGIN_TIMEOUT
env:ANSIBLE_INVENTORY_CACHE_TIMEOUT
|
Cache duration in seconds
|
client_id
string
/ required
|
An OAuth client ID generated from the API Management section of the StackPath customer portal https://control.stackpath.net/api-management.
|
||
client_secret
string
/ required
|
An OAuth client secret generated from the API Management section of the StackPath customer portal https://control.stackpath.net/api-management.
|
||
compose
dictionary
|
Default: {}
|
Create vars from jinja2 expressions.
|
|
groups
dictionary
|
Default: {}
|
Add hosts to group based on Jinja2 conditionals.
|
|
keyed_groups
list
/ elements=string
|
Default: []
|
Add hosts to group based on the values of a variable.
|
|
plugin
string
/ required
|
|
A token that ensures this is a source file for the plugin.
|
|
stack_slugs
list
/ elements=string
|
A list of Stack slugs to query instances in. If no entry then get instances in all stacks on the account.
|
||
strict
boolean
|
|
If
yes make invalid entries a fatal error, otherwise skip and continue.Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.
|
|
use_internal_ip
boolean
|
|
Whether or not to use internal IP addresses, If false, uses external IP addresses, internal otherwise.
If an instance doesn't have an external IP it will not be returned when this option is set to false.
|