NeoAnd/netbox-zabbix-sync
1
0
Fork 0
mirror of https://github.com/TheNetworkGuy/netbox-zabbix-sync.git synced 2025-07-18 13:06:34 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Documentation added for customizable host groups.
This commit is contained in:
David Mc Ken 2021-11-01 21:17:12 -04:00
parent ca9f93931f
commit 747e0dda25
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,6 +9,7 @@ From now on only compatible with Netbox 3.x.
* ZABBIX_HOST="https://zabbix.local" * ZABBIX_HOST="https://zabbix.local"
* ZABBIX_USER="username" * ZABBIX_USER="username"
* ZABBIX_PASS="Password" * ZABBIX_PASS="Password"
* ZABBIX_HG_SPEC=site/manufacturer/role
* NETBOX_HOST="https://netbox.local" * NETBOX_HOST="https://netbox.local"
* NETBOX_TOKEN="secrettoken" * NETBOX_TOKEN="secrettoken"
@ -36,6 +37,21 @@ And with tenants (-t flag):
Make sure that the Zabbix user has proper permissions to create hosts. Make sure that the Zabbix user has proper permissions to create hosts.
The hostgroups are in a nested format. This means that proper permissions only need to be applied to the site name hostgroup and cascaded to any child hostgroups. The hostgroups are in a nested format. This means that proper permissions only need to be applied to the site name hostgroup and cascaded to any child hostgroups.
If you want to customize the host groups you can set the ZABBIX_HG_SPEC environment variable.
The following fields are currently supported:
* cluster
* device_type
* location
* manufacturer
* platform
* rack
* role
* site
* tenant
If a value is not set on the host for a specified value it is filled in with 'Unknown' (only really applicable if you use -H to automatically create the host group) and an error message is displayed on the script output.
### Netbox settings ### Netbox settings
#### Custom fields #### Custom fields
Use the following custom fields in Netbox to map the Zabbix URL: Use the following custom fields in Netbox to map the Zabbix URL: