ansible.builtin.xfconf (v2.9.27) — module

Edit XFCE4 Configurations

| "added in version" 2.8 of ansible.builtin"

Authors: Joseph Benden (@jbenden)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module allows for the manipulation of Xfce 4 Configuration via xfconf-query. Please see the xfconf-query(1) man pages for more details.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Change the DPI to "192"
  xfconf:
    channel: "xsettings"
    property: "/Xft/DPI"
    value_type: "int"
    value: "192"
  become: True
  become_user: johnsmith

Inputs

    
state:
    choices:
    - get
    - present
    - absent
    default: present
    description:
    - The action to take upon the property/value.

value:
    description:
    - Preference properties typically have simple values such as strings, integers, or
      lists of strings and integers. This is ignored if the state is "get". See man xfconf-query(1)

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.
      See man xfconf-query(1)
    required: true

property:
    description:
    - A Xfce preference key is an element in the Xfconf repository that corresponds to
      an application preference. See man xfconf-query(1)
    required: true

value_type:
    choices:
    - int
    - bool
    - float
    - string
    description:
    - The type of value being set. This is ignored if the state is "get".

Outputs

channel:
  description: The channel specified in the module parameters
  returned: success
  sample: xsettings
  type: str
property:
  description: The property specified in the module parameters
  returned: success
  sample: /Xft/DPI
  type: str
value:
  description: The value of the preference key after executing the module
  returned: success
  sample: '192'
  type: str
value_type:
  description: The type of the value that was changed
  returned: success
  sample: int
  type: str