Documentation Django DCIM / IPAM models; tutorial for creating custom script for new site with Prefixes, VLANs, VRFs etc

[jesper-munk2]

I shall create a netbox custom script which adds a new site with the following objects:

• switches, routers, APs # I have found out about this
• Prefix without attributes VLAN and VRF # I have found out about this
• Prefix with attributes VLAN and VRF # I request assistance for this

i have spent a lot of time searching for documentation for Django DCIM / IPAM models - as Django is used for netbox -, and possibly other models.
I have been looking for tutorial / examples for creating custom script for new site with Prefixes, VLANs, VRFs etc., as I have described above. The netbox labs custom script documentation https://netboxlabs.com/docs/netbox/customization/custom-scripts/ and custom script getting started https://netboxlabs.com/blog/getting-started-with-netbox-custom-scripts/ are good resources, but do not provide me all information I need.
Django documentation at https://docs.djangoproject.com/en/6.0/ seems to give a very good and comprehensive documentation of Django, but I have not been able to find documentation about how Django is used for netbox custom scripts (DCIM, IPAM models etc.).

So I request documentation for Django DCIM / IPAM models - as Django is used for netbox - , and possibly other models, and possibly tutorials / comprehensive examples for custom scripts, which can do what I have described above.
For Django DCIM / IPAM / other models as required, I need:

• For netbox prefix: which IPAM model? Which attributes (e.g. VLAN, VRF are supported)? How do I set these attributes for a new prefix?
• For existing VLAN: which IPAM model? Which query parameters do I use to find the VLAN, e.g. by its VLAN id and VLAN name?
• For existing VRF: which IPAM model? Which query parameters do I use to find the VRF?
• For existing tenant: which DCIM / other model? Which query parameters do I use to find the tenant?
• For existing tenant group: which DCIM / other model? Which query parameters do I use to find the tenant group?

The last 5 questions, I will normally find answers to in an API reference / function call documentation, but I have so far not be able to find this documentation for Django for netbox scripts. Link to documentation will be much appreciated.

[jesper-munk2]

OK, I came quite a long way with the Model documentation in below, so I will continue with that and come back if I need more information