netbox-plugin-dns provider for octodns

octodns provider for netbox-plugin-dns

syncs dns records from and to netbox via octodns

config

providers:
  config:
    class: octodns_netbox_dns.NetBoxDNSProvider
    # Netbox instance url
    # [mandatory]
    url: "https://some-url"
    # Netbox API token
    # [mandatory]
    token: env/NETBOX_API_KEY
    # Filter by zone view. Can either be the name of the view, false or null.
    # false/null -> do not filter by view.
    # [optional, default=null]
    view: null
    # When records sourced from multiple providers, allows provider
    # to replace entries coming from the previous one.
    # Implementation matches YamlProvider's 'populate_should_replace'
    # [optional, default=false]
    replace_duplicates: false
    # Make CNAME, MX and SRV records absolute if they are missing the trailing "." (dot).
    # You can instead also use the "octodns.processor.trailing_dots.EnsureTrailingDots" provider.
    # [optional, default=false]
    make_absolute: false
    # Control how NS TTL is derived when reading from NetBox.
    # soa_refresh = Preserve the default behavior and use the zone's soa_refresh for all NS records.
    # record      = Use the record TTL stored in NetBox, falling back to zone.default_ttl.
    # fixed       = Use ns_ttl_value for apex NS and record/default TTL for delegated NS records.
    # [optional, default=soa_refresh]
    ns_ttl_mode: soa_refresh
    # TTL value used when ns_ttl_mode=fixed for apex NS records.
    # [optional, default=14400]
    ns_ttl_value: 14400
    # Disable automatic PTR record creating in the NetboxDNS plugin.
    # [optional, default=true]
    disable_ptr: true
    # Disable certificate verification for unsecure https.
    # [optional, default=false]
    insecure_request: false
    # Only include zones with this status when dynamic zones are used, e.g. "*".
    # [optional, default=active]
    zone_status_filter: active
    # Only include records with this status when records are listed from a zone.
    # [optional, default=active]
    record_status_filter: active
    # Maximal page size of queries.
    # A value of 0 means: show every item. Can cause errors with the NetBox setting: MAX_PAGE_SIZE
    # [optional, default=0]
    max_page_size: 0
    # Allow multi threading, useful for large dns zones, see: https://github.com/netbox-community/pynetbox#threading
    # [optional, default=False]
    enable_threading: False

compatibility

actively tested on the newest netbox-plugin-dns and netbox versions

limitations

the records can only be synced to netbox-dns if the zone is already existing. the provider CAN NOT create zones (as of now).

install

via pip

pip install octodns-netbox-dns

via pip + git

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

octodns-netbox-dns@git+https://github.com/olofvndrhr/octodns-netbox-dns.git@main