Adding further documentation to the readme (with links back to docs.netbox.dev) to explain the different DCIM parts. Hopefully this will help with contributors understanding (#1879)

This commit is contained in:
Daniel W. Anner 2024-01-23 09:39:53 -05:00 committed by GitHub
parent bfa9bc4441
commit e43c2633e7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -112,20 +112,23 @@ to be added.
The available fields for each type of component are listed below.
#### Console Ports
#### Console Ports ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/consoleport/))
> A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access provided via a networked console server.
- `name`: Name
- `label`: Label
- `type`: Port type slug (Array)
- `poe`: Does this port access/provide POE? (Boolean)
#### Console Server Ports
#### Console Server Ports ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/consoleserverport/))
> A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band access to network devices, and generally connect to console ports.
- `name`: Name
- `label`: Label
- `type`: Port type slug (Array)
#### Power Ports
#### Power Ports ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/powerport/))
> A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply internal to a device.
- `name`: Name
- `label`: Label
@ -133,7 +136,8 @@ The available fields for each type of component are listed below.
- `maximum_draw`: The port's maximum power draw, in watts (optional)
- `allocated_draw`: The port's allocated power draw, in watts (optional)
#### Power Outlets
#### Power Outlets ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/poweroutlet/))
> Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assigned a physical type, and may be associated with a specific feed leg (where three-phase power is used) and/or a specific upstream power port. This association can be used to model the distribution of power within a device.
- `name`: Name
- `label`: Label
@ -141,14 +145,16 @@ The available fields for each type of component are listed below.
- `power_port`: The name of the power port on the device which powers this outlet (optional)
- `feed_leg`: The phase (leg) of power to which this outlet is mapped; A, B, or C (optional)
#### Interfaces
#### Interfaces ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/interface/))
> Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but other types are supported as well. IP addresses and VLANs can be assigned to interfaces.
- `name`: Name
- `label`: Label
- `type`: Interface type slug (Array)
- `mgmt_only`: A boolean which indicates whether this interface is used for management purposes only (default: false)
#### Front Ports
#### Front Ports ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/frontport/))
> Front ports are pass-through ports which 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 port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each.
- `name`: Name
- `label`: Label
@ -156,7 +162,8 @@ The available fields for each type of component are listed below.
- `rear_port`: The name of the rear port on this device to which the front port maps
- `rear_port_position`: The corresponding position on the mapped rear port (default: 1)
#### Rear Ports
#### Rear Ports ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/rearport/))
> Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its physical type and 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 discrete two-strand fiber connections sharing a 12-strand MPO cable).
- `name`: Name
- `label`: Label
@ -164,18 +171,25 @@ The available fields for each type of component are listed below.
- `positions`: The number of front ports that can map to this rear port (default: 1)
- `poe`: Does this port access/provide POE? (Boolean)
#### Module Bays
#### Module Bays ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/modulebay/))
> Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switch such as the Cisco Nexus 9000 or Juniper EX9200. Modules in turn hold additional components that become available to the parent device.
- `name`: Name
- `label`: Label
- `position`: The alphanumeric position in which this module bay is situated within the parent device. When creating module components, the string `{module}` in the component name will be replaced with the module bay's `position`. See the [NetBox Documentation](https://docs.netbox.dev/en/stable/models/dcim/moduletype/#automatic-component-renaming) for more details.
#### Device Bays
#### Device Bays ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/devicebay/))
>Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four individual blade servers. The chassis would appear in the rack elevation as a 2U device with four device bays, and 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 count as consuming rack units.
>
> Child devices are first-class Devices in their own right: That is, they are 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 components. LAG interfaces may not group interfaces belonging to different child devices.
- `name`: Name
- `label`: Label
#### Inventory Items
#### Inventory Items ([Documentation](https://docs.netbox.dev/en/stable/models/dcim/inventoryitem/))
> Inventory items represent hardware components installed within a device, such as a power supply or CPU or line card. They are intended to be used primarily for inventory purposes.
>
> Inventory items are hierarchical in nature, such that any individual item may be designated as the parent for other items. For example, an inventory item might be created to represent a line card which houses several SFP optics, each of which exists as a child item within the device. An inventory item may also be associated with a specific component within the same device. For example, you may wish to associate a transceiver with an interface.
- `name`: Name
- `label`: Label