Creating a new DNS entry

[lnxbil]

Hi everyone,

I just started to evaluate OPNsense and its automation ability today and ran into this problem I really don't understand. I have you can give me some pointer to debug it further and find out why it's not working:

PLAY [localhost] ***************************************************************************************************************************************************************************************

TASK [Listing] *****************************************************************************************************************************************************************************************
[WARNING]: REQUEST: GET | URL: https://192.168.1.71/api/unbound/settings/get
[WARNING]: RESPONSE: '{'status_code': 200, '_request': <Request('GET', 'https://192.168.1.71/api/unbound/settings/get')>, '_num_bytes_downloaded': 5698, '_elapsed':
datetime.timedelta(microseconds=73866), '_content': b'{"unbound":{"general":{"enabled":"1","port":"53","stats":"1","active_interface":{"lan":{"value":"LAN","selected":0},"wan":{"value":"WAN","selecte
d":0}},"dnssec":"0","dns64":"0","dns64prefix":"","noarecords":"0","regdhcp":"0","regdhcpdomain":"","regdhcpstatic":"0","noreglladdr6":"0","noregrecords":"0","txtsupport":"1","cacheflush":"0","local_z
one_type":{"transparent":{"value":"transparent","selected":1},"always_nxdomain":{"value":"always_nxdomain","selected":0},"always_refuse":{"value":"always_refuse","selected":0},"always_transparent":{"
value":"always_transparent","selected":0},"deny":{"value":"deny","selected":0},"inform":{"value":"inform","selected":0},"inform_deny":{"value":"inform_deny","selected":0},"nodefault":{"value":"nodefa
ult","selected":0},"refuse":{"value":"refuse","selected":0},"static":{"value":"static","selected":0},"typetransparent":{"value":"typetransparent","selected":0}},"outgoing_interface":{"lan":{"value":"
LAN","selected":0},"wan":{"value":"WAN","selected":0}},"enable_wpad":"0"},"advanced":{"hideidentity":"","hideversion":"","prefetch":"","prefetchkey":"","dnssecstripped":"","aggressivensec":"1","serve
expired":"","serveexpiredreplyttl":"","serveexpiredttl":"","serveexpiredttlreset":"","serveexpiredclienttimeout":"","qnameminstrict":"","extendedstatistics":"","logqueries":"","logreplies":"","logtag
queryreply":"","logservfail":"","loglocalactions":"","logverbosity":[{"value":"Level 0","selected":0},{"value":"Level 1 (Default)","selected":1},{"value":"Level 2","selected":0},{"value":"Level
3","selected":0},{"value":"Level 4","selected":0},{"value":"Level 5","selected":0}],"valloglevel":[{"value":"Level 0 (Default)","selected":1},{"value":"Level 1","selected":0},{"value":"Level 2","sele
cted":0}],"privatedomain":[],"privateaddress":{"0.0.0.0\\/8":{"value":"0.0.0.0\\/8","selected":1},"10.0.0.0\\/8":{"value":"10.0.0.0\\/8","selected":1},"100.64.0.0\\/10":{"value":"100.64.0.0\\/10","se
lected":1},"169.254.0.0\\/16":{"value":"169.254.0.0\\/16","selected":1},"172.16.0.0\\/12":{"value":"172.16.0.0\\/12","selected":1},"192.0.2.0\\/24":{"value":"192.0.2.0\\/24","selected":1},"192.168.0.
0\\/16":{"value":"192.168.0.0\\/16","selected":1},"198.18.0.0\\/15":{"value":"198.18.0.0\\/15","selected":1},"198.51.100.0\\/24":{"value":"198.51.100.0\\/24","selected":1},"203.0.113.0\\/24":{"value"
:"203.0.113.0\\/24","selected":1},"233.252.0.0\\/24":{"value":"233.252.0.0\\/24","selected":1},"::1\\/128":{"value":"::1\\/128","selected":1},"2001:db8::\\/32":{"value":"2001:db8::\\/32","selected":1
},"fc00::\\/8":{"value":"fc00::\\/8","selected":1},"fd00::\\/8":{"value":"fd00::\\/8","selected":1},"fe80::\\/10":{"value":"fe80::\\/10","selected":1}},"insecuredomain":[],"msgcachesize":"","rrsetcac
hesize":"","outgoingnumtcp":"","incomingnumtcp":"","numqueriesperthread":"","outgoingrange":"","jostletimeout":"","cachemaxttl":"","cachemaxnegativettl":"","cacheminttl":"","infrahostttl":"","infrake
epprobing":"","infracachenumhosts":"","unwantedreplythreshold":""},"acls":{"default_action":{"allow":{"value":"Allow","selected":1},"deny":{"value":"Deny","selected":0},"refuse":{"value":"Refuse","se
lected":0}},"acl":[]},"dnsbl":{"enabled":"0","safesearch":"","type":{"atf":{"value":"Abuse.ch - ThreatFox IOC database","selected":0},"oisd0":{"value":"OISD - Domain Blocklist
Ads","selected":0},"oisd1":{"value":"OISD - Domain Blocklist Big","selected":0},"oisd2":{"value":"OISD - Domain Blocklist NSFW","selected":0},"aa":{"value":"AdAway
List","selected":0},"ag":{"value":"AdGuard List","selected":0},"bla0":{"value":"Blocklist.site Abuse","selected":0},"bla":{"value":"Blocklist.site Ads","selected":0},"blc":{"value":"Blocklist.site
Crypto","selected":0},"bld":{"value":"Blocklist.site Drugs","selected":0},"blf":{"value":"Blocklist.site Fraud","selected":0},"blf0":{"value":"Blocklist.site
Facebook","selected":0},"blg":{"value":"Blocklist.site Gambling","selected":0},"blm":{"value":"Blocklist.site Malware","selected":0},"blp":{"value":"Blocklist.site
Phishing","selected":0},"blp0":{"value":"Blocklist.site Piracy","selected":0},"blp1":{"value":"Blocklist.site Porn","selected":0},"blr":{"value":"Blocklist.site
Ransomware","selected":0},"blr0":{"value":"Blocklist.site Redirect","selected":0},"bls":{"value":"Blocklist.site Scam","selected":0},"blt":{"value":"Blocklist.site
Tiktok","selected":0},"blt0":{"value":"Blocklist.site Torrent","selected":0},"blt1":{"value":"Blocklist.site Tracking","selected":0},"bly":{"value":"Blocklist.site
Youtube","selected":0},"el":{"value":"EasyList","selected":0},"ep":{"value":"EasyPrivacy","selected":0},"nc":{"value":"NoCoin List","selected":0},"pa":{"value":"All Porn
List","selected":0},"pt":{"value":"PornTop1M List","selected":0},"sa":{"value":"Simple Ad List","selected":0},"st":{"value":"Simple Tracker List","selected":0},"sb":{"value":"Steven Black
List","selected":0},"ws":{"value":"WindowsSpyBlocker (spy)","selected":0},"wsu":{"value":"WindowsSpyBlocker (update)","selected":0},"wse":{"value":"WindowsSpyBlocker
(extra)","selected":0},"yy":{"value":"YoYo List","selected":0}},"lists":[],"whitelists":[],"blocklists":[],"wildcards":[],"address":"","nxdomain":""},"forwarding":{"enabled":""},"dots":{"dot":[]},"ho
sts":{"host":{"8a14d511-edb7-4f12-9e1a-958d2ab043ba":{"enabled":"1","hostname":"host2","domain":"example.com","rr":{"A":{"value":"A (IPv4 address)","selected":1},"AAAA":{"value":"AAAA (IPv6
address)","selected":0},"MX":{"value":"MX (Mail server)","selected":0}},"mxprio":"","mx":"","server":"192.168.1.2","description":"host2.example.com"}}},"aliases":{"alias":[]},"domains":{"domain":{"9e
9ec600-b06c-459b-83aa-2843b6013bb9":{"enabled":"1","domain":"example.com","server":"192.168.1.1","forward_tcp_upstream":"0","description":""}}}}}'}'
ok: [localhost]

TASK [Printing hosts] **********************************************************************************************************************************************************************************
ok: [localhost] => {
    "existing_entries.data": [
        {
            "description": "host2.example.com",
            "domain": "example.com",
            "enabled": true,
            "hostname": "host2",
            "mx": "",
            "mxprio": "",
            "prio": "",
            "record_type": "A",
            "server": "192.168.1.2",
            "uuid": "8a14d511-edb7-4f12-9e1a-958d2ab043ba",
            "value": "192.168.1.2"
        }
    ]
}

TASK [Adding] ******************************************************************************************************************************************************************************************
[WARNING]: RESPONSE: '{'status_code': 200, '_request': <Request('GET', 'https://192.168.1.71/api/unbound/settings/get')>, '_num_bytes_downloaded': 5698, '_elapsed':
datetime.timedelta(microseconds=65660), '_content': b'{"unbound":{"general":{"enabled":"1","port":"53","stats":"1","active_interface":{"lan":{"value":"LAN","selected":0},"wan":{"value":"WAN","selecte
d":0}},"dnssec":"0","dns64":"0","dns64prefix":"","noarecords":"0","regdhcp":"0","regdhcpdomain":"","regdhcpstatic":"0","noreglladdr6":"0","noregrecords":"0","txtsupport":"1","cacheflush":"0","local_z
one_type":{"transparent":{"value":"transparent","selected":1},"always_nxdomain":{"value":"always_nxdomain","selected":0},"always_refuse":{"value":"always_refuse","selected":0},"always_transparent":{"
value":"always_transparent","selected":0},"deny":{"value":"deny","selected":0},"inform":{"value":"inform","selected":0},"inform_deny":{"value":"inform_deny","selected":0},"nodefault":{"value":"nodefa
ult","selected":0},"refuse":{"value":"refuse","selected":0},"static":{"value":"static","selected":0},"typetransparent":{"value":"typetransparent","selected":0}},"outgoing_interface":{"lan":{"value":"
LAN","selected":0},"wan":{"value":"WAN","selected":0}},"enable_wpad":"0"},"advanced":{"hideidentity":"","hideversion":"","prefetch":"","prefetchkey":"","dnssecstripped":"","aggressivensec":"1","serve
expired":"","serveexpiredreplyttl":"","serveexpiredttl":"","serveexpiredttlreset":"","serveexpiredclienttimeout":"","qnameminstrict":"","extendedstatistics":"","logqueries":"","logreplies":"","logtag
queryreply":"","logservfail":"","loglocalactions":"","logverbosity":[{"value":"Level 0","selected":0},{"value":"Level 1 (Default)","selected":1},{"value":"Level 2","selected":0},{"value":"Level
3","selected":0},{"value":"Level 4","selected":0},{"value":"Level 5","selected":0}],"valloglevel":[{"value":"Level 0 (Default)","selected":1},{"value":"Level 1","selected":0},{"value":"Level 2","sele
cted":0}],"privatedomain":[],"privateaddress":{"0.0.0.0\\/8":{"value":"0.0.0.0\\/8","selected":1},"10.0.0.0\\/8":{"value":"10.0.0.0\\/8","selected":1},"100.64.0.0\\/10":{"value":"100.64.0.0\\/10","se
lected":1},"169.254.0.0\\/16":{"value":"169.254.0.0\\/16","selected":1},"172.16.0.0\\/12":{"value":"172.16.0.0\\/12","selected":1},"192.0.2.0\\/24":{"value":"192.0.2.0\\/24","selected":1},"192.168.0.
0\\/16":{"value":"192.168.0.0\\/16","selected":1},"198.18.0.0\\/15":{"value":"198.18.0.0\\/15","selected":1},"198.51.100.0\\/24":{"value":"198.51.100.0\\/24","selected":1},"203.0.113.0\\/24":{"value"
:"203.0.113.0\\/24","selected":1},"233.252.0.0\\/24":{"value":"233.252.0.0\\/24","selected":1},"::1\\/128":{"value":"::1\\/128","selected":1},"2001:db8::\\/32":{"value":"2001:db8::\\/32","selected":1
},"fc00::\\/8":{"value":"fc00::\\/8","selected":1},"fd00::\\/8":{"value":"fd00::\\/8","selected":1},"fe80::\\/10":{"value":"fe80::\\/10","selected":1}},"insecuredomain":[],"msgcachesize":"","rrsetcac
hesize":"","outgoingnumtcp":"","incomingnumtcp":"","numqueriesperthread":"","outgoingrange":"","jostletimeout":"","cachemaxttl":"","cachemaxnegativettl":"","cacheminttl":"","infrahostttl":"","infrake
epprobing":"","infracachenumhosts":"","unwantedreplythreshold":""},"acls":{"default_action":{"allow":{"value":"Allow","selected":1},"deny":{"value":"Deny","selected":0},"refuse":{"value":"Refuse","se
lected":0}},"acl":[]},"dnsbl":{"enabled":"0","safesearch":"","type":{"atf":{"value":"Abuse.ch - ThreatFox IOC database","selected":0},"oisd0":{"value":"OISD - Domain Blocklist
Ads","selected":0},"oisd1":{"value":"OISD - Domain Blocklist Big","selected":0},"oisd2":{"value":"OISD - Domain Blocklist NSFW","selected":0},"aa":{"value":"AdAway
List","selected":0},"ag":{"value":"AdGuard List","selected":0},"bla0":{"value":"Blocklist.site Abuse","selected":0},"bla":{"value":"Blocklist.site Ads","selected":0},"blc":{"value":"Blocklist.site
Crypto","selected":0},"bld":{"value":"Blocklist.site Drugs","selected":0},"blf":{"value":"Blocklist.site Fraud","selected":0},"blf0":{"value":"Blocklist.site
Facebook","selected":0},"blg":{"value":"Blocklist.site Gambling","selected":0},"blm":{"value":"Blocklist.site Malware","selected":0},"blp":{"value":"Blocklist.site
Phishing","selected":0},"blp0":{"value":"Blocklist.site Piracy","selected":0},"blp1":{"value":"Blocklist.site Porn","selected":0},"blr":{"value":"Blocklist.site
Ransomware","selected":0},"blr0":{"value":"Blocklist.site Redirect","selected":0},"bls":{"value":"Blocklist.site Scam","selected":0},"blt":{"value":"Blocklist.site
Tiktok","selected":0},"blt0":{"value":"Blocklist.site Torrent","selected":0},"blt1":{"value":"Blocklist.site Tracking","selected":0},"bly":{"value":"Blocklist.site
Youtube","selected":0},"el":{"value":"EasyList","selected":0},"ep":{"value":"EasyPrivacy","selected":0},"nc":{"value":"NoCoin List","selected":0},"pa":{"value":"All Porn
List","selected":0},"pt":{"value":"PornTop1M List","selected":0},"sa":{"value":"Simple Ad List","selected":0},"st":{"value":"Simple Tracker List","selected":0},"sb":{"value":"Steven Black
List","selected":0},"ws":{"value":"WindowsSpyBlocker (spy)","selected":0},"wsu":{"value":"WindowsSpyBlocker (update)","selected":0},"wse":{"value":"WindowsSpyBlocker
(extra)","selected":0},"yy":{"value":"YoYo List","selected":0}},"lists":[],"whitelists":[],"blocklists":[],"wildcards":[],"address":"","nxdomain":""},"forwarding":{"enabled":""},"dots":{"dot":[]},"ho
sts":{"host":{"8a14d511-edb7-4f12-9e1a-958d2ab043ba":{"enabled":"1","hostname":"host2","domain":"example.com","rr":{"A":{"value":"A (IPv4 address)","selected":1},"AAAA":{"value":"AAAA (IPv6
address)","selected":0},"MX":{"value":"MX (Mail server)","selected":0}},"mxprio":"","mx":"","server":"192.168.1.2","description":"host2.example.com"}}},"aliases":{"alias":[]},"domains":{"domain":{"9e
9ec600-b06c-459b-83aa-2843b6013bb9":{"enabled":"1","domain":"example.com","server":"192.168.1.1","forward_tcp_upstream":"0","description":""}}}}}'}'
[WARNING]: NOT MATCHING: 'host2.example.com' != 'host.example.com'
[WARNING]: REQUEST: POST | URL: https://192.168.1.71/api/unbound/settings/addHostOverride | HEADERS: '{'Content-Type': 'application/json'}' | DATA: '{"host": {"enabled": 1, "hostname": "host",
"domain": "example.com", "rr": "A", "description": "host.example.com", "server": "192.168.1.1"}}'
[WARNING]: RESPONSE: '{'status_code': 200, '_request': <Request('POST', 'https://192.168.1.71/api/unbound/settings/addHostOverride')>, '_num_bytes_downloaded': 19, '_elapsed':
datetime.timedelta(microseconds=23927), '_content': b'{"result":"failed"}'}'
fatal: [localhost]: FAILED! => {"changed": false, "msg": "API call failed | Response: {'status_code': 200, 'headers': Headers({'expires': 'Thu, 19 Nov 1981 08:52:00 GMT', 'cache-control': 'no-store, no-cache, must-revalidate', 'pragma': 'no-cache', 'content-type': 'application/json; charset=UTF-8', 'transfer-encoding': 'chunked', 'date': 'Sat, 09 Nov 2024 17:38:15 GMT', 'server': 'OPNsense'}), '_request': <Request('POST', 'https://192.168.1.71/api/unbound/settings/addHostOverride')>, 'next_request': None, 'extensions': {'http_version': b'HTTP/1.1', 'reason_phrase': b'OK', 'network_stream': <httpcore._backends.sync.SyncStream object at 0xffff937ed670>}, 'history': [], 'is_closed': True, 'is_stream_consumed': True, 'default_encoding': 'utf-8', 'stream': <httpx._client.BoundSyncStream object at 0xffff9305e6f0>, '_num_bytes_downloaded': 19, '_decoder': <httpx._decoders.IdentityDecoder object at 0xffff9305e5d0>, '_elapsed': datetime.timedelta(microseconds=23927), '_content': b'{\"result\":\"failed\"}'}"}

PLAY RECAP *********************************************************************************************************************************************************************************************
localhost                  : ok=2    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

with this playbook (straight from the example section of the documentation with local adaptation):

---

- hosts: localhost
  gather_facts: false
  module_defaults:
    group/ansibleguy.opnsense.all:
      firewall: '192.168.1.71'
      api_credential_file: 'credentials'
      ssl_verify: false
      debug: true

    ansibleguy.opnsense.unbound_host:
      match_fields: ['description']

    ansibleguy.opnsense.list:
      target: 'unbound_host'

  tasks:
    - name: Listing
      ansibleguy.opnsense.list:
      #  target: 'unbound_host'
      register: existing_entries

    - name: Printing hosts
      ansible.builtin.debug:
        var: existing_entries.data

    - name: Adding
      ansibleguy.opnsense.unbound_host:
        hostname: 'host'
        domain: 'example.com'
        value: '192.168.1.1'
        description: 'host.example.com'
        reload: false

[lnxbil]

After updating OPNsense, the error went away, so it had nothing to do with ansible.

[lnxbil]

Just for anyone else stumbling on this. I used 24.7 iso to install and updated to 24.7.8 yesterday