Update ddns runner documention for port, TSIG key algorithm, and timeout

This commit is contained in:
Jayson Cofell 2016-07-18 15:18:55 -05:00
parent 90e1f514e1
commit fc6409b69a

View file

@ -199651,7 +199651,7 @@ Nitin Madhok <\fI\%nmadhok@clemson.edu\fP>
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.add_host(zone, name, ttl, ip, keyname, keyfile, nameserver)
.B salt.runners.ddns.add_host(zone, name, ttl, ip, keyname, keyfile, nameserver, timeout, port=53, keyalgorithm='hmac-md5')
Create both A and PTR (reverse) records for a host.
.sp
CLI Example:
@ -199660,7 +199660,7 @@ CLI Example:
.sp
.nf
.ft C
salt\-run ddns.add_host domain.com my\-test\-vm 3600 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1
salt\-run ddns.add_host domain.com my\-test\-vm 3600 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT
@ -199668,7 +199668,7 @@ salt\-run ddns.add_host domain.com my\-test\-vm 3600 10.20.30.40 my\-tsig\-key /
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.create(zone, name, ttl, rdtype, data, keyname, keyfile, nameserver)
.B salt.runners.ddns.create(zone, name, ttl, rdtype, data, keyname, keyfile, nameserver, timeout, port=53, keyalgorithm='hmac-md5')
Create a DNS record. The nameserver must be an IP address and the master running
this runner must have create privileges on that server.
.sp
@ -199678,7 +199678,7 @@ CLI Example:
.sp
.nf
.ft C
salt\-run ddns.create domain.com my\-test\-vm 3600 A 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1
salt\-run ddns.create domain.com my\-test\-vm 3600 A 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT
@ -199686,7 +199686,7 @@ salt\-run ddns.create domain.com my\-test\-vm 3600 A 10.20.30.40 my\-tsig\-key /
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.delete(zone, name, keyname, keyfile, nameserver, rdtype=None, data=None)
.B salt.runners.ddns.delete(zone, name, keyname, keyfile, nameserver, timeout, rdtype=None, data=None, port=53, keyalgorithm='hmac-md5')
Delete a DNS record.
.sp
CLI Example:
@ -199695,7 +199695,7 @@ CLI Example:
.sp
.nf
.ft C
salt\-run ddns.delete domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 A
salt\-run ddns.delete domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5 A
.ft P
.fi
.UNINDENT
@ -199703,7 +199703,7 @@ salt\-run ddns.delete domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.keyri
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.delete_host(zone, name, keyname, keyfile, nameserver)
.B salt.runners.ddns.delete_host(zone, name, keyname, keyfile, nameserver, timeout, port=53, keyalgorithm='hmac-md5')
Delete both forward (A) and reverse (PTR) records for a host only if the
forward (A) record exists.
.sp
@ -199713,7 +199713,7 @@ CLI Example:
.sp
.nf
.ft C
salt\-run ddns.delete_host domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1
salt\-run ddns.delete_host domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT
@ -199721,7 +199721,7 @@ salt\-run ddns.delete_host domain.com my\-test\-vm my\-tsig\-key /etc/salt/tsig.
.UNINDENT
.INDENT 0.0
.TP
.B salt.runners.ddns.update(zone, name, ttl, rdtype, data, keyname, keyfile, nameserver, replace=False)
.B salt.runners.ddns.update(zone, name, ttl, rdtype, data, keyname, keyfile, nameserver, timeout, replace=False, port=53, keyalgorithm='hmac-md5')
Replace, or update a DNS record. The nameserver must be an IP address and the master running
this runner must have update privileges on that server.
.sp
@ -199739,7 +199739,7 @@ CLI Example:
.sp
.nf
.ft C
salt\-run ddns.update domain.com my\-test\-vm 3600 A 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1
salt\-run ddns.update domain.com my\-test\-vm 3600 A 10.20.30.40 my\-tsig\-key /etc/salt/tsig.keyring 10.0.0.1 5
.ft P
.fi
.UNINDENT