diff --git a/plugins/modules/vyos_interface.py b/plugins/modules/_vyos_interface.py similarity index 98% rename from plugins/modules/vyos_interface.py rename to plugins/modules/_vyos_interface.py index e7af0c1..eea8ef9 100644 --- a/plugins/modules/vyos_interface.py +++ b/plugins/modules/_vyos_interface.py @@ -1,438 +1,442 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # (c) 2017, Ansible by Red Hat, inc # # This file is part of Ansible by Red Hat # # 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 . # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'network'} DOCUMENTATION = """ --- module: vyos_interface version_added: "2.4" author: "Ganesh Nalawade (@ganeshrn)" 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: name: description: - Name of the Interface. required: true description: description: - Description of Interface. enabled: description: - Interface link status. type: bool speed: description: - Interface link speed. mtu: description: - Maximum size of transmit packet. duplex: description: - Interface link status. default: auto choices: ['full', 'half', 'auto'] delay: description: - Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down) and I(neighbors). default: 10 neighbors: description: - Check the operational state of given interface C(name) for LLDP neighbor. - The following suboptions are available. suboptions: host: description: - "LLDP neighbor host for given interface C(name)." port: description: - "LLDP neighbor port to which given interface C(name) is connected." version_added: 2.5 aggregate: description: List of Interfaces definitions. state: description: - State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down) default: present choices: ['present', 'absent', 'up', 'down'] extends_documentation_fragment: vyos """ EXAMPLES = """ - name: configure interface vyos_interface: name: eth0 description: test-interface - name: remove interface vyos_interface: name: eth0 state: absent - name: make interface down vyos_interface: name: eth0 enabled: False - name: make interface up vyos_interface: name: eth0 enabled: True - name: Configure interface speed, mtu, duplex vyos_interface: name: eth5 state: present speed: 100 mtu: 256 duplex: full - name: Set interface using aggregate vyos_interface: aggregate: - { name: eth1, description: test-interface-1, speed: 100, duplex: half, mtu: 512} - { name: eth2, description: test-interface-2, speed: 1000, duplex: full, mtu: 256} - name: Disable interface on aggregate net_interface: aggregate: - name: eth1 - name: eth2 enabled: False - name: Delete interface using aggregate net_interface: aggregate: - name: eth1 - name: eth2 state: absent - name: Check lldp neighbors intent arguments vyos_interface: name: eth0 neighbors: - port: eth0 host: netdev - name: Config + intent vyos_interface: name: eth1 enabled: False state: down """ RETURN = """ 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. type: list sample: - set interfaces ethernet eth0 description "test-interface" - set interfaces ethernet eth0 speed 100 - set interfaces ethernet eth0 mtu 256 - set interfaces ethernet eth0 duplex full """ import re from copy import deepcopy from time import sleep from ansible.module_utils._text import to_text from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.connection import exec_command from ansible.module_utils.network.common.utils import conditional, remove_default_spec from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import load_config, get_config from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import vyos_argument_spec def search_obj_in_list(name, lst): for o in lst: if o['name'] == name: return o return None def map_obj_to_commands(updates): commands = list() want, have = updates params = ('speed', 'description', 'duplex', 'mtu') for w in want: name = w['name'] disable = w['disable'] state = w['state'] obj_in_have = search_obj_in_list(name, have) set_interface = 'set interfaces ethernet ' + name delete_interface = 'delete interfaces ethernet ' + name if state == 'absent' and obj_in_have: commands.append(delete_interface) elif state in ('present', 'up', 'down'): if obj_in_have: for item in params: value = w.get(item) if value and value != obj_in_have.get(item): if item == 'description': value = "\'" + str(value) + "\'" commands.append(set_interface + ' ' + item + ' ' + str(value)) if disable and not obj_in_have.get('disable', False): commands.append(set_interface + ' disable') elif not disable and obj_in_have.get('disable', False): commands.append(delete_interface + ' disable') else: commands.append(set_interface) for item in params: value = w.get(item) if value: if item == 'description': value = "\'" + str(value) + "\'" commands.append(set_interface + ' ' + item + ' ' + str(value)) if disable: commands.append(set_interface + ' disable') return commands 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'): match = re.search(r'set interfaces ethernet (\S+)', line, re.M) name = match.group(1) if name: interface = {} for item in obj: if item['name'] == name: interface = item break if not interface: interface = {'name': name} obj.append(interface) match = re.search(r'%s (\S+)' % name, line, re.M) if match: param = match.group(1) if param == 'description': match = re.search(r'description (.+)', line, re.M) description = match.group(1).strip("'") interface['description'] = description elif param == 'speed': match = re.search(r'speed (\S+)', line, re.M) speed = match.group(1).strip("'") interface['speed'] = speed elif param == 'mtu': match = re.search(r'mtu (\S+)', line, re.M) mtu = match.group(1).strip("'") interface['mtu'] = int(mtu) elif param == 'duplex': match = re.search(r'duplex (\S+)', line, re.M) duplex = match.group(1).strip("'") interface['duplex'] = duplex elif param.strip("'") == 'disable': interface['disable'] = True return obj def map_params_to_obj(module): obj = [] aggregate = module.params.get('aggregate') if aggregate: for item in aggregate: for key in item: if item.get(key) is None: item[key] = module.params[key] d = item.copy() if d['enabled']: d['disable'] = False else: d['disable'] = True obj.append(d) else: params = { 'name': module.params['name'], 'description': module.params['description'], 'speed': module.params['speed'], 'mtu': module.params['mtu'], 'duplex': module.params['duplex'], 'delay': module.params['delay'], 'state': module.params['state'], 'neighbors': module.params['neighbors'] } if module.params['enabled']: params.update({'disable': False}) else: params.update({'disable': True}) obj.append(params) return obj def check_declarative_intent_params(module, want, result): failed_conditions = [] have_neighbors = None for w in want: want_state = w.get('state') want_neighbors = w.get('neighbors') if want_state not in ('up', 'down') and not want_neighbors: continue if result['changed']: sleep(w['delay']) command = 'show interfaces ethernet %s' % w['name'] rc, out, err = exec_command(module, command) if rc != 0: module.fail_json(msg=to_text(err, errors='surrogate_then_replace'), command=command, rc=rc) if want_state in ('up', 'down'): match = re.search(r'%s (\w+)' % 'state', out, re.M) have_state = None if match: have_state = match.group(1) if have_state is None or not conditional(want_state, have_state.strip().lower()): failed_conditions.append('state ' + 'eq(%s)' % want_state) if want_neighbors: have_host = [] have_port = [] if have_neighbors is None: rc, have_neighbors, err = exec_command(module, 'show lldp neighbors detail') if rc != 0: module.fail_json(msg=to_text(err, errors='surrogate_then_replace'), command=command, rc=rc) if have_neighbors: lines = have_neighbors.strip().split('Interface: ') for line in lines: field = line.split('\n') if field[0].split(',')[0].strip() == w['name']: for item in field: if item.strip().startswith('SysName:'): have_host.append(item.split(':')[1].strip()) if item.strip().startswith('PortDescr:'): have_port.append(item.split(':')[1].strip()) for item in want_neighbors: host = item.get('host') port = item.get('port') if host and host not in have_host: failed_conditions.append('host ' + host) if port and port not in have_port: failed_conditions.append('port ' + port) return failed_conditions def main(): """ main entry point for module execution """ neighbors_spec = dict( host=dict(), port=dict() ) element_spec = dict( name=dict(), description=dict(), speed=dict(), mtu=dict(type='int'), duplex=dict(choices=['full', 'half', 'auto']), enabled=dict(default=True, type='bool'), neighbors=dict(type='list', elements='dict', options=neighbors_spec), delay=dict(default=10, type='int'), state=dict(default='present', choices=['present', 'absent', 'up', 'down']) ) aggregate_spec = deepcopy(element_spec) aggregate_spec['name'] = dict(required=True) # remove default in aggregate spec, to handle common arguments remove_default_spec(aggregate_spec) argument_spec = dict( aggregate=dict(type='list', elements='dict', options=aggregate_spec), ) argument_spec.update(element_spec) argument_spec.update(vyos_argument_spec) required_one_of = [['name', 'aggregate']] mutually_exclusive = [['name', 'aggregate']] required_together = [['speed', 'duplex']] module = AnsibleModule(argument_spec=argument_spec, required_one_of=required_one_of, mutually_exclusive=mutually_exclusive, required_together=required_together, supports_check_mode=True) warnings = list() result = {'changed': False} if warnings: result['warnings'] = warnings want = map_params_to_obj(module) have = map_config_to_obj(module) commands = map_obj_to_commands((want, have)) result['commands'] = commands if commands: commit = not module.check_mode diff = load_config(module, commands, commit=commit) if diff: if module._diff: result['diff'] = {'prepared': diff} result['changed'] = True failed_conditions = check_declarative_intent_params(module, want, result) if failed_conditions: msg = 'One or more conditional statements have not been satisfied' module.fail_json(msg=msg, failed_conditions=failed_conditions) module.exit_json(**result) if __name__ == '__main__': main() diff --git a/plugins/modules/vyos_l3_interface.py b/plugins/modules/_vyos_l3_interface.py similarity index 98% rename from plugins/modules/vyos_l3_interface.py rename to plugins/modules/_vyos_l3_interface.py index 98fbb4b..8f22d4a 100644 --- a/plugins/modules/vyos_l3_interface.py +++ b/plugins/modules/_vyos_l3_interface.py @@ -1,285 +1,289 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # (c) 2017, Ansible by Red Hat, inc # # This file is part of Ansible by Red Hat # # 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 . # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'network'} DOCUMENTATION = """ --- module: vyos_l3_interface version_added: "2.4" author: "Ricardo Carrillo Cruz (@rcarrillocruz)" 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: name: description: - Name of the L3 interface. ipv4: description: - IPv4 of the L3 interface. ipv6: description: - IPv6 of the L3 interface. aggregate: description: List of L3 interfaces definitions state: description: - State of the L3 interface configuration. default: present choices: ['present', 'absent'] extends_documentation_fragment: vyos """ EXAMPLES = """ - name: Set eth0 IPv4 address vyos_l3_interface: name: eth0 ipv4: 192.168.0.1/24 - name: Remove eth0 IPv4 address vyos_l3_interface: name: eth0 state: absent - 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" } - 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 """ RETURN = """ 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. type: list sample: - set interfaces ethernet eth0 address '192.168.0.1/24' """ import socket import re from copy import deepcopy from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.network.common.utils import is_masklen, validate_ip_address from ansible.module_utils.network.common.utils import remove_default_spec from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import load_config, run_commands from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import vyos_argument_spec def is_ipv4(value): if value: address = value.split('/') if is_masklen(address[1]) and validate_ip_address(address[0]): return True return False def is_ipv6(value): if value: address = value.split('/') if 0 <= int(address[1]) <= 128: try: socket.inet_pton(socket.AF_INET6, address[0]) except socket.error: return False return True return False def search_obj_in_list(name, lst): for o in lst: if o['name'] == name: return o return None def map_obj_to_commands(updates, module): commands = list() want, have = updates for w in want: name = w['name'] ipv4 = w['ipv4'] ipv6 = w['ipv6'] state = w['state'] obj_in_have = search_obj_in_list(name, have) if state == 'absent' and obj_in_have: if not ipv4 and not ipv6 and (obj_in_have['ipv4'] or obj_in_have['ipv6']): if name == "lo": commands.append('delete interfaces loopback lo address') else: commands.append('delete interfaces ethernet ' + name + ' address') else: if ipv4 and ipv4 in obj_in_have['ipv4']: if name == "lo": commands.append('delete interfaces loopback lo address ' + ipv4) else: commands.append('delete interfaces ethernet ' + name + ' address ' + ipv4) if ipv6 and ipv6 in obj_in_have['ipv6']: if name == "lo": commands.append('delete interfaces loopback lo address ' + ipv6) else: commands.append('delete interfaces ethernet ' + name + ' address ' + ipv6) elif (state == 'present' and obj_in_have): if ipv4 and ipv4 not in obj_in_have['ipv4']: if name == "lo": commands.append('set interfaces loopback lo address ' + ipv4) else: commands.append('set interfaces ethernet ' + name + ' address ' + ipv4) if ipv6 and ipv6 not in obj_in_have['ipv6']: if name == "lo": commands.append('set interfaces loopback lo address ' + ipv6) else: commands.append('set interfaces ethernet ' + name + ' address ' + ipv6) return commands def map_config_to_obj(module): obj = [] output = run_commands(module, ['show interfaces']) lines = re.split(r'\n[e|l]', output[0])[1:] if len(lines) > 0: for line in lines: splitted_line = line.split() if len(splitted_line) > 0: ipv4 = [] ipv6 = [] if splitted_line[0].lower().startswith('th'): name = 'e' + splitted_line[0].lower() elif splitted_line[0].lower().startswith('o'): name = 'l' + splitted_line[0].lower() for i in splitted_line[1:]: if (('.' in i or ':' in i) and '/' in i): value = i.split(r'\n')[0] if is_ipv4(value): ipv4.append(value) elif is_ipv6(value): ipv6.append(value) obj.append({'name': name, 'ipv4': ipv4, 'ipv6': ipv6}) return obj def map_params_to_obj(module): obj = [] aggregate = module.params.get('aggregate') if aggregate: for item in aggregate: for key in item: if item.get(key) is None: item[key] = module.params[key] obj.append(item.copy()) else: obj.append({ 'name': module.params['name'], 'ipv4': module.params['ipv4'], 'ipv6': module.params['ipv6'], 'state': module.params['state'] }) return obj def main(): """ main entry point for module execution """ element_spec = dict( name=dict(), ipv4=dict(), ipv6=dict(), state=dict(default='present', choices=['present', 'absent']) ) aggregate_spec = deepcopy(element_spec) aggregate_spec['name'] = dict(required=True) # remove default in aggregate spec, to handle common arguments remove_default_spec(aggregate_spec) argument_spec = dict( aggregate=dict(type='list', elements='dict', options=aggregate_spec), ) argument_spec.update(element_spec) argument_spec.update(vyos_argument_spec) required_one_of = [['name', 'aggregate']] mutually_exclusive = [['name', 'aggregate']] module = AnsibleModule(argument_spec=argument_spec, required_one_of=required_one_of, mutually_exclusive=mutually_exclusive, supports_check_mode=True) warnings = list() result = {'changed': False} if warnings: result['warnings'] = warnings want = map_params_to_obj(module) have = map_config_to_obj(module) commands = map_obj_to_commands((want, have), module) result['commands'] = commands if commands: commit = not module.check_mode load_config(module, commands, commit=commit) result['changed'] = True module.exit_json(**result) if __name__ == '__main__': main() 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 @@ -1,222 +1,222 @@ #!/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 . # ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'network'} 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 devices running VyOS. This module can also be introspected to validate key parameters before returning successfully. If the conditional statements are not met in the wait period, the task fails. - Certain C(show) commands in VyOS produce many lines of output and use a custom pager that can cause this module to hang. If the value of the environment variable C(ANSIBLE_VYOS_TERMINAL_LENGTH) is not set, the default number of 10000 is used. extends_documentation_fragment: vyos options: commands: description: - The ordered set of commands to execute on the remote device running VyOS. The output from the command execution is returned to the playbook. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of retries has been exceeded. required: true wait_for: description: - Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured I(retries), the task fails. See examples. aliases: ['waitfor'] match: description: - The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy. Valid values are C(all) or C(any). If the value is set to C(all) then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. default: all choices: ['any', 'all'] retries: description: - Specifies the number of retries a command should be tried before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditionals. default: 10 interval: description: - Configures the interval in seconds to wait between I(retries) of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. default: 1 notes: - Tested against VYOS 1.1.7 - Running C(show system boot-messages all) will cause the module to hang since VyOS is using a custom pager setting to display the output of that command. - If a command sent to the device requires answering a prompt, it is possible to pass a dict containing I(command), I(answer) and I(prompt). See examples. """ EXAMPLES = """ tasks: - name: show configuration on ethernet devices eth0 and eth1 vyos_command: commands: - show interfaces ethernet {{ item }} with_items: - eth0 - eth1 - name: run multiple commands and check if version output contains specific version string vyos_command: commands: - show version - show hardware cpu wait_for: - "result[0] contains 'VyOS 1.1.7'" - name: run command that requires answering a prompt vyos_command: commands: - command: 'rollback 1' prompt: 'Proceed with reboot? [confirm][y]' answer: y """ RETURN = """ stdout: description: The set of responses from the commands returned: always apart from low level errors (such as action plugin) type: list sample: ['...', '...'] stdout_lines: description: The value of stdout split into a list returned: always type: list sample: [['...', '...'], ['...'], ['...']] failed_conditions: description: The list of conditionals that have failed returned: failed type: list sample: ['...', '...'] warnings: description: The list of warnings (if any) generated by module based on arguments returned: always type: list sample: ['...', '...'] """ import time from ansible.module_utils._text import to_text from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.network.common.parsing import Conditional from ansible.module_utils.network.common.utils import transform_commands, to_lines from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import run_commands from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import vyos_argument_spec def parse_commands(module, warnings): commands = transform_commands(module) if module.check_mode: for item in list(commands): if not item['command'].startswith('show'): warnings.append( 'Only show commands are supported when using check mode, not ' 'executing %s' % item['command'] ) commands.remove(item) return commands def main(): spec = dict( commands=dict(type='list', required=True), wait_for=dict(type='list', aliases=['waitfor']), match=dict(default='all', choices=['all', 'any']), retries=dict(default=10, type='int'), interval=dict(default=1, type='int') ) spec.update(vyos_argument_spec) module = AnsibleModule(argument_spec=spec, supports_check_mode=True) warnings = list() result = {'changed': False, 'warnings': warnings} commands = parse_commands(module, warnings) wait_for = module.params['wait_for'] or list() try: conditionals = [Conditional(c) for c in wait_for] except AttributeError as exc: module.fail_json(msg=to_text(exc)) retries = module.params['retries'] interval = module.params['interval'] match = module.params['match'] for _ in range(retries): responses = run_commands(module, commands) for item in list(conditionals): if item(responses): if match == 'any': conditionals = list() break conditionals.remove(item) if not conditionals: break time.sleep(interval) if conditionals: failed_conditions = [item.raw for item in conditionals] msg = 'One or more conditional statements have not been satisfied' module.fail_json(msg=msg, failed_conditions=failed_conditions) result.update({ 'stdout': responses, 'stdout_lines': list(to_lines(responses)), }) module.exit_json(**result) if __name__ == '__main__': main() 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 @@ -1,344 +1,344 @@ #!/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 . # ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'network'} 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 devices. It provides arguments for managing both the configuration file and state of the active configuration. All configuration statements are based on `set` and `delete` commands in the device configuration. extends_documentation_fragment: vyos notes: - Tested against VYOS 1.1.7 - Abbreviated commands are NOT idempotent, see L(Network FAQ,../network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands). options: lines: description: - The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device. src: description: - The C(src) argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables. match: description: - The C(match) argument controls the method used to match against the current active configuration. By default, the desired config is matched against the active config and the deltas are loaded. If the C(match) argument is set to C(none) the active configuration is ignored and the configuration is always loaded. default: line choices: ['line', 'none'] backup: description: - The C(backup) argument will backup the current devices active configuration to the Ansible control host prior to making any changes. If the C(backup_options) value is not given, the backup file will be located in the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created. type: bool default: 'no' comment: description: - Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored. default: 'configured by vyos_config' config: description: - The C(config) argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device. save: description: - The C(save) argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to True, the active configuration is saved. type: bool default: 'no' backup_options: description: - This is a dict object containing configurable options related to backup file path. The value of this option is read only when C(backup) is set to I(yes), if C(backup) is set to I(no) this option will be silently ignored. suboptions: filename: description: - The filename to be used to store the backup configuration. If the the filename is not given it will be generated based on the hostname, current time and date in format defined by _config.@ dir_path: description: - This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of C(filename) or default filename as described in C(filename) options description. If the path value is not given in that case a I(backup) directory will be created in the current working directory and backup configuration will be copied in C(filename) within I(backup) directory. type: path type: dict version_added: "2.8" """ EXAMPLES = """ - name: configure the remote device vyos_config: lines: - set system host-name {{ inventory_hostname }} - set service lldp - delete service dhcp-server - name: backup and load from file vyos_config: src: vyos.cfg backup: yes - name: render a Jinja2 template onto the VyOS router vyos_config: src: vyos_template.j2 - name: for idempotency, use full-form commands vyos_config: lines: # - set int eth eth2 description 'OUTSIDE' - set interface ethernet eth2 description 'OUTSIDE' - name: configurable backup path vyos_config: backup: yes backup_options: filename: backup.cfg dir_path: /home/user """ RETURN = """ commands: description: The list of configuration commands sent to the device returned: always type: list sample: ['...', '...'] filtered: description: The list of configuration commands removed to avoid a load failure returned: always type: list sample: ['...', '...'] backup_path: description: The full path to the backup file returned: when backup is yes type: str sample: /playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34 filename: description: The name of the backup file returned: when backup is yes and filename is not specified in backup options type: str sample: vyos_config.2016-07-16@22:28:34 shortname: description: The full path to the backup file excluding the timestamp returned: when backup is yes and filename is not specified in backup options type: str sample: /playbooks/ansible/backup/vyos_config date: description: The date extracted from the backup file name returned: when backup is yes type: str sample: "2016-07-16" time: description: The time extracted from the backup file name returned: when backup is yes type: str sample: "22:28:34" """ import re from ansible.module_utils._text import to_text from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.connection import ConnectionError from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import load_config, get_config, run_commands from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import vyos_argument_spec, get_connection DEFAULT_COMMENT = 'configured by vyos_config' CONFIG_FILTERS = [ re.compile(r'set system login user \S+ authentication encrypted-password') ] def get_candidate(module): contents = module.params['src'] or module.params['lines'] if module.params['src']: contents = format_commands(contents.splitlines()) contents = '\n'.join(contents) return contents def format_commands(commands): return [line for line in commands if len(line.strip()) > 0] def diff_config(commands, config): config = [str(c).replace("'", '') for c in config.splitlines()] updates = list() visited = set() for line in commands: item = str(line).replace("'", '') if not item.startswith('set') and not item.startswith('delete'): raise ValueError('line must start with either `set` or `delete`') elif item.startswith('set') and item not in config: updates.append(line) elif item.startswith('delete'): if not config: updates.append(line) else: item = re.sub(r'delete', 'set', item) for entry in config: if entry.startswith(item) and line not in visited: updates.append(line) visited.add(line) return list(updates) def sanitize_config(config, result): result['filtered'] = list() index_to_filter = list() for regex in CONFIG_FILTERS: for index, line in enumerate(list(config)): if regex.search(line): result['filtered'].append(line) index_to_filter.append(index) # Delete all filtered configs for filter_index in sorted(index_to_filter, reverse=True): del config[filter_index] def run(module, result): # get the current active config from the node or passed in via # the config param config = module.params['config'] or get_config(module) # create the candidate config object from the arguments candidate = get_candidate(module) # create loadable config that includes only the configuration updates connection = get_connection(module) try: response = connection.get_diff(candidate=candidate, running=config, diff_match=module.params['match']) except ConnectionError as exc: module.fail_json(msg=to_text(exc, errors='surrogate_then_replace')) commands = response.get('config_diff') sanitize_config(commands, result) result['commands'] = commands commit = not module.check_mode comment = module.params['comment'] diff = None if commands: diff = load_config(module, commands, commit=commit, comment=comment) if result.get('filtered'): result['warnings'].append('Some configuration commands were ' 'removed, please see the filtered key') result['changed'] = True if module._diff: result['diff'] = {'prepared': diff} def main(): backup_spec = dict( filename=dict(), dir_path=dict(type='path') ) argument_spec = dict( src=dict(type='path'), lines=dict(type='list'), match=dict(default='line', choices=['line', 'none']), comment=dict(default=DEFAULT_COMMENT), config=dict(), backup=dict(type='bool', default=False), backup_options=dict(type='dict', options=backup_spec), save=dict(type='bool', default=False), ) argument_spec.update(vyos_argument_spec) mutually_exclusive = [('lines', 'src')] module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=mutually_exclusive, supports_check_mode=True ) warnings = list() result = dict(changed=False, warnings=warnings) if module.params['backup']: result['__backup__'] = get_config(module=module) if any((module.params['src'], module.params['lines'])): run(module, result) if module.params['save']: diff = run_commands(module, commands=['configure', 'compare saved'])[1] if diff != '[edit]': run_commands(module, commands=['save']) result['changed'] = True run_commands(module, commands=['exit']) module.exit_json(**result) if __name__ == '__main__': main() 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,333 +1,168 @@ #!/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 . -# +# -*- 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_). 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 = """ ansible_net_config: description: The running-config from the device returned: when config is configured type: str ansible_net_commits: description: The set of available configuration revisions returned: when present type: list ansible_net_hostname: description: The configured system hostname returned: always type: str ansible_net_model: description: The device model string returned: always type: str ansible_net_serialnum: description: The serial number of the device returned: always type: str ansible_net_version: description: The version of the software running returned: always type: str ansible_net_neighbors: description: The set of LLDP neighbors returned: when interface is configured type: list ansible_net_gather_subset: description: The list of subsets gathered by the module returned: always type: list ansible_net_api: description: The name of the transport returned: always type: str 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) if __name__ == '__main__': main() 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 @@ -1,246 +1,246 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # (c) 2017, Ansible by Red Hat, inc # # This file is part of Ansible by Red Hat # # 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 . # from __future__ import absolute_import, division, print_function __metaclass__ = type ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'community'} DOCUMENTATION = """ --- module: vyos_ping short_description: Tests reachability using ping from VyOS network devices description: - Tests reachability using ping from a VyOS device to a remote destination. - Tested against VyOS 1.1.8 (helium) - For a general purpose network module, see the M(net_ping) module. - 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: description: - The IP Address or hostname (resolvable by the device) of the remote node. required: true count: description: - Number of packets to send to check reachability. type: int default: 5 source: description: - The source interface or IP Address to use while sending the ping packet(s). ttl: description: - The time-to-live value for the ICMP packet(s). type: int size: description: - Determines the size (in bytes) of the ping packet(s). type: int interval: description: - Determines the interval (in seconds) between consecutive pings. type: int state: description: - Determines if the expected result is success or fail. choices: [ absent, present ] default: present notes: - For a general purpose network module, see the M(net_ping) module. - For Windows targets, use the M(win_ping) module instead. - For targets running Python, use the M(ping) module instead. extends_documentation_fragment: vyos """ EXAMPLES = """ - name: Test reachability to 10.10.10.10 vyos_ping: dest: 10.10.10.10 - name: Test reachability to 10.20.20.20 using source and ttl set vyos_ping: dest: 10.20.20.20 source: eth0 ttl: 128 - name: Test unreachability to 10.30.30.30 using interval vyos_ping: dest: 10.30.30.30 interval: 3 state: absent - name: Test reachability to 10.40.40.40 setting count and source vyos_ping: dest: 10.40.40.40 source: eth1 count: 20 size: 512 """ RETURN = """ commands: description: List of commands sent. returned: always type: list sample: ["ping 10.8.38.44 count 10 interface eth0 ttl 128"] packet_loss: description: Percentage of packets lost. returned: always type: str sample: "0%" packets_rx: description: Packets successfully received. returned: always type: int sample: 20 packets_tx: description: Packets successfully transmitted. returned: always type: int sample: 20 rtt: description: The round trip time (RTT) stats. returned: when ping succeeds type: dict sample: {"avg": 2, "max": 8, "min": 1, "mdev": 24} """ from ansible.module_utils.basic import AnsibleModule from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import run_commands from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import vyos_argument_spec import re def main(): """ main entry point for module execution """ argument_spec = dict( count=dict(type="int", default=5), dest=dict(type="str", required=True), source=dict(type="str"), ttl=dict(type='int'), size=dict(type='int'), interval=dict(type='int'), state=dict(type="str", choices=["absent", "present"], default="present"), ) argument_spec.update(vyos_argument_spec) module = AnsibleModule(argument_spec=argument_spec) count = module.params["count"] dest = module.params["dest"] source = module.params["source"] size = module.params["size"] ttl = module.params["ttl"] interval = module.params["interval"] warnings = list() results = {} if warnings: results["warnings"] = warnings results["commands"] = [build_ping(dest, count, size, interval, source, ttl)] ping_results = run_commands(module, commands=results["commands"]) ping_results_list = ping_results[0].split("\n") rtt_info, rate_info = None, None for line in ping_results_list: if line.startswith('rtt'): rtt_info = line if line.startswith('%s packets transmitted' % count): rate_info = line if rtt_info: rtt = parse_rtt(rtt_info) for k, v in rtt.items(): if rtt[k] is not None: rtt[k] = int(v) results["rtt"] = rtt pkt_loss, rx, tx = parse_rate(rate_info) results["packet_loss"] = str(pkt_loss) + "%" results["packets_rx"] = int(rx) results["packets_tx"] = int(tx) validate_results(module, pkt_loss, results) module.exit_json(**results) def build_ping(dest, count, size=None, interval=None, source=None, ttl=None): cmd = "ping {0} count {1}".format(dest, str(count)) if source: cmd += " interface {0}".format(source) if ttl: cmd += " ttl {0}".format(str(ttl)) if size: cmd += " size {0}".format(str(size)) if interval: cmd += " interval {0}".format(str(interval)) return cmd def parse_rate(rate_info): rate_re = re.compile( r"(?P\d+) (?:\w+) (?:\w+), (?P\d+) (?:\w+), (?P\d+)% (?:\w+) (?:\w+), (?:\w+) (?P