starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-04-22 08:48:41 +02:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Update model docs for device components

Browse Source
This commit is contained in:
jeremystretch
2022-08-15 11:57:38 -04:00
parent d4f976ac8d
commit f76ce172e0
20 changed files with 432 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/models/dcim/poweroutlet.md
View File

@@ -1,7 +1,39 @@
## Power Outlets
# Power Outlets
Power outlets represent the outlets on a power distribution unit (PDU) or other device that supply 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.
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.
For example, imagine a PDU with one power port which draws from a three-phase feed and 48 power outlets arranged into three banks of 16 outlets each. Outlets 1-16 would be associated with leg A on the port, and outlets 17-32 and 33-48 would be associated with legs B and C, respectively.
Cables can connect power outlets only to downstream power ports. (Pass-through ports cannot be used to model power distribution.)
## Fields
### Device
The device to which this power outlet belongs.
### Module
The installed module within the assigned device to which this power outlet belongs (optional).
### Name
The name of the power outlet. Must be unique to the parent device.
### Label
An alternative physical label identifying the power outlet.
### Type
The type of power outlet.
### Power Port
When modeling a device which redistributes power from an upstream supply, such as a power distribution unit (PDU), each power outlet should be mapped to the respective [power port](./powerport.md) on the device which supplies power. For example, a 24-outlet PDU may two power ports, each distributing power to 12 of its outlets.
### Feed Leg
This field is used to indicate to which leg of three-phase power circuit the outlet is bound. (This should be left blank for single-phase applications.)
### Mark Connected
If selected, this component will be treated as if a cable has been connected.