ansible.builtin.vyos_l3_interface (v2.4.6.0-1) — module

Manage L3 interfaces on VyOS network devices

| "added in version" 2.4 of ansible.builtin"

Authors: Ricardo Carrillo Cruz (@rcarrillocruz)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

This module provides declarative management of L3 interfaces on VyOS network devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set eth0 IPv4 address
  vyos_l3_interface:
    name: eth0
    ipv4: 192.168.0.1/24
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove eth0 IPv4 address
  vyos_l3_interface:
    name: eth0
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set IP addresses on aggregate
  vyos_l3_interface:
    aggregate:
      - { name: eth1, ipv4: 192.168.2.10/24 }
      - { name: eth2, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove IP addresses on aggregate
  vyos_l3_interface:
    aggregate:
      - { name: eth1, ipv4: 192.168.2.10/24 }
      - { name: eth2, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
    state: absent

Inputs

    
ipv4:
    description:
    - IPv4 of the L3 interface.

ipv6:
    description:
    - IPv6 of the L3 interface.

name:
    description:
    - Name of the L3 interface.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the L3 interface configuration.

aggregate:
    description: List of L3 interfaces definitions

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always, except for the platforms that use Netconf transport to manage
    the device.
  sample:
  - set interfaces ethernet eth0 address '192.168.0.1/24'
  type: list