mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

Update DefaultTTL.md (#2133)

Browse Source
This commit is contained in:
Paul Dee
2023-03-12 17:08:37 +01:00
committed by GitHub
parent c80f8a606b
commit e9adccd3a4
2 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
documentation/functions/domain/DefaultTTL.md
View File

@ -6,8 +6,11 @@ parameter_types:
ttl: Duration
---
DefaultTTL sets the TTL for all records in a domain that do not explicitly set one with [TTL](../record/TTL.md). If neither `DefaultTTL` or `TTL` exist for a record,
it will use the DNSControl global default of 300 seconds.
DefaultTTL sets the TTL for all subsequent records following it in a domain that do not explicitly set one with [`TTL`](../record/TTL.md). If neither `DefaultTTL` or `TTL` exist for a record,
the record will inherit the DNSControl global internal default of 300 seconds. See also [`DEFAULTS`](../global/DEFAULTS.md) to override the internal defaults.
NS records are currently a special case, and do not inherit from `DefaultTTL`. See [`NAMESERVER_TTL`](../domain/NAMESERVER_TTL.md) to set a default TTL for all NS records.
```javascript
D('example.com', REGISTRAR, DnsProvider('R53'),
@ -17,5 +20,5 @@ D('example.com', REGISTRAR, DnsProvider('R53'),
);
```
The DefaultTTL duration is the same format as [TTL](../record/TTL.md), an integer number of seconds
The DefaultTTL duration is the same format as [`TTL`](../record/TTL.md), an integer number of seconds
or a string with a unit such as `'4d'`.

18
documentation/functions/domain/NAMESERVER_TTL.md
View File

@ -8,9 +8,9 @@ parameter_types:
modifiers...: RecordModifier[]
---
NAMESERVER_TTL sets the TTL on the domain apex NS RRs defined by [NAMESERVER](NAMESERVER.md).
NAMESERVER_TTL sets the TTL on the domain apex NS RRs defined by [`NAMESERVER`](NAMESERVER.md).
The value can be an integer or a string. See [TTL](../record/TTL.md) for examples.
The value can be an integer or a string. See [`TTL`](../record/TTL.md) for examples.
```javascript
D('example.com', REGISTRAR, DnsProvider('R53'),
@ -18,3 +18,17 @@ D('example.com', REGISTRAR, DnsProvider('R53'),
NAMESERVER('ns')
);
```
Use `NAMESERVER_TTL('3600'),` or `NAMESERVER_TTL('1h'),` for a 1h default TTL for all subsequent `NS` entries:
```javascript
D('example.com', REGISTRAR, DnsProvider('xyz'),
DefaultTTL("4h"),
NAMESERVER_TTL('3600'),
NAMESERVER('ns1.provider.com.'), //inherits NAMESERVER_TTL
NAMESERVER('ns2.provider.com.'), //inherits NAMESERVER_TTL
A('@','1.2.3.4'), // inherits DefaultTTL
A('foo', '2.3.4.5', TTL(600)) // overrides DefaultTTL for this record only
);
```
To apply a default TTL to all other record types, see [`DefaultTTL`](../domain/DefaultTTL.md)