Release 2.4.0.

2025-07-13 19:54:35 +02:00 · 2022-11-18 13:17:00 +01:00 · 2022-11-18 13:17:00 +01:00 · 14ba81ac60
commit 14ba81ac60
parent d1ff3b2730
17 changed files with 143 additions and 73 deletions
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@ -5,6 +5,50 @@ Community RouterOS Release Notes
 .. contents:: Topics


+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`` and ``interface 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`` and ``ip 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 path ``ip 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`` in ``ip 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 path ``interface ethernet`` (https://github.com/ansible-collections/community.routeros/pull/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 (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`` in ``ip route`` path (https://github.com/ansible-collections/community.routeros/pull/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`` (https://github.com/ansible-collections/community.routeros/pull/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 (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 path ``ipv6 firewall address-list`` (https://github.com/ansible-collections/community.routeros/pull/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 (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 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) (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 implemeted for ROS6 due to the significat changes between ROS6 and ROS7 (https://github.com/ansible-collections/community.routeros/pull/131).
+
 v2.3.1
 ======

--- a/changelogs/changelog.yaml
+++ b/changelogs/changelog.yaml
@ -255,3 +255,102 @@ releases:
    - 2.3.1.yml
    - command-check_mode.yml
    release_date: '2022-11-06'
+  2.4.0:
+    changes:
+      bugfixes:
+      - api_modify - ``ip route`` entry can be defined without the need of ``gateway``
+        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 path ``ipv6
+        firewall address-list`` (https://github.com/ansible-collections/community.routeros/pull/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 (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 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) (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 implemeted for ROS6 due to the significat changes between ROS6 and ROS7
+        (https://github.com/ansible-collections/community.routeros/pull/131).
+      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`` and ``interface
+        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`` and ``ip 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 path ``ip 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`` in ``ip 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 path ``interface ethernet`` (https://github.com/ansible-collections/community.routeros/pull/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 (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`` in ``ip route`` path
+        (https://github.com/ansible-collections/community.routeros/pull/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`` (https://github.com/ansible-collections/community.routeros/pull/122).
+      release_summary: Feature release improving the ``api*`` modules.
+    fragments:
+    - 120-api.yml
+    - 121-api.yml
+    - 122-api.yml
+    - 123-api.yml
+    - 124-api.yml
+    - 125-api.yml
+    - 126-api-capsman.yml
+    - 127-logging.yml
+    - 128-api.yml
+    - 129-api-ipsec.yml
+    - 130-api-modify-builtin.yml
+    - 131-api.yml
+    - 133-api.yml
+    - 134-command-safemode.yml
+    - 2.4.0.yml
+    release_date: '2022-11-18'
--- a/changelogs/fragments/120-api.yml
+++ b/changelogs/fragments/120-api.yml
@ -1,3 +0,0 @@
-minor_changes:
-  - api_modify, api_info - support API paths ``interface list`` and ``interface list member``
-    (https://github.com/ansible-collections/community.routeros/pull/120).
--- a/changelogs/fragments/121-api.yml
+++ b/changelogs/fragments/121-api.yml
@ -1,6 +0,0 @@
-minor_changes:
-  - 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`` (https://github.com/ansible-collections/community.routeros/pull/121).
-  - api_modify, api_info - support field ``hw-offload`` for path ``ip firewall filter``
-    (https://github.com/ansible-collections/community.routeros/pull/121).
--- a/changelogs/fragments/122-api.yml
+++ b/changelogs/fragments/122-api.yml
@ -1,4 +0,0 @@
-minor_changes:
-  - 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``
-    (https://github.com/ansible-collections/community.routeros/pull/122).
--- a/changelogs/fragments/123-api.yml
+++ b/changelogs/fragments/123-api.yml
@ -1,3 +0,0 @@
-minor_changes:
-  - api_modify, api_info - support API paths ``ip route`` and ``ip route vrf``
-    (https://github.com/ansible-collections/community.routeros/pull/123).
--- a/changelogs/fragments/124-api.yml
+++ b/changelogs/fragments/124-api.yml
@ -1,3 +0,0 @@
-minor_changes:
-  - api* modules - Add new option ``force_no_cert`` to connect with ADH ciphers
-    (https://github.com/ansible-collections/community.routeros/pull/124).
--- a/changelogs/fragments/125-api.yml
+++ b/changelogs/fragments/125-api.yml
@ -1,6 +0,0 @@
-minor_changes:
-  - 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).
-bugfixes:
-  - api_modify, api_info - the default of the field ``ingress-filtering`` in ``interface bridge port`` is now ``true``, which is the default in ROS
-    (https://github.com/ansible-collections/community.routeros/pull/125).
--- a/changelogs/fragments/126-api-capsman.yml
+++ b/changelogs/fragments/126-api-capsman.yml
@ -1,3 +0,0 @@
-minor_changes:
-  - 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).
--- a/changelogs/fragments/127-logging.yml
+++ b/changelogs/fragments/127-logging.yml
@ -1,3 +0,0 @@
-minor_changes:
-  - api_modify, api_info - support API paths ``system logging``, ``system logging action``
-    (https://github.com/ansible-collections/community.routeros/pull/127).
--- a/changelogs/fragments/128-api.yml
+++ b/changelogs/fragments/128-api.yml
@ -1,3 +0,0 @@
-minor_changes:
-  - 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).
--- a/changelogs/fragments/129-api-ipsec.yml
+++ b/changelogs/fragments/129-api-ipsec.yml
@ -1,3 +0,0 @@
-minor_changes:
-  - 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).
--- a/changelogs/fragments/130-api-modify-builtin.yml
+++ b/changelogs/fragments/130-api-modify-builtin.yml
@ -1,6 +0,0 @@
-minor_changes:
-  - 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).
-trivial:
-  - api_modify - ignore  ``builtin`` entries
-    (https://github.com/ansible-collections/community.routeros/pull/130).
--- a/changelogs/fragments/131-api.yml
+++ b/changelogs/fragments/131-api.yml
@ -1,15 +0,0 @@
-minor_changes:
-  - 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 for fields ``blackhole``, ``pref-src``, ``routing-table``, ``suppress-hw-offload``, ``type``, ``vrf-interface`` in ``ip route`` path
-    (https://github.com/ansible-collections/community.routeros/pull/131).
-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)
-    (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 implemeted for ROS6 due to the significat changes between ROS6 and ROS7
-    (https://github.com/ansible-collections/community.routeros/pull/131)."
-bugfixes:
-  - "api_modify - ``queue interface`` path works now
-    (https://github.com/ansible-collections/community.routeros/pull/131)."
-  - "api_modify - ``ip route`` entry can be defined without the need of ``gateway`` field, which is correct for unreachable/blackhole type of routes
-    (https://github.com/ansible-collections/community.routeros/pull/131)."
--- a/changelogs/fragments/133-api.yml
+++ b/changelogs/fragments/133-api.yml
@ -1,11 +0,0 @@
-minor_changes:
-  - 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 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
-    (https://github.com/ansible-collections/community.routeros/pull/133).
-  - 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
-    (https://github.com/ansible-collections/community.routeros/pull/133).
-
-bugfixes:
-  - api_modify, api_info - removed wrong field ``dynamic`` from API path ``ipv6 firewall address-list``
-    (https://github.com/ansible-collections/community.routeros/pull/133).
--- a/changelogs/fragments/134-command-safemode.yml
+++ b/changelogs/fragments/134-command-safemode.yml
@ -1,3 +0,0 @@
-bugfixes:
-  - "command, facts - commands do not timeout in safe mode anymore
-    (https://github.com/ansible-collections/community.routeros/pull/134)."
--- a/changelogs/fragments/2.4.0.yml
+++ b/changelogs/fragments/2.4.0.yml
@ -1 +0,0 @@
-release_summary: Feature release improving the ``api*`` modules.
				`@ -1 +0,0 @@`
				release_summary: Feature release improving the ``api*`` modules.