models.md 5.1 KB
NetBox Models
Model Types
A NetBox model represents a discrete object type such as a device or IP address. Each model is defined as a Python class and has its own SQL table. All NetBox data models can be categorized by type.
Features Matrix
- Change logging - Changes to these objects are automatically recorded in the change log
- Webhooks - NetBox is capable of generating outgoing webhooks for these objects
- Custom fields - These models support the addition of user-defined fields
- Export templates - Users can create custom export templates for these models
- Tagging - The models can be tagged with user-defined tags
- Journaling - These models support persistent historical commentary
- Nesting - These models can be nested recursively to create a hierarchy
| Type | Change Logging | Webhooks | Custom Fields | Export Templates | Tags | Journaling | Nesting |
|---|---|---|---|---|---|---|---|
| Primary | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | |
| Organizational | :material-check: | :material-check: | :material-check: | :material-check: | |||
| Nested Group | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | ||
| Component | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | ||
| Component Template | :material-check: | :material-check: | :material-check: |
Models Index
Primary Models
- circuits.Circuit
- circuits.Provider
- circuits.ProviderNetwork
- dcim.Cable
- dcim.Device
- dcim.DeviceType
- dcim.PowerFeed
- dcim.PowerPanel
- dcim.Rack
- dcim.RackReservation
- dcim.Site
- dcim.VirtualChassis
- ipam.Aggregate
- ipam.IPAddress
- ipam.Prefix
- ipam.RouteTarget
- ipam.Service
- ipam.VLAN
- ipam.VRF
- secrets.Secret
- tenancy.Tenant
- virtualization.Cluster
- virtualization.VirtualMachine
Organizational Models
- circuits.CircuitType
- dcim.DeviceRole
- dcim.Manufacturer
- dcim.Platform
- dcim.RackRole
- ipam.RIR
- ipam.Role
- ipam.VLANGroup
- secrets.SecretRole
- virtualization.ClusterGroup
- virtualization.ClusterType
Nested Group Models
- dcim.Location (formerly RackGroup)
- dcim.Region
- dcim.SiteGroup
- tenancy.TenantGroup
Component Models
- dcim.ConsolePort
- dcim.ConsoleServerPort
- dcim.DeviceBay
- dcim.FrontPort
- dcim.Interface
- dcim.InventoryItem
- dcim.PowerOutlet
- dcim.PowerPort
- dcim.RearPort
- virtualization.VMInterface