Custom Fields
Custom fields extend host information with additional data fields. You can define separate fields for each module.
Concept
Custom fields supplement the standard host data with additional information relevant to your organization, such as:
- Location information
- Contract or SLA data
- Internal reference numbers
- Technical notes
Managing Fields
Access field management via Settings > Custom Fields.
Creating a Field
- Click Add Field
- Configure the field:
| Field | Description |
|---|---|
| Name | Internal field name (no spaces, unique) |
| Display Name | Label shown in the interface |
| Description | Help text for the field |
| Type | Data type of the field (see below) |
| Modules | Which modules the field is available for |
| Scope | Host, group, or module (see below) |
| Required | Must the field be filled in? |
| Default Value | Pre-filled value for new entries |
| Hide in UI | Hide the field in the overview |
| Hide in Summary | Hide the field in the compact view |
| Sort Order | Order of the fields in the display |
Field Types
| Type | Description | Example |
|---|---|---|
| text | Single-line text field | Location, room number |
| number | Numeric value | Contract number, port |
| dropdown_single | Single-select dropdown | SLA level (Gold/Silver/Bronze) |
| dropdown_multiple | Multi-select dropdown | Tags, categories |
| datetime | Date and time | Maintenance date, contract end |
| checkbox | Yes/No toggle | Production system, VPN active |
Dropdown Options
For the dropdown_single and dropdown_multiple types, you can define the selection options:
- Enter the options as a list
- Example:
Gold, Silver, Bronze
Scope
| Scope | Description |
|---|---|
| host | Field is stored per host (default) |
| group | Field is stored per host group |
| module | Field is stored module-wide |
Populating Fields
In the Detail Modal
- Open a host
- Custom fields are displayed in the overview
- Click on the value to edit it (inline editing)
- Press Enter to save
When Creating a Host
If a field is marked as Required, it must be filled in when creating a new host.
Display
In the Host Table
Fields with the Show in Table option enabled appear as additional columns in the host table of the respective module.
In the Detail Modal
All custom fields for a host are displayed in the overview tab of the detail modal.
In Reports
Custom fields are available as variables in report templates and can be included in reports.
Module Assignment
Fields can be configured for specific modules or all modules at once:
- All - Field appears in all modules
- OPNsense - Only in the OPNsense module
- Proxmox VE - Only in the PVE module
- Proxmox PBS - Only in the PBS module
- Linux - Only in the Linux module
- Windows - Only in the Windows module
Visibility
| Option | Description |
|---|---|
Hide in UI (hide_in_ui) | Field is not displayed in the normal overview but is available via the API. Useful for technical fields that are only populated by scripts/checks. |
Hide in Summary (hide_in_summary) | Field is not displayed in the compact overview (e.g., tooltip) but appears in the detail modal. |
Automatic Population
Custom fields can be populated not only manually but also automatically through Health Checks. See Health Checks > Custom Field Mappings.
Practical Examples
IT Service Provider
Field: sla_level (Select: Gold, Silver, Bronze)
Field: contract_end (Date)
Field: contact_person (Text)
Field: location (Text)Internal IT Team
Field: department (Select: Development, Marketing, Sales, IT)
Field: cost_center (Text)
Field: is_production (Boolean)
Field: notes (Textarea)