summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorBradley A. Thornton <bthornto@thethorntons.net>2019-08-08 13:45:46 -0700
committerBradley A. Thornton <bthornto@thethorntons.net>2019-08-08 13:45:46 -0700
commit00ae0cf5ce60cf6149e67f5c83356a2c1877a35f (patch)
tree9e45073d2cc97e6bd7695a91007a9e53fe8d83e1 /plugins
parent400e7ab77e8f5090860f6131133ef8b700e0d023 (diff)
downloadvyos-ansible-collection-00ae0cf5ce60cf6149e67f5c83356a2c1877a35f.tar.gz
vyos-ansible-collection-00ae0cf5ce60cf6149e67f5c83356a2c1877a35f.zip
switch to devel
Diffstat (limited to 'plugins')
-rw-r--r--plugins/modules/_vyos_interface.py (renamed from plugins/modules/vyos_interface.py)8
-rw-r--r--plugins/modules/_vyos_l3_interface.py (renamed from plugins/modules/vyos_l3_interface.py)6
-rw-r--r--plugins/modules/vyos_command.py2
-rw-r--r--plugins/modules/vyos_config.py2
-rw-r--r--plugins/modules/vyos_facts.py317
-rw-r--r--plugins/modules/vyos_interfaces.py876
-rw-r--r--plugins/modules/vyos_l3_interfaces.py372
-rw-r--r--plugins/modules/vyos_ping.py2
-rw-r--r--plugins/modules/vyos_system.py2
9 files changed, 1339 insertions, 248 deletions
diff --git a/plugins/modules/vyos_interface.py b/plugins/modules/_vyos_interface.py
index e7af0c1..eea8ef9 100644
--- a/plugins/modules/vyos_interface.py
+++ b/plugins/modules/_vyos_interface.py
@@ -20,7 +20,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
- 'status': ['preview'],
+ 'status': ['deprecated'],
'supported_by': 'network'}
@@ -33,6 +33,10 @@ short_description: Manage Interface on VyOS network devices
description:
- This module provides declarative management of Interfaces
on VyOS network devices.
+deprecated:
+ removed_in: '2.13'
+ alternative: vyos_interfaces
+ why: Updated modules released with more functionality.
notes:
- Tested against VYOS 1.1.7
options:
@@ -227,7 +231,7 @@ def map_obj_to_commands(updates):
def map_config_to_obj(module):
- data = get_config(module)
+ data = get_config(module, flags=['| grep interface'])
obj = []
for line in data.split('\n'):
if line.startswith('set interfaces ethernet'):
diff --git a/plugins/modules/vyos_l3_interface.py b/plugins/modules/_vyos_l3_interface.py
index 98fbb4b..8f22d4a 100644
--- a/plugins/modules/vyos_l3_interface.py
+++ b/plugins/modules/_vyos_l3_interface.py
@@ -20,7 +20,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
- 'status': ['preview'],
+ 'status': ['deprecated'],
'supported_by': 'network'}
@@ -33,6 +33,10 @@ short_description: Manage L3 interfaces on VyOS network devices
description:
- This module provides declarative management of L3 interfaces
on VyOS network devices.
+deprecated:
+ removed_in: '2.13'
+ alternative: vyos_l3_interfaces
+ why: Updated modules released with more functionality.
notes:
- Tested against VYOS 1.1.7
options:
diff --git a/plugins/modules/vyos_command.py b/plugins/modules/vyos_command.py
index 16487e3..ac79224 100644
--- a/plugins/modules/vyos_command.py
+++ b/plugins/modules/vyos_command.py
@@ -25,7 +25,7 @@ DOCUMENTATION = """
---
module: vyos_command
version_added: "2.2"
-author: "Nathaniel Case (@qalthos)"
+author: "Nathaniel Case (@Qalthos)"
short_description: Run one or more commands on VyOS devices
description:
- The command module allows running one or more commands on remote
diff --git a/plugins/modules/vyos_config.py b/plugins/modules/vyos_config.py
index 6ed07fc..14aea79 100644
--- a/plugins/modules/vyos_config.py
+++ b/plugins/modules/vyos_config.py
@@ -25,7 +25,7 @@ DOCUMENTATION = """
---
module: vyos_config
version_added: "2.2"
-author: "Nathaniel Case (@qalthos)"
+author: "Nathaniel Case (@Qalthos)"
short_description: Manage VyOS configuration on remote device
description:
- This module provides configuration file management of VyOS
diff --git a/plugins/modules/vyos_facts.py b/plugins/modules/vyos_facts.py
index c480969..e4bf669 100644
--- a/plugins/modules/vyos_facts.py
+++ b/plugins/modules/vyos_facts.py
@@ -1,65 +1,90 @@
#!/usr/bin/python
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-#
+# -*- coding: utf-8 -*-
+# Copyright 2019 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+"""
+The module file for vyos_facts
+"""
+
+
ANSIBLE_METADATA = {'metadata_version': '1.1',
- 'status': ['preview'],
+ 'status': [u'preview'],
'supported_by': 'network'}
DOCUMENTATION = """
---
module: vyos_facts
-version_added: "2.2"
-author: "Nathaniel Case (@qalthos)"
-short_description: Collect facts from remote devices running VyOS
+version_added: 2.2
+short_description: Get facts about vyos devices.
description:
- - Collects a base set of device facts from a remote device that
- is running VyOS. This module prepends all of the
- base network fact keys with U(ansible_net_<fact>). The facts
- module will always collect a base set of facts from the device
- and can enable or disable collection of additional facts.
+ - Collects facts from network devices running the vyos operating
+ system. This module places the facts gathered in the fact tree keyed by the
+ respective resource name. The facts module will always collect a
+ base set of facts from the device and can enable or disable
+ collection of additional facts.
+author:
+ - Nathaniel Case (@qalthos)
+ - Nilashish Chakraborty (@Nilashishc)
extends_documentation_fragment: vyos
notes:
- - Tested against VYOS 1.1.7
+ - Tested against VyOS 1.1.8
options:
gather_subset:
description:
- When supplied, this argument will restrict the facts collected
to a given subset. Possible values for this argument include
- all, default, config, and neighbors. Can specify a list of
- values to include a larger subset. Values can also be used
+ all, default, config, and neighbors. Can specify a list of
+ values to include a larger subset. Values can also be used
with an initial C(M(!)) to specify that a specific subset should
not be collected.
required: false
default: "!config"
+ gather_network_resources:
+ description:
+ - When supplied, this argument will restrict the facts collected
+ to a given subset. Possible values for this argument include
+ all and the resources like interfaces.
+ Can specify a list of values to include a larger subset. Values
+ can also be used with an initial C(M(!)) to specify that a
+ specific subset should not be collected.
+ required: false
+ version_added: "2.9"
+ choices: ['all', 'interfaces', '!interfaces', 'l3_interfaces', '!l3_interfaces']
"""
EXAMPLES = """
-- name: collect all facts from the device
- vyos_facts:
+# Gather all facts
+- vyos_facts:
gather_subset: all
+ gather_network_resources: all
-- name: collect only the config and default facts
- vyos_facts:
+# collect only the config and default facts
+- vyos_facts:
gather_subset: config
-- name: collect everything exception the config
- vyos_facts:
+# collect everything exception the config
+- vyos_facts:
gather_subset: "!config"
+
+# Collect only the interfaces facts
+- vyos_facts:
+ gather_subset:
+ - '!all'
+ - '!min'
+ gather_network_resources:
+ - interfaces
+
+# Do not collect interfaces facts
+- vyos_facts:
+ gather_network_resources:
+ - "!interfaces"
+
+# Collect interfaces and minimal default facts
+- vyos_facts:
+ gather_subset: min
+ gather_network_resources: interfaces
"""
RETURN = """
@@ -103,228 +128,38 @@ ansible_net_python_version:
description: The Python version Ansible controller is using
returned: always
type: str
+ansible_net_gather_network_resources:
+ description: The list of fact resource subsets collected from the device
+ returned: always
+ type: list
"""
-import platform
-import re
-
from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six import iteritems
-from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import run_commands, get_capabilities
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.argspec.facts.facts import FactsArgs
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.facts import Facts
from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import vyos_argument_spec
-class FactsBase(object):
-
- COMMANDS = frozenset()
-
- def __init__(self, module):
- self.module = module
- self.facts = dict()
- self.responses = None
-
- def populate(self):
- self.responses = run_commands(self.module, list(self.COMMANDS))
-
-
-class Default(FactsBase):
-
- COMMANDS = [
- 'show version',
- ]
-
- def populate(self):
- super(Default, self).populate()
- data = self.responses[0]
- self.facts['serialnum'] = self.parse_serialnum(data)
- self.facts.update(self.platform_facts())
-
- def parse_serialnum(self, data):
- match = re.search(r'HW S/N:\s+(\S+)', data)
- if match:
- return match.group(1)
-
- def platform_facts(self):
- platform_facts = {}
-
- resp = get_capabilities(self.module)
- device_info = resp['device_info']
-
- platform_facts['system'] = device_info['network_os']
-
- for item in ('model', 'image', 'version', 'platform', 'hostname'):
- val = device_info.get('network_os_%s' % item)
- if val:
- platform_facts[item] = val
-
- platform_facts['api'] = resp['network_api']
- platform_facts['python_version'] = platform.python_version()
-
- return platform_facts
-
-
-class Config(FactsBase):
-
- COMMANDS = [
- 'show configuration commands',
- 'show system commit',
- ]
-
- def populate(self):
- super(Config, self).populate()
-
- self.facts['config'] = self.responses
-
- commits = self.responses[1]
- entries = list()
- entry = None
-
- for line in commits.split('\n'):
- match = re.match(r'(\d+)\s+(.+)by(.+)via(.+)', line)
- if match:
- if entry:
- entries.append(entry)
-
- entry = dict(revision=match.group(1),
- datetime=match.group(2),
- by=str(match.group(3)).strip(),
- via=str(match.group(4)).strip(),
- comment=None)
- else:
- entry['comment'] = line.strip()
-
- self.facts['commits'] = entries
-
-
-class Neighbors(FactsBase):
-
- COMMANDS = [
- 'show lldp neighbors',
- 'show lldp neighbors detail',
- ]
-
- def populate(self):
- super(Neighbors, self).populate()
-
- all_neighbors = self.responses[0]
- if 'LLDP not configured' not in all_neighbors:
- neighbors = self.parse(
- self.responses[1]
- )
- self.facts['neighbors'] = self.parse_neighbors(neighbors)
-
- def parse(self, data):
- parsed = list()
- values = None
- for line in data.split('\n'):
- if not line:
- continue
- elif line[0] == ' ':
- values += '\n%s' % line
- elif line.startswith('Interface'):
- if values:
- parsed.append(values)
- values = line
- if values:
- parsed.append(values)
- return parsed
-
- def parse_neighbors(self, data):
- facts = dict()
- for item in data:
- interface = self.parse_interface(item)
- host = self.parse_host(item)
- port = self.parse_port(item)
- if interface not in facts:
- facts[interface] = list()
- facts[interface].append(dict(host=host, port=port))
- return facts
-
- def parse_interface(self, data):
- match = re.search(r'^Interface:\s+(\S+),', data)
- return match.group(1)
-
- def parse_host(self, data):
- match = re.search(r'SysName:\s+(.+)$', data, re.M)
- if match:
- return match.group(1)
-
- def parse_port(self, data):
- match = re.search(r'PortDescr:\s+(.+)$', data, re.M)
- if match:
- return match.group(1)
-
-
-FACT_SUBSETS = dict(
- default=Default,
- neighbors=Neighbors,
- config=Config
-)
-
-VALID_SUBSETS = frozenset(FACT_SUBSETS.keys())
-
-
def main():
- argument_spec = dict(
- gather_subset=dict(default=['!config'], type='list')
- )
+ """
+ Main entry point for module execution
+
+ :returns: ansible_facts
+ """
+ argument_spec = FactsArgs.argument_spec
argument_spec.update(vyos_argument_spec)
module = AnsibleModule(argument_spec=argument_spec,
supports_check_mode=True)
- warnings = list()
-
- gather_subset = module.params['gather_subset']
-
- runable_subsets = set()
- exclude_subsets = set()
-
- for subset in gather_subset:
- if subset == 'all':
- runable_subsets.update(VALID_SUBSETS)
- continue
-
- if subset.startswith('!'):
- subset = subset[1:]
- if subset == 'all':
- exclude_subsets.update(VALID_SUBSETS)
- continue
- exclude = True
- else:
- exclude = False
-
- if subset not in VALID_SUBSETS:
- module.fail_json(msg='Subset must be one of [%s], got %s' %
- (', '.join(VALID_SUBSETS), subset))
-
- if exclude:
- exclude_subsets.add(subset)
- else:
- runable_subsets.add(subset)
-
- if not runable_subsets:
- runable_subsets.update(VALID_SUBSETS)
-
- runable_subsets.difference_update(exclude_subsets)
- runable_subsets.add('default')
-
- facts = dict()
- facts['gather_subset'] = list(runable_subsets)
-
- instances = list()
- for key in runable_subsets:
- instances.append(FACT_SUBSETS[key](module))
+ warnings = ['default value for `gather_subset` '
+ 'will be changed to `min` from `!config` v2.11 onwards']
- for inst in instances:
- inst.populate()
- facts.update(inst.facts)
+ result = Facts(module).get_facts()
- ansible_facts = dict()
- for key, value in iteritems(facts):
- key = 'ansible_net_%s' % key
- ansible_facts[key] = value
+ ansible_facts, additional_warnings = result
+ warnings.extend(additional_warnings)
module.exit_json(ansible_facts=ansible_facts, warnings=warnings)
diff --git a/plugins/modules/vyos_interfaces.py b/plugins/modules/vyos_interfaces.py
new file mode 100644
index 0000000..4ed2712
--- /dev/null
+++ b/plugins/modules/vyos_interfaces.py
@@ -0,0 +1,876 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright 2019 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+#############################################
+# WARNING #
+#############################################
+#
+# This file is auto generated by the resource
+# module builder playbook.
+#
+# Do not edit this file manually.
+#
+# Changes to this file will be over written
+# by the resource module builder.
+#
+# Changes should be made in the model used to
+# generate this file or in the resource module
+# builder template.
+#
+#############################################
+
+"""
+The module file for vyos_interfaces
+"""
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+ANSIBLE_METADATA = {
+ 'metadata_version': '1.1',
+ 'status': ['preview'],
+ 'supported_by': 'network'
+}
+
+DOCUMENTATION = """
+---
+module: vyos_interfaces
+version_added: 2.9
+short_description: Manages interface attributes of VyOS network devices.
+description:
+ - This module manages the interface attributes on VyOS network devices.
+ - This module supports managing base attributes of Ethernet, Bonding,
+ VXLAN, Loopback and Virtual Tunnel Interfaces.
+author: Nilashish Chakraborty (@nilashishc)
+options:
+ config:
+ description: The provided interfaces configuration.
+ type: list
+ suboptions:
+ name:
+ description:
+ - Full name of the interface, e.g. eth0, eth1, bond0, vti1, vxlan2.
+ type: str
+ required: True
+ description:
+ description:
+ - Interface description.
+ type: str
+ duplex:
+ description:
+ - Interface duplex mode.
+ - Applicable for Ethernet interfaces only.
+ choices: ['full', 'half', 'auto']
+ type: str
+ enabled:
+ default: True
+ description:
+ - Administrative state of the interface.
+ - Set the value to C(true) to administratively enable
+ the interface or C(false) to disable it.
+ type: bool
+ mtu:
+ description:
+ - MTU for a specific interface. Refer to vendor documentation for valid values.
+ - Applicable for Ethernet, Bonding, VXLAN and Virtual Tunnel interfaces.
+ type: int
+ speed:
+ description:
+ - Interface link speed.
+ - Applicable for Ethernet interfaces only.
+ type: str
+ choices: ['auto', '10', '100', '1000', '2500', '10000']
+ vifs:
+ description:
+ - Virtual sub-interfaces related configuration.
+ - 802.1Q VLAN interfaces are represented as virtual sub-interfaces in VyOS.
+ type: list
+ suboptions:
+ vlan_id:
+ description:
+ - Identifier for the virtual sub-interface.
+ type: int
+ description:
+ description:
+ - Virtual sub-interface description.
+ type: str
+ enabled:
+ description:
+ - Administrative state of the virtual sub-interface.
+ - Set the value to C(true) to administratively enable
+ the interface or C(false) to disable it.
+ type: bool
+ default: True
+ mtu:
+ description:
+ - MTU for the virtual sub-interface.
+ - Refer to vendor documentation for valid values.
+ type: int
+ state:
+ description:
+ - The state the configuration should be left in.
+ type: str
+ choices:
+ - merged
+ - replaced
+ - overridden
+ - deleted
+ default: merged
+"""
+EXAMPLES = """
+# Using merged
+#
+# -------------
+# Before state:
+# -------------
+#
+# vyos@vyos:~$ show configuration commands | grep interfaces
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:ea:0f:b9'
+# set interfaces ethernet eth1 smp-affinity 'auto'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth2 smp-affinity 'auto'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces loopback lo
+
+- name: Merge provided configuration with device configuration
+ vyos_interfaces:
+ config:
+ - name: eth2
+ description: 'Configured by Ansible'
+ enabled: True
+ vifs:
+ - vlan_id: 200
+ description: "VIF 200 - ETH2"
+
+ - name: eth3
+ description: 'Configured by Ansible'
+ mtu: 1500
+
+ - name: bond1
+ description: 'Bond - 1'
+ mtu: 1200
+
+ - name: vti2
+ description: 'VTI - 2'
+ enabled: false
+ state: merged
+#
+#
+# -------------------------
+# Module Execution Result
+# -------------------------
+#
+# "before": [
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "enabled": true,
+# "name": "eth3"
+# },
+# {
+# "enabled": true,
+# "name": "eth2"
+# },
+# {
+# "enabled": true,
+# "name": "eth1"
+# },
+# {
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+# "commands": [
+# "set interfaces ethernet eth2 description 'Configured by Ansible'",
+# "set interfaces ethernet eth2 vif 200",
+# "set interfaces ethernet eth2 vif 200 description 'VIF 200 - ETH2'",
+# "set interfaces ethernet eth3 description 'Configured by Ansible'",
+# "set interfaces ethernet eth3 mtu '1500'",
+# "set interfaces bonding bond1",
+# "set interfaces bonding bond1 description 'Bond - 1'",
+# "set interfaces bonding bond1 mtu '1200'",
+# "set interfaces vti vti2",
+# "set interfaces vti vti2 description 'VTI - 2'",
+# "set interfaces vti vti2 disable"
+# ]
+#
+# "after": [
+# {
+# "description": "Bond - 1",
+# "enabled": true,
+# "mtu": 1200,
+# "name": "bond1"
+# },
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "description": "VTI - 2",
+# "enabled": false,
+# "name": "vti2"
+# },
+# {
+# "description": "Configured by Ansible",
+# "enabled": true,
+# "mtu": 1500,
+# "name": "eth3"
+# },
+# {
+# "description": "Configured by Ansible",
+# "enabled": true,
+# "name": "eth2",
+# "vifs": [
+# {
+# "description": "VIF 200 - ETH2",
+# "enabled": true,
+# "vlan_id": "200"
+# }
+# ]
+# },
+# {
+# "enabled": true,
+# "name": "eth1"
+# },
+# {
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+#
+# -------------
+# After state:
+# -------------
+#
+# vyos@vyos:~$ show configuration commands | grep interfaces
+# set interfaces bonding bond1 description 'Bond - 1'
+# set interfaces bonding bond1 mtu '1200'
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:ea:0f:b9'
+# set interfaces ethernet eth1 smp-affinity 'auto'
+# set interfaces ethernet eth2 description 'Configured by Ansible'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth2 smp-affinity 'auto'
+# set interfaces ethernet eth2 vif 200 description 'VIF 200 - ETH2'
+# set interfaces ethernet eth3 description 'Configured by Ansible'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 mtu '1500'
+# set interfaces loopback lo
+# set interfaces vti vti2 description 'VTI - 2'
+# set interfaces vti vti2 disable
+#
+
+
+# Using replaced
+#
+# -------------
+# Before state:
+# -------------
+#
+# vyos:~$ show configuration commands | grep eth
+# set interfaces bonding bond1 description 'Bond - 1'
+# set interfaces bonding bond1 mtu '1400'
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 description 'Management Interface for the Appliance'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5'
+# set interfaces ethernet eth0 smp_affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 description 'Configured by Ansible Eng Team'
+# set interfaces ethernet eth1 duplex 'full'
+# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65'
+# set interfaces ethernet eth1 smp_affinity 'auto'
+# set interfaces ethernet eth1 speed '100'
+# set interfaces ethernet eth2 description 'Configured by Ansible'
+# set interfaces ethernet eth2 duplex 'full'
+# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79'
+# set interfaces ethernet eth2 mtu '500'
+# set interfaces ethernet eth2 smp_affinity 'auto'
+# set interfaces ethernet eth2 speed '100'
+# set interfaces ethernet eth2 vif 200 description 'Configured by Ansible'
+# set interfaces ethernet eth3 description 'Configured by Ansible'
+# set interfaces ethernet eth3 duplex 'full'
+# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85'
+# set interfaces ethernet eth3 mtu '1500'
+# set interfaces ethernet eth3 smp_affinity 'auto'
+# set interfaces ethernet eth3 speed '100'
+# set interfaces loopback lo
+#
+#
+- name: Replace device configurations of listed interfaces with provided configurations
+ vyos_interfaces:
+ config:
+ - name: eth2
+ description: "Replaced by Ansible"
+
+ - name: eth3
+ description: "Replaced by Ansible"
+
+ - name: eth1
+ description: "Replaced by Ansible"
+ state: replaced
+#
+#
+# -----------------------
+# Module Execution Result
+# -----------------------
+#
+# "before": [
+# {
+# "description": "Bond - 1",
+# "enabled": true,
+# "mtu": 1400,
+# "name": "bond1"
+# },
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "description": "Configured by Ansible",
+# "duplex": "full",
+# "enabled": true,
+# "mtu": 1500,
+# "name": "eth3",
+# "speed": "100"
+# },
+# {
+# "description": "Configured by Ansible",
+# "duplex": "full",
+# "enabled": true,
+# "mtu": 500,
+# "name": "eth2",
+# "speed": "100",
+# "vifs": [
+# {
+# "description": "VIF 200 - ETH2",
+# "enabled": true,
+# "vlan_id": "200"
+# }
+# ]
+# },
+# {
+# "description": "Configured by Ansible Eng Team",
+# "duplex": "full",
+# "enabled": true,
+# "name": "eth1",
+# "speed": "100"
+# },
+# {
+# "description": "Management Interface for the Appliance",
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+# "commands": [
+# "delete interfaces ethernet eth2 speed",
+# "delete interfaces ethernet eth2 duplex",
+# "delete interfaces ethernet eth2 mtu",
+# "delete interfaces ethernet eth2 vif 200 description",
+# "set interfaces ethernet eth2 description 'Replaced by Ansible'",
+# "delete interfaces ethernet eth3 speed",
+# "delete interfaces ethernet eth3 duplex",
+# "delete interfaces ethernet eth3 mtu",
+# "set interfaces ethernet eth3 description 'Replaced by Ansible'",
+# "delete interfaces ethernet eth1 speed",
+# "delete interfaces ethernet eth1 duplex",
+# "set interfaces ethernet eth1 description 'Replaced by Ansible'"
+# ]
+#
+# "after": [
+# {
+# "description": "Bond - 1",
+# "enabled": true,
+# "mtu": 1400,
+# "name": "bond1"
+# },
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "description": "Replaced by Ansible",
+# "enabled": true,
+# "name": "eth3"
+# },
+# {
+# "description": "Replaced by Ansible",
+# "enabled": true,
+# "name": "eth2",
+# "vifs": [
+# {
+# "enabled": true,
+# "vlan_id": "200"
+# }
+# ]
+# },
+# {
+# "description": "Replaced by Ansible",
+# "enabled": true,
+# "name": "eth1"
+# },
+# {
+# "description": "Management Interface for the Appliance",
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+#
+# -------------
+# After state:
+# -------------
+#
+# vyos@vyos:~$ show configuration commands | grep interfaces
+# set interfaces bonding bond1 description 'Bond - 1'
+# set interfaces bonding bond1 mtu '1400'
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 description 'Management Interface for the Appliance'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 description 'Replaced by Ansible'
+# set interfaces ethernet eth1 hw-id '08:00:27:ea:0f:b9'
+# set interfaces ethernet eth1 smp-affinity 'auto'
+# set interfaces ethernet eth2 description 'Replaced by Ansible'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth2 smp-affinity 'auto'
+# set interfaces ethernet eth2 vif 200
+# set interfaces ethernet eth3 description 'Replaced by Ansible'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces loopback lo
+#
+#
+# Using overridden
+#
+#
+# --------------
+# Before state
+# --------------
+#
+# vyos@vyos:~$ show configuration commands | grep interfaces
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 description 'Ethernet Interface - 0'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 mtu '1200'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 description 'Configured by Ansible Eng Team'
+# set interfaces ethernet eth1 hw-id '08:00:27:ea:0f:b9'
+# set interfaces ethernet eth1 mtu '100'
+# set interfaces ethernet eth1 smp-affinity 'auto'
+# set interfaces ethernet eth1 vif 100 description 'VIF 100 - ETH1'
+# set interfaces ethernet eth1 vif 100 disable
+# set interfaces ethernet eth2 description 'Configured by Ansible Team (Admin Down)'
+# set interfaces ethernet eth2 disable
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth2 mtu '600'
+# set interfaces ethernet eth2 smp-affinity 'auto'
+# set interfaces ethernet eth3 description 'Configured by Ansible Network'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces loopback lo
+# set interfaces vti vti1 description 'Virtual Tunnel Interface - 1'
+# set interfaces vti vti1 mtu '68'
+#
+#
+- name: Overrides all device configuration with provided configuration
+ vyos_interfaces:
+ config:
+ - name: eth0
+ description: Outbound Interface For The Appliance
+ speed: auto
+ duplex: auto
+
+ - name: eth2
+ speed: auto
+ duplex: auto
+
+ - name: eth3
+ mtu: 1200
+ state: overridden
+#
+#
+# ------------------------
+# Module Execution Result
+# ------------------------
+#
+# "before": [
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "description": "Virtual Tunnel Interface - 1",
+# "enabled": true,
+# "mtu": 68,
+# "name": "vti1"
+# },
+# {
+# "description": "Configured by Ansible Network",
+# "enabled": true,
+# "name": "eth3"
+# },
+# {
+# "description": "Configured by Ansible Team (Admin Down)",
+# "enabled": false,
+# "mtu": 600,
+# "name": "eth2"
+# },
+# {
+# "description": "Configured by Ansible Eng Team",
+# "enabled": true,
+# "mtu": 100,
+# "name": "eth1",
+# "vifs": [
+# {
+# "description": "VIF 100 - ETH1",
+# "enabled": false,
+# "vlan_id": "100"
+# }
+# ]
+# },
+# {
+# "description": "Ethernet Interface - 0",
+# "duplex": "auto",
+# "enabled": true,
+# "mtu": 1200,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+# "commands": [
+# "delete interfaces vti vti1 description",
+# "delete interfaces vti vti1 mtu",
+# "delete interfaces ethernet eth1 description",
+# "delete interfaces ethernet eth1 mtu",
+# "delete interfaces ethernet eth1 vif 100 description",
+# "delete interfaces ethernet eth1 vif 100 disable",
+# "delete interfaces ethernet eth0 mtu",
+# "set interfaces ethernet eth0 description 'Outbound Interface For The Appliance'",
+# "delete interfaces ethernet eth2 description",
+# "delete interfaces ethernet eth2 mtu",
+# "set interfaces ethernet eth2 duplex 'auto'",
+# "delete interfaces ethernet eth2 disable",
+# "set interfaces ethernet eth2 speed 'auto'",
+# "delete interfaces ethernet eth3 description",
+# "set interfaces ethernet eth3 mtu '1200'"
+# ],
+#
+# "after": [
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "enabled": true,
+# "name": "vti1"
+# },
+# {
+# "enabled": true,
+# "mtu": 1200,
+# "name": "eth3"
+# },
+# {
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth2",
+# "speed": "auto"
+# },
+# {
+# "enabled": true,
+# "name": "eth1",
+# "vifs": [
+# {
+# "enabled": true,
+# "vlan_id": "100"
+# }
+# ]
+# },
+# {
+# "description": "Outbound Interface For The Appliance",
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+#
+# ------------
+# After state
+# ------------
+#
+# vyos@vyos:~$ show configuration commands | grep interfaces
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 description 'Outbound Interface For The Appliance'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:ea:0f:b9'
+# set interfaces ethernet eth1 smp-affinity 'auto'
+# set interfaces ethernet eth1 vif 100
+# set interfaces ethernet eth2 duplex 'auto'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth2 smp-affinity 'auto'
+# set interfaces ethernet eth2 speed 'auto'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 mtu '1200'
+# set interfaces loopback lo
+# set interfaces vti vti1
+#
+#
+# Using deleted
+#
+#
+# -------------
+# Before state
+# -------------
+#
+# vyos@vyos:~$ show configuration commands | grep interfaces
+# set interfaces bonding bond0 mtu '1300'
+# set interfaces bonding bond1 description 'LAG - 1'
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 description 'Outbound Interface for this appliance'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 description 'Configured by Ansible Network'
+# set interfaces ethernet eth1 duplex 'full'
+# set interfaces ethernet eth1 hw-id '08:00:27:ea:0f:b9'
+# set interfaces ethernet eth1 smp-affinity 'auto'
+# set interfaces ethernet eth1 speed '100'
+# set interfaces ethernet eth2 description 'Configured by Ansible'
+# set interfaces ethernet eth2 disable
+# set interfaces ethernet eth2 duplex 'full'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth2 mtu '600'
+# set interfaces ethernet eth2 smp-affinity 'auto'
+# set interfaces ethernet eth2 speed '100'
+# set interfaces ethernet eth3 description 'Configured by Ansible Network'
+# set interfaces ethernet eth3 duplex 'full'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 speed '100'
+# set interfaces loopback lo
+#
+#
+- name: Delete attributes of given interfaces (Note - This won't delete the interfaces themselves)
+ vyos_interfaces:
+ config:
+ - name: bond1
+
+ - name: eth1
+
+ - name: eth2
+
+ - name: eth3
+ state: deleted
+#
+#
+# ------------------------
+# Module Execution Results
+# ------------------------
+#
+# "before": [
+# {
+# "enabled": true,
+# "mtu": 1300,
+# "name": "bond0"
+# },
+# {
+# "description": "LAG - 1",
+# "enabled": true,
+# "name": "bond1"
+# },
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "description": "Configured by Ansible Network",
+# "duplex": "full",
+# "enabled": true,
+# "name": "eth3",
+# "speed": "100"
+# },
+# {
+# "description": "Configured by Ansible",
+# "duplex": "full",
+# "enabled": false,
+# "mtu": 600,
+# "name": "eth2",
+# "speed": "100"
+# },
+# {
+# "description": "Configured by Ansible Network",
+# "duplex": "full",
+# "enabled": true,
+# "name": "eth1",
+# "speed": "100"
+# },
+# {
+# "description": "Outbound Interface for this appliance",
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+# "commands": [
+# "delete interfaces bonding bond1 description",
+# "delete interfaces ethernet eth1 speed",
+# "delete interfaces ethernet eth1 duplex",
+# "delete interfaces ethernet eth1 description",
+# "delete interfaces ethernet eth2 speed",
+# "delete interfaces ethernet eth2 disable",
+# "delete interfaces ethernet eth2 duplex",
+# "delete interfaces ethernet eth2 disable",
+# "delete interfaces ethernet eth2 description",
+# "delete interfaces ethernet eth2 disable",
+# "delete interfaces ethernet eth2 mtu",
+# "delete interfaces ethernet eth2 disable",
+# "delete interfaces ethernet eth3 speed",
+# "delete interfaces ethernet eth3 duplex",
+# "delete interfaces ethernet eth3 description"
+# ]
+#
+# "after": [
+# {
+# "enabled": true,
+# "mtu": 1300,
+# "name": "bond0"
+# },
+# {
+# "enabled": true,
+# "name": "bond1"
+# },
+# {
+# "enabled": true,
+# "name": "lo"
+# },
+# {
+# "enabled": true,
+# "name": "eth3"
+# },
+# {
+# "enabled": true,
+# "name": "eth2"
+# },
+# {
+# "enabled": true,
+# "name": "eth1"
+# },
+# {
+# "description": "Outbound Interface for this appliance",
+# "duplex": "auto",
+# "enabled": true,
+# "name": "eth0",
+# "speed": "auto"
+# }
+# ]
+#
+#
+# ------------
+# After state
+# ------------
+#
+# vyos@vyos:~$ show configuration commands | grep interfaces
+# set interfaces bonding bond0 mtu '1300'
+# set interfaces bonding bond1
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 description 'Outbound Interface for this appliance'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:ea:0f:b9'
+# set interfaces ethernet eth1 smp-affinity 'auto'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth2 smp-affinity 'auto'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces loopback lo
+#
+#
+"""
+RETURN = """
+before:
+ description: The configuration prior to the model invocation.
+ returned: always
+ sample: >
+ The configuration returned will always be in the same format
+ of the parameters above.
+ type: list
+after:
+ description: The resulting configuration model invocation.
+ returned: when changed
+ sample: >
+ The configuration returned will always be in the same format
+ of the parameters above.
+ type: list
+commands:
+ description: The set of commands pushed to the remote device.
+ returned: always
+ type: list
+ sample:
+ - 'set interfaces ethernet eth1 mtu 1200'
+ - 'set interfaces ethernet eth2 vif 100 description VIF 100'
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.argspec.interfaces.interfaces import InterfacesArgs
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.config.interfaces.interfaces import Interfaces
+
+
+def main():
+ """
+ Main entry point for module execution
+
+ :returns: the result form module invocation
+ """
+ module = AnsibleModule(argument_spec=InterfacesArgs.argument_spec,
+ supports_check_mode=True)
+
+ result = Interfaces(module).execute_module()
+ module.exit_json(**result)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/plugins/modules/vyos_l3_interfaces.py b/plugins/modules/vyos_l3_interfaces.py
new file mode 100644
index 0000000..7ef020e
--- /dev/null
+++ b/plugins/modules/vyos_l3_interfaces.py
@@ -0,0 +1,372 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright 2019 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+#############################################
+# WARNING #
+#############################################
+#
+# This file is auto generated by the resource
+# module builder playbook.
+#
+# Do not edit this file manually.
+#
+# Changes to this file will be over written
+# by the resource module builder.
+#
+# Changes should be made in the model used to
+# generate this file or in the resource module
+# builder template.
+#
+#############################################
+
+"""
+The module file for vyos_l3_interfaces
+"""
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+ANSIBLE_METADATA = {
+ 'metadata_version': '1.1',
+ 'status': ['preview'],
+ 'supported_by': 'network'
+}
+
+DOCUMENTATION = """
+---
+module: vyos_l3_interfaces
+version_added: 2.9
+short_description: Manages L3 interface attributes of VyOS network devices.
+description: This module manages the L3 interface attributes on VyOS network devices.
+author: Nilashish Chakraborty (@NilashishC)
+options:
+ config:
+ description: The provided L3 interfaces configuration.
+ type: list
+ elements: dict
+ suboptions:
+ name:
+ description:
+ - Full name of the interface, e.g. eth0, eth1.
+ type: str
+ required: True
+ ipv4:
+ description:
+ - List of IPv4 addresses of the interface.
+ type: list
+ elements: dict
+ suboptions:
+ address:
+ description:
+ - IPv4 address of the interface.
+ type: str
+ ipv6:
+ description:
+ - List of IPv6 addresses of the interface.
+ type: list
+ elements: dict
+ suboptions:
+ address:
+ description:
+ - IPv6 address of the interface.
+ type: str
+ vifs:
+ description:
+ - Virtual sub-interfaces L3 configurations.
+ elements: dict
+ type: list
+ suboptions:
+ vlan_id:
+ description:
+ - Identifier for the virtual sub-interface.
+ type: int
+ ipv4:
+ description:
+ - List of IPv4 addresses of the virtual interface.
+ type: list
+ elements: dict
+ suboptions:
+ address:
+ description:
+ - IPv4 address of the virtual interface.
+ type: str
+ ipv6:
+ description:
+ - List of IPv6 addresses of the virual interface.
+ type: list
+ elements: dict
+ suboptions:
+ address:
+ description:
+ - IPv6 address of the virtual interface.
+ type: str
+ state:
+ description:
+ - The state the configuration should be left in.
+ type: str
+ choices:
+ - merged
+ - replaced
+ - overridden
+ - deleted
+ default: merged
+
+"""
+EXAMPLES = """
+# Using merged
+#
+# Before state:
+# -------------
+#
+# vyos:~$ show configuration commands | grep -e eth[2,3]
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 vif 101
+# set interfaces ethernet eth3 vif 102
+
+- name: Merge provided configuration with device configuration
+ vyos_l3_interfaces:
+ config:
+ - name: eth2
+ ipv4:
+ - address: 192.0.2.10/28
+ - address: 198.51.100.40/27
+ ipv6:
+ - address: 2001:db8:100::2/32
+ - address: 2001:db8:400::10/32
+
+ - name: eth3
+ ipv4:
+ - address: 203.0.113.65/26
+ vifs:
+ - vlan_id: 101
+ ipv4:
+ - address: 192.0.2.71/28
+ - address: 198.51.100.131/25
+ - vlan_id: 102
+ ipv6:
+ - address: 2001:db8:1000::5/38
+ - address: 2001:db8:1400::3/38
+ state: merged
+
+# After state:
+# -------------
+#
+# vyos:~$ show configuration commands | grep -e eth[2,3]
+# set interfaces ethernet eth2 address '192.0.2.10/28'
+# set interfaces ethernet eth2 address '198.51.100.40/27'
+# set interfaces ethernet eth2 address '2001:db8:100::2/32'
+# set interfaces ethernet eth2 address '2001:db8:400::10/32'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth3 address '203.0.113.65/26'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 vif 101 address '192.0.2.71/28'
+# set interfaces ethernet eth3 vif 101 address '198.51.100.131/25'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:1000::5/38'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:1400::3/38'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:4000::2/34'
+
+
+# Using replaced
+#
+# Before state:
+# -------------
+#
+# vyos:~$ show configuration commands | grep eth
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:EA:0F:B9'
+# set interfaces ethernet eth1 address '192.0.2.14/24'
+# set interfaces ethernet eth2 address '192.0.2.10/24'
+# set interfaces ethernet eth2 address '192.0.2.11/24'
+# set interfaces ethernet eth2 address '2001:db8::10/32'
+# set interfaces ethernet eth2 address '2001:db8::11/32'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth3 address '198.51.100.10/24'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 vif 101 address '198.51.100.130/25'
+# set interfaces ethernet eth3 vif 101 address '198.51.100.131/25'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:4000::3/34'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:4000::2/34'
+#
+- name: Replace device configurations of listed interfaces with provided configurations
+ vyos_l3_interfaces:
+ config:
+ - name: eth2
+ ipv4:
+ - address: 192.0.2.10/24
+
+ - name: eth3
+ ipv6:
+ - address: 2001:db8::11/32
+ state: replaced
+
+# After state:
+# -------------
+#
+# vyos:~$ show configuration commands | grep eth
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:EA:0F:B9'
+# set interfaces ethernet eth1 address '192.0.2.14/24'
+# set interfaces ethernet eth2 address '192.0.2.10/24'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 address '2001:db8::11/32'
+# set interfaces ethernet eth3 vif 101
+# set interfaces ethernet eth3 vif 102
+
+
+# Using overridden
+#
+# Before state
+# --------------
+#
+# vyos@vyos-appliance:~$ show configuration commands | grep eth
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:EA:0F:B9'
+# set interfaces ethernet eth1 address '192.0.2.14/24'
+# set interfaces ethernet eth2 address '192.0.2.10/24'
+# set interfaces ethernet eth2 address '192.0.2.11/24'
+# set interfaces ethernet eth2 address '2001:db8::10/32'
+# set interfaces ethernet eth2 address '2001:db8::11/32'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth3 address '198.51.100.10/24'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 vif 101 address '198.51.100.130/25'
+# set interfaces ethernet eth3 vif 101 address '198.51.100.131/25'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:4000::3/34'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:4000::2/34'
+
+- name: Overrides all device configuration with provided configuration
+ vyos_l3_interfaces:
+ config:
+ - name: eth0
+ ipv4:
+ - address: dhcp
+ ipv6:
+ - address: dhcpv6
+ state: overridden
+
+# After state
+# ------------
+#
+# vyos@vyos-appliance:~$ show configuration commands | grep eth
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 address 'dhcpv6'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:EA:0F:B9'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 vif 101
+# set interfaces ethernet eth3 vif 102
+
+
+# Using deleted
+#
+# Before state
+# -------------
+# vyos@vyos-appliance:~$ show configuration commands | grep eth
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:30:f0:22'
+# set interfaces ethernet eth0 smp-affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:EA:0F:B9'
+# set interfaces ethernet eth1 address '192.0.2.14/24'
+# set interfaces ethernet eth2 address '192.0.2.10/24'
+# set interfaces ethernet eth2 address '192.0.2.11/24'
+# set interfaces ethernet eth2 address '2001:db8::10/32'
+# set interfaces ethernet eth2 address '2001:db8::11/32'
+# set interfaces ethernet eth2 hw-id '08:00:27:c2:98:23'
+# set interfaces ethernet eth3 address '198.51.100.10/24'
+# set interfaces ethernet eth3 hw-id '08:00:27:43:70:8c'
+# set interfaces ethernet eth3 vif 101 address '198.51.100.130/25'
+# set interfaces ethernet eth3 vif 101 address '198.51.100.131/25'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:4000::3/34'
+# set interfaces ethernet eth3 vif 102 address '2001:db8:4000::2/34'
+
+- name: Delete L3 attributes of given interfaces (Note - This won't delete the interface itself)
+ vyos_l3_interfaces:
+ config:
+ - name: eth1
+ - name: eth2
+ - name: eth3
+ state: deleted
+
+# After state
+# ------------
+# vyos@vyos-appliance:~$ show configuration commands | grep eth
+# set interfaces ethernet eth0 address 'dhcp'
+# set interfaces ethernet eth0 duplex 'auto'
+# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5'
+# set interfaces ethernet eth0 smp_affinity 'auto'
+# set interfaces ethernet eth0 speed 'auto'
+# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65'
+# set interfaces ethernet eth1 smp_affinity 'auto'
+# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79'
+# set interfaces ethernet eth2 smp_affinity 'auto'
+# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85'
+# set interfaces ethernet eth3 smp_affinity 'auto'
+
+
+"""
+RETURN = """
+before:
+ description: The configuration prior to the model invocation.
+ returned: always
+ type: list
+ sample: >
+ The configuration returned will always be in the same format
+ of the parameters above.
+after:
+ description: The resulting configuration model invocation.
+ returned: when changed
+ type: list
+ sample: >
+ The configuration returned will always be in the same format
+ of the parameters above.
+commands:
+ description: The set of commands pushed to the remote device.
+ returned: always
+ type: list
+ sample: ['set interfaces ethernet eth1 192.0.2.14/2', 'set interfaces ethernet eth3 vif 101 address 198.51.100.130/25']
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.argspec.l3_interfaces.l3_interfaces import L3_interfacesArgs
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.config.l3_interfaces.l3_interfaces import L3_interfaces
+
+
+def main():
+ """
+ Main entry point for module execution
+
+ :returns: the result form module invocation
+ """
+ module = AnsibleModule(argument_spec=L3_interfacesArgs.argument_spec,
+ supports_check_mode=True)
+
+ result = L3_interfaces(module).execute_module()
+ module.exit_json(**result)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/plugins/modules/vyos_ping.py b/plugins/modules/vyos_ping.py
index fe7bd9d..95488ac 100644
--- a/plugins/modules/vyos_ping.py
+++ b/plugins/modules/vyos_ping.py
@@ -37,7 +37,7 @@ description:
- For Windows targets, use the M(win_ping) module instead.
- For targets running Python, use the M(ping) module instead.
author:
- - Nilashish Chakraborty (@nilashishc)
+ - Nilashish Chakraborty (@NilashishC)
version_added: '2.8'
options:
dest:
diff --git a/plugins/modules/vyos_system.py b/plugins/modules/vyos_system.py
index f1f093d..e0684bf 100644
--- a/plugins/modules/vyos_system.py
+++ b/plugins/modules/vyos_system.py
@@ -26,7 +26,7 @@ DOCUMENTATION = """
---
module: "vyos_system"
version_added: "2.3"
-author: "Nathaniel Case (@qalthos)"
+author: "Nathaniel Case (@Qalthos)"
short_description: Run `set system` commands on VyOS devices
description:
- Runs one or more commands on remote devices running VyOS.