community.general.xfconf_info module – Retrieve XFCE4 configurations
Note
This module is part of the community.general collection (version 8.6.8).
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 community.general 3.5.0
Synopsis
This module allows retrieving Xfce 4 configurations with the help of
xfconf-query
.
Aliases: system.xfconf_info
Parameters
Parameter |
Comments |
---|---|
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. |
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full added in community.general 3.3.0 This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 |
Description |
---|---|
List of available channels. Returned when the module receives no parameter at all. Returned: success Sample: |
|
Flag indicating whether the property is an array or not. Returned: success |
|
List of available properties for a specific channel. Returned by passing only the Returned: success Sample: |
|
The value of the property. Empty if the property is of array type. Returned: success Sample: |
|
The array value of the property. Empty if the property is not of array type. Returned: success Sample: |