Without looking at proper NetBox doc resources for you, might pay to poke around in NetBox Shell:

source /opt/netbox/venv/bin/activate
python3 /opt/netbox/netbox/manage.py nbshell

# In nbshell
lsmodels()
help(_input_model_here_)

e.g. help(Interface)
# help(Interface) provides a manpage-like document

2. There's also the UI import forms when mass adding objects for attr lists for easyish digestion.
3. And host API schema: https://{your_netbox_host}/api/schema/swagger-ui/

In nbshell you can also try your code. If you access an object then you can print available attrs interactively.
Be careful though, you can also change them...

Interfaces

intf = Interface.objects.get(id=1004)

dir(intf)  # Prints list of attributes
- OR -
intf.? (outputs to terminal all context-help like)

# Can access attrs directly, printing to terminal
intf.id
intf.speed
print(getattr(intf, 'speed'))  # Note: getattr useful in loops

# Loop through interfaces printing intf+speed to terminal
for i in Interface.objects.all():  # Refine your query or nest inside another loop.
    i_speed = f'Interface: {i.name}, Speed: {getattr(i, "speed")}'  # Formatted for print
    print(i_speed)

output eg:
| Interface: ether1, Speed: None
| Interface: ether2, Speed: None
| ... etc

... essentially several ways to go about it. Probably some more efficient ways too.

Back to config templates, I was involved in a discussion historically that provided great insight:
#12568
Uses Jinja2, but you can typically massage the queries similarly.

Disclaimer: Uneducated, unaffiliated peasant and fellow NB scripter.
I normally do nbshell experimentation to get where I want. YMMV, hope this helps a little

P.S. I suspect this may move to a Discussion rather than a Bug.

There is a netbox interactive shell! Fellow internet stranger, you have officially made my day. This will help me so much. This week I've spent a fair amount of time looking at the source code, specially the models, just to figure out which attributes and methods the objects have.

Thank you!

I might even write some documentation about this and to a PR to include this, since I can say I've read most of (if not all) of the documentation, and I did not know about the nbshell.

@8ctorres I'm so glad to hear that you found nbshell useful! Are you still interested in contributing a documentation PR to help fellow travelers become aware of it from the official docs?

Hello @jeffgdotorg

Absolutely. I’ve been busy at work this last few weeks (mostly developing config templates, reports and scripts for Netbox), but I will try to make some time this weekend a write a page for the documentation to include a section about the nbshell. I really think it would help newcomers to start coding their own scripts.

Is there anything I should know before starting to write?