Sensors
The Sensors page manages your fleet of discovery agents. Each sensor is a machine running the CBOM sensor process. From here you register sensors, assign scanners, monitor scan activity, and trigger on-demand scans.
Sensor List
Section titled “Sensor List”Each registered sensor appears as an expandable card showing:
- Name and sensor ID
- Status — online (recently checked in) or offline
- Hostname and OS (auto-detected)
- Scanner count and total assets discovered
Click a card to expand it and see scanner assignments and management controls.
Registering a Sensor
Section titled “Registering a Sensor”- Click Register Sensor
- Enter a descriptive name
- Save the displayed Sensor ID and API Key (shown only once)
Deploy the sensor JAR on the target machine with these credentials in sensor.yml. See First Sensor for full setup instructions.
Scanner Assignments
Section titled “Scanner Assignments”The expanded sensor card shows a table of assigned scanners:
| Column | Description |
|---|---|
| Scanner Type | The scanner engine (e.g., network-tls, filesystem-certs) |
| Scanner Label | User-provided label for this assignment |
| Configs | Number of configuration entries |
| Schedule | Scan frequency (hourly, 6h, 12h, daily, weekly) |
| Last Scan | Timestamp of most recent scan |
| Assets | Number of assets found in last scan |
| Status | completed, partial, or failed |
| Actions | Scan Now, Edit, Remove |
Adding a Scanner
Section titled “Adding a Scanner”Click Add Scanner to open the scanner catalogue:
- Left pane — browse scanner types grouped by category, with search
- Right pane — shows scanner description, access modes, asset types produced
- Configure — set schedule, label, and scanner-specific YAML/JSON config
- Save — the scanner is assigned and will run on next heartbeat
The configuration editor supports both YAML and JSON with a format toggle. Field hints from the scanner’s config schema are shown below the editor.
Editing a Scanner
Section titled “Editing a Scanner”Click Edit on any scanner row to modify its type, label, schedule, or configuration.
Force Scanning
Section titled “Force Scanning”- Scan Now — triggers a single scanner immediately
- Force Scan All — triggers all assigned scanners on the sensor
The sensor picks up force-scan requests on its next check-in (within the heartbeat interval).
Scan Runs
Section titled “Scan Runs”Below the scanner table, a Scan Runs section shows historical scan activity:
| Column | Description |
|---|---|
| Scanner | Scanner type that ran |
| Label | Scanner label |
| Target | What was scanned |
| Hostname | Machine that ran the scan |
| Started | Scan start time |
| Status | completed / partial / failed (with error count badge) |
| Assets | Count of assets discovered (clickable — navigates to Inventory filtered by scan run) |
Expand a failed/partial row to see the error list.
Sensor Management
Section titled “Sensor Management”Additional actions at the bottom of the expanded card:
| Action | Description |
|---|---|
| Install Script | Generate a platform-specific install script (Linux/Windows) |
| Logs | View recent sensor logs |
| View Assets | Navigate to Inventory filtered by this sensor |
| Download Config | Download the sensor.yml template |
| Download JAR | Download the sensor binary |
| Delete Sensor | Remove the sensor registration (admin only) |
Related
Section titled “Related”- First Sensor — Initial setup guide
- Scanner Reference — All scanner types and configs
- First Scan — Running your first scan