W3cubDocs

/Ansible

community.general.xfconf_info – Retrieve XFCE4 configurations

Note

This plugin is part of the community.general collection (version 3.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.xfconf_info.

New in version 3.5.0: of community.general

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module allows retrieving Xfce 4 configurations with the help of xfconf-query.

Parameters

Parameter	Choices/Defaults	Comments
channel string		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.
property string		A Xfce preference key is an element in the Xfconf repository that corresponds to an application preference. If provided, then channel is required. If not provided and a channel is provided, then the module will list all available properties in that channel.

Notes

Note

See man xfconf-query(1) for more details.

Examples

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

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

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

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

Return Values

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

Key	Returned	Description
channels list / elements=string	success	List of available channels. Returned when the module receives no parameter at all. Sample: ['xfce4-desktop', 'displays', 'xsettings', 'xfwm4']
is_array boolean	success	Flag indicating whether the property is an array or not.
properties list / elements=string	success	List of available properties for a specific channel. Returned by passed only the channel parameter to the module. 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']
value string	success	The value of the property. Empty if the property is of array type. Sample: Monospace 10
value_array list / elements=string	success	The array value of the property. Empty if the property is not of array type. Sample: ['Main', 'Work', 'Tmp']

Authors

Alexei Znamensky (@russoz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/xfconf_info_module.html