1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

adding docs again

This commit is contained in:
Craig Peterson
2017-01-11 13:02:45 -07:00
parent 8e5257c497
commit 7ba051d750
40 changed files with 761 additions and 0 deletions

View File

@@ -0,0 +1,24 @@
---
name: NewDnsProvider
parameters:
- name
- type
- meta
return: string
---
NewDnsProvider registers a new DNS Service Provider. The name can be any string value you would like to use.
The type must match a valid dns provider type identifer (see [provider page.]({{site.github.url}}/provider-list))
Metadata is an optional object, that will only be used by certain providers. See [individual provider docs]({{site.github.url}}/provider-list) for specific details.
This function will return the name as a string so that you may assign it to a variable to use inside [D](#D) directives.
{% include startExample.html %}
{% highlight js %}
var REGISTRAR = NewRegistrar("name.com", "NAMEDOTCOM");
var r53 = NewDnsProvider("R53","ROUTE53");
D("example.com", REGISTRAR, DnsProvider(r53), A("@","1.2.3.4"));
{%endhighlight%}
{% include endExample.html %}