foreman – foreman inventory source

From Get docs
< Inventory PluginsAnsible/docs/2.7/plugins/inventory/foreman


foreman – foreman inventory source

New in version 2.6.


Synopsis

  • Get inventory hosts from the foreman service.
  • Uses a configuration file as an inventory source, it must end in .foreman.yml or .foreman.yaml and has a plugin: foreman entry.

Requirements

The below requirements are needed on the local master node that executes this inventory.

  • requests >= 1.1

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

- / required

foreman authentication password

plugin

- / required

  • foreman

the name of this plugin, it should alwys be set to 'foreman' for this plugin to recognize it as it's own.

url

-

Default:

url to foreman

user

- / required

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



Examples

# my.foreman.yml
plugin: foreman
url: http://localhost:2222
user: ansible-tester
password: secure
validate_certs: False

Status

Authors

  • UNKNOWN

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/plugins/inventory/foreman.html