From b81938a4a52d652c2ff46f78ef708d159839e369 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 21 Aug 2017 11:49:25 -0400 Subject: [PATCH] Updated Frequently Asked Questions (markdown) --- Frequently-Asked-Questions.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Frequently-Asked-Questions.md b/Frequently-Asked-Questions.md index 7bf114c..aeb627b 100644 --- a/Frequently-Asked-Questions.md +++ b/Frequently-Asked-Questions.md @@ -1,7 +1,8 @@ * [Why Doesn't NetBox Scan for IPs?](#why-doesnt-netbox-scan-for-ips) -* [Why does NetBox Require Every IP to Have a Mask?](#why-does-netbox-require-every-ip-to-have-a-mask) +* [Why Does NetBox Require Every IP to Have a Mask?](#why-does-netbox-require-every-ip-to-have-a-mask) * [Why Can't I Connect a Virtual Circuit to an Interface?](#why-cant-i-connect-a-virtual-circuit-to-an-interface) * [How Can I Add New Interface Form Factors?](#how-can-i-add-new-interface-form-factors) +* [Can We Add Custom Fields to More Models?](#can-we-add-custom-fields-to-more-models) # Why Doesn't NetBox Scan for IPs? @@ -47,4 +48,10 @@ NetBox models only physical circuits, which can be terminated to physical interf # How Can I Add New Interface Form Factors? -The set of available interface form factors is statically defined in NetBox; users cannot add arbitrary form factors. This is done to remove the potential for creating duplicate or illegitimate form factors that would degrade the data model. If there's a form factor you'd like to see added to NetBox, consider opening a [feature request](https://github.com/digitalocean/netbox/issues) detailing your use case. (However, bear in mind that only actual hardware interface types will be added.) \ No newline at end of file +The set of available interface form factors is statically defined in NetBox; users cannot add arbitrary form factors. This is done to remove the potential for creating duplicate or illegitimate form factors that would degrade the data model. If there's a form factor you'd like to see added to NetBox, consider opening a [feature request](https://github.com/digitalocean/netbox/issues) detailing your use case. (However, bear in mind that only actual hardware interface types will be added.) + +# Can We Add Custom Fields to More Models? + +[Custom fields](http://netbox.readthedocs.io/en/stable/data-model/extras/#custom-fields) allow users to define additional data fields on certain NetBox objects. These can be used to track object attributes which are important to an individual organization, but that wouldn't make sense to implement in the official NetBox database schema. For example, maybe you need to add a `legacy_name` field to the Device model, or `ticket_number` field to an IP address. + +NetBox allows custom fields to be added only to primary models. Within the DCIM application, for instance, custom fields can be added only to the Site, Rack, DeviceType, and Device models. They cannot be added to the Region, RackGroup, DeviceRole, or other models which are used primarily for organizational purposes. The relevant distinction is that primary models have dedicated views (e.g. `/dcim/devices//` for a device) whereas secondary models do not. Thus, it doesn't make sense to included arbitrary additional data. (Custom fields should not be included in object lists due to the overhead they impose, which is one additional query per field, per object in the list.) \ No newline at end of file