community.general.gconftool2 (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
key:
    description:
    - A GConf preference key is an element in the GConf repository that corresponds to
      an application preference. See man gconftool-2(1).
    required: true
    type: str

state:
    choices:
    - absent
    - present
    description:
    - The action to take upon the key/value.
    required: true
    type: str

value:
    description:
    - Preference keys typically have simple values such as strings, integers, or lists
      of strings and integers. This is ignored unless O(state=present). See man gconftool-2(1).
    type: str

direct:
    default: false
    description:
    - Access the config database directly, bypassing server.  If O(direct) is specified
      then the O(config_source) must be specified as well. See man gconftool-2(1).
    type: bool

value_type:
    choices:
    - bool
    - float
    - int
    - string
    description:
    - The type of value being set. This is ignored unless O(state=present). See man gconftool-2(1).
    type: str

config_source:
    description:
    - Specify a configuration source to use rather than the default path. See man gconftool-2(1).
    type: str

Outputs

key:
  description: The key specified in the module parameters.
  returned: success
  sample: /desktop/gnome/interface/font_name
  type: str
previous_value:
  description:
  - The value of the preference key before executing the module.
  - From community.general 7.0.0 onwards it returns V(null) for a non-existent O(key),
    and returned V("") before that.
  returned: success
  sample: Serif 12
  type: str
value:
  description:
  - The value of the preference key after executing the module or V(null) if key is
    removed.
  - From community.general 7.0.0 onwards it returns V(null) for a non-existent O(key),
    and returned V("") before that.
  returned: success
  sample: Serif 12
  type: str
value_type:
  description: The type of the value that was changed.
  returned: success
  sample: string
  type: str