You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Feature Request: Tenant inheritance from Cluster to Virtual Machines and IP Addresses #531
First of all, thank you for the excellent project.
We are using netbox-sync to synchronize VMware objects into NetBox and recently started using the cluster_tenant_relation option, which was introduced through issue #110: #110
This feature works as expected and correctly assigns tenants to clusters.
However, we have encountered a limitation: tenant assignment is not inherited from the Cluster object to Virtual Machines and their IP addresses.
Current behavior:
Cluster receives the correct tenant via cluster_tenant_relation.
VMs within that cluster remain without a tenant.
IP addresses assigned to those VMs also remain without a tenant.
Additional vm_tenant_relation rules must be created and maintained separately.
In our environment, tenant ownership is determined by the VMware cluster, not by individual VM names.
Example:
Production-Cluster -> Production Tenant
Test-Cluster -> Test Tenant
All VMs and their IP addresses within a cluster should belong to the same tenant.
The main challenge is that vm_tenant_relation works on VM-based matching. In environments with many VMs, maintaining large sets of VM name regex rules becomes difficult and duplicates information that is already defined by cluster_tenant_relation.
Suggested enhancement:
Implement tenant inheritance:
Cluster Tenant
↓
VM Tenant
↓
IP Address Tenant
Proposed behavior:
If a VM does not match an explicit vm_tenant_relation, inherit the tenant from its parent cluster.
If an IP address belongs to a VM, inherit the tenant from the VM.
Explicit mappings should continue to have priority over inherited values.
Benefits:
Significantly simpler configuration.
No need to maintain large VM name-based tenant mappings.
Tenant information would be defined only once at the cluster level.
Consistent tenant assignment across clusters, VMs and IP addresses.
Solves the common use case where tenant ownership is organized by VMware clusters.
From our perspective, tenant inheritance would fully complement the functionality introduced by cluster_tenant_relation in issue #110 and would solve almost all tenant assignment use cases in VMware environments.
Implemented in development (#589), in the image ghcr.io/bb-ricardo/netbox-sync:development. Set vm_tenant_inherit_from_cluster = True: a VM that gets no tenant from vm_tenant_relation (or the new resource pool and folder relations) takes the tenant of its cluster, the one from cluster_tenant_relation or, failing that, the tenant set on the cluster in NetBox. IP addresses already follow the VM through the device step of ip_tenant_inheritance_order, so the chain cluster → VM → IP you described works with that one option.
Could you try it against your vCenter? Run with -n first, then a real run and a second one (the second should change nothing in NetBox), and say what came out, here or in the call for testing: #592. Nothing changes unless the option is set, so pulling the image is safe. It goes into 1.10.0, the next feature release.
Activity
semx commentedon Oct 10, 2026
Implemented in
development(#589), in the imageghcr.io/bb-ricardo/netbox-sync:development. Setvm_tenant_inherit_from_cluster = True: a VM that gets no tenant fromvm_tenant_relation(or the new resource pool and folder relations) takes the tenant of its cluster, the one fromcluster_tenant_relationor, failing that, the tenant set on the cluster in NetBox. IP addresses already follow the VM through thedevicestep ofip_tenant_inheritance_order, so the chain cluster → VM → IP you described works with that one option.Could you try it against your vCenter? Run with
-nfirst, then a real run and a second one (the second should change nothing in NetBox), and say what came out, here or in the call for testing: #592. Nothing changes unless the option is set, so pulling the image is safe. It goes into 1.10.0, the next feature release.vmware: resolve the VM tenant from resource pool, folder and cluster