Skip to main content

system · Command reference

qzx getDiskHealth

What it does

Inspects one disk's S.M.A.R.T. health with smartctl and reports status flags without treating health warnings as command failures

Command maturity: Alpha

Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.6a12. This page documents the 0.2.2.0.6a12 alpha development checkout.

Safety and effects

Read-only under the current classification

No documented dry-run parameter

May invoke native programs

No documented network use

Outcome may depend on permissions

Validates one disk identifier and invokes the exact resolved smartctl path without a shell or user-supplied options, with a 15-second timeout. Parse, device-open, SMART-command, and checksum failures abort; disk-health bits remain structured observations. Disk access can require elevated privileges.

This safety classification was reviewed by OpenAI Codex (authorized project audit) against implementation digest sha256:d1758663b17c7c2441096764e85f6f88c99726241b2787682c66ad42fa78579c on 2026-07-30.

Exact syntax

qzx getDiskHealth <disk> [view] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

NameTypeRequiredDefaultDescription
diskstrYesNot declaredDisk identifier without path separators (for example: sda, nvme0n1, disk0, or PhysicalDrive0)
viewstrNo"health"Detail level: "health" for a summary or "full" for smartctl JSON

Input examples

qzx getDiskHealth sda

Inspect the S.M.A.R.T. health of /dev/sda

qzx getDiskHealth PhysicalDrive0 --view full

Read full S.M.A.R.T. JSON for a Windows physical drive

For the complete structured payload, add --json: qzx getDiskHealth <disk> [view] --json

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: qzx getDiskHealth sda --json

{
    "success": true,
    "message": "Inspects one disk's S.M.A.R.T. health with smartctl and reports status flags without treating health warnings as command failures. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "getDiskHealth",
        "command_maturity": {
            "stage": "alpha",
            "label": "Alpha",
            "sequence": 2,
            "public_executable": true,
            "stability": "interface_may_change",
            "summary": "Available for real use and feedback while its interface and behavior can still evolve.",
            "promotion_review_required": false,
            "assessment_scope": "development_checkout"
        },
        "duration_ms": 0,
        "schema_version": 1
    },
    "device": "Example value",
    "disk": "Example value",
    "health_status": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "output": "Command completed successfully with structured details.",
    "smart_data": "Example value",
    "stdout": "Command completed successfully.",
    "view": "Example value"
}
View the JSON result contract
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "meta": {
            "type": "object",
            "required": [
                "command",
                "command_maturity",
                "duration_ms",
                "schema_version"
            ],
            "properties": {
                "command": {
                    "type": "string"
                },
                "command_maturity": {
                    "type": "object",
                    "required": [
                        "stage",
                        "label",
                        "sequence",
                        "public_executable",
                        "stability",
                        "summary",
                        "promotion_review_required",
                        "assessment_scope"
                    ],
                    "properties": {
                        "stage": {
                            "type": "string"
                        },
                        "label": {
                            "type": "string"
                        },
                        "sequence": {
                            "type": "integer"
                        },
                        "public_executable": {
                            "type": "boolean"
                        },
                        "stability": {
                            "type": "string"
                        },
                        "summary": {
                            "type": "string"
                        },
                        "promotion_review_required": {
                            "type": "boolean"
                        },
                        "assessment_scope": {
                            "type": "string"
                        },
                        "note": {
                            "type": "string"
                        },
                        "review": {
                            "type": "object",
                            "required": [
                                "reviewed_on",
                                "rationale",
                                "evidence"
                            ],
                            "properties": {
                                "reviewed_on": {
                                    "type": "string",
                                    "format": "date"
                                },
                                "rationale": {
                                    "type": "string"
                                },
                                "evidence": {
                                    "type": "array",
                                    "minItems": 1,
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "replacement": {
                                    "type": "string"
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": true
                },
                "duration_ms": {
                    "type": "number"
                },
                "schema_version": {
                    "type": "integer"
                }
            },
            "additionalProperties": true
        },
        "device": [],
        "disk": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "health_status": [],
        "output": [],
        "smart_data": [],
        "stdout": [],
        "view": []
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: requires a controlled privileged environment.

Evidence and provenance

Documentation channel
Development documentation 0.2.2.0.6a12 · main · sha256:d1bf56371df81b2a79619d8219eed92ccf790be1584c528e211381ca7aa85302
Availability
0.2.2.0.6a12 or earlier

Keep exploring

Related commands

These commands also belong to the system category. Compare them to choose the operation that best fits your task.

Explore all QZX commands