{
    "mode": "man",
    "parameter": "netplan-status",
    "section": "8",
    "url": "https://www.chedong.com/phpMan.php/man/netplan-status/8/json",
    "generated": "2026-10-09T03:21:19Z",
    "synopsis": "netplan [--debug] status -h|--help\nnetplan [--debug] status [interface]",
    "sections": {
        "NAME": {
            "content": "netplan-status - query networking state of the running system\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "netplan [--debug] status -h|--help\n\nnetplan [--debug] status [interface]\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "netplan  status  [interface] queries the current network configuration and displays it in hu‐\nman-readable format.\n\nYou can specify interface to display the status of a specific interface.\n\nCurrently, netplan status depends on systemd-networkd as a source of data  and  will  try  to\nstart it if it's not masked.\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "-h --help",
                    "content": "Print basic help.\n",
                    "flag": "-h",
                    "long": "--help"
                },
                {
                    "name": "--debug",
                    "content": "Print debugging output during the process.\n",
                    "long": "--debug"
                },
                {
                    "name": "-a --all",
                    "content": "Show all interface data including inactive.\n\n--diff Analyse  and  display differences between the current system configuration and network\ndefinitions present in the YAML files.  The configuration  analysed  includes  IP  ad‐\ndresses,  routes, MAC addresses, DNS addresses, search domains and missing network in‐\nterfaces.\n\nThe output format is similar to popular diff tools, such diff and git diff.   Configu‐\nration  present only in the system (and therefore missing in the Netplan YAML) will be\ndisplayed with a + sign and will be highlighted in green.  Configuration present  only\nin  Netplan  (and therefore missing in the system) will be displayed with a - sign and\nhighlighted in red.  The same is applied to network interfaces.\n",
                    "flag": "-a",
                    "long": "--all"
                },
                {
                    "name": "--diff-only",
                    "content": "Same as --diff but omits all the information that is not a difference.\n",
                    "long": "--diff-only"
                },
                {
                    "name": "--root-dir",
                    "content": "Read YAML files from this root instead of /.\n",
                    "long": "--root-dir"
                },
                {
                    "name": "--verbose",
                    "content": "Show extra information.\n",
                    "long": "--verbose"
                },
                {
                    "name": "-f _FORMAT_ --format FORMAT",
                    "content": "Output in machine-readable json or yaml format.\n",
                    "flag": "-f",
                    "long": "--format",
                    "arg": "FORMAT"
                }
            ]
        },
        "SEE ALSO": {
            "content": "netplan(5), netplan-get(8), netplan-ip(8)\n",
            "subsections": []
        },
        "AUTHORS": {
            "content": "Danilo Egea Gondolfo (danilo.egea.gondolfo@canonical.com).\n\nNETPLAN-STATUS(8)",
            "subsections": []
        }
    },
    "summary": "netplan-status - query networking state of the running system",
    "flags": [
        {
            "flag": "-h",
            "long": "--help",
            "arg": null,
            "description": "Print basic help."
        },
        {
            "flag": "",
            "long": "--debug",
            "arg": null,
            "description": "Print debugging output during the process."
        },
        {
            "flag": "-a",
            "long": "--all",
            "arg": null,
            "description": "Show all interface data including inactive. --diff Analyse and display differences between the current system configuration and network definitions present in the YAML files. The configuration analysed includes IP ad‐ dresses, routes, MAC addresses, DNS addresses, search domains and missing network in‐ terfaces. The output format is similar to popular diff tools, such diff and git diff. Configu‐ ration present only in the system (and therefore missing in the Netplan YAML) will be displayed with a + sign and will be highlighted in green. Configuration present only in Netplan (and therefore missing in the system) will be displayed with a - sign and highlighted in red. The same is applied to network interfaces."
        },
        {
            "flag": "",
            "long": "--diff-only",
            "arg": null,
            "description": "Same as --diff but omits all the information that is not a difference."
        },
        {
            "flag": "",
            "long": "--root-dir",
            "arg": null,
            "description": "Read YAML files from this root instead of /."
        },
        {
            "flag": "",
            "long": "--verbose",
            "arg": null,
            "description": "Show extra information."
        },
        {
            "flag": "-f",
            "long": "--format",
            "arg": "FORMAT",
            "description": "Output in machine-readable json or yaml format."
        }
    ],
    "examples": [],
    "see_also": [
        {
            "name": "netplan",
            "section": "5",
            "url": "https://www.chedong.com/phpMan.php/man/netplan/5/json"
        },
        {
            "name": "netplan-get",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/netplan-get/8/json"
        },
        {
            "name": "netplan-ip",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/netplan-ip/8/json"
        }
    ]
}