network · Command reference

`qzx getNetworkConfig`

What it does

Displays comprehensive network status (interfaces, local IPs, DNS, public IP, VPN detection)

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.8. This page documents the 0.2.2.0.8 alpha development checkout.

Behavior and built-in protections

Inspects without changing state

Direct execution for this operation

Works without invoking native programs

Uses network access for the documented task

No elevation required by design

This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:b5d21c616a9a3b36ffcf1b2e39915a286e684a8bd43b8a17237cb5885817b16c on 2026-08-25.

Exact syntax

qzx getNetworkConfig [check_public] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
check_public	bool	No	true	Whether to fetch public IP and location info (true/false)

Input examples

qzx getNetworkConfig

Get full network diagnostics including public IP and VPN status

qzx getNetworkConfig false

Get local network info only, skipping public IP resolution

For the complete structured payload, add --json: qzx getNetworkConfig [check_public] --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 getNetworkConfig --json

{
    "success": true,
    "message": "Displays comprehensive network status (interfaces, local IPs, DNS, public IP, VPN detection). In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "getNetworkConfig",
        "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
    },
    "dns_servers": [
        "1.1.1.1",
        "8.8.8.8"
    ],
    "hostname": "example.com",
    "interfaces": [
        {
            "name": "Ethernet",
            "status": "up",
            "ipv4": "192.0.2.25"
        }
    ],
    "local_ips": [
        "192.0.2.25"
    ],
    "public": null,
    "remediation": "Example value",
    "vpn": {
        "active": false,
        "detected_interfaces": []
    }
}

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
        },
        "dns_servers": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "hostname": [],
        "interfaces": [],
        "local_ips": [],
        "public": {
            "type": "null"
        },
        "remediation": {
            "type": "string"
        },
        "vpn": {
            "type": "object",
            "properties": {
                "active": [],
                "detected_interfaces": []
            },
            "additionalProperties": true
        }
    },
    "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 an authorized endpoint or reviewed fixture.

Evidence and provenance

Implementation: src/qzx/commands/network/get_network_config.py
Tests: tests/test_network_commands/test_get_network_config.py
Documentation channel: Development documentation 0.2.2.0.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
Availability: 0.2.2.0.8 or earlier

Keep exploring

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

Explore all QZX commands