Browse Source

Updated documentation to include device bays

Jeremy Stretch 9 years ago
parent
commit
34c332d165
2 changed files with 5 additions and 3917 deletions
  1. 5 3
      docs/dcim.md
  2. 0 3914
      docs/schema.sql

+ 5 - 3
docs/dcim.md

@@ -43,6 +43,7 @@ Each device type is assigned a number of component templates which describe the
 * Power port templates
 * Power port templates
 * Power outlet templates
 * Power outlet templates
 * Interface templates
 * Interface templates
+* Device bay templates
 
 
 Whenever a new device is created, it is automatically assigned console, power, and interface components per the templates assigned to its device type. For example, suppose your network employs Juniper EX4300-48T switches. You would create a device type with a model name "EX4300-48T" and assign it to the manufacturer "Juniper." You might then also create the following templates for it:
 Whenever a new device is created, it is automatically assigned console, power, and interface components per the templates assigned to its device type. For example, suppose your network employs Juniper EX4300-48T switches. You would create a device type with a model name "EX4300-48T" and assign it to the manufacturer "Juniper." You might then also create the following templates for it:
 
 
@@ -81,16 +82,17 @@ A device can be assigned modules which represent internal components. Currently,
 
 
 ### Components
 ### Components
 
 
-There are five types of device components which comprise all of the interconnection logic with NetBox:
+There are six types of device components which comprise all of the interconnection logic with NetBox:
 
 
 * Console ports
 * Console ports
 * Console server ports
 * Console server ports
 * Power ports
 * Power ports
 * Power outlets
 * Power outlets
 * Interfaces
 * Interfaces
+* Device bays
 
 
 Console ports connect only to console server ports, and power ports connect only to power outlets. Interfaces connect to one another in a symmetric manner: If interface A connects to interface B, interface B therefore connects to interface A. (The relationship between two interfaces is actually represented in the database by an InterfaceConnection object, but this is transparent to the user.)
 Console ports connect only to console server ports, and power ports connect only to power outlets. Interfaces connect to one another in a symmetric manner: If interface A connects to interface B, interface B therefore connects to interface A. (The relationship between two interfaces is actually represented in the database by an InterfaceConnection object, but this is transparent to the user.)
 
 
-Each type of connection can be defined as either *planned* or *connected*. This allows for easily denoting connections which have not yet been installed.
+Each type of connection can be defined as either *planned* or *connected*. This allows for easily denoting connections which have not yet been installed. In addition to a connecting peer, interfaces are also assigned a form factor and may be designated as management-only (for out-of-band management). Interfaces may also be assigned a short description.
 
 
-In addition to a connecting peer, interfaces are also assigned a form factor and may be designated as management-only (for out-of-band management). Interfaces may also be assigned a short description.
+Device bays represent the ability of a device to house child devices. For example, You might install several four blade servers into a 2U chassis. The chassis would appear in the rack elevation as a 2U device with four device bays. Each server within it would be defined as a 0U device installed in one of the device bays. Child devices do not appear on rack elevations, but they are included in the "Non-Racked Devices" list within the rack view.

File diff suppressed because it is too large
+ 0 - 3914
docs/schema.sql