NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-16 04:02:52 -06:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Updated Frequently Asked Questions (markdown)

Jeremy Stretch 2017-08-29 16:28:15 -04:00
parent b81938a4a5
commit 54df3e1c29
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Frequently-Asked-Questions.md

@ -3,6 +3,7 @@
* [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 Does NetBox Support Only Image Attachments?](#user-content-why-does-netbox-support-only-image-attachments)
# Why Doesn't NetBox Scan for IPs?
@ -54,4 +55,10 @@ The set of available interface form factors is statically defined in NetBox; use
[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/<pk>/` 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.)
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/<pk>/` 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.)
# Why Does NetBox Support Only Image Attachments?
NetBox supports the attachment of images to certain models, namely sites, racks, and devices. This feature was added as a convenience to provide readily-accessible photographic documentation of installations. For instance, a data center technician might opt to upload a close-up photo of a device and its connections to clarify where each named interface resides on the box.
While NetBox might seem like an ideal place to store additional documents (PDFs, configurations, etc.), these are best maintained with the rest of your network's static documentation in a dedicated file store with appropriate access controls and revision history. Although other files cannot be uploaded to NetBox, you can link to them from NetBox in the comments section of an object, or within a custom URL field. Feature request [#969](https://github.com/digitalocean/netbox/issues/969) (currently a work in progress) will make this approach easier by introducing support for templatized URLs to external resources.