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

Note

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

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

Comments

groups

list / elements=string

List of groups.

Choices:

  • "location"

  • "offer"

  • "rpn"

hostnames

list / elements=string

List of preference about what to use as an hostname.

Choices:

  • "public_ipv4" ← (default)

  • "private_ipv4"

  • "hostname"

Default: ["public_ipv4"]

oauth_token

string / required

Online OAuth token.

Configuration:

plugin

string / required

token that ensures this is a source file for the ‘online’ plugin.

Choices:

  • "online"

  • "community.general.online"

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 (@remyleone)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.