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

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Manage (add, remove, change) individual interface options in an interfaces-style file without having to manage the file as a whole with, say, M(template) or M(assemble). Interface has to be presented in a file.

Read information about interfaces from interfaces-styled files

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
dest:
    default: /etc/network/interfaces
    description:
    - Path to the interfaces file

mode:
    description:
    - The permissions the resulting filesystem object should have.
    - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
      You must give Ansible enough information to parse them correctly. For consistent
      results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
      a string and can do its own conversion from string into number. Adding a leading
      zero (for example, V(0755)) works sometimes, but can fail in loops and some other
      circumstances.
    - Giving Ansible a number without following either of these rules will end up with
      a decimal number which will have unexpected results.
    - As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx)
      or V(u=rw,g=r,o=r)).
    - If O(mode) is not specified and the destination filesystem object B(does not) exist,
      the default C(umask) on the system will be used when setting the mode for the newly
      created filesystem object.
    - If O(mode) is not specified and the destination filesystem object B(does) exist,
      the mode of the existing filesystem object will be used.
    - Specifying O(mode) is the best way to ensure filesystem objects are created with
      the correct permissions. See CVE-2020-1736 for further details.
    type: raw

group:
    description:
    - Name of the group that should own the filesystem object, as would be fed to I(chown).
    - When left unspecified, it uses the current group of the current user unless you
      are root, in which case it can preserve the previous ownership.
    type: str

iface:
    description:
    - Name of the interface, required for value changes or option remove

owner:
    description:
    - Name of the user that should own the filesystem object, as would be fed to I(chown).
    - When left unspecified, it uses the current user unless you are root, in which case
      it can preserve the previous ownership.
    - Specifying a numeric username will be assumed to be a user ID and not a username.
      Avoid numeric usernames to avoid this confusion.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - If set to C(absent) the option or section will be removed if present instead of
      created.

value:
    description:
    - If I(option) is not presented for the I(interface) and I(state) is C(present) option
      will be added. If I(option) already exists and is not C(pre-up), C(up), C(post-up)
      or C(down), it's value will be updated. C(pre-up), C(up), C(post-up) and C(down)
      options can't be updated, only adding new options, removing existing ones or cleaning
      the whole option set are supported

backup:
    default: 'no'
    description:
    - Create a backup file including the timestamp information so you can get the original
      file back if you somehow clobbered it incorrectly.
    type: bool

option:
    description:
    - Name of the option, required for value changes or option remove

serole:
    description:
    - The role part of the SELinux filesystem object context.
    - When set to V(_default), it will use the C(role) portion of the policy if available.
    type: str

setype:
    description:
    - The type part of the SELinux filesystem object context.
    - When set to V(_default), it will use the C(type) portion of the policy if available.
    type: str

seuser:
    description:
    - The user part of the SELinux filesystem object context.
    - By default it uses the V(system) policy, where applicable.
    - When set to V(_default), it will use the C(user) portion of the policy if available.
    type: str

selevel:
    description:
    - The level part of the SELinux filesystem object context.
    - This is the MLS/MCS attribute, sometimes known as the C(range).
    - When set to V(_default), it will use the C(level) portion of the policy if available.
    type: str

attributes:
    aliases:
    - attr
    description:
    - The attributes the resulting filesystem object should have.
    - To get supported flags look at the man page for I(chattr) on the target system.
    - This string should contain the attributes in the same order as the one displayed
      by I(lsattr).
    - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
      be included in the string.
    type: str
    version_added: '2.3'
    version_added_collection: ansible.builtin

unsafe_writes:
    default: false
    description:
    - Influence when to use atomic operation to prevent data corruption or inconsistent
      reads from the target filesystem object.
    - By default this module uses atomic operations to prevent data corruption or inconsistent
      reads from the target filesystem objects, but sometimes systems are configured or
      just broken in ways that prevent this. One example is docker mounted filesystem
      objects, which cannot be updated atomically from inside the container and can only
      be written in an unsafe manner.
    - This option allows Ansible to fall back to unsafe methods of updating filesystem
      objects when atomic operations fail (however, it doesn't force Ansible to perform
      unsafe writes).
    - IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
    type: bool
    version_added: '2.2'
    version_added_collection: ansible.builtin

address_family:
    description:
    - Address family of the interface, useful if same interface name is used for both
      inet and inet6
    version_added: '2.8'
    version_added_collection: ansible.builtin

Outputs

dest:
  description: destination file/path
  returned: success
  sample: /etc/network/interfaces
  type: str
ifaces:
  contains:
    ifaces:
      contains:
        eth0:
          contains:
            address_family:
              description: interface address family
              returned: success
              sample: inet
              type: str
            down:
              description: list of C(down) scripts
              returned: success
              sample:
              - 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
              type: list
            method:
              description: interface method
              returned: success
              sample: manual
              type: str
            mtu:
              description: other options, all values returned as strings
              returned: success
              sample: '1500'
              type: str
            post-up:
              description: list of C(post-up) scripts
              returned: success
              sample:
              - 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
              type: list
            pre-up:
              description: list of C(pre-up) scripts
              returned: success
              sample:
              - 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
              type: list
            up:
              description: list of C(up) scripts
              returned: success
              sample:
              - 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
              type: list
          description: Name of the interface
          returned: success
          type: dict
      description: interface dictionary
      returned: success
      type: dict
  description: interfaces dictionary
  returned: success
  type: complex