W3cubDocs

/Ansible 2.10

community.general.online – Online inventory source

Note

This plugin is part of the community.general collection.

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 Online

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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/online_inventory.html