Docs4dev
Docs
ansible / latest / collections / community / general / online_inventory.html

community.general.online – Scaleway (previously Online SAS or Online.net) inventory source

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.online.

Synopsis

  • Get inventory hosts from Scaleway (previously Online SAS or Online.net).

Parameters

Parameter Choices/Defaults Configuration Comments
groups
list / elements=string
    Choices:
  • location
  • offer
  • rpn
List of groups.
hostnames
list / elements=string
    Choices:
  • public_ipv4 ←
  • private_ipv4
  • hostname
Default:
["public_ipv4"]
List of preference about what to use as an hostname.
oauth_token
string / required
env:ONLINE_TOKEN
env:ONLINE_API_KEY
env:ONLINE_OAUTH_TOKEN
Online OAuth token.
plugin
string / required
    Choices:
  • online
  • community.general.online
token that ensures this is a source file for the 'online' plugin.

Examples

# online_inventory.yml file in YAML format
# Example command line: ansible-inventory --list -i online_inventory.yml

plugin: community.general.online
hostnames:
  - public_ipv4
groups:
  - location
  - offer
  - rpn

Authors

  • Remy Leone (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/online_inventory.html