saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #31417 from jacobhammons/ddns-docs

Browse source 
ddns state docs updated with notes regarding the name, zone, and keyfile.
This commit is contained in:
Mike Place 2016-02-22 16:16:48 -07:00
commit 19d7810478
1 changed files with 20 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
salt/states/ddns.py
View file

@ -4,7 +4,11 @@ Dynamic DNS updates
===================
Ensure a DNS record is present or absent utilizing RFC 2136
type dynamic updates. Requires dnspython module.
type dynamic updates.
:depends: - `dnspython <http://www.dnspython.org/>`_
Example:
.. code-block:: yaml
@ -14,7 +18,7 @@ type dynamic updates. Requires dnspython module.
- ttl: 60
- data: 111.222.333.444
- nameserver: 123.234.345.456
- keyfile: /srv/salt/tsig_key.txt
- keyfile: /srv/salt/dnspython_key.txt
'''
@ -27,7 +31,9 @@ def present(name, zone, ttl, data, rdtype='A', **kwargs):
Ensures that the named DNS record is present with the given ttl.
name
The host portion of the DNS record, e.g., 'webserver'
The host portion of the DNS record, e.g., 'webserver'. Name and zone
are concatenated when the entry is created, so make sure that
information is not duplicated in these two arguments.
zone
The zone to check/update
@ -42,7 +48,10 @@ def present(name, zone, ttl, data, rdtype='A', **kwargs):
DNS resource type. Default 'A'.
``**kwargs``
Additional arguments the ddns.update function may need (e.g. nameserver, keyfile, keyname).
Additional arguments the ddns.update function may need (e.g.
nameserver, keyfile, keyname). Note that the nsupdate key file can’t
be reused by this function, the keyfile and other arguments must
follow the `dnspython <http://www.dnspython.org/>`_ spec.
'''
ret = {'name': name,
'changes': {},
@ -80,7 +89,9 @@ def absent(name, zone, data=None, rdtype=None, **kwargs):
Ensures that the named DNS record is absent.
name
The host portion of the DNS record, e.g., 'webserver'
The host portion of the DNS record, e.g., 'webserver'. Name and zone
are concatenated when the entry is created, so make sure that
information is not duplicated in these two arguments.
zone
The zone to check
@ -93,7 +104,10 @@ def absent(name, zone, data=None, rdtype=None, **kwargs):
DNS resource type. If omitted, all types will be purged.
``**kwargs``
Additional arguments the ddns.delete function may need (e.g. nameserver, keyfile, keyname).
Additional arguments the ddns.update function may need (e.g.
nameserver, keyfile, keyname). Note that the nsupdate key file can’t
be reused by this function, the keyfile and other arguments must
follow the `dnspython <http://www.dnspython.org/>`_ spec.
'''
ret = {'name': name,
'changes': {},