qzx getDiskName

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 getDiskName --json

{
    "success": true,
    "message": "Gets disk name/model information for a disk or all disks. In this illustrative example, the command completed successfully.",
    "block_devices": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "block_devices_error": "Example value",
    "block_devices_raw": "Example value",
    "details": {
        "disk_path": "C:\\project\\example.txt"
    },
    "disk_list": "Example value",
    "disk_list_error": "Example value",
    "disk_list_raw": "Example value",
    "disks": [
        {
            "name": "C:",
            "total_space_readable": "931.51 GiB",
            "free_space_readable": "440.00 GiB",
            "percent_used": 52.8
        }
    ],
    "os_type": "Windows",
    "physical_disks": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "physical_disks_error": "Example value"
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "block_devices": [],
        "block_devices_error": [],
        "block_devices_raw": [],
        "details": {
            "type": "object",
            "properties": {
                "disk_path": []
            },
            "additionalProperties": true
        },
        "disk_list": [],
        "disk_list_error": [],
        "disk_list_raw": [],
        "disks": {
            "type": "array"
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "os_type": [],
        "physical_disks": {
            "type": "array"
        },
        "physical_disks_error": []
    },
    "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 the supported operating-system matrix.