mirror of
https://github.com/netbox-community/netbox.git
synced 2025-08-09 00:58:16 -06:00
Update model docs
This commit is contained in:
parent
b9b8652b95
commit
a54655cc94
@ -20,6 +20,10 @@ The [location](./location.md) within a site where the rack has been installed (o
|
|||||||
|
|
||||||
The rack's name or identifier. Must be unique to the rack's location, if assigned.
|
The rack's name or identifier. Must be unique to the rack's location, if assigned.
|
||||||
|
|
||||||
|
### Rack Type
|
||||||
|
|
||||||
|
The [physical type](./racktype.md) of this rack. The rack type defines physical attributes such as height and weight.
|
||||||
|
|
||||||
### Status
|
### Status
|
||||||
|
|
||||||
Operational status.
|
Operational status.
|
||||||
@ -43,44 +47,5 @@ The unique physical serial number assigned to this rack.
|
|||||||
|
|
||||||
A unique, locally-administered label used to identify hardware resources.
|
A unique, locally-administered label used to identify hardware resources.
|
||||||
|
|
||||||
### Type
|
!!! note
|
||||||
|
Some additional fields pertaining to physical attributes such as height and weight can also be defined on each rack, but should generally be defined instead on the [rack type](./racktype.md).
|
||||||
A rack can be designated as one of the following types:
|
|
||||||
|
|
||||||
* 2-post frame
|
|
||||||
* 4-post frame
|
|
||||||
* 4-post cabinet
|
|
||||||
* Wall-mounted frame
|
|
||||||
* Wall-mounted cabinet
|
|
||||||
|
|
||||||
### Width
|
|
||||||
|
|
||||||
The canonical distance between the two vertical rails on a face. (This is typically 19 inches, however other standard widths exist.)
|
|
||||||
|
|
||||||
### Height
|
|
||||||
|
|
||||||
The height of the rack, measured in units.
|
|
||||||
|
|
||||||
### Starting Unit
|
|
||||||
|
|
||||||
The number of the numerically lowest unit in the rack. This value defaults to one, but may be higher in certain situations. For example, you may want to model only a select range of units within a shared physical rack (e.g. U13 through U24).
|
|
||||||
|
|
||||||
### Outer Dimensions
|
|
||||||
|
|
||||||
The external width and depth of the rack can be tracked to aid in floorplan calculations. These measurements must be designated in either millimeters or inches.
|
|
||||||
|
|
||||||
### Mounting Depth
|
|
||||||
|
|
||||||
The maximum depth of a mounted device that the rack can accommodate, in millimeters. For four-post frames or cabinets, this is the horizontal distance between the front and rear vertical rails. (Note that this measurement does _not_ include space between the rails and the cabinet doors.)
|
|
||||||
|
|
||||||
### Weight
|
|
||||||
|
|
||||||
The numeric weight of the rack, including a unit designation (e.g. 10 kilograms or 20 pounds).
|
|
||||||
|
|
||||||
### Maximum Weight
|
|
||||||
|
|
||||||
The maximum total weight capacity for all installed devices, inclusive of the rack itself.
|
|
||||||
|
|
||||||
### Descending Units
|
|
||||||
|
|
||||||
If selected, the rack's elevation will display unit 1 at the top of the rack. (Most racks use ascending numbering, with unit 1 assigned to the bottommost position.)
|
|
||||||
|
53
docs/models/dcim/racktype.md
Normal file
53
docs/models/dcim/racktype.md
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
# Rack Types
|
||||||
|
|
||||||
|
A rack type defines the physical characteristics of a particular model of [rack](./rack.md).
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
### Name
|
||||||
|
|
||||||
|
The unique name of the rack type.
|
||||||
|
|
||||||
|
### Type
|
||||||
|
|
||||||
|
A rack can be designated as one of the following types:
|
||||||
|
|
||||||
|
* 2-post frame
|
||||||
|
* 4-post frame
|
||||||
|
* 4-post cabinet
|
||||||
|
* Wall-mounted frame
|
||||||
|
* Wall-mounted cabinet
|
||||||
|
|
||||||
|
### Width
|
||||||
|
|
||||||
|
The canonical distance between the two vertical rails on a face. (This is typically 19 inches, however other standard widths exist.)
|
||||||
|
|
||||||
|
### Height
|
||||||
|
|
||||||
|
The height of the rack, measured in units.
|
||||||
|
|
||||||
|
### Starting Unit
|
||||||
|
|
||||||
|
The number of the numerically lowest unit in the rack. This value defaults to one, but may be higher in certain situations. For example, you may want to model only a select range of units within a shared physical rack (e.g. U13 through U24).
|
||||||
|
|
||||||
|
### Outer Dimensions
|
||||||
|
|
||||||
|
The external width and depth of the rack can be tracked to aid in floorplan calculations. These measurements must be designated in either millimeters or inches.
|
||||||
|
|
||||||
|
### Mounting Depth
|
||||||
|
|
||||||
|
The maximum depth of a mounted device that the rack can accommodate, in millimeters. For four-post frames or cabinets, this is the horizontal distance between the front and rear vertical rails. (Note that this measurement does _not_ include space between the rails and the cabinet doors.)
|
||||||
|
|
||||||
|
### Weight
|
||||||
|
|
||||||
|
The numeric weight of the rack, including a unit designation (e.g. 10 kilograms or 20 pounds).
|
||||||
|
|
||||||
|
### Maximum Weight
|
||||||
|
|
||||||
|
The maximum total weight capacity for all installed devices, inclusive of the rack itself.
|
||||||
|
|
||||||
|
### Descending Units
|
||||||
|
|
||||||
|
If selected, the rack's elevation will display unit 1 at the top of the rack. (Most racks use ascending numbering, with unit 1 assigned to the bottommost position.)
|
||||||
|
|
||||||
|
|
@ -206,6 +206,7 @@ nav:
|
|||||||
- Rack: 'models/dcim/rack.md'
|
- Rack: 'models/dcim/rack.md'
|
||||||
- RackReservation: 'models/dcim/rackreservation.md'
|
- RackReservation: 'models/dcim/rackreservation.md'
|
||||||
- RackRole: 'models/dcim/rackrole.md'
|
- RackRole: 'models/dcim/rackrole.md'
|
||||||
|
- RackType: 'models/dcim/racktype.md'
|
||||||
- RearPort: 'models/dcim/rearport.md'
|
- RearPort: 'models/dcim/rearport.md'
|
||||||
- RearPortTemplate: 'models/dcim/rearporttemplate.md'
|
- RearPortTemplate: 'models/dcim/rearporttemplate.md'
|
||||||
- Region: 'models/dcim/region.md'
|
- Region: 'models/dcim/region.md'
|
||||||
|
Loading…
Reference in New Issue
Block a user