{
    "mode": "pydoc",
    "parameter": "netplan",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/pydoc/netplan/json",
    "generated": "2026-06-02T15:04:27Z",
    "sections": {
        "NAME": {
            "content": "netplan\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "# Copyright (C) 2023 Canonical, Ltd.\n# Author: Lukas Märdian <slyon@ubuntu.com>\n#\n# This program is free software; you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation; version 3.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with this program.  If not, see <http://www.gnu.org/licenses/>.\n",
            "subsections": []
        },
        "PACKAGE CONTENTS": {
            "content": "netplancffi\nutils\nnetdef\nparser\nstate\n",
            "subsections": []
        },
        "DATA": {
            "content": "all = [<class 'netplan.parser.Parser'>, <class 'netplan.state.Stat...\n",
            "subsections": []
        },
        "FILE": {
            "content": "/usr/lib/python3/dist-packages/netplan/init.py\n\n",
            "subsections": []
        }
    },
    "summary": "netplan",
    "flags": [],
    "examples": [],
    "see_also": [],
    "tldr": {
        "source": "official",
        "description": "Network configuration utility using YAML.",
        "examples": [
            {
                "description": "Apply a network configuration and make it persistent",
                "command": "sudo netplan apply"
            },
            {
                "description": "Generate backend configuration files",
                "command": "sudo netplan generate"
            },
            {
                "description": "Configure a network interface to use DHCP",
                "command": "sudo netplan set ethernets.{{interface_name}}.dhcp4=true"
            },
            {
                "description": "Try configuration changes without applying them permanently",
                "command": "sudo netplan try --timeout {{seconds}}"
            },
            {
                "description": "Return to previous working configuration after failed apply",
                "command": "sudo netplan --debug apply"
            },
            {
                "description": "Display the current netplan configuration status",
                "command": "netplan status"
            }
        ]
    }
}