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 别名：attr 字符串	生成的 filesystem 对象应具有的属性。 要获取支持的标志，请查看目标系统上的 chattr 的 man 页面。 此字符串应包含与 lsattr 显示顺序相同的属性。 = 运算符被假定为默认值，否则需要在字符串中包含 + 或 - 运算符。
backup 布尔值	创建一个包含时间戳信息的备份文件，以便在您以某种方式错误地损坏它时，可以恢复原始文件。 选项 false ←（默认） true
dest 路径	接口文件的路径。 默认值： "/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 文件系统对象上下文的级别部分。 这是 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	支持： 无	在 diff 模式下，将返回有关已更改内容（或可能需要在 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 list / elements=string	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 list / elements=string	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 list / elements=string	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 list / elements=string	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)

合集链接

• 问题跟踪器
• 存储库（源代码）
• 寻求帮助
• 提交错误报告
• 请求功能
• 交流