Cleaned up model documentation hierarchy

This commit is contained in:
Jeremy Stretch
2020-03-05 17:03:03 -05:00
parent 363c4acadc
commit f89773f4a3
28 changed files with 56 additions and 23 deletions

View File

@@ -1,4 +1,4 @@
# Console Ports
## Console Ports
A console port provides connectivity to the physical console of a device. Console ports are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access via a console server.

View File

@@ -1,3 +1,3 @@
# Console Port Templates
## Console Port Templates
A template for a console port that will be created on all instantiations of the parent device type.

View File

@@ -1,4 +1,4 @@
# Console Server Ports
## Console Server Ports
A console server is a device which provides remote access to the local consoles of connected devices. This is typically done to provide remote out-of-band access to network devices.

View File

@@ -1,3 +1,3 @@
# Console Server Port Templates
## Console Server Port Templates
A template for a console server port that will be created on all instantiations of the parent device type.

View File

@@ -1,4 +1,4 @@
# Device Bays
## Device Bays
Device bays represent the ability of a device to house child devices. For example, you might install 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 within rack elevations or the "Non-Racked Devices" list within the rack view.

View File

@@ -1,3 +1,3 @@
# Device Bay Templates
## Device Bay Templates
A template for a device bay that will be created on all instantiations of the parent device type.

View File

@@ -1,4 +1,4 @@
# Front Ports
## Front Ports
Front ports are pass-through ports used to represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports.

View File

@@ -1,3 +1,3 @@
# Front Port Templates
## Front Port Templates
A template for a front-facing pass-through port that will be created on all instantiations of the parent device type.

View File

@@ -1,4 +1,4 @@
# Interfaces
## Interfaces
Interfaces connect to one another in a symmetric manner: If interface A connects to interface B, interface B therefore connects to interface A. Each type of connection can be classified as either *planned* or *connected*.

View File

@@ -1,3 +1,3 @@
# Interface Templates
## Interface Templates
A template for an interface that will be created on all instantiations of the parent device type.

View File

@@ -1,3 +1,3 @@
# Power Outlets
## Power Outlets
Power outlets represent the ports on a PDU that supply power to other devices. Power outlets are downstream-facing towards power ports. A power outlet can be associated with a power port on the same device and a feed leg (i.e. in a case of a three-phase supply). This indicates which power port supplies power to a power outlet.

View File

@@ -1,3 +1,3 @@
# Power Outlet Templates
## Power Outlet Templates
A template for a power outlet that will be created on all instantiations of the parent device type.

View File

@@ -1,4 +1,4 @@
# Power Ports
## Power Ports
A power port is the inlet of a device where it draws its power. Power ports are upstream-facing towards power outlets. Alternatively, a power port can connect to a power feed as mentioned in the power feed section to indicate the power source of a PDU's inlet.

View File

@@ -1,3 +1,3 @@
# Power Port Templates
## Power Port Templates
A template for a power port that will be created on all instantiations of the parent device type.

View File

@@ -1,4 +1,4 @@
# Rear Ports
## Rear Ports
Like front ports, rear ports are pass-through ports which represent the end of a particular cable segment in a path. Each rear port is defined with a number of positions: rear ports with more than one position can be mapped to multiple front ports. This can be useful for modeling instances where multiple paths share a common cable (for example, six different fiber connections sharing a 12-strand MPO cable).

View File

@@ -1,3 +1,3 @@
# Rear Port Templates
## Rear Port Templates
A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type.