community.general.gconftool2_info module – Retrieve GConf configurations

Note

This module is part of the community.general collection (version 10.1.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 community.general.

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

New in community.general 5.1.0

Synopsis

  • This module allows retrieving application preferences from the GConf database, with the help of gconftool-2.

Parameters

Parameter

Comments

key

string / required

The key name for an element in the GConf database.

Attributes

Attribute

Support

Description

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

See Also

See also

C(gconftool-2) command manual page

Manual page for the command.

gconf repository (archived)

Git repository for the project. It is an archived project, so the repository is read-only.

Examples

---
- name: Get value for a certain key in the database.
  community.general.gconftool2_info:
    key: /desktop/gnome/background/picture_filename
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

value

string

The value of the property.

Returned: success

Sample: "Monospace 10"

version

string

added in community.general 10.0.0

Version of gconftool-2.

Returned: always

Sample: "3.2.6"

Authors

  • Alexei Znamensky (@russoz)