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

Updated Configuration (markdown)

Raymond Kuiper 2025-05-28 15:42:05 +02:00
parent e5c95185a8
commit 1185cc21bb
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Configuration.md

@ -217,15 +217,15 @@ template(s) will take priority over the device type custom field template.
templates_config_context_overrule = True templates_config_context_overrule = True
``` ```
## Permissions # Permissions
### NetBox ## NetBox
Make sure that the NetBox user has proper permissions for device read and modify Make sure that the NetBox user has proper permissions for device read and modify
(modify to set the Zabbix HostID custom field) operations. The user should also (modify to set the Zabbix HostID custom field) operations. The user should also
have read-only access to the device types. have read-only access to the device types.
### Zabbix ## Zabbix
Make sure that the Zabbix user has permissions to read hostgroups and proxy Make sure that the Zabbix user has permissions to read hostgroups and proxy
servers. The user should have full rights on creating, modifying and deleting servers. The user should have full rights on creating, modifying and deleting
@ -234,7 +234,7 @@ hosts.
If you want to automatically create hostgroups then the create permission on If you want to automatically create hostgroups then the create permission on
host-groups should also be applied. host-groups should also be applied.
### Custom links # Custom links
To make the user experience easier you could add a custom link that redirects To make the user experience easier you could add a custom link that redirects
users to the Zabbix latest data. users to the Zabbix latest data.
@ -245,21 +245,21 @@ users to the Zabbix latest data.
* URL: http://myzabbixserver.local/zabbix.php?action=latest.view&hostids[]={{ object.cf["zabbix_hostid"] }} * URL: http://myzabbixserver.local/zabbix.php?action=latest.view&hostids[]={{ object.cf["zabbix_hostid"] }}
``` ```
## Running the script # Running the script
``` ```
python3 netbox_zabbix_sync.py python3 netbox_zabbix_sync.py
``` ```
### Flags ## Flags
| Flag | Option | Description | | Flag | Option | Description |
| ---- | ------- | ---------------------- | | ---- | ------- | ---------------------- |
| -v | verbose | Log with debugging on. | | -v | verbose | Log with debugging on. |
## Config context # Config context
### Zabbix proxy ## Zabbix proxy
You can set the proxy for a device using the 'proxy' key in config context. You can set the proxy for a device using the 'proxy' key in config context.
@ -308,7 +308,7 @@ everything is synced except in a situation where the Zabbix host has a proxy
configured but nothing is configured in NetBox. To force deletion and a full configured but nothing is configured in NetBox. To force deletion and a full
sync, set the `full_proxy_sync` variable in the config file. sync, set the `full_proxy_sync` variable in the config file.
### Set interface parameters within NetBox ## Set interface parameters within NetBox
When adding a new device, you can set the interface type with custom context. By When adding a new device, you can set the interface type with custom context. By
default, the following configuration is applied when no config context is default, the following configuration is applied when no config context is
@ -340,7 +340,7 @@ environment. For example, you could:
- Set the custom context on a device role - Set the custom context on a device role
- Set the custom context on a site or region - Set the custom context on a site or region
##### Agent interface configuration example ### Agent interface configuration example
```json ```json
{ {
@ -351,7 +351,7 @@ environment. For example, you could:
} }
``` ```
##### SNMPv2 interface configuration example ### SNMPv2 interface configuration example
```json ```json
{ {
@ -367,7 +367,7 @@ environment. For example, you could:
} }
``` ```
##### SNMPv3 interface configuration example ### SNMPv3 interface configuration example
```json ```json
{ {