D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
saltstack
/
salt
/
lib
/
python3.10
/
site-packages
/
salt
/
modules
/
Filename :
namecheap_domains_dns.py
back
Copy
""" Namecheap DNS Management .. versionadded:: 2017.7.0 Prerequisites ------------- This module uses the ``requests`` Python module to communicate to the namecheap API. Configuration ------------- The Namecheap username, API key and URL should be set in the minion configuration file, or in the Pillar data. .. code-block:: yaml namecheap.name: companyname namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3 namecheap.client_ip: 162.155.30.172 #Real url namecheap.url: https://api.namecheap.com/xml.response #Sandbox url #namecheap.url: https://api.sandbox.namecheap.xml.response """ CAN_USE_NAMECHEAP = True try: import salt.utils.namecheap except ImportError: CAN_USE_NAMECHEAP = False __virtualname__ = "namecheap_domains_dns" def __virtual__(): """ Check to make sure requests and xml are installed and requests """ if CAN_USE_NAMECHEAP: return "namecheap_domains_dns" return False def get_hosts(sld, tld): """ Retrieves DNS host record settings for the requested domain. returns a dictionary of information about the requested domain sld SLD of the domain name tld TLD of the domain name CLI Example: .. code-block:: bash salt 'my-minion' namecheap_domains_dns.get_hosts sld tld """ opts = salt.utils.namecheap.get_opts("namecheap.domains.dns.gethosts") opts["TLD"] = tld opts["SLD"] = sld response_xml = salt.utils.namecheap.get_request(opts) if response_xml is None: return {} domaindnsgethostsresult = response_xml.getElementsByTagName( "DomainDNSGetHostsResult" )[0] return salt.utils.namecheap.xml_to_dict(domaindnsgethostsresult) def get_list(sld, tld): """ Gets a list of DNS servers associated with the requested domain. returns a dictionary of information about requested domain sld SLD of the domain name tld TLD of the domain name CLI Example: .. code-block:: bash salt 'my-minion' namecheap_domains_dns.get_list sld tld """ opts = salt.utils.namecheap.get_opts("namecheap.domains.dns.getlist") opts["TLD"] = tld opts["SLD"] = sld response_xml = salt.utils.namecheap.get_request(opts) if response_xml is None: return {} domaindnsgetlistresult = response_xml.getElementsByTagName( "DomainDNSGetListResult" )[0] return salt.utils.namecheap.xml_to_dict(domaindnsgetlistresult) def set_hosts(sld, tld, hosts): """ Sets DNS host records settings for the requested domain. returns True if the host records were set successfully sld SLD of the domain name tld TLD of the domain name hosts Must be passed as a list of Python dictionaries, with each dictionary containing the following keys: - **hostname** - **recordtype** - One of ``A``, ``AAAA``, ``CNAME``, ``MX``, ``MXE``, ``TXT``, ``URL``, ``URL301``, or ``FRAME`` - **address** - URL or IP address - **ttl** - An integer between 60 and 60000 (default: ``1800``) Additionally, the ``mxpref`` key can be present, but must be accompanied by an ``emailtype`` key. CLI Example: .. code-block:: bash salt 'my-minion' namecheap_domains_dns.set_hosts sld tld hosts """ opts = salt.utils.namecheap.get_opts("namecheap.domains.dns.setHosts") opts["SLD"] = sld opts["TLD"] = tld i = 1 for hostrecord in hosts: str_i = str(i) opts["HostName" + str_i] = hostrecord["hostname"] opts["RecordType" + str_i] = hostrecord["recordtype"] opts["Address" + str_i] = hostrecord["address"] if "ttl" in hostrecord: opts["TTL" + str_i] = hostrecord["ttl"] if "mxpref" in hostrecord: opts["MXPref" + str_i] = hostrecord["mxpref"] opts["EmailType"] = hostrecord["emailtype"] i += 1 response_xml = salt.utils.namecheap.post_request(opts) if response_xml is None: return False dnsresult = response_xml.getElementsByTagName("DomainDNSSetHostsResult")[0] return salt.utils.namecheap.string_to_value(dnsresult.getAttribute("IsSuccess")) def set_custom(sld, tld, nameservers): """ Sets domain to use custom DNS servers. returns True if the custom nameservers were set successfully sld SLD of the domain name tld TLD of the domain name nameservers array of strings List of nameservers to be associated with this domain CLI Example: .. code-block:: bash salt 'my-minion' namecheap_domains_dns.set_custom sld tld nameserver """ opts = salt.utils.namecheap.get_opts("namecheap.domains.dns.setCustom") opts["SLD"] = sld opts["TLD"] = tld opts["Nameservers"] = ",".join(nameservers) response_xml = salt.utils.namecheap.post_request(opts) if response_xml is None: return False dnsresult = response_xml.getElementsByTagName("DomainDNSSetCustomResult")[0] return salt.utils.namecheap.string_to_value(dnsresult.getAttribute("Update")) def set_default(sld, tld): """ Sets domain to use namecheap default DNS servers. Required for free services like Host record management, URL forwarding, email forwarding, dynamic DNS and other value added services. sld SLD of the domain name tld TLD of the domain name Returns ``True`` if the domain was successfully pointed at the default DNS servers. CLI Example: .. code-block:: bash salt 'my-minion' namecheap_domains_dns.set_default sld tld """ opts = salt.utils.namecheap.get_opts("namecheap.domains.dns.setDefault") opts["SLD"] = sld opts["TLD"] = tld response_xml = salt.utils.namecheap.post_request(opts) if response_xml is None: return False dnsresult = response_xml.getElementsByTagName("DomainDNSSetDefaultResult")[0] return salt.utils.namecheap.string_to_value(dnsresult.getAttribute("Updated"))