2023-11-10 17:06:52 +01:00
|
|
|
# netbox-plugin-dns source for octodns
|
|
|
|
|
2024-01-09 22:12:25 +01:00
|
|
|
> works with https://github.com/peteeckel/netbox-plugin-dns
|
2023-11-09 13:08:03 +01:00
|
|
|
|
|
|
|
## config
|
|
|
|
|
|
|
|
```yml
|
|
|
|
providers:
|
2023-11-10 17:06:52 +01:00
|
|
|
config:
|
2023-11-09 13:08:03 +01:00
|
|
|
class: octodns_netbox_dns.NetBoxDNSSource
|
|
|
|
# Netbox url
|
2023-11-10 17:06:52 +01:00
|
|
|
# [mandatory, default=null]
|
2023-11-09 13:08:03 +01:00
|
|
|
url: "https://some-url"
|
2024-01-09 22:12:25 +01:00
|
|
|
# Netbox API token
|
2023-11-10 17:06:52 +01:00
|
|
|
# [mandatory, default=null]
|
2023-11-09 13:08:03 +01:00
|
|
|
token: env/NETBOX_API_KEY
|
2024-01-09 22:12:25 +01:00
|
|
|
# View of the zone. Can be either a string -> the view name
|
|
|
|
# "null" -> to only query zones without a view
|
|
|
|
# false -> to ignore views
|
2023-11-10 17:06:52 +01:00
|
|
|
# [optional, default=false]
|
2023-11-09 13:08:03 +01:00
|
|
|
view: false
|
|
|
|
# When records sourced from multiple providers, allows provider
|
2023-11-10 17:06:52 +01:00
|
|
|
# to replace entries coming from the previous one.
|
2023-11-09 13:08:03 +01:00
|
|
|
# Implementation matches YamlProvider's 'populate_should_replace'
|
2023-11-10 17:06:52 +01:00
|
|
|
# [optional, default=false]
|
2023-11-09 13:08:03 +01:00
|
|
|
replace_duplicates: false
|
2023-11-10 17:06:52 +01:00
|
|
|
# Make CNAME, MX and SRV records absolute if they are missing the trailing "."
|
|
|
|
# [optional, default=false]
|
|
|
|
make_absolute: false
|
|
|
|
```
|
|
|
|
|
|
|
|
## install
|
|
|
|
|
2024-01-09 22:12:25 +01:00
|
|
|
### via pip + git
|
2023-11-10 17:06:52 +01:00
|
|
|
|
|
|
|
```bash
|
|
|
|
pip install octodns-netbox-dns@git+https://github.com/olofvndrhr/octodns-netbox-dns.git@main
|
|
|
|
```
|
|
|
|
|
|
|
|
### via pip + `requirements.txt`
|
|
|
|
|
|
|
|
add the following line to your requirements file
|
|
|
|
|
|
|
|
```bash
|
|
|
|
octodns-netbox-dns@git+https://github.com/olofvndrhr/octodns-netbox-dns.git@main
|
2023-11-09 13:08:03 +01:00
|
|
|
```
|