community.general.xfconf 模块 – 编辑 XFCE4 配置

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.xfconf。

概要 

此模块允许借助 xfconf-query 操作 Xfce 4 配置。

参数 

参数	注释
channel 字符串 / 必需	Xfconf 首选项通道是 Xfconf 存储库中的顶级树键，对应于存储所有应用程序属性/键的位置。请参阅 man xfconf-query(1)。
force_array 别名：array 布尔值在 community.general 1.0.0 中添加	即使只有一个元素也强制使用数组。选项 `false` ← (默认) `true`
property 字符串 / 必需	Xfce 首选项键是 Xfconf 存储库中对应于应用程序首选项的元素。请参阅 man xfconf-query(1)。
state 字符串	对属性/值执行的操作。状态 `get` 已在 community.general 5.0.0 中删除。请改用模块 community.general.xfconf_info。选项 `"present"` ← (默认) `"absent"`
value 列表 / elements=any	首选项属性通常具有简单的值，例如字符串、整数或字符串和整数的列表。请参阅 man xfconf-query(1)。
value_type 列表 / elements=字符串	正在设置的值的类型。当提供多个 `value_type` 时，列表的长度必须等于 `value` 的长度。如果只提供一个 `value_type`，但 `value` 包含多个元素，则 `value_type` 将应用于 `value` 的所有元素。如果要设置的 `property` 是一个数组，并且该数组可能只有一个元素，那么必须使用 `force_array=true` 以确保 `xfconf-query` 将该值解释为数组而不是标量。 community.general 4.8.0 中添加了对 `uchar`、`char`、`uint64` 和 `int64` 的支持。选项 `"string"` `"int"` `"double"` `"bool"` `"uint"` `"uchar"` `"char"` `"uint64"` `"int64"` `"float"`

属性 

属性	支持	描述
check_mode	支持：完全	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。
diff_mode	支持：完全	在差异模式下，将返回已更改的内容的详细信息（或者在 `check_mode` 中可能需要更改的内容）。

另请参阅 

另请参阅

xfconf-query(1) 手册页: XFCE 文档站点上 xfconf-query 工具的手册页。
xfconf - 配置存储系统: Xfconf 配置系统的 XFCE 文档。

示例 

---
- name: Change the DPI to "192"
  xfconf:
    channel: "xsettings"
    property: "/Xft/DPI"
    value_type: "int"
    value: "192"

- name: Set workspace names (4)
  xfconf:
    channel: xfwm4
    property: /general/workspace_names
    value_type: string
    value: ['Main', 'Work1', 'Work2', 'Tmp']

- name: Set workspace names (1)
  xfconf:
    channel: xfwm4
    property: /general/workspace_names
    value_type: string
    value: ['Main']
    force_array: true

返回值 

通用返回值记录在此处，以下是此模块独有的字段

Key	描述
channel 字符串	模块参数中指定的通道返回: 成功示例: `"xsettings"`
cmd 列表 / elements=字符串在 community.general 5.4.0 中添加	一个列表，包含模块执行的最终 `xfconf-query` 命令。返回: 成功示例: `["/usr/bin/xfconf-query", "--channel", "xfce4-panel", "--property", "/plugins/plugin-19/timezone", "--create", "--type", "string", "--set", "Pacific/Auckland"]`
previous_value any	执行模块之前首选项键的值。对于数组类型，可以是单个字符串值或字符串列表。这是一个字符串或字符串列表。返回: 成功示例: `"\"96\" or [\"red\", \"blue\", \"green\"]"`
property 字符串	模块参数中指定的属性返回: 成功示例: `"/Xft/DPI"`
value any	执行模块后首选项键的值。对于数组类型，可以是单个字符串值或字符串列表。这是一个字符串或字符串列表。返回: 成功示例: `"\"192\" or [\"orange\", \"yellow\", \"violet\"]"`
value_type any	已更改的值的类型（对于 `state=reset`，为 `none`）。对于数组类型，可以是单个字符串值或字符串列表。这是一个字符串或字符串列表。返回: 成功示例: `"\"int\" or [\"str\", \"str\", \"str\"]"`

作者

Joseph Benden (@jbenden)
Alexei Znamensky (@russoz)