ansible / ansible.builtin / v2.9.27 / inventory / foreman foreman inventory source | "added in version" 2.6 of ansible.builtin" Authors: unknownansible.builtin.foreman (v2.9.27) — inventory
pip
Install with pip install ansible==2.9.27
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.
url: default: http://localhost:3000 description: url to foreman env: - name: FOREMAN_SERVER version_added: '2.8' version_added_collection: ansible.builtin user: description: foreman authentication user env: - name: FOREMAN_USER version_added: '2.8' version_added_collection: ansible.builtin required: true 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 plugin: choices: - foreman description: the name of this plugin, it should always be set to 'foreman' for this plugin to recognize it as it's own. required: true password: description: foreman authentication password env: - name: FOREMAN_PASSWORD version_added: '2.8' version_added_collection: ansible.builtin required: true want_facts: default: false description: Toggle, if True the plugin will retrieve host facts from the server type: boolean vars_prefix: default: foreman_ description: prefix to apply to host variables, does not include facts nor params want_params: default: false description: Toggle, if true the inventory will retrieve 'all_parameters' information as host vars 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: foreman_ description: prefix to apply to foreman 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 validate_certs: default: false description: verify SSL certificate if using https 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