creekorful/pfsense-netbox-sync
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
Allows to synchronize NetBox IPAM DNS information to a pfSense instance https://pypi.org/project/pfsense-netbox-sync/
4 commits 1 branch 1 tag 76 KiB
Find a file
Aloïs Micard 91410ffe65 Filter host overrides
2025-02-19 11:45:55 +01:00
.forgejo/workflows Add CI (#4) 2025-02-19 09:06:33 +01:00
app Filter host overrides 2025-02-19 11:45:55 +01:00
.gitignore Add build metadata 2025-02-19 11:45:50 +01:00
LICENSE.txt Add build metadata 2025-02-19 11:45:50 +01:00
pyproject.toml Add build metadata 2025-02-19 11:45:50 +01:00
README.md Add build metadata 2025-02-19 11:45:50 +01:00
requirements.txt Add build metadata 2025-02-19 11:45:50 +01:00

README.md

pfsense-netbox-sync

Allows to synchronize NetBox IPAM DNS information to a pfSense instance. This allows automatic DNS resolution on the pfSense based on the DNS names stored in Netbox.

How does it work?

This script work by pulling IP addresses with DNS name from NetBox (source of truth) and create/update/delete corresponding DNS entries on pfSense DNS resolver.

Installation

Configuration

On NetBox

You'll need to create a dedicated user (ex: pfsense-netbox-sync) on your NetBox instance and then create a read only API token.

The following env variables will need to be set:

  • NB_API_URL: The URL to your NetBox instance. (Example: https://netbox.example.org)
  • NB_API_TOKEN: The token created previously. (Example: f74cb99cf552b7005fd1a616b53efba2ce0c9656)

On pfSense

pfSense does not provide any REST API out of the box. Therefore, you'll first need to install the pfrest package.

Executing the script

PF_API_URL=xx PF_API_USER=xx PF_API_PASS=xx NB_API_URL=xx NB_API_TOKEN=xx python3 -m app