Namecheap domains management
New in version 2017.7.0.
Use this module to manage domains through the namecheap api. The Namecheap settings will be set in grains.
This module uses the following python libraries to communicate to the namecheap API:
requests
pip install requestsAs saltstack depends on
requests
this shouldn’t be a problem
The namecheap username, api key and url should be set in a minion configuration file or pillar
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
salt.modules.namecheap_domains.
check
(*domains_to_check)¶Checks the availability of domains
CLI Example:
salt 'my-minion' namecheap_domains.check domain-to-check
salt.modules.namecheap_domains.
create
(domain_name, years, **kwargs)¶Try to create the specified domain name for the specified number of years
CLI Example:
salt 'my-minion' namecheap_domains.create my-domain-name 2
salt.modules.namecheap_domains.
get_info
(domain_name)¶Returns information about the requested domain
returns a dictionary of information about the domain_name
CLI Example:
salt 'my-minion' namecheap_domains.get_info my-domain-name
salt.modules.namecheap_domains.
get_list
(list_type=None, search_term=None, page=None, page_size=None, sort_by=None)¶Returns a list of domains for the particular user as a list of objects
offset by page
length of page_size
CLI Example:
salt 'my-minion' namecheap_domains.get_list
salt.modules.namecheap_domains.
get_tld_list
()¶Returns a list of TLDs as objects
CLI Example:
salt 'my-minion' namecheap_domains.get_tld_list
salt.modules.namecheap_domains.
reactivate
(domain_name)¶Try to reactivate the expired domain name
CLI Example:
salt 'my-minion' namecheap_domains.reactivate my-domain-name
salt.modules.namecheap_domains.
renew
(domain_name, years, promotion_code=None)¶Try to renew the specified expiring domain name for a specified number of years
CLI Example:
salt 'my-minion' namecheap_domains.renew my-domain-name 5