Skip to content

Latest commit

 

History

History
667 lines (457 loc) · 36.9 KB

CHANGELOG.rst

File metadata and controls

667 lines (457 loc) · 36.9 KB
Raw

Community RouterOS Release Notes

Topics

v3.0.0

Release Summary

Major release that drops support for End of Life Python versions and fixes check mode for community.routeros.command.

Breaking Changes / Porting Guide

  • command - the module no longer declares that it supports check mode (#318).

Removed Features (previously deprecated)

  • The collection no longer supports Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13, and ansible-core 2.14. If you need to continue using End of Life versions of Ansible/ansible-base/ansible-core, please use community.routeros 2.x.y (#318).

v2.20.0

Release Summary

Feature release.

Minor Changes

  • api_info, api_modify - add new parameters from the RouterOS 7.16 release (#323).
  • api_info, api_modify - add support interface l2tp-client configuration (#322).
  • api_info, api_modify - add support for the cpu-frequency, memory-frequency, preboot-etherboot and preboot-etherboot-server properties in system routerboard settings (#320).
  • api_info, api_modify - add support for the matching-type property in ip dhcp-server matcher introduced by RouterOS 7.16 (#321).

v2.19.0

Release Summary

Feature release.

Minor Changes

  • api_info, api_modify - add support for the ip dns adlist path implemented by RouterOS 7.15 and newer (#310).
  • api_info, api_modify - add support for the mld-version and multicast-querier properties in interface bridge (#315).
  • api_info, api_modify - add support for the routing filter num-list path implemented by RouterOS 7 and newer (#313).
  • api_info, api_modify - add support for the routing igmp-proxy path (#309).
  • api_modify, api_info - add read-only default field to snmp community (#311).

v2.18.0

Release Summary

Feature release.

Minor Changes

  • api_info - allow to restrict the output by limiting fields to specific values with the new restrict option (#305).
  • api_info, api_modify - add support for the ip dhcp-server matcher path (#300).
  • api_info, api_modify - add support for the ipv6 nd prefix path (#303).
  • api_info, api_modify - add support for the name and is-responder properties under the interface wireguard peers path introduced in RouterOS 7.15 (#304).
  • api_info, api_modify - add support for the routing ospf static-neighbor path in RouterOS 7 (#302).
  • api_info, api_modify - set default for force in ip dhcp-server option to an explicit false (#300).
  • api_modify - allow to restrict what is updated by limiting fields to specific values with the new restrict option (#305).

Deprecated Features

  • The collection deprecates support for all Ansible/ansible-base/ansible-core versions that are currently End of Life, according to the ansible-core support matrix. This means that the next major release of the collection will no longer support Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13, and ansible-core 2.14.

Bugfixes

  • api_modify, api_info - change the default of ingress-filtering in paths interface bridge and interface bridge port back to false for RouterOS before version 7 (#305).

v2.17.0

Release Summary

Feature release.

Minor Changes

  • api_info, api_modify - add system health settings path (#294).
  • api_info, api_modify - add missing path /system resource irq rps (#295).
  • api_info, api_modify - add parameter host-key-type for ip ssh path (#280, #297).

v2.16.0

Release Summary

Feature release.

Minor Changes

  • api_info, api_modify - add missing path /ppp secret (#286).
  • api_info, api_modify - minor changes /interface ethernet path fields (#288).

v2.15.0

Release Summary

Feature release.

Minor Changes

  • api_info, api_modify - Add RouterOS 7.x support to /mpls ldp path (#271).
  • api_info, api_modify - add /ip route rule path for RouterOS 6.x (#278).
  • api_info, api_modify - add /routing filter path for RouterOS 6.x (#279).
  • api_info, api_modify - add default value for from-pool field in /ipv6 address (#270).
  • api_info, api_modify - add missing path /interface pppoe-server server (#273).
  • api_info, api_modify - add missing path /ip dhcp-relay (#276).
  • api_info, api_modify - add missing path /queue simple (#269).
  • api_info, api_modify - add missing path /queue type (#274).
  • api_info, api_modify - add missing paths /routing bgp aggregate, /routing bgp network and /routing bgp peer (#277).
  • api_info, api_modify - add support for paths /mpls interface, /mpls ldp accept-filter, /mpls ldp advertise-filter and mpls ldp interface (#272).

v2.14.0

Release Summary

Feature release.

Minor Changes

  • api_info, api_modify - add read-only fields installed-version, latest-version and status in system package update (#263).
  • api_info, api_modify - added support for interface wifi and its sub-paths (#266).
  • api_info, api_modify - remove default value for read-only running field in interface wireless (#264).

v2.13.0

Release Summary

Bugfix and feature release.

Minor Changes

  • api_info, api_modify - make path user group modifiable and add comment attribute (#256, #257).
  • api_modify, api_info - add support for the ip vrf path in RouterOS 7 (#259)

Bugfixes

  • facts - fix date not getting removed for idempotent config export (#262).

v2.12.0

Release Summary

Feature release.

Minor Changes

  • api_info, api_modify - add interface ovpn-client path (#242, #244).
  • api_info, api_modify - add radius path (#241, #245).
  • api_info, api_modify - add routing rule path (#162, #246).
  • api_info, api_modify - add missing path routing bgp template (#243).
  • api_info, api_modify - add support for the tx-power attribute in interface wireless (#239).
  • api_info, api_modify - removed host primary key in tool netwatch path (#248).
  • api_modify, api_info - added support for interface wifiwave2 (#226).

v2.11.0

Release Summary

Feature and bugfix release.

Minor Changes

  • api_info, api_modify - add missing DoH parameters doh-max-concurrent-queries, doh-max-server-connections, and doh-timeout to the ip dns path (#230, #235)
  • api_info, api_modify - add missing parameters address-list, address-list-timeout, randomise-ports, and realm to subpaths of the ip firewall path (#236, #237).
  • api_info, api_modify - mark the interface wireless parameter running as read-only (#233).
  • api_info, api_modify - set the default value to false for the disabled parameter in some more paths where it can be seen in the documentation (#237).
  • api_modify - add missing comment attribute to /routing id (#234).
  • api_modify - add missing attributes to the routing bgp connection path (#234).
  • api_modify - add versioning to the /tool e-mail path (RouterOS 7.12 release) (#234).
  • api_modify - make /ip traffic-flow target a multiple value attribute (#234).

v2.10.0

Release Summary

Bugfix and feature release.

Minor Changes

  • api_info - add new include_read_only option to select behavior for read-only values. By default these are not returned (#213).
  • api_info, api_modify - add support for address-list and match-subdomain introduced by RouterOS 7.7 in the ip dns static path (#197).
  • api_info, api_modify - add support for user, time and gmt-offset under the system clock path (#210).
  • api_info, api_modify - add support for the interface ppp-client path (#199).
  • api_info, api_modify - add support for the interface wireless path (#195).
  • api_info, api_modify - add support for the iot modbus path (#205).
  • api_info, api_modify - add support for the ip dhcp-server option and ip dhcp-server option sets paths (#223).
  • api_info, api_modify - add support for the ip upnp interfaces, tool graphing interface, tool graphing resource paths (#227).
  • api_info, api_modify - add support for the ipv6 firewall nat path (#204).
  • api_info, api_modify - add support for the mode property in ip neighbor discovery-settings introduced in RouterOS 7.7 (#198).
  • api_info, api_modify - add support for the port remote-access path (#224).
  • api_info, api_modify - add support for the routing filter rule and routing filter select-rule paths (#200).
  • api_info, api_modify - add support for the routing table path in RouterOS 7 (#215).
  • api_info, api_modify - add support for the tool netwatch path in RouterOS 7 (#216).
  • api_info, api_modify - add support for the user settings path (#201).
  • api_info, api_modify - add support for the user path (#211).
  • api_info, api_modify - finalize fields for the interface wireless security-profiles path and enable it (#203).
  • api_info, api_modify - finalize fields for the ppp profile path and enable it (#217).
  • api_modify - add new handle_read_only and handle_write_only options to handle the module's behavior for read-only and write-only fields (#213).
  • api_modify, api_info - support API paths routing id, routing bgp connection (#220).

Bugfixes

  • api_info, api_modify - in the snmp path, ensure that engine-id-suffix is only available on RouterOS 7.10+, and that engine-id is read-only on RouterOS 7.10+ (#208, #218).

v2.9.0

Release Summary

Bugfix and feature release.

Minor Changes

  • api_info, api_modify - add path caps-man channel and enable path caps-man manager interface (#193, #194).
  • api_info, api_modify - add path ip traffic-flow target (#191, #192).

Bugfixes

  • api_modify, api_info - add missing parameter engine-id-suffix for the snmp path (#189, #190).

v2.8.3

Release Summary

Maintenance release with updated documentation.

From this version on, community.routeros is using the new Ansible semantic markup in its documentation. If you look at documentation with the ansible-doc CLI tool from ansible-core before 2.15, please note that it does not render the markup correctly. You should be still able to read it in most cases, but you need ansible-core 2.15 or later to see it as it is intended. Alternatively you can look at the devel docsite for the rendered HTML version of the documentation of the latest release.

Known Issues

v2.8.2

Release Summary

Bugfix release.

Bugfixes

  • api_modify, api_info - add missing parameter tls for the tool e-mail path (#179, #180).

v2.8.1

Release Summary

Bugfix release.

Bugfixes

  • facts - do not crash in CLI output preprocessing in unexpected situations during line unwrapping (#170, #177).

v2.8.0

Release Summary

Bugfix and feature release.

Minor Changes

  • api_modify - adapt data for API paths ip dhcp-server network (#156).
  • api_modify - add support for API path snmp community (#159).
  • api_modify - add support for trap-interfaces in API path snmp (#159).
  • api_modify - add support to disable IPv6 in API paths ipv6 settings (#158).
  • api_modify - support API paths ip firewall layer7-protocol (#153).
  • command - workaround for extra characters in stdout in RouterOS versions between 6.49 and 7.1.5 (#62, #161).

Bugfixes

  • api_info, api_modify - fix default and remove behavior for dhcp-options in path ip dhcp-client (#148, #154).
  • api_modify - fix handling of disabled keys on creation (#154).
  • various plugins and modules - remove unnecessary imports (#149).

v2.7.0

Release Summary

Bugfix and feature release.

Minor Changes

  • api_modify, api_info - support API paths ip arp, ip firewall raw, ipv6 firewall raw (#144).

Bugfixes

  • api_modify, api_info - defaults corrected for fields in interface wireguard peers API path (#144).

v2.6.0

Release Summary

Regular bugfix and feature release.

Minor Changes

  • api_modify, api_info - add field regexp to ip dns static (#141).
  • api_modify, api_info - support API paths interface wireguard, interface wireguard peers (#143).

Bugfixes

  • api_modify - do not use name as a unique key in ip dns static (#141).
  • api_modify, api_info - do not crash if router contains regexp DNS entries in ip dns static (#141).

v2.5.0

Release Summary

Feature and bugfix release.

Minor Changes

  • api_info, api_modify - support API paths interface ethernet poe, interface gre6, interface vrrp and also support all previously missing fields of entries in ip dhcp-server (#137).

Bugfixes

  • api_modify - address-pool field of entries in API path ip dhcp-server is not required anymore (#137).

v2.4.0

Release Summary

Feature release improving the api* modules.

Minor Changes

  • api* modules - Add new option force_no_cert to connect with ADH ciphers (#124).
  • api_info - new parameter include_builtin which allows to include "builtin" entries that are automatically generated by ROS and cannot be modified by the user (#130).
  • api_modify, api_info - support API paths - interface bonding, interface bridge mlag, ipv6 firewall mangle, ipv6 nd, system scheduler, system script, system ups (#133).
  • api_modify, api_info - support API paths caps-man access-list, caps-man configuration, caps-man datapath, caps-man manager, caps-man provisioning, caps-man security (#126).
  • api_modify, api_info - support API paths interface list and interface list member (#120).
  • api_modify, api_info - support API paths interface pppoe-client, interface vlan, interface bridge, interface bridge vlan (#125).
  • api_modify, api_info - support API paths ip ipsec identity, ip ipsec peer, ip ipsec policy, ip ipsec profile, ip ipsec proposal (#129).
  • api_modify, api_info - support API paths ip route and ip route vrf (#123).
  • api_modify, api_info - support API paths ipv6 address, ipv6 dhcp-server, ipv6 dhcp-server option, ipv6 route, queue tree, routing ospf area, routing ospf area range, routing ospf instance, routing ospf interface-template, routing pimsm instance, routing pimsm interface-template (#131).
  • api_modify, api_info - support API paths system logging, system logging action (#127).
  • api_modify, api_info - support field hw-offload for path ip firewall filter (#121).
  • api_modify, api_info - support fields address-list, address-list-timeout, connection-bytes, connection-limit, connection-mark, connection-rate, connection-type, content, disabled, dscp, dst-address-list, dst-address-type, dst-limit, fragment, hotspot, icmp-options, in-bridge-port, in-bridge-port-list, ingress-priority, ipsec-policy, ipv4-options, jump-target, layer7-protocol, limit, log, log-prefix, nth, out-bridge-port, out-bridge-port-list, packet-mark, packet-size, per-connection-classifier, port, priority, psd, random, realm, routing-mark, same-not-by-dst, src-address, src-address-list, src-address-type, src-mac-address, src-port, tcp-mss, time, tls-host, ttl in ip firewall nat path (#133).
  • api_modify, api_info - support fields combo-mode, comment, fec-mode, mdix-enable, poe-out, poe-priority, poe-voltage, power-cycle-interval, power-cycle-ping-address, power-cycle-ping-enabled, power-cycle-ping-timeout for path interface ethernet (#121).
  • api_modify, api_info - support fields jump-target, reject-with in ip firewall filter API path, field comment in ip firwall address-list API path, field jump-target in ip firewall mangle API path, field comment in ipv6 firewall address-list API path, fields jump-target, reject-with in ipv6 firewall filter API path (#133).
  • api_modify, api_info - support for API fields that can be disabled and have default value at the same time, support API paths interface gre, interface eoip (#128).
  • api_modify, api_info - support for fields blackhole, pref-src, routing-table, suppress-hw-offload, type, vrf-interface in ip route path (#131).
  • api_modify, api_info - support paths system ntp client servers and system ntp server available in ROS7, as well as new fields servers, mode, and vrf for system ntp client (#122).

Bugfixes

  • api_modify - ip route entry can be defined without the need of gateway field, which is correct for unreachable/blackhole type of routes (#131).
  • api_modify - queue interface path works now (#131).
  • api_modify, api_info - removed wrong field dynamic from API path ipv6 firewall address-list (#133).
  • api_modify, api_info - the default of the field ingress-filtering in interface bridge port is now true, which is the default in ROS (#125).
  • command, facts - commands do not timeout in safe mode anymore (#134).

Known Issues

  • api_modify - when limits for entries in queue tree are defined as human readable - for example 25M -, the configuration will be correctly set in ROS, but the module will indicate the item is changed on every run even when there was no change done. This is caused by the ROS API which returns the number in bytes - for example 25000000 (which is inconsistent with the CLI behavior). In order to mitigate that, the limits have to be defined in bytes (those will still appear as human readable in the ROS CLI) (#131).
  • api_modify, api_info - routing ospf area, routing ospf area range, routing ospf instance, routing ospf interface-template paths are not fully implemented for ROS6 due to the significant changes between ROS6 and ROS7 (#131).

v2.3.1

Release Summary

Maintenance release with improved documentation.

Known Issues

  • The community.routeros.command module claims to support check mode. Since it cannot judge whether the commands executed modify state or not, this behavior is incorrect. Since this potentially breaks existing playbooks, we will not change this behavior until community.routeros 3.0.0.

v2.3.0

Release Summary

Feature and bugfix release.

Minor Changes

  • The collection repository conforms to the REUSE specification except for the changelog fragments (#108).
  • api* modules - added timeout parameter (#109).
  • api_modify, api_info - support API path ip firewall mangle (#110).

Bugfixes

  • api_modify, api_info - make API path ip dhcp-server support script, and ip firewall nat support in-interface and in-interface-list (#110).

v2.2.1

Release Summary

Bugfix release.

Bugfixes

  • api_modify, api_info - make API path ip dhcp-server lease support server=all (#104, #107).
  • api_modify, api_info - make API path ip dhcp-server network support missing options boot-file-name, dhcp-option-set, dns-none, domain, and next-server (#104, #106).

v2.2.0

Release Summary

New feature release.

Minor Changes

  • All software licenses are now in the LICENSES/ directory of the collection root. Moreover, SPDX-License-Identifier: is used to declare the applicable license for every file that is not automatically generated (#101).

Bugfixes

  • Include LICENSES/BSD-2-Clause.txt file for the routeros module utils (#101).

New Modules

  • community.routeros.api_info - Retrieve information from API
  • community.routeros.api_modify - Modify data at paths with API

v2.1.0

Release Summary

Feature and bugfix release with new modules.

Minor Changes

  • Added a community.routeros.api module defaults group. Use with group/community.routeros.api to provide options for all API-based modules (#89).
  • Prepare collection for inclusion in an Execution Environment by declaring its dependencies (#83).
  • api - add new option extended query more complex queries against RouterOS API (#63).
  • api - update query to accept symbolic parameters (#63).
  • api* modules - allow to set an encoding other than the default ASCII for communicating with the API (#95).

Bugfixes

  • query - fix query function check for .id vs. id arguments to not conflict with routeros arguments like identity (#68, #67).
  • quoting and unquoting filter plugins, api module - handle the escape sequence \_ correctly as escaping a space and not an underscore (#89).

New Modules

  • community.routeros.api_facts - Collect facts from remote devices running MikroTik RouterOS using the API
  • community.routeros.api_find_and_modify - Find and modify information using the API

v2.0.0

Release Summary

A new major release with breaking changes in the behavior of community.routeros.api and community.routeros.command.

Minor Changes

  • api - make validation of WHERE for query more strict (#53).
  • command - the commands and wait_for options now convert the list elements to strings (#55).
  • facts - the gather_subset option now converts the list elements to strings (#55).

Breaking Changes / Porting Guide

  • api - due to a programming error, the module never failed on errors. This has now been fixed. If you are relying on the module not failing in case of idempotent commands (resulting in errors like failure: already have such address), you need to adjust your roles/playbooks. We suggest to use failed_when to accept failure in specific circumstances, for example failed_when: "'failure: already have ' in result.msg[0]" (#39).
  • api - splitting commands no longer uses a naive split by whitespace, but a more RouterOS CLI compatible splitting algorithm (#45).
  • command - the module now always indicates that a change happens. If this is not correct, please use changed_when to determine the correct changed status for a task (#50).

Bugfixes

  • api - improve splitting of WHERE queries (#47).
  • api - when converting result lists to dictionaries, no longer removes second = and text following that if present (#47).
  • routeros cliconf plugin - adjust function signature that was modified in Ansible after creation of this plugin (#43).

New Plugins

Filter

  • community.routeros.join - Join a list of arguments to a command
  • community.routeros.list_to_dict - Convert a list of arguments to a list of dictionary
  • community.routeros.quote_argument - Quote an argument
  • community.routeros.quote_argument_value - Quote an argument value
  • community.routeros.split - Split a command into arguments

v1.2.0

Release Summary

Bugfix and feature release.

Minor Changes

  • Avoid internal ansible-core module_utils in favor of equivalent public API available since at least Ansible 2.9 (#38).
  • api - add options validate_certs (default value true), validate_cert_hostname (default value false), and ca_path to control certificate validation (#37).
  • api - rename option ssl to tls, and keep the old name as an alias (#37).
  • fact - add fact ansible_net_config_nonverbose to get idempotent config (no date, no verbose) (#23).

Bugfixes

  • api - when using TLS/SSL, remove explicit cipher configuration to insecure values, which also makes it impossible to connect to newer RouterOS versions (#34).

v1.1.0

Release Summary

This release allow dashes in usernames for SSH-based modules.

Minor Changes

  • command - added support for a dash (-) in username (#18).
  • facts - added support for a dash (-) in username (#18).

v1.0.1

Release Summary

Maintenance release with a bugfix for api.

Bugfixes

  • api - remove id to .id as default requirement which conflicts with RouterOS id configuration parameter (#15).

v1.0.0

Release Summary

This is the first production (non-prerelease) release of community.routeros.

Bugfixes

v0.1.1

Release Summary

Small improvements and bugfixes over the initial release.

Bugfixes

  • api - fix crash when the ssl parameter is used (#3).

v0.1.0

Release Summary

The community.routeros continues the work on the Ansible RouterOS modules from their state in community.network 1.2.0. The changes listed here are thus relative to the modules community.network.routeros_*.

Minor Changes