{
    "mode": "man",
    "parameter": "NETPLAN",
    "section": "8",
    "url": "https://www.chedong.com/phpMan.php/man/NETPLAN/8/json",
    "generated": "2026-10-06T10:59:37Z",
    "synopsis": "netplan [--debug ] [generate|apply|try|get|set|status]",
    "sections": {
        "NAME": {
            "content": "netplan - Netplan runtime CLI\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "netplan [--debug ] [generate|apply|try|get|set|status]\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "This manual page provides an overview of the Netplan runtime CLI commands.\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "--debug",
                    "content": "Enable debug messages\n",
                    "long": "--debug"
                }
            ]
        },
        "EXAMPLES": {
            "content": "netplan generate converts Netplan YAML into configuration files understood by the back ends (\nsystemd-networkd(8) or NetworkManager(8) ). It does not apply the generated configuration.\n\nnetplan apply applies the current Netplan configuration to a running system.\n\nnetplan try [ --timeout 120 ] takes a netplan(5) configuration, applies it, and automatically\nrolls it back if the user does not confirm the configuration within a time limit.\n\nnetplan  get  [  network.ethernets.eth0 ] reads YAML files from /{etc,lib,run}/netplan/*.yaml\nand returns a merged view of the current configuration.\n\nnetplan set [ network.ethernets.eth0={dhcp4: true, dhcp6: true} ] writes  a  given  key/value\npair or JSON struct into a YAML file in /etc/netplan/ and validates its format.\n\nnetplan status [ interface ] queries the current network configuration and displays it in hu‐\nman-readable format.\n",
            "subsections": []
        },
        "FILES": {
            "content": "",
            "subsections": [
                {
                    "name": "/etc/netplan/",
                    "content": "Directory with YAML configuration files, describing the network configuration.\n"
                }
            ]
        },
        "SEE ALSO": {
            "content": "netplan(5),  netplan-generate(8),  netplan-apply(8), netplan-try(8), netplan-get(8), netplan-\nset(8), netplan-status(8).\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Lukas Märdian (slyon@ubuntu.com).\n\n23 January 2025                                NETPLAN(8)",
            "subsections": []
        }
    },
    "summary": "netplan - Netplan runtime CLI",
    "flags": [
        {
            "flag": "",
            "long": "--debug",
            "arg": null,
            "description": "Enable debug messages"
        }
    ],
    "examples": [
        "netplan generate converts Netplan YAML into configuration files understood by the back ends (",
        "systemd-networkd(8) or NetworkManager(8) ). It does not apply the generated configuration.",
        "netplan apply applies the current Netplan configuration to a running system.",
        "netplan try [ --timeout 120 ] takes a netplan(5) configuration, applies it, and automatically",
        "rolls it back if the user does not confirm the configuration within a time limit.",
        "netplan  get  [  network.ethernets.eth0 ] reads YAML files from /{etc,lib,run}/netplan/*.yaml",
        "and returns a merged view of the current configuration.",
        "netplan set [ network.ethernets.eth0={dhcp4: true, dhcp6: true} ] writes  a  given  key/value",
        "pair or JSON struct into a YAML file in /etc/netplan/ and validates its format.",
        "netplan status [ interface ] queries the current network configuration and displays it in hu‐",
        "man-readable format."
    ],
    "see_also": [
        {
            "name": "netplan",
            "section": "5",
            "url": "https://www.chedong.com/phpMan.php/man/netplan/5/json"
        },
        {
            "name": "netplan-generate",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/netplan-generate/8/json"
        },
        {
            "name": "netplan-apply",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/netplan-apply/8/json"
        },
        {
            "name": "netplan-try",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/netplan-try/8/json"
        },
        {
            "name": "netplan-get",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/netplan-get/8/json"
        },
        {
            "name": "set",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/set/8/json"
        },
        {
            "name": "netplan-status",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/netplan-status/8/json"
        }
    ]
}