community.general.xfconf_info (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 retrieving Xfce 4 configurations with the help of C(xfconf-query).

Usage examples

Scanned by Steampunk Spotter

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

- name: Get list of all available channels
  community.general.xfconf_info: {}
  register: result

Scanned by Steampunk Spotter

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

- name: Get list of all properties in a specific channel
  community.general.xfconf_info:
    channel: xsettings
  register: result

Scanned by Steampunk Spotter

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

- name: Retrieve the DPI value
  community.general.xfconf_info:
    channel: xsettings
    property: /Xft/DPI
  register: result

Scanned by Steampunk Spotter

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

- name: Get workspace names (4)
  community.general.xfconf_info:
    channel: xfwm4
    property: /general/workspace_names
  register: result

Inputs

    
channel:
    description:
    - 'A Xfconf preference channel is a top-level tree key, inside of the Xfconf repository
      that corresponds to the location for which all application properties/keys are stored.

      '
    - If not provided, the module will list all available channels.
    type: str

property:
    description:
    - 'A Xfce preference key is an element in the Xfconf repository that corresponds to
      an application preference.

      '
    - If provided, then O(channel) is required.
    - If not provided and a O(channel) is provided, then the module will list all available
      properties in that O(channel).
    type: str

Outputs

channels:
  description:
  - List of available channels.
  - Returned when the module receives no parameter at all.
  elements: str
  returned: success
  sample:
  - xfce4-desktop
  - displays
  - xsettings
  - xfwm4
  type: list
is_array:
  description:
  - Flag indicating whether the property is an array or not.
  returned: success
  type: bool
properties:
  description:
  - List of available properties for a specific channel.
  - Returned by passing only the O(channel) parameter to the module.
  elements: str
  returned: success
  sample:
  - /Gdk/WindowScalingFactor
  - /Gtk/ButtonImages
  - /Gtk/CursorThemeSize
  - /Gtk/DecorationLayout
  - /Gtk/FontName
  - /Gtk/MenuImages
  - /Gtk/MonospaceFontName
  - /Net/DoubleClickTime
  - /Net/IconThemeName
  - /Net/ThemeName
  - /Xft/Antialias
  - /Xft/Hinting
  - /Xft/HintStyle
  - /Xft/RGBA
  type: list
value:
  description:
  - The value of the property. Empty if the property is of array type.
  returned: success
  sample: Monospace 10
  type: str
value_array:
  description:
  - The array value of the property. Empty if the property is not of array type.
  elements: str
  returned: success
  sample:
  - Main
  - Work
  - Tmp
  type: list