NeoAnd/netbox-zabbix-sync
1
0
Fork 0
mirror of https://github.com/TheNetworkGuy/netbox-zabbix-sync.git synced 2025-12-12 19:39:37 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added option to extend site information for devices and vms.

Browse Source
This commit is contained in:
Raymond Kuiper 2025-09-08 14:44:46 +02:00
parent c58a3e8dd5
commit 9259e73617
4 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,5 +1,6 @@
*.log *.log
.venv .venv
.env
config.py config.py
Pipfile Pipfile
Pipfile.lock Pipfile.lock

18
config.py.example
View File

@ -53,6 +53,12 @@ hostgroup_format = "site/manufacturer/role"
traverse_regions = False traverse_regions = False
traverse_site_groups = False traverse_site_groups = False
## Extended site properteis
# By default, NetBox will only return basic site info for any device or VM.
# By setting `extended_site_properties` to True, the script will query NetBox for additiopnal site info.
# Be aware that this will increase the number of API queries to NetBox.
extended_site_properties = False
## Filtering ## Filtering
# Custom device filter, variable must be present but can be left empty with no filtering. # Custom device filter, variable must be present but can be left empty with no filtering.
# A couple of examples: # A couple of examples:
@ -87,8 +93,8 @@ device_inventory_map = { "asset_tag": "asset_tag",
"virtual_chassis/name": "chassis", "virtual_chassis/name": "chassis",
"status/label": "deployment_status", "status/label": "deployment_status",
"location/name": "location", "location/name": "location",
"latitude": "location_lat", "site/latitude": "location_lat",
"longitude": "location_lon", "site/longitude": "location_lon",
"comments": "notes", "comments": "notes",
"name": "name", "name": "name",
"rack/name": "site_rack", "rack/name": "site_rack",
@ -112,19 +118,19 @@ usermacro_sync = False
# device usermacro_map to map NetBox fields to usermacros. # device usermacro_map to map NetBox fields to usermacros.
device_usermacro_map = {"serial": "{$HW_SERIAL}", device_usermacro_map = {"serial": "{$HW_SERIAL}",
"role/name": "{$DEV_ROLE}", "role/name": "{$DEV_ROLE}",
"url": "{$NB_URL}", "display_url": "{$NB_URL}",
"id": "{$NB_ID}"} "id": "{$NB_ID}"}
# virtual machine usermacro_map to map NetBox fields to usermacros. # virtual machine usermacro_map to map NetBox fields to usermacros.
vm_usermacro_map = {"memory": "{$TOTAL_MEMORY}", vm_usermacro_map = {"memory": "{$TOTAL_MEMORY}",
"role/name": "{$DEV_ROLE}", "role/name": "{$DEV_ROLE}",
"url": "{$NB_URL}", "display_url": "{$NB_URL}",
"id": "{$NB_ID}"} "id": "{$NB_ID}"}
# To sync host tags to Zabbix, set to True. # To sync host tags to Zabbix, set to True.
tag_sync = False tag_sync = False
# Setting tag_lower to True will lower capital letters ain tag names and values # Setting tag_lower to True will lower capital letters in tag names and values
# This is more inline with the Zabbix way of working with tags. # This is more inline with the Zabbix way of working with tags.
# #
# You can however set this to False to ensure capital letters are synced to Zabbix tags. # You can however set this to False to ensure capital letters are synced to Zabbix tags.
@ -132,8 +138,6 @@ tag_lower = True
# We can sync NetBox device/VM tags to Zabbix, but as NetBox tags don't follow the key/value # We can sync NetBox device/VM tags to Zabbix, but as NetBox tags don't follow the key/value
# pattern, we need to specify a tag name to register the NetBox tags in Zabbix. # pattern, we need to specify a tag name to register the NetBox tags in Zabbix.
#
#
# #
# If tag_name is set to False, we won't sync NetBox device/VM tags to Zabbix. # If tag_name is set to False, we won't sync NetBox device/VM tags to Zabbix.
tag_name = 'NetBox' tag_name = 'NetBox'

1
modules/config.py
View File

@ -31,6 +31,7 @@ DEFAULT_CONFIG = {
"nb_vm_filter": {"name__n": "null"}, "nb_vm_filter": {"name__n": "null"},
"inventory_mode": "disabled", "inventory_mode": "disabled",
"inventory_sync": False, "inventory_sync": False,
"extended_site_properties": False,
"device_inventory_map": { "device_inventory_map": {
"asset_tag": "asset_tag", "asset_tag": "asset_tag",
"virtual_chassis/name": "chassis", "virtual_chassis/name": "chassis",

1
modules/device.py
View File

@ -2,6 +2,7 @@
""" """
Device specific handeling for NetBox to Zabbix Device specific handeling for NetBox to Zabbix
""" """
from pprint import pprint
from copy import deepcopy from copy import deepcopy
from logging import getLogger from logging import getLogger