community.general.cobbler inventory – Cobbler inventory source

Note

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

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 community.general.

To use it in a playbook, specify: community.general.cobbler.

New in community.general 1.0.0

Synopsis

  • Get inventory hosts from the cobbler service.

  • Uses a configuration file as an inventory source, it must end in .cobbler.yml or .cobbler.yaml and have a plugin: cobbler entry.

  • Adds the primary IP addresses to cobbler_ipv4_address and cobbler_ipv6_address host variables if defined in Cobbler. The primary IP address is defined as the management interface if defined, or the interface who’s DNS name matches the hostname of the system, or else the first interface found.

Parameters

Parameter

Comments

cache

boolean

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

Choices:

  • false ← (default)

  • true

Configuration:

cache_connection

string

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

Configuration:

cache_fallback

boolean

Fallback to cached results if connection to cobbler fails.

Choices:

  • false ← (default)

  • true

cache_plugin

string

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

Default: "memory"

Configuration:

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:

exclude_mgmt_classes

list / elements=string

added in community.general 7.4.0

Management classes to exclude from inventory.

Default: []

exclude_profiles

list / elements=string

Profiles to exclude from inventory.

Ignored if include_profiles is specified.

Default: []

group

string

Group to place all hosts into.

Default: "cobbler"

group_by

list / elements=string

Keys to group hosts by.

Default: ["mgmt_classes", "owners", "status"]

group_prefix

string

Prefix to apply to cobbler groups.

Default: "cobbler_"

include_mgmt_classes

list / elements=string

added in community.general 7.4.0

Management classes to include from inventory.

Default: []

include_profiles

list / elements=string

added in community.general 4.4.0

Profiles to include from inventory.

If specified, all other profiles will be excluded.

exclude_profiles is ignored if include_profiles is specified.

Default: []

inventory_hostname

string

added in community.general 7.1.0

What to use for the ansible inventory hostname.

By default the networking hostname is used if defined, otherwise the DNS name of the management or first non-static interface.

If set to system, the cobbler system name is used.

Choices:

  • "hostname" ← (default)

  • "system"

password

string

Cobbler authentication password.

Configuration:

plugin

string / required

The name of this plugin, it should always be set to community.general.cobbler for this plugin to recognize it as it’s own.

Choices:

  • "cobbler"

  • "community.general.cobbler"

url

string

URL to cobbler.

Default: "http://cobbler/cobbler_api"

Configuration:

user

string

Cobbler authentication user.

Configuration:

want_facts

boolean

Toggle, if true the plugin will retrieve host facts from the server.

Choices:

  • false

  • true ← (default)

want_ip_addresses

boolean

added in community.general 7.1.0

Toggle, if true the plugin will add a cobbler_ipv4_addresses and cobbleer_ipv6_addresses dictionary to the defined group mapping interface DNS names to IP addresses.

Choices:

  • false

  • true ← (default)

Examples

# my.cobbler.yml
plugin: community.general.cobbler
url: http://cobbler/cobbler_api
user: ansible-tester
password: secure

Authors

  • Orion Poplawski (@opoplawski)

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.