Reference

YAML configuration

Netplan configuration files use the YAML (v1.1) format. All files in /{lib,etc,run}/netplan/*.yaml are considered and are supposed to use restrictive file permissions (600/rw-------), i.e. owner (root) read-write only.

The top-level node in a Netplan configuration file is a network: mapping that contains version: 2 (the YAML currently being used by curtin, MAAS, etc. is version 1), and then device definitions grouped by their type, such as ethernets:, modems:, wifis:, or bridges:. These are the types that our renderer can understand and are supported by our back ends.

• YAML configuration

libnetplan API

libnetplan is a component of the Netplan project that contains the logic for data parsing, validation and generation. It is build as a dynamic .so library that can be used from different binaries (like Netplan generate, netplan-dbus, the netplan apply/try/get/set/... CLI or using the corresponding Python bindings or external applications like the NetworkManager, using the Netplan back end).

• libnetplan API
  • Public headers
    • parse.h
    • parse-nm.h
    • state.h
    • netdef.h
    • util.h
    • types.h

Netplan CLI

Netplan manual pages describe the usage of the different command line interface tools available. Those are also installed on a system running Netplan and can be accessed, using the man utility.

• Netplan CLI

Netplan D-Bus

Netplan provides a daemon that can be run to provide the io.netplan.Netplan D-Bus API, to control certain aspects of a system’s Netplan configuration programmatically. See also: D-Bus configuration API.

• Netplan D-Bus