Hyper-V VM Status Reference

All parameters, thresholds, and configuration options for the Hyper-V VM Status check in octoja.

Written By Erdinc Akay

Last updated About 2 months ago

The Hyper-V VM Status check monitors the status of virtual machines on a Hyper-V host and warns when VMs are in an unexpected state.

Configuration fields

Field	Type	Required	Default	Description
Monitor all VMs	Boolean	No	Yes	Monitor all VMs on the host
VMs to monitor	List of strings	No	—	Specific VM names (shown when Monitor all VMs is off)
Warn if VM is off	Boolean	No	Yes	Raise a warning for VMs in 'Off' state
Critical if VM is off	Boolean	No	No	Raise a critical error instead of a warning for VMs in 'Off' state
Warn if VM is saved	Boolean	No	No	Raise a warning for VMs in 'Saved' state

Total VM count on the host
VM state — only Off, Saved, and Paused are evaluated explicitly; any other state (including Running) is treated as success
For VMs in a problem state, octoja reports the VM name, state, uptime, CPU usage (percent), and assigned memory (MB)
Aggregated host result — the worst result across all evaluated VMs; when no VM is in a problem state, no per-VM details are shown

Platform	Supported
Windows (with the Hyper-V role or feature enabled)	Yes
Linux	No
macOS	No

VMs in the Paused state always raise a warning. This behavior is hardcoded and cannot be turned off via the configuration fields.
Requires the Hyper-V role installed and the Hyper-V PowerShell module available.
The check uses Get-VM to query VM states.
Failure semantics: a missing Hyper-V role or unavailable Get-VM cmdlet raises a warning (not a failure). A host with no VMs also raises a warning. If Monitor all VMs is off and none of the listed VM names match a VM on the host (names are compared case-insensitively), the check raises a warning — for example after a VM has been renamed. Any other exception during evaluation raises a failure.
The check runs every 5 minutes on the agent. The interval is not user-configurable.