fix: detect rfc5424 changes on existing syslog destinations (#436)

rfc5424 was in FIELDS_ALL but not FIELDS_CHANGE. update() (base module)
only compares FIELDS_CHANGE to detect drift, so flipping rfc5424 on an
existing destination yielded changed=False and no API POST — the setting
silently no-oped and had to be applied by hand in the GUI. The POST
payload builder iterates FIELDS_ALL and already included rfc5424, so the
value applied once some other change triggered an update; the gap was
purely change detection.

Add rfc5424 to FIELDS_CHANGE (and drop it from the FIELDS_ALL literal,
since FIELDS_ALL extends FIELDS_CHANGE) so a standalone rfc5424 change is
detected. The OPNsense Syslog model stores rfc5424 as a BooleanField
returned by the API, so detection reads the real current value and stays
idempotent; drop the stale "not getting current value from response"
comment that claimed otherwise. Add a change-detection/idempotency
regression to tests/syslog.yml.

Assisted-By: Claude <noreply@anthropic.com>

Author: ovv

plugins/module_utils/main/syslog.py

@@ -23,9 +23,9 @@ class Syslog(BaseModule):
     API_CONT_REL = 'service'
     FIELDS_CHANGE = [
         'target', 'transport', 'facility', 'program', 'level', 'certificate',
-        'port', 'description',
+        'port', 'description', 'rfc5424',
     ]
-    FIELDS_ALL = ['rfc5424', 'enabled']
+    FIELDS_ALL = ['enabled']
     FIELDS_ALL.extend(FIELDS_CHANGE)
     FIELDS_TRANSLATE = {
         'target': 'hostname',

plugins/modules/syslog.py

@@ -54,7 +54,7 @@ def run_module():
             ],
         ),
         certificate=dict(type='str', required=False, aliases=['cert']),
-        rfc5424=dict(type='bool', required=False, default=False),  # not getting current value from response
+        rfc5424=dict(type='bool', required=False, default=False),
         description=dict(type='str', required=False, aliases=['desc']),
         match_fields=dict(
             type='list', required=False, elements='str',

tests/syslog.yml

@@ -107,6 +107,39 @@
         not opn8.changed
       when: not ansible_check_mode
 
+    - name: Enabling rfc5424 on 1
+      oxlorg.opnsense.syslog:
+        description: 'ANSIBLE_TEST_1'
+        target: '192.168.0.1'
+        rfc5424: true
+      register: opn12
+      failed_when: >
+        opn12.failed or
+        not opn12.changed
+      when: not ansible_check_mode
+
+    - name: Enabling rfc5424 on 1 - nothing changed
+      oxlorg.opnsense.syslog:
+        description: 'ANSIBLE_TEST_1'
+        target: '192.168.0.1'
+        rfc5424: true
+      register: opn13
+      failed_when: >
+        opn13.failed or
+        opn13.changed
+      when: not ansible_check_mode
+
+    - name: Disabling rfc5424 on 1
+      oxlorg.opnsense.syslog:
+        description: 'ANSIBLE_TEST_1'
+        target: '192.168.0.1'
+        rfc5424: false
+      register: opn14
+      failed_when: >
+        opn14.failed or
+        not opn14.changed
+      when: not ansible_check_mode
+
     - name: Listing
       oxlorg.opnsense.list:
       register: opn1