mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
Refactored device component docs
This commit is contained in:
5
docs/models/dcim/consoleport.md
Normal file
5
docs/models/dcim/consoleport.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 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.
|
||||
|
||||
Console ports can be connected to console server ports.
|
||||
5
docs/models/dcim/consoleserverport.md
Normal file
5
docs/models/dcim/consoleserverport.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 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.
|
||||
|
||||
Console server ports can be connected to console ports.
|
||||
7
docs/models/dcim/devicebay.md
Normal file
7
docs/models/dcim/devicebay.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# 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.
|
||||
|
||||
Child devices are first-class Devices in their own right: that is, fully independent managed entities which don't share any control plane with the parent. Just like normal devices, child devices have their own platform (OS), role, tags, and interfaces. You cannot create a LAG between interfaces in different child devices.
|
||||
|
||||
Therefore, Device bays are **not** suitable for modeling chassis-based switches and routers. These should instead be modeled as a single Device, with the line cards as Inventory Items.
|
||||
5
docs/models/dcim/frontport.md
Normal file
5
docs/models/dcim/frontport.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 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.
|
||||
|
||||
Each front port is mapped to a specific rear port on the same device. A single rear port may be mapped to multiple rear ports.
|
||||
9
docs/models/dcim/interface.md
Normal file
9
docs/models/dcim/interface.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# 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*.
|
||||
|
||||
Each interface is a assigned a type denoting its physical properties. Two special types exist: the "virtual" type can be used to designate logical interfaces (such as SVIs), and the "LAG" type can be used to desinate link aggregation groups to which physical interfaces can be assigned.
|
||||
|
||||
Each interface can also be enabled or disabled, and optionally designated as management-only (for out-of-band management). Fields are also provided to store an interface's MTU and MAC address.
|
||||
|
||||
VLANs can be assigned to each interface as either tagged or untagged. (An interface may have only one untagged VLAN.)
|
||||
3
docs/models/dcim/poweroutlet.md
Normal file
3
docs/models/dcim/poweroutlet.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# 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.
|
||||
6
docs/models/dcim/powerport.md
Normal file
6
docs/models/dcim/powerport.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# 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.
|
||||
|
||||
!!! info
|
||||
If the draw of a power port is left empty, it will be dynamically calculated based on the power outlets associated with that power port. This is usually the case on the power ports of devices that supply power, like a PDU.
|
||||
5
docs/models/dcim/rearport.md
Normal file
5
docs/models/dcim/rearport.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 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).
|
||||
|
||||
Note that front and rear ports need not necessarily reside on the actual front or rear device face. This terminology is used primarily to distinguish between the two components in a pass-through port pairing.
|
||||
Reference in New Issue
Block a user