community.general.gconftool2 module – Edit GNOME Configurations
Note
This module is part of the community.general collection (version 8.6.4).
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.
Aliases: system.gconftool2
Parameters
Parameter |
Comments |
---|---|
Specify a configuration source to use rather than the default path. See man gconftool-2(1). |
|
Access the config database directly, bypassing server. If Choices:
|
|
A GConf preference key is an element in the GConf repository that corresponds to an application preference. See man gconftool-2(1). |
|
The action to take upon the key/value. Choices:
|
|
Preference keys typically have simple values such as strings, integers, or lists of strings and integers. This is ignored unless |
|
The type of value being set. This is ignored unless Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
The key specified in the module parameters. Returned: success Sample: |
|
The value of the preference key before executing the module. From community.general 7.0.0 onwards it returns Returned: success Sample: |
|
The value of the preference key after executing the module or From community.general 7.0.0 onwards it returns Returned: success Sample: |
|
The type of the value that was changed. Returned: success Sample: |