Skip to content

Commit b5f0262

Browse files
committed
Added documentation for the record expiration feature
1 parent 7134719 commit b5f0262

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

docs/using_netbox_dns.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1172,6 +1172,29 @@ Another example shows a conflict at View level when assigning a prefix:
11721172

11731173
The solution is to either disable automatic DNS record configuration for the affected IP addresses (which retains the original DNS records) or to remove or deactivate the existing address records and try again.
11741174

1175+
### Record Expiration
1176+
1177+
In some cases it may be desired to define an expiration date for records, for example for validation `TXT` records that are only necessary for a limited period of time. Starting with NetBox DNS 1.5.10, a feature was added that enables automatic expiration of records.
1178+
1179+
When the "Expiration Date" is set for a record, the record is supposed to be deactivated when this date is reached. For this automatism to be effective, two conditions need to be met:
1180+
1181+
* The record expiration job needs to be enabled in NetBox DNS
1182+
* The "Generate SOA SERIAL" feature must be active for the zone (which is the default setting)
1183+
1184+
The record expiration job is disabled by default because it adds some overhead to NetBox and is not necessary unless the record expiration feature is to be used. To enable it, the `enable_record_exiration_job` variable must be set in the NetBox DNS configuration:
1185+
1186+
```
1187+
PLUGINS_CONFIG = {
1188+
'netbox_dns': {
1189+
...
1190+
'enable_record_expiration_job': True,
1191+
...
1192+
},
1193+
}
1194+
```
1195+
1196+
If enabled, the job runs once daily and sets the status of all records whose expiration date has passed to "Expired". This is an inactive record status and causes the record to be disregarded by provisioning mechanisms.
1197+
11751198
### Additional Information for IP Addresses and DNS Records
11761199
When a link between an IP address and a DNS address record is present, additional panes will appear in the IPAM IP address and NetBox DNS record view, as well as in the detail views for NetBox DNS managed records.
11771200

@@ -1213,7 +1236,6 @@ For records automatically generated by DNSsync, this is not generally the desire
12131236

12141237
For this reason, NetBox DNS does not check uniqueness for address records automatically generated by DNSsync, and there is an option to deactivate other conflicting address records automatically. This is not enabled by default, but it can be switched on with the configuration variable `dnssync_conflict_deactivate`:
12151238

1216-
12171239
```
12181240
PLUGINS_CONFIG = {
12191241
'netbox_dns': {

0 commit comments

Comments
 (0)