community.general.interfaces_file 模块 – 微调 /etc/network/interfaces 文件中的设置

注意

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

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

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

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

概要

• 管理（添加、删除、更改）interfaces 风格文件中的单个接口选项，无需使用例如 ansible.builtin.template 或 ansible.builtin.assemble 来整体管理文件。接口必须存在于文件中。

• 从 interfaces 风格的文件中读取有关接口的信息。

参数

参数	注释
address_family 字符串	接口的地址族，如果同一接口名称同时用于 inet 和 inet6，则此参数很有用。
attributes aliases: attr 字符串	生成的 filesystem 对象应具有的属性。 要获得支持的标志，请查看目标系统上 *chattr* 的手册页。 此字符串应包含与 *lsattr* 显示的顺序相同的属性。 默认情况下假定使用 = 运算符，否则需要在字符串中包含 + 或 - 运算符。
backup 布尔值	创建一个包含时间戳信息的备份文件，以便在您意外覆盖文件时可以恢复原始文件。 选项 false ← (默认) true
dest 路径	interfaces 文件的路径。 默认值： "/etc/network/interfaces"
group 字符串	应拥有 filesystem 对象的组的名称，如同传递给 *chown* 一样。 如果未指定，则使用当前用户的当前组，除非您是 root 用户，在这种情况下，它可以保留之前的拥有者。
iface 字符串	接口名称，更改值或删除选项时需要。
mode 任意	生成的 filesystem 对象应具有的权限。 对于习惯使用 * /usr/bin/chmod* 的用户，请记住模式实际上是八进制数。您必须向 Ansible 提供足够的信息才能正确解析它们。为了获得一致的结果，请引用八进制数（例如，'644' 或 '1777'），以便 Ansible 接收一个字符串并可以自行将字符串转换为数字。添加前导零（例如，0755）有时有效，但在循环和其他一些情况下可能会失败。 如果不遵循上述任何规则而向 Ansible 提供数字，则最终会得到一个十进制数，这将产生意想不到的结果。 从 Ansible 1.8 开始，模式可以指定为符号模式（例如，u+rwx 或 u=rw,g=r,o=r）。 如果未指定 mode 且目标 filesystem 对象不存在，则在为新创建的 filesystem 对象设置模式时，将使用系统上的默认 umask。 如果未指定 mode 且目标 filesystem 对象存在，则将使用现有 filesystem 对象的模式。 指定 mode 是确保以正确的权限创建 filesystem 对象的最佳方法。有关更多详细信息，请参阅 CVE-2020-1736。
option 字符串	选项名称，更改值或删除选项时需要。
owner 字符串	应拥有 filesystem 对象的用户名称，如同传递给 *chown* 一样。 如果未指定，则使用当前用户，除非您是 root 用户，在这种情况下，它可以保留之前的拥有者。 指定数字用户名将被视为用户 ID 而不是用户名。避免使用数字用户名以避免此混淆。
selevel 字符串	SELinux filesystem 对象上下文的级别部分。 这是 MLS/MCS 属性，有时称为 range。 设置为_default时，如果可用，它将使用策略中的level部分。
serole 字符串	SELinux 文件系统对象上下文的角色部分。 设置为_default时，如果可用，它将使用策略中的role部分。
setype 字符串	SELinux 文件系统对象上下文类型部分。 设置为_default时，如果可用，它将使用策略中的type部分。
seuser 字符串	SELinux 文件系统对象上下文的用户部分。 默认情况下，它使用system策略（如果适用）。 设置为_default时，如果可用，它将使用策略中的user部分。
state 字符串	如果设置为absent，则如果存在，将删除选项或部分，而不是创建。 选项 "present" ← (默认) "absent"
unsafe_writes 布尔值	影响何时使用原子操作来防止目标文件系统对象的数据损坏或不一致读取。 默认情况下，此模块使用原子操作来防止目标文件系统对象的数据损坏或不一致读取，但有时系统配置错误或损坏，无法实现此功能。例如，docker 挂载的文件系统对象，无法从容器内部以原子方式更新，只能以非安全方式写入。 此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全写入）。 重要！不安全写入容易出现竞争条件，并可能导致数据损坏。 选项 false ← (默认) true
value 字符串	如果对于iface未提供option，并且state为present，则将添加选项。如果option已存在且不为pre-up、up、post-up或down，则将更新其值。pre-up、up、post-up和down选项无法更新，仅支持添加新选项、删除现有选项或清除整个选项集。

属性

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

备注

注意

• 如果选项多次定义，则将更新最后一个选项，但在 absent 状态下，所有选项都将被删除。

示例

- name: Set eth1 mtu configuration value to 8000
  community.general.interfaces_file:
    dest: /etc/network/interfaces.d/eth1.cfg
    iface: eth1
    option: mtu
    value: 8000
    backup: true
    state: present
  register: eth1_cfg

返回值

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

键	描述
dest 字符串	目标文件/路径。 返回值：成功 示例："/etc/network/interfaces"
ifaces 字典	接口字典。 返回值：成功
ifaces 字典	接口字典。 返回值：成功
eth0 字典	接口名称。 返回值：成功
address_family 字符串	接口地址族。 返回值：成功 示例："inet"
down 列表 / 元素=字符串	down脚本列表。 返回值：成功 示例：["route del -net 10.10.10.0/24 gw 10.10.10.1 dev eth1", "route del -net 10.10.11.0/24 gw 10.10.11.1 dev eth2"]
method 字符串	接口方法。 返回值：成功 示例："manual"
mtu 字符串	其他选项，所有值都作为字符串返回。 返回值：成功 示例："1500"
post-up 列表 / 元素=字符串	post-up脚本列表。 返回值：成功 示例：["route add -net 10.10.10.0/24 gw 10.10.10.1 dev eth1", "route add -net 10.10.11.0/24 gw 10.10.11.1 dev eth2"]
pre-up 列表 / 元素=字符串	pre-up脚本列表。 返回值：成功 示例：["route add -net 10.10.10.0/24 gw 10.10.10.1 dev eth1", "route add -net 10.10.11.0/24 gw 10.10.11.1 dev eth2"]
up 列表 / 元素=字符串	up脚本列表。 返回值：成功 示例：["route add -net 10.10.10.0/24 gw 10.10.10.1 dev eth1", "route add -net 10.10.11.0/24 gw 10.10.11.1 dev eth2"]

作者

• Roman Belyakovsky (@hryamzik)

资源链接

• 问题追踪
• 代码仓库
• 寻求帮助
• 提交错误报告
• 请求功能
• 通信