mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
Finish refreshing DCIM models documentation
This commit is contained in:
@@ -8,8 +8,86 @@ A device is said to be full-depth if its installation on one rack face prevents
|
||||
|
||||
Each device must be instantiated from a pre-created device type, and its default components (console ports, power ports, interfaces, etc.) will be created automatically. (The device type associated with a device may be changed after its creation, however its components will not be updated retroactively.)
|
||||
|
||||
Each device must be assigned a site, device role, and operational status, and may optionally be assigned to a specific location and/or rack within a site. A platform, serial number, and asset tag may optionally be assigned to each device.
|
||||
|
||||
Device names must be unique within a site, unless the device has been assigned to a tenant. Devices may also be unnamed.
|
||||
|
||||
When a device has one or more interfaces with IP addresses assigned, a primary IP for the device can be designated, for both IPv4 and IPv6.
|
||||
|
||||
## Fields
|
||||
|
||||
### Name
|
||||
|
||||
The device's configured name. This field is optional; devices can be unnamed. However, if set, the name must be unique to the assigned site and tenant.
|
||||
|
||||
### Device Role
|
||||
|
||||
The functional [role](./devicerole.md) assigned to this device.
|
||||
|
||||
### Device Type
|
||||
|
||||
The hardware [device type](./devicetype.md) which defines the device's make & model. Upon creating, all templated components assigned to the device type will be replicated on the new device.
|
||||
|
||||
### Airflow
|
||||
|
||||
The direction in which air circulates through the device chassis for cooling.
|
||||
|
||||
### Serial Number
|
||||
|
||||
The unique physical serial number assigned to this device by its manufacturer.
|
||||
|
||||
### Asset Tag
|
||||
|
||||
A unique, locally-administered label used to identify hardware resources.
|
||||
|
||||
### Site
|
||||
|
||||
The [site](./site.md) in which this device is located.
|
||||
|
||||
### Location
|
||||
|
||||
A specific [location](./location.md) where this device resides within the assigned site (optional).
|
||||
|
||||
### Rack
|
||||
|
||||
The [rack](./rack.md) within which this device is installed (optional).
|
||||
|
||||
### Rack Face
|
||||
|
||||
If installed in a rack, this field denotes the primary face on which the device is mounted.
|
||||
|
||||
### Position
|
||||
|
||||
If installed in a rack, this field indicates the base rack unit in which the device is mounted.
|
||||
|
||||
!!! tip
|
||||
Devices with a height of more than one rack unit should be set to the lowest-numbered rack unit that they occupy.
|
||||
|
||||
### Status
|
||||
|
||||
The device's operational status.
|
||||
|
||||
!!! tip
|
||||
Additional statuses may be defined by setting `Device.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter.
|
||||
|
||||
### Platform
|
||||
|
||||
A device may be associated with a particular [platform](./platform.md) to indicate its operating system. Note that only platforms assigned to the associated manufacturer (or to no manufacturer) will be available for selection.
|
||||
|
||||
### Cluster
|
||||
|
||||
If this device will serve as a host for a virtualization [cluster](../virtualization/cluster.md), it can be assigned here. (Host devices can also be assigned by editing the cluster.)
|
||||
|
||||
### Virtual Chassis
|
||||
|
||||
The [virtual chassis](./virtualchassis.md) of which this device is a member, if any.
|
||||
|
||||
### VC Position
|
||||
|
||||
If assigned to a [virtual chassis](./virtualchassis.md), this field indicates the device's member position.
|
||||
|
||||
### VC Priority
|
||||
|
||||
If assigned to a [virtual chassis](./virtualchassis.md), this field indicates the device's priority for master election.
|
||||
|
||||
### Local Config Context Data
|
||||
|
||||
Any unique [context data](../../features/context-data.md) to be associated with the device.
|
||||
|
Reference in New Issue
Block a user