Community.Routeros Release Notes
v3.1.0
Release Summary
Bugfix and feature release.
Minor Changes
api_info, api_modify - add missing fields
comment
,next-pool
toip pool
path (https://github.com/ansible-collections/community.routeros/pull/327).
Bugfixes
api_info, api_modify - fields
log
andlog-prefix
in pathsip firewall filter
,ip firewall mangle
,ip firewall nat
,ip firewall raw
now have the correct default values (https://github.com/ansible-collections/community.routeros/pull/324).
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 (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/318).
v2.20.0
Release Summary
Feature release.
Minor Changes
api_info, api_modify - add new parameters from the RouterOS 7.16 release (https://github.com/ansible-collections/community.routeros/pull/323).
api_info, api_modify - add support
interface l2tp-client
configuration (https://github.com/ansible-collections/community.routeros/pull/322).api_info, api_modify - add support for the
cpu-frequency
,memory-frequency
,preboot-etherboot
andpreboot-etherboot-server
properties insystem routerboard settings
(https://github.com/ansible-collections/community.routeros/pull/320).api_info, api_modify - add support for the
matching-type
property inip dhcp-server matcher
introduced by RouterOS 7.16 (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/310).api_info, api_modify - add support for the
mld-version
andmulticast-querier
properties ininterface bridge
(https://github.com/ansible-collections/community.routeros/pull/315).api_info, api_modify - add support for the
routing filter num-list
path implemented by RouterOS 7 and newer (https://github.com/ansible-collections/community.routeros/pull/313).api_info, api_modify - add support for the
routing igmp-proxy
path (https://github.com/ansible-collections/community.routeros/pull/309).api_modify, api_info - add read-only
default
field tosnmp community
(https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/305).api_info, api_modify - add support for the
ip dhcp-server matcher
path (https://github.com/ansible-collections/community.routeros/pull/300).api_info, api_modify - add support for the
ipv6 nd prefix
path (https://github.com/ansible-collections/community.routeros/pull/303).api_info, api_modify - add support for the
name
andis-responder
properties under theinterface wireguard peers
path introduced in RouterOS 7.15 (https://github.com/ansible-collections/community.routeros/pull/304).api_info, api_modify - add support for the
routing ospf static-neighbor
path in RouterOS 7 (https://github.com/ansible-collections/community.routeros/pull/302).api_info, api_modify - set default for
force
inip dhcp-server option
to an explicitfalse
(https://github.com/ansible-collections/community.routeros/pull/300).api_modify - allow to restrict what is updated by limiting fields to specific values with the new
restrict
option (https://github.com/ansible-collections/community.routeros/pull/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 pathsinterface bridge
andinterface bridge port
back tofalse
for RouterOS before version 7 (https://github.com/ansible-collections/community.routeros/pull/305).
v2.17.0
Release Summary
Feature release.
Minor Changes
api_info, api_modify - add
system health settings
path (https://github.com/ansible-collections/community.routeros/pull/294).api_info, api_modify - add missing path
/system resource irq rps
(https://github.com/ansible-collections/community.routeros/pull/295).api_info, api_modify - add parameter
host-key-type
forip ssh
path (https://github.com/ansible-collections/community.routeros/issues/280, https://github.com/ansible-collections/community.routeros/pull/297).
v2.16.0
Release Summary
Feature release.
Minor Changes
api_info, api_modify - add missing path
/ppp secret
(https://github.com/ansible-collections/community.routeros/pull/286).api_info, api_modify - minor changes
/interface ethernet
path fields (https://github.com/ansible-collections/community.routeros/pull/288).
v2.15.0
Release Summary
Feature release.
Minor Changes
api_info, api_modify - Add RouterOS 7.x support to
/mpls ldp
path (https://github.com/ansible-collections/community.routeros/pull/271).api_info, api_modify - add
/ip route rule
path for RouterOS 6.x (https://github.com/ansible-collections/community.routeros/pull/278).api_info, api_modify - add
/routing filter
path for RouterOS 6.x (https://github.com/ansible-collections/community.routeros/pull/279).api_info, api_modify - add default value for
from-pool
field in/ipv6 address
(https://github.com/ansible-collections/community.routeros/pull/270).api_info, api_modify - add missing path
/interface pppoe-server server
(https://github.com/ansible-collections/community.routeros/pull/273).api_info, api_modify - add missing path
/ip dhcp-relay
(https://github.com/ansible-collections/community.routeros/pull/276).api_info, api_modify - add missing path
/queue simple
(https://github.com/ansible-collections/community.routeros/pull/269).api_info, api_modify - add missing path
/queue type
(https://github.com/ansible-collections/community.routeros/pull/274).api_info, api_modify - add missing paths
/routing bgp aggregate
,/routing bgp network
and/routing bgp peer
(https://github.com/ansible-collections/community.routeros/pull/277).api_info, api_modify - add support for paths
/mpls interface
,/mpls ldp accept-filter
,/mpls ldp advertise-filter
andmpls ldp interface
(https://github.com/ansible-collections/community.routeros/pull/272).
v2.14.0
Release Summary
Feature release.
Minor Changes
api_info, api_modify - add read-only fields
installed-version
,latest-version
andstatus
insystem package update
(https://github.com/ansible-collections/community.routeros/pull/263).api_info, api_modify - added support for
interface wifi
and its sub-paths (https://github.com/ansible-collections/community.routeros/pull/266).api_info, api_modify - remove default value for read-only
running
field ininterface wireless
(https://github.com/ansible-collections/community.routeros/pull/264).
v2.13.0
Release Summary
Bugfix and feature release.
Minor Changes
api_info, api_modify - make path
user group
modifiable and addcomment
attribute (https://github.com/ansible-collections/community.routeros/issues/256, https://github.com/ansible-collections/community.routeros/pull/257).api_modify, api_info - add support for the
ip vrf
path in RouterOS 7 (https://github.com/ansible-collections/community.routeros/pull/259)
Bugfixes
facts - fix date not getting removed for idempotent config export (https://github.com/ansible-collections/community.routeros/pull/262).
v2.12.0
Release Summary
Feature release.
Minor Changes
api_info, api_modify - add
interface ovpn-client
path (https://github.com/ansible-collections/community.routeros/issues/242, https://github.com/ansible-collections/community.routeros/pull/244).api_info, api_modify - add
radius
path (https://github.com/ansible-collections/community.routeros/issues/241, https://github.com/ansible-collections/community.routeros/pull/245).api_info, api_modify - add
routing rule
path (https://github.com/ansible-collections/community.routeros/issues/162, https://github.com/ansible-collections/community.routeros/pull/246).api_info, api_modify - add missing path
routing bgp template
(https://github.com/ansible-collections/community.routeros/pull/243).api_info, api_modify - add support for the
tx-power
attribute ininterface wireless
(https://github.com/ansible-collections/community.routeros/pull/239).api_info, api_modify - removed
host
primary key intool netwatch
path (https://github.com/ansible-collections/community.routeros/pull/248).api_modify, api_info - added support for
interface wifiwave2
(https://github.com/ansible-collections/community.routeros/pull/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
, anddoh-timeout
to theip dns
path (https://github.com/ansible-collections/community.routeros/issues/230, https://github.com/ansible-collections/community.routeros/pull/235)api_info, api_modify - add missing parameters
address-list
,address-list-timeout
,randomise-ports
, andrealm
to subpaths of theip firewall
path (https://github.com/ansible-collections/community.routeros/issues/236, https://github.com/ansible-collections/community.routeros/pull/237).api_info, api_modify - mark the
interface wireless
parameterrunning
as read-only (https://github.com/ansible-collections/community.routeros/pull/233).api_info, api_modify - set the default value to
false
for thedisabled
parameter in some more paths where it can be seen in the documentation (https://github.com/ansible-collections/community.routeros/pull/237).api_modify - add missing
comment
attribute to/routing id
(https://github.com/ansible-collections/community.routeros/pull/234).api_modify - add missing attributes to the
routing bgp connection
path (https://github.com/ansible-collections/community.routeros/pull/234).api_modify - add versioning to the
/tool e-mail
path (RouterOS 7.12 release) (https://github.com/ansible-collections/community.routeros/pull/234).api_modify - make
/ip traffic-flow target
a multiple value attribute (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/213).api_info, api_modify - add support for
address-list
andmatch-subdomain
introduced by RouterOS 7.7 in theip dns static
path (https://github.com/ansible-collections/community.routeros/pull/197).api_info, api_modify - add support for
user
,time
andgmt-offset
under thesystem clock
path (https://github.com/ansible-collections/community.routeros/pull/210).api_info, api_modify - add support for the
interface ppp-client
path (https://github.com/ansible-collections/community.routeros/pull/199).api_info, api_modify - add support for the
interface wireless
path (https://github.com/ansible-collections/community.routeros/pull/195).api_info, api_modify - add support for the
iot modbus
path (https://github.com/ansible-collections/community.routeros/pull/205).api_info, api_modify - add support for the
ip dhcp-server option
andip dhcp-server option sets
paths (https://github.com/ansible-collections/community.routeros/pull/223).api_info, api_modify - add support for the
ip upnp interfaces
,tool graphing interface
,tool graphing resource
paths (https://github.com/ansible-collections/community.routeros/pull/227).api_info, api_modify - add support for the
ipv6 firewall nat
path (https://github.com/ansible-collections/community.routeros/pull/204).api_info, api_modify - add support for the
mode
property inip neighbor discovery-settings
introduced in RouterOS 7.7 (https://github.com/ansible-collections/community.routeros/pull/198).api_info, api_modify - add support for the
port remote-access
path (https://github.com/ansible-collections/community.routeros/pull/224).api_info, api_modify - add support for the
routing filter rule
androuting filter select-rule
paths (https://github.com/ansible-collections/community.routeros/pull/200).api_info, api_modify - add support for the
routing table
path in RouterOS 7 (https://github.com/ansible-collections/community.routeros/pull/215).api_info, api_modify - add support for the
tool netwatch
path in RouterOS 7 (https://github.com/ansible-collections/community.routeros/pull/216).api_info, api_modify - add support for the
user settings
path (https://github.com/ansible-collections/community.routeros/pull/201).api_info, api_modify - add support for the
user
path (https://github.com/ansible-collections/community.routeros/pull/211).api_info, api_modify - finalize fields for the
interface wireless security-profiles
path and enable it (https://github.com/ansible-collections/community.routeros/pull/203).api_info, api_modify - finalize fields for the
ppp profile
path and enable it (https://github.com/ansible-collections/community.routeros/pull/217).api_modify - add new
handle_read_only
andhandle_write_only
options to handle the module’s behavior for read-only and write-only fields (https://github.com/ansible-collections/community.routeros/pull/213).api_modify, api_info - support API paths
routing id
,routing bgp connection
(https://github.com/ansible-collections/community.routeros/pull/220).
Bugfixes
api_info, api_modify - in the
snmp
path, ensure thatengine-id-suffix
is only available on RouterOS 7.10+, and thatengine-id
is read-only on RouterOS 7.10+ (https://github.com/ansible-collections/community.routeros/issues/208, https://github.com/ansible-collections/community.routeros/pull/218).
v2.9.0
Release Summary
Bugfix and feature release.
Minor Changes
api_info, api_modify - add path
caps-man channel
and enable pathcaps-man manager interface
(https://github.com/ansible-collections/community.routeros/issues/193, https://github.com/ansible-collections/community.routeros/pull/194).api_info, api_modify - add path
ip traffic-flow target
(https://github.com/ansible-collections/community.routeros/issues/191, https://github.com/ansible-collections/community.routeros/pull/192).
Bugfixes
api_modify, api_info - add missing parameter
engine-id-suffix
for thesnmp
path (https://github.com/ansible-collections/community.routeros/issues/189, https://github.com/ansible-collections/community.routeros/pull/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
Ansible markup will show up in raw form on ansible-doc text output for ansible-core before 2.15. If you have trouble deciphering the documentation markup, please upgrade to ansible-core 2.15 (or newer), or read the HTML documentation on https://docs.ansible.com/ansible/devel/collections/community/routeros/.
v2.8.2
Release Summary
Bugfix release.
Bugfixes
api_modify, api_info - add missing parameter
tls
for thetool e-mail
path (https://github.com/ansible-collections/community.routeros/issues/179, https://github.com/ansible-collections/community.routeros/pull/180).
v2.8.1
Release Summary
Bugfix release.
Bugfixes
facts - do not crash in CLI output preprocessing in unexpected situations during line unwrapping (https://github.com/ansible-collections/community.routeros/issues/170, https://github.com/ansible-collections/community.routeros/pull/177).
v2.8.0
Release Summary
Bugfix and feature release.
Minor Changes
api_modify - adapt data for API paths
ip dhcp-server network
(https://github.com/ansible-collections/community.routeros/pull/156).api_modify - add support for API path
snmp community
(https://github.com/ansible-collections/community.routeros/pull/159).api_modify - add support for
trap-interfaces
in API pathsnmp
(https://github.com/ansible-collections/community.routeros/pull/159).api_modify - add support to disable IPv6 in API paths
ipv6 settings
(https://github.com/ansible-collections/community.routeros/pull/158).api_modify - support API paths
ip firewall layer7-protocol
(https://github.com/ansible-collections/community.routeros/pull/153).command - workaround for extra characters in stdout in RouterOS versions between 6.49 and 7.1.5 (https://github.com/ansible-collections/community.routeros/issues/62, https://github.com/ansible-collections/community.routeros/pull/161).
Bugfixes
api_info, api_modify - fix default and remove behavior for
dhcp-options
in pathip dhcp-client
(https://github.com/ansible-collections/community.routeros/issues/148, https://github.com/ansible-collections/community.routeros/pull/154).api_modify - fix handling of disabled keys on creation (https://github.com/ansible-collections/community.routeros/pull/154).
various plugins and modules - remove unnecessary imports (https://github.com/ansible-collections/community.routeros/pull/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
(https://github.com/ansible-collections/community.routeros/pull/144).
Bugfixes
api_modify, api_info - defaults corrected for fields in
interface wireguard peers
API path (https://github.com/ansible-collections/community.routeros/pull/144).
v2.6.0
Release Summary
Regular bugfix and feature release.
Minor Changes
api_modify, api_info - add field
regexp
toip dns static
(https://github.com/ansible-collections/community.routeros/issues/141).api_modify, api_info - support API paths
interface wireguard
,interface wireguard peers
(https://github.com/ansible-collections/community.routeros/pull/143).
Bugfixes
api_modify - do not use
name
as a unique key inip dns static
(https://github.com/ansible-collections/community.routeros/issues/141).api_modify, api_info - do not crash if router contains
regexp
DNS entries inip dns static
(https://github.com/ansible-collections/community.routeros/issues/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 inip dhcp-server
(https://github.com/ansible-collections/community.routeros/pull/137).
Bugfixes
api_modify -
address-pool
field of entries in API pathip dhcp-server
is not required anymore (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/130).api_modify, api_info - support API paths -
interface bonding
,interface bridge mlag
,ipv6 firewall mangle
,ipv6 nd
,system scheduler
,system script
,system ups
(https://github.com/ansible-collections/community.routeros/pull/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
(https://github.com/ansible-collections/community.routeros/pull/126).api_modify, api_info - support API paths
interface list
andinterface list member
(https://github.com/ansible-collections/community.routeros/pull/120).api_modify, api_info - support API paths
interface pppoe-client
,interface vlan
,interface bridge
,interface bridge vlan
(https://github.com/ansible-collections/community.routeros/pull/125).api_modify, api_info - support API paths
ip ipsec identity
,ip ipsec peer
,ip ipsec policy
,ip ipsec profile
,ip ipsec proposal
(https://github.com/ansible-collections/community.routeros/pull/129).api_modify, api_info - support API paths
ip route
andip route vrf
(https://github.com/ansible-collections/community.routeros/pull/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
(https://github.com/ansible-collections/community.routeros/pull/131).api_modify, api_info - support API paths
system logging
,system logging action
(https://github.com/ansible-collections/community.routeros/pull/127).api_modify, api_info - support field
hw-offload
for pathip firewall filter
(https://github.com/ansible-collections/community.routeros/pull/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
inip firewall nat
path (https://github.com/ansible-collections/community.routeros/pull/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 pathinterface ethernet
(https://github.com/ansible-collections/community.routeros/pull/121).api_modify, api_info - support fields
jump-target
,reject-with
inip firewall filter
API path, fieldcomment
inip firwall address-list
API path, fieldjump-target
inip firewall mangle
API path, fieldcomment
inipv6 firewall address-list
API path, fieldsjump-target
,reject-with
inipv6 firewall filter
API path (https://github.com/ansible-collections/community.routeros/pull/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
(https://github.com/ansible-collections/community.routeros/pull/128).api_modify, api_info - support for fields
blackhole
,pref-src
,routing-table
,suppress-hw-offload
,type
,vrf-interface
inip route
path (https://github.com/ansible-collections/community.routeros/pull/131).api_modify, api_info - support paths
system ntp client servers
andsystem ntp server
available in ROS7, as well as new fieldsservers
,mode
, andvrf
forsystem ntp client
(https://github.com/ansible-collections/community.routeros/pull/122).
Bugfixes
api_modify -
ip route
entry can be defined without the need ofgateway
field, which is correct for unreachable/blackhole type of routes (https://github.com/ansible-collections/community.routeros/pull/131).api_modify -
queue interface
path works now (https://github.com/ansible-collections/community.routeros/pull/131).api_modify, api_info - removed wrong field
dynamic
from API pathipv6 firewall address-list
(https://github.com/ansible-collections/community.routeros/pull/133).api_modify, api_info - the default of the field
ingress-filtering
ininterface bridge port
is nowtrue
, which is the default in ROS (https://github.com/ansible-collections/community.routeros/pull/125).command, facts - commands do not timeout in safe mode anymore (https://github.com/ansible-collections/community.routeros/pull/134).
Known Issues
api_modify - when limits for entries in
queue tree
are defined as human readable - for example25M
-, 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 example25000000
(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) (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/108).
api* modules - added
timeout
parameter (https://github.com/ansible-collections/community.routeros/pull/109).api_modify, api_info - support API path
ip firewall mangle
(https://github.com/ansible-collections/community.routeros/pull/110).
Bugfixes
api_modify, api_info - make API path
ip dhcp-server
supportscript
, andip firewall nat
supportin-interface
andin-interface-list
(https://github.com/ansible-collections/community.routeros/pull/110).
v2.2.1
Release Summary
Bugfix release.
Bugfixes
api_modify, api_info - make API path
ip dhcp-server lease
supportserver=all
(https://github.com/ansible-collections/community.routeros/issues/104, https://github.com/ansible-collections/community.routeros/pull/107).api_modify, api_info - make API path
ip dhcp-server network
support missing optionsboot-file-name
,dhcp-option-set
,dns-none
,domain
, andnext-server
(https://github.com/ansible-collections/community.routeros/issues/104, https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/101).
Bugfixes
Include
LICENSES/BSD-2-Clause.txt
file for therouteros
module utils (https://github.com/ansible-collections/community.routeros/pull/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 withgroup/community.routeros.api
to provide options for all API-based modules (https://github.com/ansible-collections/community.routeros/pull/89).Prepare collection for inclusion in an Execution Environment by declaring its dependencies (https://github.com/ansible-collections/community.routeros/pull/83).
api - add new option
extended query
more complex queries against RouterOS API (https://github.com/ansible-collections/community.routeros/pull/63).api - update
query
to accept symbolic parameters (https://github.com/ansible-collections/community.routeros/pull/63).api* modules - allow to set an encoding other than the default ASCII for communicating with the API (https://github.com/ansible-collections/community.routeros/pull/95).
Bugfixes
query - fix query function check for
.id
vs.id
arguments to not conflict with routeros arguments likeidentity
(https://github.com/ansible-collections/community.routeros/pull/68, https://github.com/ansible-collections/community.routeros/issues/67).quoting and unquoting filter plugins, api module - handle the escape sequence
\_
correctly as escaping a space and not an underscore (https://github.com/ansible-collections/community.routeros/pull/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
forquery
more strict (https://github.com/ansible-collections/community.routeros/pull/53).command - the
commands
andwait_for
options now convert the list elements to strings (https://github.com/ansible-collections/community.routeros/pull/55).facts - the
gather_subset
option now converts the list elements to strings (https://github.com/ansible-collections/community.routeros/pull/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 usefailed_when
to accept failure in specific circumstances, for examplefailed_when: "'failure: already have ' in result.msg[0]"
(https://github.com/ansible-collections/community.routeros/pull/39).api - splitting commands no longer uses a naive split by whitespace, but a more RouterOS CLI compatible splitting algorithm (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/50).
Bugfixes
api - improve splitting of
WHERE
queries (https://github.com/ansible-collections/community.routeros/pull/47).api - when converting result lists to dictionaries, no longer removes second
=
and text following that if present (https://github.com/ansible-collections/community.routeros/pull/47).routeros cliconf plugin - adjust function signature that was modified in Ansible after creation of this plugin (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/38).
api - add options
validate_certs
(default valuetrue
),validate_cert_hostname
(default valuefalse
), andca_path
to control certificate validation (https://github.com/ansible-collections/community.routeros/pull/37).api - rename option
ssl
totls
, and keep the old name as an alias (https://github.com/ansible-collections/community.routeros/pull/37).fact - add fact
ansible_net_config_nonverbose
to get idempotent config (no date, no verbose) (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/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 (https://github.com/ansible-collections/community.routeros/pull/18).facts - added support for a dash (
-
) in username (https://github.com/ansible-collections/community.routeros/pull/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 RouterOSid
configuration parameter (https://github.com/ansible-collections/community.routeros/pull/15).
v1.0.0
Release Summary
This is the first production (non-prerelease) release of community.routeros
.
Bugfixes
routeros terminal plugin - allow slashes in hostnames for terminal detection. Without this, slashes in hostnames will result in connection timeouts (https://github.com/ansible-collections/community.network/pull/138).
v0.1.1
Release Summary
Small improvements and bugfixes over the initial release.
Bugfixes
api - fix crash when the
ssl
parameter is used (https://github.com/ansible-collections/community.routeros/pull/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
facts - now also collecting data about BGP and OSPF (https://github.com/ansible-collections/community.network/pull/101).
facts - set configuration export on to verbose, for full configuration export (https://github.com/ansible-collections/community.network/pull/104).