Documentation

foreman - foreman inventory source

New in version 2.6.

Synopsis

  • Get inventory hosts from the foreman service.

Parameters

Parameter Choices/Defaults Configuration Comments
cache
boolean
Default:
no
ini entries:

[inventory ]
cache = no

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
ini entries:

[inventory ]
cache_connection = VALUE

env:ANSIBLE_INVENTORY_CACHE_CONNECTION
Cache connection data or path, read cache plugin documentation for specifics.
cache_plugin
ini entries:

[inventory ]
cache_plugin = VALUE

env:ANSIBLE_INVENTORY_CACHE_PLUGIN
Cache plugin to use for the inventory's source data.
cache_timeout
integer
Default:
3600
ini entries:

[inventory ]
cache_timeout = 3600

env:ANSIBLE_INVENTORY_CACHE_TIMEOUT
Cache duration in seconds
group_prefix Default:
foreman_
prefix to apply to foreman groups
password
forman authentication password
url Default:
http://localhost:300
url to foreman
user
foreman authentication user
validate_certs
boolean
Default:
no
verify SSL certificate if using https
vars_prefix Default:
foreman_
prefix to apply to host variables, does not include facts nor params
want_facts
boolean
Default:
no
Toggle, if True the plugin will retrieve host facts from the server
want_params
boolean
Default:
no
Toggle, if true the inventory will retrieve 'all_parameters' information as host vars

Status

Author

  • UNKNOWN

Hint

If you notice any issues in this documentation you can edit this document to improve it.