Skip to main content
Storage Health
MonitoringSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the Storage health panel with terminalsbooleanfalseOpen the panel by itself on hosts that have it.
Panel sideselect"right"Where the Storage health panel opens beside a terminal.
Panel sizenumber380Width or height of the panel in pixels.
Show the edge buttonbooleantrueShow a small button on the edge of the terminal to open the panel.

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
Storage HealthbooleanfalseWatch drives, pools and arrays on this host.
Use sudobooleantrueRun the checks with passwordless sudo. SMART needs root.
Read onlybooleanfalseBlock self tests and scrubs from Termix.
Show the side panelbooleantrueOffer the Storage health panel beside terminals on this host.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
storage-health.useadmin, userSee drive and array health on hosts you can access.
storage-health.run-testsadmin, userStart SMART self tests and scrubs. Also needs edit access to the host.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
storage-health.devices
Drives
A hostRead only
storage-health.pools
Pools and arrays
A hostRead only
storage-health.status
Storage health
A hostRead only
storage-health.temperature
Hottest drive
A hostRead only
storage-health.selftest
SMART self test
A hostChangesdevice, action
storage-health.scrub
Scrub
A hostChangestarget, stop

Events​

Automations can start when one of these happens.

EventWhat it means
storage-health.degradedStorage problem found
storage-health.recoveredStorage problem cleared
storage-health.smart-failingDrive failing its SMART check
storage-health.raid-degradedPool or array degraded

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
kv:ownLowRemember small settings. Kept separate from other plugins.
files:ownLowStore its own files. In its own folder on disk, separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Services​

Services are how plugins call each other. Plugin authors can use these.

ProvidesVersionPermission
storage-health.access1.0.0storage-health.use

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS