community.general.sysrc 模块 – 使用 sysrc 管理 FreeBSD

注意

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

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

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

要在剧本中使用它，请指定： community.general.sysrc。

community.general 2.0.0 中的新增功能

概要

  • 管理 FreeBSD 的 /etc/rc.conf。

参数

参数

注释

delim

字符串

用于代替 " " (空格) 的分隔符。

仅当 state=value_present 或 state=value_absent 时使用。

默认值： " "

jail

字符串

要操作的 jail 的名称或 ID。

name

字符串 / 必需

要管理的 /etc/rc.conf 中的变量名称。

path

字符串

要使用的文件的路径，代替 /etc/rc.conf。

默认值： "/etc/rc.conf"

state

字符串

使用 present 添加变量。

使用 absent 删除变量。

使用 value_present 将值添加到现有变量。

使用 value_absent 从现有变量中删除值。

选项

  • "absent"

  • "present" ← (默认)

  • "value_present"

  • "value_absent"

value

字符串

当 state=present 时要设置的值。

当 state=value_present 时要添加的值。

当 state=value_absent 时要删除的值。

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

备注

注意

  • name 不能包含句点，因为 sysrc 不支持 OID 样式的名称。

示例

---
# enable mysql in the /etc/rc.conf
- name: Configure mysql pid file
  community.general.sysrc:
    name: mysql_pidfile
    value: "/var/run/mysqld/mysqld.pid"

# enable accf_http kld in the boot loader
- name: Enable accf_http kld
  community.general.sysrc:
    name: accf_http_load
    state: present
    value: "YES"
    path: /boot/loader.conf

# add gif0 to cloned_interfaces
- name: Add gif0 interface
  community.general.sysrc:
    name: cloned_interfaces
    state: value_present
    value: "gif0"

# enable nginx on a jail
- name: Enable nginx in test jail
  community.general.sysrc:
    name: nginx_enable
    value: "YES"
    jail: testjail

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

changed

布尔值

返回 sysrc 操作的更改。

返回：始终

示例： true

作者

  • David Lundgren (@dlundgren)