network · Command reference

`qzx getNetworkConfig`

What it does

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

Canonical command: getNetworkConfig

Accepted aliases: None

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 alpha development checkout.

Safety and effects

Read-only under the current classification

No documented dry-run parameter

No native program invocation in the current classification

May use the network

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:b3514a4ef474472af9f0c68cd95daaa05ef544df488471b352c12d9fbbe9a083 on 2026-07-24.

Exact syntax

qzx getNetworkConfig [check_public] --json

Parameters

Name	Type	Required	Default	Description
check_public	str	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.",
    "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,
    "vpn": {
        "active": false,
        "detected_interfaces": []
    }
}

View the JSON result contract

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "dns_servers": [],
        "hostname": [],
        "interfaces": [],
        "local_ips": [],
        "public": {
            "type": "null"
        },
        "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.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability: 0.2.2.0.2 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