{
    "content": [
        {
            "type": "text",
            "text": "# netplan-dbus (man)\n\n## NAME\n\nnetplan-dbus - daemon to access netplan's functionality via a DBus API\n\n## DESCRIPTION\n\nnetplan-dbus  is a DBus daemon, providing io.netplan.Netplan on the system bus.  The /io/net‐\nplan/Netplan object provides an io.netplan.Netplan interface, offering the following methods:\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS** (1 subsections)\n- **DESCRIPTION**\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "netplan-dbus",
        "section": "",
        "mode": "man",
        "summary": "netplan-dbus - daemon to access netplan's functionality via a DBus API",
        "synopsis": "",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [
            {
                "name": "netplan",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/netplan/5/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": "netplan-set",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/netplan-set/8/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "netplan-dbus",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "DESCRIPTION",
                "lines": 43,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHORS",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "netplan-dbus - daemon to access netplan's functionality via a DBus API\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "",
                "subsections": [
                    {
                        "name": "netplan-dbus",
                        "content": ""
                    }
                ]
            },
            "DESCRIPTION": {
                "content": "netplan-dbus  is a DBus daemon, providing io.netplan.Netplan on the system bus.  The /io/net‐\nplan/Netplan object provides an io.netplan.Netplan interface, offering the following methods:\n\n• Apply() -> b: calls netplan apply and returns a success or failure status.\n\n• Generate() -> b: calls netplan generate and returns a success or failure status.\n\n• Info() -> a(sv): returns a dict \"Features -> as\", containing an array of all available fea‐\nture flags.\n\n• Config()  -> o: prepares a new config object as /io/netplan/Netplan/config/<ID>, by copying\nthe current state from /{etc,run,lib}/netplan/*.yaml\n\nThe /io/netplan/Netplan/config/<ID> objects provide  a  io.netplan.Netplan.Config  interface,\noffering the following methods:\n\n• Get()  -> s: calls netplan get --root-dir=/run/netplan/config-ID all and returns the merged\nYAML config of the the given config object's state\n\n• Set(s:CONFIGDELTA, s:ORIGINHINT) -> b: calls netplan set  --root-dir=/run/netplan/config-\nID --origin-hint=ORIGINHINT CONFIGDELTA\n\nCONFIGDELTA  can  be something like: network.ethernets.eth0.dhcp4=true and ORIGINHINT can\nbe something like: 70-snapd (it will then write the config to 70-snapd.yaml).   Once  Set()\nis called on a config object, all other current and future config objects are being invali‐\ndated and cannot Set() or Try()/Apply() anymore, due to this pending  dirty  state.   After\nthe dirty config object is rejected via Cancel(), the other config objects are valid again.\nIf the dirty config object is accepted via Apply(), newly created config  objects  will  be\nvalid, while the older states will stay invalid.\n\n• Try(u:TIMEOUTSEC)  -> b: replaces the main netplan configuration with this config object's\nstate and calls netplan try --timeout=TIMEOUTSEC\n\n• Cancel() -> b: rejects a currently running Try() attempt on this config object and/or  dis‐\ncards the config object\n\n• Apply()  ->  b: replaces the main netplan configuration with this config object's state and\ncalls netplan apply\n\nFor information about the Apply()/Try()/Get()/Set() functionality, see  netplan-apply(8)/net‐‐\nplan-try(8)/netplan-get(8)/netplan-set(8) accordingly.  For details of the configuration file\nformat, see netplan(5).\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "netplan(5), netplan-apply(8), netplan-try(8), netplan-get(8), netplan-set(8)\n",
                "subsections": []
            },
            "AUTHORS": {
                "content": "Lukas Märdian (<lukas.maerdian@canonical.com>).\n\n\n\nnetplan-dbus(8)",
                "subsections": []
            }
        }
    }
}