Try SpotterDigitalOcean Inventory Plugin
| "added in version" 1.1.0 of community.digitalocean"
Authors: Janos Gerzson (@grzs), Tadej Borovšak (@tadeboro)
Install with ansible-galaxy collection install community.digitalocean:==1.3.0
collections:
- name: community.digitalocean
version: 1.3.0DigitalOcean (DO) inventory plugin.
Acquires droplet list from DO API.
Uses configuration file that ends with '(do_hosts|digitalocean|digital_ocean).(yaml|yml)'.
cache:
default: false
description:
- Toggle to enable/disable the caching of the inventory's source data, requires a
cache plugin setup to work.
env:
- name: ANSIBLE_INVENTORY_CACHE
ini:
- key: cache
section: inventory
type: bool
groups:
default: {}
description: Add hosts to group based on Jinja2 conditionals.
type: dict
plugin:
choices:
- community.digitalocean.digitalocean
description:
- The name of the DigitalOcean Inventory Plugin, this should always be C(community.digitalocean.digitalocean).
required: true
strict:
default: false
description:
- If V(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.
type: bool
compose:
default: {}
description: Create vars from jinja2 expressions.
type: dict
timeout:
default: 30
description:
- The timeout in seconds used for polling DigitalOcean's API.
type: int
api_token:
aliases:
- oauth_token
description:
- DigitalOcean OAuth token.
env:
- name: DO_API_TOKEN
required: true
type: str
attributes:
default:
- id
- name
- networks
- region
- size_slug
description: Droplet attributes to add as host vars to each inventory host. Check
out the DO API docs for full list of attributes at U(https://developers.digitalocean.com/documentation/v2/#list-all-droplets).
elements: str
type: list
pagination:
default: 200
description:
- Maximum droplet objects per response page.
- If the number of droplets related to the account exceeds this value, the query will
be broken to multiple requests (pages).
- DigitalOcean currently allows a maximum of 200.
type: int
var_prefix:
default: do_
description:
- Prefix of generated varible names (e.g. C(tags) -> C(do_tags))
type: str
oauth_token:
aliases:
- api_token
description:
- DigitalOcean OAuth token.
- There are several other environment variables which can be used to provide this
value.
- i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN'
type: str
cache_plugin:
default: memory
description:
- Cache plugin to use for the inventory's source data.
env:
- name: ANSIBLE_CACHE_PLUGIN
- name: ANSIBLE_INVENTORY_CACHE_PLUGIN
ini:
- key: fact_caching
section: defaults
- key: cache_plugin
section: inventory
type: str
cache_prefix:
default: ansible_inventory_
description:
- Prefix to use for cache plugin files/tables
env:
- name: ANSIBLE_CACHE_PLUGIN_PREFIX
- name: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX
ini:
- key: fact_caching_prefix
section: defaults
- key: cache_prefix
section: inventory
keyed_groups:
default: []
description: Add hosts to group based on the values of a variable.
elements: dict
suboptions:
default_value:
description:
- The default value when the host variable's value is an empty string.
- This option is mutually exclusive with O(keyed_groups[].trailing_separator).
type: str
version_added: '2.12'
version_added_collection: ansible.builtin
key:
description:
- The key from input dictionary used to generate groups
type: str
parent_group:
description: parent group for keyed group
type: str
prefix:
default: ''
description: A keyed group name will start with this prefix
type: str
separator:
default: _
description: separator used to build the keyed group name
type: str
trailing_separator:
default: true
description:
- Set this option to V(False) to omit the O(keyed_groups[].separator) after the
host variable when the value is an empty string.
- This option is mutually exclusive with O(keyed_groups[].default_value).
type: bool
version_added: '2.12'
version_added_collection: ansible.builtin
type: list
cache_timeout:
default: 3600
description:
- Cache duration in seconds
env:
- name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
- name: ANSIBLE_INVENTORY_CACHE_TIMEOUT
ini:
- key: fact_caching_timeout
section: defaults
- key: cache_timeout
section: inventory
type: int
use_extra_vars:
default: false
description: Merge extra vars into the available variables for composition (highest
precedence).
env:
- name: ANSIBLE_INVENTORY_USE_EXTRA_VARS
ini:
- key: use_extra_vars
section: inventory_plugins
type: bool
version_added: '2.11'
version_added_collection: ansible.builtin
validate_certs:
default: true
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(no) used on personally controlled sites using self-signed
certificates.
type: bool
cache_connection:
description:
- Cache connection data or path, read cache plugin documentation for specifics.
env:
- name: ANSIBLE_CACHE_PLUGIN_CONNECTION
- name: ANSIBLE_INVENTORY_CACHE_CONNECTION
ini:
- key: fact_caching_connection
section: defaults
- key: cache_connection
section: inventory
type: str
leading_separator:
default: true
description:
- Use in conjunction with keyed_groups.
- By default, a keyed group that does not have a prefix or a separator provided will
have a name that starts with an underscore.
- This is because the default prefix is "" and the default separator is "_".
- Set this option to False to omit the leading underscore (or other separator) if
no prefix is given.
- If the group name is derived from a mapping the separator is still used to concatenate
the items.
- To not use a separator in the group name at all, set the separator for the keyed
group to an empty string instead.
type: boolean
version_added: '2.11'
version_added_collection: ansible.builtin