community.general.from_ini filter – Converts INI text input into a dictionary

Note

This filter plugin is part of the community.general collection (version 9.0.1).

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.from_ini.

New in community.general 8.2.0

Synopsis

  • Converts INI text input into a dictionary.

Input

This describes the input of the filter, the value before | community.general.from_ini.

Parameter

Comments

Input

string / required

A string containing an INI document.

Examples

- name: Slurp an INI file
  ansible.builtin.slurp:
    src: /etc/rhsm/rhsm.conf
  register: rhsm_conf

- name: Display the INI file as dictionary
  ansible.builtin.debug:
    var: rhsm_conf.content | b64decode | community.general.from_ini

- name: Set a new dictionary fact with the contents of the INI file
  ansible.builtin.set_fact:
    rhsm_dict: >-
      {{
          rhsm_conf.content | b64decode | community.general.from_ini
      }}

Return Value

Key

Description

Return value

dictionary

A dictionary representing the INI file.

Returned: success

Authors

  • Steffen Scheib (@sscheib)

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.