theforeman.foreman.foreman inventory – Foreman inventory source

Note

This inventory plugin is part of the theforeman.foreman collection (version 3.4.0).

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 theforeman.foreman.

To use it in a playbook, specify: theforeman.foreman.foreman.

Synopsis

  • Get inventory hosts from Foreman.

  • Uses a YAML configuration file that ends with foreman.(yml|yaml).

Requirements

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

  • requests >= 1.1

Parameters

Parameter

Comments

batch_size

integer

Number of hosts per batch that will be retrieved from the Foreman API per individual call

Default: 250

cache

boolean

Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work.

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [inventory]
    cache = no
    
  • Environment variable: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Cache connection data or path, read cache plugin documentation for specifics.

Configuration:

  • INI entries:

    [defaults]
    fact_caching_connection = None
    
    [inventory]
    cache_connection = None
    
  • Environment variable: ANSIBLE_CACHE_PLUGIN_CONNECTION

  • Environment variable: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Cache plugin to use for the inventory’s source data.

Default: “memory”

Configuration:

  • INI entries:

    [defaults]
    fact_caching = memory
    
    [inventory]
    cache_plugin = memory
    
  • Environment variable: ANSIBLE_CACHE_PLUGIN

  • Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Prefix to use for cache plugin files/tables

Default: “ansible_inventory_”

Configuration:

  • INI entries:

    [default]
    fact_caching_prefix = ansible_inventory_
    

    Removed in: version 2.16 of ansible.builtin

    Why: Fixes typing error in INI section name

    Alternative: Use the ‘defaults’ section instead

    [defaults]
    fact_caching_prefix = ansible_inventory_
    
    [inventory]
    cache_prefix = ansible_inventory_
    
  • Environment variable: ANSIBLE_CACHE_PLUGIN_PREFIX

  • Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Cache duration in seconds

Default: 3600

Configuration:

  • INI entries:

    [defaults]
    fact_caching_timeout = 3600
    
    [inventory]
    cache_timeout = 3600
    
  • Environment variable: ANSIBLE_CACHE_PLUGIN_TIMEOUT

  • Environment variable: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

dictionary

Create vars from jinja2 expressions.

Default: {}

foreman

string

Foreman server related configuration, deprecated.

You can pass use_reports_api in this dict to enable the Reporting API.

Only for backward compatibility.

group_prefix

string

prefix to apply to foreman groups

Default: “foreman_”

groups

dictionary

Add hosts to group based on Jinja2 conditionals.

Default: {}

host_filters

string

This can be used to restrict the list of returned host

hostnames

list / elements=string

A list of templates in order of precedence to compose inventory_hostname.

If the template results in an empty string or None value it is ignored.

Default: [“name”]

keyed_groups

list / elements=dictionary

Add hosts to group based on the values of a variable.

Default: []

default_value

string

added in 2.12 of ansible.builtin

The default value when the host variable’s value is an empty string.

This option is mutually exclusive with trailing_separator.

key

string

The key from input dictionary used to generate groups

parent_group

string

parent group for keyed group

prefix

string

A keyed group name will start with this prefix

Default: “”

separator

string

separator used to build the keyed group name

Default: “_”

trailing_separator

boolean

added in 2.12 of ansible.builtin

Set this option to False to omit the separator after the host variable when the value is an empty string.

This option is mutually exclusive with default_value.

Choices:

  • no

  • yes ← (default)

leading_separator

boolean

added in 2.11 of ansible.builtin

Use in conjunction with keyed_groups.

By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.

This is because the default prefix is “” and the default separator is “_”.

Set this option to False to omit the leading underscore (or other separator) if no prefix is given.

If the group name is derived from a mapping the separator is still used to concatenate the items.

To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.

Choices:

  • no

  • yes ← (default)

legacy_hostvars

boolean

Toggle, if true the plugin will build legacy hostvars present in the foreman script

Places hostvars in a dictionary with keys foreman, foreman_facts, and foreman_params

Choices:

  • no ← (default)

  • yes

max_timeout

integer

Timeout before falling back to old host API when using report_data endpoint while polling.

Default: 600

password

string / required

Password of the user accessing the Foreman server.

Configuration:

  • Environment variable: FOREMAN_PASSWORD

plugin

string / required

token that ensures this is a source file for the foreman plugin.

Choices:

  • theforeman.foreman.foreman

poll_interval

integer

The polling interval between 2 calls to the report_data endpoint while polling.

Default: 10

report

dictionary

Report API specific configuration, deprecated.

You can pass the Report API specific params as part of this dict, instead of the main configuration.

Only for backward compatibility.

strict

boolean

If yes make invalid entries a fatal error, otherwise skip and continue.

Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.

Choices:

  • no ← (default)

  • yes

url

string

URL of the Foreman server.

Default: “http://localhost:3000”

Configuration:

  • Environment variable: FOREMAN_SERVER

  • Environment variable: FOREMAN_SERVER_URL

  • Environment variable: FOREMAN_URL

use_extra_vars

boolean

added in 2.11 of ansible.builtin

Merge extra vars into the available variables for composition (highest precedence).

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [inventory_plugins]
    use_extra_vars = no
    
  • Environment variable: ANSIBLE_INVENTORY_USE_EXTRA_VARS

use_reports_api

boolean

Use Reporting API.

Choices:

  • no

  • yes ← (default)

user

string / required

Username accessing the Foreman server.

Configuration:

  • Environment variable: FOREMAN_USER

  • Environment variable: FOREMAN_USERNAME

validate_certs

boolean

Whether or not to verify the TLS certificates of the Foreman server.

Choices:

  • no

  • yes ← (default)

Configuration:

  • Environment variable: FOREMAN_VALIDATE_CERTS

vars_prefix

string

prefix to apply to host variables, does not include facts nor params

Default: “foreman_”

want_content_facet_attributes

boolean

Toggle, if true the inventory will fetch content view details that the host is tied to.

Choices:

  • no

  • yes ← (default)

want_facts

boolean

Toggle, if True the plugin will retrieve host facts from the server

Choices:

  • no ← (default)

  • yes

want_host_group

boolean

Toggle, if true the inventory will fetch host_groups and create groupings for the same.

Choices:

  • no

  • yes ← (default)

want_hostcollections

boolean

Toggle, if true the plugin will create Ansible groups for host collections

Choices:

  • no ← (default)

  • yes

want_ipv4

boolean

Toggle, if true the inventory will fetch ipv4 address of the host.

Choices:

  • no

  • yes ← (default)

want_ipv6

boolean

Toggle, if true the inventory will fetch ipv6 address of the host.

Choices:

  • no

  • yes ← (default)

want_location

boolean

Toggle, if true the inventory will fetch location the host belongs to and create groupings for the same.

Choices:

  • no

  • yes ← (default)

want_organization

boolean

Toggle, if true the inventory will fetch organization the host belongs to and create groupings for the same.

Choices:

  • no

  • yes ← (default)

want_params

boolean

Toggle, if true the inventory will retrieve ‘all_parameters’ information as host vars

Choices:

  • no ← (default)

  • yes

want_smart_proxies

boolean

Toggle, if true the inventory will fetch smart proxy that the host is registered to.

Choices:

  • no

  • yes ← (default)

want_subnet

boolean

Toggle, if true the inventory will fetch subnet.

Choices:

  • no

  • yes ← (default)

want_subnet_v6

boolean

Toggle, if true the inventory will fetch ipv6 subnet.

Choices:

  • no

  • yes ← (default)

Examples

# my.foreman.yml
plugin: theforeman.foreman.foreman
url: https://foreman.example.com
user: ansibleinventory
password: changeme
host_filters: 'organization="Web Engineering"'

# shortname.foreman.yml
plugin: theforeman.foreman.foreman
url: https://foreman.example.com
user: ansibleinventory
password: changeme
hostnames:
  - name.split('.')[0]

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.