VhddlmZmZmZeZdZdZdZddl Z ddl m Z m Z ddl mZddlmZmZdd lmZd ZGd d eZd Zedk(reyy))absolute_importdivisionprint_functionaj module: cloudflare_dns author: - Michael Gruener (@mgruener) short_description: Manage Cloudflare DNS records description: - 'Manages DNS records using the Cloudflare API, see the docs: U(https://api.cloudflare.com/).' extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: api_token: description: - API token. - Required for API token authentication. - "You can obtain your API token from the bottom of the Cloudflare 'My Account' page, found here: U(https://dash.cloudflare.com/)." - Can be specified in E(CLOUDFLARE_TOKEN) environment variable since community.general 2.0.0. type: str version_added: '0.2.0' account_api_key: description: - Account API key. - Required for API keys authentication. - "You can obtain your API key from the bottom of the Cloudflare 'My Account' page, found here: U(https://dash.cloudflare.com/)." type: str aliases: [account_api_token] account_email: description: - Account email. Required for API keys authentication. type: str algorithm: description: - Algorithm number. - Required for O(type=DS) and O(type=SSHFP) when O(state=present). type: int cert_usage: description: - Certificate usage number. - Required for O(type=TLSA) when O(state=present). type: int choices: [0, 1, 2, 3] comment: description: - Comments or notes about the DNS record. type: str version_added: 10.1.0 flag: description: - Issuer Critical Flag. - Required for O(type=CAA) when O(state=present). type: int choices: [0, 1] version_added: 8.0.0 tag: description: - CAA issue restriction. - Required for O(type=CAA) when O(state=present). type: str choices: [issue, issuewild, iodef] version_added: 8.0.0 hash_type: description: - Hash type number. - Required for O(type=DS), O(type=SSHFP) and O(type=TLSA) when O(state=present). type: int choices: [1, 2] key_tag: description: - DNSSEC key tag. - Needed for O(type=DS) when O(state=present). type: int port: description: - Service port. - Required for O(type=SRV) and O(type=TLSA). type: int priority: description: - Record priority. - Required for O(type=MX) and O(type=SRV). default: 1 type: int proto: description: - Service protocol. Required for O(type=SRV) and O(type=TLSA). - Common values are TCP and UDP. type: str proxied: description: - Proxy through Cloudflare network or just use DNS. type: bool default: false record: description: - Record to add. - Required if O(state=present). - Default is V(@) (that is, the zone name). type: str default: '@' aliases: [name] selector: description: - Selector number. - Required for O(type=TLSA) when O(state=present). choices: [0, 1] type: int service: description: - Record service. - Required for O(type=SRV). type: str solo: description: - Whether the record should be the only one for that record type and record name. - Only use with O(state=present). - This will delete all other records with the same record name and type. type: bool state: description: - Whether the record(s) should exist or not. type: str choices: [absent, present] default: present tags: description: - Custom tags for the DNS record. type: list elements: str version_added: 10.1.0 timeout: description: - Timeout for Cloudflare API calls. type: int default: 30 ttl: description: - The TTL to give the new record. - Must be between V(120) and V(2,147,483,647) seconds, or V(1) for automatic. type: int default: 1 type: description: - The type of DNS record to create. Required if O(state=present). - Support for V(SPF) has been removed from community.general 9.0.0 since that record type is no longer supported by CloudFlare. type: str choices: [A, AAAA, CNAME, DS, MX, NS, SRV, SSHFP, TLSA, CAA, TXT] value: description: - The record value. - Required for O(state=present). type: str aliases: [content] weight: description: - Service weight. - Required for O(type=SRV). type: int default: 1 zone: description: - The name of the Zone to work with (for example V(example.com)). - The Zone must already exist. type: str required: true aliases: [domain] a - name: Create a test.example.net A record to point to 127.0.0.1 community.general.cloudflare_dns: zone: example.net record: test type: A value: 127.0.0.1 account_email: test@example.com account_api_key: dummyapitoken register: record - name: Create a record using api token community.general.cloudflare_dns: zone: example.net record: test type: A value: 127.0.0.1 api_token: dummyapitoken - name: Create a record with comment and tags community.general.cloudflare_dns: zone: example.net record: test type: A value: 127.0.0.1 comment: Local test website tags: - test - local api_token: dummyapitoken - name: Create a example.net CNAME record to example.com community.general.cloudflare_dns: zone: example.net type: CNAME value: example.com account_email: test@example.com account_api_key: dummyapitoken state: present - name: Change its TTL community.general.cloudflare_dns: zone: example.net type: CNAME value: example.com ttl: 600 account_email: test@example.com account_api_key: dummyapitoken state: present - name: Delete the record community.general.cloudflare_dns: zone: example.net type: CNAME value: example.com account_email: test@example.com account_api_key: dummyapitoken state: absent - name: Create a example.net CNAME record to example.com and proxy through Cloudflare's network community.general.cloudflare_dns: zone: example.net type: CNAME value: example.com proxied: true account_email: test@example.com account_api_key: dummyapitoken state: present # This deletes all other TXT records named "test.example.net" - name: Create TXT record "test.example.net" with value "unique value" community.general.cloudflare_dns: domain: example.net record: test type: TXT value: unique value solo: true account_email: test@example.com account_api_key: dummyapitoken state: present - name: Create an SRV record _foo._tcp.example.net community.general.cloudflare_dns: domain: example.net service: foo proto: tcp port: 3500 priority: 10 weight: 20 type: SRV value: fooserver.example.net - name: Create a SSHFP record login.example.com community.general.cloudflare_dns: zone: example.com record: login type: SSHFP algorithm: 4 hash_type: 2 value: 9dc1d6742696d2f51ca1f1a78b3d16a840f7d111eb9454239e70db31363f33e1 - name: Create a TLSA record _25._tcp.mail.example.com community.general.cloudflare_dns: zone: example.com record: mail port: 25 proto: tcp type: TLSA cert_usage: 3 selector: 1 hash_type: 1 value: 6b76d034492b493e15a7376fccd08e63befdad0edab8e442562f532338364bf3 - name: Create a CAA record subdomain.example.com community.general.cloudflare_dns: zone: example.com record: subdomain type: CAA flag: 0 tag: issue value: ca.example.com - name: Create a DS record for subdomain.example.com community.general.cloudflare_dns: zone: example.com record: subdomain type: DS key_tag: 5464 algorithm: 8 hash_type: 2 value: B4EB5AC4467D2DFB3BAF9FB9961DC1B6FED54A58CDFAA3E465081EC86F89BFAB a record: description: A dictionary containing the record data. returned: success, except on record deletion type: complex contains: comment: description: Comments or notes about the DNS record. returned: success type: str sample: Domain verification record version_added: 10.1.0 comment_modified_on: description: When the record comment was last modified. Omitted if there is no comment. returned: success type: str sample: "2024-01-01T05:20:00.12345Z" version_added: 10.1.0 content: description: The record content (details depend on record type). returned: success type: str sample: 192.0.2.91 created_on: description: The record creation date. returned: success type: str sample: "2016-03-25T19:09:42.516553Z" data: description: Additional record data. returned: success, if type is SRV, DS, SSHFP TLSA or CAA type: dict sample: { "name": "jabber", "port": 8080, "priority": 10, "proto": "_tcp", "service": "_xmpp", "target": "jabberhost.sample.com", "weight": 5 } id: description: The record ID. returned: success type: str sample: f9efb0549e96abcb750de63b38c9576e locked: description: No documentation available. returned: success type: bool sample: false meta: description: Extra Cloudflare-specific information about the record. returned: success type: dict sample: { "auto_added": false } modified_on: description: Record modification date. returned: success type: str sample: "2016-03-25T19:09:42.516553Z" name: description: The record name as FQDN (including _service and _proto for SRV). returned: success type: str sample: www.sample.com priority: description: Priority of the MX record. returned: success, if type is MX type: int sample: 10 proxiable: description: Whether this record can be proxied through Cloudflare. returned: success type: bool sample: false proxied: description: Whether the record is proxied through Cloudflare. returned: success type: bool sample: false tags: description: Custom tags for the DNS record. returned: success type: list elements: str sample: ['production', 'app'] version_added: 10.1.0 tags_modified_on: description: When the record tags were last modified. Omitted if there are no tags. returned: success type: str sample: "2025-01-01T05:20:00.12345Z" version_added: 10.1.0 ttl: description: The time-to-live for the record. returned: success type: int sample: 300 type: description: The record type. returned: success type: str sample: A zone_id: description: The ID of the zone containing the record. returned: success type: str sample: abcede0bf9f0066f94029d2e6b73856a zone_name: description: The name of the zone containing the record. returned: success type: str sample: sample.com N) AnsibleModule env_fallback) urlencode) to_nativeto_text) fetch_urlcFt|ts|S|jSN) isinstancestrlower)params t/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/cloudflare_dns.pylowercase_stringrs eS ! ;;=cNeZdZdZdZdZd dZd dZd dZd dZ dd Z d Z d Z y) CloudflareAPIz$https://api.cloudflare.com/client/v4Fc||_|jd|_|jd|_|jd|_|jd|_|jd|_|jd|_|jd|_|jd|_ |jd |_ |jd |_ |jd |_ |jd |_ |jd |_t|jd|_|jd|_|jd|_t|jd|_t|jd|_|jd|_|jd|_|jd|_|jd|_|jd|_|jd|_|jd|_t|jd|_|j&dk(r|j8|_|j2dvr:|j4.|j4j;dj=|_|j2dk(r+|j4|j4j=|_|j2dk(rv|j /|j j?d sd |j z|_|j(/|j(j?d sd |j(z|_|j2d!k(rd|j /|j j?d sd |j z|_|jd tA|jz|_ |j&jC|j8s!|j&dz|j8z|_|j2d"k(r7|j&|j8k(r|jjEd#$yyy)%N api_tokenaccount_api_key account_email algorithm cert_usagecomment hash_typeflagtagtagskey_tagportpriorityprotoproxiedselectorrecordservicesolostatetimeoutttltypevalueweightzone@)CNAMENSMXSRV.AAAAr6_TLSADSz$DS records only apply to subdomains.msg)#moduleparamsrrrrrrrrr r!r"r#r$rr%r&r'r(r)is_solor+r,r-r.r/r0r1rstripr startswithrendswith fail_json)selfr>s r__init__zCloudflareAPI.__init__sW {3%}}->?#]]?;{3 -- 5}}Y/ {3MM&) =='MM&) }}Y/ MM&)  j1 %fmmG&<= }}Y/  j1 &v}}X'>? ' i(@A }}V, ]]7+ }}Y/ =='MM&) ]]7+ mmH- $V]]6%:; ;;# ))DK II5 5DJJrDr r cf_api_endpointr,formatgetreadAttributeErrorloadsr getattr ValueError)rEapi_callrLpayloadrJrKerespinfo error_msgresultcontentr[ chain_errors r_cf_simple_api_callz!CloudflareAPI._cf_simple_api_calls >>!*T^^!; 2G !% 2 2"22 2G   bzz'*t{{#33h>'.$(&,'+|| 5 d >!I I KK ! !&^&e&efnptu}p~AEAIAIJOAP'Q ! R >S `gghlmuhvx~AIJI (^s "\ccdhiqdrtz}EFI (^s "Y``aefnaoqwzBCI (^s "ahhimnviwyBJKI (^s "\ccdhiqdrtz}EFI (^s "NUUVZ[cVdflnvwI iikGF|v,;;  pGG KK ! !i ! 0 F " :AA&**WBUV VI KK ! !i ! 0i , ,I) s6==eFmUS\M]^^  E)',]';s !%>%E%EkRXFY[fgp[q%rr s s KK ! !i ! 0tH~%%I b %%*QT]^_T`*`%aa bH G D"3Z@ pQXXYbcdYegnoo  psAJ/ K.2 L/ K+8(K&&K+. K=<K=ML<<Mc|j|||\}}|d}d|vr|d}|ddkDrt|ddz}dj|g} d|vrJ|jdd\} } | | jdD cgc]} | j dr| c} z } n|} ||dkrC| ddj | zz } |j| ||\}}||dz }|dz }||dkrC||fScc} w) Nrp result_info total_pagespagezpage={0}?&)rsintrcsplitrBjoin) rErjrLrkrprMrK pagination next_page parameters raw_api_callqueryrs r _cf_api_callzCloudflareAPI._cf_api_callVs.11(FGLh F " .J-(1, 6 23a7 (// :; (?*2..a*@'L%ekk#6F"gUeN^N^_eNf5"ggJ#+L:m#<< C#((:*>$>>L%)%=%=lFT[%\NFFF8,,DNI  :m#<< V|#hs =C/C/c4|s |j}|j|}t|dkDr+|jj dj |t|dkr+|jj dj ||ddS)NrwzMore than one zone matches {0}r<zNo zone found with name {0}rid)r1 get_zoneslenr>rDrc)rEr1zoness r _get_zone_idzCloudflareAPI._get_zone_idns99Dt$ u:> KK ! !&F&M&Md&S ! T u:> KK ! !&C&J&J4&P ! QQx~rcx|s |j}d}|rdtd|iz}|jd|z\}}|S)NrUrynamez/zones)r1rr)rErrrrMs rrzCloudflareAPI.get_zones{sG99D )VTN33E))(U*:; v rc8|s |j}|s |j}|s |j}|s| |j}|j }dj |}i}|r||d<|r||d<|r||d<|r|dt |zz }|j|\}} |S)N/zones/{0}/dns_recordsr.rrqry)r1r.r(r/rrcrr) rE zone_namer.r(r/zone_idrjrrecordsrMs rget_dns_recordszCloudflareAPI.get_dns_recordss I99D[[FE-JJE##%+227;  E&M "E&M $E)   i.. .H++H5rc i}dD]}||vr ||||<t||||< g}|d}|d}|ddk(rO|d1|ddk(s)t|ddzt|d zdz|dz}|d d z|d zd z|dz}n|dd k(rI|d|ddk(st|ddzt|dzdzt|dzdz|dz}n|ddk(rE|d|ddk(st|ddzt|dzdz|djz}ng|ddk(r_|dC|ddk(s;t|ddzt|dzdzt|dzdz|dz}|d d z|d zd z|dz}|drd}n|}|j|d}|j |d|d||}|D]} |drc| d|dk(r| d|k(r | d|k(r$d|_|j jrB|jdj|| dd\} } kd|_|j jr|jdj|| dd\} } |j S)N)r#r%r)r*r.r(r/r0r1rrrr'r"rr r/r(r.r6rUr0 r#r)r7r%r;r"rrSSHFP r:rr'r*r1rrqT/zones/{0}/dns_records/{1}rDELETE) rhrupperrrchangedr> check_moderrc) rEkwargsr?rrrq search_record search_valuerrrrprns rdelete_dns_recordsz CloudflareAPI.delete_dns_recordssgd 5E &u u 'e 4u  5/x( &>U "7O+vg"/DfX./$6VF^9LLtSV\]dVee"9-3fWoEKfU]N^^M F^t #7O+vg"/DfY/047#f[>Q:RRUYY\_`fgr`s\ttw{{EFMNN F^w &7O+vg"/Df[12S83vk?R;SSVYY\bcj\k\q\q\ss F^v %7O+vg"/Df\23d:S AS=TTW[[^abhitbu^vvy}}AGHOAPP"6NS06'?BSH6RZK[[M &>L"L##F6N3&&vf~vf~}Vbc wBf~Fvf~5BvJ-|ds|jjd|dd k(rd}|d|d|d|d d }|dd vr|d |d <|ddk(rJ|d|dfD]&}||dk(s |jjd(|d|d|d|d|d d}|ddk(r|d|d|d|d|d|dfD]&}||dk(s |jjd(|d|d|d|dd}|d|ddz|dzdz|dz|d |d}t|ddzt|dzdz|dz}|ddz|dzdz|dz}|ddk(r|d|d|d |dfD]&}||dk(s |jjd!(|d|d|d |dd"} |d|d| |d d#}t|ddzt|dzdzt|d zdz|dz}|dd$k(r|d|d |dfD]&}||dk(s |jjd%(|dj |d |dd&} |d|d| |d d#}t|dd'zt|d zd'z|dz}|dd(k(r|d|d|d)|d*|d |dfD]&}||dk(s |jjd+(|ddz|dzdz|dz}|d)|d*|d |dd,} |d|| |d d#}t|d)dzt|d*zdzt|d zdz|dz}|dd-k(rX|d.|d/|dfD]&}||dk(s |jjd0(|d.|d/|dd1} |d|d| |d d#}d}|d2xsd|d2<|d3xsg|d3<|j |d4} |j |d4|d||}t|d5kDrh|dd-k(rD|D]>}|d6d7 d7k(s|d6d/| d/k(s!|d6d| dk(s0||jfcSn|jjd8t|d5k(r|d9}d:}|d  |d |d k7rd;}|dd|vr |d|dk7rd;}d |vrd |vr |d |d k7rd;}d6|vrd6|vr |d6|d6k7rd;}|dd k(r |d<|d<k7rd;}|d2|d2k7rd;}t|d3t|d3k7rd;}|rZ|jjr|}n,|jd=j| |d9d>d?|\}}d;|_||jfS||jfS|jjr|}n%|jd@j| dA|\}}d;|_||jfS)BN)r#r$r%r&r)r-r.r(r/r0r1rrrr'r"rr r!rr/r(r.z;You must provide a type and a record to create a new recordr<)Ar8r3TXTr5r4z=You must provide a non-empty value to create this record typer3r-)r.rrqr-)rr8r3r&r5r$rUz@You must provide priority and a value to create this record type)r.rrqr$r-r6r#r%r)r0z^You must provide port, priority, proto, service, weight and a value to create this record type)targetr#r0r$r7)r.rr-rKrr;r"rrzUYou must provide key_tag, algorithm, hash_type and a value to create this record type)r"r digest_typedigest)r.rrKr-rzLYou must provide algorithm, hash_type and a value to create this record type) fingerprintr.rrr:rr'zdYou must provide port, proto, cert_usage, selector, hash_type and a value to create this record type)usager' matching_type certificateCAArr zAYou must provide flag, tag and a value to create this record type)flagsr r/rr!r1rwrKrznMore than one record already exists for the given attributes. That should be impossible, please open an issue!rFTrqrrPUTrPOST) rhr>rDrrrrrrsortedrrrc)rErr?rrr new_recordattrsrv_datads_data sshfp_data tlsa_datacaa_datarrr cur_record do_updaterprns rensure_dns_recordzCloudflareAPI.ensure_dns_recordsi w 5E &u u 'e 4u  5g x(  6N "x(8(@ KK ! !&c ! d 6NG G'? %%*i%j f~(# vx(!'?e} J 6N4 4$*9$5Jy ! &>T ! +VG_= rLdbjKK)).p)q rvx(!'?":.e} J &>U " );VG_fU^N_aghpaqsy{BtCD PLdbjKK))/O)P P!/v *":. Hvy)C/&/ACG&QYJZZe} J vh/047#fVn:MMPTTW]^eWffL"9-3fWoEKfU]N^^M &>T ! *F;,? ATV\]dVef GLdbjKK))/F)G G"),#K0%k2 / Gvx(e} J vi01D83vk?R;SSVZZ]`aghsat]uux||@FGN@OOL &>W $ ,f[.A6'?S ~LdbjKK)).|)} ~ &g446{+#K0J vx("e} J vk23c9C{@SV #&:NPVWaPbdjkvdwyAHzIJ VLdbjKK))/U)V V#6NS06'?BSH6RZK[[M -":.!' !4%g Iv%!e} J vl34t;c&BT>UUX\\_bcijucv_wwz~~BHIPBQQL &>U "wH sLdbjKK)).q)r s e}H vx( e} J  L &y 1 9T 9#F^1r 6##F6N3&&vf~vf~}Vbc wd"dgfd3d?ddgfg@}|jds0|jdr|jd s|j dAB|jd3d=k(r|jd80|jd!|jd5|jd5dCk(rQ|jd80|jd!|jd5$|jd5dCk(s|j dDB|jd3dEk(r|jd 0|jd!|jd5|jd5dCk(rQ|jd 0|jd!|jd5$|jd5dCk(s|j dFB|jd3d>k(r|jd?|jd)0|jd!|jd5|jd5dCk(r`|jd?|jd)0|jd!|jd5$|jd5dCk(s|j dGB|jd3d?k(r|jd0|jd!|jd5|jd5dCk(rQ|jd0|jd!|jd5$|jd5dCk(s|j dHB|jd3dIk(r|jd?|jd 0|jd!|jd5|jd5dCk(r`|jd?|jd 0|jd!|jd5$|jd5dCk(s|j dJBd}t |}|j r!|jd.k(r|j dKB|jd-k(ry|j r|j|j L}|j\}}t|tr|j|d%|diM|j|d%|iMy|jdL}|j|Ny)PNrrFTCLOUDFLARE_TOKEN)r.requiredno_logfallbackraccount_api_token)r.rraliasesr)r.rrr{)r.r)rrw)r.choicesrrrwrr")r.rr#rrr )issue issuewildiodefr!list)r.elementsr$)r.defaultr%r&boolr(r2r)r.rrr'r)r*r+presentabsent)r.rrr,r-r.) rr8r3r;r5r4r6rr:rrr/rq)r.rr0r1domain)r.rr)r(r.r/r6r:r) argument_specsupports_check_mode required_ifzJEither api_token or account_api_key and account_email params are required.r<rUzXFor SRV records the params weight, port and value all need to be defined, or not at all.rzbFor SSHFP records the params algorithm, hash_type and value all need to be defined, or not at all.zlFor TLSA records the params cert_usage, selector, hash_type and value all need to be defined, or not at all.zUFor CAA records the params flag, tag and value all need to be defined, or not at all.r;zhFor DS records the params key_tag, algorithm, hash_type and value all need to be defined, or not at all.z-solo=true can only be used with state=present)r*)rrp)rr) rdictrr?rDrr@r+rrrr exit_json)r>rcf_apirps rmainrs   &);(<=   !eeDSfRgh  EE:  &   =  e$  1v6  eE2  5!  51a&1  %)HI!  "6E2#  $ua0%  &E"'  (fe4)  *UC&B+  ,uq!f5-  .e$/  06"1  2E9x>ST3  4eR05  6%+7  85*xy9  :EI;7;  <UA.=  >54(D?  B! i!< = h + UWi0 1 Vgv. / UVUO ,  G*FX == %v}}=N/OTZTaTabqTrij }}V%x(4v9N9Z --08FMM'>//V^^/DG 224 fd #   Whq 5J  K(F1CD+++7)r__main__) __future__rrrr. __metaclass__ DOCUMENTATIONEXAMPLESRETURNr_ansible.module_utils.basicrr+ansible.module_utils.six.moves.urllib.parser+ansible.module_utils.common.text.convertersr r ansible.module_utils.urlsr robjectrrrrrrrsnA@ j XC Jv p BAJ/ G$FG$Tg*T zFr