diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5e7db9d --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +nbxsync/* + diff --git a/README.md b/README.md index 6567233..e650610 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# nbxSync – NetBox ⇄ Zabbix Integration +# nbxSync - NetBox to Zabbix Integration -**Integrate Netbox as Source of Truth with Zabbix as Monitoring Solution** +**Integrate NetBox as source of truth with Zabbix as monitoring solution** ![CI](https://github.com/OpensourceICTSolutions/nbxsync/actions/workflows/ci.yml/badge.svg) ![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/bvbaekel/1a1cf04e63a52d5497edd6e0a564ec2b/raw/4a293f964b246091d1fd943629408dbb7d9f597f/cov.json) @@ -11,16 +11,28 @@ ## Description -nbxSync seamlessly integrates Netbox with Zabbix. +nbxSync integrates NetBox with Zabbix. With nbxSync you can: -✅ Create and manage all your devices in NetBox (your single source of truth) -✅ Automatically sync devices to Zabbix for monitoring -✅ Save time, reduce errors, and ensure consistent, up-to-date monitoring data -This plugin bridges the gap between network/source-of-truth documentation and infrastructure monitoring – something many teams have been asking for. +- Create and manage devices in NetBox as the source of truth. +- Synchronize devices, virtual machines, host groups, templates, tags, macros, interfaces, proxies, and maintenance windows with Zabbix. +- Keep monitoring configuration aligned with documented infrastructure. +- Optionally synchronize Zabbix trigger dependencies from NetBox cabling. -💡 If you’re running both NetBox and Zabbix, this is the missing link you’ve been waiting for. +This plugin bridges source-of-truth documentation and infrastructure monitoring. + +## Trigger Dependencies + +nbxSync can optionally update Zabbix trigger dependencies after a successful device host sync. This allows dependencies such as: + +```text +access point trigger -> switch trigger -> gateway/firewall trigger +``` + +The feature is disabled by default and is configured with ordered dependency levels. Each level defines the NetBox device role names/slugs it matches and the Zabbix trigger description to update. NetBox cabling determines the directly connected upstream/downstream device, while the configured level order determines dependency direction. + +See [Configuration](docs/configuration.md#trigger_dependencies) for details. ## Compatibility @@ -33,12 +45,12 @@ This plugin bridges the gap between network/source-of-truth documentation and in --- -## 📦 Installation +## Installation ### 1. Install the plugin > [!IMPORTANT] -> The steps below are for a non-dockerized setup. If you run Netbox in Docker containers, please see [their installation instructions](https://netboxlabs.com/docs/netbox/installation/) +> The steps below are for a non-dockerized setup. If you run NetBox in Docker containers, please see [their installation instructions](https://netboxlabs.com/docs/netbox/installation/) Install using pip diff --git a/docs/configuration.md b/docs/configuration.md index 2316c26..8e0293f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,6 +1,6 @@ # Configuration -The plugin is configuration to do exactly what you want, by means of the plugin settings. As described in the [installation instructions](installation.md)), the default configuration is as follows: +The plugin can be configured with NetBox plugin settings. As described in the [installation instructions](installation.md), the default configuration is as follows: ```python "nbxsync": { @@ -74,6 +74,39 @@ The plugin is configuration to do exactly what you want, by means of the plugin 'interval': 15, # 15 minutes }, }, + 'trigger_dependencies': { + 'enabled': False, + 'levels': [ + { + 'name': 'access_point', + 'roles': ['access point', 'access-point', 'ap'], + 'trigger_description': 'AP status', + }, + { + 'name': 'switch', + 'roles': ['switch', 'switches'], + 'trigger_description': 'Switch status', + }, + { + 'name': 'gateway', + 'roles': [ + 'gateway', + 'gateways', + 'gw', + 'firewall', + 'firewalls', + 'meraki gw', + 'meraki-gw', + 'meraki mx', + 'meraki-mx', + 'mx', + 'security appliance', + 'security-appliance', + ], + 'trigger_description': 'Gateway status', + }, + ], + }, 'no_alerting_tag': 'NO_ALERTING', 'no_alerting_tag_value': '1', 'attach_objtag': True, @@ -86,11 +119,11 @@ The plugin is configuration to do exactly what you want, by means of the plugin ### Source of Truth -The `sot` key determines which system is the Source of Truth: `netbox` or `zabbix`. And as such, which way the sync works. If the SoT is Netbox, data will be synschronized from Netbox to Zabbix. If the SoT is Zabbix, data is synchronized from Zabbix to Netbox - if and where possible (Zabbix doesn't expose all information). +The `sot` key determines which system is the source of truth: `netbox` or `zabbix`. This controls the sync direction. If the SoT is NetBox, data is synchronized from NetBox to Zabbix. If the SoT is Zabbix, data is synchronized from Zabbix to NetBox where possible; Zabbix does not expose all information. ### Statusmapping -The `statusmapping` key influences how certain statusses are interpreted and used. The two models that are to be synchronized are Devices and Virtual Machines. Each of these can be configurated independently of eachother for maximum flexibility. +The `statusmapping` key controls how certain statuses are interpreted and used. Devices and Virtual Machines can be configured independently. The key is the `netbox` status whilst the value is the action to be taken in Zabbix. @@ -98,15 +131,15 @@ The key is the `netbox` status whilst the value is the action to be taken in Zab #### enabled -This status results in the host to be enabled in Zabbix +This status enables the host in Zabbix. #### disabled -This status results in the host to be disabled in Zabbix +This status disables the host in Zabbix. #### deleted -This status results in the host to be deleted from Zabbix +This status deletes the host from Zabbix. #### enabled_in_maintenance @@ -118,11 +151,11 @@ If a host has this status, it is enabled in Zabbix, but it will have a tag with ### backgroundsync -If wanted, system jobs can be used to automatically sync objects +System jobs can be used to automatically sync objects. #### objects -This key is used to determine if 'objects' (that is: Devices and/or Virtual Machines) are to be automatically synched to/from Zabbix +This key controls whether objects, such as Devices and Virtual Machines, are automatically synchronized to or from Zabbix. ##### enabled @@ -165,6 +198,38 @@ This runs as the `Zabbix Sync Maintenance job` system job. Only maintenance windows that have at least one period and one object assignment are included. See [Zabbix Maintenance](zabbixmaintenance.md) for details. +### trigger_dependencies + +When enabled, nbxSync updates Zabbix trigger dependencies after a successful device host sync. The feature uses NetBox cabling and ordered dependency levels to build dependency chains such as: + +```text +access point trigger -> switch trigger -> gateway/firewall trigger +``` + +This feature is disabled by default. Enable it only when the configured role tokens match your NetBox device role names or slugs and the configured trigger descriptions match your Zabbix trigger names. + +Both pieces are required: + +- Role matching decides which dependency level a NetBox device belongs to. Role names and slugs are compared case-insensitively. +- Interface cabling decides which directly connected devices are considered. +- The order of `levels` decides dependency direction. Lower levels depend on directly connected higher levels. + +For example, an access point role named `Wireless AP` will not match the defaults unless you add `wireless ap` or the role slug to the access point level's `roles`. A device with a matching role but no connected higher-level neighbor is skipped because nbxSync cannot determine its upstream dependency. + +| Key | Default | Description | +|------------|---------|-------------| +| `enabled` | `False` | Enable trigger dependency updates after host sync | +| `levels` | AP, switch, gateway/firewall | Ordered from lowest child to highest parent | +| `name` | Level-specific | Human-readable level name used for configuration clarity | +| `roles` | Level-specific role tokens | NetBox device role names/slugs that belong to this level | +| `trigger_description` | Level-specific trigger name | Zabbix trigger description on hosts in this level | + +The default levels are ordered as access point, switch, gateway/firewall. With those defaults, a connected access point depends on its connected switch, and a connected switch depends on its connected gateway or firewall. Cable direction does not matter; nbxSync looks at directly connected devices and uses the level order to decide which device is the child and which device is the parent. + +To support more device types, add their NetBox role names or slugs to the appropriate level. To support a different hierarchy, add or reorder levels from lowest child to highest parent. + +Existing Zabbix dependencies whose descriptions do not match the managed parent trigger descriptions are preserved. Dependencies matching the managed parent trigger descriptions are replaced with the current cabling-derived parent triggers. + ### no_alerting_tag This defines the tag to be set when a host has the 'enabled_no_alerting' status. Use just a string value with no ${ } around the tag. Defaults to 'NO_ALERTING'. @@ -216,4 +281,4 @@ Two separate `sync_enabled` flags control whether synchronization to Zabbix is a **On `ZabbixServerAssignment`**: disabling this stops synchronization for that specific device/VM assignment only. Other assignments to the same or different Zabbix servers are unaffected. -Both flags must be `True` for a sync to proceed. The "Sync Status" column on the Zabbix Server Assignments list shows a green check only when both the assignment and its server are enabled. \ No newline at end of file +Both flags must be `True` for a sync to proceed. The "Sync Status" column on the Zabbix Server Assignments list shows a green check only when both the assignment and its server are enabled. diff --git a/docs/index.md b/docs/index.md index 68040dd..7a1096b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,8 @@ -# nbxSync - Netbox ❤️ Zabbix +# nbxSync - NetBox and Zabbix -This plugin integrates [NetBox](https://netbox.dev) with [Zabbix](https://www.zabbix.com/), providing a bridge to synchronize NetBox Devices, Virtual Device Contexts & VMs into Zabbix Hosts and (limited though) vice versa. Through custom models, these Devices, Virtual Device Contexts and VMs can be added to custom hostgroups, macro's can be provisioned with dynamic values (based on jinja2) and templates can be assigned on not only the object itself (so the device/vdc/vm), but can be inherited from Device Types, Manufacturerer, Device Roles and Platform. +This plugin integrates [NetBox](https://netbox.dev) with [Zabbix](https://www.zabbix.com/), providing a bridge to synchronize NetBox Devices, Virtual Device Contexts, and VMs into Zabbix Hosts and, where supported, vice versa. Through custom models, these Devices, Virtual Device Contexts, and VMs can be added to custom host groups, macros can be provisioned with dynamic values based on Jinja2, and templates can be assigned on the object itself or inherited from Device Types, Manufacturers, Device Roles, and Platforms. -In order to ease operational burden, configuration can be grouped together using Configuration Groups. These groups replicate the templated configuration (such as Zabbix Templates, Zabbix Host Interfaces, Hostgroups, et cetera) to the assigned Devices/VDCs/VMs. +To reduce operational work, configuration can be grouped together using Configuration Groups. These groups replicate templated configuration, such as Zabbix Templates, Zabbix Host Interfaces, host groups, and tags, to the assigned Devices, VDCs, and VMs. ## Features @@ -13,6 +13,7 @@ In order to ease operational burden, configuration can be grouped together using - Job-based execution for controlled syncing - Hostgroup & Tag values based on Jinja2 templates - Supports Configuration Groups to quickly apply a 'set of configuration items' to Devices, VDCs or VMs +- Optional trigger dependency synchronization from NetBox cabling Built to make NetBox the single source of truth while leveraging Zabbix for monitoring. {: .slogan } diff --git a/docs/installation.md b/docs/installation.md index 1b31938..669a4a2 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,7 +2,7 @@ ## Docker -Installing on Docker is fairly simple and [documented by the Netbox Docker project](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins). Just ensure to restart both the Netbox and Netbox-Worker container, as both will need to have nbxSync installed. +Installing on Docker is documented by the [NetBox Docker project](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins). Restart both the NetBox and NetBox Worker containers after installing nbxSync, as both containers need the plugin installed. Also, replace `netbox_secrets` with `nbxsync` obviously. @@ -13,7 +13,7 @@ Also, replace `netbox_secrets` with `nbxsync` obviously. - Python >= 3.8 - Zabbix server >= 7.0 -In order to install NetBox, please see [their installation instructions](https://netboxlabs.com/docs/netbox/installation/). Once you have a working Netbox installation, proceed with the steps below. +To install NetBox, see [the NetBox installation instructions](https://netboxlabs.com/docs/netbox/installation/). Once you have a working NetBox installation, proceed with the steps below. ### Steps @@ -28,7 +28,7 @@ echo nbxsync >> /opt/netbox/local_requirements.txt #### Configuration -If you want to change the default configuration, can add the following configuration and alter it accordingly. This is _not_ required though. +If you want to change the default configuration, add the following configuration and adjust it for your environment. This is optional. ```python title="netbox/configuration.py" PLUGINS = ['nbxsync'] diff --git a/docs/permissions.md b/docs/permissions.md index b361812..ec53841 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -1,6 +1,6 @@ # Permissions -nbxSync integrates with the [Netbox Permission system](https://netbox.readthedocs.io/en/stable/administration/permissions/). +nbxSync integrates with the [NetBox permission system](https://netbox.readthedocs.io/en/stable/administration/permissions/). ## Zabbix Hostgroup diff --git a/docs/setup.md b/docs/setup.md index e5f9e16..c058ad5 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,27 +1,27 @@ # Setup -This plugin requires some setup in Netbox to function correctly. +This plugin requires some setup in NetBox to function correctly. ## Prerequisites -Before you begin, ensure that Netbox can communicate with Zabbix via the [JSON API](https://www.zabbix.com/documentation/current/en/manual/api). Authentication is performed using a `Token`. +Before you begin, ensure that NetBox can communicate with Zabbix via the [JSON API](https://www.zabbix.com/documentation/current/en/manual/api). Authentication is performed using a token. Refer to the [Zabbix Documentation](https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/users/api_tokens) for instructions on generating an API token. Take note of the `Expiration date`. For continuous operation, it is recommended to set no expiration, but for security, you should choose what is most appropriate for your environment. ## Step 1: Set Up Zabbix Server -After generating a token, configure a new Zabbix Server in Netbox. Navigate to `Zabbix` -> `Zabbix Servers` in the left-hand menu and click `Add`. +After generating a token, configure a new Zabbix Server in NetBox. Navigate to `Zabbix` -> `Zabbix Servers` in the left-hand menu and click `Add`. | Field | Value | Description | |----------------------------|---------|------------------------------------------------------------------------------------------| -| Name | String | The name of the Zabbix Server; used for reference within Netbox. | +| Name | String | The name of the Zabbix Server; used for reference within NetBox. | | URL | URI | The fully qualified URI of the Zabbix frontend, e.g., `http://192.168.2.31/zabbix` | | Validate HTTPS Certificate | Boolean | Whether to validate the SSL certificate when using HTTPS. | | Token | String | The authentication token for accessing Zabbix. | ## Step 2: Synchronize Templates -Next, import all templates from Zabbix into Netbox so they can be referenced later. To do this, go to the Zabbix Server you created in Step 1 and click the `Sync Templates` button in the upper right corner. +Next, import all templates from Zabbix into NetBox so they can be referenced later. To do this, go to the Zabbix Server you created in Step 1 and click the `Sync Templates` button in the upper right corner. A background job will be scheduled. After a few seconds (if everything works as expected), you should see the templates by navigating to the 'Templates' tab on the Zabbix Server object or by browsing the Zabbix Template objects via the `Zabbix` -> `Zabbix Templates` menu. @@ -45,13 +45,13 @@ First, assign the host to one or more Zabbix Servers. This determines the destin When adding an assignment, you can: - Select the Zabbix Server that should monitor this device. -- Choose the `Zabbix Proxy` or `Zabbix Proxy Group` responsible for monitoring (provided these have already been created in Netbox). +- Choose the `Zabbix Proxy` or `Zabbix Proxy Group` responsible for monitoring, provided these have already been created in NetBox. ### Step 3b: Configure a Host Interface !!! note "When is an interface required?" - Whether an interface is required depends on the templates assigned to the host. nbxSync inspects the item types on each template during the template sync (Step 2) and stores the interface requirements on each `ZabbixTemplate` record. - A host interface is **not** required if all assigned templates consist entirely of items that need no interface (e.g. HTTP agent, Script, Calculated, Dependent). + Whether an interface is required depends on the templates assigned to the host. nbxSync inspects the item types on each template during the template sync (Step 2) and stores the interface requirements on each `ZabbixTemplate` record. + A host interface is **not** required if all assigned templates consist entirely of items that need no interface, such as HTTP agent, Script, Calculated, or Dependent items. In practice, most templates require at least an Agent or SNMP interface. If the Sync button does not work on a device, check that the required interface type matches what the assigned templates expect. After assigning a Zabbix Server, specify how the Zabbix Server will monitor the Device, VDC or Virtual Machine via a [Host Interface](https://www.thezabbixbook.com/ch04-zabbix-collecting-data/host-interfaces/). @@ -87,7 +87,7 @@ Once the Hostgroup is created, create a Hostgroup Assignment on the Device or Vi ## Debugging -If something does not work as expected, relevant information can usually be found in the Netbox logs or Netbox worker logs. If not, enable Debug mode in Netbox for further troubleshooting. +If something does not work as expected, relevant information can usually be found in the NetBox logs or NetBox worker logs. If not, enable debug mode in NetBox for further troubleshooting. ## Triggering Synchronization @@ -95,11 +95,13 @@ Host synchronization can be triggered in three ways. All three paths converge on ### Sync button in the UI -On the `Zabbix` tab of any Device, VDC, or Virtual Machine, a **Sync** button appears when the host meets the minimum requirements (a Zabbix Server Assignment, at least one resolved host group, and a host interface compatible with the assigned templates). Clicking it immediately enqueues a `synchost` background job for that host. +On the `Zabbix` tab of any Device, VDC, or Virtual Machine, a **Sync** button appears when the host meets the minimum requirements: a Zabbix Server Assignment, at least one resolved host group, and a host interface compatible with the assigned templates. Clicking it enqueues a `synchost` RQ job for that host. This job may not appear as a regular NetBox `core.Job` entry because it is queued directly through RQ. ### Background system job -The `Zabbix Sync Hosts job` runs automatically at the interval configured by `backgroundsync.objects.interval` (default: every 60 minutes). It iterates every `ZabbixServerAssignment` in NetBox and enqueues a `synchost` job for each unique Device, VDC, or VM (subject to both `sync_enabled` flags being `True`). +The `Zabbix Sync Hosts job` runs automatically at the interval configured by `backgroundsync.objects.interval` (default: every 60 minutes). It iterates over every `ZabbixServerAssignment` in NetBox and enqueues a `synchost` job for each unique Device, VDC, or VM, subject to both `sync_enabled` flags being `True`. + +If `trigger_dependencies.enabled` is set to `True`, trigger dependency synchronization runs after each successful Device host sync. ### REST API @@ -120,4 +122,4 @@ curl -X POST \ Valid `obj_type` values: `device`, `virtualmachine`, `virtualdevicecontext`. The response is HTTP 202 with `{"count": 1, "results": [{"scheduled": true}]}`. -The endpoint requires a valid NetBox authentication token but no special nbxSync permissions beyond basic API access. \ No newline at end of file +The endpoint requires a valid NetBox authentication token but no special nbxSync permissions beyond basic API access. diff --git a/docs/traffic_flows.md b/docs/traffic_flows.md index 412a6de..0bebe7f 100644 --- a/docs/traffic_flows.md +++ b/docs/traffic_flows.md @@ -2,7 +2,7 @@ NetBox is composed of several components, most importantly the Django application (the frontend) and one or more workers. -- Job handling: nbxSync dispatches jobs into a queue. These jobs are then picked up and executed by a worker. This is native Netbox functionality. +- Job handling: nbxSync dispatches jobs into a queue. These jobs are then picked up and executed by a worker. This is native NetBox functionality. - Zabbix communication: When a job is executed, the worker communicates with the Zabbix API. Depending on the configuration, this communication happens over port 80 (HTTP, unencrypted) or port 443 (HTTPS, encrypted). - Operational View: the NetBox frontend also communicates directly with the Zabbix API to retrieve problems and events for a given host. diff --git a/nbxsync.egg-info/PKG-INFO b/nbxsync.egg-info/PKG-INFO new file mode 100644 index 0000000..a8d8430 --- /dev/null +++ b/nbxsync.egg-info/PKG-INFO @@ -0,0 +1,765 @@ +Metadata-Version: 2.4 +Name: nbxsync +Version: 1.0.4 +Summary: nbxsync +Author-email: Opensource ICT Solutions +License: GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for + software and other kinds of works, specifically designed to ensure + cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed + to take away your freedom to share and change the works. By contrast, + our General Public Licenses are intended to guarantee your freedom to + share and change all versions of a program--to make sure it remains free + software for all its users. + + When we speak of free software, we are referring to freedom, not + price. Our General Public Licenses are designed to make sure that you + have the freedom to distribute copies of free software (and charge for + them if you wish), that you receive source code or can get it if you + want it, that you can change the software or use pieces of it in new + free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights + with two steps: (1) assert copyright on the software, and (2) offer + you this License which gives you legal permission to copy, distribute + and/or modify the software. + + A secondary benefit of defending all users' freedom is that + improvements made in alternate versions of the program, if they + receive widespread use, become available for other developers to + incorporate. Many developers of free software are heartened and + encouraged by the resulting cooperation. However, in the case of + software used on network servers, this result may fail to come about. + The GNU General Public License permits making a modified version and + letting the public access it on a server without ever releasing its + source code to the public. + + The GNU Affero General Public License is designed specifically to + ensure that, in such cases, the modified source code becomes available + to the community. It requires the operator of a network server to + provide the source code of the modified version running there to the + users of that server. Therefore, public use of a modified version, on + a publicly accessible server, gives the public access to the source + code of the modified version. + + An older license, called the Affero General Public License and + published by Affero, was designed to accomplish similar goals. This is + a different license, not a version of the Affero GPL, but Affero has + released a new version of the Affero GPL which permits relicensing under + this license. + + The precise terms and conditions for copying, distribution and + modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of + works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this + License. Each licensee is addressed as "you". "Licensees" and + "recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work + in a fashion requiring copyright permission, other than the making of an + exact copy. The resulting work is called a "modified version" of the + earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based + on the Program. + + To "propagate" a work means to do anything with it that, without + permission, would make you directly or secondarily liable for + infringement under applicable copyright law, except executing it on a + computer or modifying a private copy. Propagation includes copying, + distribution (with or without modification), making available to the + public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other + parties to make or receive copies. Mere interaction with a user through + a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" + to the extent that it includes a convenient and prominently visible + feature that (1) displays an appropriate copyright notice, and (2) + tells the user that there is no warranty for the work (except to the + extent that warranties are provided), that licensees may convey the + work under this License, and how to view a copy of this License. If + the interface presents a list of user commands or options, such as a + menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work + for making modifications to it. "Object code" means any non-source + form of a work. + + A "Standard Interface" means an interface that either is an official + standard defined by a recognized standards body, or, in the case of + interfaces specified for a particular programming language, one that + is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other + than the work as a whole, that (a) is included in the normal form of + packaging a Major Component, but which is not part of that Major + Component, and (b) serves only to enable use of the work with that + Major Component, or to implement a Standard Interface for which an + implementation is available to the public in source code form. A + "Major Component", in this context, means a major essential component + (kernel, window system, and so on) of the specific operating system + (if any) on which the executable work runs, or a compiler used to + produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all + the source code needed to generate, install, and (for an executable + work) run the object code and to modify the work, including scripts to + control those activities. However, it does not include the work's + System Libraries, or general-purpose tools or generally available free + programs which are used unmodified in performing those activities but + which are not part of the work. For example, Corresponding Source + includes interface definition files associated with source files for + the work, and the source code for shared libraries and dynamically + linked subprograms that the work is specifically designed to require, + such as by intimate data communication or control flow between those + subprograms and other parts of the work. + + The Corresponding Source need not include anything that users + can regenerate automatically from other parts of the Corresponding + Source. + + The Corresponding Source for a work in source code form is that + same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of + copyright on the Program, and are irrevocable provided the stated + conditions are met. This License explicitly affirms your unlimited + permission to run the unmodified Program. The output from running a + covered work is covered by this License only if the output, given its + content, constitutes a covered work. This License acknowledges your + rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not + convey, without conditions so long as your license otherwise remains + in force. You may convey covered works to others for the sole purpose + of having them make modifications exclusively for you, or provide you + with facilities for running those works, provided that you comply with + the terms of this License in conveying all material for which you do + not control copyright. Those thus making or running the covered works + for you must do so exclusively on your behalf, under your direction + and control, on terms that prohibit them from making any copies of + your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under + the conditions stated below. Sublicensing is not allowed; section 10 + makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological + measure under any applicable law fulfilling obligations under article + 11 of the WIPO copyright treaty adopted on 20 December 1996, or + similar laws prohibiting or restricting circumvention of such + measures. + + When you convey a covered work, you waive any legal power to forbid + circumvention of technological measures to the extent such circumvention + is effected by exercising rights under this License with respect to + the covered work, and you disclaim any intention to limit operation or + modification of the work as a means of enforcing, against the work's + users, your or third parties' legal rights to forbid circumvention of + technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you + receive it, in any medium, provided that you conspicuously and + appropriately publish on each copy an appropriate copyright notice; + keep intact all notices stating that this License and any + non-permissive terms added in accord with section 7 apply to the code; + keep intact all notices of the absence of any warranty; and give all + recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, + and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to + produce it from the Program, in the form of source code under the + terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent + works, which are not by their nature extensions of the covered work, + and which are not combined with it such as to form a larger program, + in or on a volume of a storage or distribution medium, is called an + "aggregate" if the compilation and its resulting copyright are not + used to limit the access or legal rights of the compilation's users + beyond what the individual works permit. Inclusion of a covered work + in an aggregate does not cause this License to apply to the other + parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms + of sections 4 and 5, provided that you also convey the + machine-readable Corresponding Source under the terms of this License, + in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded + from the Corresponding Source as a System Library, need not be + included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any + tangible personal property which is normally used for personal, family, + or household purposes, or (2) anything designed or sold for incorporation + into a dwelling. In determining whether a product is a consumer product, + doubtful cases shall be resolved in favor of coverage. For a particular + product received by a particular user, "normally used" refers to a + typical or common use of that class of product, regardless of the status + of the particular user or of the way in which the particular user + actually uses, or expects or is expected to use, the product. A product + is a consumer product regardless of whether the product has substantial + commercial, industrial or non-consumer uses, unless such uses represent + the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, + procedures, authorization keys, or other information required to install + and execute modified versions of a covered work in that User Product from + a modified version of its Corresponding Source. The information must + suffice to ensure that the continued functioning of the modified object + code is in no case prevented or interfered with solely because + modification has been made. + + If you convey an object code work under this section in, or with, or + specifically for use in, a User Product, and the conveying occurs as + part of a transaction in which the right of possession and use of the + User Product is transferred to the recipient in perpetuity or for a + fixed term (regardless of how the transaction is characterized), the + Corresponding Source conveyed under this section must be accompanied + by the Installation Information. But this requirement does not apply + if neither you nor any third party retains the ability to install + modified object code on the User Product (for example, the work has + been installed in ROM). + + The requirement to provide Installation Information does not include a + requirement to continue to provide support service, warranty, or updates + for a work that has been modified or installed by the recipient, or for + the User Product in which it has been modified or installed. Access to a + network may be denied when the modification itself materially and + adversely affects the operation of the network or violates the rules and + protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, + in accord with this section must be in a format that is publicly + documented (and with an implementation available to the public in + source code form), and must require no special password or key for + unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this + License by making exceptions from one or more of its conditions. + Additional permissions that are applicable to the entire Program shall + be treated as though they were included in this License, to the extent + that they are valid under applicable law. If additional permissions + apply only to part of the Program, that part may be used separately + under those permissions, but the entire Program remains governed by + this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option + remove any additional permissions from that copy, or from any part of + it. (Additional permissions may be written to require their own + removal in certain cases when you modify the work.) You may place + additional permissions on material, added by you to a covered work, + for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you + add to a covered work, you may (if authorized by the copyright holders of + that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further + restrictions" within the meaning of section 10. If the Program as you + received it, or any part of it, contains a notice stating that it is + governed by this License along with a term that is a further + restriction, you may remove that term. If a license document contains + a further restriction but permits relicensing or conveying under this + License, you may add to a covered work material governed by the terms + of that license document, provided that the further restriction does + not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you + must place, in the relevant source files, a statement of the + additional terms that apply to those files, or a notice indicating + where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the + form of a separately written license, or stated as exceptions; + the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly + provided under this License. Any attempt otherwise to propagate or + modify it is void, and will automatically terminate your rights under + this License (including any patent licenses granted under the third + paragraph of section 11). + + However, if you cease all violation of this License, then your + license from a particular copyright holder is reinstated (a) + provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and (b) permanently, if the copyright + holder fails to notify you of the violation by some reasonable means + prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is + reinstated permanently if the copyright holder notifies you of the + violation by some reasonable means, this is the first time you have + received notice of violation of this License (for any work) from that + copyright holder, and you cure the violation prior to 30 days after + your receipt of the notice. + + Termination of your rights under this section does not terminate the + licenses of parties who have received copies or rights from you under + this License. If your rights have been terminated and not permanently + reinstated, you do not qualify to receive new licenses for the same + material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or + run a copy of the Program. Ancillary propagation of a covered work + occurring solely as a consequence of using peer-to-peer transmission + to receive a copy likewise does not require acceptance. However, + nothing other than this License grants you permission to propagate or + modify any covered work. These actions infringe copyright if you do + not accept this License. Therefore, by modifying or propagating a + covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically + receives a license from the original licensors, to run, modify and + propagate that work, subject to this License. You are not responsible + for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an + organization, or substantially all assets of one, or subdividing an + organization, or merging organizations. If propagation of a covered + work results from an entity transaction, each party to that + transaction who receives a copy of the work also receives whatever + licenses to the work the party's predecessor in interest had or could + give under the previous paragraph, plus a right to possession of the + Corresponding Source of the work from the predecessor in interest, if + the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the + rights granted or affirmed under this License. For example, you may + not impose a license fee, royalty, or other charge for exercise of + rights granted under this License, and you may not initiate litigation + (including a cross-claim or counterclaim in a lawsuit) alleging that + any patent claim is infringed by making, using, selling, offering for + sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this + License of the Program or a work on which the Program is based. The + work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims + owned or controlled by the contributor, whether already acquired or + hereafter acquired, that would be infringed by some manner, permitted + by this License, of making, using, or selling its contributor version, + but do not include claims that would be infringed only as a + consequence of further modification of the contributor version. For + purposes of this definition, "control" includes the right to grant + patent sublicenses in a manner consistent with the requirements of + this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free + patent license under the contributor's essential patent claims, to + make, use, sell, offer for sale, import and otherwise run, modify and + propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express + agreement or commitment, however denominated, not to enforce a patent + (such as an express permission to practice a patent or covenant not to + sue for patent infringement). To "grant" such a patent license to a + party means to make such an agreement or commitment not to enforce a + patent against the party. + + If you convey a covered work, knowingly relying on a patent license, + and the Corresponding Source of the work is not available for anyone + to copy, free of charge and under the terms of this License, through a + publicly available network server or other readily accessible means, + then you must either (1) cause the Corresponding Source to be so + available, or (2) arrange to deprive yourself of the benefit of the + patent license for this particular work, or (3) arrange, in a manner + consistent with the requirements of this License, to extend the patent + license to downstream recipients. "Knowingly relying" means you have + actual knowledge that, but for the patent license, your conveying the + covered work in a country, or your recipient's use of the covered work + in a country, would infringe one or more identifiable patents in that + country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or + arrangement, you convey, or propagate by procuring conveyance of, a + covered work, and grant a patent license to some of the parties + receiving the covered work authorizing them to use, propagate, modify + or convey a specific copy of the covered work, then the patent license + you grant is automatically extended to all recipients of the covered + work and works based on it. + + A patent license is "discriminatory" if it does not include within + the scope of its coverage, prohibits the exercise of, or is + conditioned on the non-exercise of one or more of the rights that are + specifically granted under this License. You may not convey a covered + work if you are a party to an arrangement with a third party that is + in the business of distributing software, under which you make payment + to the third party based on the extent of your activity of conveying + the work, and under which the third party grants, to any of the + parties who would receive the covered work from you, a discriminatory + patent license (a) in connection with copies of the covered work + conveyed by you (or copies made from those copies), or (b) primarily + for and in connection with specific products or compilations that + contain the covered work, unless you entered into that arrangement, + or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting + any implied license or other defenses to infringement that may + otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or + otherwise) that contradict the conditions of this License, they do not + excuse you from the conditions of this License. If you cannot convey a + covered work so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you may + not convey it at all. For example, if you agree to terms that obligate you + to collect a royalty for further conveying from those to whom you convey + the Program, the only way you could satisfy both those terms and this + License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the + Program, your modified version must prominently offer all users + interacting with it remotely through a computer network (if your version + supports such interaction) an opportunity to receive the Corresponding + Source of your version by providing access to the Corresponding Source + from a network server at no charge, through some standard or customary + means of facilitating copying of software. This Corresponding Source + shall include the Corresponding Source for any work covered by version 3 + of the GNU General Public License that is incorporated pursuant to the + following paragraph. + + Notwithstanding any other provision of this License, you have + permission to link or combine any covered work with a work licensed + under version 3 of the GNU General Public License into a single + combined work, and to convey the resulting work. The terms of this + License will continue to apply to the part which is the covered work, + but the work with which it is combined will remain governed by version + 3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of + the GNU Affero General Public License from time to time. Such new versions + will be similar in spirit to the present version, but may differ in detail to + address new problems or concerns. + + Each version is given a distinguishing version number. If the + Program specifies that a certain numbered version of the GNU Affero General + Public License "or any later version" applies to it, you have the + option of following the terms and conditions either of that numbered + version or of any later version published by the Free Software + Foundation. If the Program does not specify a version number of the + GNU Affero General Public License, you may choose any version ever published + by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future + versions of the GNU Affero General Public License can be used, that proxy's + public statement of acceptance of a version permanently authorizes you + to choose that version for the Program. + + Later license versions may give you additional or different + permissions. However, no additional obligations are imposed on any + author or copyright holder as a result of your choosing to follow a + later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY + APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY + OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, + THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM + IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF + ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING + WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS + THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY + GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE + USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF + DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD + PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), + EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF + SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided + above cannot be given local legal effect according to their terms, + reviewing courts shall apply local law that most closely approximates + an absolute waiver of all civil liability in connection with the + Program, unless a warranty or assumption of liability accompanies a + copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest + possible use to the public, the best way to achieve this is to make it + free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest + to attach them to the start of each source file to most effectively + state the exclusion of warranty; and each file should have at least + the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer + network, you should also make sure that it provides a way for users to + get its source. For example, if your program is a web application, its + interface could display a "Source" link that leads users to an archive + of the code. There are many ways you could offer source, and different + solutions will be better for different programs; see section 13 for the + specific requirements. + + You should also get your employer (if you work as a programmer) or school, + if any, to sign a "copyright disclaimer" for the program, if necessary. + For more information on this, and how to apply and follow the GNU AGPL, see + . + +Project-URL: Homepage, https://nbxsync.com +Project-URL: Source, https://github.com/OpensourceICTSolutions/nbxsync +Project-URL: Bug Tracker, https://github.com/OpensourceICTSolutions/nbxsync/issues/ +Keywords: netbox,netbox-plugin,zabbix,nbxsync +Classifier: Programming Language :: Python :: 3 +Classifier: Operating System :: OS Independent +Requires-Python: >=3.10 +Description-Content-Type: text/markdown +License-File: LICENSE +Requires-Dist: zabbix_utils +Requires-Dist: pydantic<2.11 +Provides-Extra: dev +Requires-Dist: ruff; extra == "dev" +Requires-Dist: djlint; extra == "dev" +Requires-Dist: mkdocs-material; extra == "dev" +Dynamic: license-file + +# nbxSync – NetBox ⇄ Zabbix Integration + +**Integrate Netbox as Source of Truth with Zabbix as Monitoring Solution** + +![CI](https://github.com/OpensourceICTSolutions/nbxsync/actions/workflows/ci.yml/badge.svg) +![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/bvbaekel/1a1cf04e63a52d5497edd6e0a564ec2b/raw/4a293f964b246091d1fd943629408dbb7d9f597f/cov.json) +![Python](https://img.shields.io/badge/Python-3.12-blue.svg) +![NetBox](https://img.shields.io/badge/NetBox-4.2|4.3|4.4|4.5-blue.svg) + +--- + +## Description + +nbxSync seamlessly integrates Netbox with Zabbix. + +With nbxSync you can: +✅ Create and manage all your devices in NetBox (your single source of truth) +✅ Automatically sync devices to Zabbix for monitoring +✅ Save time, reduce errors, and ensure consistent, up-to-date monitoring data + +This plugin bridges the gap between network/source-of-truth documentation and infrastructure monitoring – something many teams have been asking for. + +💡 If you’re running both NetBox and Zabbix, this is the missing link you’ve been waiting for. + +## Compatibility + +| Release | Minimum NetBox Version | Maximum NetBox Version | +| ------- | ---------------------- | ---------------------- | +| 1.0.3 | 4.2.0 | 4.5.x | +| 1.0.2 | 4.2.0 | 4.5.x | +| 1.0.1 | 4.2.0 | 4.4.x | +| 1.0.0 | 4.3.0 | 4.4.x | + +--- + +## 📦 Installation + +### 1. Install the plugin + +> [!IMPORTANT] +> The steps below are for a non-dockerized setup. If you run Netbox in Docker containers, please see [their installation instructions](https://netboxlabs.com/docs/netbox/installation/) + +Install using pip + +```bash +pip install nbxsync +``` + +### 2. Enable the plugin in `configuration.py` + +Add to your `PLUGINS` list: + +```python +PLUGINS = [ + 'nbxsync', + # ... other plugins ... +] +``` + +### 3. Apply migrations and collect static files + +```bash +python3 manage.py migrate +python3 manage.py collectstatic +``` + +### 4. Restart NetBox + +```bash +sudo systemctl restart netbox netbox-rq +``` + +--- + +## Screenshots + +![Screenshot 1](docs/assets/img/screenshot1.png "Device Zabbix overview") +--- + +![Screenshot 2](docs/assets/img/screenshot2.png "Device Zabbix Ops overview") +--- diff --git a/nbxsync.egg-info/SOURCES.txt b/nbxsync.egg-info/SOURCES.txt new file mode 100644 index 0000000..1702031 --- /dev/null +++ b/nbxsync.egg-info/SOURCES.txt @@ -0,0 +1,431 @@ +LICENSE +README.md +pyproject.toml +nbxsync/__init__.py +nbxsync/navigation.py +nbxsync/settings.py +nbxsync/template_content.py +nbxsync/urls.py +nbxsync/worker.py +nbxsync.egg-info/PKG-INFO +nbxsync.egg-info/SOURCES.txt +nbxsync.egg-info/dependency_links.txt +nbxsync.egg-info/requires.txt +nbxsync.egg-info/top_level.txt +nbxsync/api/__init__.py +nbxsync/api/urls.py +nbxsync/api/serializers/__init__.py +nbxsync/api/serializers/sync_info.py +nbxsync/api/serializers/zabbixconfigurationgroup.py +nbxsync/api/serializers/zabbixconfigurationgroupassignment.py +nbxsync/api/serializers/zabbixhostgroup.py +nbxsync/api/serializers/zabbixhostgroupassignment.py +nbxsync/api/serializers/zabbixhostinterface.py +nbxsync/api/serializers/zabbixhostinventory.py +nbxsync/api/serializers/zabbixmacro.py +nbxsync/api/serializers/zabbixmacroassignment.py +nbxsync/api/serializers/zabbixmaintenance.py +nbxsync/api/serializers/zabbixmaintenanceobjectassignment.py +nbxsync/api/serializers/zabbixmaintenanceperiod.py +nbxsync/api/serializers/zabbixmaintenancetagassignment.py +nbxsync/api/serializers/zabbixproxy.py +nbxsync/api/serializers/zabbixproxygroup.py +nbxsync/api/serializers/zabbixserver.py +nbxsync/api/serializers/zabbixserverassignment.py +nbxsync/api/serializers/zabbixtag.py +nbxsync/api/serializers/zabbixtagassignment.py +nbxsync/api/serializers/zabbixtemplate.py +nbxsync/api/serializers/zabbixtemplateassignment.py +nbxsync/api/views/__init__.py +nbxsync/api/views/zabbixconfigurationgroup.py +nbxsync/api/views/zabbixconfigurationgroupassignment.py +nbxsync/api/views/zabbixhostgroup.py +nbxsync/api/views/zabbixhostgroupassignment.py +nbxsync/api/views/zabbixhostinterface.py +nbxsync/api/views/zabbixhostinventory.py +nbxsync/api/views/zabbixmacro.py +nbxsync/api/views/zabbixmacroassignment.py +nbxsync/api/views/zabbixmaintenance.py +nbxsync/api/views/zabbixmaintenanceobjectassignment.py +nbxsync/api/views/zabbixmaintenanceperiod.py +nbxsync/api/views/zabbixmaintenancetagassignment.py +nbxsync/api/views/zabbixproxy.py +nbxsync/api/views/zabbixproxygroup.py +nbxsync/api/views/zabbixserver.py +nbxsync/api/views/zabbixserverassignment.py +nbxsync/api/views/zabbixsync.py +nbxsync/api/views/zabbixtag.py +nbxsync/api/views/zabbixtagassignment.py +nbxsync/api/views/zabbixtemplate.py +nbxsync/api/views/zabbixtemplateassignment.py +nbxsync/choices/__init__.py +nbxsync/choices/ipmiauthtype.py +nbxsync/choices/ipmiprivilege.py +nbxsync/choices/severitychoices.py +nbxsync/choices/syncsot.py +nbxsync/choices/zabbixhostinterfacerequirement.py +nbxsync/choices/zabbixhostinterfacetype.py +nbxsync/choices/zabbixhostinventorymode.py +nbxsync/choices/zabbixinterfacesnmpv3authproto.py +nbxsync/choices/zabbixinterfacesnmpv3privproto.py +nbxsync/choices/zabbixinterfacesnmpv3securitylevel.py +nbxsync/choices/zabbixinterfacesnmpversion.py +nbxsync/choices/zabbixinterfacetype.py +nbxsync/choices/zabbixinterfaceuse.py +nbxsync/choices/zabbixmacro.py +nbxsync/choices/zabbixmaintenancetagoperator.py +nbxsync/choices/zabbixmaintenancetagseval.py +nbxsync/choices/zabbixmaintenancetype.py +nbxsync/choices/zabbixproxytype.py +nbxsync/choices/zabbixstatus.py +nbxsync/choices/zabbixtimeperioddayofweek.py +nbxsync/choices/zabbixtimeperioddayofweekoption.py +nbxsync/choices/zabbixtimeperiodmonth.py +nbxsync/choices/zabbixtimeperiodmonthdate.py +nbxsync/choices/zabbixtimeperiodtype.py +nbxsync/choices/zabbixtls.py +nbxsync/constants/__init__.py +nbxsync/constants/add_hostinterface_button.py +nbxsync/constants/assignment_models.py +nbxsync/constants/assignment_type_to_field.py +nbxsync/constants/inheritance_source_colors.py +nbxsync/constants/itemtype.py +nbxsync/constants/path_labels.py +nbxsync/filtersets/__init__.py +nbxsync/filtersets/zabbixconfiguationgroupassignment.py +nbxsync/filtersets/zabbixconfigurationgroup.py +nbxsync/filtersets/zabbixconfigurationgroupassignment.py +nbxsync/filtersets/zabbixhostgroup.py +nbxsync/filtersets/zabbixhostgroupassignment.py +nbxsync/filtersets/zabbixhostinterface.py +nbxsync/filtersets/zabbixhostinventory.py +nbxsync/filtersets/zabbixmacro.py +nbxsync/filtersets/zabbixmacroassignment.py +nbxsync/filtersets/zabbixmaintenance.py +nbxsync/filtersets/zabbixmaintenanceobjectassignment.py +nbxsync/filtersets/zabbixmaintenanceperiod.py +nbxsync/filtersets/zabbixmaintenancetagassignment.py +nbxsync/filtersets/zabbixproxy.py +nbxsync/filtersets/zabbixproxygroup.py +nbxsync/filtersets/zabbixserver.py +nbxsync/filtersets/zabbixserverassignment.py +nbxsync/filtersets/zabbixtag.py +nbxsync/filtersets/zabbixtagassignment.py +nbxsync/filtersets/zabbixtemplate.py +nbxsync/filtersets/zabbixtemplateassignment.py +nbxsync/forms/__init__.py +nbxsync/forms/zabbixconfigurationgroup.py +nbxsync/forms/zabbixconfigurationgroupassignment.py +nbxsync/forms/zabbixhostgroup.py +nbxsync/forms/zabbixhostgroupassignment.py +nbxsync/forms/zabbixhostinterface.py +nbxsync/forms/zabbixhostinventory.py +nbxsync/forms/zabbixmacro.py +nbxsync/forms/zabbixmacroassignment.py +nbxsync/forms/zabbixmaintenance.py +nbxsync/forms/zabbixmaintenanceobjectassignment.py +nbxsync/forms/zabbixmaintenanceperiod.py +nbxsync/forms/zabbixmaintenancetagassignment.py +nbxsync/forms/zabbixproxy.py +nbxsync/forms/zabbixproxygroup.py +nbxsync/forms/zabbixserver.py +nbxsync/forms/zabbixserverassignment.py +nbxsync/forms/zabbixtag.py +nbxsync/forms/zabbixtagassignment.py +nbxsync/forms/zabbixtemplate.py +nbxsync/forms/zabbixtemplateassignment.py +nbxsync/forms/fields/__init__.py +nbxsync/forms/fields/multi_ip_field.py +nbxsync/forms/widgets/__init__.py +nbxsync/forms/widgets/multipwidget.py +nbxsync/jobs/__init__.py +nbxsync/jobs/cfggroup.py +nbxsync/jobs/deletehost.py +nbxsync/jobs/deletemaintenance.py +nbxsync/jobs/synchost.py +nbxsync/jobs/syncmaintenance.py +nbxsync/jobs/syncproxy.py +nbxsync/jobs/syncproxygroup.py +nbxsync/jobs/synctemplates.py +nbxsync/migrations/0001_initial.py +nbxsync/migrations/0002_zabbixmaintenance_automatic.py +nbxsync/migrations/0003_alter_zabbixhostgroupassignment_assigned_object_type_and_more.py +nbxsync/migrations/0004_alter_zabbixhostinterface_port.py +nbxsync/migrations/0005_alter_zabbixhostgroupassignment_assigned_object_type_and_more.py +nbxsync/migrations/0006_zabbixconfigurationgroup_and_more.py +nbxsync/migrations/0007_alter_zabbixhostinterface_tls_psk.py +nbxsync/migrations/0008_alter_zabbixhostinventory_location_lat_and_more.py +nbxsync/migrations/0009_remove_zabbixhostinterface_nbxsync_zabbixhostinterface_unique__server_type_object_and_more.py +nbxsync/migrations/0010_zabbixhostinterface_snmp_pushcommunity.py +nbxsync/migrations/0011_zabbixhostinterface_max_repetitions_and_more.py +nbxsync/migrations/0012_zabbixserver_skip_version_check.py +nbxsync/migrations/__init__.py +nbxsync/mixins/__init__.py +nbxsync/mixins/zabbixtabmixin.py +nbxsync/models/__init__.py +nbxsync/models/sync_info.py +nbxsync/models/zabbixconfigurationgroup.py +nbxsync/models/zabbixconfigurationgroupassignment.py +nbxsync/models/zabbixevent.py +nbxsync/models/zabbixhostgroup.py +nbxsync/models/zabbixhostgroupassignment.py +nbxsync/models/zabbixhostinterface.py +nbxsync/models/zabbixhostinventory.py +nbxsync/models/zabbixmacro.py +nbxsync/models/zabbixmacroassignment.py +nbxsync/models/zabbixmaintenance.py +nbxsync/models/zabbixmaintenanceobjectassignment.py +nbxsync/models/zabbixmaintenanceperiod.py +nbxsync/models/zabbixmaintenancetagassignment.py +nbxsync/models/zabbixproblem.py +nbxsync/models/zabbixproxy.py +nbxsync/models/zabbixproxygroup.py +nbxsync/models/zabbixserver.py +nbxsync/models/zabbixserverassignment.py +nbxsync/models/zabbixtag.py +nbxsync/models/zabbixtagassignment.py +nbxsync/models/zabbixtemplate.py +nbxsync/models/zabbixtemplateassignment.py +nbxsync/signals/__init__.py +nbxsync/signals/ipaddress.py +nbxsync/signals/nbobjects.py +nbxsync/signals/zabbixconfigurationgroupassignment.py +nbxsync/signals/zabbixhostgroupassignment.py +nbxsync/signals/zabbixhostinterface.py +nbxsync/signals/zabbixmacroassignment.py +nbxsync/signals/zabbixmaintenance.py +nbxsync/signals/zabbixserver.py +nbxsync/signals/zabbixserverassignment.py +nbxsync/signals/zabbixtagassignment.py +nbxsync/signals/zabbixtemplate.py +nbxsync/signals/zabbixtemplateassignment.py +nbxsync/static/nbxsync/css/password_field.css +nbxsync/static/nbxsync/js/multi-ip-widget.js +nbxsync/static/nbxsync/js/zabbixhostinterface-form.js +nbxsync/static/nbxsync/js/zabbixmacroassignment-form.js +nbxsync/static/nbxsync/js/zabbixmaintenanceperiod-form.js +nbxsync/static/nbxsync/js/zabbixproxy-form.js +nbxsync/static/nbxsync/js/zabbixserver-form.js +nbxsync/systemjobs/__init__.py +nbxsync/systemjobs/sync_maintenance.py +nbxsync/systemjobs/sync_objects.py +nbxsync/systemjobs/sync_proxies.py +nbxsync/systemjobs/sync_templates.py +nbxsync/tables/__init__.py +nbxsync/tables/columns.py +nbxsync/tables/zabbixconfigurationgroup.py +nbxsync/tables/zabbixconfigurationgroupassignment.py +nbxsync/tables/zabbixevent.py +nbxsync/tables/zabbixhostgroup.py +nbxsync/tables/zabbixhostgroupassignment.py +nbxsync/tables/zabbixhostinterface.py +nbxsync/tables/zabbixhostinventory.py +nbxsync/tables/zabbixinheritedassignment.py +nbxsync/tables/zabbixmacro.py +nbxsync/tables/zabbixmacroassignment.py +nbxsync/tables/zabbixmaintenance.py +nbxsync/tables/zabbixmaintenanceobjectassignment.py +nbxsync/tables/zabbixmaintenanceperiod.py +nbxsync/tables/zabbixmaintenancetagassignment.py +nbxsync/tables/zabbixproblem.py +nbxsync/tables/zabbixproxy.py +nbxsync/tables/zabbixproxygroup.py +nbxsync/tables/zabbixserver.py +nbxsync/tables/zabbixserverassignment.py +nbxsync/tables/zabbixtag.py +nbxsync/tables/zabbixtagassignment.py +nbxsync/tables/zabbixtemplate.py +nbxsync/tables/zabbixtemplateassignment.py +nbxsync/templates/generic/base.html +nbxsync/templates/nbxsync/zabbixconfigurationgroup.html +nbxsync/templates/nbxsync/zabbixconfigurationgroupassignment.html +nbxsync/templates/nbxsync/zabbixhostgroup.html +nbxsync/templates/nbxsync/zabbixhostgroupassignment.html +nbxsync/templates/nbxsync/zabbixhostinterface.html +nbxsync/templates/nbxsync/zabbixhostinventory.html +nbxsync/templates/nbxsync/zabbixmacro.html +nbxsync/templates/nbxsync/zabbixmacroassignment.html +nbxsync/templates/nbxsync/zabbixmaintenance.html +nbxsync/templates/nbxsync/zabbixmaintenanceobjectassignment.html +nbxsync/templates/nbxsync/zabbixmaintenancetagassignment.html +nbxsync/templates/nbxsync/zabbixproxy.html +nbxsync/templates/nbxsync/zabbixproxygroup.html +nbxsync/templates/nbxsync/zabbixserver.html +nbxsync/templates/nbxsync/zabbixserver_edit.html +nbxsync/templates/nbxsync/zabbixserverassignment.html +nbxsync/templates/nbxsync/zabbixtag.html +nbxsync/templates/nbxsync/zabbixtagassignment.html +nbxsync/templates/nbxsync/zabbixtemplate.html +nbxsync/templates/nbxsync/zabbixtemplateassignment.html +nbxsync/templates/nbxsync/buttons/syncconfigurationgroup.html +nbxsync/templates/nbxsync/buttons/synchost.html +nbxsync/templates/nbxsync/buttons/syncmaintenance.html +nbxsync/templates/nbxsync/buttons/syncproxy.html +nbxsync/templates/nbxsync/buttons/syncproxygroup.html +nbxsync/templates/nbxsync/buttons/synctemplate.html +nbxsync/templates/nbxsync/forms/zabbixhostinterface.html +nbxsync/templates/nbxsync/forms/zabbixmacroassignment.html +nbxsync/templates/nbxsync/forms/zabbixmaintenanceperiod.html +nbxsync/templates/nbxsync/forms/zabbixproxy.html +nbxsync/templates/nbxsync/inc/sync_status.html +nbxsync/templates/nbxsync/modals/op_view.html +nbxsync/templates/nbxsync/modals/sync_info.html +nbxsync/templates/nbxsync/tabs/full.html +nbxsync/templates/nbxsync/tabs/minimal.html +nbxsync/templates/nbxsync/tabs/ops.html +nbxsync/templates/nbxsync/widgets/multi_ip_widget.html +nbxsync/templatetags/__init__.py +nbxsync/templatetags/render_field.py +nbxsync/templatetags/zabbix_hostgroups.py +nbxsync/templatetags/zabbix_hostinterfaces.py +nbxsync/templatetags/zabbix_macros.py +nbxsync/templatetags/zabbix_tags.py +nbxsync/tests/__init__.py +nbxsync/tests/test_plugin_settings.py +nbxsync/tests/test_worker.py +nbxsync/tests/filtersets/__init__.py +nbxsync/tests/filtersets/test_zabbixconfigurationgroup.py +nbxsync/tests/filtersets/test_zabbixconfigurationgroupassignment.py +nbxsync/tests/filtersets/test_zabbixhostgroup.py +nbxsync/tests/filtersets/test_zabbixhostgroupassignment.py +nbxsync/tests/filtersets/test_zabbixhostinterface.py +nbxsync/tests/filtersets/test_zabbixhostinventory.py +nbxsync/tests/filtersets/test_zabbixmacro.py +nbxsync/tests/filtersets/test_zabbixmacroassignment.py +nbxsync/tests/filtersets/test_zabbixproxy.py +nbxsync/tests/filtersets/test_zabbixproxygroup.py +nbxsync/tests/filtersets/test_zabbixserver.py +nbxsync/tests/filtersets/test_zabbixserverassignment.py +nbxsync/tests/filtersets/test_zabbixtag.py +nbxsync/tests/filtersets/test_zabbixtagassignment.py +nbxsync/tests/filtersets/test_zabbixtemplate.py +nbxsync/tests/filtersets/test_zabbixtemplateassignment.py +nbxsync/tests/jobs/__init__.py +nbxsync/tests/jobs/test_deletehost.py +nbxsync/tests/jobs/test_synchost.py +nbxsync/tests/jobs/test_syncproxy.py +nbxsync/tests/jobs/test_syncproxygroup.py +nbxsync/tests/jobs/test_synctemplates.py +nbxsync/tests/models/__init__.py +nbxsync/tests/models/test_sync_info.py +nbxsync/tests/models/test_zabbixconfigurationgroup.py +nbxsync/tests/models/test_zabbixconfigurationgroupassignment.py +nbxsync/tests/models/test_zabbixhostgroup.py +nbxsync/tests/models/test_zabbixhostgroupassignment.py +nbxsync/tests/models/test_zabbixhostinterface.py +nbxsync/tests/models/test_zabbixhostinventory.py +nbxsync/tests/models/test_zabbixmacro.py +nbxsync/tests/models/test_zabbixmacroassignment.py +nbxsync/tests/models/test_zabbixproxy.py +nbxsync/tests/models/test_zabbixproxygroup.py +nbxsync/tests/models/test_zabbixserver.py +nbxsync/tests/models/test_zabbixserverassignment.py +nbxsync/tests/models/test_zabbixtag.py +nbxsync/tests/models/test_zabbixtagassignment.py +nbxsync/tests/models/test_zabbixtemplate.py +nbxsync/tests/models/test_zabbixtemplateassignment.py +nbxsync/tests/signals/__init__.py +nbxsync/tests/signals/test_zabbixconfigurationgroupassignment.py +nbxsync/tests/signals/test_zabbixhostgroupassignment.py +nbxsync/tests/signals/test_zabbixhostinterface.py +nbxsync/tests/signals/test_zabbixmacroassignment.py +nbxsync/tests/signals/test_zabbixserver.py +nbxsync/tests/signals/test_zabbixserverassignment.py +nbxsync/tests/signals/test_zabbixtagassignment.py +nbxsync/tests/signals/test_zabbixtemplateassignment.py +nbxsync/tests/systemjobs/__init__.py +nbxsync/tests/systemjobs/test_sync_maintenance.py +nbxsync/tests/systemjobs/test_sync_objects.py +nbxsync/tests/systemjobs/test_sync_proxies.py +nbxsync/tests/systemjobs/test_sync_templates.py +nbxsync/tests/utils/__init__.py +nbxsync/tests/utils/test_cfggroup_resync.py +nbxsync/tests/utils/test_cfggroup_utils.py +nbxsync/tests/utils/test_get_assigned_zabbixobjects.py +nbxsync/tests/utils/test_get_zabbixassignments_for_request.py +nbxsync/tests/utils/test_helpers.py +nbxsync/tests/utils/test_hostgroupsync.py +nbxsync/tests/utils/test_hostinterfacesync.py +nbxsync/tests/utils/test_hostsync.py +nbxsync/tests/utils/test_maintenance_sync.py +nbxsync/tests/utils/test_maintenancesync.py +nbxsync/tests/utils/test_proxygroupsync.py +nbxsync/tests/utils/test_proxysync.py +nbxsync/tests/utils/test_resolve_inherited_zabbix_assignments.py +nbxsync/tests/utils/test_run_zabbix_operations.py +nbxsync/tests/utils/test_safedelete.py +nbxsync/tests/utils/test_safesync.py +nbxsync/tests/utils/test_set_nested_attr.py +nbxsync/tests/utils/test_syncbase.py +nbxsync/tests/utils/test_trigger_dependency_sync.py +nbxsync/tests/utils/test_zabbixconnection.py +nbxsync/tests/views/__init__.py +nbxsync/tests/views/test_devicetab.py +nbxsync/tests/views/test_jobs.py +nbxsync/tests/views/test_virtualdevicecontexttab.py +nbxsync/tests/views/test_virtualmachinetab.py +nbxsync/tests/views/test_zabbixconfigurationgroup.py +nbxsync/tests/views/test_zabbixconfigurationgroupassignment.py +nbxsync/tests/views/test_zabbixhostgroup.py +nbxsync/tests/views/test_zabbixhostgroupassignment.py +nbxsync/tests/views/test_zabbixhostinterface.py +nbxsync/tests/views/test_zabbixhostinventory.py +nbxsync/tests/views/test_zabbixmacro.py +nbxsync/tests/views/test_zabbixmacroassignment.py +nbxsync/tests/views/test_zabbixproxy.py +nbxsync/tests/views/test_zabbixproxygroup.py +nbxsync/tests/views/test_zabbixserver.py +nbxsync/tests/views/test_zabbixserverassignment.py +nbxsync/tests/views/test_zabbixtag.py +nbxsync/tests/views/test_zabbixtagassignment.py +nbxsync/tests/views/test_zabbixtemplate.py +nbxsync/tests/views/test_zabbixtemplateassignment.py +nbxsync/utils/__init__.py +nbxsync/utils/helpers.py +nbxsync/utils/inheritance.py +nbxsync/utils/maintenance_sync.py +nbxsync/utils/resolve_attr.py +nbxsync/utils/resolve_zabbixserver.py +nbxsync/utils/set_nested_attr.py +nbxsync/utils/trigger_dependency_sync.py +nbxsync/utils/zabbixconnection.py +nbxsync/utils/cfggroup/__init__.py +nbxsync/utils/cfggroup/helpers.py +nbxsync/utils/cfggroup/resync_zabbixconfiggroupassignment.py +nbxsync/utils/sync/__init__.py +nbxsync/utils/sync/hostgroupsync.py +nbxsync/utils/sync/hostinterfacesync.py +nbxsync/utils/sync/hostsync.py +nbxsync/utils/sync/maintenancesync.py +nbxsync/utils/sync/proxygroupsync.py +nbxsync/utils/sync/proxysync.py +nbxsync/utils/sync/run_zabbix_operations.py +nbxsync/utils/sync/safe_delete.py +nbxsync/utils/sync/safe_sync.py +nbxsync/utils/sync/syncbase.py +nbxsync/validators/__init__.py +nbxsync/validators/validate_address.py +nbxsync/views/__init__.py +nbxsync/views/hostinfo.py +nbxsync/views/jobs.py +nbxsync/views/tabs.py +nbxsync/views/zabbixconfigurationgroup.py +nbxsync/views/zabbixconfigurationgroupassignment.py +nbxsync/views/zabbixhostgroup.py +nbxsync/views/zabbixhostgroupassignment.py +nbxsync/views/zabbixhostinterface.py +nbxsync/views/zabbixhostinventory.py +nbxsync/views/zabbixmacro.py +nbxsync/views/zabbixmacroassignment.py +nbxsync/views/zabbixmaintenance.py +nbxsync/views/zabbixmaintenanceobjectassignment.py +nbxsync/views/zabbixmaintenanceperiod.py +nbxsync/views/zabbixmaintenancetagassignment.py +nbxsync/views/zabbixproxy.py +nbxsync/views/zabbixproxygroup.py +nbxsync/views/zabbixserver.py +nbxsync/views/zabbixserverassignment.py +nbxsync/views/zabbixtag.py +nbxsync/views/zabbixtagassignment.py +nbxsync/views/zabbixtemplate.py +nbxsync/views/zabbixtemplateassignment.py \ No newline at end of file diff --git a/nbxsync.egg-info/dependency_links.txt b/nbxsync.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/nbxsync.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/nbxsync.egg-info/requires.txt b/nbxsync.egg-info/requires.txt new file mode 100644 index 0000000..2369d3b --- /dev/null +++ b/nbxsync.egg-info/requires.txt @@ -0,0 +1,7 @@ +zabbix_utils +pydantic<2.11 + +[dev] +ruff +djlint +mkdocs-material diff --git a/nbxsync.egg-info/top_level.txt b/nbxsync.egg-info/top_level.txt new file mode 100644 index 0000000..e475ffa --- /dev/null +++ b/nbxsync.egg-info/top_level.txt @@ -0,0 +1 @@ +nbxsync diff --git a/nbxsync/__init__.py b/nbxsync/__init__.py index 7311d8d..b30d596 100644 --- a/nbxsync/__init__.py +++ b/nbxsync/__init__.py @@ -111,6 +111,39 @@ class nbxSync(PluginConfig): 'interval': 15, # 15 minutes }, }, + 'trigger_dependencies': { + 'enabled': False, + 'levels': [ + { + 'name': 'access_point', + 'roles': ['access point', 'access-point', 'ap'], + 'trigger_description': 'AP status', + }, + { + 'name': 'switch', + 'roles': ['switch', 'switches'], + 'trigger_description': 'Switch status', + }, + { + 'name': 'gateway', + 'roles': [ + 'gateway', + 'gateways', + 'gw', + 'firewall', + 'firewalls', + 'meraki gw', + 'meraki-gw', + 'meraki mx', + 'meraki-mx', + 'mx', + 'security appliance', + 'security-appliance', + ], + 'trigger_description': 'Gateway status', + }, + ], + }, 'no_alerting_tag': 'NO_ALERTING', 'no_alerting_tag_value': '1', 'maintenance_window_duration': 3600, diff --git a/nbxsync/jobs/synchost.py b/nbxsync/jobs/synchost.py index 408fea0..b78e4c5 100644 --- a/nbxsync/jobs/synchost.py +++ b/nbxsync/jobs/synchost.py @@ -7,6 +7,7 @@ from nbxsync.utils.sync import HostGroupSync, HostInterfaceSync, HostSync, ProxyGroupSync, ProxySync, run_zabbix_operation from nbxsync.utils.sync.safe_delete import safe_delete from nbxsync.utils.sync.safe_sync import safe_sync +from nbxsync.utils.trigger_dependency_sync import sync_device_trigger_dependencies __all__ = ('SyncHostJob',) @@ -37,6 +38,9 @@ def run(self): self.sync_host(assignment) self.verify_hostinterfaces(assignment) + if object_type == 'device' and zabbix_status != ZabbixHostStatus.DELETED and pluginsettings.trigger_dependencies.enabled: + sync_device_trigger_dependencies(self.instance) + def delete_host(self, assignment): safe_delete(HostSync, assignment) diff --git a/nbxsync/settings.py b/nbxsync/settings.py index 7e657b6..016d532 100644 --- a/nbxsync/settings.py +++ b/nbxsync/settings.py @@ -1,4 +1,4 @@ -from typing import Dict, List, Optional, Tuple +from typing import Dict, List, Tuple from django.apps import apps from pydantic import BaseModel, Field, field_validator @@ -6,7 +6,7 @@ from nbxsync.choices.syncsot import SyncSOT from nbxsync.choices.zabbixstatus import ZabbixHostStatus -__all__ = ('PluginSettingsModel',) +__all__ = ('PluginSettingsModel', 'TriggerDependencyConfig', 'TriggerDependencyLevelConfig') class SoTConfig(BaseModel): @@ -50,11 +50,72 @@ class BackgroundSync(BaseModel): maintenance: BackgroundSyncConfig = Field(default_factory=BackgroundSyncConfig) +class TriggerDependencyLevelConfig(BaseModel): + name: str + roles: List[str] + trigger_description: str + + @field_validator('name', 'trigger_description', mode='before') + def validate_non_empty_string(cls, v: str) -> str: + if not isinstance(v, str) or not v.strip(): + raise ValueError('Value must be a non-empty string') + return v.strip() + + @field_validator('roles', mode='before') + def validate_role_tokens(cls, v: List[str]) -> List[str]: + if not isinstance(v, list) or not v: + raise ValueError('Role tokens must be a non-empty list') + return v + + +class TriggerDependencyConfig(BaseModel): + enabled: bool = Field(default=False) + levels: List[TriggerDependencyLevelConfig] = Field( + default_factory=lambda: [ + TriggerDependencyLevelConfig( + name='access_point', + roles=['access point', 'access-point', 'ap'], + trigger_description='AP status', + ), + TriggerDependencyLevelConfig( + name='switch', + roles=['switch', 'switches'], + trigger_description='Switch status', + ), + TriggerDependencyLevelConfig( + name='gateway', + roles=[ + 'gateway', + 'gateways', + 'gw', + 'firewall', + 'firewalls', + 'meraki gw', + 'meraki-gw', + 'meraki mx', + 'meraki-mx', + 'mx', + 'security appliance', + 'security-appliance', + ], + trigger_description='Gateway status', + ), + ] + ) + + @field_validator('levels', mode='before') + def validate_levels(cls, v: List[TriggerDependencyLevelConfig]) -> List[TriggerDependencyLevelConfig]: + if not isinstance(v, list) or not v: + raise ValueError('Dependency levels must be a non-empty list') + return v + + class PluginSettingsModel(BaseModel): sot: SoTConfig = SoTConfig() statusmapping: StatusMapping = Field(default_factory=StatusMapping) snmpconfig: SNMPConfig = Field(default_factory=SNMPConfig) backgroundsync: BackgroundSync = Field(default_factory=BackgroundSync) + trigger_dependencies: TriggerDependencyConfig = Field(default_factory=TriggerDependencyConfig) inheritance_chain: List[Tuple[str, ...]] = Field( default_factory=lambda: [ ('device',), diff --git a/nbxsync/tests/jobs/test_synchost.py b/nbxsync/tests/jobs/test_synchost.py index 9ed526d..d570a41 100644 --- a/nbxsync/tests/jobs/test_synchost.py +++ b/nbxsync/tests/jobs/test_synchost.py @@ -11,11 +11,14 @@ from nbxsync.choices.zabbixstatus import ZabbixHostStatus from nbxsync.jobs.synchost import SyncHostJob from nbxsync.models import ZabbixHostgroup, ZabbixHostgroupAssignment, ZabbixHostInterface, ZabbixProxy, ZabbixProxyGroup, ZabbixServer, ZabbixServerAssignment -from nbxsync.utils.sync import HostSync, ProxyGroupSync, HostInterfaceSync +from nbxsync.settings import get_plugin_settings +from nbxsync.utils.sync import HostInterfaceSync, HostSync, ProxyGroupSync class SyncHostJobTestCase(TestCase): def setUp(self): + get_plugin_settings().trigger_dependencies.enabled = False + self.device = create_test_device(name='SyncHostVM') self.device_ct = ContentType.objects.get_for_model(Device) @@ -100,12 +103,26 @@ def test_run_sync_host_success(self): job = SyncHostJob(instance=self.device) job.run() + @patch('nbxsync.jobs.synchost.sync_device_trigger_dependencies') + def test_run_skips_trigger_dependency_sync_by_default(self, mock_sync_dependencies): + job = SyncHostJob(instance=self.device) + job.run() + + mock_sync_dependencies.assert_not_called() + + @patch('nbxsync.jobs.synchost.sync_device_trigger_dependencies') + def test_run_syncs_trigger_dependencies_when_enabled(self, mock_sync_dependencies): + get_plugin_settings().trigger_dependencies.enabled = True + + job = SyncHostJob(instance=self.device) + job.run() + + mock_sync_dependencies.assert_called_once_with(self.device) + def test_run_sync_host_deleted(self): self.device.status = 'decommissioning' self.device.save() # Set mapping to deleted for test - from nbxsync.settings import get_plugin_settings - pluginsettings = get_plugin_settings() pluginsettings.statusmapping.device['decommissioning'] = ZabbixHostStatus.DELETED diff --git a/nbxsync/tests/test_plugin_settings.py b/nbxsync/tests/test_plugin_settings.py index cf7b509..ac6b878 100644 --- a/nbxsync/tests/test_plugin_settings.py +++ b/nbxsync/tests/test_plugin_settings.py @@ -4,7 +4,14 @@ from pydantic import ValidationError from nbxsync.choices.syncsot import SyncSOT -from nbxsync.settings import PluginSettingsModel, SNMPConfig, BackgroundSyncConfig, get_plugin_settings +from nbxsync.settings import ( + PluginSettingsModel, + SNMPConfig, + BackgroundSyncConfig, + TriggerDependencyConfig, + TriggerDependencyLevelConfig, + get_plugin_settings, +) class PluginSettingsModelTestCase(TestCase): @@ -19,6 +26,8 @@ def test_default_settings_model(self): self.assertIsInstance(settings.backgroundsync.templates, BackgroundSyncConfig) self.assertIsInstance(settings.backgroundsync.proxies, BackgroundSyncConfig) self.assertIsInstance(settings.backgroundsync.maintenance, BackgroundSyncConfig) + self.assertIsInstance(settings.trigger_dependencies, TriggerDependencyConfig) + self.assertFalse(settings.trigger_dependencies.enabled) def test_snmp_macro_validation_valid(self): config = SNMPConfig(snmp_community='{$VALID_COMM}', snmp_authpass='{$VALID_AUTH}', snmp_privpass='{$VALID_PRIV}') @@ -83,3 +92,18 @@ def test_snmp_macro_validation_trailing_brace_missing(self): snmp_privpass='{$OK}', ) self.assertIn("Value must start with '{$' and end with '}'", str(ctx.exception)) + + def test_trigger_dependency_level_description_validation(self): + with self.assertRaises(ValidationError) as ctx: + TriggerDependencyLevelConfig(name='access_point', roles=['ap'], trigger_description=' ') + self.assertIn('Value must be a non-empty string', str(ctx.exception)) + + def test_trigger_dependency_level_role_validation(self): + with self.assertRaises(ValidationError) as ctx: + TriggerDependencyLevelConfig(name='access_point', roles=[], trigger_description='AP status') + self.assertIn('Role tokens must be a non-empty list', str(ctx.exception)) + + def test_trigger_dependency_levels_validation(self): + with self.assertRaises(ValidationError) as ctx: + TriggerDependencyConfig(levels=[]) + self.assertIn('Dependency levels must be a non-empty list', str(ctx.exception)) diff --git a/nbxsync/tests/utils/test_trigger_dependency_sync.py b/nbxsync/tests/utils/test_trigger_dependency_sync.py new file mode 100644 index 0000000..5bada30 --- /dev/null +++ b/nbxsync/tests/utils/test_trigger_dependency_sync.py @@ -0,0 +1,78 @@ +from types import SimpleNamespace +from unittest.mock import patch + +from django.test import TestCase + +from nbxsync.settings import PluginSettingsModel +from nbxsync.utils.trigger_dependency_sync import build_dependency_payload, get_dependency_level, normalized_role_tokens, sync_device_trigger_dependencies + + +class TriggerDependencySyncTestCase(TestCase): + def setUp(self): + self.trigger_config = PluginSettingsModel().trigger_dependencies + + def test_normalized_role_tokens_reads_name_and_slug(self): + device = SimpleNamespace(role=SimpleNamespace(name='Meraki MX', slug='meraki-mx')) + + self.assertEqual(normalized_role_tokens(device), {'meraki mx', 'meraki-mx'}) + + def test_role_matching_uses_configured_level_tokens(self): + access_point = SimpleNamespace(role=SimpleNamespace(name='Access Point', slug='access-point')) + switch = SimpleNamespace(role=SimpleNamespace(name='Switch', slug='switch')) + gateway = SimpleNamespace(role=SimpleNamespace(name='Security Appliance', slug='security-appliance')) + firewall = SimpleNamespace(role=SimpleNamespace(name='Firewall', slug='firewall')) + + access_point_index, access_point_level = get_dependency_level(access_point, trigger_config=self.trigger_config) + switch_index, switch_level = get_dependency_level(switch, trigger_config=self.trigger_config) + gateway_index, gateway_level = get_dependency_level(gateway, trigger_config=self.trigger_config) + firewall_index, firewall_level = get_dependency_level(firewall, trigger_config=self.trigger_config) + + self.assertEqual((access_point_index, access_point_level.name), (0, 'access_point')) + self.assertEqual((switch_index, switch_level.name), (1, 'switch')) + self.assertEqual((gateway_index, gateway_level.name), (2, 'gateway')) + self.assertEqual((firewall_index, firewall_level.name), (2, 'gateway')) + + def test_build_dependency_payload_preserves_unmanaged_dependencies(self): + child_trigger = { + 'triggerid': '100', + 'dependencies': [ + {'triggerid': '200', 'description': 'Unrelated dependency'}, + {'triggerid': '201', 'description': self.trigger_config.levels[1].trigger_description}, + ], + } + + payload = build_dependency_payload( + child_trigger, + ['300'], + {self.trigger_config.levels[1].trigger_description}, + ) + + self.assertEqual(payload, [{'triggerid': '200'}, {'triggerid': '300'}]) + + def test_build_dependency_payload_deduplicates_parent_dependencies(self): + child_trigger = { + 'triggerid': '100', + 'dependencies': [ + {'triggerid': '300', 'description': 'Unrelated dependency'}, + ], + } + + payload = build_dependency_payload(child_trigger, ['300'], set()) + + self.assertEqual(payload, [{'triggerid': '300'}]) + + @patch('nbxsync.utils.trigger_dependency_sync.get_child_devices', return_value=[]) + @patch('nbxsync.utils.trigger_dependency_sync._sync_child_dependency', return_value={'child': 'ap', 'changed': True}) + @patch('nbxsync.utils.trigger_dependency_sync.get_plugin_settings') + def test_sync_device_trigger_dependencies_syncs_lowest_level_device(self, mock_settings, mock_sync_child, _mock_get_children): + self.trigger_config.enabled = True + mock_settings.return_value = SimpleNamespace(trigger_dependencies=self.trigger_config) + access_point = SimpleNamespace( + role=SimpleNamespace(name='Access Point', slug='access-point'), + _meta=SimpleNamespace(model_name='device'), + ) + + result = sync_device_trigger_dependencies(access_point) + + self.assertEqual(result, [{'child': 'ap', 'changed': True}]) + mock_sync_child.assert_called_once_with(access_point, trigger_config=self.trigger_config) diff --git a/nbxsync/utils/trigger_dependency_sync.py b/nbxsync/utils/trigger_dependency_sync.py new file mode 100644 index 0000000..4c2b2ae --- /dev/null +++ b/nbxsync/utils/trigger_dependency_sync.py @@ -0,0 +1,255 @@ +import logging + +from django.contrib.contenttypes.models import ContentType + +from nbxsync.models import ZabbixServerAssignment +from nbxsync.settings import get_plugin_settings +from nbxsync.utils import ZabbixConnection + +logger = logging.getLogger(__name__) + + +def _token_set(values): + tokens = set() + for value in values or []: + normalized = str(value).strip().lower() + if normalized: + tokens.add(normalized) + tokens.add(normalized.replace('-', ' ')) + return tokens + + +def normalized_role_tokens(device): + role = getattr(device, 'role', None) + if not role: + return set() + + tokens = set() + for attr in ('name', 'slug'): + value = getattr(role, attr, None) + if value: + normalized = str(value).strip().lower() + tokens.add(normalized) + tokens.add(normalized.replace('-', ' ')) + return tokens + + +def get_dependency_level(device, trigger_config=None): + trigger_config = trigger_config or get_plugin_settings().trigger_dependencies + role_tokens = normalized_role_tokens(device) + + for index, level in enumerate(trigger_config.levels): + if role_tokens & _token_set(level.roles): + return index, level + + return None, None + + +def get_managed_trigger_descriptions(trigger_config=None): + trigger_config = trigger_config or get_plugin_settings().trigger_dependencies + return {level.trigger_description for level in trigger_config.levels} + + +def get_server_assignments(device): + object_ct = ContentType.objects.get_for_model(device) + return list( + ZabbixServerAssignment.objects.filter( + assigned_object_type=object_ct, + assigned_object_id=device.pk, + sync_enabled=True, + zabbixserver__sync_enabled=True, + ).select_related('zabbixserver') + ) + + +def get_host_assignment(device): + assignments = [assignment for assignment in get_server_assignments(device) if assignment.hostid] + return assignments[0] if assignments else None + + +def get_primary_remote_device(interface): + endpoints = list(interface.connected_endpoints or []) + if not endpoints: + return None + + remote_interface = endpoints[0] + return getattr(remote_interface, 'device', None) + + +def get_connected_devices(device): + devices = [] + seen_ids = set() + + for interface in device.interfaces.all().order_by('name'): + remote_device = get_primary_remote_device(interface) + if not remote_device or remote_device.pk in seen_ids: + continue + + devices.append(remote_device) + seen_ids.add(remote_device.pk) + + return devices + + +def get_parent_devices(child, trigger_config=None): + trigger_config = trigger_config or get_plugin_settings().trigger_dependencies + child_level_index, _ = get_dependency_level(child, trigger_config=trigger_config) + if child_level_index is None: + return [] + + parents = [] + for remote_device in get_connected_devices(child): + remote_level_index, _ = get_dependency_level(remote_device, trigger_config=trigger_config) + if remote_level_index is not None and remote_level_index > child_level_index: + parents.append(remote_device) + + return parents + + +def get_child_devices(parent, trigger_config=None): + trigger_config = trigger_config or get_plugin_settings().trigger_dependencies + parent_level_index, _ = get_dependency_level(parent, trigger_config=trigger_config) + if parent_level_index is None: + return [] + + children = [] + for remote_device in get_connected_devices(parent): + remote_level_index, _ = get_dependency_level(remote_device, trigger_config=trigger_config) + if remote_level_index is not None and remote_level_index < parent_level_index: + children.append(remote_device) + + return children + + +def get_host_trigger(api, hostid, description): + triggers = api.trigger.get( + hostids=[str(hostid)], + filter={'description': description}, + output=['triggerid', 'description'], + selectDependencies='extend', + expandDescription=True, + ) + return triggers[0] if triggers else None + + +def build_dependency_payload(child_trigger, parent_triggerids, managed_parent_descriptions): + dependencies = child_trigger.get('dependencies', []) + merged = [] + seen_ids = set() + managed_parent_descriptions = set(managed_parent_descriptions) + + for dependency in dependencies: + dependency_id = dependency.get('triggerid') + dependency_description = dependency.get('description') + if not dependency_id or dependency_description in managed_parent_descriptions: + continue + if dependency_id in seen_ids: + continue + merged.append({'triggerid': dependency_id}) + seen_ids.add(dependency_id) + + for parent_triggerid in parent_triggerids: + parent_triggerid = str(parent_triggerid) + if parent_triggerid not in seen_ids: + merged.append({'triggerid': parent_triggerid}) + seen_ids.add(parent_triggerid) + + return merged + + +def sync_device_trigger_dependencies(device): + trigger_config = get_plugin_settings().trigger_dependencies + + if not trigger_config.enabled: + return [] + + if getattr(device._meta, 'model_name', None) != 'device': + logger.debug('Skipping trigger dependency sync for unsupported object type: %s', device) + return [] + + device_level_index, _ = get_dependency_level(device, trigger_config=trigger_config) + if device_level_index is None: + logger.debug('Skipping trigger dependency sync for unsupported role on %s.', device) + return [] + + results = [] + + if device_level_index < len(trigger_config.levels) - 1: + result = _sync_child_dependency(device, trigger_config=trigger_config) + if result: + results.append(result) + + for child in get_child_devices(device, trigger_config=trigger_config): + result = _sync_child_dependency(child, trigger_config=trigger_config) + if result: + results.append(result) + + return results + + +def _sync_child_dependency(child, trigger_config=None): + trigger_config = trigger_config or get_plugin_settings().trigger_dependencies + child_level_index, child_level = get_dependency_level(child, trigger_config=trigger_config) + if child_level_index is None: + logger.debug('Skipping dependency sync for unsupported child role on %s.', child) + return None + + parent_devices = get_parent_devices(child, trigger_config=trigger_config) + if not parent_devices: + logger.warning('No higher-level connected parent found for %s; skipping dependency sync.', child) + return None + + child_assignment = get_host_assignment(child) + if not child_assignment: + logger.warning('No Zabbix host assignment with hostid found for %s.', child) + return None + + with ZabbixConnection(child_assignment.zabbixserver) as api: + child_trigger = get_host_trigger(api, child_assignment.hostid, child_level.trigger_description) + if not child_trigger: + logger.warning('No "%s" trigger found for %s.', child_level.trigger_description, child) + return None + + parent_triggers = [] + parent_names = [] + for parent in parent_devices: + _, parent_level = get_dependency_level(parent, trigger_config=trigger_config) + parent_assignment = get_host_assignment(parent) + if not parent_assignment: + logger.warning('No Zabbix host assignment with hostid found for parent %s.', parent) + continue + + if child_assignment.zabbixserver_id != parent_assignment.zabbixserver_id: + logger.warning( + 'Skipping dependency sync for %s: child and parent %s are assigned to different Zabbix servers.', + child, + parent, + ) + continue + + parent_trigger = get_host_trigger(api, parent_assignment.hostid, parent_level.trigger_description) + if not parent_trigger: + logger.warning('No "%s" trigger found for %s.', parent_level.trigger_description, parent) + continue + + parent_triggers.append(parent_trigger) + parent_names.append(str(parent)) + + if not parent_triggers: + return None + + dependency_payload = build_dependency_payload( + child_trigger, + [trigger['triggerid'] for trigger in parent_triggers], + get_managed_trigger_descriptions(trigger_config=trigger_config), + ) + current_ids = {dep.get('triggerid') for dep in child_trigger.get('dependencies', []) if dep.get('triggerid')} + desired_ids = {dep.get('triggerid') for dep in dependency_payload} + + if current_ids == desired_ids: + logger.info('Dependency already correct: %s -> %s.', child, ', '.join(parent_names)) + return {'child': str(child), 'parent': ', '.join(parent_names), 'changed': False} + + api.trigger.update(triggerid=child_trigger['triggerid'], dependencies=dependency_payload) + logger.info('Updated dependency: %s -> %s.', child, ', '.join(parent_names)) + return {'child': str(child), 'parent': ', '.join(parent_names), 'changed': True}