📝 Document sync lifecycle, filtering, clustering and journals
Add sections for behavior that was not documented anywhere:
- How a sync run handles each object, and what happens when a host name
already exists, a host was deleted in Zabbix, or an object was deleted
in NetBox.
- Device and VM filters, with the examples from config.py.example.
- Clustering of virtual chassis, including the failover takeover added in
v4.1 and extended_virtual_chassis.
- Journal entries.
- That the host description is only set on creation.
- The NETBOX_ID<id> host name used for names with special characters.
📝 Correct outdated and wrong information in Sync Behavior
Corrections:
- VMs use the device_cf custom field (zabbix_hostid), not zabbix_id.
- VMs default to a Zabbix agent interface, not SNMPv2.
- Hostgroup fields: add rack and fixed text, fix traverse_regions and the
dev_location example, and fix vm_hostgroup_format being described as
the device format.
- IPMI, OOB interfaces, DNS names and interface overrides are no longer
"in development": mark them as added in v4.1 and note they are
device-only where applicable.
- Fix invalid JSON in the tags, OOB and advanced interface examples.
- Use lowercase IPMI authtypes and usermacro types, matching what the
code accepts, and document the usermacro description key.
- Inventory example used custom_fields/<field>/name, which only works for
Object custom fields.
- templates_config_context_overrule applies to all config context, not
only device specific context.
- Update the log messages to what the script currently prints.
Additions to existing sections:
- Hostgroups, templates, tags, usermacros and interfaces set by hand in
Zabbix are replaced or removed on the next run.
- Interface type names, default ports, SNMP options and preferred_ip.
- Proxy custom field types, selection order and full_proxy_sync.
- Default usermacro maps are active as soon as usermacro_sync is enabled.
Permissions moved to the Preparation page. Sections are reordered and a
short introduction on config context was added.
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
Updated Sync Behavior (markdown)
q1x
committed
Oct 5, 2026
Adding documentation for new IPMI interface support
q1x
committed
Mar 25, 2026
Updated Sync Behavior (markdown)
Added new section for description options
Updated Sync Behavior (markdown)
Updated Sync Behavior (markdown)
Updated Sync Behavior (markdown)
Created Sync Behavior (markdown)