community.general.cobbler (1.3.11) — inventory

Install collection

Install with ansible-galaxy collection install community.general:==1.3.11

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.11

Description

Get inventory hosts from the cobbler service.

Uses a configuration file as an inventory source, it must end in C(.cobbler.yml) or C(.cobbler.yaml) and has a C(plugin: cobbler) entry.

Inputs

    
url:
    default: http://cobbler/cobbler_api
    description: URL to cobbler.
    env:
    - name: COBBLER_SERVER

user:
    description: Cobbler authentication user.
    env:
    - name: COBBLER_USER
    required: false

cache:
    default: false
    description:
    - Toggle to enable/disable the caching of the inventory's source data, requires a
      cache plugin setup to work.
    env:
    - name: ANSIBLE_INVENTORY_CACHE
    ini:
    - key: cache
      section: inventory
    type: bool

group:
    default: cobbler
    description: Group to place all hosts into

plugin:
    choices:
    - cobbler
    - community.general.cobbler
    description: The name of this plugin, it should always be set to C(community.general.cobbler)
      for this plugin to recognize it as it's own.
    required: true

group_by:
    default:
    - mgmt_classes
    - owners
    - status
    description: Keys to group hosts by
    type: list

password:
    description: Cobbler authentication password
    env:
    - name: COBBLER_PASSWORD
    required: false

want_facts:
    default: true
    description: Toggle, if C(true) the plugin will retrieve host facts from the server
    type: boolean

cache_plugin:
    default: memory
    description:
    - Cache plugin to use for the inventory's source data.
    env:
    - name: ANSIBLE_CACHE_PLUGIN
    - name: ANSIBLE_INVENTORY_CACHE_PLUGIN
    ini:
    - key: fact_caching
      section: defaults
    - key: cache_plugin
      section: inventory
    type: str

cache_prefix:
    default: ansible_inventory_
    description:
    - Prefix to use for cache plugin files/tables
    env:
    - name: ANSIBLE_CACHE_PLUGIN_PREFIX
    - name: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX
    ini:
    - key: fact_caching_prefix
      section: defaults
    - key: cache_prefix
      section: inventory

group_prefix:
    default: cobbler_
    description: Prefix to apply to cobbler groups

cache_timeout:
    default: 3600
    description:
    - Cache duration in seconds
    env:
    - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
    - name: ANSIBLE_INVENTORY_CACHE_TIMEOUT
    ini:
    - key: fact_caching_timeout
      section: defaults
    - key: cache_timeout
      section: inventory
    type: int

cache_fallback:
    default: false
    description: Fallback to cached results if connection to cobbler fails
    type: boolean

cache_connection:
    description:
    - Cache connection data or path, read cache plugin documentation for specifics.
    env:
    - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
    - name: ANSIBLE_INVENTORY_CACHE_CONNECTION
    ini:
    - key: fact_caching_connection
      section: defaults
    - key: cache_connection
      section: inventory
    type: str

exclude_profiles:
    default: []
    description: Profiles to exclude from inventory
    elements: str
    type: list