community.general.gconftool2 module – Edit GNOME Configurations

Note

This module is part of the community.general collection (version 4.8.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. See man gconftool-2(1)

direct

boolean

Access the config database directly, bypassing server. If direct is specified then the config_source must be specified as well. See man gconftool-2(1)

Choices:

  • no ← (default)

  • yes

key

string / required

A GConf preference key is an element in the GConf repository that corresponds to an application preference. See man gconftool-2(1)

state

string / required

The action to take upon the key/value.

Choices:

  • absent

  • get

  • present

value

string

Preference keys typically have simple values such as strings, integers, or lists of strings and integers. This is ignored if the state is “get”. See man gconftool-2(1)

value_type

string

The type of value being set. This is ignored if the state is “get”.

Choices:

  • bool

  • float

  • int

  • string

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”

value

string

The value of the preference key after executing the module

Returned: success

Sample: “Serif 12”

value_type

string

The type of the value that was changed

Returned: success

Sample: “string”

Authors

  • Kenneth D. Evensen (@kevensen)