community.general.gconftool2 module – Edit GNOME Configurations

Note

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

Synopsis

  • This module allows for the manipulation of GNOME 2 Configuration via gconftool-2. Please see the gconftool-2(1) man pages for more details.

Parameters

Parameter

Comments

config_source

string

Specify a configuration source to use rather than the default path.

direct

boolean

Access the config database directly, bypassing server. If direct is specified then the config_source must be specified as well.

Choices:

  • false ← (default)

  • true

key

string / required

A GConf preference key is an element in the GConf repository that corresponds to an application preference.

state

string / required

The action to take upon the key/value.

Choices:

  • "absent"

  • "present"

value

string

Preference keys typically have simple values such as strings, integers, or lists of strings and integers. This is ignored unless state=present.

value_type

string

The type of value being set. This is ignored unless state=present.

Choices:

  • "bool"

  • "float"

  • "int"

  • "string"

Attributes

Attribute

Support

Description

check_mode

Support: full

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

diff_mode

Support: none

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.

Examples

---
- name: Change the widget font to "Serif 12"
  community.general.gconftool2:
    key: "/desktop/gnome/interface/font_name"
    value_type: "string"
    value: "Serif 12"

Return Values

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

Key

Description

key

string

The key specified in the module parameters.

Returned: success

Sample: "/desktop/gnome/interface/font_name"

previous_value

string

The value of the preference key before executing the module.

From community.general 7.0.0 onwards it returns null for a non-existent key, and returned "" before that.

Returned: success

Sample: "Serif 12"

value

string

The value of the preference key after executing the module or null if key is removed.

From community.general 7.0.0 onwards it returns null for a non-existent key, and returned "" before that.

Returned: success

Sample: "Serif 12"

value_type

string

The type of the value that was changed.

Returned: success

Sample: "string"

version

string

added in community.general 10.0.0

Version of gconftool-2.

Returned: always

Sample: "3.2.6"

Authors

  • Kenneth D. Evensen (@kevensen)